Ansible 配置设置

Ansible 支持多种来源来配置其行为,包括名为 ansible.cfg 的 ini 文件、环境变量、命令行选项、Playbook 关键字和变量。有关各来源相对优先级的详细信息,请参阅 控制 Ansible 的行为:优先级规则

ansible-config 工具允许用户查看所有可用的配置设置、其默认值、如何设置它们以及其当前值的来源。有关更多信息,请参阅 ansible-config

配置文件

可以在配置文件中进行更改并使用,该文件将按以下顺序搜索:

  • ANSIBLE_CONFIG(如果已设置环境变量)

  • ansible.cfg(在当前目录中)

  • ~/.ansible.cfg(在主目录中)

  • /etc/ansible/ansible.cfg

Ansible 将处理上述列表并使用找到的第一个文件,所有其他文件将被忽略。

注意

配置文件是 INI 格式的一种变体。当注释位于行首时,哈希符号 (#) 和分号 (;) 均可用作注释标记。但是,如果注释与常规值在同一行,则只能使用分号引入注释。例如:

# some basic default values...
inventory = /etc/ansible/hosts  ; This points to the file that lists your hosts

生成示例 ansible.cfg 文件

您可以生成一个完全注释掉的示例 ansible.cfg 文件,例如:

$ ansible-config init --disabled > ansible.cfg

您还可以拥有一个包含现有插件的更完整的文件:

$ ansible-config init --disabled -t all > ansible.cfg

您可以将这些作为起点来创建您自己的 ansible.cfg 文件。

避免在当前目录使用 ansible.cfg 带来的安全风险

如果 Ansible 从一个全局可写的当前工作目录加载 ansible.cfg,将会产生严重的安全风险。其他用户可能会在那里放置他们自己的配置文件,旨在使 Ansible 在本地和远程执行恶意代码,且可能具有提升的权限。出于这个原因,如果当前工作目录是全局可写的,Ansible 将不会自动从该目录加载配置文件。

如果您依赖在当前工作目录中使用带有配置文件的 Ansible,避免此问题的最佳方法是将对 Ansible 目录的访问权限限制为特定用户和/或组。如果您的 Ansible 目录位于必须模拟 Unix 权限的文件系统上(如 Vagrant 或适用于 Linux 的 Windows 子系统 (WSL)),您最初可能不知道如何修复此问题,因为 chmodchownchgrp 可能在那里不起作用。在大多数此类情况下,正确的修复方法是修改文件系统的挂载选项,以便文件和目录对于运行 Ansible 的用户和组是可读写的,但对其他人关闭。有关正确设置的更多详细信息,请参阅:

如果您绝对依赖于将 Ansible 配置存储在全局可写的当前工作目录中,则可以通过 ANSIBLE_CONFIG 环境变量显式指定配置文件。在这样做之前,请采取适当的步骤来降低上述安全风险。

配置的相对路径

您可以为许多配置选项指定相对路径。在大多数此类情况下,所使用的路径将相对于当前执行所使用的 ansible.cfg 文件。如果您需要相对于当前工作目录 (CWD) 的路径,可以使用 {{CWD}} 宏来指定它。我们不建议这种方法,因为使用 CWD 作为相对路径的根目录可能会产生安全风险。例如:cd /tmp; secureinfo=./newrootpassword ansible-playbook ~/safestuff/change_root_pwd.yml

常用选项

这是我们发布版本中可用选项的副本,您的本地安装可能会因为额外的插件而具有额外的选项,您可以使用上面提到的命令行工具(ansible-config)来浏览这些选项。

ACTION_WARNINGS

描述:

默认情况下,当从任务操作(模块或操作插件)接收到警告时,Ansible 将发出警告。通过将此设置调整为 False,可以静默这些警告。

类型:

布尔值

默认值:

True

添加版本:

2.5

Ini:
部分:

[defaults]

键:

action_warnings

环境变量:
变量:

ANSIBLE_ACTION_WARNINGS

AGNOSTIC_BECOME_PROMPT

描述:

显示一个通用的提权提示,而不是显示包含命令行提供的提权方法的提示。

类型:

布尔值

默认值:

True

添加版本:

2.5

Ini:
部分:

[privilege_escalation]

键:

agnostic_become_prompt

环境变量:
变量:

ANSIBLE_AGNOSTIC_BECOME_PROMPT

ALLOW_BROKEN_CONDITIONALS

描述:

启用后,此选项允许使用非布尔结果的条件。在这种情况下,将发出弃用警告。默认情况下,非布尔条件会导致错误。此类结果通常表明在不支持的地方无意使用了模板,导致条件始终为真。启用此选项后,为实现向后兼容,文字 None 或空字符串的条件表达式将被评估为真。

类型:

布尔值

默认值:

False

添加版本:

2.19

Ini:
部分:

[defaults]

键:

allow_broken_conditionals

环境变量:
变量:

ANSIBLE_ALLOW_BROKEN_CONDITIONALS

ALLOW_EMBEDDED_TEMPLATES

描述:

启用后,此选项允许针对特定的向后兼容场景使用嵌入式模板。在这种情况下,将发出弃用警告。首先,完全用模板分隔符包围的条件(例如 failed_whenuntilassert.that)。其次,条件中的字符串常量(例如 when: some_var == '{{ some_other_var }}')。最后,查找的位置参数(例如 lookup('pipe', 'echo {{ some_var }}'))。此功能已被弃用,因为在这些情况下嵌入式模板是不必要的。禁用时,使用嵌入式模板会导致错误。未来的版本将默认禁用此功能。

类型:

布尔值

默认值:

True

添加版本:

2.19

Ini:
部分:

[defaults]

键:

allow_embedded_templates

环境变量:
变量:

ANSIBLE_ALLOW_EMBEDDED_TEMPLATES

ANSIBLE_CONNECTION_PATH

描述:

指定查找 ansible-connection 脚本的位置。在搜索 $PATH 之前将检查此位置。如果为 null,ansible 将以与 ansible 脚本相同的目录开始。

类型:

path

默认值:

None

添加版本:

2.8

Ini:
部分:

[persistent_connection]

键:

ansible_connection_path

环境变量:
变量:

ANSIBLE_CONNECTION_PATH

注意:

此配置现已弃用,并计划移除。

计划移除:

2.22

弃用原因:

此设置无效。

ANSIBLE_COW_ACCEPTLIST

描述:

接受“安全”使用的 cowsay 模板列表,如果您想启用所有安装的模板,请将其设置为空列表。

类型:

list

默认值:

['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']

Ini:
部分:

[defaults]

键:

cowsay_enabled_stencils

添加版本:

2.11

环境变量:
变量:

ANSIBLE_COW_ACCEPTLIST

添加版本:

2.11

ANSIBLE_COW_PATH

描述:

指定自定义的 cowsay 路径或替换为您选择的 cowsay 实现。

类型:

字符串

默认值:

None

Ini:
部分:

[defaults]

键:

cowpath

环境变量:
变量:

ANSIBLE_COW_PATH

ANSIBLE_COW_SELECTION

描述:

这允许您为横幅选择特定的 cowsay 模板,或使用“random”循环浏览它们。

默认值:

default

Ini:
部分:

[defaults]

键:

cow_selection

环境变量:
变量:

ANSIBLE_COW_SELECTION

ANSIBLE_FORCE_COLOR

描述:

此选项即使在没有 TTY 或“nocolor”设置的情况下也强制开启颜色模式。

类型:

布尔值

默认值:

False

Ini:
部分:

[defaults]

键:

force_color

环境变量:
变量:

ANSIBLE_FORCE_COLOR

ANSIBLE_HOME

描述:

控制器上 Ansible 配置文件的默认根路径。

类型:

path

默认值:

~/.ansible

添加版本:

2.14

Ini:
部分:

[defaults]

键:

home

环境变量:
变量:

ANSIBLE_HOME

ANSIBLE_NOCOLOR

描述:

此设置允许禁止颜色化输出,用于更好地指示失败和状态信息。

类型:

布尔值

默认值:

False

Ini:
部分:

[defaults]

键:

nocolor

环境变量:

ANSIBLE_NOCOWS

描述:

如果您安装了 cowsay 但想避免显示“奶牛”(为什么????),请使用此项。

类型:

布尔值

默认值:

False

Ini:
部分:

[defaults]

键:

nocows

环境变量:
变量:

ANSIBLE_NOCOWS

ANSIBLE_PIPELINING

描述:

这是一个全局选项,每个连接插件都可以通过具有更具体的选项或根本不支持流水线来覆盖此设置。如果连接插件支持,流水线化可以通过执行多个 Ansible 模块而无需实际文件传输,从而减少在远程服务器上执行模块所需的网络操作数量。启用后,它可以带来非常显著的性能改进。但这与提权(become)冲突。例如,使用“sudo:”操作时,您必须首先在所有受管主机上的 /etc/sudoers 中禁用“requiretty”,这就是默认禁用它的原因。如果启用了 ANSIBLE_KEEP_REMOTE_FILES,此设置将被禁用。

类型:

布尔值

默认值:

False

Ini:
  • 部分:

    [connection]

    键:

    pipelining

  • 部分:

    [defaults]

    键:

    pipelining

环境变量:
变量:

ANSIBLE_PIPELINING

ANY_ERRORS_FATAL

描述:

设置 any_errors_fatal 关键字的默认值,如果为 True,任务失败将被视为致命错误。

类型:

布尔值

默认值:

False

添加版本:

2.4

Ini:
部分:

[defaults]

键:

any_errors_fatal

环境变量:
变量:

ANSIBLE_ANY_ERRORS_FATAL

BECOME_ALLOW_SAME_USER

描述:

当为 False(默认)时,如果远程用户与提权用户相同,Ansible 将跳过使用提权,因为这通常是多余的操作。换句话说,即 root sudo 到 root。如果为 True,则强制 Ansible 无论如何都使用提权插件,因为在某些情况下这是必要的。

类型:

布尔值

默认值:

False

Ini:
部分:

[privilege_escalation]

键:

become_allow_same_user

环境变量:
变量:

ANSIBLE_BECOME_ALLOW_SAME_USER

BECOME_PASSWORD_FILE

描述:

用于提权插件的密码文件。--become-password-file。如果它是可执行文件,它将被运行,产生的标准输出将用作密码。

类型:

path

默认值:

None

添加版本:

2.12

Ini:
部分:

[defaults]

键:

become_password_file

环境变量:
变量:

ANSIBLE_BECOME_PASSWORD_FILE

BECOME_PLUGIN_PATH

描述:

Ansible 将搜索提权插件的冒号分隔路径。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/become:/usr/share/ansible/plugins/become" }}

添加版本:

2.8

Ini:
部分:

[defaults]

键:

become_plugins

环境变量:
变量:

ANSIBLE_BECOME_PLUGINS

CACHE_PLUGIN

描述:

选择使用哪个事实缓存插件。默认情况下,不使用缓存,事实不会在运行之间持续存在。

默认值:

memory

Ini:
部分:

[defaults]

键:

fact_caching

环境变量:
变量:

ANSIBLE_CACHE_PLUGIN

CACHE_PLUGIN_CONNECTION

描述:

为事实缓存插件定义连接或路径信息。

默认值:

None

Ini:
部分:

[defaults]

键:

fact_caching_connection

环境变量:
变量:

ANSIBLE_CACHE_PLUGIN_CONNECTION

CACHE_PLUGIN_PREFIX

描述:

用于事实缓存插件文件/表的前缀。

默认值:

ansible_facts

Ini:
部分:

[defaults]

键:

fact_caching_prefix

环境变量:
变量:

ANSIBLE_CACHE_PLUGIN_PREFIX

CACHE_PLUGIN_TIMEOUT

描述:

事实缓存插件数据的过期超时时间。

类型:

整数

默认值:

86400

Ini:
部分:

[defaults]

键:

fact_caching_timeout

环境变量:
变量:

ANSIBLE_CACHE_PLUGIN_TIMEOUT

CALLBACKS_ENABLED

描述:

已启用的回调列表,并非所有回调都需要启用,但随 Ansible 一起提供的许多回调需要,因为我们不希望默认激活它们。

类型:

list

默认值:

[]

Ini:
部分:

[defaults]

键:

callbacks_enabled

添加版本:

2.11

环境变量:
变量:

ANSIBLE_CALLBACKS_ENABLED

添加版本:

2.11

COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH

描述:

当加载不支持当前运行的 Ansible 版本的集合时(使用集合元数据键 requires_ansible)。

默认值:

warning

选择:
  • error:

    发出“致命”错误并停止 Play

  • warning:

    发出警告但继续

  • ignore:

    静默继续

Ini:
部分:

[defaults]

键:

collections_on_ansible_version_mismatch

环境变量:
变量:

ANSIBLE_COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH

COLLECTIONS_PATHS

描述:

Ansible 将搜索集合内容的冒号分隔路径。集合必须在嵌套的子目录中,而不是直接在这些目录中。例如,如果 COLLECTIONS_PATHS 包含 '{{ ANSIBLE_HOME ~ "/collections" }}',并且您想将 my.collection 添加到该目录,则必须将其保存为 '{{ ANSIBLE_HOME ~ "/collections/ansible_collections/my/collection" }}'

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/collections:/usr/share/ansible/collections" }}

Ini:
部分:

[defaults]

键:

collections_path

添加版本:

2.10

环境变量:
变量:

ANSIBLE_COLLECTIONS_PATH

添加版本:

2.10

COLLECTIONS_SCAN_SYS_PATH

描述:

用于启用或禁用扫描 sys.path 以查找已安装集合的布尔值。

类型:

布尔值

默认值:

True

Ini:
部分:

[defaults]

键:

collections_scan_sys_path

环境变量:
变量:

ANSIBLE_COLLECTIONS_SCAN_SYS_PATH

COLOR_CHANGED

描述:

定义在“Changed”任务状态下使用的颜色。

默认值:

yellow

Ini:
部分:

[colors]

键:

changed

环境变量:
变量:

ANSIBLE_COLOR_CHANGED

COLOR_CONSOLE_PROMPT

描述:

定义用于 ansible-console 的默认颜色。

默认值:

white

添加版本:

2.7

Ini:
部分:

[colors]

键:

console_prompt

环境变量:
变量:

ANSIBLE_COLOR_CONSOLE_PROMPT

COLOR_DEBUG

描述:

定义发出调试消息时使用的颜色。

默认值:

dark gray

Ini:
部分:

[colors]

键:

debug

环境变量:
变量:

ANSIBLE_COLOR_DEBUG

COLOR_DEPRECATE

描述:

定义发出弃用消息时使用的颜色。

默认值:

purple

Ini:
部分:

[colors]

键:

deprecate

环境变量:
变量:

ANSIBLE_COLOR_DEPRECATE

COLOR_DIFF_ADD

描述:

定义在差异中显示添加的行时使用的颜色。

默认值:

green

Ini:
部分:

[colors]

键:

diff_add

环境变量:
变量:

ANSIBLE_COLOR_DIFF_ADD

COLOR_DIFF_LINES

描述:

定义显示差异时使用的颜色。

默认值:

cyan

Ini:
部分:

[colors]

键:

diff_lines

环境变量:
变量:

ANSIBLE_COLOR_DIFF_LINES

COLOR_DIFF_REMOVE

描述:

定义在差异中显示删除的行时使用的颜色。

默认值:

red

Ini:
部分:

[colors]

键:

diff_remove

环境变量:
变量:

ANSIBLE_COLOR_DIFF_REMOVE

COLOR_DOC_CONSTANT

描述:

定义在 ansible-doc 输出中发出常量时使用的颜色。

默认值:

dark gray

添加版本:

2.18

Ini:
部分:

[colors]

键:

doc_constant

环境变量:
变量:

ANSIBLE_COLOR_DOC_CONSTANT

COLOR_DOC_DEPRECATED

描述:

定义在 ansible-doc 输出中发出弃用值时使用的颜色。

默认值:

magenta

添加版本:

2.18

Ini:
部分:

[colors]

键:

doc_deprecated

环境变量:
变量:

ANSIBLE_COLOR_DOC_DEPRECATED

COLOR_DOC_MODULE

描述:

定义在 ansible-doc 输出中发出模块名称时使用的颜色。

默认值:

yellow

添加版本:

2.18

Ini:
部分:

[colors]

键:

doc_module

环境变量:
变量:

ANSIBLE_COLOR_DOC_MODULE

COLOR_DOC_PLUGIN

描述:

定义在 ansible-doc 输出中发出插件名称时使用的颜色。

默认值:

yellow

添加版本:

2.18

Ini:
部分:

[colors]

键:

doc_plugin

环境变量:
变量:

ANSIBLE_COLOR_DOC_PLUGIN

COLOR_DOC_REFERENCE

描述:

定义在 ansible-doc 输出中发出交叉引用时使用的颜色。

默认值:

magenta

添加版本:

2.18

Ini:
部分:

[colors]

键:

doc_reference

环境变量:
变量:

ANSIBLE_COLOR_DOC_REFERENCE

COLOR_ERROR

描述:

定义发出错误消息时使用的颜色。

默认值:

red

Ini:
部分:

[colors]

键:

error

环境变量:
变量:

ANSIBLE_COLOR_ERROR

COLOR_HIGHLIGHT

描述:

定义用于高亮的颜色。

默认值:

white

Ini:
部分:

[colors]

键:

highlight

环境变量:
变量:

ANSIBLE_COLOR_HIGHLIGHT

COLOR_INCLUDED

描述:

定义显示“Included”任务状态时使用的颜色。

默认值:

cyan

添加版本:

2.18

Ini:
部分:

[colors]

键:

included

环境变量:
变量:

ANSIBLE_COLOR_INCLUDED

COLOR_OK

描述:

定义显示“OK”任务状态时使用的颜色。

默认值:

green

Ini:
部分:

[colors]

键:

ok

环境变量:
变量:

ANSIBLE_COLOR_OK

COLOR_SKIP

描述:

定义显示“Skipped”任务状态时使用的颜色。

默认值:

cyan

Ini:
部分:

[colors]

键:

skip

环境变量:
变量:

ANSIBLE_COLOR_SKIP

COLOR_UNREACHABLE

描述:

定义在“Unreachable”状态下使用的颜色。

默认值:

bright red

Ini:
部分:

[colors]

键:

unreachable

环境变量:
变量:

ANSIBLE_COLOR_UNREACHABLE

COLOR_VERBOSE

描述:

定义发出详细消息时使用的颜色。换句话说,那些随 '-v' 显示的消息。

默认值:

blue

Ini:
部分:

[colors]

键:

verbose

环境变量:
变量:

ANSIBLE_COLOR_VERBOSE

COLOR_WARN

描述:

定义发出警告消息时使用的颜色。

默认值:

bright purple

Ini:
部分:

[colors]

键:

warn

环境变量:
变量:

ANSIBLE_COLOR_WARN

CONNECTION_FACTS_MODULES

描述:

基于连接在 Play 的事实收集阶段运行哪些模块

类型:

dict

默认值:

{'asa': 'ansible.legacy.asa_facts', 'cisco.asa.asa': 'cisco.asa.asa_facts', 'eos': 'ansible.legacy.eos_facts', 'arista.eos.eos': 'arista.eos.eos_facts', 'frr': 'ansible.legacy.frr_facts', 'frr.frr.frr': 'frr.frr.frr_facts', 'ios': 'ansible.legacy.ios_facts', 'cisco.ios.ios': 'cisco.ios.ios_facts', 'iosxr': 'ansible.legacy.iosxr_facts', 'cisco.iosxr.iosxr': 'cisco.iosxr.iosxr_facts', 'junos': 'ansible.legacy.junos_facts', 'junipernetworks.junos.junos': 'junipernetworks.junos.junos_facts', 'nxos': 'ansible.legacy.nxos_facts', 'cisco.nxos.nxos': 'cisco.nxos.nxos_facts', 'vyos': 'ansible.legacy.vyos_facts', 'vyos.vyos.vyos': 'vyos.vyos.vyos_facts', 'exos': 'ansible.legacy.exos_facts', 'extreme.exos.exos': 'extreme.exos.exos_facts', 'slxos': 'ansible.legacy.slxos_facts', 'extreme.slxos.slxos': 'extreme.slxos.slxos_facts', 'voss': 'ansible.legacy.voss_facts', 'extreme.voss.voss': 'extreme.voss.voss_facts', 'ironware': 'ansible.legacy.ironware_facts', 'community.network.ironware': 'community.network.ironware_facts'}

CONNECTION_PASSWORD_FILE

描述:

用于连接插件的密码文件。--connection-password-file

类型:

path

默认值:

None

添加版本:

2.12

Ini:
部分:

[defaults]

键:

connection_password_file

环境变量:
变量:

ANSIBLE_CONNECTION_PASSWORD_FILE

COVERAGE_REMOTE_OUTPUT

描述:

设置远程主机上生成覆盖率报告的输出目录。目前仅用于 PowerShell 模块的远程覆盖率。这仅供内部使用。

类型:

str

添加版本:

2.9

环境变量:
变量:

_ANSIBLE_COVERAGE_REMOTE_OUTPUT

变量:
name:

_ansible_coverage_remote_output

COVERAGE_REMOTE_PATHS

描述:

在远程主机上执行时,Ansible 控制器上要运行覆盖率的文件的路径列表。只有匹配路径通配符的文件才会收集其覆盖率。可以指定多个路径通配符,并用 : 分隔。目前仅用于 PowerShell 模块的远程覆盖率。这仅供内部使用。

类型:

str

默认值:

*

添加版本:

2.9

环境变量:
变量:

_ANSIBLE_COVERAGE_REMOTE_PATH_FILTER

DEFAULT_ACTION_PLUGIN_PATH

描述:

Ansible 将搜索操作插件的冒号分隔路径。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/action:/usr/share/ansible/plugins/action" }}

Ini:
部分:

[defaults]

键:

action_plugins

环境变量:
变量:

ANSIBLE_ACTION_PLUGINS

DEFAULT_ALLOW_UNSAFE_LOOKUPS

描述:

启用后,此选项允许查找插件(无论是在变量中用作 {{lookup('foo')}} 还是作为循环如 with_foo)返回未标记为“不安全”的数据。默认情况下,此类数据被标记为不安全,以防止模板引擎评估任何 jinja2 模板语言,因为这可能代表安全风险。提供此选项是为了允许向后兼容,但用户应首先考虑将 allow_unsafe=True 添加到任何可能包含可能在后期通过模板引擎运行的数据的查找中。

类型:

布尔值

默认值:

False

添加版本:

2.2.3

Ini:
部分:

[defaults]

键:

allow_unsafe_lookups

注意:

此配置现已弃用,并计划移除。您应该更新到当前的替代方案。

计划移除:

2.23

弃用原因:

此选项不再在 Ansible Core 代码库中使用。

当前的替代方案:

查找插件负责标记包含模板的字符串,以允许作为模板进行评估。

DEFAULT_ASK_PASS

描述:

这控制 Ansible Playbook 是否应提示输入登录密码。如果使用 SSH 密钥进行身份验证,您可能无需更改此设置。

类型:

布尔值

默认值:

False

Ini:
部分:

[defaults]

键:

ask_pass

环境变量:
变量:

ANSIBLE_ASK_PASS

DEFAULT_ASK_VAULT_PASS

描述:

这控制 Ansible Playbook 是否应提示输入 Vault 密码。

类型:

布尔值

默认值:

False

Ini:
部分:

[defaults]

键:

ask_vault_pass

环境变量:
变量:

ANSIBLE_ASK_VAULT_PASS

DEFAULT_BECOME

描述:

切换是否使用提权,允许您在登录后“成为”另一个用户。

类型:

布尔值

默认值:

False

Ini:
部分:

[privilege_escalation]

键:

become

环境变量:
变量:

ANSIBLE_BECOME

DEFAULT_BECOME_ASK_PASS

描述:

切换是否提示输入提权密码。

类型:

布尔值

默认值:

False

Ini:
部分:

[privilege_escalation]

键:

become_ask_pass

环境变量:
变量:

ANSIBLE_BECOME_ASK_PASS

DEFAULT_BECOME_EXE

描述:

用于提权的执行程序,否则 Ansible 将依赖 PATH。

默认值:

None

Ini:
部分:

[privilege_escalation]

键:

become_exe

环境变量:
变量:

ANSIBLE_BECOME_EXE

DEFAULT_BECOME_FLAGS

描述:

传递给提权执行程序的标志。

默认值:

Ini:
部分:

[privilege_escalation]

键:

become_flags

环境变量:
变量:

ANSIBLE_BECOME_FLAGS

DEFAULT_BECOME_METHOD

描述:

启用 become 时要使用的提权方法。

默认值:

sudo

Ini:
部分:

[privilege_escalation]

键:

become_method

环境变量:
变量:

ANSIBLE_BECOME_METHOD

DEFAULT_BECOME_USER

描述:

使用提权时您的登录/远程用户所“成为”的用户,大多数系统在未指定用户时将使用“root”。

默认值:

root

Ini:
部分:

[privilege_escalation]

键:

become_user

环境变量:
变量:

ANSIBLE_BECOME_USER

DEFAULT_CACHE_PLUGIN_PATH

描述:

Ansible 将搜索缓存插件的冒号分隔路径。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/cache:/usr/share/ansible/plugins/cache" }}

Ini:
部分:

[defaults]

键:

cache_plugins

环境变量:
变量:

ANSIBLE_CACHE_PLUGINS

DEFAULT_CALLBACK_PLUGIN_PATH

描述:

Ansible 将搜索回调插件的冒号分隔路径。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/callback:/usr/share/ansible/plugins/callback" }}

Ini:
部分:

[defaults]

键:

callback_plugins

环境变量:
变量:

ANSIBLE_CALLBACK_PLUGINS

DEFAULT_CLICONF_PLUGIN_PATH

描述:

Ansible 将搜索 Cliconf 插件的冒号分隔路径。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/cliconf:/usr/share/ansible/plugins/cliconf" }}

Ini:
部分:

[defaults]

键:

cliconf_plugins

环境变量:
变量:

ANSIBLE_CLICONF_PLUGINS

DEFAULT_CONNECTION_PLUGIN_PATH

描述:

Ansible 将搜索连接插件的冒号分隔路径。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/connection:/usr/share/ansible/plugins/connection" }}

Ini:
部分:

[defaults]

键:

connection_plugins

环境变量:
变量:

ANSIBLE_CONNECTION_PLUGINS

DEFAULT_DEBUG

描述:

切换 Ansible 中的调试输出。这是非常详细的,并可能阻碍多进程处理。尽管启用了 no_log 设置,调试输出也可能包含机密信息,这意味着不应在生产环境中使用调试模式。

类型:

布尔值

默认值:

False

Ini:
部分:

[defaults]

键:

debug

环境变量:
变量:

ANSIBLE_DEBUG

DEFAULT_EXECUTABLE

描述:

这指示用于生成 Shell 的命令,这是 Ansible 在目标机上执行需求所必需的。用户在 Shell 使用受限的极少数情况下可能需要更改此设置,但在大多数情况下,可以保持原样。

默认值:

/bin/sh

Ini:
部分:

[defaults]

键:

executable

环境变量:
变量:

ANSIBLE_EXECUTABLE

DEFAULT_FILTER_PLUGIN_PATH

描述:

Ansible 将搜索 Jinja2 过滤器插件的冒号分隔路径。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/filter:/usr/share/ansible/plugins/filter" }}

Ini:
部分:

[defaults]

键:

filter_plugins

环境变量:
变量:

ANSIBLE_FILTER_PLUGINS

DEFAULT_FORCE_HANDLERS

描述:

此选项控制即使在主机上发生故障,通知的处理器是否在该主机上运行。当为 false 时,如果主机上发生了故障,处理器将不会运行。这也可以按 Play 或在命令行上设置。有关更多详细信息,请参阅“处理器和故障”。

类型:

布尔值

默认值:

False

添加版本:

1.9.1

Ini:
部分:

[defaults]

键:

force_handlers

环境变量:
变量:

ANSIBLE_FORCE_HANDLERS

DEFAULT_FORKS

描述:

Ansible 用于在目标主机上执行任务的最大分支(进程)数。

类型:

整数

默认值:

5

Ini:
部分:

[defaults]

键:

forks

环境变量:
变量:

ANSIBLE_FORKS

DEFAULT_GATHERING

描述:

此设置控制事实收集(关于远程系统发现的事实)的默认策略。此选项对于希望节省事实收集时间的用户很有用。'smart' 和 'explicit' 都将使用缓存插件。

默认值:

implicit

选择:
  • implicit:

    除非设置了 ‘gather_facts: False’,否则缓存插件将被忽略,并且事实将按 Play 收集。

  • explicit:

    除非在 Play 中直接请求,否则不会收集事实。

  • smart:

    每个未发现事实的新主机都将被扫描,但如果同一主机在多个 Play 中被寻址,它在本次运行中将不会再次被联系。

添加版本:

1.6

Ini:
部分:

[defaults]

键:

gathering

环境变量:
变量:

ANSIBLE_GATHERING

DEFAULT_HASH_BEHAVIOUR

描述:

此设置控制 Ansible 如何处理字典变量(又称哈希、映射、关联数组)的重复定义。这不影响值为标量(整数、字符串)或数组的变量。警告,不建议更改此设置,因为它很脆弱,并且使您的内容(Play、角色、集合)不可移植,从而导致持续的困惑和误用。除非您认为绝对需要,否则不要更改此设置。我们建议避免重用变量名,并依靠 combine 过滤器以及 varsvarnames 查找来创建各个变量的合并版本。根据我们的经验,这很少需要,这标志着数据结构和 Play 中引入了太多的复杂性。对于某些用途,您还可以查看自定义 vars_plugins 以在输入时进行合并,甚至替换负责解析 host_vars/group_vars/ 目录的默认 host_group_vars。此设置的大多数用户仅对清单范围感兴趣,但设置本身会影响所有来源并使调试更加困难。官方示例仓库中的所有 Playbook 和角色都假定此设置使用默认值。将设置更改为 merge 适用于所有变量来源,但许多来源在内部仍会覆盖这些变量。例如,include_vars 将在更新 Ansible 之前在内部对变量进行去重,其中“最后定义的”会覆盖同一文件中之前的定义。Ansible 项目建议您在新项目中避免使用 ``merge``。 Ansible 开发人员打算最终弃用并删除此设置,但由于一些用户确实严重依赖它,因此保留了它。新项目应避免使用 ‘merge’

类型:

字符串

默认值:

replace

选择:
  • replace:

    任何定义不止一次的变量都会根据变量优先级规则进行覆盖(最高优先级获胜)。

  • merge:

    任何字典变量都将在不同的变量定义来源之间与新定义递归合并。

Ini:
部分:

[defaults]

键:

hash_behaviour

环境变量:
变量:

ANSIBLE_HASH_BEHAVIOUR

DEFAULT_HOST_LIST

描述:

Ansible 清单来源的逗号分隔列表

类型:

pathlist

默认值:

['/etc/ansible/hosts']

Ini:
部分:

[defaults]

键:

inventory

环境变量:
变量:

ANSIBLE_INVENTORY

DEFAULT_HTTPAPI_PLUGIN_PATH

描述:

Ansible 将搜索 HttpApi 插件的冒号分隔路径。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/httpapi:/usr/share/ansible/plugins/httpapi" }}

Ini:
部分:

[defaults]

键:

httpapi_plugins

环境变量:
变量:

ANSIBLE_HTTPAPI_PLUGINS

DEFAULT_INTERNAL_POLL_INTERVAL

描述:

这设置了 Ansible 内部进程相互轮询的间隔(以秒为单位)。较低的值可以通过额外的 CPU 负载来提高大型 Playbook 的性能。较高的值更适合在不需要 UI 响应能力但可能担心 CPU 使用率的自动化场景中使用 Ansible。默认值对应于 Ansible <= 2.1 中硬编码的值。

类型:

float

默认值:

0.001

添加版本:

2.2

Ini:
部分:

[defaults]

键:

internal_poll_interval

DEFAULT_INVENTORY_PLUGIN_PATH

描述:

Ansible 将搜索清单插件的冒号分隔路径。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/inventory:/usr/share/ansible/plugins/inventory" }}

Ini:
部分:

[defaults]

键:

inventory_plugins

环境变量:
变量:

ANSIBLE_INVENTORY_PLUGINS

DEFAULT_JINJA2_EXTENSIONS

描述:

这是一个特定于开发人员的功能,允许启用额外的 Jinja2 扩展。有关详细信息,请参阅 Jinja2 文档。如果您不知道这些做什么,您可能不需要更改此设置 :)

类型:

list

默认值:

[]

Ini:
部分:

[defaults]

键:

jinja2_extensions

环境变量:
变量:

ANSIBLE_JINJA2_EXTENSIONS

注意:

此配置现已弃用,并计划移除。您应该更新到当前的替代方案。

计划移除:

2.23

弃用原因:

Jinja2 扩展已被弃用

当前的替代方案:

Ansible 支持的 Jinja 插件(测试、过滤器、查找)

DEFAULT_JINJA2_NATIVE

描述:

此选项在模板操作期间保留变量类型。

类型:

布尔值

默认值:

True

添加版本:

2.7

Ini:
部分:

[defaults]

键:

jinja2_native

环境变量:
变量:

ANSIBLE_JINJA2_NATIVE

注意:

此配置现已弃用,并计划移除。您应该更新到当前的替代方案。

计划移除:

2.23

弃用原因:

此选项不再在 Ansible Core 代码库中使用。

当前的替代方案:

Jinja2 原生模式现在是默认且唯一的选项。

DEFAULT_KEEP_REMOTE_FILES

描述:

启用/禁用清理 Ansible 用于在远程执行任务的临时文件。如果启用了此选项,它将禁用 ANSIBLE_PIPELINING

类型:

布尔值

默认值:

False

Ini:
部分:

[defaults]

键:

keep_remote_files

环境变量:
变量:

ANSIBLE_KEEP_REMOTE_FILES

DEFAULT_LIBVIRT_LXC_NOSECLABEL

描述:

此设置导致 libvirt 通过将 --noseclabel 参数传递给 virsh 命令来连接到 LXC 容器。这在没有 SELinux 的系统上运行时是必需的。

类型:

布尔值

默认值:

False

添加版本:

2.1

Ini:
部分:

[selinux]

键:

libvirt_lxc_noseclabel

环境变量:
变量:

ANSIBLE_LIBVIRT_LXC_NOSECLABEL

注意:

此配置现已弃用,并计划移除。您应该更新到当前的替代方案。

计划移除:

2.22

弃用原因:

此选项已移至插件本身

当前的替代方案:

使用插件本身的选项。

DEFAULT_LOAD_CALLBACK_PLUGINS

描述:

控制在运行 /usr/bin/ansible 时是否加载回调插件。这可能用于从命令行记录活动、发送通知等。对于 ansible-playbook,回调插件始终会被加载。

类型:

布尔值

默认值:

False

添加版本:

1.8

Ini:
部分:

[defaults]

键:

bin_ansible_callbacks

环境变量:
变量:

ANSIBLE_LOAD_CALLBACK_PLUGINS

DEFAULT_LOCAL_TMP

描述:

Ansible 在控制器上使用的临时目录。

类型:

tmppath

默认值:

{{ ANSIBLE_HOME ~ "/tmp" }}

Ini:
部分:

[defaults]

键:

local_tmp

环境变量:
变量:

ANSIBLE_LOCAL_TEMP

DEFAULT_LOG_FILTER

描述:

要从日志文件中过滤掉的记录器名称列表。

类型:

list

默认值:

[]

Ini:
部分:

[defaults]

键:

log_filter

环境变量:
变量:

ANSIBLE_LOG_FILTER

DEFAULT_LOG_PATH

描述:

Ansible 在控制端记录日志的文件。未设置时,日志功能将被禁用。

类型:

path

默认值:

None

Ini:
部分:

[defaults]

键:

log_path

环境变量:
变量:

ANSIBLE_LOG_PATH

DEFAULT_LOOKUP_PLUGIN_PATH

描述:

Ansible 搜索查找插件(Lookup Plugins)的路径,以冒号分隔。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/lookup:/usr/share/ansible/plugins/lookup" }}

Ini:
部分:

[defaults]

键:

lookup_plugins

环境变量:
变量:

ANSIBLE_LOOKUP_PLUGINS

DEFAULT_MANAGED_STR

描述:

设置 ansible_collections.ansible.builtin.template_moduleansible_collections.ansible.windows.win_template_module 可用的 ‘ansible_managed’ 变量宏。此设置仅与这两个模块相关。

默认值:

Ansible managed

Ini:
部分:

[defaults]

键:

ansible_managed

注意:

此配置现已弃用,并计划移除。您应该更新到当前的替代方案。

计划移除:

2.23

弃用原因:

ansible_managed 变量可以像其他任何变量一样设置,或者也可以使用不同的变量。

当前的替代方案:

设置 ansible_managed 变量,或者在模板中使用任何自定义变量。

DEFAULT_MODULE_ARGS

描述:

如果没有指定 -a,则设置传递给 ansible 即席(adhoc)二进制文件的默认参数。

默认值:

None

Ini:
部分:

[defaults]

键:

module_args

环境变量:
变量:

ANSIBLE_MODULE_ARGS

DEFAULT_MODULE_COMPRESSION

描述:

向目标传输 Python 模块时使用的压缩方案。

默认值:

ZIP_DEFLATED

Ini:
部分:

[defaults]

键:

module_compression

变量:
name:

ansible_module_compression

DEFAULT_MODULE_NAME

描述:

如果未通过 -m 指定模块,则使用该模块执行 ansible 即席命令。

默认值:

command

Ini:
部分:

[defaults]

键:

module_name

DEFAULT_MODULE_PATH

描述:

Ansible 搜索模块的路径,以冒号分隔。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/modules:/usr/share/ansible/plugins/modules" }}

Ini:
部分:

[defaults]

键:

library

环境变量:
变量:

ANSIBLE_LIBRARY

DEFAULT_MODULE_UTILS_PATH

描述:

Ansible 搜索模块工具文件的路径,这些文件由各个模块共享,以冒号分隔。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/module_utils:/usr/share/ansible/plugins/module_utils" }}

Ini:
部分:

[defaults]

键:

module_utils

环境变量:
变量:

ANSIBLE_MODULE_UTILS

DEFAULT_NETCONF_PLUGIN_PATH

描述:

Ansible 搜索 Netconf 插件的路径,以冒号分隔。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/netconf:/usr/share/ansible/plugins/netconf" }}

Ini:
部分:

[defaults]

键:

netconf_plugins

环境变量:
变量:

ANSIBLE_NETCONF_PLUGINS

DEFAULT_NO_LOG

描述:

切换 Ansible 对任务细节的显示和记录,主要用于避免安全泄露。

类型:

布尔值

默认值:

False

Ini:
部分:

[defaults]

键:

no_log

环境变量:
变量:

ANSIBLE_NO_LOG

DEFAULT_NO_TARGET_SYSLOG

描述:

切换 Ansible 在目标主机执行任务时记录到系统日志(syslog)的行为。在 Windows 主机上,这将禁止较新样式的 PowerShell 模块写入事件日志。

类型:

布尔值

默认值:

False

Ini:
部分:

[defaults]

键:

no_target_syslog

环境变量:
变量:

ANSIBLE_NO_TARGET_SYSLOG

变量:
name:

ansible_no_target_syslog

添加版本:

2.10

DEFAULT_NULL_REPRESENTATION

描述:

模板处理应返回什么作为 ‘null’ 值。如果未设置,将由 Jinja2 决定。

类型:

raw

默认值:

None

Ini:
部分:

[defaults]

键:

null_representation

环境变量:
变量:

ANSIBLE_NULL_REPRESENTATION

注意:

此配置现已弃用,并计划移除。您应该更新到当前的替代方案。

计划移除:

2.23

弃用原因:

此选项不再在 Ansible Core 代码库中使用。

当前的替代方案:

目前没有替代方案。需要在当前代码库中实现一种不同的机制。

DEFAULT_POLL_INTERVAL

描述:

对于 Ansible 中的异步任务(参见异步操作和轮询),这是未明确提供轮询间隔时检查任务状态的频率。默认的 15 秒是一个适中的选择,平衡了检查频率与任务完成后的快速响应。

类型:

整数

默认值:

15

Ini:
部分:

[defaults]

键:

poll_interval

环境变量:
变量:

ANSIBLE_POLL_INTERVAL

DEFAULT_PRIVATE_KEY_FILE

描述:

对于使用证书或密钥文件进行身份验证(而非代理或密码)的连接,可以在此处设置默认值,以避免每次调用时都重复指定 --private-key

类型:

path

默认值:

None

Ini:
部分:

[defaults]

键:

private_key_file

环境变量:
变量:

ANSIBLE_PRIVATE_KEY_FILE

DEFAULT_PRIVATE_ROLE_VARS

描述:

默认情况下,导入的角色将其变量发布到 Play 和其他角色,此设置可以避免这种情况。引入此设置是为了在 Playbook 中多次使用同一角色时,将角色变量重置为默认值。从版本 ‘2.17’ 开始,M(ansible.builtin.include_roles) 和 M(ansible.builtin.import_roles) 可以通过 C(public) 参数单独覆盖此设置。与在 Playbook 编译时发生的导入角色不同,包含的角色仅在执行时将其变量公开。

类型:

布尔值

默认值:

False

Ini:
部分:

[defaults]

键:

private_role_vars

环境变量:
变量:

ANSIBLE_PRIVATE_ROLE_VARS

DEFAULT_REMOTE_PORT

描述:

远程连接中使用的端口,若为空,则使用连接插件的默认值。

类型:

整数

默认值:

None

Ini:
部分:

[defaults]

键:

remote_port

环境变量:
变量:

ANSIBLE_REMOTE_PORT

DEFAULT_REMOTE_USER

描述:

设置目标机器的登录用户。若为空,则使用连接插件的默认值,通常是当前执行 Ansible 的用户。

Ini:
部分:

[defaults]

键:

remote_user

环境变量:
变量:

ANSIBLE_REMOTE_USER

DEFAULT_ROLES_PATH

描述:

Ansible 搜索角色的路径,以冒号分隔。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/roles:/usr/share/ansible/roles:/etc/ansible/roles" }}

Ini:
部分:

[defaults]

键:

roles_path

环境变量:
变量:

ANSIBLE_ROLES_PATH

DEFAULT_SELINUX_SPECIAL_FS

描述:

某些文件系统不支持安全操作和/或返回不一致的错误,此设置使 Ansible “容忍”列表中列出的文件系统,而不导致致命错误。当文件系统在列表中时,可能会发生数据损坏,且写入操作并不总是经过验证。

类型:

list

默认值:

['fuse', 'nfs', 'vboxsf', 'ramfs', '9p', 'vfat']

Ini:
部分:

[selinux]

键:

special_context_filesystems

环境变量:
变量:

ANSIBLE_SELINUX_SPECIAL_FS

添加版本:

2.9

DEFAULT_STDOUT_CALLBACK

描述:

设置用于显示 Ansible 输出的主回调。一次只能设置一个。你可以拥有许多其他回调,但只有一个可以负责标准输出(stdout)。有关可用选项的列表,请参阅 回调插件

默认值:

default

Ini:
部分:

[defaults]

键:

stdout_callback

环境变量:
变量:

ANSIBLE_STDOUT_CALLBACK

DEFAULT_STRATEGY

描述:

设置 Play 使用的默认策略。

默认值:

linear

添加版本:

2.3

Ini:
部分:

[defaults]

键:

strategy

环境变量:
变量:

ANSIBLE_STRATEGY

DEFAULT_STRATEGY_PLUGIN_PATH

描述:

Ansible 搜索策略插件的路径,以冒号分隔。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/strategy:/usr/share/ansible/plugins/strategy" }}

Ini:
部分:

[defaults]

键:

strategy_plugins

环境变量:
变量:

ANSIBLE_STRATEGY_PLUGINS

DEFAULT_SU

描述:

切换任务是否使用 “su”。

类型:

布尔值

默认值:

False

Ini:
部分:

[defaults]

键:

su

环境变量:
变量:

ANSIBLE_SU

DEFAULT_SYSLOG_FACILITY

描述:

Ansible 记录到远程目标时要使用的 Syslog 设施。

默认值:

LOG_USER

Ini:
部分:

[defaults]

键:

syslog_facility

环境变量:
变量:

ANSIBLE_SYSLOG_FACILITY

DEFAULT_TERMINAL_PLUGIN_PATH

描述:

Ansible 搜索终端插件的路径,以冒号分隔。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/terminal:/usr/share/ansible/plugins/terminal" }}

Ini:
部分:

[defaults]

键:

terminal_plugins

环境变量:
变量:

ANSIBLE_TERMINAL_PLUGINS

DEFAULT_TEST_PLUGIN_PATH

描述:

Ansible 搜索 Jinja2 测试插件的路径,以冒号分隔。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/test:/usr/share/ansible/plugins/test" }}

Ini:
部分:

[defaults]

键:

test_plugins

环境变量:
变量:

ANSIBLE_TEST_PLUGINS

DEFAULT_TIMEOUT

描述:

这是连接插件使用的默认超时时间。

类型:

整数

默认值:

10

Ini:
部分:

[defaults]

键:

timeout

环境变量:
变量:

ANSIBLE_TIMEOUT

DEFAULT_TRANSPORT

描述:

可以是你的 Ansible 安装中可用的任何连接插件。

默认值:

ssh

Ini:
部分:

[defaults]

键:

transport

环境变量:
变量:

ANSIBLE_TRANSPORT

DEFAULT_UNDEFINED_VAR_BEHAVIOR

描述:

若为 True,则会导致 Ansible 模板在引用拼写错误的变量名时失败。否则,任何包含未定义变量的 ‘{{ template_expression }}’ 都将按原样呈现在模板或 Ansible 操作行中。

类型:

布尔值

默认值:

True

添加版本:

1.3

Ini:
部分:

[defaults]

键:

error_on_undefined_vars

环境变量:
变量:

ANSIBLE_ERROR_ON_UNDEFINED_VARS

注意:

此配置现已弃用,并计划移除。您应该更新到当前的替代方案。

计划移除:

2.23

弃用原因:

此选项不再在 Ansible Core 代码库中使用。

当前的替代方案:

目前没有替代方案。需要在当前代码库中实现一种不同的机制。

DEFAULT_VARS_PLUGIN_PATH

描述:

Ansible 搜索变量插件的路径,以冒号分隔。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/vars:/usr/share/ansible/plugins/vars" }}

Ini:
部分:

[defaults]

键:

vars_plugins

环境变量:
变量:

ANSIBLE_VARS_PLUGINS

DEFAULT_VAULT_ENCRYPT_IDENTITY

描述:

默认用于加密的 vault_id。如果提供了多个 vault_ids,这指定了用于加密的一个。CLI 选项 --encrypt-vault-id 会覆盖配置的值。

Ini:
部分:

[defaults]

键:

vault_encrypt_identity

环境变量:
变量:

ANSIBLE_VAULT_ENCRYPT_IDENTITY

DEFAULT_VAULT_ID_MATCH

描述:

如果为 True,使用 vault id 解密 vault 时将仅尝试使用来自匹配 vault-id 的密码。

默认值:

False

Ini:
部分:

[defaults]

键:

vault_id_match

环境变量:
变量:

ANSIBLE_VAULT_ID_MATCH

DEFAULT_VAULT_IDENTITY

描述:

在未提供 vault id 标签的情况下,用于默认 vault id 标签的标签名称。

默认值:

default

Ini:
部分:

[defaults]

键:

vault_identity

环境变量:
变量:

ANSIBLE_VAULT_IDENTITY

DEFAULT_VAULT_IDENTITY_LIST

描述:

默认使用的 vault-ids 列表。等同于多个 --vault-id 参数。Vault-ids 将按顺序尝试使用。

类型:

list

默认值:

[]

Ini:
部分:

[defaults]

键:

vault_identity_list

环境变量:
变量:

ANSIBLE_VAULT_IDENTITY_LIST

DEFAULT_VAULT_PASSWORD_FILE

描述:

要使用的 vault 密码文件。等同于 --vault-password-file--vault-id。如果文件是可执行的,它将被运行,其生成的标准输出(stdout)将用作密码。

类型:

path

默认值:

None

Ini:
部分:

[defaults]

键:

vault_password_file

环境变量:
变量:

ANSIBLE_VAULT_PASSWORD_FILE

DEFAULT_VERBOSITY

描述:

设置默认的详细级别,等同于在命令行中传递的 -v 的数量。

类型:

整数

默认值:

0

Ini:
部分:

[defaults]

键:

verbosity

环境变量:
变量:

ANSIBLE_VERBOSITY

DEPRECATION_WARNINGS

描述:

用于控制是否显示弃用警告的切换开关。

类型:

布尔值

默认值:

True

Ini:
部分:

[defaults]

键:

deprecation_warnings

环境变量:
变量:

ANSIBLE_DEPRECATION_WARNINGS

变量:
name:

ansible_deprecation_warnings

添加版本:

2.19

DEVEL_WARNING

描述:

用于控制是否显示与运行开发版(devel)相关的警告的切换开关。

类型:

布尔值

默认值:

True

Ini:
部分:

[defaults]

键:

devel_warning

环境变量:
变量:

ANSIBLE_DEVEL_WARNING

DIFF_ALWAYS

描述:

配置切换开关,告诉模块在处于 ‘changed’(已更改)状态时显示差异,等同于 --diff

类型:

bool

默认值:

False

Ini:
部分:

[diff]

键:

always

环境变量:
变量:

ANSIBLE_DIFF_ALWAYS

DIFF_CONTEXT

描述:

显示文件间差异时要展示的上下文行数。

类型:

整数

默认值:

3

Ini:
部分:

[diff]

键:

context

环境变量:
变量:

ANSIBLE_DIFF_CONTEXT

DISPLAY_ARGS_TO_STDOUT

描述:

通常 ansible-playbook 会为运行的每个任务打印一个标题。如果你指定了任务中的 name 字段,这些标题将包含该字段。如果没有指定,ansible-playbook 会使用任务的动作来帮助你识别当前正在运行的任务。有时你运行许多相同的动作,因此你可能需要关于任务的更多信息,以便将其与相同动作的其他任务区分开来。如果将此变量设置为 True,则 ansible-playbook 也将在标题中包含任务的参数。此设置默认设为 False,因为你的参数中可能包含敏感值,而你不希望打印这些值。如果将其设置为 True,你应该确保你已保护好环境的 stdout(没有人能窥视你的屏幕,且你没有将 stdout 保存到不安全的文件中),或者确保你所有的 Playbook 都已对包含敏感值的任务显式添加了 no_log: True 参数。有关详细信息,请参阅 如何在 Playbook 中保留秘密数据?

类型:

布尔值

默认值:

False

添加版本:

2.1

Ini:
部分:

[defaults]

键:

display_args_to_stdout

环境变量:
变量:

ANSIBLE_DISPLAY_ARGS_TO_STDOUT

DISPLAY_SKIPPED_HOSTS

描述:

用于控制在默认回调中是否显示任务中跳过的任务/主机条目的切换开关。

类型:

布尔值

默认值:

True

Ini:
部分:

[defaults]

键:

display_skipped_hosts

环境变量:
变量:

ANSIBLE_DISPLAY_SKIPPED_HOSTS

DISPLAY_TRACEBACK

描述:

何时在扩展错误消息中包含回溯信息。

类型:

list

默认值:

['never']

选择:
  • error

  • warning

  • deprecated

  • deprecated_value

  • always

  • never

添加版本:

2.19

Ini:
部分:

[defaults]

键:

display_traceback

环境变量:
变量:

ANSIBLE_DISPLAY_TRACEBACK

DOC_FRAGMENT_PLUGIN_PATH

描述:

Ansible 搜索文档片段插件的路径,以冒号分隔。

类型:

pathspec

默认值:

{{ ANSIBLE_HOME ~ "/plugins/doc_fragments:/usr/share/ansible/plugins/doc_fragments" }}

Ini:
部分:

[defaults]

键:

doc_fragment_plugins

环境变量:
变量:

ANSIBLE_DOC_FRAGMENT_PLUGINS

DOCSITE_ROOT_URL

描述:

用于生成警告/错误文本中文档 URL 的根文档站点 URL;必须是具有有效方案和尾随斜杠的绝对 URL。

默认值:

https://docs.ansible.org.cn/ansible-core/

添加版本:

2.8

Ini:
部分:

[defaults]

键:

docsite_root_url

DUPLICATE_YAML_DICT_KEY

描述:

默认情况下,当在 YAML 中遇到重复的字典键时,Ansible 会发出警告。可以通过将此设置调整为 False 来消除这些警告。

类型:

字符串

默认值:

warn

选择:
  • error:

    发出“致命”错误并停止 Play

  • warn:

    发出警告但继续

  • ignore:

    静默继续

添加版本:

2.9

Ini:
部分:

[defaults]

键:

duplicate_dict_key

环境变量:
变量:

ANSIBLE_DUPLICATE_YAML_DICT_KEY

EDITOR

描述:

对于 Ansible 需要在编辑器中返回文件的情况,此项选择要使用的应用程序。

默认值:

vi

Ini:
部分:

[defaults]

键:

editor

添加版本:

2.15

环境变量:

ENABLE_TASK_DEBUGGER

描述:

是否启用任务调试器。这以前是作为策略插件完成的。现在所有策略插件都可以继承此行为。调试器默认在任务因无法访问而失败时激活。使用 debugger 关键字以获得更大的灵活性。

类型:

布尔值

默认值:

False

添加版本:

2.5

Ini:
部分:

[defaults]

键:

enable_task_debugger

环境变量:
变量:

ANSIBLE_ENABLE_TASK_DEBUGGER

ERROR_ON_MISSING_HANDLER

描述:

切换开关,允许在通知时缺失的处理程序成为警告而不是错误。

类型:

布尔值

默认值:

True

Ini:
部分:

[defaults]

键:

error_on_missing_handler

环境变量:
变量:

ANSIBLE_ERROR_ON_MISSING_HANDLER

FACTS_MODULES

描述:

在 Play 的事实收集阶段运行哪些模块。使用默认的 ‘smart’ 将尝试根据连接类型找出答案。如果你添加了自己的模块,但仍想使用默认的 Ansible 事实,你需要将 ‘setup’ 或相应的网络模块包含在列表中(如果你添加 ‘smart’,Ansible 也会找出答案)。这不会影响对 ‘setup’ 模块的显式调用,但总是会影响 ‘gather_facts’ 操作(隐式或显式)。

类型:

list

默认值:

['smart']

Ini:
部分:

[defaults]

键:

facts_modules

环境变量:
变量:

ANSIBLE_FACTS_MODULES

变量:
name:

ansible_facts_modules

GALAXY_CACHE_DIR

描述:

存储来自 Galaxy 服务器的缓存响应的目录。这仅由 ansible-galaxy collection installdownload 命令使用。如果此目录内的缓存文件是全局可写的,它们将被忽略。

类型:

path

默认值:

{{ ANSIBLE_HOME ~ "/galaxy_cache" }}

添加版本:

2.11

Ini:
部分:

[galaxy]

键:

cache_dir

环境变量:
变量:

ANSIBLE_GALAXY_CACHE_DIR

GALAXY_COLLECTION_IMPORT_POLL_FACTOR

描述:

检查集合导入状态时,用于增加 GALAXY_COLLECTION_IMPORT_POLL_INTERVAL 的乘数。

类型:

float

默认值:

1.5

添加版本:

2.18

环境变量:
变量:

ANSIBLE_GALAXY_COLLECTION_IMPORT_POLL_FACTOR

GALAXY_COLLECTION_IMPORT_POLL_INTERVAL

描述:

轮询集合导入状态的初始间隔(以秒为单位)。此间隔根据 GALAXY_COLLECTION_IMPORT_POLL_FACTOR 指数级增加,最大延迟为 30 秒。

类型:

float

默认值:

2.0

添加版本:

2.18

环境变量:
变量:

ANSIBLE_GALAXY_COLLECTION_IMPORT_POLL_INTERVAL

GALAXY_COLLECTION_SKELETON

描述:

用作 ansible-galaxy collectioninit 操作模板的集合骨架目录,与 --collection-skeleton 相同。

类型:

path

Ini:
部分:

[galaxy]

键:

collection_skeleton

环境变量:
变量:

ANSIBLE_GALAXY_COLLECTION_SKELETON

GALAXY_COLLECTION_SKELETON_IGNORE

描述:

Galaxy 集合骨架目录中要忽略的文件模式。

类型:

list

默认值:

['^.git$', '^.*/.git_keep$']

Ini:
部分:

[galaxy]

键:

collection_skeleton_ignore

环境变量:
变量:

ANSIBLE_GALAXY_COLLECTION_SKELETON_IGNORE

GALAXY_COLLECTIONS_PATH_WARNING

描述:

ansible-galaxy collection install 是否应针对配置的 COLLECTIONS_PATHS 中缺失 --collections-path 发出警告。

类型:

bool

默认值:

True

添加版本:

2.16

Ini:
部分:

[galaxy]

键:

collections_path_warning

环境变量:
变量:

ANSIBLE_GALAXY_COLLECTIONS_PATH_WARNING

GALAXY_DISABLE_GPG_VERIFY

描述:

在集合安装期间禁用 GPG 签名验证。

类型:

bool

默认值:

False

添加版本:

2.13

Ini:
部分:

[galaxy]

键:

disable_gpg_verify

环境变量:
变量:

ANSIBLE_GALAXY_DISABLE_GPG_VERIFY

GALAXY_DISPLAY_PROGRESS

描述:

ansible-galaxy 中的某些步骤会显示进度轮,这在某些显示器或将标准输出输出到文件时可能会导致问题。此配置选项控制是否显示进度轮。默认情况下,如果标准输出是终端(tty),则会显示进度轮。

类型:

bool

默认值:

None

添加版本:

2.10

Ini:
部分:

[galaxy]

键:

display_progress

环境变量:
变量:

ANSIBLE_GALAXY_DISPLAY_PROGRESS

GALAXY_GPG_KEYRING

描述:

配置在集合安装和验证期间用于 GPG 签名验证的密钥环。

类型:

path

添加版本:

2.13

Ini:
部分:

[galaxy]

键:

gpg_keyring

环境变量:
变量:

ANSIBLE_GALAXY_GPG_KEYRING

GALAXY_IGNORE_CERTS

描述:

如果设置为 yes,ansible-galaxy 将不会验证 TLS 证书。这对于针对带有自签名证书的服务器进行测试非常有用。

类型:

布尔值

Ini:
部分:

[galaxy]

键:

ignore_certs

环境变量:
变量:

ANSIBLE_GALAXY_IGNORE

GALAXY_IGNORE_INVALID_SIGNATURE_STATUS_CODES

描述:

GPG 签名验证期间要忽略的 GPG 状态代码列表。有关状态代码描述,请参阅 L(https://github.com/gpg/gnupg/blob/master/doc/DETAILS#general-status-codes)。如果成功验证集合的签名数少于 GALAXY_REQUIRED_VALID_SIGNATURE_COUNT,即使所有错误代码都被忽略,签名验证也会失败。

类型:

list

选择:
  • EXPSIG

  • EXPKEYSIG

  • REVKEYSIG

  • BADSIG

  • ERRSIG

  • NO_PUBKEY

  • MISSING_PASSPHRASE

  • BAD_PASSPHRASE

  • NODATA

  • UNEXPECTED

  • ERROR

  • FAILURE

  • BADARMOR

  • KEYEXPIRED

  • KEYREVOKED

  • NO_SECKEY

Ini:
部分:

[galaxy]

键:

ignore_signature_status_codes

环境变量:
变量:

ANSIBLE_GALAXY_IGNORE_SIGNATURE_STATUS_CODES

GALAXY_REQUIRED_VALID_SIGNATURE_COUNT

描述:

安装或验证集合时,在 GPG 签名验证期间必须成功的签名数量。这应该是一个正整数,或者使用 ‘all’ 来表示所有签名都必须成功验证集合。在值前添加 +,如果未找到集合的有效签名,则失败。

类型:

str

默认值:

1

Ini:
部分:

[galaxy]

键:

required_valid_signature_count

环境变量:
变量:

ANSIBLE_GALAXY_REQUIRED_VALID_SIGNATURE_COUNT

GALAXY_ROLE_SKELETON

描述:

用作 ansible-galaxy/ansible-galaxy roleinit 操作模板的角色骨架目录,与 --role-skeleton 相同。

类型:

path

Ini:
部分:

[galaxy]

键:

role_skeleton

环境变量:
变量:

ANSIBLE_GALAXY_ROLE_SKELETON

GALAXY_ROLE_SKELETON_IGNORE

描述:

Galaxy 角色或集合骨架目录中要忽略的文件模式。

类型:

list

默认值:

['^.git$', '^.*/.git_keep$']

Ini:
部分:

[galaxy]

键:

role_skeleton_ignore

环境变量:
变量:

ANSIBLE_GALAXY_ROLE_SKELETON_IGNORE

GALAXY_SERVER

描述:

当角色未指定完整 URI 时要预置的 URL,假设它们将此服务器作为来源。

默认值:

https://galaxy.ansible.com

Ini:
部分:

[galaxy]

键:

server

环境变量:
变量:

ANSIBLE_GALAXY_SERVER

GALAXY_SERVER_LIST

描述:

安装集合时要使用的 Galaxy 服务器列表。该值对应于定义服务器详细信息的 config ini 标题 [galaxy_server.{{item}}]。有关如何定义 Galaxy 服务器的更多详细信息,请参阅 配置 ansible-galaxy 客户端。此列表中服务器的顺序用于决定解析集合的顺序。设置此配置选项将忽略 GALAXY_SERVER 配置选项。

类型:

list

添加版本:

2.9

Ini:
部分:

[galaxy]

键:

server_list

环境变量:
变量:

ANSIBLE_GALAXY_SERVER_LIST

GALAXY_SERVER_TIMEOUT

描述:

Galaxy API 调用的默认超时时间。未配置特定超时的 Galaxy 服务器将回退到此值。

类型:

int

默认值:

60

Ini:
部分:

[galaxy]

键:

server_timeout

环境变量:
变量:

ANSIBLE_GALAXY_SERVER_TIMEOUT

GALAXY_TOKEN_PATH

描述:

Galaxy 访问令牌文件的本地路径。

类型:

path

默认值:

{{ ANSIBLE_HOME ~ "/galaxy_token" }}

添加版本:

2.9

Ini:
部分:

[galaxy]

键:

token_path

环境变量:
变量:

ANSIBLE_GALAXY_TOKEN_PATH

HOST_KEY_CHECKING

描述:

如果你想避免 Ansible 用于连接主机的底层连接插件进行主机密钥检查,请将其设置为 “False”。请阅读所使用的特定连接插件的文档以获取详细信息。

类型:

布尔值

默认值:

True

Ini:
部分:

[defaults]

键:

host_key_checking

环境变量:
变量:

ANSIBLE_HOST_KEY_CHECKING

HOST_PATTERN_MISMATCH

描述:

此设置更改不匹配主机模式的行为,它允许你强制执行致命错误、发出警告或直接忽略它。

默认值:

warning

选择:
  • error:

    发出“致命”错误并停止 Play

  • warning:

    发出警告但继续

  • ignore:

    静默继续

添加版本:

2.8

Ini:
部分:

[inventory]

键:

host_pattern_mismatch

环境变量:
变量:

ANSIBLE_HOST_PATTERN_MISMATCH

INJECT_FACTS_AS_VARS

描述:

事实在 ansible_facts 变量中可用,此设置也将它们作为自己的变量推送到主命名空间中。与在 ansible_facts 字典内部删除了前缀 ansible_ 不同,这些变量将具有模块返回的确切名称。

类型:

布尔值

默认值:

True

添加版本:

2.5

Ini:
部分:

[defaults]

键:

inject_facts_as_vars

环境变量:
变量:

ANSIBLE_INJECT_FACT_VARS

INJECT_INVOCATION

描述:

启用后,将会在任务结果中添加一个 invocation 键,其中包含所使用的模块/动作参数。大多数回调插件默认在任务结果显示中屏蔽 invocation 键。

类型:

布尔值

默认值:

False

添加版本:

2.21

Ini:
部分:

[defaults]

键:

interpreter_python

环境变量:
变量:

ANSIBLE_INJECT_INVOCATION

变量:
name:

ansible_inject_invocation

INTERPRETER_PYTHON

描述:

用于在远程目标上执行模块的 Python 解释器的路径,或自动发现模式。支持的发现模式有 auto(默认)和 auto_silent。所有发现模式都会针对已知 Python 解释器位置的有序列表进行匹配。回退行为将发出一个应显式设置解释器的警告(因为稍后安装的解释器可能会改变所使用的那个)。可以通过设置 auto_silent 来禁用此警告行为。auto_legacy* 模式已被移除。它们的存在是为了向后兼容较旧的 Ansible 版本,这些版本总是默认为 /usr/bin/python3,如果存在,将使用该解释器。

默认值:

auto

添加版本:

2.8

Ini:
部分:

[defaults]

键:

interpreter_python

环境变量:
变量:

ANSIBLE_PYTHON_INTERPRETER

变量:
name:

ansible_python_interpreter

INTERPRETER_PYTHON_FALLBACK

类型:

list

默认值:

['python3.14', 'python3.13', 'python3.12', 'python3.11', 'python3.10', 'python3.9', '/usr/bin/python3', 'python3']

添加版本:

2.8

变量:
name:

ansible_interpreter_python_fallback

INVALID_TASK_ATTRIBUTE_FAILED

描述:

如果为 ‘false’,任务的无效属性将导致警告而不是错误。

类型:

布尔值

默认值:

True

添加版本:

2.7

Ini:
部分:

[defaults]

键:

invalid_task_attribute_failed

环境变量:
变量:

ANSIBLE_INVALID_TASK_ATTRIBUTE_FAILED

INVENTORY_ANY_UNPARSED_IS_FAILED

描述:

如果为 ‘true’,当任何给定的清单(inventory)源不能被任何可用的清单插件成功解析时,这都是一个致命错误;否则,这种情况只会引发警告。

类型:

布尔值

默认值:

False

添加版本:

2.7

Ini:
部分:

[inventory]

键:

any_unparsed_is_failed

环境变量:
变量:

ANSIBLE_INVENTORY_ANY_UNPARSED_IS_FAILED

INVENTORY_ENABLED

描述:

已启用的清单插件列表,它也决定了它们被使用的顺序。

类型:

list

默认值:

['host_list', 'script', 'auto', 'yaml', 'ini', 'toml']

Ini:
部分:

[inventory]

键:

enable_plugins

环境变量:
变量:

ANSIBLE_INVENTORY_ENABLED

INVENTORY_EXPORT

描述:

控制 ansible-inventory 是准确反映 Ansible 对清单的视图,还是针对导出进行了优化。

类型:

bool

默认值:

False

Ini:
部分:

[inventory]

键:

export

环境变量:
变量:

ANSIBLE_INVENTORY_EXPORT

INVENTORY_IGNORE_EXTS

描述:

当使用目录作为清单源时要忽略的扩展名列表。

类型:

list

默认值:

{{ REJECT_EXTS + ['.orig', '.cfg', '.retry'] }}

Ini:
  • 部分:

    [defaults]

    键:

    inventory_ignore_extensions

  • 部分:

    [inventory]

    键:

    ignore_extensions

环境变量:
变量:

ANSIBLE_INVENTORY_IGNORE

INVENTORY_IGNORE_PATTERNS

描述:

当使用目录作为清单源时要忽略的模式列表。

类型:

list

默认值:

[]

Ini:
  • 部分:

    [defaults]

    键:

    inventory_ignore_patterns

  • 部分:

    [inventory]

    键:

    ignore_patterns

环境变量:
变量:

ANSIBLE_INVENTORY_IGNORE_REGEX

INVENTORY_UNPARSED_IS_FAILED

描述:

如果为 ‘true’,则如果每一个潜在的清单源都无法解析,这是一个致命错误,否则这种情况只会引发警告。

类型:

bool

默认值:

False

Ini:
部分:

[inventory]

键:

unparsed_is_failed

环境变量:
变量:

ANSIBLE_INVENTORY_UNPARSED_FAILED

INVENTORY_UNPARSED_WARNING

描述:

默认情况下,当未加载任何清单时,Ansible 会发出警告,并指出它将使用隐式的仅 localhost 清单。可以通过将此设置调整为 False 来消除这些警告。

类型:

布尔值

默认值:

True

添加版本:

2.14

Ini:
部分:

[inventory]

键:

inventory_unparsed_warning

环境变量:
变量:

ANSIBLE_INVENTORY_UNPARSED_WARNING

LOCALHOST_WARNING

描述:

默认情况下,当清单中没有主机时,Ansible 会发出警告。可以通过将此设置调整为 False 来消除这些警告。

类型:

布尔值

默认值:

True

添加版本:

2.6

Ini:
部分:

[defaults]

键:

localhost_warning

环境变量:
变量:

ANSIBLE_LOCALHOST_WARNING

LOG_VERBOSITY

描述:

如果该值高于正常的显示详细级别,这将设置日志详细级别,否则将与该级别相匹配。

类型:

int

添加版本:

2.17

Ini:
部分:

[defaults]

键:

log_verbosity

环境变量:
变量:

ANSIBLE_LOG_VERBOSITY

MAX_FILE_SIZE_FOR_DIFF

描述:

用于差异显示的文件的最大大小。

类型:

int

默认值:

104448

Ini:
部分:

[defaults]

键:

max_diff_size

环境变量:
变量:

ANSIBLE_MAX_DIFF_SIZE

MODULE_IGNORE_EXTS

描述:

寻找要加载的模块时要忽略的扩展名列表。这是为了拒绝脚本和二进制模块的回退扩展名。

类型:

list

默认值:

{{ REJECT_EXTS + ['.yaml', '.yml', '.ini'] }}

Ini:
部分:

[defaults]

键:

module_ignore_exts

环境变量:
变量:

ANSIBLE_MODULE_IGNORE_EXTS

MODULE_STRICT_UTF8_RESPONSE

描述:

启用是否评估模块响应以包含非 UTF-8 数据。禁用此选项可能会导致意外行为。只有 ansible-core 应该评估此配置。

类型:

bool

默认值:

True

Ini:
部分:

[defaults]

键:

module_strict_utf8_response

环境变量:
变量:

ANSIBLE_MODULE_STRICT_UTF8_RESPONSE

NETCONF_SSH_CONFIG

描述:

此变量用于通过 netconf 连接启用堡垒机/跳转主机。如果设置为 True,堡垒机/跳转主机 ssh 设置应存在于 ~/.ssh/config 文件中;或者,也可以将其设置为自定义 ssh 配置文件路径以读取堡垒机/跳转主机设置。

默认值:

None

Ini:
部分:

[netconf_connection]

键:

ssh_config

环境变量:
变量:

ANSIBLE_NETCONF_SSH_CONFIG

NETWORK_GROUP_MODULES

类型:

list

默认值:

['eos', 'nxos', 'ios', 'iosxr', 'junos', 'enos', 'ce', 'vyos', 'sros', 'dellos9', 'dellos10', 'dellos6', 'asa', 'aruba', 'aireos', 'bigip', 'ironware', 'onyx', 'netconf', 'exos', 'voss', 'slxos']

Ini:
部分:

[defaults]

键:

network_group_modules

环境变量:
变量:

ANSIBLE_NETWORK_GROUP_MODULES

OLD_PLUGIN_CACHE_CLEARING

描述:

以前 Ansible 在加载新角色时只会清除部分插件加载缓存,这导致在之前 Play 中加载的插件会被意外地“粘住”。此设置允许用户返回到该行为。

类型:

布尔值

默认值:

False

添加版本:

2.8

Ini:
部分:

[defaults]

键:

old_plugin_cache_clear

环境变量:
变量:

ANSIBLE_OLD_PLUGIN_CACHE_CLEAR

PAGER

描述:

对于 Ansible 需要以可分页方式返回输出的情况,此项选择要使用的应用程序。

默认值:

less

Ini:
部分:

[defaults]

键:

pager

添加版本:

2.15

环境变量:

PERSISTENT_COMMAND_TIMEOUT

描述:

这控制在中断持久连接之前,等待远程设备响应的时间量。

类型:

int

默认值:

30

Ini:
部分:

[persistent_connection]

键:

command_timeout

环境变量:
变量:

ANSIBLE_PERSISTENT_COMMAND_TIMEOUT

PERSISTENT_CONNECT_RETRY_TIMEOUT

描述:

这控制持久连接尝试连接到本地域套接字的重试超时时间。

类型:

整数

默认值:

15

Ini:
部分:

[persistent_connection]

键:

connect_retry_timeout

环境变量:
变量:

ANSIBLE_PERSISTENT_CONNECT_RETRY_TIMEOUT

PERSISTENT_CONNECT_TIMEOUT

描述:

这控制持久连接在被销毁前保持空闲的时间。

类型:

整数

默认值:

30

Ini:
部分:

[persistent_connection]

键:

connect_timeout

环境变量:
变量:

ANSIBLE_PERSISTENT_CONNECT_TIMEOUT

PERSISTENT_CONTROL_PATH_DIR

描述:

连接持久化系统使用的套接字路径。

类型:

path

默认值:

{{ ANSIBLE_HOME ~ "/pc" }}

Ini:
部分:

[persistent_connection]

键:

control_path_dir

环境变量:
变量:

ANSIBLE_PERSISTENT_CONTROL_PATH_DIR

PLAYBOOK_DIR

描述:

许多非 Playbook CLI 都有一个 --playbook-dir 参数;此项设置其默认值。

类型:

path

添加版本:

2.9

Ini:
部分:

[defaults]

键:

playbook_dir

环境变量:
变量:

ANSIBLE_PLAYBOOK_DIR

PLAYBOOK_VARS_ROOT

描述:

这设置了哪些 Playbook 目录将被用作处理变量插件的根目录,包括查找 host_vars/group_vars。

默认值:

top

选择:
  • top:

    遵循使用链中顶部 Playbook 来查找根目录的传统行为。

  • bottom:

    遵循 2.4.0 版本中使用当前 Playbook 来查找根目录的行为。

  • all:

    从第一个父目录检查到当前 Playbook。

添加版本:

2.4.1

Ini:
部分:

[defaults]

键:

playbook_vars_root

环境变量:
变量:

ANSIBLE_PLAYBOOK_VARS_ROOT

PLUGIN_FILTERS_CFG

描述:

用于过滤允许使用系统中安装的哪些插件的配置路径。有关过滤器文件格式的详细信息,请参阅 拒绝模块。默认值为 /etc/ansible/plugin_filters.yml

类型:

path

默认值:

None

添加版本:

2.5.0

Ini:
部分:

[defaults]

键:

plugin_filters_cfg

PYTHON_MODULE_RLIMIT_NOFILE

描述:

执行 Python 模块时尝试将 RLIMIT_NOFILE 软限制设置为指定值(可以加快 Python 2.x 上子进程的使用。参见 https://bugs.python.org/issue11284)。该值将受到现有硬限制的限制。默认值 0 不会尝试调整现有的系统定义限制。

默认值:

0

添加版本:

2.8

Ini:
部分:

[defaults]

键:

python_module_rlimit_nofile

环境变量:
变量:

ANSIBLE_PYTHON_MODULE_RLIMIT_NOFILE

变量:
name:

ansible_python_module_rlimit_nofile

RETRY_FILES_ENABLED

描述:

这控制失败的 Ansible Playbook 是否应创建 .retry 文件。

类型:

bool

默认值:

False

Ini:
部分:

[defaults]

键:

retry_files_enabled

环境变量:
变量:

ANSIBLE_RETRY_FILES_ENABLED

RETRY_FILES_SAVE_PATH

描述:

这设置了当 Playbook 失败且启用重试文件时 Ansible 保存 .retry 文件的路径。此文件将在每次运行后被覆盖,包含来自所有 Play 的失败主机列表。

类型:

path

默认值:

None

Ini:
部分:

[defaults]

键:

retry_files_save_path

环境变量:
变量:

ANSIBLE_RETRY_FILES_SAVE_PATH

RUN_VARS_PLUGINS

描述:

此设置可用于根据用户清单大小和 Play 选择来优化变量插件(vars_plugin)的使用。

类型:

str

默认值:

demand

选择:
  • demand:

    当任务“需求”变量时,将根据清单源运行变量插件。

  • start:

    导入该清单源后,将根据清单源运行变量插件。

添加版本:

2.10

Ini:
部分:

[defaults]

键:

run_vars_plugins

环境变量:
变量:

ANSIBLE_RUN_VARS_PLUGINS

SHOW_CUSTOM_STATS

描述:

这会将通过 set_stats 插件设置的自定义统计信息添加到默认输出中。

类型:

bool

默认值:

False

Ini:
部分:

[defaults]

键:

show_custom_stats

环境变量:
变量:

ANSIBLE_SHOW_CUSTOM_STATS

SSH_AGENT

描述:

通过 Ansible 管理 SSH 代理。配置为 none 将不会与代理交互;auto 将在运行期间通过 ssh-agent 二进制文件启动并销毁代理;SSH_AUTH_SOCK 的路径将允许与预先存在的代理进行交互。

类型:

字符串

默认值:

none

添加版本:

2.19

Ini:
部分:

[connection]

键:

ssh_agent

环境变量:
变量:

ANSIBLE_SSH_AGENT

SSH_AGENT_EXECUTABLE

描述:

SSH_AGENTauto 时,要启动的 ssh 代理可执行文件的路径或名称。

类型:

str

默认值:

ssh-agent

添加版本:

2.19

Ini:
部分:

[connection]

键:

ssh_agent_executable

环境变量:
变量:

ANSIBLE_SSH_AGENT_EXECUTABLE

SSH_AGENT_KEY_LIFETIME

描述:

对于插入由 SSH_AGENT 定义的代理中的密钥,定义密钥在代理中可以保留的生存时间(以秒为单位)。

类型:

int

添加版本:

2.19

Ini:
部分:

[connection]

键:

ssh_agent_key_lifetime

环境变量:
变量:

ANSIBLE_SSH_AGENT_KEY_LIFETIME

STRING_TYPE_FILTERS

描述:

此过滤器列表在模板化变量时避免‘类型转换’。例如,当你想要避免转换为 JSON 字符串的列表或字典时,这很有用。

类型:

list

默认值:

['string', 'to_json', 'to_nice_json', 'to_yaml', 'to_nice_yaml', 'ppretty', 'json']

Ini:
部分:

[jinja2]

键:

dont_type_filters

环境变量:
变量:

ANSIBLE_STRING_TYPE_FILTERS

注意:

此配置现已弃用,并计划移除。您应该更新到当前的替代方案。

计划移除:

2.23

弃用原因:

此选项无效。

当前的替代方案:

无;从过滤器返回的原生类型始终被保留。

SYSTEM_WARNINGS

描述:

允许禁用与运行 Ansible 本身的系统(而非受管主机)上的潜在问题相关的警告。这些可能包括关于第三方软件包或在可能的情况下应解决的其他条件的警告。

类型:

布尔值

默认值:

True

Ini:
部分:

[defaults]

键:

system_warnings

环境变量:
变量:

ANSIBLE_SYSTEM_WARNINGS

TAGS_RUN

描述:

在你的 Play 中运行的默认标签列表,跳过标签(Skip Tags)具有优先权。

类型:

list

默认值:

[]

添加版本:

2.5

Ini:
部分:

[tags]

键:

run

环境变量:
变量:

ANSIBLE_RUN_TAGS

TAGS_SKIP

描述:

在你的 Play 中跳过的默认标签列表,优先于运行标签(Run Tags)

类型:

list

默认值:

[]

添加版本:

2.5

Ini:
部分:

[tags]

键:

skip

环境变量:
变量:

ANSIBLE_SKIP_TAGS

TARGET_LOG_INFO

描述:

插入到目标日志中以进行跟踪目的的字符串。

添加版本:

2.17

Ini:
部分:

[defaults]

键:

target_log_info

环境变量:
变量:

ANSIBLE_TARGET_LOG_INFO

变量:
name:

ansible_target_log_info

TASK_DEBUGGER_IGNORE_ERRORS

描述:

此选项定义当指定 ignore_errors=True 时,任务调试器是否会在失败的任务上调用。True 表示调试器将遵守 ignore_errors,而 False 表示将不遵守。

类型:

布尔值

默认值:

True

添加版本:

2.7

Ini:
部分:

[defaults]

键:

task_debugger_ignore_errors

环境变量:
变量:

ANSIBLE_TASK_DEBUGGER_IGNORE_ERRORS

TASK_TIMEOUT

描述:

设置任务操作执行的最大时间(以秒为单位)。超时独立于模板化或循环运行。它适用于任务操作的每次执行尝试,且不会因任务所花费的总时间而改变。当操作执行超过超时时间时,Ansible 会中断该进程。这被注册为因外部情况导致的失败,而非任务失败,以便接收适当的响应和恢复过程。如果设置为 0(默认值),则没有超时。

类型:

整数

默认值:

0

添加版本:

2.10

Ini:
部分:

[defaults]

键:

task_timeout

环境变量:
变量:

ANSIBLE_TASK_TIMEOUT

TRANSFORM_INVALID_GROUP_CHARS

描述:

使 Ansible 转换清单源提供的组名称中的无效字符。

类型:

字符串

默认值:

never

选择:
  • always:

    它将把任何无效字符替换为 ‘_’(下划线)并警告用户。

  • never:

    它将允许使用该组名称,但会发出有关问题的警告。

  • ignore:

    它的作用与 ‘never’ 相同,但不发出警告。

  • silently:

    它的作用与 ‘always’ 相同,但不发出警告。

添加版本:

2.8

Ini:
部分:

[defaults]

键:

force_valid_group_names

环境变量:
变量:

ANSIBLE_TRANSFORM_INVALID_GROUP_CHARS

USE_PERSISTENT_CONNECTIONS

描述:

切换连接是否使用持久化。

类型:

布尔值

默认值:

False

Ini:
部分:

[defaults]

键:

use_persistent_connections

环境变量:
变量:

ANSIBLE_USE_PERSISTENT_CONNECTIONS

VALIDATE_ACTION_GROUP_METADATA

描述:

用于禁用验证 module_defaults 操作组的集合 ‘metadata’ 条目的切换开关。当此值为 True 时,包含意外字段或值类型的元数据将产生警告。

类型:

bool

默认值:

True

添加版本:

2.12

Ini:
部分:

[defaults]

键:

validate_action_group_metadata

环境变量:
变量:

ANSIBLE_VALIDATE_ACTION_GROUP_METADATA

VARIABLE_PLUGINS_ENABLED

描述:

需要此项的变量插件的允许列表。

类型:

list

默认值:

['host_group_vars']

添加版本:

2.10

Ini:
部分:

[defaults]

键:

vars_plugins_enabled

环境变量:
变量:

ANSIBLE_VARS_ENABLED

VARIABLE_PRECEDENCE

描述:

允许更改组变量优先级的合并顺序。

类型:

list

默认值:

['all_inventory', 'groups_inventory', 'all_plugins_inventory', 'all_plugins_play', 'groups_plugins_inventory', 'groups_plugins_play']

添加版本:

2.4

Ini:
部分:

[defaults]

键:

precedence

环境变量:
变量:

ANSIBLE_PRECEDENCE

VAULT_ENCRYPT_SALT

描述:

用于 vault 加密的盐值(salt)。如果不提供,将使用随机盐值。

默认值:

None

添加版本:

2.15

Ini:
部分:

[defaults]

键:

vault_encrypt_salt

环境变量:
变量:

ANSIBLE_VAULT_ENCRYPT_SALT

VERBOSE_TO_STDERR

描述:

强制 ‘verbose’ 选项使用 stderr 而不是 stdout。

类型:

bool

默认值:

False

添加版本:

2.8

Ini:
部分:

[defaults]

键:

verbose_to_stderr

环境变量:
变量:

ANSIBLE_VERBOSE_TO_STDERR

WIN_ASYNC_STARTUP_TIMEOUT

描述:

对于 Ansible 中的异步任务(涵盖在异步操作和轮询中),这是等待 Ansible 派生的任务连接回 Windows 系统上使用的命名管道的时间(以秒为单位)。默认值为 5 秒。在较慢的系统或负载较重的系统上,此值可能太低。这不是异步命令可以运行的总时间,而是等待异步命令启动的单独超时时间。任务一旦连接到管道,就开始针对其 async_timeout 进行计时,因此任务可以采取的整体最长持续时间将延长此处指定的量。

类型:

整数

默认值:

5

添加版本:

2.10

Ini:
部分:

[defaults]

键:

win_async_startup_timeout

环境变量:
变量:

ANSIBLE_WIN_ASYNC_STARTUP_TIMEOUT

变量:
name:

ansible_win_async_startup_timeout

WORKER_SESSION_ISOLATION

描述:

Ansible 的分叉工作进程默认以会话隔离方式运行,以避免共享 TTY 上的竞争。如果需要访问继承的父 TTY,请将此选项设置为 false 以禁用会话隔离。禁用会话隔离应通过在单个任务、块、Play、角色或主机上设置 ansible_worker_session_isolation 变量,将其限制在尽可能小的范围内。

类型:

布尔值

默认值:

True

添加版本:

2.21

Ini:
部分:

[defaults]

键:

worker_session_isolation

环境变量:
变量:

ANSIBLE_WORKER_SESSION_ISOLATION

变量:
name:

ansible_worker_session_isolation

WORKER_SHUTDOWN_POLL_COUNT

描述:

检查任务队列管理器工作进程以验证它们是否干净退出的最大次数。达到此限制后,任何仍在运行的工作进程都将被终止。这仅供内部使用。

类型:

整数

默认值:

0

添加版本:

2.10

环境变量:
变量:

ANSIBLE_WORKER_SHUTDOWN_POLL_COUNT

WORKER_SHUTDOWN_POLL_DELAY

描述:

在检查任务队列管理器工作进程以验证它们是否干净退出时,轮询循环之间的休眠秒数。这仅供内部使用。

类型:

float

默认值:

0.1

添加版本:

2.10

环境变量:
变量:

ANSIBLE_WORKER_SHUTDOWN_POLL_DELAY

YAML_FILENAME_EXTENSIONS

描述:

在寻找应该是 YAML 或 JSON 或这些格式的 vault 版本(加密版本)的‘变量’文件时,检查所有这些扩展名。这会影响 vars_files、include_vars、inventory 和 vars 插件等。

类型:

list

默认值:

['.yml', '.yaml', '.json']

Ini:
部分:

[defaults]

键:

yaml_valid_extensions

环境变量:
变量:

ANSIBLE_YAML_FILENAME_EXT

环境变量

可以在 所有集合环境变量索引 中找到用于配置集合中插件的其他环境变量。

ANSIBLE_CONFIG

覆盖默认的 ansible 配置文件。

ANSIBLE_ALLOW_BROKEN_CONDITIONALS

启用此选项后,允许使用非布尔结果的条件表达式。在这种情况下,会发出弃用警告。默认情况下,非布尔条件会导致错误。此类结果通常表示在不支持模板的地方误用了模板,从而导致条件始终为真。启用此选项后,为了向后兼容,文字 None 或空字符串的条件表达式将被评估为真。

另请参阅 ALLOW_BROKEN_CONDITIONALS

ANSIBLE_ALLOW_EMBEDDED_TEMPLATES

启用此选项后,允许在特定的向后兼容场景中使用嵌入式模板。在这种情况下,会发出弃用警告。首先,完全包含在模板分隔符中的条件(例如 failed_whenuntilassert.that)。其次,条件中的字符串常量(例如 when: some_var == '{{ some_other_var }}')。最后,查找的定位参数(例如 lookup('pipe', 'echo {{ some_var }}'))。此功能已被弃用,因为在这些情况下不需要嵌入式模板。禁用此功能后,使用嵌入式模板将导致错误。未来的版本将默认禁用此功能。

另请参阅 ALLOW_EMBEDDED_TEMPLATES

ANSIBLE_HOME

控制器上 Ansible 配置文件的默认根路径。

另请参阅 ANSIBLE_HOME

ANSIBLE_CONNECTION_PATH

指定查找 ansible-connection 脚本的位置。在搜索 $PATH 之前会检查此位置。如果为 null,ansible 将从与 ansible 脚本相同的目录开始。

另请参阅 ANSIBLE_CONNECTION_PATH

ANSIBLE_COW_SELECTION

这允许您为横幅选择特定的 cowsay 模板,或使用“random”循环浏览它们。

另请参阅 ANSIBLE_COW_SELECTION

ANSIBLE_COW_ACCEPTLIST

接受“安全”使用的 cowsay 模板列表,如果您想启用所有安装的模板,请将其设置为空列表。

另请参阅 ANSIBLE_COW_ACCEPTLIST

添加版本:

2.11

ANSIBLE_FORCE_COLOR

此选项即使在没有 TTY 或“nocolor”设置的情况下也强制开启颜色模式。

另请参阅 ANSIBLE_FORCE_COLOR

ANSIBLE_NOCOLOR

此设置允许禁止颜色化输出,用于更好地指示失败和状态信息。

另请参阅 ANSIBLE_NOCOLOR

NO_COLOR

此设置允许禁止颜色化输出,用于更好地指示失败和状态信息。

另请参阅 ANSIBLE_NOCOLOR

添加版本:

2.11

ANSIBLE_NOCOWS

如果您安装了 cowsay 但想避免显示“奶牛”(为什么????),请使用此项。

另请参阅 ANSIBLE_NOCOWS

ANSIBLE_COW_PATH

指定自定义的 cowsay 路径或替换为您选择的 cowsay 实现。

另请参阅 ANSIBLE_COW_PATH

ANSIBLE_PIPELINING

这是一个全局选项,每个连接插件可以通过拥有更具体的选项或根本不支持流水线(pipelining)来进行覆盖。如果连接插件支持流水线,它会通过执行多个 Ansible 模块而不进行实际文件传输,从而减少在远程服务器上执行模块所需的网络操作次数。启用后,性能可能会有非常显著的提升。然而,这与权限提升(become)存在冲突。例如,当使用 ‘sudo:’ 操作时,必须首先在所有受管主机上的 /etc/sudoers 中禁用 ‘requiretty’,这就是它默认禁用的原因。如果启用了 ANSIBLE_KEEP_REMOTE_FILES,则此设置将被禁用。

另请参阅 ANSIBLE_PIPELINING

ANSIBLE_ANY_ERRORS_FATAL

设置 any_errors_fatal 关键字的默认值,如果为 True,任务失败将被视为致命错误。

另请参阅 ANY_ERRORS_FATAL

ANSIBLE_BECOME_ALLOW_SAME_USER

当为 False(默认)时,如果远程用户与 become 用户相同,Ansible 将跳过 become 的使用,因为这通常是冗余操作。换句话说,即 root sudo 到 root。如果为 True,则强制 Ansible 无论如何都使用 become 插件,因为在某些情况下这是必须的。

另请参阅 BECOME_ALLOW_SAME_USER

ANSIBLE_BECOME_PASSWORD_FILE

become 插件使用的密码文件。--become-password-file。如果它是可执行的,则会运行它,并将生成的 stdout 用作密码。

另请参阅 BECOME_PASSWORD_FILE

ANSIBLE_AGNOSTIC_BECOME_PROMPT

显示一个通用的提权提示,而不是显示包含命令行提供的提权方法的提示。

另请参阅 AGNOSTIC_BECOME_PROMPT

ANSIBLE_CACHE_PLUGIN

选择使用哪个事实缓存插件。默认情况下,不使用缓存,事实不会在运行之间持续存在。

另请参阅 CACHE_PLUGIN

ANSIBLE_CACHE_PLUGIN_CONNECTION

为事实缓存插件定义连接或路径信息。

另请参阅 CACHE_PLUGIN_CONNECTION

ANSIBLE_CACHE_PLUGIN_PREFIX

用于事实缓存插件文件/表的前缀。

另请参阅 CACHE_PLUGIN_PREFIX

ANSIBLE_CACHE_PLUGIN_TIMEOUT

事实缓存插件数据的过期超时时间。

另请参阅 CACHE_PLUGIN_TIMEOUT

ANSIBLE_COLLECTIONS_SCAN_SYS_PATH

用于启用或禁用扫描 sys.path 以查找已安装集合的布尔值。

另请参阅 COLLECTIONS_SCAN_SYS_PATH

ANSIBLE_COLLECTIONS_PATH

Ansible 将搜索集合内容的冒号分隔路径。集合必须在嵌套的子目录中,而不是直接在这些目录中。例如,如果 COLLECTIONS_PATHS 包含 '{{ ANSIBLE_HOME ~ "/collections" }}',并且您想将 my.collection 添加到该目录,则必须将其保存为 '{{ ANSIBLE_HOME ~ "/collections/ansible_collections/my/collection" }}'

另请参阅 COLLECTIONS_PATHS

添加版本:

2.10

ANSIBLE_COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH

当加载不支持当前运行的 Ansible 版本的集合时(使用集合元数据键 requires_ansible)。

另请参阅 COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH

ANSIBLE_COLOR_CHANGED

定义在“Changed”任务状态下使用的颜色。

另请参阅 COLOR_CHANGED

ANSIBLE_COLOR_CONSOLE_PROMPT

定义用于 ansible-console 的默认颜色。

另请参阅 COLOR_CONSOLE_PROMPT

ANSIBLE_COLOR_DEBUG

定义发出调试消息时使用的颜色。

另请参阅 COLOR_DEBUG

ANSIBLE_COLOR_DEPRECATE

定义发出弃用消息时使用的颜色。

另请参阅 COLOR_DEPRECATE

ANSIBLE_COLOR_DIFF_ADD

定义在差异中显示添加的行时使用的颜色。

另请参阅 COLOR_DIFF_ADD

ANSIBLE_COLOR_DIFF_LINES

定义显示差异时使用的颜色。

另请参阅 COLOR_DIFF_LINES

ANSIBLE_COLOR_DIFF_REMOVE

定义在差异中显示删除的行时使用的颜色。

另请参阅 COLOR_DIFF_REMOVE

ANSIBLE_COLOR_ERROR

定义发出错误消息时使用的颜色。

另请参阅 COLOR_ERROR

ANSIBLE_COLOR_HIGHLIGHT

定义用于高亮的颜色。

另请参阅 COLOR_HIGHLIGHT

ANSIBLE_COLOR_INCLUDED

定义显示“Included”任务状态时使用的颜色。

另请参阅 COLOR_INCLUDED

ANSIBLE_COLOR_OK

定义显示“OK”任务状态时使用的颜色。

另请参阅 COLOR_OK

ANSIBLE_COLOR_SKIP

定义显示“Skipped”任务状态时使用的颜色。

另请参阅 COLOR_SKIP

ANSIBLE_COLOR_UNREACHABLE

定义在“Unreachable”状态下使用的颜色。

另请参阅 COLOR_UNREACHABLE

ANSIBLE_COLOR_VERBOSE

定义发出详细消息时使用的颜色。换句话说,那些随 '-v' 显示的消息。

另请参阅 COLOR_VERBOSE

ANSIBLE_COLOR_WARN

定义发出警告消息时使用的颜色。

另请参阅 COLOR_WARN

ANSIBLE_COLOR_DOC_MODULE

定义在 ansible-doc 输出中发出模块名称时使用的颜色。

另请参阅 COLOR_DOC_MODULE

ANSIBLE_COLOR_DOC_REFERENCE

定义在 ansible-doc 输出中发出交叉引用时使用的颜色。

另请参阅 COLOR_DOC_REFERENCE

定义在 ansible-doc 输出中发出链接时使用的颜色。

另请参阅 COLOR_DOC_LINK

ANSIBLE_COLOR_DOC_DEPRECATED

定义在 ansible-doc 输出中发出弃用值时使用的颜色。

另请参阅 COLOR_DOC_DEPRECATED

ANSIBLE_COLOR_DOC_CONSTANT

定义在 ansible-doc 输出中发出常量时使用的颜色。

另请参阅 COLOR_DOC_CONSTANT

ANSIBLE_COLOR_DOC_PLUGIN

定义在 ansible-doc 输出中发出插件名称时使用的颜色。

另请参阅 COLOR_DOC_PLUGIN

ANSIBLE_CONNECTION_PASSWORD_FILE

用于连接插件的密码文件。--connection-password-file

另请参阅 CONNECTION_PASSWORD_FILE

_ANSIBLE_COVERAGE_REMOTE_OUTPUT

设置远程主机上用于生成覆盖率报告的输出目录。目前仅用于 PowerShell 模块的远程覆盖率。此仅供内部使用。

另请参阅 COVERAGE_REMOTE_OUTPUT

_ANSIBLE_COVERAGE_REMOTE_PATH_FILTER

在远程主机上执行时,Ansible 控制器上运行覆盖率的文件路径列表。只有匹配路径 glob 的文件才会收集其覆盖率。可以指定多个路径 glob,并用 : 分隔。目前仅用于 PowerShell 模块的远程覆盖率。此仅供内部使用。

另请参阅 COVERAGE_REMOTE_PATHS

ANSIBLE_ACTION_WARNINGS

默认情况下,当从任务操作(模块或操作插件)接收到警告时,Ansible 会发出警告。可以通过将此设置调整为 False 来消除这些警告。

另请参阅 ACTION_WARNINGS

ANSIBLE_LOCALHOST_WARNING

默认情况下,当清单中没有主机时,Ansible 会发出警告。可以通过将此设置调整为 False 来消除这些警告。

另请参阅 LOCALHOST_WARNING

ANSIBLE_LOG_VERBOSITY

如果该值高于正常的显示详细级别,这将设置日志详细级别,否则将与该级别相匹配。

另请参阅 LOG_VERBOSITY

ANSIBLE_INVENTORY_UNPARSED_WARNING

默认情况下,当未加载清单且指出将使用隐式的仅 localhost 清单时,Ansible 会发出警告。可以通过将此设置调整为 False 来消除这些警告。

另请参阅 INVENTORY_UNPARSED_WARNING

ANSIBLE_DOC_FRAGMENT_PLUGINS

Ansible 搜索文档片段插件的路径,以冒号分隔。

另请参阅 DOC_FRAGMENT_PLUGIN_PATH

ANSIBLE_ACTION_PLUGINS

Ansible 将搜索操作插件的冒号分隔路径。

另请参阅 DEFAULT_ACTION_PLUGIN_PATH

ANSIBLE_ASK_PASS

这控制 Ansible Playbook 是否应提示输入登录密码。如果使用 SSH 密钥进行身份验证,您可能无需更改此设置。

另请参阅 DEFAULT_ASK_PASS

ANSIBLE_ASK_VAULT_PASS

这控制 Ansible Playbook 是否应提示输入 Vault 密码。

另请参阅 DEFAULT_ASK_VAULT_PASS

ANSIBLE_BECOME

切换是否使用提权,允许您在登录后“成为”另一个用户。

另请参阅 DEFAULT_BECOME

ANSIBLE_BECOME_ASK_PASS

切换是否提示输入提权密码。

另请参阅 DEFAULT_BECOME_ASK_PASS

ANSIBLE_BECOME_METHOD

启用 become 时要使用的提权方法。

另请参阅 DEFAULT_BECOME_METHOD

ANSIBLE_BECOME_EXE

用于提权的执行程序,否则 Ansible 将依赖 PATH。

另请参阅 DEFAULT_BECOME_EXE

ANSIBLE_BECOME_FLAGS

传递给提权执行程序的标志。

另请参阅 DEFAULT_BECOME_FLAGS

ANSIBLE_BECOME_PLUGINS

Ansible 将搜索提权插件的冒号分隔路径。

另请参阅 BECOME_PLUGIN_PATH

ANSIBLE_BECOME_USER

使用提权时您的登录/远程用户所“成为”的用户,大多数系统在未指定用户时将使用“root”。

另请参阅 DEFAULT_BECOME_USER

ANSIBLE_CACHE_PLUGINS

Ansible 将搜索缓存插件的冒号分隔路径。

另请参阅 DEFAULT_CACHE_PLUGIN_PATH

ANSIBLE_CALLBACK_PLUGINS

Ansible 将搜索回调插件的冒号分隔路径。

另请参阅 DEFAULT_CALLBACK_PLUGIN_PATH

ANSIBLE_CALLBACKS_ENABLED

已启用的回调列表,并非所有回调都需要启用,但随 Ansible 一起提供的许多回调需要,因为我们不希望默认激活它们。

另请参阅 CALLBACKS_ENABLED

添加版本:

2.11

ANSIBLE_CLICONF_PLUGINS

Ansible 将搜索 Cliconf 插件的冒号分隔路径。

另请参阅 DEFAULT_CLICONF_PLUGIN_PATH

ANSIBLE_CONNECTION_PLUGINS

Ansible 将搜索连接插件的冒号分隔路径。

另请参阅 DEFAULT_CONNECTION_PLUGIN_PATH

ANSIBLE_DEBUG

切换 Ansible 中的调试输出。这是非常详细的,并可能阻碍多进程处理。尽管启用了 no_log 设置,调试输出也可能包含机密信息,这意味着不应在生产环境中使用调试模式。

另请参阅 DEFAULT_DEBUG

ANSIBLE_EXECUTABLE

这指示用于生成 Shell 的命令,这是 Ansible 在目标机上执行需求所必需的。用户在 Shell 使用受限的极少数情况下可能需要更改此设置,但在大多数情况下,可以保持原样。

另请参阅 DEFAULT_EXECUTABLE

ANSIBLE_FILTER_PLUGINS

Ansible 将搜索 Jinja2 过滤器插件的冒号分隔路径。

另请参阅 DEFAULT_FILTER_PLUGIN_PATH

ANSIBLE_FORCE_HANDLERS

此选项控制通知的 handler 是否在主机上运行,即使在该主机上发生故障也是如此。当为 false 时,如果主机上发生故障,handler 将不会运行。这也可以按 play 或在命令行上进行设置。有关更多详细信息,请参阅 Handlers and Failure。

另请参阅 DEFAULT_FORCE_HANDLERS

ANSIBLE_FORKS

Ansible 用于在目标主机上执行任务的最大分支(进程)数。

另请参阅 DEFAULT_FORKS

ANSIBLE_GATHERING

此设置控制事实收集(关于远程系统的发现事实)的默认策略。此选项对于那些希望节省事实收集时间的用户很有用。‘smart’ 和 ‘explicit’ 都将使用缓存插件。

另请参阅 DEFAULT_GATHERING

ANSIBLE_HASH_BEHAVIOUR

此设置控制 Ansible 如何处理字典变量(又称哈希、映射、关联数组)的重复定义。这不会影响值为标量(整数、字符串)或数组的变量。**警告**,不建议更改此设置,因为它很脆弱,并且使您的内容(play、角色、集合)不可移植,导致持续的困惑和滥用。除非您认为绝对需要,否则不要更改此设置。我们建议避免重用变量名,并依靠 combine 过滤器以及 varsvarnames 查找来创建单个变量的合并版本。根据我们的经验,这很少需要,这表明数据结构和 play 中引入了太多的复杂性。对于某些用途,您还可以查看自定义 vars_plugins 以在输入时合并,甚至替代负责解析 host_vars/group_vars/ 目录的默认 host_group_vars。此设置的大多数用户只对清单范围感兴趣,但设置本身会影响所有源,并使调试更加困难。官方示例库中的所有 playbook 和角色都假设此设置为默认值。将设置更改为 merge 适用于所有变量源,但许多源在内部仍然会覆盖这些变量。例如,include_vars 在更新 Ansible 之前会在内部对变量进行去重,其中“最后定义的”会覆盖同一文件中的先前定义。Ansible 项目建议您**避免为新项目使用 ``merge``。** Ansible 开发人员打算最终弃用并删除此设置,但由于一些用户确实严重依赖它,因此保留了下来。新项目应**避免 ‘merge’**。

另请参阅 DEFAULT_HASH_BEHAVIOUR

ANSIBLE_INVENTORY

Ansible 清单来源的逗号分隔列表

另请参阅 DEFAULT_HOST_LIST

ANSIBLE_HTTPAPI_PLUGINS

Ansible 将搜索 HttpApi 插件的冒号分隔路径。

另请参阅 DEFAULT_HTTPAPI_PLUGIN_PATH

ANSIBLE_INVENTORY_PLUGINS

Ansible 将搜索清单插件的冒号分隔路径。

另请参阅 DEFAULT_INVENTORY_PLUGIN_PATH

ANSIBLE_JINJA2_EXTENSIONS

这是一个特定于开发人员的功能,允许启用额外的 Jinja2 扩展。有关详细信息,请参阅 Jinja2 文档。如果您不知道这些扩展的作用,您可能不需要更改此设置 :)

另请参阅 DEFAULT_JINJA2_EXTENSIONS

ANSIBLE_JINJA2_NATIVE

此选项在模板操作期间保留变量类型。

另请参阅 DEFAULT_JINJA2_NATIVE

ANSIBLE_KEEP_REMOTE_FILES

启用/禁用清理 Ansible 用于在远程主机上执行任务的临时文件。如果启用了此选项,它将禁用 ANSIBLE_PIPELINING

另请参阅 DEFAULT_KEEP_REMOTE_FILES

ANSIBLE_LIBVIRT_LXC_NOSECLABEL

此设置导致 libvirt 通过将 --noseclabel 参数传递给 virsh 命令来连接到 LXC 容器。这在没有 SELinux 的系统上运行时是必需的。

另请参阅 DEFAULT_LIBVIRT_LXC_NOSECLABEL

ANSIBLE_LOAD_CALLBACK_PLUGINS

控制在运行 /usr/bin/ansible 时是否加载回调插件。这可能用于从命令行记录活动、发送通知等。对于 ansible-playbook,回调插件始终会被加载。

另请参阅 DEFAULT_LOAD_CALLBACK_PLUGINS

ANSIBLE_LOCAL_TEMP

Ansible 在控制器上使用的临时目录。

另请参阅 DEFAULT_LOCAL_TMP

ANSIBLE_LOG_PATH

Ansible 将在控制器上记录到的文件。当未设置时,记录功能被禁用。

另请参阅 DEFAULT_LOG_PATH

ANSIBLE_LOG_FILTER

要从日志文件中过滤掉的记录器名称列表。

另请参阅 DEFAULT_LOG_FILTER

ANSIBLE_LOOKUP_PLUGINS

Ansible 搜索查找插件(Lookup Plugins)的路径,以冒号分隔。

另请参阅 DEFAULT_LOOKUP_PLUGIN_PATH

ANSIBLE_MODULE_ARGS

如果没有指定 -a,则设置传递给 ansible 即席(adhoc)二进制文件的默认参数。

另请参阅 DEFAULT_MODULE_ARGS

ANSIBLE_LIBRARY

Ansible 搜索模块的路径,以冒号分隔。

另请参阅 DEFAULT_MODULE_PATH

ANSIBLE_MODULE_UTILS

Ansible 搜索模块工具文件的路径,这些文件由各个模块共享,以冒号分隔。

另请参阅 DEFAULT_MODULE_UTILS_PATH

ANSIBLE_NETCONF_PLUGINS

Ansible 搜索 Netconf 插件的路径,以冒号分隔。

另请参阅 DEFAULT_NETCONF_PLUGIN_PATH

ANSIBLE_NO_LOG

切换 Ansible 对任务细节的显示和记录,主要用于避免安全泄露。

另请参阅 DEFAULT_NO_LOG

ANSIBLE_NO_TARGET_SYSLOG

切换 Ansible 在目标主机执行任务时记录到系统日志(syslog)的行为。在 Windows 主机上,这将禁止较新样式的 PowerShell 模块写入事件日志。

另请参阅 DEFAULT_NO_TARGET_SYSLOG

ANSIBLE_NULL_REPRESENTATION

模板处理应返回什么作为 ‘null’ 值。如果未设置,将由 Jinja2 决定。

另请参阅 DEFAULT_NULL_REPRESENTATION

ANSIBLE_POLL_INTERVAL

对于 Ansible 中的异步任务(参见异步操作和轮询),这是未明确提供轮询间隔时检查任务状态的频率。默认的 15 秒是一个适中的选择,平衡了检查频率与任务完成后的快速响应。

另请参阅 DEFAULT_POLL_INTERVAL

ANSIBLE_PRIVATE_KEY_FILE

对于使用证书或密钥文件进行身份验证(而非代理或密码)的连接,可以在此处设置默认值,以避免每次调用时都重复指定 --private-key

另请参阅 DEFAULT_PRIVATE_KEY_FILE

ANSIBLE_PRIVATE_ROLE_VARS

默认情况下,导入的角色将其变量发布给 play 和其他角色,此设置可以避免这种情况。这是作为一种如果角色在 playbook 中被多次使用时将角色变量重置为默认值的方法而引入的。从 ‘2.17’ 版本开始,M(ansible.builtin.include_roles) 和 M(ansible.builtin.import_roles) 可以通过 C(public) 参数单独覆盖此设置。被包含的角色仅在执行时使其变量公开,与在 playbook 编译时发生的导入角色不同。

另请参阅 DEFAULT_PRIVATE_ROLE_VARS

ANSIBLE_REMOTE_PORT

远程连接中使用的端口,若为空,则使用连接插件的默认值。

另请参阅 DEFAULT_REMOTE_PORT

ANSIBLE_REMOTE_USER

设置目标机器的登录用户。当为空时,它使用连接插件的默认值,通常是当前执行 Ansible 的用户。

另请参阅 DEFAULT_REMOTE_USER

ANSIBLE_ROLES_PATH

Ansible 搜索角色的路径,以冒号分隔。

另请参阅 DEFAULT_ROLES_PATH

ANSIBLE_SELINUX_SPECIAL_FS

某些文件系统不支持安全操作和/或返回不一致的错误,此设置使 Ansible ‘容忍’ 列表中的那些文件系统,而不会导致致命错误。当文件系统在列表中时,可能会发生数据损坏,且写入并不总是经过验证。

另请参阅 DEFAULT_SELINUX_SPECIAL_FS

添加版本:

2.9

ANSIBLE_STDOUT_CALLBACK

设置用于显示 Ansible 输出的主要回调。您一次只能拥有一个。您可以拥有许多其他回调,但只有一个可以负责 stdout。有关可用选项列表,请参阅 Callback plugins

另请参阅 DEFAULT_STDOUT_CALLBACK

ANSIBLE_EDITOR

对于 Ansible 需要在编辑器中返回文件的情况,此项选择要使用的应用程序。

另请参阅 EDITOR

添加版本:

2.15

EDITOR

对于 Ansible 需要在编辑器中返回文件的情况,此项选择要使用的应用程序。

另请参阅 EDITOR

ANSIBLE_ENABLE_TASK_DEBUGGER

是否启用任务调试器,这以前是作为策略插件完成的。现在所有策略插件都可以继承此行为。调试器默认在任务失败或不可达时激活。使用 debugger 关键字以获得更大的灵活性。

另请参阅 ENABLE_TASK_DEBUGGER

ANSIBLE_TASK_DEBUGGER_IGNORE_ERRORS

此选项定义当指定 ignore_errors=True 时,任务调试器是否会在失败的任务上调用。True 指定调试器将遵循 ignore_errors,False 则不遵循 ignore_errors。

另请参阅 TASK_DEBUGGER_IGNORE_ERRORS

ANSIBLE_STRATEGY

设置 Play 使用的默认策略。

另请参阅 DEFAULT_STRATEGY

ANSIBLE_STRATEGY_PLUGINS

Ansible 搜索策略插件的路径,以冒号分隔。

另请参阅 DEFAULT_STRATEGY_PLUGIN_PATH

ANSIBLE_SU

切换任务是否使用 “su”。

另请参阅 DEFAULT_SU

ANSIBLE_SYSLOG_FACILITY

Ansible 记录到远程目标时要使用的 Syslog 设施。

另请参阅 DEFAULT_SYSLOG_FACILITY

ANSIBLE_TERMINAL_PLUGINS

Ansible 搜索终端插件的路径,以冒号分隔。

另请参阅 DEFAULT_TERMINAL_PLUGIN_PATH

ANSIBLE_TEST_PLUGINS

Ansible 搜索 Jinja2 测试插件的路径,以冒号分隔。

另请参阅 DEFAULT_TEST_PLUGIN_PATH

ANSIBLE_TIMEOUT

这是连接插件使用的默认超时时间。

另请参阅 DEFAULT_TIMEOUT

ANSIBLE_TRANSPORT

可以是你的 Ansible 安装中可用的任何连接插件。

另请参阅 DEFAULT_TRANSPORT

ANSIBLE_ERROR_ON_UNDEFINED_VARS

当为 True 时,这会导致 ansible 模板处理失败,因为引用了很可能是拼写错误的变量名。否则,任何包含未定义变量的 ‘{{ template_expression }}’ 都将按照书写原样在模板或 ansible 操作行中呈现。

另请参阅 DEFAULT_UNDEFINED_VAR_BEHAVIOR

ANSIBLE_VARS_PLUGINS

Ansible 搜索变量插件的路径,以冒号分隔。

另请参阅 DEFAULT_VARS_PLUGIN_PATH

ANSIBLE_VAULT_ID_MATCH

如果为 True,使用 vault id 解密 vault 时将仅尝试使用来自匹配 vault-id 的密码。

另请参阅 DEFAULT_VAULT_ID_MATCH

ANSIBLE_VAULT_IDENTITY

在未提供 vault id 标签的情况下,用于默认 vault id 标签的标签名称。

另请参阅 DEFAULT_VAULT_IDENTITY

ANSIBLE_VAULT_ENCRYPT_SALT

用于 vault 加密的盐值(salt)。如果不提供,将使用随机盐值。

另请参阅 VAULT_ENCRYPT_SALT

ANSIBLE_VAULT_ENCRYPT_IDENTITY

默认用于加密的 vault_id。如果提供了多个 vault_ids,这指定了用于加密的一个。CLI 选项 --encrypt-vault-id 会覆盖配置的值。

另请参阅 DEFAULT_VAULT_ENCRYPT_IDENTITY

ANSIBLE_VAULT_IDENTITY_LIST

默认使用的 vault-ids 列表。等同于多个 --vault-id 参数。Vault-ids 将按顺序尝试使用。

另请参阅 DEFAULT_VAULT_IDENTITY_LIST

ANSIBLE_VAULT_PASSWORD_FILE

要使用的 vault 密码文件。等同于 --vault-password-file--vault-id。如果它是可执行的,则会运行它,并将生成的 stdout 用作密码。

另请参阅 DEFAULT_VAULT_PASSWORD_FILE

ANSIBLE_VERBOSITY

设置默认的详细级别,等同于在命令行中传递的 -v 的数量。

另请参阅 DEFAULT_VERBOSITY

ANSIBLE_DEPRECATION_WARNINGS

用于控制是否显示弃用警告的切换开关。

另请参阅 DEPRECATION_WARNINGS

ANSIBLE_DEVEL_WARNING

用于控制是否显示与运行开发版(devel)相关的警告的切换开关。

另请参阅 DEVEL_WARNING

ANSIBLE_DIFF_ALWAYS

配置切换开关,告诉模块在处于 ‘changed’(已更改)状态时显示差异,等同于 --diff

另请参阅 DIFF_ALWAYS

ANSIBLE_DIFF_CONTEXT

显示文件间差异时要展示的上下文行数。

另请参阅 DIFF_CONTEXT

ANSIBLE_DISPLAY_ARGS_TO_STDOUT

通常 ansible-playbook 会为运行的每个任务打印一个标题。如果您指定了标题,这些标题将包含来自任务的 name: 字段。如果没有,则 ansible-playbook 使用任务的操作来帮助您判断当前正在运行的任务。有时您运行许多相同的操作,因此您需要关于任务的更多信息以将其与相同操作的其他任务区分开来。如果您在配置中将此变量设置为 True,则 ansible-playbook 还将在标题中包含任务的参数。此设置默认设为 False,因为您的参数中可能包含敏感值,而您不希望这些值被打印出来。如果您将其设置为 True,则应确保已保护了环境的 stdout(没有人可以偷窥您的屏幕,并且您没有将 stdout 保存到不安全的文件中)或确保您的所有 playbook 都明确地为具有敏感值的任务添加了 no_log: True 参数。有关更多信息,请参阅 How do I keep secret data in my playbook?

另请参阅 DISPLAY_ARGS_TO_STDOUT

ANSIBLE_DISPLAY_SKIPPED_HOSTS

用于控制在默认回调中是否显示任务中跳过的任务/主机条目的切换开关。

另请参阅 DISPLAY_SKIPPED_HOSTS

ANSIBLE_DISPLAY_TRACEBACK

何时在扩展错误消息中包含回溯信息。

另请参阅 DISPLAY_TRACEBACK

ANSIBLE_DUPLICATE_YAML_DICT_KEY

默认情况下,当在 YAML 中遇到重复的字典键时,Ansible 会发出警告。可以通过将此设置调整为 False 来消除这些警告。

另请参阅 DUPLICATE_YAML_DICT_KEY

ANSIBLE_ERROR_ON_MISSING_HANDLER

切换开关,允许在通知时缺失的处理程序成为警告而不是错误。

另请参阅 ERROR_ON_MISSING_HANDLER

ANSIBLE_FACTS_MODULES

在 play 的事实收集阶段运行哪些模块,使用默认的 ‘smart’ 将尝试根据连接类型弄清楚这一点。如果添加您自己的模块但仍想使用默认的 Ansible 事实,则需要将 ‘setup’ 或相应的网络模块添加到列表中(如果您添加 ‘smart’,Ansible 也会弄清楚这一点)。这不会影响对 ‘setup’ 模块的显式调用,但总是会影响 ‘gather_facts’ 操作(隐式或显式)。

另请参阅 FACTS_MODULES

ANSIBLE_GALAXY_IGNORE

如果设置为 yes,ansible-galaxy 将不会验证 TLS 证书。这对于针对带有自签名证书的服务器进行测试非常有用。

另请参阅 GALAXY_IGNORE_CERTS

ANSIBLE_GALAXY_SERVER_TIMEOUT

Galaxy API 调用的默认超时时间。未配置特定超时的 Galaxy 服务器将回退到此值。

另请参阅 GALAXY_SERVER_TIMEOUT

ANSIBLE_GALAXY_ROLE_SKELETON

用作 ansible-galaxy/ansible-galaxy roleinit 操作模板的角色骨架目录,与 --role-skeleton 相同。

另请参阅 GALAXY_ROLE_SKELETON

ANSIBLE_GALAXY_ROLE_SKELETON_IGNORE

Galaxy 角色或集合骨架目录中要忽略的文件模式。

另请参阅 GALAXY_ROLE_SKELETON_IGNORE

ANSIBLE_GALAXY_COLLECTION_SKELETON

用作 ansible-galaxy collectioninit 操作模板的集合骨架目录,与 --collection-skeleton 相同。

另请参阅 GALAXY_COLLECTION_SKELETON

ANSIBLE_GALAXY_COLLECTION_SKELETON_IGNORE

Galaxy 集合骨架目录中要忽略的文件模式。

另请参阅 GALAXY_COLLECTION_SKELETON_IGNORE

ANSIBLE_GALAXY_COLLECTIONS_PATH_WARNING

ansible-galaxy collection install 是否应针对配置的 COLLECTIONS_PATHS 中缺失 --collections-path 发出警告。

另请参阅 GALAXY_COLLECTIONS_PATH_WARNING

ANSIBLE_GALAXY_SERVER

当角色未指定完整 URI 时要预置的 URL,假设它们将此服务器作为来源。

另请参阅 GALAXY_SERVER

ANSIBLE_GALAXY_SERVER_LIST

安装集合时要使用的 Galaxy 服务器列表。该值对应于配置 ini 标题 [galaxy_server.{{item}}],它定义了服务器详细信息。有关如何定义 Galaxy 服务器的更多详细信息,请参阅 Configuring the ansible-galaxy client。此列表中的服务器顺序用作解析集合的顺序。设置此配置选项将忽略 GALAXY_SERVER 配置选项。

另请参阅 GALAXY_SERVER_LIST

ANSIBLE_GALAXY_TOKEN_PATH

Galaxy 访问令牌文件的本地路径。

另请参阅 GALAXY_TOKEN_PATH

ANSIBLE_GALAXY_DISPLAY_PROGRESS

ansible-galaxy 中的某些步骤会显示一个进度轮,这可能会在某些显示器上或将 stdout 输出到文件时导致问题。此配置选项控制是否显示进度轮。默认情况下,如果 stdout 有 tty,则显示进度轮。

另请参阅 GALAXY_DISPLAY_PROGRESS

ANSIBLE_GALAXY_CACHE_DIR

存储来自 Galaxy 服务器缓存响应的目录。这仅由 ansible-galaxy collection installdownload 命令使用。如果此目录中的缓存文件是全局可写的,则将被忽略。

另请参阅 GALAXY_CACHE_DIR

ANSIBLE_GALAXY_DISABLE_GPG_VERIFY

在集合安装期间禁用 GPG 签名验证。

另请参阅 GALAXY_DISABLE_GPG_VERIFY

ANSIBLE_GALAXY_GPG_KEYRING

配置在集合安装和验证期间用于 GPG 签名验证的密钥环。

另请参阅 GALAXY_GPG_KEYRING

ANSIBLE_GALAXY_IGNORE_SIGNATURE_STATUS_CODES

在 GPG 签名验证期间要忽略的 GPG 状态代码列表。有关状态代码描述,请参阅 L(https://github.com/gpg/gnupg/blob/master/doc/DETAILS#general-status-codes)。如果成功验证集合的签名少于 GALAXY_REQUIRED_VALID_SIGNATURE_COUNT,即使忽略了所有错误代码,签名验证也将失败。

另请参阅 GALAXY_IGNORE_INVALID_SIGNATURE_STATUS_CODES

ANSIBLE_GALAXY_REQUIRED_VALID_SIGNATURE_COUNT

在安装或验证集合时,GPG 签名验证期间必须成功的签名数量。这应该是一个正整数或“all”,以表示所有签名必须成功验证集合。在值前加上 +,如果找不到集合的有效签名,则失败。

另请参阅 GALAXY_REQUIRED_VALID_SIGNATURE_COUNT

ANSIBLE_GALAXY_COLLECTION_IMPORT_POLL_INTERVAL

轮询集合导入状态的初始间隔(以秒为单位)。此间隔根据 GALAXY_COLLECTION_IMPORT_POLL_FACTOR 指数增加,最大延迟为 30 秒。

另请参阅 GALAXY_COLLECTION_IMPORT_POLL_INTERVAL

ANSIBLE_GALAXY_COLLECTION_IMPORT_POLL_FACTOR

检查集合导入状态时,用于增加 GALAXY_COLLECTION_IMPORT_POLL_INTERVAL 的乘数。

另请参阅 GALAXY_COLLECTION_IMPORT_POLL_FACTOR

ANSIBLE_HOST_KEY_CHECKING

如果您想避免 Ansible 用于连接到主机的底层连接插件进行主机密钥检查,请将其设置为 “False”。请阅读所使用的特定连接插件的文档以了解详细信息。

另请参阅 HOST_KEY_CHECKING

ANSIBLE_HOST_PATTERN_MISMATCH

此设置更改不匹配主机模式的行为,它允许你强制执行致命错误、发出警告或直接忽略它。

另请参阅 HOST_PATTERN_MISMATCH

ANSIBLE_INJECT_INVOCATION

启用后,将会在任务结果中添加一个 invocation 键,其中包含所使用的模块/动作参数。大多数回调插件默认在任务结果显示中屏蔽 invocation 键。

另请参阅 INJECT_INVOCATION

ANSIBLE_PYTHON_INTERPRETER

用于在远程目标上执行模块的 Python 解释器的路径,或自动发现模式。支持的发现模式有 auto(默认)和 auto_silent。所有发现模式都会针对已知 Python 解释器位置的有序列表进行匹配。回退行为将发出一个应显式设置解释器的警告(因为稍后安装的解释器可能会改变所使用的那个)。可以通过设置 auto_silent 来禁用此警告行为。auto_legacy* 模式已被移除。它们的存在是为了向后兼容较旧的 Ansible 版本,这些版本总是默认为 /usr/bin/python3,如果存在,将使用该解释器。

另请参阅 INTERPRETER_PYTHON

ANSIBLE_TRANSFORM_INVALID_GROUP_CHARS

使 Ansible 转换清单源提供的组名称中的无效字符。

另请参阅 TRANSFORM_INVALID_GROUP_CHARS

ANSIBLE_INVALID_TASK_ATTRIBUTE_FAILED

如果为 ‘false’,任务的无效属性将导致警告而不是错误。

另请参阅 INVALID_TASK_ATTRIBUTE_FAILED

ANSIBLE_INVENTORY_ANY_UNPARSED_IS_FAILED

如果为 ‘true’,当任何给定的清单(inventory)源不能被任何可用的清单插件成功解析时,这都是一个致命错误;否则,这种情况只会引发警告。

另请参阅 INVENTORY_ANY_UNPARSED_IS_FAILED

ANSIBLE_INVENTORY_ENABLED

已启用的清单插件列表,它也决定了它们被使用的顺序。

另请参阅 INVENTORY_ENABLED

ANSIBLE_INVENTORY_EXPORT

控制 ansible-inventory 是准确反映 Ansible 对清单的视图,还是针对导出进行了优化。

另请参阅 INVENTORY_EXPORT

ANSIBLE_INVENTORY_IGNORE

当使用目录作为清单源时要忽略的扩展名列表。

另请参阅 INVENTORY_IGNORE_EXTS

ANSIBLE_INVENTORY_IGNORE_REGEX

当使用目录作为清单源时要忽略的模式列表。

另请参阅 INVENTORY_IGNORE_PATTERNS

ANSIBLE_INVENTORY_UNPARSED_FAILED

如果为 ‘true’,则如果每一个潜在的清单源都无法解析,这是一个致命错误,否则这种情况只会引发警告。

另请参阅 INVENTORY_UNPARSED_IS_FAILED

ANSIBLE_MAX_DIFF_SIZE

用于差异显示的文件的最大大小。

另请参阅 MAX_FILE_SIZE_FOR_DIFF

ANSIBLE_NETWORK_GROUP_MODULES

另请参阅 NETWORK_GROUP_MODULES

ANSIBLE_INJECT_FACT_VARS

事实在 ansible_facts 变量内可用,此设置也将它们作为自己的变量推送到主命名空间中。与 ansible_facts 字典内删除了前缀 ansible_ 不同,这些变量将具有模块返回的确切名称。

另请参阅 INJECT_FACTS_AS_VARS

ANSIBLE_MODULE_IGNORE_EXTS

在查找要加载的模块时要忽略的扩展名列表。这是用于拒绝脚本和二进制模块的回退扩展名。

另请参阅 MODULE_IGNORE_EXTS

ANSIBLE_MODULE_STRICT_UTF8_RESPONSE

启用是否评估模块响应以包含非 UTF-8 数据。禁用此设置可能会导致意外行为。只有 ansible-core 应该评估此配置。

另请参阅 MODULE_STRICT_UTF8_RESPONSE

ANSIBLE_OLD_PLUGIN_CACHE_CLEAR

以前 Ansible 在加载新角色时只会清除部分插件加载缓存,这导致在之前 Play 中加载的插件会被意外地“粘住”。此设置允许用户返回到该行为。

另请参阅 OLD_PLUGIN_CACHE_CLEARING

ANSIBLE_PAGER

对于 Ansible 需要以可分页方式返回输出的情况,此项选择要使用的应用程序。

另请参阅 PAGER

添加版本:

2.15

PAGER

对于 Ansible 需要以可分页方式返回输出的情况,此项选择要使用的应用程序。

另请参阅 PAGER

ANSIBLE_PERSISTENT_CONTROL_PATH_DIR

连接持久化系统使用的套接字路径。

另请参阅 PERSISTENT_CONTROL_PATH_DIR

ANSIBLE_PERSISTENT_CONNECT_TIMEOUT

这控制持久连接在被销毁前保持空闲的时间。

另请参阅 PERSISTENT_CONNECT_TIMEOUT

ANSIBLE_PERSISTENT_CONNECT_RETRY_TIMEOUT

这控制持久连接尝试连接到本地域套接字的重试超时时间。

另请参阅 PERSISTENT_CONNECT_RETRY_TIMEOUT

ANSIBLE_PERSISTENT_COMMAND_TIMEOUT

这控制在中断持久连接之前,等待远程设备响应的时间量。

另请参阅 PERSISTENT_COMMAND_TIMEOUT

ANSIBLE_PLAYBOOK_DIR

许多非 Playbook CLI 都有一个 --playbook-dir 参数;此项设置其默认值。

另请参阅 PLAYBOOK_DIR

ANSIBLE_PLAYBOOK_VARS_ROOT

这设置了哪些 Playbook 目录将被用作处理变量插件的根目录,包括查找 host_vars/group_vars。

另请参阅 PLAYBOOK_VARS_ROOT

ANSIBLE_PYTHON_MODULE_RLIMIT_NOFILE

执行 Python 模块时尝试将 RLIMIT_NOFILE 软限制设置为指定值(可以加快 Python 2.x 上子进程的使用。参见 https://bugs.python.org/issue11284)。该值将受到现有硬限制的限制。默认值 0 不会尝试调整现有的系统定义限制。

另请参阅 PYTHON_MODULE_RLIMIT_NOFILE

ANSIBLE_RETRY_FILES_ENABLED

这控制失败的 Ansible Playbook 是否应创建 .retry 文件。

另请参阅 RETRY_FILES_ENABLED

ANSIBLE_RETRY_FILES_SAVE_PATH

这设置了当 playbook 失败且启用重试文件时,Ansible 将保存 .retry 文件的路径。此文件将在每次运行后覆盖,其中包含来自所有 play 的失败主机列表。

另请参阅 RETRY_FILES_SAVE_PATH

ANSIBLE_RUN_VARS_PLUGINS

此设置可用于根据用户清单大小和 Play 选择来优化变量插件(vars_plugin)的使用。

另请参阅 RUN_VARS_PLUGINS

ANSIBLE_SHOW_CUSTOM_STATS

这会将通过 set_stats 插件设置的自定义统计信息添加到默认输出中。

另请参阅 SHOW_CUSTOM_STATS

ANSIBLE_SSH_AGENT

通过 Ansible 管理 SSH 代理。配置为 none 将不会与代理交互;auto 将在运行期间通过 ssh-agent 二进制文件启动并销毁代理;SSH_AUTH_SOCK 的路径将允许与预先存在的代理进行交互。

另请参阅 SSH_AGENT

ANSIBLE_SSH_AGENT_EXECUTABLE

SSH_AGENTauto 时,要启动的 ssh 代理可执行文件的路径或名称。

另请参阅 SSH_AGENT_EXECUTABLE

ANSIBLE_SSH_AGENT_KEY_LIFETIME

对于插入由 SSH_AGENT 定义的代理中的密钥,定义密钥在代理中可以保留的生存时间(以秒为单位)。

另请参阅 SSH_AGENT_KEY_LIFETIME

ANSIBLE_STRING_TYPE_FILTERS

此过滤器列表用于在模板化变量时避免“类型转换”。例如,当您想避免将 JSON 字符串转换为列表或字典时,这很有用。

另请参阅 STRING_TYPE_FILTERS

ANSIBLE_SYSTEM_WARNINGS

允许禁用与运行 Ansible 本身的系统(而非受管主机)上的潜在问题相关的警告。这些可能包括有关第三方软件包的警告,或其他如果可能应予以解决的情况。

另请参阅 SYSTEM_WARNINGS

ANSIBLE_RUN_TAGS

在你的 Play 中运行的默认标签列表,跳过标签(Skip Tags)具有优先权。

另请参阅 TAGS_RUN

ANSIBLE_SKIP_TAGS

在你的 Play 中跳过的默认标签列表,优先于运行标签(Run Tags)

另请参阅 TAGS_SKIP

ANSIBLE_TARGET_LOG_INFO

插入到目标日志中以进行跟踪目的的字符串。

另请参阅 TARGET_LOG_INFO

ANSIBLE_TASK_TIMEOUT

设置任务操作执行的最大时间(以秒为单位)。超时运行与模板化或循环独立。它适用于任务操作的每次尝试,且不会因任务所花费的总时间而改变。当操作执行超过超时时间时,Ansible 会中断该进程。这被注册为由于外部情况导致的失败,而不是任务本身失败,以便接收适当的响应和恢复过程。如果设置为 0(默认值),则没有超时限制。

另请参阅 TASK_TIMEOUT

ANSIBLE_WORKER_SESSION_ISOLATION

Ansible 的 fork 工作进程默认在会话隔离状态下运行,以避免共享 TTY 上的争用。如果需要访问继承的父级 TTY,请将此选项设置为 false 以禁用会话隔离。禁用会话隔离应限制在尽可能小的范围内,可通过根据需要在单个任务、块、剧本、角色或主机上设置 ansible_worker_session_isolation 变量来实现。

另请参阅 WORKER_SESSION_ISOLATION

ANSIBLE_WORKER_SHUTDOWN_POLL_COUNT

检查任务队列管理器(Task Queue Manager)工作进程以验证它们是否已干净退出的最大次数。达到此限制后,任何仍在运行的工作进程都将被终止。此选项仅供内部使用。

另请参阅 WORKER_SHUTDOWN_POLL_COUNT

ANSIBLE_WORKER_SHUTDOWN_POLL_DELAY

在检查任务队列管理器工作进程以验证它们是否已干净退出时,轮询循环之间的休眠秒数。此选项仅供内部使用。

另请参阅 WORKER_SHUTDOWN_POLL_DELAY

ANSIBLE_USE_PERSISTENT_CONNECTIONS

切换连接是否使用持久化。

另请参阅 USE_PERSISTENT_CONNECTIONS

ANSIBLE_VARS_ENABLED

需要此项的变量插件的允许列表。

另请参阅 VARIABLE_PLUGINS_ENABLED

ANSIBLE_PRECEDENCE

允许更改组变量优先级的合并顺序。

另请参阅 VARIABLE_PRECEDENCE

ANSIBLE_WIN_ASYNC_STARTUP_TIMEOUT

对于 Ansible 中的异步任务(在“异步操作和轮询”一节中介绍),这是指等待 Ansible 派生的任务连接回 Windows 系统上所用命名管道的时长(以秒为单位)。默认值为 5 秒。在较慢的系统或负载较重的系统上,该值可能过低。这不是异步命令可以运行的总时长,而是等待异步命令启动的单独超时时间。只有在连接到管道后,任务才会开始根据其 async_timeout 进行计时,因此任务可以运行的总最大时长会增加此处指定的时间量。

另请参阅 WIN_ASYNC_STARTUP_TIMEOUT

ANSIBLE_YAML_FILENAME_EXT

在查找应为 YAML、JSON 或其加密(vaulted)版本的文件时,检查所有这些扩展名。这会影响 vars_files、include_vars、inventory 和 vars 插件等。

另请参阅 YAML_FILENAME_EXTENSIONS

ANSIBLE_NETCONF_SSH_CONFIG

此变量用于通过 netconf 连接启用堡垒机/跳转主机。如果设置为 True,堡垒机/跳转主机 ssh 设置应存在于 ~/.ssh/config 文件中;或者,也可以将其设置为自定义 ssh 配置文件路径以读取堡垒机/跳转主机设置。

另请参阅 NETCONF_SSH_CONFIG

ANSIBLE_VALIDATE_ACTION_GROUP_METADATA

用于禁用验证 module_defaults 操作组的集合 ‘metadata’ 条目的切换开关。当此值为 True 时,包含意外字段或值类型的元数据将产生警告。

另请参阅 VALIDATE_ACTION_GROUP_METADATA

ANSIBLE_VERBOSE_TO_STDERR

强制 ‘verbose’ 选项使用 stderr 而不是 stdout。

另请参阅 VERBOSE_TO_STDERR