podman-pod-ps(1)

1podman-pod-ps(1)            General Commands Manual           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       --quiet, -q
79
80
81       Print the numeric IDs of the pods only
82
83
84       --format
85
86
87       Pretty-print containers to JSON or using a Go template
88
89
90       Valid placeholders for the Go template are listed below:
91
92
93       ┌────────────────────┬────────────────────────────┐
94       │Placeholder         │ Description                │
95       ├────────────────────┼────────────────────────────┤
96       │.ID                 │ Container ID               │
97       ├────────────────────┼────────────────────────────┤
98       │.Name               │ Name of pod                │
99       ├────────────────────┼────────────────────────────┤
100       │.Status             │ Status of pod              │
101       ├────────────────────┼────────────────────────────┤
102       │.Labels             │ All the labels assigned to │
103       │                    │ the pod                    │
104       ├────────────────────┼────────────────────────────┤
105       │.ContainerInfo      │ Show the names, ids and/or │
106       │                    │ statuses of containers     │
107       │                    │ (only shows 9 unless       │
108       │                    │ no-trunc is specified)     │
109       ├────────────────────┼────────────────────────────┤
110       │.NumberOfContainers │ Show the number of         │
111       │                    │ containers attached to pod │
112       ├────────────────────┼────────────────────────────┤
113       │.Cgroup             │ Cgroup path of pod         │
114       ├────────────────────┼────────────────────────────┤
115       │.UsePodCgroup       │ Whether containers use the │
116       │                    │ Cgroup of the pod          │
117       └────────────────────┴────────────────────────────┘
118
119       --sort
120
121
122       Sort by created, ID, name, status, or number of containers
123
124
125       Default: created
126
127
128       --filter, -f
129
130
131       Filter output based on conditions given
132
133
134       Valid filters are listed below:
135
136
137       ┌───────────┬───────────────────────────────┐
138       │Filter     │ Description                   │
139       ├───────────┼───────────────────────────────┤
140       │id         │ [ID] Pod's ID                 │
141       ├───────────┼───────────────────────────────┤
142       │name       │ [Name] Pod's name             │
143       ├───────────┼───────────────────────────────┤
144       │label      │ [Key] or [Key=Value] Label    │
145       │           │ assigned to a container       │
146       ├───────────┼───────────────────────────────┤
147       │ctr-names  │ Container name within the pod │
148       ├───────────┼───────────────────────────────┤
149       │ctr-ids    │ Container ID within the pod   │
150       ├───────────┼───────────────────────────────┤
151       │ctr-status │ Container status within the   │
152       │           │ pod                           │
153       ├───────────┼───────────────────────────────┤
154       │ctr-number │ Number of containers in the   │
155       │           │ pod                           │
156       └───────────┴───────────────────────────────┘
157
158       --help, -h
159
160
161       Print usage statement
162
163

EXAMPLES

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

pod ps

226       Print a list of pods
227
228

HISTORY

234       July 2018, Originally compiled by Peter Hunt ⟨pehunt@redhat.com⟩
235
236
237
238                                                              podman-pod-ps(1)