O Ansible vem com um utilitário chamado ansible-doc
. Nele é possível consultar todos os módulos disponíveis numa instalação padrão do Ansible:
$ ansible-doc -l
[...]
expect Executes a command and responds to prompts
facter Runs the discovery program `facter' on the remote system
fail Fail with custom message
fetch Fetches a file from remote nodes
file Sets attributes of files
filesystem Makes file system on block device
find return a list of files based on specific criteria
firewalld Manage arbitrary ports/services with firewalld
flowadm Manage bandwidth resource control and priority for protocols, se...
flowdock Send a message to a flowdock
foreman Manage Foreman Resources
[...]
O resultado do comando ansible-doc -l
é mostrado numa interface parecida com a dos programas ‘vim’ ou ‘less’. Nela é possível paginar o texto com as teclas de navegação/page up/down, além pesquisar através do caractere ‘/’ + texto + <enter>. Após a pesquisa, digitar a tecla ‘n’ (next) para mostrar a próxima entrada ou ‘p’ (preview) para mostrar a entrada anterior. Para sair basta digitar a letra ‘q’.
Com o nome do módulo escolhido, é possível ver a documentação do módulo através do comando $ ansible-doc <nomedomodulo>
:
A documentação oficial do Ansible é gerada automaticamente a partir da documentação dos módulos.
O comando ansible-doc <nomedomodulo>
e a url http://docs.ansible.com/ansible/nomedomodulo_module.html possuem o mesmo conteúdo.
A documentação dos módulos fornece todas as informações detalhadas dos parâmetros, além de ricos EXEMPLOS para facilitar a sua utilização. Esses exemplos são tasks que podem ser utilizadas diretamentes em playbooks. Para utilizar através de comandos Ad-Hoc ($ ansible -m modulo
) é necessário acrescentar o argumento ‘-a “opcao1=xxx opcao2=yyy”’