mirror of
https://github.com/docker/cli.git
synced 2026-10-07 22:45:48 -04:00
Yoan Wainmann
d573c171fe
Document how multiple --filter flags interact in prune commands: different filter keys are ANDed (all conditions must match), while multiple values for the same key are ORed (any value can match). This addresses a gap in the documentation where users could not determine whether multiple filters were combined with AND or OR logic, which is especially important for prune commands where the wrong assumption could lead to unintended data removal. Closes #5899 Signed-off-by: Yoan Wainmann <yoan@mreshet.co.il>
113 lines
4.5 KiB
Markdown
113 lines
4.5 KiB
Markdown
# network prune
|
||
|
||
<!---MARKER_GEN_START-->
|
||
Remove all unused networks
|
||
|
||
### Options
|
||
|
||
| Name | Type | Default | Description |
|
||
|:----------------------|:---------|:--------|:-------------------------------------------------|
|
||
| [`--filter`](#filter) | `filter` | | Provide filter values (e.g. `until=<timestamp>`) |
|
||
| `-f`, `--force` | `bool` | | Do not prompt for confirmation |
|
||
|
||
|
||
<!---MARKER_GEN_END-->
|
||
|
||
## Description
|
||
|
||
Remove all unused networks. Unused networks are those which are not referenced
|
||
by any containers.
|
||
|
||
## Examples
|
||
|
||
```console
|
||
$ docker network prune
|
||
|
||
WARNING! This will remove all custom networks not used by at least one container.
|
||
Are you sure you want to continue? [y/N] y
|
||
Deleted Networks:
|
||
n1
|
||
n2
|
||
```
|
||
|
||
### <a name="filter"></a> Filtering (--filter)
|
||
|
||
The filtering flag (`--filter`) format is of "key=value". If there is more
|
||
than one filter, then pass multiple flags (e.g., `--filter "foo=bar" --filter "bif=baz"`).
|
||
|
||
When multiple filters are provided, they are combined as follows:
|
||
|
||
- Multiple filters with **different keys** are combined using AND logic.
|
||
A network must satisfy all filter conditions to be pruned.
|
||
- Multiple filters with the **same key** are combined using OR logic.
|
||
A network is pruned if it matches any of the values for that key.
|
||
|
||
For example, `--filter "label=foo" --filter "until=24h"` prunes networks
|
||
that have the `foo` label **and** were created more than 24 hours ago.
|
||
Conversely, `--filter "label=foo" --filter "label=bar"` prunes networks
|
||
that have **either** the `foo` **or** `bar` label.
|
||
|
||
The currently supported filters are:
|
||
|
||
* until (`<timestamp>`) - only remove networks created before given timestamp
|
||
* label (`label=<key>`, `label=<key>=<value>`, `label!=<key>`, or `label!=<key>=<value>`) - only remove networks with (or without, in case `label!=...` is used) the specified labels.
|
||
|
||
The `until` filter can be Unix timestamps, date formatted
|
||
timestamps, or Go duration strings supported by [ParseDuration](https://pkg.go.dev/time#ParseDuration) (e.g. `10m`, `1h30m`) computed
|
||
relative to the daemon machine’s time. Supported formats for date
|
||
formatted time stamps include RFC3339Nano, RFC3339, `2006-01-02T15:04:05`,
|
||
`2006-01-02T15:04:05.999999999`, `2006-01-02T07:00`, and `2006-01-02`. The local
|
||
timezone on the daemon will be used if you do not provide either a `Z` or a
|
||
`+-00:00` timezone offset at the end of the timestamp. When providing Unix
|
||
timestamps enter seconds[.nanoseconds], where seconds is the number of seconds
|
||
that have elapsed since January 1, 1970 (midnight UTC/GMT), not counting leap
|
||
seconds (aka Unix epoch or Unix time), and the optional .nanoseconds field is a
|
||
fraction of a second no more than nine digits long.
|
||
|
||
The `label` filter accepts two formats. One is the `label=...` (`label=<key>` or `label=<key>=<value>`),
|
||
which removes networks with the specified labels. The other
|
||
format is the `label!=...` (`label!=<key>` or `label!=<key>=<value>`), which removes
|
||
networks without the specified labels.
|
||
|
||
The following removes networks created more than 5 minutes ago. Note that
|
||
system networks such as `bridge`, `host`, and `none` will never be pruned:
|
||
|
||
```console
|
||
$ docker network ls
|
||
|
||
NETWORK ID NAME DRIVER SCOPE
|
||
7430df902d7a bridge bridge local
|
||
ea92373fd499 foo-1-day-ago bridge local
|
||
ab53663ed3c7 foo-1-min-ago bridge local
|
||
97b91972bc3b host host local
|
||
f949d337b1f5 none null local
|
||
|
||
$ docker network prune --force --filter until=5m
|
||
|
||
Deleted Networks:
|
||
foo-1-day-ago
|
||
|
||
$ docker network ls
|
||
|
||
NETWORK ID NAME DRIVER SCOPE
|
||
7430df902d7a bridge bridge local
|
||
ab53663ed3c7 foo-1-min-ago bridge local
|
||
97b91972bc3b host host local
|
||
f949d337b1f5 none null local
|
||
```
|
||
|
||
## Related commands
|
||
|
||
* [network disconnect ](network_disconnect.md)
|
||
* [network connect](network_connect.md)
|
||
* [network create](network_create.md)
|
||
* [network ls](network_ls.md)
|
||
* [network inspect](network_inspect.md)
|
||
* [network rm](network_rm.md)
|
||
* [Understand Docker container networks](https://docs.docker.com/network/)
|
||
* [system df](system_df.md)
|
||
* [container prune](container_prune.md)
|
||
* [image prune](image_prune.md)
|
||
* [volume prune](volume_prune.md)
|
||
* [system prune](system_prune.md)
|