Docker Node Info

4 min

Resumo

Recupera fatos sobre um docker node.
Deve ser executado em um host em execução como Swarm Manager, caso contrário, o módulo falhará.

Parâmetros

Parâmetro	Tipo	Escolhas \| Valor Padrão	Comentários
api_version aliases: docker_api_version	string	Default: - "auto"	A versão da API Docker em execução no Docker Host.O padrão é a versão mais recente da API suportada pelo Docker SDK para Python e o docker daemon.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_API_VERSION será usado. Se a variável de ambiente não for definida, o valor padrão será usado.
ca_cert aliases: tls_ca_cert, cacert_path	path		Use um certificado CA ao executar a verificação do servidor, fornecendo o caminho para um arquivo de certificado CA.Se o valor não for especificado na tarefa e a variável de ambiente DOCKER_CERT_PATH for definida, o arquivo ca.pem do diretório especificado na variável de ambiente DOCKER_CERT_PATH será usado.
client_cert aliases: tls_client_cert, cert_path	path		Caminho para o arquivo de certificado TLS do cliente.Se o valor não for especificado na tarefa e a variável de ambiente DOCKER_CERT_PATH for definida, o arquivo cert.pem do diretório especificado na variável de ambiente DOCKER_CERT_PATH será usado.
client_key aliases: tls_client_key, key_path	path		Caminho para o arquivo de chave TLS do cliente.Se o valor não for especificado na tarefa e a variável de ambiente DOCKER_CERT_PATH for definida, o arquivo key.pem do diretório especificado na variável de ambiente DOCKER_CERT_PATH será usado.
debug	boolean	Escolhas: - false (default) - true	Modo de depuração
docker_host aliases: docker_url	string	Default: - "unix: //var/run/docker.sock"	O URL ou o caminho do soquete Unix usado para se conectar à API Docker. Para se conectar a um host remoto, forneça a string de conexão TCP. Por exemplo tcp://192.0.2.23:2376. Se TLS for usado para criptografar a conexão, o módulo será automaticamente substituído tcp na URL de conexão por https.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_HOST será usado. Se a variável de ambiente não for definida, o valor padrão será usado.
name	list / elements=string		O nome do node a ser inspecionado.A lista de nomes de nodes a serem inspecionados.Se estiver vazio, retorne informações de todos os nodes no cluster Swarm.Ao identificar o nó, use o nome do host do node (conforme registrado no Swarm) ou o ID do node.Se self for true, este parâmetro será ignorado.
self	boolean	Escolhas: - false (default) - true	Se true, consulta o node (ou seja, o docker daemon) com o qual o módulo se comunica.Se true, em seguida, o nome é ignorado.Se false então, a consulta depende da presença e do valor do name.
ssl_version	string		Forneça um número de versão SSL válido. Valor padrão determinado pelo módulo ssl.py.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_SSL_VERSION será usado.
timeout	integer	Default: - 60	O tempo máximo em segundos de espera por uma resposta da API.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_TIMEOUT será usado. Se a variável de ambiente não for definida, o valor padrão será usado.
tls	boolean	Escolhas: - false (default) - true	Proteja a conexão com a API usando TLS sem verificar a autenticidade do servidor host Docker. Observe que se validate_certs também for definido como yes, ele terá precedência.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_TLS será usado. Se a variável de ambiente não for definida, o valor padrão será usado.
tls_hostname	string	Default: - "localhost"	Ao verificar a autenticidade do servidor Docker Host, forneça o nome esperado do servidor.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_TLS_HOSTNAME será usado. Se a variável de ambiente não for definida, o valor padrão será usado.
validate_certs aliases: tls_verify	boolean	Escolhas: - false (default) - true	Proteja a conexão com a API usando TLS e verificando a autenticidade do servidor host Docker.Se o valor não for especificado na tarefa, o valor da variável de ambiente DOCKER_TLS_VERIFY será usado. Se a variável de ambiente não for definida, o valor padrão será usado.

Exemplos

# Obtenha informações sobre todos os nodes
  docker_node_info:
  register: result

# Obtenha informações sobre o node
  docker_node_info:
    name: mynode
  register: result

# Obtenha informações sobre a lista dos nodes
  docker_node_info:
    name:
      - mynode1
      - mynode2
  register: result

# Obter informações sobre o host, se for o Swarm Manager
  docker_node_info:
    self: true
  register: result

Valores Retornados

Chave	Tipo	Retornado quando	Descrição
nodes	list / elements=dictionary	sempre	Fatos que representam o estado atual dos nodes. Corresponde à docker node inspect saída.Pode conter várias entradas se mais de um node fornecido em nome ou nome não for fornecido. Se nome contém uma lista de nodes, a saída fornecerá informações sobre todos os nodes registrados no enxame, incluindo nodes que deixaram o enxame, mas não foram removidos do cluster em gerenciadores de enxame e nodes que estão inacessíveis.