docker_network - Manage Docker networks
New in version 2.2.
Synopsis
- Create/remove Docker networks and connect containers to them.
- Performs largely the same function as the “docker network” CLI subcommand.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.6
- docker-py >= 1.7.0
- The docker server >= 1.9.0
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| api_version | Default:
default provided by docker-py
|
The version of the Docker API running on the Docker Host. Defaults to the latest version of the API supported by docker-py.
aliases: docker_api_version |
| appends | Default:
no
|
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 |
| cacert_path | Default:
None
|
Use a CA certificate when performing server verification by providing the path to a CA certificate file.
aliases: tls_ca_cert |
| cert_path | Default:
None
|
Path to the client's TLS certificate file.
aliases: tls_client_cert |
| connected | Default:
None
|
List of container names or container IDs to connect to a network.
aliases: containers |
| docker_host | 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'.
aliases: docker_url |
| driver | Default:
bridge
|
Specify the type of network. Docker provides bridge and overlay drivers, but 3rd party drivers can also be used.
|
| driver_options | Default:
None
|
Dictionary of network settings. Consult docker docs for valid options and values.
|
| force | Default:
no
|
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.
|
| ipam_driver | Default:
None
|
Specify an IPAM driver.
|
| ipam_options | Default:
None
|
Dictionary of IPAM options.
|
| key_path | Default:
None
|
Path to the client's TLS key file.
aliases: tls_client_key |
| name
required
|
Name of the network to operate on.
aliases: network_name |
|
| ssl_version | Default:
1.0
|
Provide a valid SSL version number. Default value determined by docker-py, currently 1.0.
|
| state |
|
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 | Default:
60
|
The maximum amount of time in seconds to wait on a response from the API.
|
| tls | Default:
no
|
Secure the connection to the API by using TLS without verifying the authenticity of the Docker host server.
|
| tls_hostname | Default:
localhost
|
When verifying the authenticity of the Docker Host server, provide the expected name of the server.
|
| tls_verify | Default:
no
|
Secure the connection to the API by using TLS and verifying the authenticity of the Docker host server.
|
Notes
Note
- Connect to the Docker daemon by providing parameters with each task or by defining environment variables. You can define DOCKER_HOST, DOCKER_TLS_HOSTNAME, DOCKER_API_VERSION, DOCKER_CERT_PATH, DOCKER_SSL_VERSION, DOCKER_TLS, DOCKER_TLS_VERIFY and DOCKER_TIMEOUT. If you are using docker machine, run the script shipped with the product that sets up the environment. It will set these variables for you. See https://docker-py.readthedocs.org/en/stable/machine/ for more details.
Examples
- name: Create a network
docker_network:
name: network_one
- name: Remove all but selected list of containers
docker_network:
name: network_one
connected:
- container_a
- container_b
- container_c
- name: Remove a single container
docker_network:
name: network_one
connected: "{{ fulllist|difference(['container_a']) }}"
- name: Add a container to a network, leaving existing containers connected
docker_network:
name: network_one
connected:
- container_a
appends: yes
- name: Create a network with options
docker_network:
name: network_two
driver_options:
com.docker.network.bridge.name: net2
ipam_options:
subnet: '172.3.26.0/16'
gateway: 172.3.26.1
iprange: '192.168.1.0/24'
- name: Delete a network, disconnecting all containers
docker_network:
name: network_one
state: absent
force: yes
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| facts
dict
|
success |
Network inspection results for the affected network.
|
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Ben Keith (@keitwb)
- Chris Houseknecht (@chouseknecht)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/docker_network_module.html
