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

EXAMPLES

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

pod ps

239       Print a list of pods
240
241

HISTORY

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