summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoropenshift-ci[bot] <75433959+openshift-ci[bot]@users.noreply.github.com>2022-08-03 17:23:07 +0000
committerGitHub <noreply@github.com>2022-08-03 17:23:07 +0000
commit5fc7339aa1f383828a2f4949b0d9b8a7553374d7 (patch)
treef71f3f817d04cae5a51373264e8eda84863f28a7 /docs
parentc1a38eb773af07b1f84a2b3f1780b216c4278e15 (diff)
parent53ec479685a7636a1bcc75bf3a88fbf7d95ba72a (diff)
downloadpodman-5fc7339aa1f383828a2f4949b0d9b8a7553374d7.tar.gz
podman-5fc7339aa1f383828a2f4949b0d9b8a7553374d7.tar.bz2
podman-5fc7339aa1f383828a2f4949b0d9b8a7553374d7.zip
Merge pull request #15084 from sstosh/rm-filter
Add rm --filter option
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/podman-rm.1.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-rm.1.md b/docs/source/markdown/podman-rm.1.md
index 1fac3aa34..1dbd1d0c3 100644
--- a/docs/source/markdown/podman-rm.1.md
+++ b/docs/source/markdown/podman-rm.1.md
@@ -26,6 +26,30 @@ Read container ID from the specified file and remove the container. Can be spec
Remove selected container and recursively remove all containers that depend on it.
+#### **--filter**=*filter*
+
+Filter what containers remove.
+Multiple filters can be given with multiple uses of the --filter flag.
+Filters with the same key work inclusive with the only exception being
+`label` which is exclusive. Filters with different keys always work exclusive.
+
+Valid filters are listed below:
+
+| **Filter** | **Description** |
+| --------------- | -------------------------------------------------------------------------------- |
+| id | [ID] Container's ID (accepts regex) |
+| name | [Name] Container's name (accepts regex) |
+| label | [Key] or [Key=Value] Label assigned to a container |
+| exited | [Int] Container's exit code |
+| status | [Status] Container's status: 'created', 'exited', 'paused', 'running', 'unknown' |
+| ancestor | [ImageName] Image or descendant used to create container |
+| before | [ID] or [Name] Containers created before this container |
+| since | [ID] or [Name] Containers created since this container |
+| volume | [VolumeName] or [MountpointDestination] Volume mounted in container |
+| health | [Status] healthy or unhealthy |
+| pod | [Pod] name or full or partial ID of pod |
+| network | [Network] name or full ID of network |
+
#### **--force**, **-f**
Force the removal of running and paused containers. Forcing a container removal also