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

## Generate Ansible inventory

> [!NOTE]
> 
> **Path**: ansible\
> *`disabled`*\
> **Disabled**: when the variable "[select for output](#step.output)" is accessible and hasn't the value "ansible".

| Variable                                                                                                                                                                                                        | Description                 | Default value   | Type                                                                                           | Validator                                         |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------|-----------------|------------------------------------------------------------------------------------------------|---------------------------------------------------|
| **<a id="ansible.output" name="ansible.output">ansible.output</a>**<br/>**Command line**: <br/>--ansible.output<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.OUTPUT                                         | Output type.                | inventory       | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | **Choices**: <br/>•&nbsp;inventory<br/>•&nbsp;doc |
| **<a id="ansible.host_namespace" name="ansible.host_namespace">ansible.host_namespace</a>**<br/>**Command line**: <br/>--ansible.host_namespace<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.HOST_NAMESPACE | Namespace with host values. | hosts           | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |                                                   |

### Doc configuration

> [!NOTE]
> 
> **Path**: ansible.doc\
> *`disabled`*\
> **Disabled**: when the variable "[Output type](#ansible.output)" hasn't the value "doc".

| Variable                                                                                                                                                                                                                                 | Description                                       | Default value   | Type                                                                                           | Validator                                                                                                                                            |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|-----------------|------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="ansible.doc.project_name" name="ansible.doc.project_name">ansible.doc.project_name</a>**<br/>**Command line**: <br/>--ansible.doc.project_name<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.DOC.PROJECT_NAME                | Ansible project name.                             |                 | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |                                                                                                                                                      |
| **<a id="ansible.doc.author" name="ansible.doc.author">ansible.doc.author</a>**<br/>**Command line**: <br/>--ansible.doc.author<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.DOC.AUTHOR                                              | Ansible author name.                              |                 | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |                                                                                                                                                      |
| **<a id="ansible.doc.output_format" name="ansible.doc.output_format">ansible.doc.output_format</a>**<br/>**Command line**: <br/>--ansible.doc.output_format<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.DOC.OUTPUT_FORMAT           | The output format of the generated documentation. | console         | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | **Choices**: <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/>**Command line**: <br/>--ansible.doc.collection_type<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.DOC.COLLECTION_TYPE | Collection contents.                              | auto            | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | **Choices**: <br/>•&nbsp;auto<br/>•&nbsp;playbooks<br/>•&nbsp;roles                                                                                  |

#### Playbooks informations

> [!NOTE]
> 
> This family contains lists of variable blocks.\
> **Path**: ansible.doc.playbooks\
> *`disabled`*\
> **Disabled**: if the content is a role.

| Variable                                                                                                                                                                                                                                                               | Description                                                                                                                                                                                                                        | Type                                                                                           | Validator   |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|-------------|
| **<a id="ansible.doc.playbooks.name" name="ansible.doc.playbooks.name">ansible.doc.playbooks.name</a>**<br/>**Command line**: <br/>--ansible.doc.playbooks.name<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.NAME                                    | Playbook name.<br/>Playbooks are placed in the playbooks/ directory. By default, the description of the &quot;type&quot; is used as the Playbook name in the generated example. It is possible to customize this description here. | [`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/>**Command line**: <br/>--ansible.doc.playbooks.description<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.DESCRIPTION | Playbook description.                                                                                                                                                                                                              | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |             |

| Variable                                                                                                                                                                                                                            | Description                            | Type                                                                                      | Validator                                                                                                                |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|-------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------|
| **<a id="ansible.doc.root_directory" name="ansible.doc.root_directory">ansible.doc.root_directory</a>**<br/>**Command line**: <br/>--ansible.doc.root_directory<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.DOC.ROOT_DIRECTORY | Root directory of generated documents. | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | •&nbsp;this filename could be a relative path<br/>•&nbsp;this file must exist<br/>•&nbsp;file type allowed: "directory". |

### Inventory configuration

> [!NOTE]
> 
> **Path**: ansible.inventory\
> *`disabled`*\
> **Disabled**: when the variable "[Output type](#ansible.output)" hasn't the value "inventory".

| Variable                                                                                                                                                                                                                                                                                                                                                      | Description                                         | Default value   | Type                                                                                            |
|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|
| **<a id="ansible.inventory.no_namespace_in_vars" name="ansible.inventory.no_namespace_in_vars">ansible.inventory.no_namespace_in_vars</a>**<br/>**Command line**: <br/>•&nbsp;--ansible.inventory.no_namespace_in_vars<br/>•&nbsp;--ansible.inventory.no-no_namespace_in_vars<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.INVENTORY.NO_NAMESPACE_IN_VARS | Remove namespace name in host vars.                 | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
| **<a id="ansible.inventory.export_warnings" name="ansible.inventory.export_warnings">ansible.inventory.export_warnings</a>**<br/>**Command line**: <br/>•&nbsp;--ansible.inventory.export_warnings<br/>•&nbsp;--ansible.inventory.no-export_warnings<br/>**Environment variable**: ROUGAILCLI_ANSIBLE.INVENTORY.EXPORT_WARNINGS                               | Displays warnings inside Ansible exportation datas. | true            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |
