|
|
@ -51,11 +51,10 @@ options:
|
|
|
|
|
|
|
|
|
|
|
|
force:
|
|
|
|
force:
|
|
|
|
description:
|
|
|
|
description:
|
|
|
|
- >
|
|
|
|
- With state I(absent) forces disconnecting all containers from the
|
|
|
|
With state 'absent' forces disconnecting all containers from the
|
|
|
|
network prior to deleting the network. With state I(present) will
|
|
|
|
network prior to deleting the network. With state 'present' will
|
|
|
|
|
|
|
|
disconnect all containers, delete the network and re-create the
|
|
|
|
disconnect all containers, delete the network and re-create the
|
|
|
|
network. This option is required if you have changed the ipam or
|
|
|
|
network. This option is required if you have changed the IPAM or
|
|
|
|
driver options and want an existing network to be updated to use the
|
|
|
|
driver options and want an existing network to be updated to use the
|
|
|
|
new options.
|
|
|
|
new options.
|
|
|
|
default: false
|
|
|
|
default: false
|
|
|
@ -63,7 +62,7 @@ options:
|
|
|
|
appends:
|
|
|
|
appends:
|
|
|
|
description:
|
|
|
|
description:
|
|
|
|
- By default the connected list is canonical, meaning containers not on the list are removed from the network.
|
|
|
|
- By default the connected list is canonical, meaning containers not on the list are removed from the network.
|
|
|
|
Use 'appends' to leave existing containers connected.
|
|
|
|
Use C(appends) to leave existing containers connected.
|
|
|
|
default: false
|
|
|
|
default: false
|
|
|
|
aliases:
|
|
|
|
aliases:
|
|
|
|
- incremental
|
|
|
|
- incremental
|
|
|
@ -80,17 +79,15 @@ options:
|
|
|
|
|
|
|
|
|
|
|
|
state:
|
|
|
|
state:
|
|
|
|
description:
|
|
|
|
description:
|
|
|
|
- >
|
|
|
|
- I(absent) deletes the network. If a network has connected containers, it
|
|
|
|
"absent" deletes the network. If a network has connected containers, it
|
|
|
|
cannot be deleted. Use the C(force) option to disconnect all containers
|
|
|
|
cannot be deleted. Use the force option to disconnect all containers
|
|
|
|
|
|
|
|
and delete the network.
|
|
|
|
and delete the network.
|
|
|
|
- >
|
|
|
|
- I(present) creates the network, if it does not already exist with the
|
|
|
|
"present" creates the network, if it does not already exist with the
|
|
|
|
|
|
|
|
specified parameters, and connects the list of containers provided via
|
|
|
|
specified parameters, and connects the list of containers provided via
|
|
|
|
the connected parameter. Containers not on the list will be
|
|
|
|
the connected parameter. Containers not on the list will be disconnected.
|
|
|
|
disconnected. An empty list will leave no containers connected to the
|
|
|
|
An empty list will leave no containers connected to the network. Use the
|
|
|
|
network. Use the appends option to leave existing containers
|
|
|
|
C(appends) option to leave existing containers connected. Use the C(force)
|
|
|
|
connected. Use the force options to force re-creation of the network.
|
|
|
|
options to force re-creation of the network.
|
|
|
|
default: present
|
|
|
|
default: present
|
|
|
|
choices:
|
|
|
|
choices:
|
|
|
|
- absent
|
|
|
|
- absent
|
|
|
|