Lendo a documentação com ansible-doc

O comando ansible-doc mostra a documentação completa dos módulos diretamente no seu shell, para que você nunca precise sair do terminal para consultar alguma informação.

Informe o nome de um módulo para ler sua documentação: cada opção, seu tipo e se ela é obrigatória. Esta é a maneira mais rápida de aprender a usar um módulo.

A saída lista cada opção com uma descrição, um valor padrão e as escolhas possíveis. Isso informa exatamente quais chaves um módulo aceita.

Adicione -s para exibir um trecho pronto para copiar e colar com os argumentos do módulo. É um ponto de partida perfeito para uma nova tarefa.

Execute com -l para listar todos os módulos instalados com resumos de uma linha. Encaminhe a saída para grep para encontrar o que você precisa.

Não tem certeza do nome? Liste os módulos e filtre por tópico. Pesquisar por service rapidamente mostra os módulos relevantes.

Como ansible-doc lê os módulos instalados localmente, a documentação sempre corresponde à sua versão exata. Não há risco de encontrar páginas antigas na Internet.

A documentação também descreve o que um módulo retorna, como changed ou stdout. Isso ajuda quando você registra resultados para usá-los mais tarde.

Use -t para ler a documentação de outros tipos de plug-in, não apenas de módulos. Por exemplo, consulte um plug-in lookup ou filter da mesma maneira.

O cabeçalho da documentação mostra a coleção do módulo e sua finalidade resumida, para que você saiba o nome totalmente qualificado antes de escrever uma tarefa.

Antes de adivinhar um argumento, consulte primeiro o ansible-doc. Uma consulta de dez segundos evita uma execução malsucedida e uma mensagem de erro confusa.

Você quer um trecho rápido dos argumentos de um módulo para copiar e colar, não o manual completo.

ansible-doc traz para o seu terminal uma documentação correspondente à versão: consulte um módulo, use -s para obter um trecho e -l para listar e pesquisar. 📚