diff options
Diffstat (limited to 'docs/source/markdown/podman-pod-rm.1.md.in')
| -rw-r--r-- | docs/source/markdown/podman-pod-rm.1.md.in | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-pod-rm.1.md.in b/docs/source/markdown/podman-pod-rm.1.md.in new file mode 100644 index 000000000..54646ebe3 --- /dev/null +++ b/docs/source/markdown/podman-pod-rm.1.md.in @@ -0,0 +1,79 @@ +% podman-pod-rm(1) + +## NAME +podman\-pod\-rm - Remove one or more stopped pods and containers + +## SYNOPSIS +**podman pod rm** [*options*] *pod* + +## DESCRIPTION +**podman pod rm** will remove one or more stopped pods and their containers from the host. The pod name or ID can be used. The \-f option stops all containers and then removes them before removing the pod. If all containers added by the user are in an exited state, the pod will be removed. + +## OPTIONS + +#### **--all**, **-a** + +Remove all pods. Can be used in conjunction with \-f as well. + +#### **--force**, **-f** + +Stop running containers and delete all stopped containers before removal of pod. + +#### **--ignore**, **-i** + +Ignore errors when specified pods are not in the container store. A user might +have decided to manually remove a pod which would lead to a failure during the +ExecStop directive of a systemd service referencing that pod. + +#### **--latest**, **-l** + +Instead of providing the pod name or ID, remove the last created pod. (This option is not available with the remote Podman client, including Mac and Windows (excluding WSL2) machines) + +@@option pod-id-file.pod + +#### **--time**, **-t**=*seconds* + +Seconds to wait before forcibly stopping running containers within the pod. The --force option must be specified to use the --time option. + +## EXAMPLE + +Remove pod with a given name +``` +podman pod rm mywebserverpod +``` + +Remove multiple pods with given names and/or IDs +``` +podman pod rm mywebserverpod myflaskserverpod 860a4b23 +``` + +Forcefully remove pod with a given ID +``` +podman pod rm -f 860a4b23 +``` + +Forcefully remove all pods +``` +podman pod rm -f -a +podman pod rm -fa +``` + +Remove pod using ID specified in a given file +``` +podman pod rm --pod-id-file /path/to/id/file +``` + +## Exit Status + **0** All specified pods removed + + **1** One of the specified pods did not exist, and no other failures + + **2** One of the specified pods is attached to a container + + **125** The command fails for any other reason + +## SEE ALSO +**[podman(1)](podman.1.md)**, **[podman-pod(1)](podman-pod.1.md)** + +## HISTORY +July 2018, Originally compiled by Peter Hunt <pehunt@redhat.com> |