AnsibleModule y especificación de argumentos

La clase AnsibleModule es su conjunto de herramientas. Analiza los argumentos que envía Ansible, los valida y le proporciona utilidades para devolver resultados.

Describa cada entrada que acepta su módulo en un diccionario argument_spec. Ansible lo lee para validar lo que introducen los usuarios.

Establezca un type como str, int, bool, list o dict. Ansible convierte los tipos y rechaza las entradas incorrectas antes incluso de ejecutar su código.

Añada required=True y Ansible mostrará un error claro si el usuario olvida ese argumento. No necesitará comprobaciones defensivas.

Use default para que los argumentos opcionales reciban un valor automáticamente. Los usuarios solo tendrán que establecer lo que quieran cambiar.

La lista choices limita un argumento a los valores permitidos. Cualquier otro valor se rechaza de antemano con un mensaje útil.

Pase su especificación a AnsibleModule para crear el objeto. A partir de ese momento, todas sus entradas estarán disponibles de forma segura en module.params.

Acceda a sus argumentos mediante module.params, un diccionario normal. Los valores ya están tipados y validados, así que solo tiene que utilizarlos.

¿Necesita que dos argumentos aparezcan juntos o que nunca aparezcan ambos? Pase reglas como required_together o mutually_exclusive a AnsibleModule y este las hará cumplir.

Marque las entradas confidenciales con no_log=True para que las contraseñas nunca aparezcan en los registros de Ansible ni en la salida detallada.

Una buena argument_spec sustituye montones de validaciones manuales. Describa las entradas una sola vez y Ansible gestionará los tipos, los errores y la documentación sin esfuerzo adicional.

Piense en cómo llegan las entradas del usuario al código de su módulo.

Defina las entradas en argument_spec con tipos, valores predeterminados, opciones required y choices, construya AnsibleModule y, después, lea valores limpios de module.params. ✅