docker network inspect

O comando docker network inspect é usado para exibir informações detalhadas sobre uma ou mais redes Docker. Ele fornece uma visão abrangente da configuração de rede, incluindo informações sobre containers conectados, endereços IP, sub-redes, gateways, drivers de rede, e muito mais.

Sintaxe

docker network inspect [OPTIONS] NETWORK [NETWORK...]

• NETWORK: Nome ou ID da rede que você deseja inspecionar. Você pode inspecionar várias redes ao mesmo tempo, separando os nomes/IDs por espaços.

Opções Comuns

• --format: Formata a saída usando um modelo Go, permitindo personalizar a visualização dos dados.

• --verbose: Exibe informações mais detalhadas, incluindo opções específicas do driver (nem todos os drivers suportam isso).

Saída do Comando

A saída de docker network inspect é apresentada em formato JSON e inclui:

• Name: O nome da rede.

• Id: O ID único da rede.

• Created: A data e hora em que a rede foi criada.

• Scope: O escopo da rede (ex: local para redes bridge ou global para overlay).

• Driver: O driver de rede utilizado (ex: bridge, overlay, etc.).

• EnableIPv6: Indica se o IPv6 está habilitado.

• IPAM: Configurações de IPAM (IP Address Management), incluindo sub-redes e gateways.

• Containers: Uma lista de containers conectados à rede, junto com seus endereços IP, aliases, e outras informações.

• Options: Opções específicas do driver de rede.

• Labels: Rótulos associados à rede.

Exemplos

1. Inspecionar uma Rede Específica:

   docker network inspect my_network

   Esse comando exibe todas as informações sobre a rede my_network, incluindo os containers conectados, sub-redes, gateways, e mais.

2. Inspecionar Múltiplas Redes:

   docker network inspect network1 network2

   Aqui, o Docker inspeciona e exibe informações para as redes network1 e network2.

3. Exibir Apenas os Containers Conectados a uma Rede:

   docker network inspect --format '{{json .Containers}}' my_network

   Esse comando exibe apenas a lista de containers conectados à rede my_network, em formato JSON.

4. Exibir Informações Personalizadas com --format:

   docker network inspect --format '{{.Name}}: {{.Driver}}' my_network

   Este comando exibe o nome da rede e o driver utilizado, proporcionando uma saída mais concisa.

Uso Avançado

Se você estiver gerenciando redes complexas ou precisando depurar problemas de conectividade, o docker network inspect é uma ferramenta essencial. Ele permite verificar se os containers estão conectados às redes corretas, se os endereços IP estão dentro da faixa esperada, e se as configurações de gateway e roteamento estão corretas.

Exemplo de Documentação

## Inspecionando Redes Docker com `docker network inspect`

O comando `docker network inspect` é utilizado para obter informações detalhadas sobre as redes Docker, incluindo os containers conectados, configuração de IPs, e o driver de rede utilizado.

### Exemplo Básico: Inspecionando uma Rede

Para inspecionar uma rede chamada `my_network`:

```bash
docker network inspect my_network

Inspeção Múltipla: Verificando Várias Redes ao Mesmo Tempo

Você pode inspecionar várias redes de uma vez:

docker network inspect frontend_network backend_network

Saída Personalizada: Formatando os Dados Exibidos

Para exibir apenas o nome da rede e o driver utilizado:

docker network inspect --format '{{.Name}}: {{.Driver}}' my_network

Foco em Containers: Visualizando Apenas os Containers Conectados

Se você deseja ver apenas os containers conectados a uma rede:

docker network inspect --format '{{json .Containers}}' my_network

Utilidade e Aplicações

O comando docker network inspect é essencial para depuração e gerenciamento de redes Docker, permitindo que você verifique a integridade e configuração das redes usadas por seus containers.

Essa estrutura pode ser usada para documentar o comando `docker network inspect` na sua documentação Docker.