Files
podman/docs/source/markdown/podman-network-ls.1.md
Paul Holzinger 8494bcb866 podman network label support
Add label support for podman network create. Use the `args`
field in the cni config file to store the podman labels.
Use `podman_labels` as key name and store the labels as
map[string]string.

For reference: https://github.com/containernetworking/cni/blob/master/CONVENTIONS.md#args-in-network-config
https://github.com/containernetworking/cni/blob/spec-v0.4.0/SPEC.md#network-configuration

Example snippet:

```
...
"args": {
	"podman_labels": {
		"key1":"value1",
		"key2":"value2"
	}
}
...
```

Make podman network list support several filters. Supported filters are name,
plugin, driver and label. Filters with different keys work exclusive. Several label
filters work exclusive and the other filter keys are working inclusive.

Also adjust the compat api to support labels in network create and list.

Breaking changes:

- podman network ls -f shortform is used for --filter instead --format
This matches docker and other podman commands (container ps, volume ps)

- libpod network list endpoint filter parameter is removed. Instead the
filters paramter should be used as json encoded map[string][]string.

Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
2020-11-28 18:35:43 +01:00

2.0 KiB

% podman-network-ls(1)

NAME

podman-network-ls - Display a summary of CNI networks

SYNOPSIS

podman network ls [options]

DESCRIPTION

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. Multiple filters can be given with multiple uses of the --filter flag. Filters with the same key work inclusive with the only exception being label which is exclusive. Filters with different keys always work exclusive.

Valid filters are listed below:

Filter Description
name [Name] Network name (accepts regex)
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

EXAMPLE

Display networks

# podman network ls
NAME      VERSION   PLUGINS
podman    0.3.0     bridge,portmap
podman2   0.3.0     bridge,portmap
outside   0.3.0     bridge
podman9   0.3.0     bridge,portmap

Display only network names

# podman network ls -q
podman
podman2
outside
podman9

Display name of network which support bridge plugin

# podman network ls --filter plugin=portmap --format {{.Name}}
podman
podman2
podman9

SEE ALSO

podman(1), podman-network(1), podman-network-inspect(1)

HISTORY

August 2019, Originally compiled by Brent Baude bbaude@redhat.com