github.com/containers/podman/v5@v5.1.0-rc1/docs/source/markdown/podman-pod-inspect.1.md.in (about)

     1  % podman-pod-inspect 1
     2  
     3  ## NAME
     4  podman\-pod\-inspect - Display information describing a pod
     5  
     6  ## SYNOPSIS
     7  **podman pod inspect** [*options*] *pod* ...
     8  
     9  ## DESCRIPTION
    10  Displays configuration and state information about a given pod.  It also displays information about containers
    11  that belong to the pod.
    12  
    13  ## OPTIONS
    14  
    15  #### **--format**, **-f**=*format*
    16  
    17  Change the default output format.  This can be of a supported type like 'json'
    18  or a Go template.
    19  Valid placeholders for the Go template are listed below:
    20  
    21  | **Placeholder**      | **Description**                             |
    22  |----------------------|---------------------------------------------|
    23  | .BlkioDeviceReadBps  | Block I/O Device Read, in bytes/sec         |
    24  | .BlkioDeviceWriteBps | Block I/O Device Read, in bytes/sec         |
    25  | .BlkioWeight         | Block I/O Weight                            |
    26  | .BlkioWeightDevice   | Block I/O Device Weight                     |
    27  | .CgroupParent        | Pod cgroup parent                           |
    28  | .CgroupPath          | Pod cgroup path                             |
    29  | .Containers          | Pod containers                              |
    30  | .CPUPeriod           | CPU period                                  |
    31  | .CPUQuota            | CPU quota                                   |
    32  | .CPUSetCPUs          | CPU Set CPUs                                |
    33  | .CPUSetMems          | CPU Set Mems                                |
    34  | .CPUShares           | CPU Shares                                  |
    35  | .CreateCgroup        | Whether cgroup was created                  |
    36  | .CreateCommand       | Create command                              |
    37  | .Created ...         | Time when the pod was created               |
    38  | .CreateInfra         | Whether infrastructure created              |
    39  | .Devices             | Devices                                     |
    40  | .ExitPolicy          | Exit policy                                 |
    41  | .Hostname            | Pod hostname                                |
    42  | .ID                  | Pod ID                                      |
    43  | .InfraConfig ...     | Infra config (contains further fields)      |
    44  | .InfraContainerID    | Pod infrastructure ID                       |
    45  | .InspectPodData ...  | Nested structure, for experts only          |
    46  | .Labels ...          | Pod labels                                  |
    47  | .LockNumber          | Number of the pod's Libpod lock             |
    48  | .MemoryLimit         | Memory limit, bytes                         |
    49  | .MemorySwap          | Memory swap limit, in bytes                 |
    50  | .Mounts              | Mounts                                      |
    51  | .Name                | Pod name                                    |
    52  | .Namespace           | Namespace                                   |
    53  | .NumContainers       | Number of containers in the pod             |
    54  | .RestartPolicy       | Restart policy of the pod                   |
    55  | .SecurityOpts        | Security options                            |
    56  | .SharedNamespaces    | Pod shared namespaces                       |
    57  | .State               | Pod state                                   |
    58  | .VolumesFrom         | Volumes from                                |
    59  
    60  @@option latest
    61  
    62  ## EXAMPLE
    63  
    64  Inspect specified pod:
    65  ```
    66  # podman pod inspect foobar
    67  [
    68       {
    69           "Id": "3513ca70583dd7ef2bac83331350f6b6c47d7b4e526c908e49d89ebf720e4693",
    70           "Name": "foobar",
    71           "Labels": {},
    72           "CgroupParent": "/libpod_parent",
    73           "CreateCgroup": true,
    74           "Created": "2018-08-08T11:15:18.823115347-05:00"
    75           "State": "created",
    76           "Hostname": "",
    77           "SharedNamespaces": [
    78                "uts",
    79                "ipc",
    80                "net"
    81           ]
    82           "CreateInfra": false,
    83           "InfraContainerID": "1020dd70583dd7ff2bac83331350f6b6e007de0d026c908e49d89ebf891d4699"
    84           "CgroupPath": ""
    85           "Containers": [
    86                {
    87                     "id": "d53f8bf1e9730281264aac6e6586e327429f62c704abea4b6afb5d8a2b2c9f2c",
    88                     "state": "configured"
    89                }
    90           ]
    91       }
    92  ]
    93  ```
    94  
    95  ## SEE ALSO
    96  **[podman(1)](podman.1.md)**, **[podman-pod(1)](podman-pod.1.md)**, **[podman-inspect(1)](podman-inspect.1.md)**
    97  
    98  ## HISTORY
    99  August 2018, Originally compiled by Brent Baude <bbaude@redhat.com>