--- title: Docker Network slug: homologacao-atmosphere/docker-network description: Learn about the parameters and subfields for creating, removing, and connecting Docker networks with this comprehensive document. Discover options like appends, attachable, driver, and more. Find examples on how to use these parameters and gain insights i docTags: createdAt: 2021-03-18T12:35:35.000Z --- ## Resumo - Criar, remover redes Docker e conectar contêineres a elas. ## Parâmetros | **Parâmetro** | **Tipo** | **Escolhas \| Valor Padrão** | **Comentários** | | ----------------------------------------------------------------------------------------------------- | -------------------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | appends 





aliases: incremental | boolean | Escolhas:
- false
(default)
- true | Por padrão, a lista conectada é canônica, o que significa que os contêineres que não estão na lista são removidos da rede. Utilize appends para deixar os contêineres existentes conectados.
| | attachable  | boolean | Escolhas:
- false
- true | Se ativado, e a rede estiver no escopo global, contêineres sem serviço em nodes ativos serão capazes de se conectar à rede. | | connected 











aliases: containers | list / elements=string | | Lista de nomes de contêineres ou IDs de contêineres para conectar a uma rede. Observe que o módulo apenas garante que esses contêineres estejam conectados à rede, mas não se preocupa com as opções de conexão. Se você depende de endereços IP específicos use o módulo docker\_container para garantir que seus contêineres estejam conectados corretamente a esta rede. | | driver  | string | - "bridge"
(default) | Especifique o tipo de rede. O Docker fornece drivers de ponte e de sobreposição, mas drivers de terceiros também podem ser usados. | | driver\_options  | dictionary | | Dicionário de configurações de rede. Consulte a documentação do docker para opções e valores válidos. | | enable\_ipv6  | boolean | Escolhas:
- false
- true | Ativar a rede IPv6. | | force  | boolean | Escolhas:
- false
(default)
- true | Se o parâmetro state for absent, força a desconexão de todos os contêineres da rede antes de excluí-la. Com o state present, todos os contêineres são desconectados, excluídos e recriados. Essa opção é necessária se você alterou as opções do IPAM ou do driver e deseja que uma rede existente seja atualizada para usar as novas opções. | | internal  | boolean | Escolhas:
- false
- true | Restrinja o acesso externo à rede. | | ipam\_config  | list / elements=dictionary | | Lista de blocos de configuração do IPAM. Consulte a documentação do Docker para opções e valores válidos. Observe que a subopção *iprange* é escrito de forma diferente. | | ipam\_driver  | string | | Especifique um driver IPAM. | | ipam\_driver\_options  | dictionary | | Dicionário de opções do driver IPAM. | | labels  | dictionary | | Dicionário de rótulos. | | name - *required*
**
aliases: network\_name | string | | Nome da rede a ser operada.
| | scope  | string | Escolhas:
- local
- global
- swarm | Especifique o escopo da rede. | | state  | string | Escolhas:
- absent
- present
(default) | absent - exclui a rede. Se uma rede tiver contêineres conectados, ela não poderá ser excluída. Use a opção force para desconectar todos os contêineres e excluir o network.
present - cria a rede, se ela ainda não existir com os parâmetros especificados, e conecta a lista de contêineres fornecida por meio do parâmetro conectado.

Os contêineres que não estiverem na lista serão desconectados. Uma lista vazia não deixará nenhum container conectado à rede. Use a opção appends para deixar os containers existentes conectados. Use as opções de force para forçar a recriação da rede. | ## Subcampos da opção ipam config | **Parâmetro** | **Tipo** | **Escolhas \| Valor Padrão** | **Comentários** | | --------------- | ---------- | ---------------------------- | ----------------------------------------------------------------------------------------------- | | aux\_addresses  | dictionary | | Endereços IP auxiliares usados pelo driver de rede, como um mapeamento de nome de host para IP. | | gateway | string | | Endereço gateway do IP. | | iprange | string | | Intervalo de endereços IP em notação CIDR. | | subnet | string | | Subconjunto de IP em notação CIDR. | ## Exemplos ```yaml # Exemplo: Criar uma rede - docker_network: name: network_one # Exemplo: Excluir tudo, exceto a lista selecionada de contêineres - docker_network: name: network_one connected: - container_a - container_b - container_c # Exemplo: Excluir um único contâiner - docker_network: name: network_one connected: "{{ fulllist|difference(['container_a']) }}" # Exemplo: Adicionar um contêiner a uma rede, deixando os contêineres existentes conectados - docker_network: name: network_one connected: - container_a appends: yes # Exemplo: Criar uma rede com opções de driver - docker_network: name: network_two driver_options: com.docker.network.bridge.name: net2 # Exemplo: Criar uma rede com configuração IPAM personalizada - docker_network: name: network_three ipam_config: - subnet: 172.3.27.0/24 gateway: 172.3.27.2 iprange: 172.3.27.0/26 aux_addresses: host1: 172.3.27.3 host2: 172.3.27.4 # Exemplo: Criar uma rede com rótulos - docker_network: name: network_four labels: key1: value1 key2: value2 # Exemplo: Criar uma rede com configuração IPAM IPv6 - docker_network: name: network_ipv6_one enable_ipv6: yes ipam_config: - subnet: fdd1:ac8c:0557:7ce1::/64 # Exemplo: Criar uma rede com IPv6 e configuração personalizada de IPAM IPv4 - docker_network: name: network_ipv6_two enable_ipv6: yes ipam_config: - subnet: 172.4.27.0/24 - subnet: fdd1:ac8c:0557:7ce2::/64 # Exemplo: Excluir uma rede, desconectando todos os contêineres - docker_network: name: network_one state: absent force: yes ``` ## Valores retornados | **Chave** | **Tipo** | **Retornado quando** | **Descrição** | | --------- | ---------- | -------------------- | ------------------------------- | | network  | dictionary | Sucesso | Resultados da inspeção de rede. |