---
title: Docker Swarm Info
slug: homologacao-atmosphere/docker-swarm-info
description: Learn about Docker Swarm and its components with this document. Discover the parameters for retrieving information about nodes, services, tasks, and the unlock key. Explore examples of parameter usage and understand the values returned, including Docker d
docTags:
createdAt: 2021-03-18T17:25:40.000Z
---
## Resumo
- Retorna informações sobre um Swarm do Docker.
## Requisitos
- Docker API >= 1.24
## Parâmetros
| **Parâmetro** | **Tipo** | **Escolhas \| Valor Padrão** | **Comentários** |
| ------------------ | ---------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| nodes | boolean | Escolhas:
- false
(default)
- true | Se deve listar nodes de um swarm. |
| nodes\_filters | dictionary | | Um dicionário de valores de filtro usado para selecionar nodes a serem listados. Por exemplo, nome: mynode. Consulte a documentação do docker para obter mais informações sobre os filtros possíveis. |
| services | boolean | Escolhas:
- false
(default)
- true | Se deve listar os serviços de um swarm. |
| services\_filters | dictionary | | Um dicionário de valores de filtro usado para selecionar os serviços a serem listados. Por exemplo, nome: myservice. Consulte a documentação do docker para obter mais informações sobre os possíveis filtros. |
| tasks | boolean | Escolhas:
- false
(default)
- true | Se deve listar containers. |
| tasks\_filters | dictionary | | Um dicionário de valores de filtro usado para selecionar tarefas a serem listadas. Por exemplo, node: mynode-1. Consulte a documentação do docker para obter mais informações sobre os possíveis filtros. |
| unlock\_key | boolean | Escolhas:
- false
(default)
- true | Se deve retornar a chave de desbloqueio do swarm. |
| verbose\_output | boolean | Escolhas:
- false
(default)
- true | Quando definido como verdadeiro, nodes, serviços ou tarefas são definidos como verdadeiros, a saída do módulo conterá informações detalhadas sobre os objetos que correspondem à saída completa do método API. A saída detalhada neste módulo contém apenas um subconjunto de informações retornadas pelo módulo\_info para cada tipo de objetos. |
## Exemplos
```yaml
# Exemplo: Obtenha informações sobre o Swarm Docker
- docker_swarm_info:
ignore_errors: yes
register: result
# Exemplo: Obtenha informações sobre o Swarm docker e listar seus nodes
- docker_swarm_info:
nodes: yes
register: result
# Exemplo: Obtenha informações sobre o Docker Swarm e uma lista estendida de nodes registrados
- docker_swarm_info:
nodes: yes
verbose_output: yes
register: result
# Exemplo: Obtenha informações sobre Docker Swarm e uma lista filtrada de nodes registrados
- docker_swarm_info:
nodes: yes
nodes_filter:
name: mynode
register: result
# Exemplo: Obtenha a chave de desbloqueio do swarm
- docker_swarm_info:
unlock_key: yes
register: result
```
## Valores retornados
| **Chave** | **Tipo** | **Retornado quando** | **Descrição** |
| ----------------------- | -------------------------- | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| can\_talk\_to\_docker | boolean | Tanto no sucesso quanto no erro | Será verdadeiro se o módulo puder se comunicar com o daemon do docker.
|
| docker\_swarm\_active | boolean | Tanto no sucesso quanto no erro | Será verdadeiro se o módulo puder se comunicar com o daemon do docker e o daemon do docker estiver no modo Swarm.
|
| docker\_swarm\_manager | boolean | Tanto no sucesso quanto no erro | Será verdadeiro se o módulo puder se comunicar com o daemon do docker, o daemon do docker estiver no modo Swarm e o node atual for um manager. Somente se este for verdadeiro, o módulo não falhará.
|
| nodes | list / elements=dictionary | Quando o *node* existe | Lista de objetos dict contendo as informações básicas sobre cada volume. As chaves correspondem à saída ls do docker node, a menos que verbose\_output = true.
|
| services | list / elements=dictionary | Quando o *serviço* existe | Lista de objetos dict contendo as informações básicas sobre cada volume. As chaves correspondem à saída ls do docker service, a menos que verbose\_output = yes.
|
| swarm\_facts | dictionary | Sempre | Fatos que representam o estado básico do cluster Swarm do docker. Contém tokens para se conectar ao Swarm.
|
| swarm\_unlock\_key | string | Quando a *unlock\_key *é verdadeira | Contém a chave necessária para desbloquear o swarm.
|
| tasks | list / elements=dictionary | Quando as *tasks *existem. | Lista de objetos dict contendo as informações básicas sobre cada volume. As chaves correspondem à saída ps do docker service, a menos que verbose\_output = yes. |