diff options
| author | Paul Holzinger <paul.holzinger@web.de> | 2020-12-01 22:12:16 +0100 |
|---|---|---|
| committer | Paul Holzinger <paul.holzinger@web.de> | 2020-12-02 10:27:00 +0100 |
| commit | c31a5c0d9c9db52f03caa443a3fdfdce194046e8 (patch) | |
| tree | fe21af9d8e5b87e6fa4054bb8d30ce17ab673662 /docs/source | |
| parent | 9c5fe954cca8b4bcb8f552645e1f52a5d9824134 (diff) | |
| download | podman-c31a5c0d9c9db52f03caa443a3fdfdce194046e8.tar.gz podman-c31a5c0d9c9db52f03caa443a3fdfdce194046e8.tar.bz2 podman-c31a5c0d9c9db52f03caa443a3fdfdce194046e8.zip | |
Add support for network ids
The network ID is not stored. It is just the sha256 hash from
the network name. There is a risk of a potential hash collision.
However it's very unlikely and even if we hit this it will
complain that more than network with this ID exists.
The main benefit is that the compat api can have proper
network ID support. Also this adds the support for
`podman network ls --format "{{.ID}}"` and `--filter id=<ID>`.
It also ensures that we can do network rm <ID> and network
inspect <ID>.
Since we use a hash this commit is backwards compatible even for
already existing networks.
Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/markdown/podman-network-ls.1.md | 31 |
1 files changed, 23 insertions, 8 deletions
diff --git a/docs/source/markdown/podman-network-ls.1.md b/docs/source/markdown/podman-network-ls.1.md index fcba51190..a964c97e8 100644 --- a/docs/source/markdown/podman-network-ls.1.md +++ b/docs/source/markdown/podman-network-ls.1.md @@ -10,14 +10,6 @@ podman\-network\-ls - Display a summary of CNI networks Displays a list of existing podman networks. This command is not available for rootless users. ## OPTIONS -#### **--quiet**, **-q** - -The `quiet` option will restrict the output to only the network names. - -#### **--format** - -Pretty-print networks to JSON or using a Go template. - #### **--filter**, **-f** Filter output based on conditions given. @@ -30,10 +22,33 @@ Valid filters are listed below: | **Filter** | **Description** | | ---------- | ------------------------------------------------------------------------------------- | | name | [Name] Network name (accepts regex) | +| id | [ID] Full or partial network ID | | label | [Key] or [Key=Value] Label assigned to a network | | plugin | [Plugin] CNI plugins included in a network (e.g `bridge`,`portmap`,`firewall`,`tuning`,`dnsname`,`macvlan`) | | driver | [Driver] Only `bridge` is supported | +#### **--format** + +Change the default output format. This can be of a supported type like 'json' +or a Go template. +Valid placeholders for the Go template are listed below: + +| **Placeholder** | **Description** | +| --------------- | --------------------------------| +| .ID | Network ID | +| .Name | Network name | +| .Plugins | Network Plugins | +| .Labels | Network labels | +| .Version | CNI Version of the config file | + +#### **--no-trunc** + +Do not truncate the network ID. The network ID is not displayed by default and must be specified with **--format**. + +#### **--quiet**, **-q** + +The `quiet` option will restrict the output to only the network names. + ## EXAMPLE Display networks |