These variables cannot be set directly by the user; Ansible will always override them to reflect internal state.
These variables cannot be set directly by the user; Ansible will always override them to reflect internal state.
ansible_check_mode
..glossary::
Boolean that indicates if we are in check mode or not
ansible_config_file
ansible_check_mode
The full path of used Ansible configuration file
Boolean that indicates if we are in check mode or not
ansible_dependent_role_names
ansible_config_file
The names of the roles currently imported into the current play as dependencies of other plays
The full path of used Ansible configuration file
ansible_diff_mode
ansible_dependent_role_names
Boolean that indicates if we are in diff mode or not
The names of the roles currently imported into the current play as dependencies of other plays
ansible_forks
ansible_diff_mode
Integer reflecting the number of maximum forks available to this run
Boolean that indicates if we are in diff mode or not
ansible_inventory_sources
ansible_forks
List of sources used as inventory
Integer reflecting the number of maximum forks available to this run
ansible_limit
ansible_inventory_sources
Contents of the ``--limit`` CLI option for the current execution of Ansible
List of sources used as inventory
ansible_loop
ansible_limit
A dictionary/map containing extended loop information when enabled through ``loop_control.extended``
Contents of the ``--limit`` CLI option for the current execution of Ansible
ansible_loop_var
ansible_loop
The name of the value provided to ``loop_control.loop_var``. Added in ``2.8``
A dictionary/map containing extended loop information when enabled through ``loop_control.extended``
ansible_index_var
ansible_loop_var
The name of the value provided to ``loop_control.index_var``. Added in ``2.9``
The name of the value provided to ``loop_control.loop_var``. Added in ``2.8``
ansible_parent_role_names
ansible_index_var
When the current role is being executed by means of an :ref:`include_role <include_role_module>` or :ref:`import_role <import_role_module>` action, this variable contains a list of all parent roles, with the most recent role (in other words, the role that included/imported this role) being the first item in the list.
The name of the value provided to ``loop_control.index_var``. Added in ``2.9``
When multiple inclusions occur, this list lists the *last* role (in other words, the role that included this role) as the *first* item in the list. It is also possible that a specific role exists more than once in this list.
For example: When role **A** includes role **B**, inside role B, ``ansible_parent_role_names`` will equal to ``['A']``. If role **B** then includes role **C**, the list becomes ``['B', 'A']``.
ansible_parent_role_names
When the current role is being executed by means of an :ref:`include_role <include_role_module>` or :ref:`import_role <import_role_module>` action, this variable contains a list of all parent roles, with the most recent role (in other words, the role that included/imported this role) being the first item in the list.
When multiple inclusions occur, this list lists the *last* role (in other words, the role that included this role) as the *first* item in the list. It is also possible that a specific role exists more than once in this list.
ansible_parent_role_paths
For example: When role **A** includes role **B**, inside role B, ``ansible_parent_role_names`` will equal to ``['A']``. If role **B** then includes role **C**, the list becomes ``['B', 'A']``.
When the current role is being executed by means of an :ref:`include_role <include_role_module>` or :ref:`import_role <import_role_module>` action, this variable contains a list of all parent roles paths, with the most recent role (in other words, the role that included/imported this role) being the first item in the list.
Please refer to ``ansible_parent_role_names`` for the order of items in this list.
ansible_play_batch
ansible_parent_role_paths
List of active hosts in the current play run limited by the serial, aka 'batch'. Failed/Unreachable hosts are not considered 'active'.
When the current role is being executed by means of an :ref:`include_role <include_role_module>` or :ref:`import_role <import_role_module>` action, this variable contains a list of all parent roles paths, with the most recent role (in other words, the role that included/imported this role) being the first item in the list.
Please refer to ``ansible_parent_role_names`` for the order of items in this list.
ansible_play_hosts
ansible_play_batch
List of hosts in the current play run, not limited by the serial. Failed/Unreachable hosts are excluded from this list.
List of active hosts in the current play run limited by the serial, aka 'batch'. Failed/Unreachable hosts are not considered 'active'.
ansible_play_hosts_all
ansible_play_hosts
List of all the hosts that were targeted by the play
List of hosts in the current play run, not limited by the serial. Failed/Unreachable hosts are excluded from this list.
ansible_play_role_names
ansible_play_hosts_all
The names of the roles currently imported into the current play. This list does **not** contain the role names that are
List of all the hosts that were targeted by the play
implicitly included through dependencies.
ansible_playbook_python
ansible_play_role_names
The path to the python interpreter being used by Ansible on the controller
The names of the roles currently imported into the current play. This list does **not** contain the role names that are
implicitly included through dependencies.
ansible_role_names
ansible_playbook_python
The names of the roles currently imported into the current play, or roles referenced as dependencies of the roles
The path to the python interpreter being used by Ansible on the controller
imported into the current play.
ansible_role_name
ansible_role_names
The fully qualified collection role name, in the format of ``namespace.collection.role_name``
The names of the roles currently imported into the current play, or roles referenced as dependencies of the roles
imported into the current play.
ansible_collection_name
ansible_role_name
The name of the collection the task that is executing is a part of. In the format of ``namespace.collection``
The fully qualified collection role name, in the format of ``namespace.collection.role_name``
ansible_run_tags
ansible_collection_name
Contents of the ``--tags`` CLI option, which specifies which tags will be included for the current run. Note that if ``--tags`` is not passed, this variable will default to ``["all"]``.
The name of the collection the task that is executing is a part of. In the format of ``namespace.collection``
ansible_search_path
ansible_run_tags
Current search path for action plugins and lookups, in other words, where we search for relative paths when you do ``template: src=myfile``
Contents of the ``--tags`` CLI option, which specifies which tags will be included for the current run. Note that if ``--tags`` is not passed, this variable will default to ``["all"]``.
ansible_skip_tags
ansible_search_path
Contents of the ``--skip-tags`` CLI option, which specifies which tags will be skipped for the current run.
Current search path for action plugins and lookups, in other words, where we search for relative paths when you do ``template: src=myfile``
ansible_verbosity
ansible_skip_tags
Current verbosity setting for Ansible
Contents of the ``--skip-tags`` CLI option, which specifies which tags will be skipped for the current run.
ansible_version
ansible_verbosity
Dictionary/map that contains information about the current running version of ansible, it has the following keys: full, major, minor, revision and string.
Current verbosity setting for Ansible
group_names
ansible_version
List of groups the current host is part of
Dictionary/map that contains information about the current running version of ansible, it has the following keys: full, major, minor, revision and string.
groups
group_names
A dictionary/map with all the groups in inventory and each group has the list of hosts that belong to it
List of groups the current host is part of
hostvars
groups
A dictionary/map with all the hosts in inventory and variables assigned to them
A dictionary/map with all the groups in inventory and each group has the list of hosts that belong to it
inventory_hostname
hostvars
The inventory name for the 'current' host being iterated over in the play
A dictionary/map with all the hosts in inventory and variables assigned to them
inventory_hostname_short
inventory_hostname
The short version of `inventory_hostname`
The inventory name for the 'current' host being iterated over in the play
inventory_dir
inventory_hostname_short
The directory of the inventory source in which the `inventory_hostname` was first defined
The short version of `inventory_hostname`
inventory_file
inventory_dir
The file name of the inventory source in which the `inventory_hostname` was first defined
The directory of the inventory source in which the `inventory_hostname` was first defined
omit
inventory_file
Special variable that allows you to 'omit' an option in a task, for example ``- user: name=bob home={{ bobs_home|default(omit) }}``
The file name of the inventory source in which the `inventory_hostname` was first defined
play_hosts
omit
Deprecated, the same as ansible_play_batch
Special variable that allows you to 'omit' an option in a task, for example ``- user: name=bob home={{ bobs_home|default(omit) }}``
ansible_play_name
play_hosts
The name of the currently executed play. Added in ``2.8``. (`name` attribute of the play, not file name of the playbook.)
Deprecated, the same as ansible_play_batch
playbook_dir
ansible_play_name
The path to the directory of the current playbook being executed. NOTE: This might be different than directory of the playbook passed to the ``ansible-playbook`` command line when a playbook contains a ``import_playbook`` statement.
The name of the currently executed play. Added in ``2.8``. (`name` attribute of the play, not file name of the playbook.)
role_name
playbook_dir
The name of the role currently being executed.
The path to the directory of the current playbook being executed. NOTE: This might be different than directory of the playbook passed to the ``ansible-playbook`` command line when a playbook contains a ``import_playbook`` statement.
role_names
role_name
Deprecated, the same as ansible_play_role_names
The name of the role currently being executed.
role_path
role_names
The path to the dir of the currently running role
Deprecated, the same as ansible_play_role_names
role_path
The path to the dir of the currently running role
Facts
Facts
-----
-----
These are variables that contain information pertinent to the current host (`inventory_hostname`). They are only available if gathered first. See :ref:`vars_and_facts` for more information.
These are variables that contain information pertinent to the current host (`inventory_hostname`). They are only available if gathered first. See :ref:`vars_and_facts` for more information.
ansible_facts
..glossary::
Contains any facts gathered or cached for the `inventory_hostname`
Facts are normally gathered by the :ref:`setup <setup_module>` module automatically in a play, but any module can return facts.
ansible_facts
Contains any facts gathered or cached for the `inventory_hostname`
Facts are normally gathered by the :ref:`setup <setup_module>` module automatically in a play, but any module can return facts.
ansible_local
ansible_local
Contains any 'local facts' gathered or cached for the `inventory_hostname`.
Contains any 'local facts' gathered or cached for the `inventory_hostname`.
The keys available depend on the custom facts created.
The keys available depend on the custom facts created.
See the :ref:`setup <setup_module>` module and :ref:`local_facts` for more details.
See the :ref:`setup <setup_module>` module and :ref:`local_facts` for more details.
.._connection_variables:
.._connection_variables:
@ -151,17 +155,19 @@ Connection variables are normally used to set the specifics on how to execute ac
Only the common ones are described as each connection/become/shell/etc plugin can define its own overrides and specific variables.
Only the common ones are described as each connection/become/shell/etc plugin can define its own overrides and specific variables.
See :ref:`general_precedence_rules` for how connection variables interact with :ref:`configuration settings<ansible_configuration_settings>`, :ref:`command-line options<command_line_tools>`, and :ref:`playbook keywords<playbook_keywords>`.
See :ref:`general_precedence_rules` for how connection variables interact with :ref:`configuration settings<ansible_configuration_settings>`, :ref:`command-line options<command_line_tools>`, and :ref:`playbook keywords<playbook_keywords>`.
ansible_become_user
..glossary::
The user Ansible 'becomes' after using privilege escalation. This must be available to the 'login user'.
ansible_become_user
The user Ansible 'becomes' after using privilege escalation. This must be available to the 'login user'.
ansible_connection
ansible_connection
The connection plugin actually used for the task on the target host.
The connection plugin actually used for the task on the target host.
ansible_host
ansible_host
The ip/name of the target host to use instead of `inventory_hostname`.
The ip/name of the target host to use instead of `inventory_hostname`.
ansible_python_interpreter
ansible_python_interpreter
The path to the Python executable Ansible should use on the target host.
The path to the Python executable Ansible should use on the target host.
Benoît Geeraerts
1 year ago
committed by