AnsibleModule e especificação de argumentos

A classe AnsibleModule é o seu conjunto de ferramentas. Ela analisa os argumentos enviados pelo Ansible, valida-os e fornece auxiliares para retornar resultados.

Você descreve cada entrada aceita pelo módulo em um dicionário argument_spec. O Ansible o lê para validar o que os usuários fornecem.

Defina um type como str, int, bool, list ou dict. O Ansible converte os valores e rejeita entradas inválidas antes mesmo de o seu código ser executado.

Adicione required=True, e o Ansible falhará com um erro claro se o usuário esquecer esse argumento. Não é necessário fazer verificações defensivas.

Use default para que os argumentos opcionais recebam um valor automaticamente. Os usuários só precisam definir o que desejam alterar.

A lista choices limita um argumento aos valores permitidos. Qualquer outro valor é rejeitado imediatamente com uma mensagem útil.

Passe sua especificação para AnsibleModule a fim de criar o objeto. A partir desse ponto, todas as suas entradas estarão armazenadas com segurança em module.params.

Acesse seus argumentos por meio de module.params, um dicionário simples. Os valores já estão tipados e validados, então basta usá-los.

Você precisa de dois argumentos juntos ou nunca dos dois ao mesmo tempo? Passe regras como required_together ou mutually_exclusive para AnsibleModule, e ele as aplicará.

Marque as entradas confidenciais com no_log=True para que as senhas nunca apareçam nos registros do Ansible nem na saída detalhada.

Uma boa argument_spec substitui pilhas de validações manuais. Descreva as entradas uma vez, e o Ansible cuidará dos tipos, dos erros e da documentação sem custo adicional.

Pense em como as entradas do usuário chegam ao código do seu módulo.

Defina as entradas em argument_spec com tipos, valores padrão, indicação de obrigatoriedade e opções, crie o AnsibleModule e depois leia os valores tratados em module.params. ✅