AnsibleModule et spécification des arguments

La classe AnsibleModule est votre boîte à outils. Elle analyse les arguments envoyés par Ansible, les valide et vous fournit des fonctions d’assistance pour renvoyer des résultats.

Vous décrivez chaque entrée acceptée par votre module dans un dictionnaire argument_spec. Ansible le lit pour valider ce que les utilisateurs transmettent.

Définissez un type comme str, int, bool, list ou dict. Ansible convertit les valeurs et rejette les entrées incorrectes avant même l’exécution de votre code.

Ajoutez required=True et Ansible échoue avec une erreur claire si l’utilisateur oublie cet argument. Aucune vérification défensive n’est nécessaire.

Utilisez default afin que les arguments facultatifs reçoivent automatiquement une valeur. Les utilisateurs ne définissent que ce qu’ils souhaitent modifier.

La liste choices limite un argument aux valeurs autorisées. Toute autre valeur est rejetée immédiatement avec un message utile.

Transmettez votre spécification à AnsibleModule pour créer l’objet. À partir de là, toutes vos entrées résident en toute sécurité dans module.params.

Accédez à vos arguments via module.params, un simple dictionnaire. Les valeurs sont déjà typées et validées : il vous suffit de les utiliser.

Deux arguments doivent-ils être utilisés ensemble ou ne doivent-ils jamais l’être simultanément ? Transmettez à AnsibleModule des règles comme required_together ou mutually_exclusive, et il les fera respecter.

Marquez les entrées sensibles avec no_log=True afin que les mots de passe n’apparaissent jamais dans les journaux Ansible ni dans la sortie détaillée.

Une bonne argument_spec remplace des piles de validations manuelles. Décrivez les entrées une seule fois et Ansible gère gratuitement les types, les erreurs et la documentation.

Définissez les entrées dans argument_spec avec des types, des valeurs par défaut, les paramètres obligatoires et des choix, construisez AnsibleModule, puis lisez des valeurs propres depuis module.params. ✅