Lire la documentation avec ansible-doc

La commande ansible-doc affiche la documentation complète des modules directement dans votre terminal, vous n’avez donc jamais besoin de le quitter pour rechercher une information.

Indiquez le nom d’un module pour lire sa documentation : chaque option, son type et si elle est requise. C’est la façon la plus rapide d’apprendre à utiliser un module.

La sortie répertorie chaque option avec une description, une valeur par défaut et les choix possibles. Vous savez ainsi exactement quelles clés un module accepte.

Ajoutez -s pour afficher un extrait prêt à copier-coller des arguments du module. C’est un point de départ idéal pour une nouvelle tâche.

Exécutez la commande avec -l pour répertorier tous les modules installés accompagnés d’un résumé d’une ligne. Faites passer le résultat dans grep pour trouver ce dont vous avez besoin.

Vous n’êtes pas sûr du nom ? Répertoriez les modules et filtrez-les par sujet. La recherche de service fait rapidement apparaître les modules pertinents.

Comme ansible-doc lit les modules installés localement, la documentation correspond toujours exactement à votre version. Vous ne risquez pas de consulter des pages en ligne obsolètes.

La documentation décrit également ce qu’un module retourne, comme changed ou stdout. Cela vous aide lorsque vous enregistrez les résultats pour les utiliser plus tard.

Utilisez -t pour consulter la documentation d’autres types d’extensions, et pas seulement des modules. Par exemple, recherchez de la même manière une extension lookup ou filter.

L’en-tête de la documentation indique la collection du module et son objectif en quelques mots. Vous connaissez ainsi son nom entièrement qualifié avant d’écrire une tâche.

Avant de deviner un argument, consultez d’abord ansible-doc. Une recherche de dix secondes vous évite une exécution échouée et un message d’erreur déroutant.

ansible-doc apporte dans votre terminal une documentation correspondant à votre version : consultez un module, utilisez -s pour obtenir un extrait et -l pour répertorier et rechercher. 📚