10 KiB
10 KiB
Table of Contents
Generate Ansible inventory
Note
Path: ansible
disabled
Disabled: when the variable "select for output" is accessible and hasn't the value "ansible".
| Variable | Description | Default value | Type | Validator |
|---|---|---|---|---|
| ansible.output Command line: --ansible.output Environment variable: ROUGAILCLI_ANSIBLE.OUTPUT |
Output type. | inventory | choice mandatory |
Choices: • inventory • doc |
| ansible.host_namespace Command line: --ansible.host_namespace Environment variable: ROUGAILCLI_ANSIBLE.HOST_NAMESPACE |
Namespace with host values. | hosts | string mandatory |
Doc configuration
Note
Path: ansible.doc
disabled
Disabled: when the variable "Output type" hasn't the value "doc".
| Variable | Description | Default value | Type | Validator |
|---|---|---|---|---|
| ansible.doc.project_name Command line: --ansible.doc.project_name Environment variable: ROUGAILCLI_ANSIBLE.DOC.PROJECT_NAME |
Ansible project name. | string mandatory |
||
| ansible.doc.author Command line: --ansible.doc.author Environment variable: ROUGAILCLI_ANSIBLE.DOC.AUTHOR |
Ansible author name. | string mandatory |
||
| ansible.doc.output_format Command line: --ansible.doc.output_format Environment variable: ROUGAILCLI_ANSIBLE.DOC.OUTPUT_FORMAT |
The output format of the generated documentation. | console | choice mandatory |
Choices: • console • asciidoc • html • github • gitlab • restructuredtext • json |
| ansible.doc.collection_type Command line: --ansible.doc.collection_type Environment variable: ROUGAILCLI_ANSIBLE.DOC.COLLECTION_TYPE |
Collection contents. | auto | choice mandatory |
Choices: • auto • playbooks • 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 |
|---|---|---|---|
| ansible.doc.playbooks.name Command line: --ansible.doc.playbooks.name Environment variable: ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.NAME |
Playbook name. Playbooks are placed in the playbooks/ directory. By default, the description of the "type" is used as the Playbook name in the generated example. It is possible to customize this description here. |
string multiple |
unique |
| ansible.doc.playbooks.description Command line: --ansible.doc.playbooks.description Environment variable: ROUGAILCLI_ANSIBLE.DOC.PLAYBOOKS.DESCRIPTION |
Playbook description. | string mandatory |
Inventory configuration
Note
Path: ansible.inventory
disabled
Disabled: when the variable "Output type" hasn't the value "inventory".
| Variable | Description | Default value | Type |
|---|---|---|---|
| ansible.inventory.no_namespace_in_vars Command line: • --ansible.inventory.no_namespace_in_vars • --ansible.inventory.no-no_namespace_in_vars Environment variable: ROUGAILCLI_ANSIBLE.INVENTORY.NO_NAMESPACE_IN_VARS |
Remove namespace name in host vars. | false | boolean mandatory |
| ansible.inventory.export_warnings Command line: • --ansible.inventory.export_warnings • --ansible.inventory.no-export_warnings Environment variable: ROUGAILCLI_ANSIBLE.INVENTORY.EXPORT_WARNINGS |
Displays warnings inside Ansible exportation datas. | true | boolean mandatory |