特殊变量

魔术变量

这些变量不能由用户直接设置;Ansible 将始终覆盖它们以反映内部状态。

ansible_check_mode

布尔值,指示我们是否处于检查模式。

ansible_collection_name

正在执行的任务所属集合的名称。格式为 namespace.collection

ansible_config_file

使用的 Ansible 配置文件的完整路径

ansible_dependent_role_names

当前作为其他剧本的依赖项导入到当前剧本中的角色的名称

ansible_diff_mode

布尔值,指示我们是否处于差异模式。

ansible_forks

整数,反映此运行可用的最大分叉数。

ansible_index_var

提供给 loop_control.index_var 的值的名称。在 2.9 中添加。

ansible_inventory_sources

用作清单的源列表

ansible_limit

当前 Ansible 执行的 --limit CLI 选项的内容

ansible_loop

当通过 loop_control.extended 启用时,包含扩展循环信息的字典/映射。

ansible_loop_var

提供给 loop_control.loop_var 的值的名称。在 2.8 中添加。

ansible_parent_role_names

当当前角色通过 include_roleimport_role 操作执行时,此变量包含所有父角色的列表,最新角色(换句话说,包含/导入此角色的角色)是列表中的第一个项目。当发生多次包含时,此列表列出最后一个角色(换句话说,包含此角色的角色)作为列表中的第一个项目。也有可能此列表中存在特定角色多次。

例如:当角色 **A** 包含角色 **B** 时,在角色 B 内部,ansible_parent_role_names 将等于 ['A']。如果角色 **B** 然后包含角色 **C**,列表将变为 ['B', 'A']

ansible_parent_role_paths

当当前角色通过 include_roleimport_role 操作执行时,此变量包含所有父角色路径的列表,最新角色(换句话说,包含/导入此角色的角色)是列表中的第一个项目。请参考 ansible_parent_role_names 以了解此列表中项目的顺序。

ansible_play_batch

当前剧本运行中受 serial(也称为“批次”)限制的活动主机列表。失败/无法访问的主机不被视为“活动”。

ansible_play_hosts

当前剧本运行中的主机列表,不受 serial 限制。失败/无法访问的主机将从此列表中排除。

ansible_play_hosts_all

剧本所针对的所有主机的列表

ansible_play_name

正在执行的剧本的名称。在 2.8 中添加。(剧本的 name 属性,而不是剧本的文件名。)

ansible_play_role_names

当前导入到当前剧本中的角色的名称。此列表包含通过依赖项隐式包含的角色名称。

ansible_playbook_python

控制节点上 Ansible 使用的 python 解释器的路径

ansible_role_name

完全限定的集合角色名称,格式为 namespace.collection.role_name

ansible_role_names

当前导入到当前剧本中的角色的名称,或作为导入到当前剧本中的角色的依赖项引用的角色名称。

ansible_run_tags

--tags CLI 选项的内容,该选项指定当前运行将包含哪些标签。请注意,如果未传递 --tags,此变量将默认为 ["all"]

ansible_search_path

操作插件和查找的当前搜索路径,换句话说,当您执行 template: src=myfile 时,我们在哪里搜索相对路径

ansible_skip_tags

--skip-tags CLI 选项的内容,该选项指定当前运行将跳过哪些标签。

ansible_verbosity

Ansible 的当前详细程度设置

ansible_version

包含有关正在运行的 ansible 版本的信息的字典/映射,它具有以下键:full、major、minor、revision 和 string。

group_names

当前主机所属的组列表,它始终反映 inventory_hostname 并且忽略委托。

groups

一个包含清单中所有组的字典/映射,每个组都包含属于它的主机列表

hostvars

一个包含清单中所有主机的字典/映射,以及分配给它们的所有变量

inventory_dir

首次定义 inventory_hostname 的清单源的目录。这始终反映 inventory_hostname 并且忽略委托。

inventory_hostname

剧本中正在迭代的“当前”主机的清单名称。这不受委托影响,它始终反映任务的原始主机

inventory_hostname_short

inventory_hostname 的简短版本,是通过 . 分割后第一个部分。例如,对于 inventory_hostnamewww.example.comwww 将是 inventory_hostname_short 这受委托影响,因此它将反映委托主机的“简短名称”

inventory_file

首次定义 inventory_hostname 的清单源的文件名。忽略委托,始终反映 inventory_hostname 的信息。

omit

允许您“省略”任务中选项的特殊变量,例如 - user: name=bob home={{ bobs_home|default(omit) }}

play_hosts

已弃用,与 ansible_play_batch 相同

playbook_dir

正在执行的当前剧本的目录的路径。注意:当剧本包含 import_playbook 语句时,这可能与传递给 ansible-playbook 命令行的剧本目录不同。

role_name

当前正在执行的角色名称。

role_names

已弃用,与 ansible_play_role_names 相同。

role_path

当前运行角色的目录路径。

事实

这些是包含与当前主机 (inventory_hostname) 相关信息的变量。 它们只有在首次收集时才可用。 有关更多信息,请参阅 发现变量:事实和魔法变量

ansible_facts

包含为 inventory_hostname 收集或缓存的任何事实。 事实通常由 setup 模块在剧本中自动收集,但任何模块都可以返回事实。

ansible_local

包含为 inventory_hostname 收集或缓存的任何“本地事实”。 可用的键取决于创建的自定义事实。 有关更多详细信息,请参阅 setup 模块和 facts.d 或本地事实

连接变量

连接变量通常用于设置在目标上执行操作的具体细节。 它们中的大多数与连接插件相对应,但并非所有都与它们相关;其他插件如 shell、terminal 和 become 通常会参与其中。 只有常见的变量会被描述,因为每个连接/become/shell/等插件都可以定义自己的覆盖和特定变量。 有关连接变量如何与 控制 Ansible 行为方式:优先级规则配置设置命令行选项剧本关键字 相互作用,请参阅。

ansible_become_user

Ansible 在使用特权提升后“成为”的用户。 此用户必须对“登录用户”可用。

ansible_connection

实际用于目标主机上的任务的连接插件。

ansible_host

要使用的目标主机的 IP/名称,而不是 inventory_hostname

ansible_python_interpreter

Ansible 应在目标主机上使用的 Python 可执行文件的路径。

ansible_user

Ansible “登录”的用户。