podman-pod-ps(1)

1podman-pod-ps(1)()                                          podman-pod-ps(1)()
2
3
4

NAME

6       podman-pod-ps - Prints out information about pods
7
8

SYNOPSIS

10       podman pod ps [options]
11
12

DESCRIPTION

14       podman pod ps lists the pods on the system.  By default it lists:
15
16
17              • pod id
18
19              • pod name
20
21              • number of containers attached to pod
22
23              • status of pod as defined by the following table
24
25
26
27       ┌────────┬───────────────────────────────┐
28       │Status  │ Description                   │
29       ├────────┼───────────────────────────────┤
30       │Created │ No   containers  running  nor │
31       │        │ stopped                       │
32       ├────────┼───────────────────────────────┤
33       │Running │ at  least  one  container  is │
34       │        │ running                       │
35       ├────────┼───────────────────────────────┤
36       │Stopped │ At    least   one   container │
37       │        │ stopped and none running      │
38       ├────────┼───────────────────────────────┤
39       │Exited  │ All containers stopped in pod │
40       ├────────┼───────────────────────────────┤
41       │Dead    │ Error retrieving state        │
42       ├────────┼───────────────────────────────┤
43       │        │                               │
44       └────────┴───────────────────────────────┘
45

OPTIONS

47   --ctr-names
48       Includes the container names in the container info field
49
50
51   --ctr-ids
52       Includes the container IDs in the container info field
53
54
55   --ctr-status
56       Includes the container statuses in the container info field
57
58
59   --latest, -l
60       Show the latest pod created (all states) (This option is not  available
61       with the remote Podman client)
62
63
64   --noheading
65       Omit the table headings from the listing of pods.
66
67
68   --no-trunc
69       Display the extended information
70
71
72   --ns
73       Display namespace information of the pod
74
75
76   --quiet, -q
77       Print the numeric IDs of the pods only
78
79
80   --format=format
81       Pretty-print containers to JSON or using a Go template
82
83
84       Valid placeholders for the Go template are listed below:
85
86
87       ┌────────────────────┬────────────────────────────┐
88       │Placeholder         │ Description                │
89       ├────────────────────┼────────────────────────────┤
90       │.ID                 │ Container ID               │
91       ├────────────────────┼────────────────────────────┤
92       │.Name               │ Name of pod                │
93       ├────────────────────┼────────────────────────────┤
94       │.Status             │ Status of pod              │
95       ├────────────────────┼────────────────────────────┤
96       │.Labels             │ All the labels assigned to │
97       │                    │ the pod                    │
98       ├────────────────────┼────────────────────────────┤
99       │.NumberOfContainers │ Show the  number  of  con‐ │
100       │                    │ tainers attached to pod    │
101       ├────────────────────┼────────────────────────────┤
102       │.Cgroup             │ Cgroup path of pod         │
103       ├────────────────────┼────────────────────────────┤
104       │.Created            │ Creation time of pod       │
105       ├────────────────────┼────────────────────────────┤
106       │.InfraID            │ Pod infra container ID     │
107       ├────────────────────┼────────────────────────────┤
108       │.Networks           │ Show   all  networks  con‐ │
109       │                    │ nected to the  infra  con‐ │
110       │                    │ tainer                     │
111       ├────────────────────┼────────────────────────────┤
112       │                    │                            │
113       └────────────────────┴────────────────────────────┘
114
115   --sort
116       Sort by created, ID, name, status, or number of containers
117
118
119       Default: created
120
121
122   --filter, -f=filter
123       Filter output based on conditions given.  Multiple filters can be given
124       with multiple uses of the --filter flag.  Filters  with  the  same  key
125       work  inclusive with the only exception being label which is exclusive.
126       Filters with different keys always work exclusive.
127
128
129       Valid filters are listed below:
130
131
132       ┌────────────────┬───────────────────────────────┐
133       │Filter          │ Description                   │
134       ├────────────────┼───────────────────────────────┤
135       │id              │ [ID] Pod's ID (accepts regex) │
136       ├────────────────┼───────────────────────────────┤
137       │name            │ [Name]  Pod's  name  (accepts │
138       │                │ regex)                        │
139       ├────────────────┼───────────────────────────────┤
140       │label           │ [Key]  or  [Key=Value]  Label │
141       │                │ assigned to a container       │
142       ├────────────────┼───────────────────────────────┤
143       │status          │ Pod's status:                 │
144       ├────────────────┼───────────────────────────────┤
145       │stopped,        │                               │
146       ├────────────────┼───────────────────────────────┤
147       │running,        │                               │
148       ├────────────────┼───────────────────────────────┤
149       │paused,         │                               │
150       ├────────────────┼───────────────────────────────┤
151       │exited,         │                               │
152       ├────────────────┼───────────────────────────────┤
153       │dead,           │                               │
154       ├────────────────┼───────────────────────────────┤
155       │created,        │                               │
156       ├────────────────┼───────────────────────────────┤
157       │degradednetwork │ [Network] name or full ID  of │
158       │                │ network                       │
159       ├────────────────┼───────────────────────────────┤
160       │ctr-names       │ Container name within the pod │
161       │                │ (accepts regex)               │
162       ├────────────────┼───────────────────────────────┤
163       │ctr-ids         │ Container ID within  the  pod │
164       │                │ (accepts regex)               │
165       ├────────────────┼───────────────────────────────┤
166       │ctr-status      │ Container  status  within the │
167       │                │ pod                           │
168       ├────────────────┼───────────────────────────────┤
169       │ctr-number      │ Number of containers  in  the │
170       │                │ pod                           │
171       ├────────────────┼───────────────────────────────┤
172       │                │                               │
173       └────────────────┴───────────────────────────────┘
174
175   --help, -h
176       Print usage statement
177
178

EXAMPLES

180              $ podman pod ps
181              POD ID         NAME              STATUS    NUMBER OF CONTAINERS
182              00dfd6fa02c0   jolly_goldstine   Running   1
183              f4df8692e116   nifty_torvalds    Created   2
184
185
186
187              $ podman pod ps --ctr-names
188              POD ID         NAME              STATUS    CONTAINER INFO
189              00dfd6fa02c0   jolly_goldstine   Running   [ loving_archimedes ]
190              f4df8692e116   nifty_torvalds    Created   [ thirsty_hawking ] [ wizardly_golick ]
191
192
193
194              $ podman pod ps --ctr-status --ctr-names --ctr-ids
195              POD ID         NAME              STATUS    CONTAINER INFO
196              00dfd6fa02c0   jolly_goldstine   Running   [ ba465ab0a3a4 loving_archimedes Running ]
197              f4df8692e116   nifty_torvalds    Created   [ 331693bff40a thirsty_hawking Created ] [ 8e428daeb89e wizardly_golick Created ]
198
199
200
201              $ podman pod ps --format "{{.ID}}  {{.ContainerInfo}}  {{.Cgroup}}" --ctr-names
202              00dfd6fa02c0      [ loving_archimedes ]                         /libpod_parent
203              f4df8692e116      [ thirsty_hawking ] [ wizardly_golick ]       /libpod_parent
204
205
206
207              $ podman pod ps --cgroup
208              POD ID         NAME              STATUS    NUMBER OF CONTAINERS   CGROUP           USE POD CGROUP
209              00dfd6fa02c0   jolly_goldstine   Running   1                      /libpod_parent   true
210              f4df8692e116   nifty_torvalds    Created   2                      /libpod_parent   true
211
212
213
214              $ podman pod ps --sort id --filter ctr-number=2
215              POD ID         NAME             STATUS    NUMBER OF CONTAINERS
216              f4df8692e116   nifty_torvalds   Created   2
217
218
219
220              $ podman pod ps  --ctr-ids
221              POD ID         NAME              STATUS    CONTAINER INFO
222              00dfd6fa02c0   jolly_goldstine   Running   [ ba465ab0a3a4 ]
223              f4df8692e116   nifty_torvalds    Created   [ 331693bff40a ] [ 8e428daeb89e ]
224
225
226
227              $ podman pod ps --no-trunc --ctr-ids
228              POD ID                                                             NAME              STATUS    CONTAINER INFO
229              00dfd6fa02c0a2daaedfdf8fcecd06f22ad114d46d167d71777224735f701866   jolly_goldstine   Running   [ ba465ab0a3a4e15e3539a1e79c32d1213a02b0989371e274f98e0f1ae9de7050 ]
230              f4df8692e116a3e6d1d62572644ed36ca475d933808cc3c93435c45aa139314b   nifty_torvalds    Created   [ 331693bff40a0ef2f05a3aba73ce49e3243108911927fff04d1f7fc44dda8022 ] [ 8e428daeb89e69b71e7916a13accfb87d122889442b5c05c2d99cf94a3230e9d ]
231
232
233
234              $ podman pod ps --ctr-names
235              POD ID         NAME   STATUS    CONTAINER INFO
236              314f4da82d74   hi     Created   [ jovial_jackson ] [ hopeful_archimedes ] [ vibrant_ptolemy ] [ heuristic_jennings ] [ keen_raman ] [ hopeful_newton ] [ mystifying_bose ] [ silly_lalande ] [ serene_lichterman ] ...
237
238
239

pod ps

241       Print a list of pods
242
243

HISTORY

249       July   2018,   Originally  compiled  by  Peter  Hunt  pehunt@redhat.com
250       ⟨mailto:pehunt@redhat.com⟩
251
252
253
254                                                            podman-pod-ps(1)()