---
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**: ANSIBLE.OUTPUT | Output type.  | inventory       | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | **Choices**: <br/>•&nbsp;inventory<br/>•&nbsp;doc |

### 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.author" name="ansible.doc.author">ansible.doc.author</a>**<br/>**Command line**: <br/>--ansible.doc.author<br/>**Environment variable**: ANSIBLE.DOC.AUTHOR                                    | Ansible author name.                              | <author>        | [`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**: 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;json |

### 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.host_namespace" name="ansible.inventory.host_namespace">ansible.inventory.host_namespace</a>**<br/>**Command line**: <br/>--ansible.inventory.host_namespace<br/>**Environment variable**: ANSIBLE.INVENTORY.HOST_NAMESPACE                                                                                             | Namespace with host values.                         | hosts           | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`  |
| **<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**: 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**: ANSIBLE.INVENTORY.EXPORT_WARNINGS                               | Displays warnings inside Ansible exportation datas. | true            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` |


