Misc. fixes in base.yml (#81771)

* Convert Latin short forms to English wording
* Typo fixes
* Sentence rewording

Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com>
pull/81784/head
Abhijeet Kasurde 2 years ago committed by GitHub
parent 51f2ddd445
commit 989ea7a9f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -28,14 +28,14 @@ ANSIBLE_CONNECTION_PATH:
ANSIBLE_COW_SELECTION: ANSIBLE_COW_SELECTION:
name: Cowsay filter selection name: Cowsay filter selection
default: default default: default
description: This allows you to chose a specific cowsay stencil for the banners or use 'random' to cycle through them. description: This allows you to choose a specific cowsay stencil for the banners or use 'random' to cycle through them.
env: [{name: ANSIBLE_COW_SELECTION}] env: [{name: ANSIBLE_COW_SELECTION}]
ini: ini:
- {key: cow_selection, section: defaults} - {key: cow_selection, section: defaults}
ANSIBLE_COW_ACCEPTLIST: ANSIBLE_COW_ACCEPTLIST:
name: Cowsay filter acceptance list name: Cowsay filter acceptance list
default: ['bud-frogs', 'bunny', 'cheese', 'daemon', 'default', 'dragon', 'elephant-in-snake', 'elephant', 'eyes', 'hellokitty', 'kitty', 'luke-koala', 'meow', 'milk', 'moofasa', 'moose', 'ren', 'sheep', 'small', 'stegosaurus', 'stimpy', 'supermilker', 'three-eyes', 'turkey', 'turtle', 'tux', 'udder', 'vader-koala', 'vader', 'www'] default: ['bud-frogs', 'bunny', 'cheese', 'daemon', 'default', 'dragon', 'elephant-in-snake', 'elephant', 'eyes', 'hellokitty', 'kitty', 'luke-koala', 'meow', 'milk', 'moofasa', 'moose', 'ren', 'sheep', 'small', 'stegosaurus', 'stimpy', 'supermilker', 'three-eyes', 'turkey', 'turtle', 'tux', 'udder', 'vader-koala', 'vader', 'www']
description: Accept list of cowsay templates that are 'safe' to use, set to empty list if you want to enable all installed templates. description: Accept a list of cowsay templates that are 'safe' to use, set to an empty list if you want to enable all installed templates.
env: env:
- name: ANSIBLE_COW_ACCEPTLIST - name: ANSIBLE_COW_ACCEPTLIST
version_added: '2.11' version_added: '2.11'
@ -78,7 +78,7 @@ ANSIBLE_NOCOWS:
ANSIBLE_COW_PATH: ANSIBLE_COW_PATH:
name: Set path to cowsay command name: Set path to cowsay command
default: null default: null
description: Specify a custom cowsay path or swap in your cowsay implementation of choice description: Specify a custom cowsay path or swap in your cowsay implementation of choice.
env: [{name: ANSIBLE_COW_PATH}] env: [{name: ANSIBLE_COW_PATH}]
ini: ini:
- {key: cowpath, section: defaults} - {key: cowpath, section: defaults}
@ -119,7 +119,7 @@ BECOME_ALLOW_SAME_USER:
name: Allow becoming the same user name: Allow becoming the same user
default: False default: False
description: description:
- This setting controls if become is skipped when remote user and become user are the same. I.E root sudo to root. - This setting controls if become is skipped when the remote user and become user are the same. In other words root sudo to root.
- If executable, it will be run and the resulting stdout will be used as the password. - If executable, it will be run and the resulting stdout will be used as the password.
env: [{name: ANSIBLE_BECOME_ALLOW_SAME_USER}] env: [{name: ANSIBLE_BECOME_ALLOW_SAME_USER}]
ini: ini:
@ -130,7 +130,7 @@ BECOME_PASSWORD_FILE:
name: Become password file name: Become password file
default: ~ default: ~
description: description:
- 'The password file to use for the become plugin. --become-password-file.' - 'The password file to use for the become plugin. ``--become-password-file``.'
- If executable, it will be run and the resulting stdout will be used as the password. - If executable, it will be run and the resulting stdout will be used as the password.
env: [{name: ANSIBLE_BECOME_PASSWORD_FILE}] env: [{name: ANSIBLE_BECOME_PASSWORD_FILE}]
ini: ini:
@ -141,7 +141,7 @@ AGNOSTIC_BECOME_PROMPT:
name: Display an agnostic become prompt name: Display an agnostic become prompt
default: True default: True
type: boolean type: boolean
description: Display an agnostic become prompt instead of displaying a prompt containing the command line supplied become method description: Display an agnostic become prompt instead of displaying a prompt containing the command line supplied become method.
env: [{name: ANSIBLE_AGNOSTIC_BECOME_PROMPT}] env: [{name: ANSIBLE_AGNOSTIC_BECOME_PROMPT}]
ini: ini:
- {key: agnostic_become_prompt, section: privilege_escalation} - {key: agnostic_become_prompt, section: privilege_escalation}
@ -158,7 +158,7 @@ CACHE_PLUGIN:
CACHE_PLUGIN_CONNECTION: CACHE_PLUGIN_CONNECTION:
name: Cache Plugin URI name: Cache Plugin URI
default: ~ default: ~
description: Defines connection or path information for the cache plugin description: Defines connection or path information for the cache plugin.
env: [{name: ANSIBLE_CACHE_PLUGIN_CONNECTION}] env: [{name: ANSIBLE_CACHE_PLUGIN_CONNECTION}]
ini: ini:
- {key: fact_caching_connection, section: defaults} - {key: fact_caching_connection, section: defaults}
@ -166,7 +166,7 @@ CACHE_PLUGIN_CONNECTION:
CACHE_PLUGIN_PREFIX: CACHE_PLUGIN_PREFIX:
name: Cache Plugin table prefix name: Cache Plugin table prefix
default: ansible_facts default: ansible_facts
description: Prefix to use for cache plugin files/tables description: Prefix to use for cache plugin files/tables.
env: [{name: ANSIBLE_CACHE_PLUGIN_PREFIX}] env: [{name: ANSIBLE_CACHE_PLUGIN_PREFIX}]
ini: ini:
- {key: fact_caching_prefix, section: defaults} - {key: fact_caching_prefix, section: defaults}
@ -174,7 +174,7 @@ CACHE_PLUGIN_PREFIX:
CACHE_PLUGIN_TIMEOUT: CACHE_PLUGIN_TIMEOUT:
name: Cache Plugin expiration timeout name: Cache Plugin expiration timeout
default: 86400 default: 86400
description: Expiration timeout for the cache plugin data description: Expiration timeout for the cache plugin data.
env: [{name: ANSIBLE_CACHE_PLUGIN_TIMEOUT}] env: [{name: ANSIBLE_CACHE_PLUGIN_TIMEOUT}]
ini: ini:
- {key: fact_caching_timeout, section: defaults} - {key: fact_caching_timeout, section: defaults}
@ -182,7 +182,7 @@ CACHE_PLUGIN_TIMEOUT:
yaml: {key: facts.cache.timeout} yaml: {key: facts.cache.timeout}
COLLECTIONS_SCAN_SYS_PATH: COLLECTIONS_SCAN_SYS_PATH:
name: Scan PYTHONPATH for installed collections name: Scan PYTHONPATH for installed collections
description: A boolean to enable or disable scanning the sys.path for installed collections description: A boolean to enable or disable scanning the sys.path for installed collections.
default: true default: true
type: boolean type: boolean
env: env:
@ -190,9 +190,9 @@ COLLECTIONS_SCAN_SYS_PATH:
ini: ini:
- {key: collections_scan_sys_path, section: defaults} - {key: collections_scan_sys_path, section: defaults}
COLLECTIONS_PATHS: COLLECTIONS_PATHS:
name: ordered list of root paths for loading installed Ansible collections content name: An ordered list of root paths for loading installed Ansible collections content.
description: > description: >
Colon separated paths in which Ansible will search for collections content. Colon-separated paths in which Ansible will search for collections content.
Collections must be in nested *subdirectories*, not directly in these directories. Collections must be in nested *subdirectories*, not directly in these directories.
For example, if ``COLLECTIONS_PATHS`` includes ``'{{ ANSIBLE_HOME ~ "/collections" }}'``, For example, if ``COLLECTIONS_PATHS`` includes ``'{{ ANSIBLE_HOME ~ "/collections" }}'``,
and you want to add ``my.collection`` to that directory, it must be saved as and you want to add ``my.collection`` to that directory, it must be saved as
@ -229,14 +229,14 @@ COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH:
COLOR_CHANGED: COLOR_CHANGED:
name: Color for 'changed' task status name: Color for 'changed' task status
default: yellow default: yellow
description: Defines the color to use on 'Changed' task status description: Defines the color to use on 'Changed' task status.
env: [{name: ANSIBLE_COLOR_CHANGED}] env: [{name: ANSIBLE_COLOR_CHANGED}]
ini: ini:
- {key: changed, section: colors} - {key: changed, section: colors}
COLOR_CONSOLE_PROMPT: COLOR_CONSOLE_PROMPT:
name: "Color for ansible-console's prompt task status" name: "Color for ansible-console's prompt task status"
default: white default: white
description: Defines the default color to use for ansible-console description: Defines the default color to use for ansible-console.
env: [{name: ANSIBLE_COLOR_CONSOLE_PROMPT}] env: [{name: ANSIBLE_COLOR_CONSOLE_PROMPT}]
ini: ini:
- {key: console_prompt, section: colors} - {key: console_prompt, section: colors}
@ -244,21 +244,21 @@ COLOR_CONSOLE_PROMPT:
COLOR_DEBUG: COLOR_DEBUG:
name: Color for debug statements name: Color for debug statements
default: dark gray default: dark gray
description: Defines the color to use when emitting debug messages description: Defines the color to use when emitting debug messages.
env: [{name: ANSIBLE_COLOR_DEBUG}] env: [{name: ANSIBLE_COLOR_DEBUG}]
ini: ini:
- {key: debug, section: colors} - {key: debug, section: colors}
COLOR_DEPRECATE: COLOR_DEPRECATE:
name: Color for deprecation messages name: Color for deprecation messages
default: purple default: purple
description: Defines the color to use when emitting deprecation messages description: Defines the color to use when emitting deprecation messages.
env: [{name: ANSIBLE_COLOR_DEPRECATE}] env: [{name: ANSIBLE_COLOR_DEPRECATE}]
ini: ini:
- {key: deprecate, section: colors} - {key: deprecate, section: colors}
COLOR_DIFF_ADD: COLOR_DIFF_ADD:
name: Color for diff added display name: Color for diff added display
default: green default: green
description: Defines the color to use when showing added lines in diffs description: Defines the color to use when showing added lines in diffs.
env: [{name: ANSIBLE_COLOR_DIFF_ADD}] env: [{name: ANSIBLE_COLOR_DIFF_ADD}]
ini: ini:
- {key: diff_add, section: colors} - {key: diff_add, section: colors}
@ -266,21 +266,21 @@ COLOR_DIFF_ADD:
COLOR_DIFF_LINES: COLOR_DIFF_LINES:
name: Color for diff lines display name: Color for diff lines display
default: cyan default: cyan
description: Defines the color to use when showing diffs description: Defines the color to use when showing diffs.
env: [{name: ANSIBLE_COLOR_DIFF_LINES}] env: [{name: ANSIBLE_COLOR_DIFF_LINES}]
ini: ini:
- {key: diff_lines, section: colors} - {key: diff_lines, section: colors}
COLOR_DIFF_REMOVE: COLOR_DIFF_REMOVE:
name: Color for diff removed display name: Color for diff removed display
default: red default: red
description: Defines the color to use when showing removed lines in diffs description: Defines the color to use when showing removed lines in diffs.
env: [{name: ANSIBLE_COLOR_DIFF_REMOVE}] env: [{name: ANSIBLE_COLOR_DIFF_REMOVE}]
ini: ini:
- {key: diff_remove, section: colors} - {key: diff_remove, section: colors}
COLOR_ERROR: COLOR_ERROR:
name: Color for error messages name: Color for error messages
default: red default: red
description: Defines the color to use when emitting error messages description: Defines the color to use when emitting error messages.
env: [{name: ANSIBLE_COLOR_ERROR}] env: [{name: ANSIBLE_COLOR_ERROR}]
ini: ini:
- {key: error, section: colors} - {key: error, section: colors}
@ -288,49 +288,49 @@ COLOR_ERROR:
COLOR_HIGHLIGHT: COLOR_HIGHLIGHT:
name: Color for highlighting name: Color for highlighting
default: white default: white
description: Defines the color to use for highlighting description: Defines the color to use for highlighting.
env: [{name: ANSIBLE_COLOR_HIGHLIGHT}] env: [{name: ANSIBLE_COLOR_HIGHLIGHT}]
ini: ini:
- {key: highlight, section: colors} - {key: highlight, section: colors}
COLOR_OK: COLOR_OK:
name: Color for 'ok' task status name: Color for 'ok' task status
default: green default: green
description: Defines the color to use when showing 'OK' task status description: Defines the color to use when showing 'OK' task status.
env: [{name: ANSIBLE_COLOR_OK}] env: [{name: ANSIBLE_COLOR_OK}]
ini: ini:
- {key: ok, section: colors} - {key: ok, section: colors}
COLOR_SKIP: COLOR_SKIP:
name: Color for 'skip' task status name: Color for 'skip' task status
default: cyan default: cyan
description: Defines the color to use when showing 'Skipped' task status description: Defines the color to use when showing 'Skipped' task status.
env: [{name: ANSIBLE_COLOR_SKIP}] env: [{name: ANSIBLE_COLOR_SKIP}]
ini: ini:
- {key: skip, section: colors} - {key: skip, section: colors}
COLOR_UNREACHABLE: COLOR_UNREACHABLE:
name: Color for 'unreachable' host state name: Color for 'unreachable' host state
default: bright red default: bright red
description: Defines the color to use on 'Unreachable' status description: Defines the color to use on 'Unreachable' status.
env: [{name: ANSIBLE_COLOR_UNREACHABLE}] env: [{name: ANSIBLE_COLOR_UNREACHABLE}]
ini: ini:
- {key: unreachable, section: colors} - {key: unreachable, section: colors}
COLOR_VERBOSE: COLOR_VERBOSE:
name: Color for verbose messages name: Color for verbose messages
default: blue default: blue
description: Defines the color to use when emitting verbose messages. i.e those that show with '-v's. description: Defines the color to use when emitting verbose messages. In other words, those that show with '-v's.
env: [{name: ANSIBLE_COLOR_VERBOSE}] env: [{name: ANSIBLE_COLOR_VERBOSE}]
ini: ini:
- {key: verbose, section: colors} - {key: verbose, section: colors}
COLOR_WARN: COLOR_WARN:
name: Color for warning messages name: Color for warning messages
default: bright purple default: bright purple
description: Defines the color to use when emitting warning messages description: Defines the color to use when emitting warning messages.
env: [{name: ANSIBLE_COLOR_WARN}] env: [{name: ANSIBLE_COLOR_WARN}]
ini: ini:
- {key: warn, section: colors} - {key: warn, section: colors}
CONNECTION_PASSWORD_FILE: CONNECTION_PASSWORD_FILE:
name: Connection password file name: Connection password file
default: ~ default: ~
description: 'The password file to use for the connection plugin. --connection-password-file.' description: 'The password file to use for the connection plugin. ``--connection-password-file``.'
env: [{name: ANSIBLE_CONNECTION_PASSWORD_FILE}] env: [{name: ANSIBLE_CONNECTION_PASSWORD_FILE}]
ini: ini:
- {key: connection_password_file, section: defaults} - {key: connection_password_file, section: defaults}
@ -339,7 +339,7 @@ CONNECTION_PASSWORD_FILE:
COVERAGE_REMOTE_OUTPUT: COVERAGE_REMOTE_OUTPUT:
name: Sets the output directory and filename prefix to generate coverage run info. name: Sets the output directory and filename prefix to generate coverage run info.
description: description:
- Sets the output directory on the remote host to generate coverage reports to. - Sets the output directory on the remote host to generate coverage reports into.
- Currently only used for remote coverage on PowerShell modules. - Currently only used for remote coverage on PowerShell modules.
- This is for internal use only. - This is for internal use only.
env: env:
@ -352,7 +352,7 @@ COVERAGE_REMOTE_PATHS:
name: Sets the list of paths to run coverage for. name: Sets the list of paths to run coverage for.
description: description:
- A list of paths for files on the Ansible controller to run coverage for when executing on the remote host. - A list of paths for files on the Ansible controller to run coverage for when executing on the remote host.
- Only files that match the path glob will have its coverage collected. - Only files that match the path glob will have their coverage collected.
- Multiple path globs can be specified and are separated by ``:``. - Multiple path globs can be specified and are separated by ``:``.
- Currently only used for remote coverage on PowerShell modules. - Currently only used for remote coverage on PowerShell modules.
- This is for internal use only. - This is for internal use only.
@ -365,7 +365,7 @@ ACTION_WARNINGS:
name: Toggle action warnings name: Toggle action warnings
default: True default: True
description: description:
- By default Ansible will issue a warning when received from a task action (module or action plugin) - By default, Ansible will issue a warning when received from a task action (module or action plugin).
- These warnings can be silenced by adjusting this setting to False. - These warnings can be silenced by adjusting this setting to False.
env: [{name: ANSIBLE_ACTION_WARNINGS}] env: [{name: ANSIBLE_ACTION_WARNINGS}]
ini: ini:
@ -376,7 +376,7 @@ LOCALHOST_WARNING:
name: Warning when using implicit inventory with only localhost name: Warning when using implicit inventory with only localhost
default: True default: True
description: description:
- By default Ansible will issue a warning when there are no hosts in the - By default, Ansible will issue a warning when there are no hosts in the
inventory. inventory.
- These warnings can be silenced by adjusting this setting to False. - These warnings can be silenced by adjusting this setting to False.
env: [{name: ANSIBLE_LOCALHOST_WARNING}] env: [{name: ANSIBLE_LOCALHOST_WARNING}]
@ -388,7 +388,7 @@ INVENTORY_UNPARSED_WARNING:
name: Warning when no inventory files can be parsed, resulting in an implicit inventory with only localhost name: Warning when no inventory files can be parsed, resulting in an implicit inventory with only localhost
default: True default: True
description: description:
- By default Ansible will issue a warning when no inventory was loaded and notes that - By default, Ansible will issue a warning when no inventory was loaded and notes that
it will use an implicit localhost-only inventory. it will use an implicit localhost-only inventory.
- These warnings can be silenced by adjusting this setting to False. - These warnings can be silenced by adjusting this setting to False.
env: [{name: ANSIBLE_INVENTORY_UNPARSED_WARNING}] env: [{name: ANSIBLE_INVENTORY_UNPARSED_WARNING}]
@ -399,7 +399,7 @@ INVENTORY_UNPARSED_WARNING:
DOC_FRAGMENT_PLUGIN_PATH: DOC_FRAGMENT_PLUGIN_PATH:
name: documentation fragment plugins path name: documentation fragment plugins path
default: '{{ ANSIBLE_HOME ~ "/plugins/doc_fragments:/usr/share/ansible/plugins/doc_fragments" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/doc_fragments:/usr/share/ansible/plugins/doc_fragments" }}'
description: Colon separated paths in which Ansible will search for Documentation Fragments Plugins. description: Colon-separated paths in which Ansible will search for Documentation Fragments Plugins.
env: [{name: ANSIBLE_DOC_FRAGMENT_PLUGINS}] env: [{name: ANSIBLE_DOC_FRAGMENT_PLUGINS}]
ini: ini:
- {key: doc_fragment_plugins, section: defaults} - {key: doc_fragment_plugins, section: defaults}
@ -407,7 +407,7 @@ DOC_FRAGMENT_PLUGIN_PATH:
DEFAULT_ACTION_PLUGIN_PATH: DEFAULT_ACTION_PLUGIN_PATH:
name: Action plugins path name: Action plugins path
default: '{{ ANSIBLE_HOME ~ "/plugins/action:/usr/share/ansible/plugins/action" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/action:/usr/share/ansible/plugins/action" }}'
description: Colon separated paths in which Ansible will search for Action Plugins. description: Colon-separated paths in which Ansible will search for Action Plugins.
env: [{name: ANSIBLE_ACTION_PLUGINS}] env: [{name: ANSIBLE_ACTION_PLUGINS}]
ini: ini:
- {key: action_plugins, section: defaults} - {key: action_plugins, section: defaults}
@ -421,8 +421,8 @@ DEFAULT_ALLOW_UNSAFE_LOOKUPS:
to return data that is not marked 'unsafe'." to return data that is not marked 'unsafe'."
- By default, such data is marked as unsafe to prevent the templating engine from evaluating any jinja2 templating language, - By default, such data is marked as unsafe to prevent the templating engine from evaluating any jinja2 templating language,
as this could represent a security risk. This option is provided to allow for backward compatibility, as this could represent a security risk. This option is provided to allow for backward compatibility,
however users should first consider adding allow_unsafe=True to any lookups which may be expected to contain data which may be run however, users should first consider adding allow_unsafe=True to any lookups that may be expected to contain data that may be run
through the templating engine late through the templating engine late.
env: [] env: []
ini: ini:
- {key: allow_unsafe_lookups, section: defaults} - {key: allow_unsafe_lookups, section: defaults}
@ -474,7 +474,7 @@ DEFAULT_BECOME_METHOD:
DEFAULT_BECOME_EXE: DEFAULT_BECOME_EXE:
name: Choose 'become' executable name: Choose 'become' executable
default: ~ default: ~
description: 'executable to use for privilege escalation, otherwise Ansible will depend on PATH' description: 'executable to use for privilege escalation, otherwise Ansible will depend on PATH.'
env: [{name: ANSIBLE_BECOME_EXE}] env: [{name: ANSIBLE_BECOME_EXE}]
ini: ini:
- {key: become_exe, section: privilege_escalation} - {key: become_exe, section: privilege_escalation}
@ -488,7 +488,7 @@ DEFAULT_BECOME_FLAGS:
BECOME_PLUGIN_PATH: BECOME_PLUGIN_PATH:
name: Become plugins path name: Become plugins path
default: '{{ ANSIBLE_HOME ~ "/plugins/become:/usr/share/ansible/plugins/become" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/become:/usr/share/ansible/plugins/become" }}'
description: Colon separated paths in which Ansible will search for Become Plugins. description: Colon-separated paths in which Ansible will search for Become Plugins.
env: [{name: ANSIBLE_BECOME_PLUGINS}] env: [{name: ANSIBLE_BECOME_PLUGINS}]
ini: ini:
- {key: become_plugins, section: defaults} - {key: become_plugins, section: defaults}
@ -506,7 +506,7 @@ DEFAULT_BECOME_USER:
DEFAULT_CACHE_PLUGIN_PATH: DEFAULT_CACHE_PLUGIN_PATH:
name: Cache Plugins Path name: Cache Plugins Path
default: '{{ ANSIBLE_HOME ~ "/plugins/cache:/usr/share/ansible/plugins/cache" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/cache:/usr/share/ansible/plugins/cache" }}'
description: Colon separated paths in which Ansible will search for Cache Plugins. description: Colon-separated paths in which Ansible will search for Cache Plugins.
env: [{name: ANSIBLE_CACHE_PLUGINS}] env: [{name: ANSIBLE_CACHE_PLUGINS}]
ini: ini:
- {key: cache_plugins, section: defaults} - {key: cache_plugins, section: defaults}
@ -514,7 +514,7 @@ DEFAULT_CACHE_PLUGIN_PATH:
DEFAULT_CALLBACK_PLUGIN_PATH: DEFAULT_CALLBACK_PLUGIN_PATH:
name: Callback Plugins Path name: Callback Plugins Path
default: '{{ ANSIBLE_HOME ~ "/plugins/callback:/usr/share/ansible/plugins/callback" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/callback:/usr/share/ansible/plugins/callback" }}'
description: Colon separated paths in which Ansible will search for Callback Plugins. description: Colon-separated paths in which Ansible will search for Callback Plugins.
env: [{name: ANSIBLE_CALLBACK_PLUGINS}] env: [{name: ANSIBLE_CALLBACK_PLUGINS}]
ini: ini:
- {key: callback_plugins, section: defaults} - {key: callback_plugins, section: defaults}
@ -537,7 +537,7 @@ CALLBACKS_ENABLED:
DEFAULT_CLICONF_PLUGIN_PATH: DEFAULT_CLICONF_PLUGIN_PATH:
name: Cliconf Plugins Path name: Cliconf Plugins Path
default: '{{ ANSIBLE_HOME ~ "/plugins/cliconf:/usr/share/ansible/plugins/cliconf" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/cliconf:/usr/share/ansible/plugins/cliconf" }}'
description: Colon separated paths in which Ansible will search for Cliconf Plugins. description: Colon-separated paths in which Ansible will search for Cliconf Plugins.
env: [{name: ANSIBLE_CLICONF_PLUGINS}] env: [{name: ANSIBLE_CLICONF_PLUGINS}]
ini: ini:
- {key: cliconf_plugins, section: defaults} - {key: cliconf_plugins, section: defaults}
@ -545,7 +545,7 @@ DEFAULT_CLICONF_PLUGIN_PATH:
DEFAULT_CONNECTION_PLUGIN_PATH: DEFAULT_CONNECTION_PLUGIN_PATH:
name: Connection Plugins Path name: Connection Plugins Path
default: '{{ ANSIBLE_HOME ~ "/plugins/connection:/usr/share/ansible/plugins/connection" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/connection:/usr/share/ansible/plugins/connection" }}'
description: Colon separated paths in which Ansible will search for Connection Plugins. description: Colon-separated paths in which Ansible will search for Connection Plugins.
env: [{name: ANSIBLE_CONNECTION_PLUGINS}] env: [{name: ANSIBLE_CONNECTION_PLUGINS}]
ini: ini:
- {key: connection_plugins, section: defaults} - {key: connection_plugins, section: defaults}
@ -567,8 +567,8 @@ DEFAULT_EXECUTABLE:
name: Target shell executable name: Target shell executable
default: /bin/sh default: /bin/sh
description: description:
- "This indicates the command to use to spawn a shell under for Ansible's execution needs on a target. - "This indicates the command to use to spawn a shell under, which is required for Ansible's execution needs on a target.
Users may need to change this in rare instances when shell usage is constrained, but in most cases it may be left as is." Users may need to change this in rare instances when shell usage is constrained, but in most cases, it may be left as is."
env: [{name: ANSIBLE_EXECUTABLE}] env: [{name: ANSIBLE_EXECUTABLE}]
ini: ini:
- {key: executable, section: defaults} - {key: executable, section: defaults}
@ -576,7 +576,7 @@ DEFAULT_FACT_PATH:
name: local fact path name: local fact path
description: description:
- "This option allows you to globally configure a custom path for 'local_facts' for the implied :ref:`ansible_collections.ansible.builtin.setup_module` task when using fact gathering." - "This option allows you to globally configure a custom path for 'local_facts' for the implied :ref:`ansible_collections.ansible.builtin.setup_module` task when using fact gathering."
- "If not set, it will fallback to the default from the ``ansible.builtin.setup`` module: ``/etc/ansible/facts.d``." - "If not set, it will fall back to the default from the ``ansible.builtin.setup`` module: ``/etc/ansible/facts.d``."
- "This does **not** affect user defined tasks that use the ``ansible.builtin.setup`` module." - "This does **not** affect user defined tasks that use the ``ansible.builtin.setup`` module."
- The real action being created by the implicit task is currently ``ansible.legacy.gather_facts`` module, which then calls the configured fact modules, - The real action being created by the implicit task is currently ``ansible.legacy.gather_facts`` module, which then calls the configured fact modules,
by default this will be ``ansible.builtin.setup`` for POSIX systems but other platforms might have different defaults. by default this will be ``ansible.builtin.setup`` for POSIX systems but other platforms might have different defaults.
@ -593,7 +593,7 @@ DEFAULT_FACT_PATH:
DEFAULT_FILTER_PLUGIN_PATH: DEFAULT_FILTER_PLUGIN_PATH:
name: Jinja2 Filter Plugins Path name: Jinja2 Filter Plugins Path
default: '{{ ANSIBLE_HOME ~ "/plugins/filter:/usr/share/ansible/plugins/filter" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/filter:/usr/share/ansible/plugins/filter" }}'
description: Colon separated paths in which Ansible will search for Jinja2 Filter Plugins. description: Colon-separated paths in which Ansible will search for Jinja2 Filter Plugins.
env: [{name: ANSIBLE_FILTER_PLUGINS}] env: [{name: ANSIBLE_FILTER_PLUGINS}]
ini: ini:
- {key: filter_plugins, section: defaults} - {key: filter_plugins, section: defaults}
@ -676,10 +676,10 @@ DEFAULT_HASH_BEHAVIOUR:
description: description:
- This setting controls how duplicate definitions of dictionary variables (aka hash, map, associative array) are handled in Ansible. - This setting controls how duplicate definitions of dictionary variables (aka hash, map, associative array) are handled in Ansible.
- This does not affect variables whose values are scalars (integers, strings) or arrays. - This does not affect variables whose values are scalars (integers, strings) or arrays.
- "**WARNING**, changing this setting is not recommended as this is fragile and makes your content (plays, roles, collections) non portable, - "**WARNING**, changing this setting is not recommended as this is fragile and makes your content (plays, roles, collections) nonportable,
leading to continual confusion and misuse. Don't change this setting unless you think you have an absolute need for it." leading to continual confusion and misuse. Don't change this setting unless you think you have an absolute need for it."
- We recommend avoiding reusing variable names and relying on the ``combine`` filter and ``vars`` and ``varnames`` lookups - We recommend avoiding reusing variable names and relying on the ``combine`` filter and ``vars`` and ``varnames`` lookups
to create merged versions of the individual variables. In our experience this is rarely really needed and a sign that too much to create merged versions of the individual variables. In our experience, this is rarely needed and is a sign that too much
complexity has been introduced into the data structures and plays. complexity has been introduced into the data structures and plays.
- For some uses you can also look into custom vars_plugins to merge on input, even substituting the default ``host_group_vars`` - For some uses you can also look into custom vars_plugins to merge on input, even substituting the default ``host_group_vars``
that is in charge of parsing the ``host_vars/`` and ``group_vars/`` directories. Most users of this setting are only interested in inventory scope, that is in charge of parsing the ``host_vars/`` and ``group_vars/`` directories. Most users of this setting are only interested in inventory scope,
@ -696,7 +696,7 @@ DEFAULT_HASH_BEHAVIOUR:
DEFAULT_HOST_LIST: DEFAULT_HOST_LIST:
name: Inventory Source name: Inventory Source
default: /etc/ansible/hosts default: /etc/ansible/hosts
description: Comma separated list of Ansible inventory sources description: Comma-separated list of Ansible inventory sources
env: env:
- name: ANSIBLE_INVENTORY - name: ANSIBLE_INVENTORY
expand_relative_paths: True expand_relative_paths: True
@ -708,7 +708,7 @@ DEFAULT_HOST_LIST:
DEFAULT_HTTPAPI_PLUGIN_PATH: DEFAULT_HTTPAPI_PLUGIN_PATH:
name: HttpApi Plugins Path name: HttpApi Plugins Path
default: '{{ ANSIBLE_HOME ~ "/plugins/httpapi:/usr/share/ansible/plugins/httpapi" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/httpapi:/usr/share/ansible/plugins/httpapi" }}'
description: Colon separated paths in which Ansible will search for HttpApi Plugins. description: Colon-separated paths in which Ansible will search for HttpApi Plugins.
env: [{name: ANSIBLE_HTTPAPI_PLUGINS}] env: [{name: ANSIBLE_HTTPAPI_PLUGINS}]
ini: ini:
- {key: httpapi_plugins, section: defaults} - {key: httpapi_plugins, section: defaults}
@ -724,13 +724,13 @@ DEFAULT_INTERNAL_POLL_INTERVAL:
description: description:
- This sets the interval (in seconds) of Ansible internal processes polling each other. - This sets the interval (in seconds) of Ansible internal processes polling each other.
Lower values improve performance with large playbooks at the expense of extra CPU load. Lower values improve performance with large playbooks at the expense of extra CPU load.
Higher values are more suitable for Ansible usage in automation scenarios, Higher values are more suitable for Ansible usage in automation scenarios
when UI responsiveness is not required but CPU usage might be a concern. when UI responsiveness is not required but CPU usage might be a concern.
- "The default corresponds to the value hardcoded in Ansible <= 2.1" - "The default corresponds to the value hardcoded in Ansible <= 2.1"
DEFAULT_INVENTORY_PLUGIN_PATH: DEFAULT_INVENTORY_PLUGIN_PATH:
name: Inventory Plugins Path name: Inventory Plugins Path
default: '{{ ANSIBLE_HOME ~ "/plugins/inventory:/usr/share/ansible/plugins/inventory" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/inventory:/usr/share/ansible/plugins/inventory" }}'
description: Colon separated paths in which Ansible will search for Inventory Plugins. description: Colon-separated paths in which Ansible will search for Inventory Plugins.
env: [{name: ANSIBLE_INVENTORY_PLUGINS}] env: [{name: ANSIBLE_INVENTORY_PLUGINS}]
ini: ini:
- {key: inventory_plugins, section: defaults} - {key: inventory_plugins, section: defaults}
@ -769,7 +769,7 @@ DEFAULT_LIBVIRT_LXC_NOSECLABEL:
name: No security label on Lxc name: No security label on Lxc
default: False default: False
description: description:
- "This setting causes libvirt to connect to lxc containers by passing --noseclabel to virsh. - "This setting causes libvirt to connect to LXC containers by passing ``--noseclabel`` parameter to ``virsh`` command.
This is necessary when running on systems which do not have SELinux." This is necessary when running on systems which do not have SELinux."
env: env:
- name: ANSIBLE_LIBVIRT_LXC_NOSECLABEL - name: ANSIBLE_LIBVIRT_LXC_NOSECLABEL
@ -808,14 +808,14 @@ DEFAULT_LOG_PATH:
DEFAULT_LOG_FILTER: DEFAULT_LOG_FILTER:
name: Name filters for python logger name: Name filters for python logger
default: [] default: []
description: List of logger names to filter out of the log file description: List of logger names to filter out of the log file.
env: [{name: ANSIBLE_LOG_FILTER}] env: [{name: ANSIBLE_LOG_FILTER}]
ini: ini:
- {key: log_filter, section: defaults} - {key: log_filter, section: defaults}
type: list type: list
DEFAULT_LOOKUP_PLUGIN_PATH: DEFAULT_LOOKUP_PLUGIN_PATH:
name: Lookup Plugins Path name: Lookup Plugins Path
description: Colon separated paths in which Ansible will search for Lookup Plugins. description: Colon-separated paths in which Ansible will search for Lookup Plugins.
default: '{{ ANSIBLE_HOME ~ "/plugins/lookup:/usr/share/ansible/plugins/lookup" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/lookup:/usr/share/ansible/plugins/lookup" }}'
env: [{name: ANSIBLE_LOOKUP_PLUGINS}] env: [{name: ANSIBLE_LOOKUP_PLUGINS}]
ini: ini:
@ -825,7 +825,7 @@ DEFAULT_LOOKUP_PLUGIN_PATH:
DEFAULT_MANAGED_STR: DEFAULT_MANAGED_STR:
name: Ansible managed name: Ansible managed
default: 'Ansible managed' default: 'Ansible managed'
description: Sets the macro for the 'ansible_managed' variable available for :ref:`ansible_collections.ansible.builtin.template_module` and :ref:`ansible_collections.ansible.windows.win_template_module`. This is only relevant for those two modules. description: Sets the macro for the 'ansible_managed' variable available for :ref:`ansible_collections.ansible.builtin.template_module` and :ref:`ansible_collections.ansible.windows.win_template_module`. This is only relevant to those two modules.
env: [] env: []
ini: ini:
- {key: ansible_managed, section: defaults} - {key: ansible_managed, section: defaults}
@ -856,7 +856,7 @@ DEFAULT_MODULE_NAME:
- {key: module_name, section: defaults} - {key: module_name, section: defaults}
DEFAULT_MODULE_PATH: DEFAULT_MODULE_PATH:
name: Modules Path name: Modules Path
description: Colon separated paths in which Ansible will search for Modules. description: Colon-separated paths in which Ansible will search for Modules.
default: '{{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }}'
env: [{name: ANSIBLE_LIBRARY}] env: [{name: ANSIBLE_LIBRARY}]
ini: ini:
@ -864,7 +864,7 @@ DEFAULT_MODULE_PATH:
type: pathspec type: pathspec
DEFAULT_MODULE_UTILS_PATH: DEFAULT_MODULE_UTILS_PATH:
name: Module Utils Path name: Module Utils Path
description: Colon separated paths in which Ansible will search for Module utils files, which are shared by modules. description: Colon-separated paths in which Ansible will search for Module utils files, which are shared by modules.
default: '{{ ANSIBLE_HOME ~ "/plugins/module_utils:/usr/share/ansible/plugins/module_utils" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/module_utils:/usr/share/ansible/plugins/module_utils" }}'
env: [{name: ANSIBLE_MODULE_UTILS}] env: [{name: ANSIBLE_MODULE_UTILS}]
ini: ini:
@ -873,7 +873,7 @@ DEFAULT_MODULE_UTILS_PATH:
DEFAULT_NETCONF_PLUGIN_PATH: DEFAULT_NETCONF_PLUGIN_PATH:
name: Netconf Plugins Path name: Netconf Plugins Path
default: '{{ ANSIBLE_HOME ~ "/plugins/netconf:/usr/share/ansible/plugins/netconf" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/netconf:/usr/share/ansible/plugins/netconf" }}'
description: Colon separated paths in which Ansible will search for Netconf Plugins. description: Colon-separated paths in which Ansible will search for Netconf Plugins.
env: [{name: ANSIBLE_NETCONF_PLUGINS}] env: [{name: ANSIBLE_NETCONF_PLUGINS}]
ini: ini:
- {key: netconf_plugins, section: defaults} - {key: netconf_plugins, section: defaults}
@ -890,7 +890,7 @@ DEFAULT_NO_TARGET_SYSLOG:
name: No syslog on target name: No syslog on target
default: False default: False
description: description:
- Toggle Ansible logging to syslog on the target when it executes tasks. On Windows hosts this will disable a newer - Toggle Ansible logging to syslog on the target when it executes tasks. On Windows hosts, this will disable a newer
style PowerShell modules from writing to the event log. style PowerShell modules from writing to the event log.
env: [{name: ANSIBLE_NO_TARGET_SYSLOG}] env: [{name: ANSIBLE_NO_TARGET_SYSLOG}]
ini: ini:
@ -925,7 +925,7 @@ DEFAULT_PRIVATE_KEY_FILE:
default: ~ default: ~
description: description:
- Option for connections using a certificate or key file to authenticate, rather than an agent or passwords, - Option for connections using a certificate or key file to authenticate, rather than an agent or passwords,
you can set the default value here to avoid re-specifying --private-key with every invocation. you can set the default value here to avoid re-specifying ``--private-key`` with every invocation.
env: [{name: ANSIBLE_PRIVATE_KEY_FILE}] env: [{name: ANSIBLE_PRIVATE_KEY_FILE}]
ini: ini:
- {key: private_key_file, section: defaults} - {key: private_key_file, section: defaults}
@ -962,7 +962,7 @@ DEFAULT_REMOTE_USER:
DEFAULT_ROLES_PATH: DEFAULT_ROLES_PATH:
name: Roles path name: Roles path
default: '{{ ANSIBLE_HOME ~ "/roles:/usr/share/ansible/roles:/etc/ansible/roles" }}' default: '{{ ANSIBLE_HOME ~ "/roles:/usr/share/ansible/roles:/etc/ansible/roles" }}'
description: Colon separated paths in which Ansible will search for Roles. description: Colon-separated paths in which Ansible will search for Roles.
env: [{name: ANSIBLE_ROLES_PATH}] env: [{name: ANSIBLE_ROLES_PATH}]
expand_relative_paths: True expand_relative_paths: True
ini: ini:
@ -974,7 +974,7 @@ DEFAULT_SELINUX_SPECIAL_FS:
default: fuse, nfs, vboxsf, ramfs, 9p, vfat default: fuse, nfs, vboxsf, ramfs, 9p, vfat
description: description:
- "Some filesystems do not support safe operations and/or return inconsistent errors, - "Some filesystems do not support safe operations and/or return inconsistent errors,
this setting makes Ansible 'tolerate' those in the list w/o causing fatal errors." this setting makes Ansible 'tolerate' those in the list without causing fatal errors."
- Data corruption may occur and writes are not always verified when a filesystem is in the list. - Data corruption may occur and writes are not always verified when a filesystem is in the list.
env: env:
- name: ANSIBLE_SELINUX_SPECIAL_FS - name: ANSIBLE_SELINUX_SPECIAL_FS
@ -993,10 +993,10 @@ DEFAULT_STDOUT_CALLBACK:
ini: ini:
- {key: stdout_callback, section: defaults} - {key: stdout_callback, section: defaults}
EDITOR: EDITOR:
name: editor application touse name: editor application to use
default: vi default: vi
descrioption: descrioption:
- for the cases in which Ansible needs to return a file within an editor, this chooses the application to use - for the cases in which Ansible needs to return a file within an editor, this chooses the application to use.
ini: ini:
- section: defaults - section: defaults
key: editor key: editor
@ -1023,7 +1023,7 @@ TASK_DEBUGGER_IGNORE_ERRORS:
description: description:
- This option defines whether the task debugger will be invoked on a failed task when ignore_errors=True - This option defines whether the task debugger will be invoked on a failed task when ignore_errors=True
is specified. is specified.
- True specifies that the debugger will honor ignore_errors, False will not honor ignore_errors. - True specifies that the debugger will honor ignore_errors, and False will not honor ignore_errors.
type: boolean type: boolean
env: [{name: ANSIBLE_TASK_DEBUGGER_IGNORE_ERRORS}] env: [{name: ANSIBLE_TASK_DEBUGGER_IGNORE_ERRORS}]
ini: ini:
@ -1039,7 +1039,7 @@ DEFAULT_STRATEGY:
version_added: "2.3" version_added: "2.3"
DEFAULT_STRATEGY_PLUGIN_PATH: DEFAULT_STRATEGY_PLUGIN_PATH:
name: Strategy Plugins Path name: Strategy Plugins Path
description: Colon separated paths in which Ansible will search for Strategy Plugins. description: Colon-separated paths in which Ansible will search for Strategy Plugins.
default: '{{ ANSIBLE_HOME ~ "/plugins/strategy:/usr/share/ansible/plugins/strategy" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/strategy:/usr/share/ansible/plugins/strategy" }}'
env: [{name: ANSIBLE_STRATEGY_PLUGINS}] env: [{name: ANSIBLE_STRATEGY_PLUGINS}]
ini: ini:
@ -1056,21 +1056,21 @@ DEFAULT_SU:
DEFAULT_SYSLOG_FACILITY: DEFAULT_SYSLOG_FACILITY:
name: syslog facility name: syslog facility
default: LOG_USER default: LOG_USER
description: Syslog facility to use when Ansible logs to the remote target description: Syslog facility to use when Ansible logs to the remote target.
env: [{name: ANSIBLE_SYSLOG_FACILITY}] env: [{name: ANSIBLE_SYSLOG_FACILITY}]
ini: ini:
- {key: syslog_facility, section: defaults} - {key: syslog_facility, section: defaults}
DEFAULT_TERMINAL_PLUGIN_PATH: DEFAULT_TERMINAL_PLUGIN_PATH:
name: Terminal Plugins Path name: Terminal Plugins Path
default: '{{ ANSIBLE_HOME ~ "/plugins/terminal:/usr/share/ansible/plugins/terminal" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/terminal:/usr/share/ansible/plugins/terminal" }}'
description: Colon separated paths in which Ansible will search for Terminal Plugins. description: Colon-separated paths in which Ansible will search for Terminal Plugins.
env: [{name: ANSIBLE_TERMINAL_PLUGINS}] env: [{name: ANSIBLE_TERMINAL_PLUGINS}]
ini: ini:
- {key: terminal_plugins, section: defaults} - {key: terminal_plugins, section: defaults}
type: pathspec type: pathspec
DEFAULT_TEST_PLUGIN_PATH: DEFAULT_TEST_PLUGIN_PATH:
name: Jinja2 Test Plugins Path name: Jinja2 Test Plugins Path
description: Colon separated paths in which Ansible will search for Jinja2 Test Plugins. description: Colon-separated paths in which Ansible will search for Jinja2 Test Plugins.
default: '{{ ANSIBLE_HOME ~ "/plugins/test:/usr/share/ansible/plugins/test" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/test:/usr/share/ansible/plugins/test" }}'
env: [{name: ANSIBLE_TEST_PLUGINS}] env: [{name: ANSIBLE_TEST_PLUGINS}]
ini: ini:
@ -1107,7 +1107,7 @@ DEFAULT_UNDEFINED_VAR_BEHAVIOR:
DEFAULT_VARS_PLUGIN_PATH: DEFAULT_VARS_PLUGIN_PATH:
name: Vars Plugins Path name: Vars Plugins Path
default: '{{ ANSIBLE_HOME ~ "/plugins/vars:/usr/share/ansible/plugins/vars" }}' default: '{{ ANSIBLE_HOME ~ "/plugins/vars:/usr/share/ansible/plugins/vars" }}'
description: Colon separated paths in which Ansible will search for Vars Plugins. description: Colon-separated paths in which Ansible will search for Vars Plugins.
env: [{name: ANSIBLE_VARS_PLUGINS}] env: [{name: ANSIBLE_VARS_PLUGINS}]
ini: ini:
- {key: vars_plugins, section: defaults} - {key: vars_plugins, section: defaults}
@ -1124,7 +1124,7 @@ DEFAULT_VARS_PLUGIN_PATH:
DEFAULT_VAULT_ID_MATCH: DEFAULT_VAULT_ID_MATCH:
name: Force vault id match name: Force vault id match
default: False default: False
description: 'If true, decrypting vaults with a vault id will only try the password from the matching vault-id' description: 'If true, decrypting vaults with a vault id will only try the password from the matching vault-id.'
env: [{name: ANSIBLE_VAULT_ID_MATCH}] env: [{name: ANSIBLE_VAULT_ID_MATCH}]
ini: ini:
- {key: vault_id_match, section: defaults} - {key: vault_id_match, section: defaults}
@ -1132,7 +1132,7 @@ DEFAULT_VAULT_ID_MATCH:
DEFAULT_VAULT_IDENTITY: DEFAULT_VAULT_IDENTITY:
name: Vault id label name: Vault id label
default: default default: default
description: 'The label to use for the default vault id label in cases where a vault id label is not provided' description: 'The label to use for the default vault id label in cases where a vault id label is not provided.'
env: [{name: ANSIBLE_VAULT_IDENTITY}] env: [{name: ANSIBLE_VAULT_IDENTITY}]
ini: ini:
- {key: vault_identity, section: defaults} - {key: vault_identity, section: defaults}
@ -1147,7 +1147,7 @@ VAULT_ENCRYPT_SALT:
version_added: '2.15' version_added: '2.15'
DEFAULT_VAULT_ENCRYPT_IDENTITY: DEFAULT_VAULT_ENCRYPT_IDENTITY:
name: Vault id to use for encryption name: Vault id to use for encryption
description: 'The vault_id to use for encrypting by default. If multiple vault_ids are provided, this specifies which to use for encryption. The --encrypt-vault-id cli option overrides the configured value.' description: 'The vault_id to use for encrypting by default. If multiple vault_ids are provided, this specifies which to use for encryption. The ``--encrypt-vault-id`` CLI option overrides the configured value.'
env: [{name: ANSIBLE_VAULT_ENCRYPT_IDENTITY}] env: [{name: ANSIBLE_VAULT_ENCRYPT_IDENTITY}]
ini: ini:
- {key: vault_encrypt_identity, section: defaults} - {key: vault_encrypt_identity, section: defaults}
@ -1155,7 +1155,7 @@ DEFAULT_VAULT_ENCRYPT_IDENTITY:
DEFAULT_VAULT_IDENTITY_LIST: DEFAULT_VAULT_IDENTITY_LIST:
name: Default vault ids name: Default vault ids
default: [] default: []
description: 'A list of vault-ids to use by default. Equivalent to multiple --vault-id args. Vault-ids are tried in order.' description: 'A list of vault-ids to use by default. Equivalent to multiple ``--vault-id`` args. Vault-ids are tried in order.'
env: [{name: ANSIBLE_VAULT_IDENTITY_LIST}] env: [{name: ANSIBLE_VAULT_IDENTITY_LIST}]
ini: ini:
- {key: vault_identity_list, section: defaults} - {key: vault_identity_list, section: defaults}
@ -1165,7 +1165,7 @@ DEFAULT_VAULT_PASSWORD_FILE:
name: Vault password file name: Vault password file
default: ~ default: ~
description: description:
- 'The vault password file to use. Equivalent to --vault-password-file or --vault-id' - 'The vault password file to use. Equivalent to ``--vault-password-file`` or ``--vault-id``.'
- If executable, it will be run and the resulting stdout will be used as the password. - If executable, it will be run and the resulting stdout will be used as the password.
env: [{name: ANSIBLE_VAULT_PASSWORD_FILE}] env: [{name: ANSIBLE_VAULT_PASSWORD_FILE}]
ini: ini:
@ -1191,7 +1191,7 @@ DEPRECATION_WARNINGS:
DEVEL_WARNING: DEVEL_WARNING:
name: Running devel warning name: Running devel warning
default: True default: True
description: Toggle to control showing warnings related to running devel description: Toggle to control showing warnings related to running devel.
env: [{name: ANSIBLE_DEVEL_WARNING}] env: [{name: ANSIBLE_DEVEL_WARNING}]
ini: ini:
- {key: devel_warning, section: defaults} - {key: devel_warning, section: defaults}
@ -1207,7 +1207,7 @@ DIFF_ALWAYS:
DIFF_CONTEXT: DIFF_CONTEXT:
name: Difference context name: Difference context
default: 3 default: 3
description: How many lines of context to show when displaying the differences between files. description: Number of lines of context to show when displaying the differences between files.
env: [{name: ANSIBLE_DIFF_CONTEXT}] env: [{name: ANSIBLE_DIFF_CONTEXT}]
ini: ini:
- {key: context, section: diff} - {key: context, section: diff}
@ -1225,8 +1225,8 @@ DISPLAY_ARGS_TO_STDOUT:
you do not want those to be printed." you do not want those to be printed."
- "If you set this to True you should be sure that you have secured your environment's stdout - "If you set this to True you should be sure that you have secured your environment's stdout
(no one can shoulder surf your screen and you aren't saving stdout to an insecure file) or (no one can shoulder surf your screen and you aren't saving stdout to an insecure file) or
made sure that all of your playbooks explicitly added the ``no_log: True`` parameter to tasks which have sensitive values made sure that all of your playbooks explicitly added the ``no_log: True`` parameter to tasks that have sensitive values
See How do I keep secret data in my playbook? for more information." :ref:`keep_secret_data` for more information."
env: [{name: ANSIBLE_DISPLAY_ARGS_TO_STDOUT}] env: [{name: ANSIBLE_DISPLAY_ARGS_TO_STDOUT}]
ini: ini:
- {key: display_args_to_stdout, section: defaults} - {key: display_args_to_stdout, section: defaults}
@ -1235,7 +1235,7 @@ DISPLAY_ARGS_TO_STDOUT:
DISPLAY_SKIPPED_HOSTS: DISPLAY_SKIPPED_HOSTS:
name: Show skipped results name: Show skipped results
default: True default: True
description: "Toggle to control displaying skipped task/host entries in a task in the default callback" description: "Toggle to control displaying skipped task/host entries in a task in the default callback."
env: env:
- name: ANSIBLE_DISPLAY_SKIPPED_HOSTS - name: ANSIBLE_DISPLAY_SKIPPED_HOSTS
ini: ini:
@ -1245,7 +1245,7 @@ DOCSITE_ROOT_URL:
name: Root docsite URL name: Root docsite URL
default: https://docs.ansible.com/ansible-core/ default: https://docs.ansible.com/ansible-core/
description: Root docsite URL used to generate docs URLs in warning/error text; description: Root docsite URL used to generate docs URLs in warning/error text;
must be an absolute URL with valid scheme and trailing slash. must be an absolute URL with a valid scheme and trailing slash.
ini: ini:
- {key: docsite_root_url, section: defaults} - {key: docsite_root_url, section: defaults}
version_added: "2.8" version_added: "2.8"
@ -1253,7 +1253,7 @@ DUPLICATE_YAML_DICT_KEY:
name: Controls ansible behaviour when finding duplicate keys in YAML. name: Controls ansible behaviour when finding duplicate keys in YAML.
default: warn default: warn
description: description:
- By default Ansible will issue a warning when a duplicate dict key is encountered in YAML. - By default, Ansible will issue a warning when a duplicate dict key is encountered in YAML.
- These warnings can be silenced by adjusting this setting to False. - These warnings can be silenced by adjusting this setting to False.
env: [{name: ANSIBLE_DUPLICATE_YAML_DICT_KEY}] env: [{name: ANSIBLE_DUPLICATE_YAML_DICT_KEY}]
ini: ini:
@ -1345,7 +1345,7 @@ GALAXY_ROLE_SKELETON:
GALAXY_ROLE_SKELETON_IGNORE: GALAXY_ROLE_SKELETON_IGNORE:
name: Galaxy role skeleton ignore name: Galaxy role skeleton ignore
default: ["^.git$", "^.*/.git_keep$"] default: ["^.git$", "^.*/.git_keep$"]
description: patterns of files to ignore inside a Galaxy role or collection skeleton directory description: patterns of files to ignore inside a Galaxy role or collection skeleton directory.
env: [{name: ANSIBLE_GALAXY_ROLE_SKELETON_IGNORE}] env: [{name: ANSIBLE_GALAXY_ROLE_SKELETON_IGNORE}]
ini: ini:
- {key: role_skeleton_ignore, section: galaxy} - {key: role_skeleton_ignore, section: galaxy}
@ -1360,14 +1360,14 @@ GALAXY_COLLECTION_SKELETON:
GALAXY_COLLECTION_SKELETON_IGNORE: GALAXY_COLLECTION_SKELETON_IGNORE:
name: Galaxy collection skeleton ignore name: Galaxy collection skeleton ignore
default: ["^.git$", "^.*/.git_keep$"] default: ["^.git$", "^.*/.git_keep$"]
description: patterns of files to ignore inside a Galaxy collection skeleton directory description: patterns of files to ignore inside a Galaxy collection skeleton directory.
env: [{name: ANSIBLE_GALAXY_COLLECTION_SKELETON_IGNORE}] env: [{name: ANSIBLE_GALAXY_COLLECTION_SKELETON_IGNORE}]
ini: ini:
- {key: collection_skeleton_ignore, section: galaxy} - {key: collection_skeleton_ignore, section: galaxy}
type: list type: list
GALAXY_COLLECTIONS_PATH_WARNING: GALAXY_COLLECTIONS_PATH_WARNING:
name: "ansible-galaxy collection install colections path warnings" name: "ansible-galaxy collection install collections path warnings"
description: "whether ``ansible-galaxy collection install`` should warn about ``--collections-path`` missing from configured :ref:`collections_paths`" description: "whether ``ansible-galaxy collection install`` should warn about ``--collections-path`` missing from configured :ref:`collections_paths`."
default: true default: true
type: bool type: bool
env: [{name: ANSIBLE_GALAXY_COLLECTIONS_PATH_WARNING}] env: [{name: ANSIBLE_GALAXY_COLLECTIONS_PATH_WARNING}]
@ -1395,7 +1395,7 @@ GALAXY_SERVER_LIST:
- A list of Galaxy servers to use when installing a collection. - A list of Galaxy servers to use when installing a collection.
- The value corresponds to the config ini header ``[galaxy_server.{{item}}]`` which defines the server details. - The value corresponds to the config ini header ``[galaxy_server.{{item}}]`` which defines the server details.
- 'See :ref:`galaxy_server_config` for more details on how to define a Galaxy server.' - 'See :ref:`galaxy_server_config` for more details on how to define a Galaxy server.'
- The order of servers in this list is used to as the order in which a collection is resolved. - The order of servers in this list is used as the order in which a collection is resolved.
- Setting this config option will ignore the :ref:`galaxy_server` config option. - Setting this config option will ignore the :ref:`galaxy_server` config option.
env: [{name: ANSIBLE_GALAXY_SERVER_LIST}] env: [{name: ANSIBLE_GALAXY_SERVER_LIST}]
ini: ini:
@ -1510,7 +1510,7 @@ HOST_KEY_CHECKING:
HOST_PATTERN_MISMATCH: HOST_PATTERN_MISMATCH:
name: Control host pattern mismatch behaviour name: Control host pattern mismatch behaviour
default: 'warning' default: 'warning'
description: This setting changes the behaviour of mismatched host patterns, it allows you to force a fatal error, a warning or just ignore it description: This setting changes the behaviour of mismatched host patterns, it allows you to force a fatal error, a warning or just ignore it.
env: [{name: ANSIBLE_HOST_PATTERN_MISMATCH}] env: [{name: ANSIBLE_HOST_PATTERN_MISMATCH}]
ini: ini:
- {key: host_pattern_mismatch, section: inventory} - {key: host_pattern_mismatch, section: inventory}
@ -1533,7 +1533,7 @@ INTERPRETER_PYTHON:
falling back to a fixed ordered list of well-known Python interpreter locations if a platform-specific default is not falling back to a fixed ordered list of well-known Python interpreter locations if a platform-specific default is not
available. The fallback behavior will issue a warning that the interpreter should be set explicitly (since interpreters available. The fallback behavior will issue a warning that the interpreter should be set explicitly (since interpreters
installed later may change which one is used). This warning behavior can be disabled by setting ``auto_silent`` or installed later may change which one is used). This warning behavior can be disabled by setting ``auto_silent`` or
``auto_legacy_silent``. The value of ``auto_legacy`` provides all the same behavior, but for backwards-compatibility ``auto_legacy_silent``. The value of ``auto_legacy`` provides all the same behavior, but for backward-compatibility
with older Ansible releases that always defaulted to ``/usr/bin/python``, will use that interpreter if present. with older Ansible releases that always defaulted to ``/usr/bin/python``, will use that interpreter if present.
_INTERPRETER_PYTHON_DISTRO_MAP: _INTERPRETER_PYTHON_DISTRO_MAP:
name: Mapping of known included platform pythons for various Linux distros name: Mapping of known included platform pythons for various Linux distros
@ -1590,7 +1590,7 @@ TRANSFORM_INVALID_GROUP_CHARS:
INVALID_TASK_ATTRIBUTE_FAILED: INVALID_TASK_ATTRIBUTE_FAILED:
name: Controls whether invalid attributes for a task result in errors instead of warnings name: Controls whether invalid attributes for a task result in errors instead of warnings
default: True default: True
description: If 'false', invalid attributes for a task will result in warnings instead of errors description: If 'false', invalid attributes for a task will result in warnings instead of errors.
type: boolean type: boolean
env: env:
- name: ANSIBLE_INVALID_TASK_ATTRIBUTE_FAILED - name: ANSIBLE_INVALID_TASK_ATTRIBUTE_FAILED
@ -1683,7 +1683,7 @@ INVENTORY_EXPORT:
INVENTORY_IGNORE_EXTS: INVENTORY_IGNORE_EXTS:
name: Inventory ignore extensions name: Inventory ignore extensions
default: "{{(REJECT_EXTS + ('.orig', '.ini', '.cfg', '.retry'))}}" default: "{{(REJECT_EXTS + ('.orig', '.ini', '.cfg', '.retry'))}}"
description: List of extensions to ignore when using a directory as an inventory source description: List of extensions to ignore when using a directory as an inventory source.
env: [{name: ANSIBLE_INVENTORY_IGNORE}] env: [{name: ANSIBLE_INVENTORY_IGNORE}]
ini: ini:
- {key: inventory_ignore_extensions, section: defaults} - {key: inventory_ignore_extensions, section: defaults}
@ -1692,7 +1692,7 @@ INVENTORY_IGNORE_EXTS:
INVENTORY_IGNORE_PATTERNS: INVENTORY_IGNORE_PATTERNS:
name: Inventory ignore patterns name: Inventory ignore patterns
default: [] default: []
description: List of patterns to ignore when using a directory as an inventory source description: List of patterns to ignore when using a directory as an inventory source.
env: [{name: ANSIBLE_INVENTORY_IGNORE_REGEX}] env: [{name: ANSIBLE_INVENTORY_IGNORE_REGEX}]
ini: ini:
- {key: inventory_ignore_patterns, section: defaults} - {key: inventory_ignore_patterns, section: defaults}
@ -1703,7 +1703,7 @@ INVENTORY_UNPARSED_IS_FAILED:
default: False default: False
description: > description: >
If 'true' it is a fatal error if every single potential inventory If 'true' it is a fatal error if every single potential inventory
source fails to parse, otherwise this situation will only attract a source fails to parse, otherwise, this situation will only attract a
warning. warning.
env: [{name: ANSIBLE_INVENTORY_UNPARSED_FAILED}] env: [{name: ANSIBLE_INVENTORY_UNPARSED_FAILED}]
ini: ini:
@ -1713,7 +1713,7 @@ JINJA2_NATIVE_WARNING:
name: Running older than required Jinja version for jinja2_native warning name: Running older than required Jinja version for jinja2_native warning
default: True default: True
description: Toggle to control showing warnings related to running a Jinja version description: Toggle to control showing warnings related to running a Jinja version
older than required for jinja2_native older than required for jinja2_native.
env: env:
- name: ANSIBLE_JINJA2_NATIVE_WARNING - name: ANSIBLE_JINJA2_NATIVE_WARNING
deprecated: deprecated:
@ -1725,7 +1725,7 @@ JINJA2_NATIVE_WARNING:
MAX_FILE_SIZE_FOR_DIFF: MAX_FILE_SIZE_FOR_DIFF:
name: Diff maximum file size name: Diff maximum file size
default: 104448 default: 104448
description: Maximum size of files to be considered for diff display description: Maximum size of files to be considered for diff display.
env: [{name: ANSIBLE_MAX_DIFF_SIZE}] env: [{name: ANSIBLE_MAX_DIFF_SIZE}]
ini: ini:
- {key: max_diff_size, section: defaults} - {key: max_diff_size, section: defaults}
@ -1754,8 +1754,8 @@ MODULE_IGNORE_EXTS:
name: Module ignore extensions name: Module ignore extensions
default: "{{(REJECT_EXTS + ('.yaml', '.yml', '.ini'))}}" default: "{{(REJECT_EXTS + ('.yaml', '.yml', '.ini'))}}"
description: description:
- List of extensions to ignore when looking for modules to load - List of extensions to ignore when looking for modules to load.
- This is for rejecting script and binary module fallback extensions - This is for rejecting script and binary module fallback extensions.
env: [{name: ANSIBLE_MODULE_IGNORE_EXTS}] env: [{name: ANSIBLE_MODULE_IGNORE_EXTS}]
ini: ini:
- {key: module_ignore_exts, section: defaults} - {key: module_ignore_exts, section: defaults}
@ -1763,16 +1763,16 @@ MODULE_IGNORE_EXTS:
MODULE_STRICT_UTF8_RESPONSE: MODULE_STRICT_UTF8_RESPONSE:
name: Module strict UTF-8 response name: Module strict UTF-8 response
description: description:
- Enables whether module responses are evaluated for containing non UTF-8 data - Enables whether module responses are evaluated for containing non-UTF-8 data.
- Disabling this may result in unexpected behavior - Disabling this may result in unexpected behavior.
- Only ansible-core should evaluate this configuration - Only ansible-core should evaluate this configuration.
env: [{name: ANSIBLE_MODULE_STRICT_UTF8_RESPONSE}] env: [{name: ANSIBLE_MODULE_STRICT_UTF8_RESPONSE}]
ini: ini:
- {key: module_strict_utf8_response, section: defaults} - {key: module_strict_utf8_response, section: defaults}
type: bool type: bool
default: True default: True
OLD_PLUGIN_CACHE_CLEARING: OLD_PLUGIN_CACHE_CLEARING:
description: Previously Ansible would only clear some of the plugin loading caches when loading new roles, this led to some behaviours in which a plugin loaded in previous plays would be unexpectedly 'sticky'. This setting allows to return to that behaviour. description: Previously Ansible would only clear some of the plugin loading caches when loading new roles, this led to some behaviors in which a plugin loaded in previous plays would be unexpectedly 'sticky'. This setting allows the user to return to that behavior.
env: [{name: ANSIBLE_OLD_PLUGIN_CACHE_CLEAR}] env: [{name: ANSIBLE_OLD_PLUGIN_CACHE_CLEAR}]
ini: ini:
- {key: old_plugin_cache_clear, section: defaults} - {key: old_plugin_cache_clear, section: defaults}
@ -1783,7 +1783,7 @@ PAGER:
name: pager application to use name: pager application to use
default: less default: less
descrioption: descrioption:
- for the cases in which Ansible needs to return output in pageable fashion, this chooses the application to use - for the cases in which Ansible needs to return output in a pageable fashion, this chooses the application to use.
ini: ini:
- section: defaults - section: defaults
key: pager key: pager
@ -1818,7 +1818,7 @@ PARAMIKO_LOOK_FOR_KEYS:
PERSISTENT_CONTROL_PATH_DIR: PERSISTENT_CONTROL_PATH_DIR:
name: Persistence socket path name: Persistence socket path
default: '{{ ANSIBLE_HOME ~ "/pc" }}' default: '{{ ANSIBLE_HOME ~ "/pc" }}'
description: Path to socket to be used by the connection persistence system. description: Path to the socket to be used by the connection persistence system.
env: [{name: ANSIBLE_PERSISTENT_CONTROL_PATH_DIR}] env: [{name: ANSIBLE_PERSISTENT_CONTROL_PATH_DIR}]
ini: ini:
- {key: control_path_dir, section: persistent_connection} - {key: control_path_dir, section: persistent_connection}
@ -1842,7 +1842,7 @@ PERSISTENT_CONNECT_RETRY_TIMEOUT:
PERSISTENT_COMMAND_TIMEOUT: PERSISTENT_COMMAND_TIMEOUT:
name: Persistence command timeout name: Persistence command timeout
default: 30 default: 30
description: This controls the amount of time to wait for response from remote device before timing out persistent connection. description: This controls the amount of time to wait for a response from a remote device before timing out a persistent connection.
env: [{name: ANSIBLE_PERSISTENT_COMMAND_TIMEOUT}] env: [{name: ANSIBLE_PERSISTENT_COMMAND_TIMEOUT}]
ini: ini:
- {key: command_timeout, section: persistent_connection} - {key: command_timeout, section: persistent_connection}
@ -1860,7 +1860,7 @@ PLAYBOOK_VARS_ROOT:
default: top default: top
version_added: "2.4.1" version_added: "2.4.1"
description: description:
- This sets which playbook dirs will be used as a root to process vars plugins, which includes finding host_vars/group_vars - This sets which playbook dirs will be used as a root to process vars plugins, which includes finding host_vars/group_vars.
env: [{name: ANSIBLE_PLAYBOOK_VARS_ROOT}] env: [{name: ANSIBLE_PLAYBOOK_VARS_ROOT}]
ini: ini:
- {key: playbook_vars_root, section: defaults} - {key: playbook_vars_root, section: defaults}
@ -1916,7 +1916,7 @@ RUN_VARS_PLUGINS:
name: When should vars plugins run relative to inventory name: When should vars plugins run relative to inventory
default: demand default: demand
description: description:
- This setting can be used to optimize vars_plugin usage depending on user's inventory size and play selection. - This setting can be used to optimize vars_plugin usage depending on the user's inventory size and play selection.
env: [{name: ANSIBLE_RUN_VARS_PLUGINS}] env: [{name: ANSIBLE_RUN_VARS_PLUGINS}]
ini: ini:
- {key: run_vars_plugins, section: defaults} - {key: run_vars_plugins, section: defaults}
@ -1928,7 +1928,7 @@ RUN_VARS_PLUGINS:
SHOW_CUSTOM_STATS: SHOW_CUSTOM_STATS:
name: Display custom stats name: Display custom stats
default: False default: False
description: 'This adds the custom stats set via the set_stats plugin to the default output' description: 'This adds the custom stats set via the set_stats plugin to the default output.'
env: [{name: ANSIBLE_SHOW_CUSTOM_STATS}] env: [{name: ANSIBLE_SHOW_CUSTOM_STATS}]
ini: ini:
- {key: show_custom_stats, section: defaults} - {key: show_custom_stats, section: defaults}
@ -1937,7 +1937,7 @@ STRING_TYPE_FILTERS:
name: Filters to preserve strings name: Filters to preserve strings
default: [string, to_json, to_nice_json, to_yaml, to_nice_yaml, ppretty, json] default: [string, to_json, to_nice_json, to_yaml, to_nice_yaml, ppretty, json]
description: description:
- "This list of filters avoids 'type conversion' when templating variables" - "This list of filters avoids 'type conversion' when templating variables."
- Useful when you want to avoid conversion into lists or dictionaries for JSON strings, for example. - Useful when you want to avoid conversion into lists or dictionaries for JSON strings, for example.
env: [{name: ANSIBLE_STRING_TYPE_FILTERS}] env: [{name: ANSIBLE_STRING_TYPE_FILTERS}]
ini: ini:
@ -1947,8 +1947,8 @@ SYSTEM_WARNINGS:
name: System warnings name: System warnings
default: True default: True
description: description:
- Allows disabling of warnings related to potential issues on the system running ansible itself (not on the managed hosts) - Allows disabling of warnings related to potential issues on the system running Ansible itself (not on the managed hosts).
- These may include warnings about 3rd party packages or other conditions that should be resolved if possible. - These may include warnings about third-party packages or other conditions that should be resolved if possible.
env: [{name: ANSIBLE_SYSTEM_WARNINGS}] env: [{name: ANSIBLE_SYSTEM_WARNINGS}]
ini: ini:
- {key: system_warnings, section: defaults} - {key: system_warnings, section: defaults}

Loading…
Cancel
Save