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

OPTIONS

45       --ctr-names
46
47
48       Includes the container names in the container info field
49
50
51       --ctr-ids
52
53
54       Includes the container IDs in the container info field
55
56
57       --ctr-status
58
59
60       Includes the container statuses in the container info field
61
62
63       --latest, -l
64
65
66       Show the latest pod created (all states)
67
68
69       The latest option is not supported on the remote client.
70
71
72       --no-trunc
73
74
75       Display the extended information
76
77
78       --ns
79
80
81       Display namespace information of the pod
82
83
84       --quiet, -q
85
86
87       Print the numeric IDs of the pods only
88
89
90       --format=format
91
92
93       Pretty-print containers to JSON or using a Go template
94
95
96       Valid placeholders for the Go template are listed below:
97
98
99       ┌────────────────────┬────────────────────────────┐
100       │Placeholder         │ Description                │
101       ├────────────────────┼────────────────────────────┤
102       │.ID                 │ Container ID               │
103       ├────────────────────┼────────────────────────────┤
104       │.Name               │ Name of pod                │
105       ├────────────────────┼────────────────────────────┤
106       │.Status             │ Status of pod              │
107       ├────────────────────┼────────────────────────────┤
108       │.Labels             │ All the labels assigned to │
109       │                    │ the pod                    │
110       ├────────────────────┼────────────────────────────┤
111       │.ContainerInfo      │ Show the names, ids and/or │
112       │                    │ statuses   of   containers │
113       │                    │ (only   shows   9   unless │
114       │                    │ no-trunc is specified)     │
115       ├────────────────────┼────────────────────────────┤
116       │.NumberOfContainers │ Show the  number  of  con‐ │
117       │                    │ tainers attached to pod    │
118       ├────────────────────┼────────────────────────────┤
119       │.Cgroup             │ Cgroup path of pod         │
120       ├────────────────────┼────────────────────────────┤
121       │.UsePodCgroup       │ Whether containers use the │
122       │                    │ Cgroup of the pod          │
123       └────────────────────┴────────────────────────────┘
124
125       --sort
126
127
128       Sort by created, ID, name, status, or number of containers
129
130
131       Default: created
132
133
134       --filter, -f=filter
135
136
137       Filter output based on conditions given
138
139
140       Valid filters are listed below:
141
142
143       ┌───────────┬───────────────────────────────┐
144       │Filter     │ Description                   │
145       ├───────────┼───────────────────────────────┤
146       │id         │ [ID] Pod's ID                 │
147       ├───────────┼───────────────────────────────┤
148       │name       │ [Name] Pod's name             │
149       ├───────────┼───────────────────────────────┤
150       │label      │ [Key]  or  [Key=Value]  Label │
151       │           │ assigned to a container       │
152       ├───────────┼───────────────────────────────┤
153       │ctr-names  │ Container name within the pod │
154       ├───────────┼───────────────────────────────┤
155       │ctr-ids    │ Container ID within the pod   │
156       ├───────────┼───────────────────────────────┤
157       │ctr-status │ Container  status  within the │
158       │           │ pod                           │
159       ├───────────┼───────────────────────────────┤
160       │ctr-number │ Number of containers  in  the │
161       │           │ pod                           │
162       └───────────┴───────────────────────────────┘
163
164       --help, -h
165
166
167       Print usage statement
168
169

EXAMPLES

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

pod ps

232       Print a list of pods
233
234

HISTORY

240       July   2018,   Originally  compiled  by  Peter  Hunt  pehunt@redhat.com
241       ⟨mailto:pehunt@redhat.com⟩
242
243
244
245                                                            podman-pod-ps(1)()