docker_network

Collection: community.general

Full Name: parallax.community.general.docker_network

Aliases: community.general.docker_network, docker_network

Synopsis

Manage docker network

Parameters

NameTypeRequiredDefaultDescription
namestringyesName of the Docker network
statestringpresentState of the network Choices: present, absent
driverstringbridgeNetwork driver to use
driver_optionsstringDriver options as key=value pairs separated by commas
ipam_driverstringIPAM driver to use
ipam_configstringIPAM configuration as subnet=x,gateway=y
ipam_optionsstringIPAM driver options as key=value pairs
enable_ipv6boolfalseEnable IPv6 networking
internalboolfalseRestrict external access to the network
forceboolfalseForce removal of network
labelsstringLabels as key=value pairs separated by commas
scopestringNetwork scope (local, global, swarm)
attachableboolfalseEnable manual container attachment

Example

- name: Example docker_network task
  docker_network:
    name: <your_name>