特殊变量

魔术变量

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

ansible_check_mode

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

ansible_collection_name

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

ansible_config_file

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

ansible_dependent_role_names

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

ansible_diff_mode

布尔值,指示是否处于差异(diff)模式

ansible_forks

整数,反映本次运行可用的最大并行进程(forks)数量

ansible_index_var

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

ansible_inventory_sources

用作清单(inventory)的来源列表

ansible_limit

当前 Ansible 执行中 --limit 命令行选项的内容

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

当前 Play 运行中受 serial 限制的活跃主机列表,也称为“批次”(batch)。失败/不可达的主机不被视为“活跃”。

ansible_play_hosts

当前 Play 运行中的主机列表,不受 serial 限制。失败/不可达的主机将从此列表中排除。

ansible_play_hosts_all

Play 所针对的所有主机的列表

ansible_play_name

当前执行的 Play 的名称。添加于 2.8。(Play 的 name 属性,而非 Playbook 的文件名。)

ansible_play_role_names

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

ansible_playbook_python

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

ansible_role_name

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

ansible_role_names

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

ansible_run_tags

--tags 命令行选项的内容,它指定了当前运行中将包含哪些标签。注意,如果没有传递 --tags,此变量将默认为 ["all"]

ansible_search_path

当前动作插件和查找(lookups)的搜索路径,即当你执行 template: src=myfile 时我们搜索相对路径的位置

ansible_skip_tags

--skip-tags 命令行选项的内容,它指定了当前运行中将跳过哪些标签。

ansible_verbosity

Ansible 当前的详细程度设置

ansible_version

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

group_names

当前主机所属的组列表,它始终反映 inventory_hostname 且忽略委派(delegation)。

groups

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

hostvars

包含清单中所有主机及其分配的变量的字典/映射

inventory_dir

首次定义 inventory_hostname 的清单源目录。此变量始终反映 inventory_hostname 且忽略委派。

inventory_hostname

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

inventory_hostname_short

inventory_hostname 的简短版本,即通过 . 分割后的第一部分。例如,对于 www.example.cominventory_hostnamewww 将是 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

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

role_name

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

role_names

已弃用,与 ansible_play_role_names 相同

role_path

当前正在运行的角色的目录路径

Facts

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

ansible_facts

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

ansible_local

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

连接变量

连接变量通常用于设置如何在目标上执行动作的细节。它们中的大多数对应于连接插件,但并非所有都特定于它们;其他插件(如 shell、terminal 和 become)通常也涉及其中。这里仅描述通用的变量,因为每个连接/become/shell 等插件都可以定义自己的覆盖和特定变量。有关连接变量如何与 配置设置命令行选项Playbook 关键字 进行交互的信息,请参阅 控制 Ansible 的行为:优先级规则

ansible_become_user

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

ansible_connection

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

ansible_host

要使用的目标主机的 IP/名称,用于替代 inventory_hostname

ansible_python_interpreter

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

ansible_user

Ansible 作为其“登录”的用户。