summaryrefslogtreecommitdiff
path: root/docs/podman-pod-inspect.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2018-08-08 13:08:22 -0500
committerAtomic Bot <atomic-devel@projectatomic.io>2018-08-09 11:06:32 +0000
commit06fafe4cd04f29ee19078d6e78fdd792f2c1a37e (patch)
tree858649113e849d6b6c179126eb3b8740b0d2ee9d /docs/podman-pod-inspect.1.md
parent879453eaf16675f732dd87fd250ccaaac72f4285 (diff)
downloadpodman-06fafe4cd04f29ee19078d6e78fdd792f2c1a37e.tar.gz
podman-06fafe4cd04f29ee19078d6e78fdd792f2c1a37e.tar.bz2
podman-06fafe4cd04f29ee19078d6e78fdd792f2c1a37e.zip
add podman pod inspect
first pass of podman pod inspect Signed-off-by: baude <bbaude@redhat.com> Closes: #1236 Approved by: rhatdan
Diffstat (limited to 'docs/podman-pod-inspect.1.md')
-rw-r--r--docs/podman-pod-inspect.1.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/podman-pod-inspect.1.md b/docs/podman-pod-inspect.1.md
new file mode 100644
index 000000000..edcd5dcef
--- /dev/null
+++ b/docs/podman-pod-inspect.1.md
@@ -0,0 +1,48 @@
+% podman-pod-inspect "1"
+
+## NAME
+podman\-pod\-inspect - Displays information describing a pod
+
+## SYNOPSIS
+**podman pod inspect** [*options*] *pod* ...
+
+## DESCRIPTION
+Displays configuration and state information about a given pod. It also displays information about containers
+that belong to the pod.
+
+## OPTIONS
+**--latest, -l**
+
+Instead of providing the pod name or ID, use the last created pod. If you use methods other than Podman
+to run pods such as CRI-O, the last started pod could be from either of those methods.
+
+
+## EXAMPLE
+```
+# podman pod inspect foobar
+{
+ "Config": {
+ "id": "3513ca70583dd7ef2bac83331350f6b6c47d7b4e526c908e49d89ebf720e4693",
+ "name": "foobar",
+ "labels": {},
+ "cgroupParent": "/libpod_parent",
+ "UsePodCgroup": true,
+ "created": "2018-08-08T11:15:18.823115347-05:00"
+ },
+ "State": {
+ "CgroupPath": ""
+ },
+ "Containers": [
+ {
+ "id": "d53f8bf1e9730281264aac6e6586e327429f62c704abea4b6afb5d8a2b2c9f2c",
+ "state": "configured"
+ }
+ ]
+}
+```
+
+## SEE ALSO
+podman-pod(1), podman-pod-ps(1)
+
+## HISTORY
+August 2018, Originally compiled by Brent Baude <bbaude@redhat.com>