ansible.builtin.docker_network (v2.6.2) — module

Install Ansible via pip

Install with pip install ansible==2.6.2

Description

Create/remove Docker networks and connect containers to them.

Performs largely the same function as the "docker network" CLI subcommand.

Requirements

• python >= 2.6
• docker-py >= 1.7.0
• Please note that the L(docker-py,https://pypi.org/project/docker-py/) Python module has been superseded by L(docker,https://pypi.org/project/docker/) (see L(here,https://github.com/docker/docker-py/issues/1310) for details). For Python 2.6, C(docker-py) must be used. Otherwise, it is recommended to install the C(docker) Python module. Note that both modules should I(not) be installed at the same time.
• The docker server >= 1.9.0

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Create a network
  docker_network:
    name: network_one

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove all but selected list of containers
  docker_network:
    name: network_one
    connected:
      - container_a
      - container_b
      - container_c

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove a single container
  docker_network:
    name: network_one
    connected: "{{ fulllist|difference(['container_a']) }}"

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Add a container to a network, leaving existing containers connected
  docker_network:
    name: network_one
    connected:
      - container_a
    appends: yes

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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'

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Delete a network, disconnecting all containers
  docker_network:
    name: network_one
    state: absent
    force: yes

Inputs

    
tls:
    default: false
    description:
    - Secure the connection to the API by using TLS without verifying the authenticity
      of the Docker host server. Note that if I(validate_certs) is set to C(true) as well,
      it will take precedence.
    - If the value is not specified in the task, the value of environment variable C(DOCKER_TLS)
      will be used instead. If the environment variable is not set, the default value
      will be used.
    type: bool

name:
    aliases:
    - network_name
    description:
    - Name of the network to operate on.
    required: true

debug:
    default: false
    description:
    - Debug mode
    type: bool

force:
    default: 'no'
    description:
    - With state I(absent) forces disconnecting all containers from the network prior
      to deleting the network. With state I(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.
    type: bool

state:
    choices:
    - absent
    - present
    default: present
    description:
    - I(absent) deletes the network. If a network has connected containers, it cannot
      be deleted. Use the C(force) option to disconnect all containers and delete the
      network.
    - I(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 C(appends) option to leave existing containers
      connected. Use the C(force) options to force re-creation of the network.

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

appends:
    aliases:
    - incremental
    default: 'no'
    description:
    - By default the connected list is canonical, meaning containers not on the list are
      removed from the network. Use C(appends) to leave existing containers connected.
    type: bool

ca_cert:
    aliases:
    - tls_ca_cert
    - cacert_path
    description:
    - 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 C(DOCKER_CERT_PATH)
      is set, the file C(ca.pem) from the directory specified in the environment variable
      C(DOCKER_CERT_PATH) will be used.
    type: path

timeout:
    default: 60
    description:
    - 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 C(DOCKER_TIMEOUT)
      will be used instead. If the environment variable is not set, the default value
      will be used.
    type: int

connected:
    aliases:
    - containers
    description:
    - List of container names or container IDs to connect to a network.

client_key:
    aliases:
    - tls_client_key
    - key_path
    description:
    - Path to the client's TLS key file.
    - If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH)
      is set, the file C(key.pem) from the directory specified in the environment variable
      C(DOCKER_CERT_PATH) will be used.
    type: path

api_version:
    aliases:
    - docker_api_version
    default: auto
    description:
    - 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 C(DOCKER_API_VERSION)
      will be used instead. If the environment variable is not set, the default value
      will be used.
    type: str

client_cert:
    aliases:
    - tls_client_cert
    - cert_path
    description:
    - Path to the client's TLS certificate file.
    - If the value is not specified in the task and the environment variable C(DOCKER_CERT_PATH)
      is set, the file C(cert.pem) from the directory specified in the environment variable
      C(DOCKER_CERT_PATH) will be used.
    type: path

docker_host:
    aliases:
    - docker_url
    default: unix://var/run/docker.sock
    description:
    - 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, C(tcp://192.0.2.23:2376).
      If TLS is used to encrypt the connection, the module will automatically replace
      C(tcp) in the connection URL with C(https).
    - If the value is not specified in the task, the value of environment variable C(DOCKER_HOST)
      will be used instead. If the environment variable is not set, the default value
      will be used.
    type: str

ipam_driver:
    description:
    - Specify an IPAM driver.

ssl_version:
    description:
    - 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 C(DOCKER_SSL_VERSION)
      will be used instead.
    type: str

ipam_options:
    description:
    - Dictionary of IPAM options.

tls_hostname:
    description:
    - 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 C(DOCKER_TLS_HOSTNAME)
      will be used instead. If the environment variable is not set, the default value
      will be used.
    - The current default value is C(localhost). This default is deprecated and will change
      in community.docker 2.0.0 to be a value computed from I(docker_host). Explicitly
      specify C(localhost) to make sure this value will still be used, and to disable
      the deprecation message which will be shown otherwise.
    type: str

driver_options:
    description:
    - Dictionary of network settings. Consult docker docs for valid options and values.

use_ssh_client:
    default: false
    description:
    - For SSH transports, use the C(ssh) CLI tool instead of paramiko.
    - Requires Docker SDK for Python 4.4.0 or newer.
    type: bool
    version_added: 1.5.0
    version_added_collection: community.docker

validate_certs:
    aliases:
    - tls_verify
    default: false
    description:
    - 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 C(DOCKER_TLS_VERIFY)
      will be used instead. If the environment variable is not set, the default value
      will be used.
    type: bool

Outputs

facts:
  description: Network inspection results for the affected network.
  returned: success
  sample: {}
  type: dict