docker_network – Manage Docker networks — Ansible Documentation

Parameter
Choices/Defaults
Comments

api_version

string

Default:

“auto”

The version of the Docker API running on the Docker Host.

Defaults to the latest version of the API supported by Docker SDK for Python and the docker daemon.

If the value is not specified in the task, the value of environment variable DOCKER_API_VERSION will be used instead. If the environment variable is not set, the default value will be used.

aliases: docker_api_version

appends

boolean

Choices:

no ←
yes

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.

aliases: incremental

attachable

boolean

added in 2.8

Choices:

If enabled, and the network is in the global scope, non-service containers on worker nodes will be able to connect to the network.

ca_cert

path

Use a CA certificate when performing server verification by providing the path to a CA certificate file.

If the value is not specified in the task and the environment variable DOCKER_CERT_PATH is set, the file ca.pem from the directory specified in the environment variable DOCKER_CERT_PATH will be used.

aliases: tls_ca_cert, cacert_path

client_cert

path

Path to the client’s TLS certificate file.

If the value is not specified in the task and the environment variable DOCKER_CERT_PATH is set, the file cert.pem from the directory specified in the environment variable DOCKER_CERT_PATH will be used.

aliases: tls_client_cert, cert_path

client_key

path

Path to the client’s TLS key file.

If the value is not specified in the task and the environment variable DOCKER_CERT_PATH is set, the file key.pem from the directory specified in the environment variable DOCKER_CERT_PATH will be used.

aliases: tls_client_key, key_path

connected

list

elements=string

List of container names or container IDs to connect to a network.

Please note that the module only makes sure that these containers are connected to the network, but does not care about connection options. If you rely on specific IP addresses etc., use the

docker_container

module to ensure your containers are correctly connected to this network.

aliases: containers

debug

boolean

Choices:

no ←
yes

Debug mode

docker_host

string

Default:

“unix://var/run/docker.sock”

The URL or Unix socket path used to connect to the Docker API. To connect to a remote host, provide the TCP connection string. For example, tcp://192.0.2.23:2376. If TLS is used to encrypt the connection, the module will automatically replace tcp in the connection URL with https.

If the value is not specified in the task, the value of environment variable DOCKER_HOST will be used instead. If the environment variable is not set, the default value will be used.

aliases: docker_url

driver

string

Default:

“bridge”

Specify the type of network. Docker provides bridge and overlay drivers, but 3rd party drivers can also be used.

driver_options

dictionary

Dictionary of network settings. Consult docker docs for valid options and values.

enable_ipv6

boolean

added in 2.8

Choices:

Enable IPv6 networking.

force

boolean

Choices:

no ←
yes

With state absent forces disconnecting all containers from the network prior to deleting the network. With state present will disconnect all containers, delete the network and re-create the 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 new options.

internal

boolean

added in 2.8

Choices:

Restrict external access to the network.

ipam_config

list

elements=dictionary

added in 2.8

List of IPAM config blocks. Consult Docker docs for valid options and values. Note that iprange is spelled differently here (we use the notation from the Docker SDK for Python).

aux_addresses

dictionary

Auxiliary IP addresses used by Network driver, as a mapping from hostname to IP.

gateway

string

IP gateway address.

iprange

string

IP address range in CIDR notation.

subnet

string

IP subset in CIDR notation.

ipam_driver

string

Specify an IPAM driver.

ipam_driver_options

dictionary

added in 2.8

Dictionary of IPAM driver options.

ipam_options

dictionary

Dictionary of IPAM options.

Deprecated in 2.8, will be removed in 2.12. Use parameter ipam_config instead. In Docker 1.10.0, IPAM options were introduced (see here ). This module parameter addresses the IPAM config not the newly introduced IPAM options. For the IPAM options, see the ipam_driver_options parameter.

aux_addresses

dictionary

Auxiliary IP addresses used by Network driver, as a mapping from hostname to IP.

gateway

string

IP gateway address.

iprange

string

IP address range in CIDR notation.

subnet

string

IP subset in CIDR notation.

labels

dictionary

added in 2.8

Dictionary of labels.

name

string

required

Name of the network to operate on.

aliases: network_name

scope

string

added in 2.8

Choices:

local
global
swarm

Specify the network’s scope.

ssl_version

string

Provide a valid SSL version number. Default value determined by ssl.py module.

If the value is not specified in the task, the value of environment variable DOCKER_SSL_VERSION will be used instead.

state

string

Choices:

absent
present ←

absent deletes the network. If a network has connected containers, it cannot be deleted. Use the force option to disconnect all containers and delete the network.

present creates the network, if it does not already exist with the specified parameters, and connects the list of containers provided via the connected parameter. Containers not on the list will be disconnected. An empty list will leave no containers connected to the network. Use the appends option to leave existing containers connected. Use the force options to force re-creation of the network.

timeout

integer

Default:

The maximum amount of time in seconds to wait on a response from the API.

If the value is not specified in the task, the value of environment variable DOCKER_TIMEOUT will be used instead. If the environment variable is not set, the default value will be used.

tls

boolean

Choices:

no ←
yes

Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server. Note that if validate_certs is set to yes as well, it will take precedence.

If the value is not specified in the task, the value of environment variable DOCKER_TLS will be used instead. If the environment variable is not set, the default value will be used.

tls_hostname

string

Default:

“localhost”

When verifying the authenticity of the Docker Host server, provide the expected name of the server.

If the value is not specified in the task, the value of environment variable DOCKER_TLS_HOSTNAME will be used instead. If the environment variable is not set, the default value will be used.

validate_certs

boolean

Choices:

no ←
yes

Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server.

If the value is not specified in the task, the value of environment variable DOCKER_TLS_VERIFY will be used instead. If the environment variable is not set, the default value will be used.

aliases: tls_verify