summaryrefslogtreecommitdiff
path: root/docs/podman-pod-exists.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2018-12-01 13:51:58 -0600
committerbaude <bbaude@redhat.com>2018-12-03 12:00:18 -0600
commit318bf7017bcb82da9f73cfce9e3a963b61252788 (patch)
treea572d02d29dacb4ad9b59887e7f8a7daac722b24 /docs/podman-pod-exists.1.md
parent5bb66a47a46ea3cd66a86889d39b57bb28256c7a (diff)
downloadpodman-318bf7017bcb82da9f73cfce9e3a963b61252788.tar.gz
podman-318bf7017bcb82da9f73cfce9e3a963b61252788.tar.bz2
podman-318bf7017bcb82da9f73cfce9e3a963b61252788.zip
podman pod exists
like containers and images, users would benefit from being able to check if a pod exists in local storage. if the pod exists, the return code is 0. if the pod does not exists, the return code is 1. Any other return code indicates a real errors, such as permissions or runtime. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/podman-pod-exists.1.md')
-rw-r--r--docs/podman-pod-exists.1.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/podman-pod-exists.1.md b/docs/podman-pod-exists.1.md
new file mode 100644
index 000000000..8fb2fc90e
--- /dev/null
+++ b/docs/podman-pod-exists.1.md
@@ -0,0 +1,40 @@
+% podman-pod-exits(1) Podman Man Pages
+% Brent Baude
+% December 2018
+# NAME
+podman-pod-exists- Check if a pod exists in local storage
+
+# SYNOPSIS
+**podman pod exists**
+[**-h**|**--help**]
+POD
+
+# DESCRIPTION
+**podman pod exists** checks if a pod exists in local storage. The **ID** or **Name**
+of the pod may be used as input. Podman will return an exit code
+of `0` when the pod 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 a pod called `web` exists in local storage (the pod does actually exist).
+```
+$ sudo podman pod exists web
+$ echo $?
+0
+$
+```
+
+Check if a pod called `backend` exists in local storage (the pod does not actually exist).
+```
+$ sudo podman pod exists backend
+$ echo $?
+1
+$
+```
+
+## SEE ALSO
+podman-pod(1), podman(1)
+
+# HISTORY
+December 2018, Originally compiled by Brent Baude (bbaude at redhat dot com)