rougail-output-ansible/README.fr.md

11 KiB

Table of Contents

🇬🇧 (EN) - 🇫🇷 (FR)

Génère un inventaire Ansible

Note

Chemin : ansible
désactivé
Désactivé : lorsque la variable "sélection pour sortie" est accessible et n'a pas la valeur "ansible".

Variable Description Valeur par défaut Type Validateur
ansible.output
Ligne de commande :
--ansible.output
Variable d'environnement : ROUGAILCLI_ANSIBLE.OUTPUT
Type de sortie. inventory choice obligatoire Choix :
• inventory
• doc
ansible.host_namespace
Ligne de commande :
--ansible.host_namespace
Variable d'environnement : ROUGAILCLI_ANSIBLE.HOST_NAMESPACE
Espace de nom avec les valeurs de l'hôte. hosts string obligatoire

Configuration de la doc

Note

Chemin : ansible.doc
désactivé
Désactivé : lorsque la variable "Type de sortie" n'a pas la valeur "doc".

Variable Description Valeur par défaut Type Validateur
ansible.doc.project_name
Ligne de commande :
--ansible.doc.project_name
Variable d'environnement : ROUGAILCLI_ANSIBLE.DOC.PROJECT_NAME
Nom du projet Ansible. string obligatoire
ansible.doc.author
Ligne de commande :
--ansible.doc.author
Variable d'environnement : ROUGAILCLI_ANSIBLE.DOC.AUTHOR
Nom de l'auteur Ansible. string obligatoire
ansible.doc.output_format
Ligne de commande :
--ansible.doc.output_format
Variable d'environnement : ROUGAILCLI_ANSIBLE.DOC.OUTPUT_FORMAT
Le format de sorti de la documentation générée. console choice obligatoire Choix :
• console
• asciidoc
• html
• github
• gitlab
• restructuredtext
• json
ansible.doc.collection_type
Ligne de commande :
--ansible.doc.collection_type
Variable d'environnement : ROUGAILCLI_ANSIBLE.DOC.COLLECTION_TYPE
Contenu de la collection. auto choice obligatoire Choix :
• auto
• playbooks
• roles

Informations sur le Playbooks

Note

Cette famille contient des listes de bloc de variable.
Chemin : ansible.doc.playbooks
désactivé
Désactivé : si le contenu est une rôle.

Variable Description Type Validateur
ansible.doc.playbooks.name
Ligne de commande :
--ansible.doc.playbooks.name
Variable d'environnement : ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.NAME
Nom du Playbook.
Les Playbooks sont placés dans le répertoire playbooks/. Par défaut, la description du "type" est utilisée comme nom de Playbook dans l'exemple généré. Il est possible de personnalisé la description ici.
string multiple unique
ansible.doc.playbooks.description
Ligne de commande :
--ansible.doc.playbooks.description
Variable d'environnement : ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.DESCRIPTION
Description du Playbook. string obligatoire

Configuration de l'inventaire

Note

Chemin : ansible.inventory
désactivé
Désactivé : lorsque la variable "Type de sortie" n'a pas la valeur "inventory".

Variable Description Valeur par défaut Type
ansible.inventory.no_namespace_in_vars
Ligne de commande :
• --ansible.inventory.no_namespace_in_vars
• --ansible.inventory.no-no_namespace_in_vars
Variable d'environnement : ROUGAILCLI_ANSIBLE.INVENTORY.NO_NAMESPACE_IN_VARS
Supprime le nom de l'espace de nom dans les vars de l'hôte. false boolean obligatoire
ansible.inventory.export_warnings
Ligne de commande :
• --ansible.inventory.export_warnings
• --ansible.inventory.no-export_warnings
Variable d'environnement : ROUGAILCLI_ANSIBLE.INVENTORY.EXPORT_WARNINGS
Affiche les avertissements dans les données d'exportation Ansible. true boolean obligatoire