docker network ls (original) (raw)

Description List networks
Usage docker network ls [OPTIONS]
AliasesAn alias is a short or memorable alternative for a longer command. docker network list

Lists all the networks the Engine daemon knows about. This includes the networks that span across multiple hosts in a cluster.

Option Default Description
-f, --filter Provide filter values (e.g. driver=bridge)
--format Format output using a custom template:'table': Print output in table format with column headers (default)'table TEMPLATE': Print output in table format using the given Go template'json': Print in JSON format'TEMPLATE': Print output using the given Go template.Refer tohttps://docs.docker.com/go/formatting/ for more information about formatting output with templates
--no-trunc Do not truncate the output
-q, --quiet Only display network IDs

List all networks

List networks without truncating the ID column (--no-trun)

Use the --no-trunc option to display the full network id:

Filtering (--filter)

The filtering flag (-f or --filter) format is a key=value pair. If there is more than one filter, then pass multiple flags (e.g. --filter "foo=bar" --filter "bif=baz"). Multiple filter flags are combined as an OR filter. For example,-f type=custom -f type=builtin returns both custom and builtin networks.

The currently supported filters are:

Driver

The driver filter matches networks based on their driver.

The following example matches networks with the bridge driver:

ID

The id filter matches on all or part of a network's ID.

The following filter matches all networks with an ID containing the63d1ff1f77b0... string.

You can also filter for a substring in an ID as this shows:

Label

The label filter matches networks based on the presence of a label alone or a label and a value.

The following filter matches networks with the usage label regardless of its value.

The following filter matches networks with the usage label with the prod value.

Name

The name filter matches on all or part of a network's name.

The following filter matches all networks with a name containing the foobar string.

You can also filter for a substring in a name as this shows:

Scope

The scope filter matches networks based on their scope.

The following example matches networks with the swarm scope:

The following example matches networks with the local scope:

Type

The type filter supports two values; builtin displays predefined networks (bridge, none, host), whereas custom displays user defined networks.

The following filter matches all user defined networks:

By having this flag it allows for batch cleanup. For example, use this filter to delete all user defined networks:

A warning will be issued when trying to remove a network that has containers attached.

Format the output (--format)

The formatting options (--format) pretty-prints networks output using a Go template.

Valid placeholders for the Go template are listed below:

Placeholder Description
.ID Network ID
.Name Network name
.Driver Network driver
.Scope Network scope (local, global)
.IPv6 Whether IPv6 is enabled on the network or not.
.Internal Whether the network is internal or not.
.Labels All labels assigned to the network.
.Label Value of a specific label for this network. For example {{.Label "project.version"}}
.CreatedAt Time when the network was created

When using the --format option, the network ls command will either output the data exactly as the template declares or, when using thetable directive, includes column headers as well.

The following example uses a template without headers and outputs theID and Driver entries separated by a colon (:) for all networks:

To list all networks in JSON format, use the json directive: