---
gitea: none
include_toc: true
---
[🇬🇧 (EN)](README.md) - [🇫🇷 (FR)](README.fr.md)

## Génère un inventaire Ansible

> [!NOTE]
> 
> **Chemin** : ansible\
> *`désactivé`*\
> **Désactivé** : lorsque la variable "[sélection pour sortie](#step.output)" est accessible et n'a pas la valeur "ansible".

| Variable                                                                                                                                                                                                                   | Description                                    | Valeur par défaut   | Type                                                                                             | Validateur                                       |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|---------------------|--------------------------------------------------------------------------------------------------|--------------------------------------------------|
| **<a id="ansible.output" name="ansible.output">ansible.output</a>**<br/>**Ligne de commande** : <br/>--ansible.output<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.OUTPUT                                         | Type de sortie.                                | inventory           | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | **Choix** : <br/>•&nbsp;inventory<br/>•&nbsp;doc |
| **<a id="ansible.host_namespace" name="ansible.host_namespace">ansible.host_namespace</a>**<br/>**Ligne de commande** : <br/>--ansible.host_namespace<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.HOST_NAMESPACE | Espace de nom avec les valeurs de l&#x27;hôte. | hosts               | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |                                                  |

### Configuration de la doc

> [!NOTE]
> 
> **Chemin** : ansible.doc\
> *`désactivé`*\
> **Désactivé** : lorsque la variable "[Type de sortie](#ansible.output)" n'a pas la valeur "doc".

| Variable                                                                                                                                                                                                                                            | Description                                     | Valeur par défaut   | Type                                                                                             | Validateur                                                                                                                                          |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|---------------------|--------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="ansible.doc.project_name" name="ansible.doc.project_name">ansible.doc.project_name</a>**<br/>**Ligne de commande** : <br/>--ansible.doc.project_name<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.DOC.PROJECT_NAME                | Nom du projet Ansible.                          |                     | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |                                                                                                                                                     |
| **<a id="ansible.doc.author" name="ansible.doc.author">ansible.doc.author</a>**<br/>**Ligne de commande** : <br/>--ansible.doc.author<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.DOC.AUTHOR                                              | Nom de l&#x27;auteur Ansible.                   |                     | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |                                                                                                                                                     |
| **<a id="ansible.doc.output_format" name="ansible.doc.output_format">ansible.doc.output_format</a>**<br/>**Ligne de commande** : <br/>--ansible.doc.output_format<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.DOC.OUTPUT_FORMAT           | Le format de sorti de la documentation générée. | console             | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | **Choix** : <br/>•&nbsp;console<br/>•&nbsp;asciidoc<br/>•&nbsp;html<br/>•&nbsp;github<br/>•&nbsp;gitlab<br/>•&nbsp;restructuredtext<br/>•&nbsp;json |
| **<a id="ansible.doc.collection_type" name="ansible.doc.collection_type">ansible.doc.collection_type</a>**<br/>**Ligne de commande** : <br/>--ansible.doc.collection_type<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.DOC.COLLECTION_TYPE | Contenu de la collection.                       | auto                | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` | **Choix** : <br/>•&nbsp;auto<br/>•&nbsp;playbooks<br/>•&nbsp;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   |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|--------------|
| **<a id="ansible.doc.playbooks.name" name="ansible.doc.playbooks.name">ansible.doc.playbooks.name</a>**<br/>**Ligne de commande** : <br/>--ansible.doc.playbooks.name<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.NAME                                    | Nom du Playbook.<br/>Les Playbooks sont placés dans le répertoire playbooks/. Par défaut, la description du &quot;type&quot; est utilisée comme nom de Playbook dans l&#x27;exemple généré. Il est possible de personnalisé la description ici. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple`    | `unique`     |
| **<a id="ansible.doc.playbooks.description" name="ansible.doc.playbooks.description">ansible.doc.playbooks.description</a>**<br/>**Ligne de commande** : <br/>--ansible.doc.playbooks.description<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.DESCRIPTION | Description du Playbook.                                                                                                                                                                                                                        | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |              |

| Variable                                                                                                                                                                                                                                       | Description                                    | Type                                                                                      | Validateur                                                                                                                                 |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|-------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="ansible.doc.root_directory" name="ansible.doc.root_directory">ansible.doc.root_directory</a>**<br/>**Ligne de commande** : <br/>--ansible.doc.root_directory<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.DOC.ROOT_DIRECTORY | Répertoire racine de la documentation générée. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | •&nbsp;le nom de fichier peut être une chemin relatif<br/>•&nbsp;le fichier doit exister<br/>•&nbsp;type de fichier autorisé: "directory". |

### Configuration de l&#x27;inventaire

> [!NOTE]
> 
> **Chemin** : ansible.inventory\
> *`désactivé`*\
> **Désactivé** : lorsque la variable "[Type de sortie](#ansible.output)" n'a pas la valeur "inventory".

| Variable                                                                                                                                                                                                                                                                                                                                                                 | Description                                                             | Valeur par défaut   | Type                                                                                              |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------|---------------------|---------------------------------------------------------------------------------------------------|
| **<a id="ansible.inventory.no_namespace_in_vars" name="ansible.inventory.no_namespace_in_vars">ansible.inventory.no_namespace_in_vars</a>**<br/>**Ligne de commande** : <br/>•&nbsp;--ansible.inventory.no_namespace_in_vars<br/>•&nbsp;--ansible.inventory.no-no_namespace_in_vars<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.INVENTORY.NO_NAMESPACE_IN_VARS | Supprime le nom de l&#x27;espace de nom dans les vars de l&#x27;hôte.   | false               | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
| **<a id="ansible.inventory.export_warnings" name="ansible.inventory.export_warnings">ansible.inventory.export_warnings</a>**<br/>**Ligne de commande** : <br/>•&nbsp;--ansible.inventory.export_warnings<br/>•&nbsp;--ansible.inventory.no-export_warnings<br/>**Variable d'environnement** : ROUGAILCLI_ANSIBLE.INVENTORY.EXPORT_WARNINGS                               | Affiche les avertissements dans les données d&#x27;exportation Ansible. | true                | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `obligatoire` |
