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

| Variable                                                                                                                                                                                                                                                        | Description                                                                                                                                                     | Default value                                                                                                                                    | Type                                                                                                 | Access control                                                                                                    | Validator                                                                                                                                        |
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="default_structural_format_version" name="default_structural_format_version">default_structural_format_version</a>**<br/>**Command line**: <br/>-v, --default_structural_format_version<br/>**Environment variable**: DEFAULT_STRUCTURAL_FORMAT_VERSION | Default version of the structural file format.<br/>This value is only used if the version is not set in the structural file.                                    |                                                                                                                                                  | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types)                   | `standard`                                                                                                        | **Choices**: <br/>•&nbsp;1.0<br/>•&nbsp;1.1<br/>•&nbsp;null                                                                                      |
| **<a id="types" name="types">types</a>**<br/>**Command line**: <br/>--types<br/>**Environment variable**: TYPES                                                                                                                                                 | File with personalize types.<br/>This file contains personalize types in Rougail format for structure files.                                                    |                                                                                                                                                  | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard`                                                                                                        | `unique`<br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;this file must exist<br/>•&nbsp;file type allowed: "directory" and "file". |
| **<a id="functions_files" name="functions_files">functions_files</a>**<br/>**Command line**: <br/>--functions_files<br/>**Environment variable**: FUNCTIONS_FILES                                                                                               | File with functions.<br/>This file contains filters and additional Jinja2 functions usable in structure files.                                                  |                                                                                                                                                  | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard`                                                                                                        | `unique`<br/>•&nbsp;this filename could be a relative path<br/>•&nbsp;this file must exist<br/>•&nbsp;file type allowed: "file".                 |
| **<a id="modes_level" name="modes_level">modes_level</a>**<br/>**Command line**: <br/>--modes_level<br/>**Environment variable**: MODES_LEVEL                                                                                                                   | All modes level available.                                                                                                                                      |                                                                                                                                                  | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple`        | `standard`                                                                                                        | `unique`                                                                                                                                         |
| **<a id="default_family_mode" name="default_family_mode">default_family_mode</a>**<br/>**Environment variable**: DEFAULT_FAMILY_MODE                                                                                                                            | Default mode for a family.                                                                                                                                      | the first one defined in "[All modes level available](#modes_level)".                                                                            | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`       | `standard` *`disabled`*<br/>**Disabled**: when no mode is defined in "[All modes level available](#modes_level)". | This mode must be available in "[All modes level available](#modes_level)".                                                                      |
| **<a id="default_variable_mode" name="default_variable_mode">default_variable_mode</a>**<br/>**Environment variable**: DEFAULT_VARIABLE_MODE                                                                                                                    | Default mode for a variable.                                                                                                                                    | if the variable "[All modes level available](#modes_level)" is defined, the default value is the second available element, otherwise, the first. | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`       | `standard` *`disabled`*<br/>**Disabled**: when no mode is defined in "[All modes level available](#modes_level)". | This mode must be available in "[All modes level available](#modes_level)".                                                                      |
| **<a id="base_option_name" name="base_option_name">base_option_name</a>**<br/>**Environment variable**: BASE_OPTION_NAME                                                                                                                                        | Option name for the base option.                                                                                                                                | baseoption                                                                                                                                       | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`       | `standard`                                                                                                        |                                                                                                                                                  |
| **<a id="export_with_import" name="export_with_import">export_with_import</a>**<br/>**Environment variable**: EXPORT_WITH_IMPORT                                                                                                                                | In cache file, do not importation of Tiramisu and other dependencies.                                                                                           | true                                                                                                                                             | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`      | `standard`                                                                                                        |                                                                                                                                                  |
| **<a id="tiramisu_cache" name="tiramisu_cache">tiramisu_cache</a>**<br/>**Environment variable**: TIRAMISU_CACHE                                                                                                                                                | Store Tiramisu cache filename.<br/>This file contains the Tiramisu instructions used internally to load the variables.<br/>This file can be used for debugging. |                                                                                                                                                  | [`UNIX filename`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types)            | `standard`                                                                                                        | •&nbsp;this filename could be a relative path<br/>•&nbsp;file type allowed: "file".                                                              |
| **<a id="internal_functions" name="internal_functions">internal_functions</a>**<br/>**Environment variable**: INTERNAL_FUNCTIONS                                                                                                                                | Name of internal functions that we can use as a function.                                                                                                       |                                                                                                                                                  | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple`        | `standard`                                                                                                        | `unique`                                                                                                                                         |
| **<a id="extra_annotators" name="extra_annotators">extra_annotators</a>**<br/>**Environment variable**: EXTRA_ANNOTATORS                                                                                                                                        | Name of extra annotators.                                                                                                                                       |                                                                                                                                                  | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple`        | `standard`                                                                                                        | `unique`                                                                                                                                         |
| **<a id="suffix" name="suffix">suffix</a>**<br/>**Environment variable**: SUFFIX                                                                                                                                                                                | Suffix add to generated options name.                                                                                                                           |                                                                                                                                                  | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types)                   | `standard`                                                                                                        |                                                                                                                                                  |
| **<a id="force_optional" name="force_optional">force_optional</a>**<br/>**Command line**: <br/>•&nbsp;--force_optional<br/>•&nbsp;--no-force_optional<br/>**Environment variable**: FORCE_OPTIONAL                                                              | Every variables in calculation are optionals.                                                                                                                   | false                                                                                                                                            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`      | `standard`                                                                                                        |                                                                                                                                                  |
| **<a id="load_unexist_redefine" name="load_unexist_redefine">load_unexist_redefine</a>**<br/>**Environment variable**: LOAD_UNEXIST_REDEFINE                                                                                                                    | Loads redefine variables even if there don&#x27;t already exists.                                                                                               | false                                                                                                                                            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`      | `standard`                                                                                                        |                                                                                                                                                  |

## The secret manager

> [!NOTE]
> 
> **Path**: secret_manager\
> `standard`

| Variable                                                                                                                                                                                             | Description                                                                                                                      | Default value                                                  | Type                                                                                           | Access control   |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|------------------------------------------------------------------------------------------------|------------------|
| **<a id="secret_manager.pattern" name="secret_manager.pattern">secret_manager.pattern</a>**<br/>**Command line**: <br/>--secret_manager.pattern<br/>**Environment variable**: SECRET_MANAGER.PATTERN | The secret pattern to constructing the name of the item searched for in the secret manager.<br/>The pattern is in Jinja2 format. | {{ project }} - {{ environment }} - {{ service }} - {{ user }} | [`string`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard`       |

## Load and exporter steps

> [!NOTE]
> 
> **Path**: step\
> `standard`

| Variable                                                                                                                                                         | Description            | Default value    | Type                                                                                                      | Access control                                                                   | Validator                                                                                                                                                                  |
|------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------|------------------|-----------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **<a id="step.structural" name="step.structural">step.structural</a>**<br/>**Environment variable**: STEP.STRUCTURAL                                             | Select for structural. | •&nbsp;directory | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` `mandatory` | `standard`                                                                       | `unique`<br/>**Choices**: <br/>•&nbsp;directory<br/>•&nbsp;string<br/>•&nbsp;commandline<br/>•&nbsp;risotto                                                                |
| **<a id="step.user_data" name="step.user_data">step.user_data</a>**<br/>**Command line**: <br/>-u, --step.user_data<br/>**Environment variable**: STEP.USER_DATA | Select for user datas. |                  | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple`             | `standard` *`disabled`*<br/>**Disabled**: outputs "doc" did not allow user data. | `unique`<br/>**Choices**: <br/>•&nbsp;yaml<br/>•&nbsp;environment<br/>•&nbsp;commandline<br/>•&nbsp;ansible<br/>•&nbsp;questionary<br/>•&nbsp;risotto<br/>•&nbsp;bitwarden |
| **<a id="step.output" name="step.output">step.output</a>**<br/>**Command line**: <br/>-o, --step.output<br/>**Environment variable**: STEP.OUTPUT                | Select for output.     | display          | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory`            | `standard`                                                                       | **Choices**: <br/>•&nbsp;display<br/>•&nbsp;json<br/>•&nbsp;doc<br/>•&nbsp;table<br/>•&nbsp;ansible                                                                        |

| Variable                                                                                                                                                                                                                                     | Description                                  | Default value   | Type                                                                                            | Access control   |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|-----------------|-------------------------------------------------------------------------------------------------|------------------|
| **<a id="define_default_params" name="define_default_params">define_default_params</a>**<br/>**Command line**: <br/>•&nbsp;--define_default_params<br/>•&nbsp;--no-define_default_params<br/>**Environment variable**: DEFINE_DEFAULT_PARAMS | Override default parameters for option type. | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `mandatory` | `standard`       |

## Default parameters for option type

> [!NOTE]
> 
> **Path**: default_params\
> `standard` *`disabled`*\
> **Disabled**: when the variable "[Override default parameters for option type](#define_default_params)" has the value "false".

### UNIX filename

> [!NOTE]
> 
> **Path**: default_params.unix_filename\
> `standard`

| Variable                                                                                                                                                                                                                                                                                                                                                                         | Description                             | Default value                    | Type                                                                                          | Access control   | Validator                                                       |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|----------------------------------|-----------------------------------------------------------------------------------------------|------------------|-----------------------------------------------------------------|
| **<a id="default_params.unix_filename.allow_relative" name="default_params.unix_filename.allow_relative">default_params.unix_filename.allow_relative</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.unix_filename.allow_relative<br/>•&nbsp;--default_params.unix_filename.no-allow_relative<br/>**Environment variable**: DEFAULT_PARAMS.UNIX_FILENAME.ALLOW_RELATIVE | This filename could be a relative path. | false                            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types)           | `standard`       |                                                                 |
| **<a id="default_params.unix_filename.test_existence" name="default_params.unix_filename.test_existence">default_params.unix_filename.test_existence</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.unix_filename.test_existence<br/>•&nbsp;--default_params.unix_filename.no-test_existence<br/>**Environment variable**: DEFAULT_PARAMS.UNIX_FILENAME.TEST_EXISTENCE | This file must exist.                   | false                            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types)           | `standard`       |                                                                 |
| **<a id="default_params.unix_filename.types" name="default_params.unix_filename.types">default_params.unix_filename.types</a>**<br/>**Command line**: <br/>--default_params.unix_filename.types<br/>**Environment variable**: DEFAULT_PARAMS.UNIX_FILENAME.TYPES                                                                                                                 | File type allowed.                      | •&nbsp;file<br/>•&nbsp;directory | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) `multiple` | `standard`       | `unique`<br/>**Choices**: <br/>•&nbsp;file<br/>•&nbsp;directory |

### IP

> [!NOTE]
> 
> **Path**: default_params.ip\
> `standard`

| Variable                                                                                                                                                                                                                                                                                                       | Description                | Default value   | Type                                                                                | Access control   |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|-----------------|-------------------------------------------------------------------------------------|------------------|
| **<a id="default_params.ip.private_only" name="default_params.ip.private_only">default_params.ip.private_only</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.ip.private_only<br/>•&nbsp;--default_params.ip.no-private_only<br/>**Environment variable**: DEFAULT_PARAMS.IP.PRIVATE_ONLY             | Private IP are allowed.    | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
| **<a id="default_params.ip.allow_reserved" name="default_params.ip.allow_reserved">default_params.ip.allow_reserved</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.ip.allow_reserved<br/>•&nbsp;--default_params.ip.no-allow_reserved<br/>**Environment variable**: DEFAULT_PARAMS.IP.ALLOW_RESERVED | Reserved IP are allowed.   | true            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
| **<a id="default_params.ip.cidr" name="default_params.ip.cidr">default_params.ip.cidr</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.ip.cidr<br/>•&nbsp;--default_params.ip.no-cidr<br/>**Environment variable**: DEFAULT_PARAMS.IP.CIDR                                                             | IP must be in CIDR format. | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |

### CIDR

> [!NOTE]
> 
> **Path**: default_params.cidr\
> `standard`

| Variable                                                                                                                                                                                                                                                                                                                   | Description                | Default value   | Type                                                                                | Access control   |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------|-----------------|-------------------------------------------------------------------------------------|------------------|
| **<a id="default_params.cidr.private_only" name="default_params.cidr.private_only">default_params.cidr.private_only</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.cidr.private_only<br/>•&nbsp;--default_params.cidr.no-private_only<br/>**Environment variable**: DEFAULT_PARAMS.CIDR.PRIVATE_ONLY             | Private IP are allowed.    | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
| **<a id="default_params.cidr.allow_reserved" name="default_params.cidr.allow_reserved">default_params.cidr.allow_reserved</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.cidr.allow_reserved<br/>•&nbsp;--default_params.cidr.no-allow_reserved<br/>**Environment variable**: DEFAULT_PARAMS.CIDR.ALLOW_RESERVED | Reserved IP are allowed.   | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
| **<a id="default_params.cidr.cidr" name="default_params.cidr.cidr">default_params.cidr.cidr</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.cidr.cidr<br/>•&nbsp;--default_params.cidr.no-cidr<br/>**Environment variable**: DEFAULT_PARAMS.CIDR.CIDR                                                             | IP must be in CIDR format. | true            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |

### Network

> [!NOTE]
> 
> **Path**: default_params.network\
> `standard`

| Variable                                                                                                                                                                                                                                                                                                                                     | Description                     | Default value   | Type                                                                                | Access control   |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|-----------------|-------------------------------------------------------------------------------------|------------------|
| **<a id="default_params.network.private_only" name="default_params.network.private_only">default_params.network.private_only</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.network.private_only<br/>•&nbsp;--default_params.network.no-private_only<br/>**Environment variable**: DEFAULT_PARAMS.NETWORK.PRIVATE_ONLY             | Private network are allowed.    | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
| **<a id="default_params.network.allow_reserved" name="default_params.network.allow_reserved">default_params.network.allow_reserved</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.network.allow_reserved<br/>•&nbsp;--default_params.network.no-allow_reserved<br/>**Environment variable**: DEFAULT_PARAMS.NETWORK.ALLOW_RESERVED | Reserved network are allowed.   | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
| **<a id="default_params.network.cidr" name="default_params.network.cidr">default_params.network.cidr</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.network.cidr<br/>•&nbsp;--default_params.network.no-cidr<br/>**Environment variable**: DEFAULT_PARAMS.NETWORK.CIDR                                                             | Network must be in CIDR format. | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |

### Network CIDR

> [!NOTE]
> 
> **Path**: default_params.network_cidr\
> `standard`

| Variable                                                                                                                                                                                                                                                                                                                                                                   | Description                     | Default value   | Type                                                                                | Access control   |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------|-----------------|-------------------------------------------------------------------------------------|------------------|
| **<a id="default_params.network_cidr.private_only" name="default_params.network_cidr.private_only">default_params.network_cidr.private_only</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.network_cidr.private_only<br/>•&nbsp;--default_params.network_cidr.no-private_only<br/>**Environment variable**: DEFAULT_PARAMS.NETWORK_CIDR.PRIVATE_ONLY             | Private network are allowed.    | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
| **<a id="default_params.network_cidr.allow_reserved" name="default_params.network_cidr.allow_reserved">default_params.network_cidr.allow_reserved</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.network_cidr.allow_reserved<br/>•&nbsp;--default_params.network_cidr.no-allow_reserved<br/>**Environment variable**: DEFAULT_PARAMS.NETWORK_CIDR.ALLOW_RESERVED | Reserved network are allowed.   | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
| **<a id="default_params.network_cidr.cidr" name="default_params.network_cidr.cidr">default_params.network_cidr.cidr</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.network_cidr.cidr<br/>•&nbsp;--default_params.network_cidr.no-cidr<br/>**Environment variable**: DEFAULT_PARAMS.NETWORK_CIDR.CIDR                                                             | Network must be in CIDR format. | true            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |

### Netbios

> [!NOTE]
> 
> **Path**: default_params.netbios\
> `standard`

| Variable                                                                                                                                                                                                                                                                                                                                                                         | Description                                    | Default value   | Type                                                                                | Access control   | Validator                                                                                  |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|-----------------|-------------------------------------------------------------------------------------|------------------|--------------------------------------------------------------------------------------------|
| **<a id="default_params.netbios.type" name="default_params.netbios.type">default_params.netbios.type</a>**<br/>**Command line**: <br/>--default_params.netbios.type<br/>**Environment variable**: DEFAULT_PARAMS.NETBIOS.TYPE                                                                                                                                                    | Type of domainname.                            | netbios         | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types)  | `standard`       | **Choices**: <br/>•&nbsp;domainname<br/>•&nbsp;netbios<br/>•&nbsp;hostname<br/>•&nbsp;null |
| **<a id="default_params.netbios.allow_without_dot" name="default_params.netbios.allow_without_dot">default_params.netbios.allow_without_dot</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.netbios.allow_without_dot<br/>•&nbsp;--default_params.netbios.no-allow_without_dot<br/>**Environment variable**: DEFAULT_PARAMS.NETBIOS.ALLOW_WITHOUT_DOT                   | The domain name can be a hostname.             | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.netbios.test_existence" name="default_params.netbios.test_existence">default_params.netbios.test_existence</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.netbios.test_existence<br/>•&nbsp;--default_params.netbios.no-test_existence<br/>**Environment variable**: DEFAULT_PARAMS.NETBIOS.TEST_EXISTENCE                                     | The domain name must exist.                    | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.netbios.allow_ip" name="default_params.netbios.allow_ip">default_params.netbios.allow_ip</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.netbios.allow_ip<br/>•&nbsp;--default_params.netbios.no-allow_ip<br/>**Environment variable**: DEFAULT_PARAMS.NETBIOS.ALLOW_IP                                                                         | The domain name can be an IP.                  | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.netbios.allow_cidr_network" name="default_params.netbios.allow_cidr_network">default_params.netbios.allow_cidr_network</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.netbios.allow_cidr_network<br/>•&nbsp;--default_params.netbios.no-allow_cidr_network<br/>**Environment variable**: DEFAULT_PARAMS.NETBIOS.ALLOW_CIDR_NETWORK             | The domain name can be network in CIDR format. | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.netbios.allow_startswith_dot" name="default_params.netbios.allow_startswith_dot">default_params.netbios.allow_startswith_dot</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.netbios.allow_startswith_dot<br/>•&nbsp;--default_params.netbios.no-allow_startswith_dot<br/>**Environment variable**: DEFAULT_PARAMS.NETBIOS.ALLOW_STARTSWITH_DOT | The domain name can starts by a dot.           | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |

### Domainname

> [!NOTE]
> 
> **Path**: default_params.domainname\
> `standard`

| Variable                                                                                                                                                                                                                                                                                                                                                                                           | Description                                    | Default value   | Type                                                                                | Access control   | Validator                                                                                  |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|-----------------|-------------------------------------------------------------------------------------|------------------|--------------------------------------------------------------------------------------------|
| **<a id="default_params.domainname.type" name="default_params.domainname.type">default_params.domainname.type</a>**<br/>**Command line**: <br/>--default_params.domainname.type<br/>**Environment variable**: DEFAULT_PARAMS.DOMAINNAME.TYPE                                                                                                                                                       | Type of domainname.                            | domainname      | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types)  | `standard`       | **Choices**: <br/>•&nbsp;domainname<br/>•&nbsp;netbios<br/>•&nbsp;hostname<br/>•&nbsp;null |
| **<a id="default_params.domainname.allow_without_dot" name="default_params.domainname.allow_without_dot">default_params.domainname.allow_without_dot</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.domainname.allow_without_dot<br/>•&nbsp;--default_params.domainname.no-allow_without_dot<br/>**Environment variable**: DEFAULT_PARAMS.DOMAINNAME.ALLOW_WITHOUT_DOT                   | The domain name can be a hostname.             | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.domainname.test_existence" name="default_params.domainname.test_existence">default_params.domainname.test_existence</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.domainname.test_existence<br/>•&nbsp;--default_params.domainname.no-test_existence<br/>**Environment variable**: DEFAULT_PARAMS.DOMAINNAME.TEST_EXISTENCE                                     | The domain name must exist.                    | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.domainname.allow_ip" name="default_params.domainname.allow_ip">default_params.domainname.allow_ip</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.domainname.allow_ip<br/>•&nbsp;--default_params.domainname.no-allow_ip<br/>**Environment variable**: DEFAULT_PARAMS.DOMAINNAME.ALLOW_IP                                                                         | The domain name can be an IP.                  | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.domainname.allow_cidr_network" name="default_params.domainname.allow_cidr_network">default_params.domainname.allow_cidr_network</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.domainname.allow_cidr_network<br/>•&nbsp;--default_params.domainname.no-allow_cidr_network<br/>**Environment variable**: DEFAULT_PARAMS.DOMAINNAME.ALLOW_CIDR_NETWORK             | The domain name can be network in CIDR format. | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.domainname.allow_startswith_dot" name="default_params.domainname.allow_startswith_dot">default_params.domainname.allow_startswith_dot</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.domainname.allow_startswith_dot<br/>•&nbsp;--default_params.domainname.no-allow_startswith_dot<br/>**Environment variable**: DEFAULT_PARAMS.DOMAINNAME.ALLOW_STARTSWITH_DOT | The domain name can starts by a dot.           | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |

### Hostname

> [!NOTE]
> 
> **Path**: default_params.hostname\
> `standard`

| Variable                                                                                                                                                                                                                                                                                                                                                                               | Description                                    | Default value   | Type                                                                                | Access control   | Validator                                                                                  |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|-----------------|-------------------------------------------------------------------------------------|------------------|--------------------------------------------------------------------------------------------|
| **<a id="default_params.hostname.type" name="default_params.hostname.type">default_params.hostname.type</a>**<br/>**Command line**: <br/>--default_params.hostname.type<br/>**Environment variable**: DEFAULT_PARAMS.HOSTNAME.TYPE                                                                                                                                                     | Type of domainname.                            | hostname        | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types)  | `standard`       | **Choices**: <br/>•&nbsp;domainname<br/>•&nbsp;netbios<br/>•&nbsp;hostname<br/>•&nbsp;null |
| **<a id="default_params.hostname.allow_without_dot" name="default_params.hostname.allow_without_dot">default_params.hostname.allow_without_dot</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.hostname.allow_without_dot<br/>•&nbsp;--default_params.hostname.no-allow_without_dot<br/>**Environment variable**: DEFAULT_PARAMS.HOSTNAME.ALLOW_WITHOUT_DOT                   | The domain name can be a hostname.             | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.hostname.test_existence" name="default_params.hostname.test_existence">default_params.hostname.test_existence</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.hostname.test_existence<br/>•&nbsp;--default_params.hostname.no-test_existence<br/>**Environment variable**: DEFAULT_PARAMS.HOSTNAME.TEST_EXISTENCE                                     | The domain name must exist.                    | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.hostname.allow_ip" name="default_params.hostname.allow_ip">default_params.hostname.allow_ip</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.hostname.allow_ip<br/>•&nbsp;--default_params.hostname.no-allow_ip<br/>**Environment variable**: DEFAULT_PARAMS.HOSTNAME.ALLOW_IP                                                                         | The domain name can be an IP.                  | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.hostname.allow_cidr_network" name="default_params.hostname.allow_cidr_network">default_params.hostname.allow_cidr_network</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.hostname.allow_cidr_network<br/>•&nbsp;--default_params.hostname.no-allow_cidr_network<br/>**Environment variable**: DEFAULT_PARAMS.HOSTNAME.ALLOW_CIDR_NETWORK             | The domain name can be network in CIDR format. | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.hostname.allow_startswith_dot" name="default_params.hostname.allow_startswith_dot">default_params.hostname.allow_startswith_dot</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.hostname.allow_startswith_dot<br/>•&nbsp;--default_params.hostname.no-allow_startswith_dot<br/>**Environment variable**: DEFAULT_PARAMS.HOSTNAME.ALLOW_STARTSWITH_DOT | The domain name can starts by a dot.           | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |

### Web address

> [!NOTE]
> 
> **Path**: default_params.web_address\
> `standard`

| Variable                                                                                                                                                                                                                                                                                                                                                                                                 | Description                                     | Default value   | Type                                                                                | Access control   | Validator                                                                                  |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|-----------------|-------------------------------------------------------------------------------------|------------------|--------------------------------------------------------------------------------------------|
| **<a id="default_params.web_address.type" name="default_params.web_address.type">default_params.web_address.type</a>**<br/>**Command line**: <br/>--default_params.web_address.type<br/>**Environment variable**: DEFAULT_PARAMS.WEB_ADDRESS.TYPE                                                                                                                                                        | Type of domainname.                             | domainname      | [`choice`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types)  | `standard`       | **Choices**: <br/>•&nbsp;domainname<br/>•&nbsp;netbios<br/>•&nbsp;hostname<br/>•&nbsp;null |
| **<a id="default_params.web_address.allow_without_dot" name="default_params.web_address.allow_without_dot">default_params.web_address.allow_without_dot</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.web_address.allow_without_dot<br/>•&nbsp;--default_params.web_address.no-allow_without_dot<br/>**Environment variable**: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_WITHOUT_DOT                   | The domain name can be a hostname.              | true            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.web_address.test_existence" name="default_params.web_address.test_existence">default_params.web_address.test_existence</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.web_address.test_existence<br/>•&nbsp;--default_params.web_address.no-test_existence<br/>**Environment variable**: DEFAULT_PARAMS.WEB_ADDRESS.TEST_EXISTENCE                                     | The domain name must exist.                     | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.web_address.allow_ip" name="default_params.web_address.allow_ip">default_params.web_address.allow_ip</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.web_address.allow_ip<br/>•&nbsp;--default_params.web_address.no-allow_ip<br/>**Environment variable**: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_IP                                                                         | The domain name can be an IP.                   | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.web_address.allow_cidr_network" name="default_params.web_address.allow_cidr_network">default_params.web_address.allow_cidr_network</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.web_address.allow_cidr_network<br/>•&nbsp;--default_params.web_address.no-allow_cidr_network<br/>**Environment variable**: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_CIDR_NETWORK             | The domain name can be network in CIDR format.  | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.web_address.allow_startswith_dot" name="default_params.web_address.allow_startswith_dot">default_params.web_address.allow_startswith_dot</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.web_address.allow_startswith_dot<br/>•&nbsp;--default_params.web_address.no-allow_startswith_dot<br/>**Environment variable**: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_STARTSWITH_DOT | The domain name can starts by a dot.            | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.web_address.allow_range" name="default_params.web_address.allow_range">default_params.web_address.allow_range</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.web_address.allow_range<br/>•&nbsp;--default_params.web_address.no-allow_range<br/>**Environment variable**: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_RANGE                                                       | Can be range of port.                           | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.web_address.allow_protocol" name="default_params.web_address.allow_protocol">default_params.web_address.allow_protocol</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.web_address.allow_protocol<br/>•&nbsp;--default_params.web_address.no-allow_protocol<br/>**Environment variable**: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_PROTOCOL                                     | Can have the protocol.                          | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.web_address.allow_zero" name="default_params.web_address.allow_zero">default_params.web_address.allow_zero</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.web_address.allow_zero<br/>•&nbsp;--default_params.web_address.no-allow_zero<br/>**Environment variable**: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_ZERO                                                             | Port 0 is allowed.                              | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.web_address.allow_wellknown" name="default_params.web_address.allow_wellknown">default_params.web_address.allow_wellknown</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.web_address.allow_wellknown<br/>•&nbsp;--default_params.web_address.no-allow_wellknown<br/>**Environment variable**: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_WELLKNOWN                               | Well-known ports (1 to 1023) are allowed.       | true            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.web_address.allow_registred" name="default_params.web_address.allow_registred">default_params.web_address.allow_registred</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.web_address.allow_registred<br/>•&nbsp;--default_params.web_address.no-allow_registred<br/>**Environment variable**: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_REGISTRED                               | Registred ports (1024 to 49151) are allowed.    | true            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |
| **<a id="default_params.web_address.allow_private" name="default_params.web_address.allow_private">default_params.web_address.allow_private</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.web_address.allow_private<br/>•&nbsp;--default_params.web_address.no-allow_private<br/>**Environment variable**: DEFAULT_PARAMS.WEB_ADDRESS.ALLOW_PRIVATE                                           | Private ports (greater than 49152) are allowed. | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |                                                                                            |

### Port

> [!NOTE]
> 
> **Path**: default_params.port\
> `standard`

| Variable                                                                                                                                                                                                                                                                                                                         | Description                                     | Default value   | Type                                                                                | Access control   |
|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------|-----------------|-------------------------------------------------------------------------------------|------------------|
| **<a id="default_params.port.allow_range" name="default_params.port.allow_range">default_params.port.allow_range</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.port.allow_range<br/>•&nbsp;--default_params.port.no-allow_range<br/>**Environment variable**: DEFAULT_PARAMS.PORT.ALLOW_RANGE                         | Can be range of port.                           | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
| **<a id="default_params.port.allow_protocol" name="default_params.port.allow_protocol">default_params.port.allow_protocol</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.port.allow_protocol<br/>•&nbsp;--default_params.port.no-allow_protocol<br/>**Environment variable**: DEFAULT_PARAMS.PORT.ALLOW_PROTOCOL       | Can have the protocol.                          | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
| **<a id="default_params.port.allow_zero" name="default_params.port.allow_zero">default_params.port.allow_zero</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.port.allow_zero<br/>•&nbsp;--default_params.port.no-allow_zero<br/>**Environment variable**: DEFAULT_PARAMS.PORT.ALLOW_ZERO                               | Port 0 is allowed.                              | false           | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
| **<a id="default_params.port.allow_wellknown" name="default_params.port.allow_wellknown">default_params.port.allow_wellknown</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.port.allow_wellknown<br/>•&nbsp;--default_params.port.no-allow_wellknown<br/>**Environment variable**: DEFAULT_PARAMS.PORT.ALLOW_WELLKNOWN | Well-known ports (1 to 1023) are allowed.       | true            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
| **<a id="default_params.port.allow_registred" name="default_params.port.allow_registred">default_params.port.allow_registred</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.port.allow_registred<br/>•&nbsp;--default_params.port.no-allow_registred<br/>**Environment variable**: DEFAULT_PARAMS.PORT.ALLOW_REGISTRED | Registred ports (1024 to 49151) are allowed.    | true            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
| **<a id="default_params.port.allow_private" name="default_params.port.allow_private">default_params.port.allow_private</a>**<br/>**Command line**: <br/>•&nbsp;--default_params.port.allow_private<br/>•&nbsp;--default_params.port.no-allow_private<br/>**Environment variable**: DEFAULT_PARAMS.PORT.ALLOW_PRIVATE             | Private ports (greater than 49152) are allowed. | true            | [`boolean`](https://rougail.readthedocs.io/en/latest/variable.html#variables-types) | `standard`       |
