特殊变量

魔法变量

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

ansible_check_mode

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

ansible_collection_name

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

ansible_config_file

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

ansible_dependent_role_names

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

ansible_diff_mode

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

ansible_forks

反映此运行可用的最大 fork 数量的整数

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

当前剧本运行中由序列(也称为“批次”)限制的活动主机列表。失败/不可达主机不被视为“活动”主机。

ansible_play_hosts

当前剧本运行中的主机列表,不受序列限制。失败/不可达主机已从此列表中排除。

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) 相关的的信息。只有在先收集了信息的情况下才可以使用它们。更多信息请参考 发现变量:facts 和 magic 变量

ansible_facts

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

ansible_local

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

连接变量

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

ansible_become_user

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

ansible_connection

在目标主机上执行任务时实际使用的连接插件。

ansible_host

用于替换 inventory_hostname 的目标主机的 IP/名称。

ansible_python_interpreter

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

ansible_user

Ansible “登录”的用户。