diff options
Diffstat (limited to 'docs')
| -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 |