summaryrefslogtreecommitdiff
path: root/docs/podman-container-exists.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2018-11-25 16:26:39 -0600
committerbaude <bbaude@redhat.com>2018-11-26 09:19:39 -0600
commit9d883d2032b112d5c65040629313cfba0de6c479 (patch)
tree581d8a9bf1875426c4e3ebafe8f0bddd36559031 /docs/podman-container-exists.1.md
parente3ece3bb907145110408c54f70b839777b09da44 (diff)
downloadpodman-9d883d2032b112d5c65040629313cfba0de6c479.tar.gz
podman-9d883d2032b112d5c65040629313cfba0de6c479.tar.bz2
podman-9d883d2032b112d5c65040629313cfba0de6c479.zip
add podman container|image exists
Add an exists subcommand to podman container and podman image that allows users to verify the existence of a container or image by ID or name. The return code can be 0 (success), 1 (failed to find), or 125 (failed to work with runtime). Issue #1845 Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/podman-container-exists.1.md')
-rw-r--r--docs/podman-container-exists.1.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/podman-container-exists.1.md b/docs/podman-container-exists.1.md
new file mode 100644
index 000000000..76701e2c2
--- /dev/null
+++ b/docs/podman-container-exists.1.md
@@ -0,0 +1,40 @@
+% PODMAN(1) Podman Man Pages
+% Brent Baude
+% November 2018
+# NAME
+podman-container-exists- Check if a container exists in local storage
+
+# SYNOPSIS
+**podman container exists**
+[**-h**|**--help**]
+CONTAINER
+
+# DESCRIPTION
+**podman container exists** checks if a container exists in local storage. The **ID** or **Name**
+of the container may be used as input. Podman will return an exit code
+of `0` when the container is found. A `1` will be returned otherwise. An exit code of `125` indicates there
+was an issue accessing the local storage.
+
+## Examples ##
+
+Check if an container called `webclient` exists in local storage (the container does actually exist).
+```
+$ sudo podman container exists webclient
+$ echo $?
+0
+$
+```
+
+Check if an container called `webbackend` exists in local storage (the container does not actually exist).
+```
+$ sudo podman container exists webbackend
+$ echo $?
+1
+$
+```
+
+## SEE ALSO
+podman(1)
+
+# HISTORY
+November 2018, Originally compiled by Brent Baude (bbaude at redhat dot com)