120 lines
3.2 KiB
Groff
120 lines
3.2 KiB
Groff
'\" t
|
|
.nh
|
|
.TH podman-pod-inspect 1
|
|
.SH NAME
|
|
podman-pod-inspect \- Display information describing a pod
|
|
|
|
.SH SYNOPSIS
|
|
\fBpodman pod inspect\fP [\fIoptions\fP] \fIpod\fP ...
|
|
|
|
.SH DESCRIPTION
|
|
Displays configuration and state information about a given pod. It also displays information about containers
|
|
that belong to the pod.
|
|
|
|
.SH OPTIONS
|
|
.SS \fB--format\fP, \fB-f\fP=\fIformat\fP
|
|
Change the default output format. This can be of a supported type like 'json'
|
|
or a Go template.
|
|
Valid placeholders for the Go template are listed below:
|
|
|
|
.TS
|
|
allbox;
|
|
l l
|
|
l l .
|
|
\fB\fBPlaceholder\fP\fP \fB\fBDescription\fP\fP
|
|
\&.BlkioDeviceReadBps T{
|
|
Block I/O Device Read, in bytes/sec
|
|
T}
|
|
\&.BlkioDeviceWriteBps T{
|
|
Block I/O Device Read, in bytes/sec
|
|
T}
|
|
\&.BlkioWeight Block I/O Weight
|
|
\&.BlkioWeightDevice Block I/O Device Weight
|
|
\&.CgroupParent Pod cgroup parent
|
|
\&.CgroupPath Pod cgroup path
|
|
\&.Containers Pod containers
|
|
\&.CPUPeriod CPU period
|
|
\&.CPUQuota CPU quota
|
|
\&.CPUSetCPUs CPU Set CPUs
|
|
\&.CPUSetMems CPU Set Mems
|
|
\&.CPUShares CPU Shares
|
|
\&.CreateCgroup Whether cgroup was created
|
|
\&.CreateCommand Create command
|
|
\&.Created ... Time when the pod was created
|
|
\&.CreateInfra Whether infrastructure created
|
|
\&.Devices Devices
|
|
\&.ExitPolicy Exit policy
|
|
\&.Hostname Pod hostname
|
|
\&.ID Pod ID
|
|
\&.InfraConfig ... T{
|
|
Infra config (contains further fields)
|
|
T}
|
|
\&.InfraContainerID Pod infrastructure ID
|
|
\&.InspectPodData ... T{
|
|
Nested structure, for experts only
|
|
T}
|
|
\&.Labels ... Pod labels
|
|
\&.LockNumber T{
|
|
Number of the pod's Libpod lock
|
|
T}
|
|
\&.MemoryLimit Memory limit, bytes
|
|
\&.MemorySwap Memory swap limit, in bytes
|
|
\&.Mounts Mounts
|
|
\&.Name Pod name
|
|
\&.Namespace Namespace
|
|
\&.NumContainers T{
|
|
Number of containers in the pod
|
|
T}
|
|
\&.RestartPolicy Restart policy of the pod
|
|
\&.SecurityOpts Security options
|
|
\&.SharedNamespaces Pod shared namespaces
|
|
\&.State Pod state
|
|
\&.VolumesFrom Volumes from
|
|
.TE
|
|
|
|
.SS \fB--latest\fP, \fB-l\fP
|
|
Instead of providing the pod name or ID, use the last created pod.
|
|
Note: the last started pod can be from other users of Podman on the host machine.
|
|
(This option is not available with the remote Podman client, including Mac and Windows
|
|
(excluding WSL2) machines)
|
|
|
|
.SH EXAMPLE
|
|
Inspect specified pod:
|
|
|
|
.EX
|
|
# podman pod inspect foobar
|
|
[
|
|
{
|
|
"Id": "3513ca70583dd7ef2bac83331350f6b6c47d7b4e526c908e49d89ebf720e4693",
|
|
"Name": "foobar",
|
|
"Labels": {},
|
|
"CgroupParent": "/libpod_parent",
|
|
"CreateCgroup": true,
|
|
"Created": "2018-08-08T11:15:18.823115347-05:00"
|
|
"State": "created",
|
|
"Hostname": "",
|
|
"SharedNamespaces": [
|
|
"uts",
|
|
"ipc",
|
|
"net"
|
|
]
|
|
"CreateInfra": false,
|
|
"InfraContainerID": "1020dd70583dd7ff2bac83331350f6b6e007de0d026c908e49d89ebf891d4699"
|
|
"CgroupPath": ""
|
|
"Containers": [
|
|
{
|
|
"id": "d53f8bf1e9730281264aac6e6586e327429f62c704abea4b6afb5d8a2b2c9f2c",
|
|
"state": "configured"
|
|
}
|
|
]
|
|
}
|
|
]
|
|
.EE
|
|
|
|
.SH SEE ALSO
|
|
\fBpodman(1)\fP, \fBpodman-pod(1)\fP, \fBpodman-inspect(1)\fP
|
|
|
|
.SH HISTORY
|
|
August 2018, Originally compiled by Brent Baude bbaude@redhat.com
|
|
\[la]mailto:bbaude@redhat.com\[ra]
|