diff options
author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2021-01-19 16:56:17 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-01-19 16:56:17 -0500 |
commit | 5e7262ddf595f9187d01e12f5dcee2fe1c713798 (patch) | |
tree | 6cde028a76610dfc85eb7e27af7743af2e9842bb /docs | |
parent | 37470c4d200c5cde2f8e233dbaa6d200d94919cc (diff) | |
parent | a45d22a1ddd2840cf8c3a38540aa8683cc0d5c7d (diff) | |
download | podman-5e7262ddf595f9187d01e12f5dcee2fe1c713798.tar.gz podman-5e7262ddf595f9187d01e12f5dcee2fe1c713798.tar.bz2 podman-5e7262ddf595f9187d01e12f5dcee2fe1c713798.zip |
Merge pull request #9021 from Luap99/podman-network-exists
podman network exists
Diffstat (limited to 'docs')
-rw-r--r-- | docs/source/markdown/podman-network-exists.1.md | 44 | ||||
-rw-r--r-- | docs/source/markdown/podman-network.1.md | 1 | ||||
-rw-r--r-- | docs/source/network.rst | 2 |
3 files changed, 47 insertions, 0 deletions
diff --git a/docs/source/markdown/podman-network-exists.1.md b/docs/source/markdown/podman-network-exists.1.md new file mode 100644 index 000000000..c7edc2ac7 --- /dev/null +++ b/docs/source/markdown/podman-network-exists.1.md @@ -0,0 +1,44 @@ +% podman-network-exists(1) + +## NAME +podman\-network\-exists - Check if the given network exists + +## SYNOPSIS +**podman network exists** *network* + +## DESCRIPTION +**podman network exists** checks if a network exists. The **Name** or **ID** +of the network may be used as input. Podman will return an exit code +of `0` when the network is found. A `1` will be returned otherwise. An exit code of +`125` indicates there was an other issue. + + +## OPTIONS + +#### **--help**, **-h** + +Print usage statement + +## EXAMPLE + +Check if a network called `net1` exists (the network does actually exist). +``` +$ podman network exists net1 +$ echo $? +0 +$ +``` + +Check if an network called `webbackend` exists (the network does not actually exist). +``` +$ podman network exists webbackend +$ echo $? +1 +$ +``` + +## SEE ALSO +podman(1), podman-network-create(1), podman-network-rm(1) + +## HISTORY +January 2021, Originally compiled by Paul Holzinger <paul.holzinger@web.de> diff --git a/docs/source/markdown/podman-network.1.md b/docs/source/markdown/podman-network.1.md index 41e2ae885..3ad37b8bf 100644 --- a/docs/source/markdown/podman-network.1.md +++ b/docs/source/markdown/podman-network.1.md @@ -16,6 +16,7 @@ The network command manages CNI networks for Podman. | connect | [podman-network-connect(1)](podman-network-connect.1.md) | Connect a container to a network | | create | [podman-network-create(1)](podman-network-create.1.md) | Create a Podman CNI network | | disconnect | [podman-network-disconnect(1)](podman-network-disconnect.1.md) | Disconnect a container from a network | +| exists | [podman-network-exists(1)](podman-network-exists.1.md) | Check if the given network exists | | inspect | [podman-network-inspect(1)](podman-network-inspect.1.md) | Displays the raw CNI network configuration for one or more networks | | ls | [podman-network-ls(1)](podman-network-ls.1.md) | Display a summary of CNI networks | | reload | [podman-network-reload(1)](podman-network-reload.1.md) | Reload network configuration for containers | diff --git a/docs/source/network.rst b/docs/source/network.rst index 2ecb97858..b5829876e 100644 --- a/docs/source/network.rst +++ b/docs/source/network.rst @@ -7,6 +7,8 @@ Network :doc:`disconnect <markdown/podman-network-disconnect.1>` network disconnect +:doc:`exists <markdown/podman-network-exists.1>` network exists + :doc:`inspect <markdown/podman-network-inspect.1>` network inspect :doc:`ls <markdown/podman-network-ls.1>` network list |