所有集合环境变量索引

以下索引文档记录了集合中的插件声明的所有环境变量。ansible-core配置使用的环境变量在Ansible配置设置中进行了说明。

ANSIBLE_ADMIN_USERS

预期具有管理员权限的用户列表。控制器使用此信息来确定如何在远程用户和become用户之间共享临时文件。

由以下使用： ansible.builtin.sh shell插件

ANSIBLE_ASYNC_DIR

Ansible将保存异步作业信息的目录。

由以下使用： ansible.builtin.sh shell插件

ANSIBLE_BECOME_PASS

请参阅使用此环境变量的选项的文档。

由以下使用： ansible.builtin.runas become插件，ansible.builtin.su become插件，ansible.builtin.sudo become插件

ANSIBLE_CALLBACK_FORMAT_PRETTY

将结果格式配置为更易读。

当result_format设置为yaml时，此选项默认为true，当配置为json时，默认为false。

将此选项设置为true将强制json和yaml结果始终进行漂亮打印，而不管冗余度如何。

当设置为true并与yaml结果格式一起使用时，此选项将修改模块响应，以尝试生成更易于理解的输出，但代价是正确性降低，不应依赖它来帮助编写变量操作或条件语句。为了保证正确性，请将此选项设置为false或将result_format设置为json。

由以下使用： ansible.builtin.default回调插件，ansible.builtin.minimal回调插件

ANSIBLE_CALLBACK_RESULT_FORMAT

定义回调输出中使用的任务结果格式。

这些格式不会导致回调发出有效的JSON或YAML格式。

输出包含这些格式以及其他不可解析的机器数据。

由以下使用： ansible.builtin.default回调插件，ansible.builtin.minimal回调插件

ANSIBLE_CALLBACK_TREE_DIR

将包含每个主机JSON文件的目录。使用adhoc时，也由--tree选项设置。

由以下使用： ansible.builtin.tree回调插件

ANSIBLE_CHECK_MODE_MARKERS

切换以控制在检查模式下显示标记。

标记是在playbook执行开始和结束时（调用ansible-playbook --check时）的DRY RUN，以及在检查模式下运行的每个play和task的结尾的CHECK MODE。

由以下使用： ansible.builtin.default回调插件

ANSIBLE_COMMON_REMOTE_GROUP

当Ansible需要以不同的用户执行模块时进行检查。

如果setfacl和chown都失败并且不允许不同的用户访问模块的文件，它们将被chgrp’d到这个组。

为了使此方法有效，远程用户和become用户必须共享一个公共组，并且此设置必须设置为该组。

由以下使用： ansible.builtin.sh shell插件

ANSIBLE_DISPLAY_FAILED_STDERR

切换以控制是否将失败和不可达的任务显示到STDERR而不是STDOUT。

由以下使用： ansible.builtin.default回调插件

ANSIBLE_DISPLAY_OK_HOSTS

切换以控制在任务中显示“ok”任务/主机结果。

由以下使用： ansible.builtin.default回调插件

ANSIBLE_INVENTORY_PLUGIN_EXTS

包含YAML文件的“有效”扩展名列表

由以下使用： ansible.builtin.yaml清单插件

ANSIBLE_INVENTORY_PLUGIN_SCRIPT_STDERR

即使脚本成功，也切换显示stderr

由以下使用： ansible.builtin.script清单插件

ANSIBLE_INVENTORY_USE_EXTRA_VARS

将额外变量合并到可用于组合的变量中（最高优先级）。

由以下使用： ansible.builtin.constructed清单插件

ANSIBLE_LOOKUP_URL_AGENT

在请求中使用的User-Agent。默认值在2.11中更改为ansible-httpget。

由以下使用： ansible.builtin.url查找插件

ANSIBLE_LOOKUP_URL_CA_PATH

要使用的CA证书包的文件系统路径字符串

由以下使用： ansible.builtin.url查找插件

ANSIBLE_LOOKUP_URL_CIPHERS

用于请求的SSL/TLS密码

提供列表时，所有密码将按顺序用:连接。

有关更多详细信息，请参阅OpenSSL密码列表格式。

可用的密码取决于Python和OpenSSL/LibreSSL版本

由以下使用： ansible.builtin.url查找插件

ANSIBLE_LOOKUP_URL_FOLLOW_REDIRECTS

URI模块是否应该跟随重定向。

由以下使用： ansible.builtin.url查找插件

ANSIBLE_LOOKUP_URL_FORCE

是否设置值为“no-cache”的“cache-control”标头

由以下使用： ansible.builtin.url查找插件

ANSIBLE_LOOKUP_URL_FORCE_BASIC_AUTH

强制基本身份验证

由以下使用： ansible.builtin.url查找插件

ANSIBLE_LOOKUP_URL_TIMEOUT

在放弃之前等待服务器发送数据的时间

由以下使用： ansible.builtin.url查找插件

ANSIBLE_LOOKUP_URL_UNIX_SOCKET

用于与提供的URL建立连接时使用的Unix套接字文件的系统路径字符串

由以下使用： ansible.builtin.url查找插件

ANSIBLE_LOOKUP_URL_UNREDIR_HEADERS

无需附加到重定向请求的头列表

由以下使用： ansible.builtin.url查找插件

ANSIBLE_LOOKUP_URL_USE_GSSAPI

使用请求的GSSAPI处理程序

从Ansible 2.11开始，可以使用username和password指定GSSAPI凭据。

由以下使用： ansible.builtin.url查找插件

ANSIBLE_LOOKUP_URL_USE_NETRC

确定是否使用``~/.netrc``文件中的凭据

默认情况下，.netrc与基本身份验证标头一起使用

设置为False时，将忽略.netrc凭据

由以下使用： ansible.builtin.url查找插件

ANSIBLE_PARAMIKO_BANNER_TIMEOUT

配置等待SSH banner显示的时间（以秒为单位）。此选项受paramiko 1.15.0或更高版本支持。

使用于： ansible.builtin.paramiko_ssh 连接插件

ANSIBLE_PARAMIKO_HOST_KEY_CHECKING

如果要避免Ansible用于连接到主机的底层工具进行主机密钥检查，请将其设置为“False”

使用于： ansible.builtin.paramiko_ssh 连接插件

ANSIBLE_PARAMIKO_PRIVATE_KEY_FILE

要使用的私钥文件的路径。

使用于： ansible.builtin.paramiko_ssh 连接插件

ANSIBLE_PARAMIKO_PROXY_COMMAND

通过跳板机运行连接的代理信息。

使用于： ansible.builtin.paramiko_ssh 连接插件

ANSIBLE_PARAMIKO_PTY

SUDO通常需要PTY，True表示提供PTY，False表示不提供PTY。

使用于： ansible.builtin.paramiko_ssh 连接插件

ANSIBLE_PARAMIKO_RECORD_HOST_KEYS

将主机密钥保存到文件中

使用于： ansible.builtin.paramiko_ssh 连接插件

ANSIBLE_PARAMIKO_REMOTE_USER

用于登录/身份验证的用户

可以通过CLI使用--user或-u选项设置。

使用于： ansible.builtin.paramiko_ssh 连接插件

ANSIBLE_PARAMIKO_TIMEOUT

插件在未能建立TCP连接之前放弃的时间（以秒为单位）。

使用于： ansible.builtin.paramiko_ssh 连接插件

ANSIBLE_PARAMIKO_USE_RSA_SHA2_ALGORITHMS

是否启用RSA SHA2算法用于公钥和主机密钥

在低于2.9版本的paramiko中，这仅影响主机密钥

要获得与paramiko<2.9匹配的行为，请将其设置为False

使用于： ansible.builtin.paramiko_ssh 连接插件

ANSIBLE_PKCS11_PROVIDER

PKCS11智能卡提供程序，例如opensc，示例：/usr/local/lib/opensc-pkcs11.so

需要sshpass 1.06+版本，sshpass必须支持-P选项。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_REMOTE_PARAMIKO_PORT

要连接到的远程端口。

使用于： ansible.builtin.paramiko_ssh 连接插件

ANSIBLE_REMOTE_TEMP

执行任务时在目标上使用的临时目录。

由以下使用： ansible.builtin.sh shell插件

ANSIBLE_REMOTE_TMP

执行任务时在目标上使用的临时目录。

由以下使用： ansible.builtin.sh shell插件

ANSIBLE_RUNAS_FLAGS

传递给runas的选项，一个以空格分隔的k=v对列表

使用于： ansible.builtin.runas become 插件

ANSIBLE_RUNAS_PASS

密码

使用于： ansible.builtin.runas become 插件

ANSIBLE_RUNAS_USER

您“成为”以执行任务的用户

使用于： ansible.builtin.runas become 插件

ANSIBLE_SCP_EXECUTABLE

这定义了scp二进制文件的位置。默认为scp，它将使用$PATH中可用的第一个二进制文件。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SCP_EXTRA_ARGS

专用于scp CLI的额外参数

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SFTP_BATCH_MODE

待补充

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SFTP_EXECUTABLE

这定义了sftp二进制文件的位置。默认为sftp，它将使用$PATH中可用的第一个二进制文件。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SFTP_EXTRA_ARGS

专用于sftp CLI的额外参数

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SHELL_ALLOW_WORLD_READABLE_TEMP

这使得在机器上创建的临时文件对全世界可读，并将发出警告而不是使任务失败。

在成为非特权用户时很有用。

由以下使用： ansible.builtin.sh shell插件

ANSIBLE_SHOW_PER_HOST_START

这会添加输出，显示任务何时开始对每个主机执行。

由以下使用： ansible.builtin.default回调插件

ANSIBLE_SHOW_TASK_PATH_ON_FAILURE

任务失败时，显示包含失败任务的文件路径和行号。使用-vv或更高详细程度运行时，此信息将自动显示每个任务。

由以下使用： ansible.builtin.default回调插件

ANSIBLE_SSH_ARGS

要传递给所有SSH CLI工具的参数。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SSH_COMMON_ARGS

所有SSH CLI工具的常用额外参数。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SSH_CONTROL_PATH

这是保存SSH的ControlPath套接字的位置，它使用SSH的变量替换。

从2.3版本开始，如果为空（默认值），ansible将生成一个唯一的哈希值。使用``%(directory)s``指示在哪里使用控制目录路径设置。

在2.3版本之前，默认为``control_path=%(directory)s/ansible-ssh-%%h-%%p-%%r``。

请注意，如果在ssh参数中设置了-o ControlPath，则此设置将被忽略。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SSH_CONTROL_PATH_DIR

如果控制路径设置为空，则设置要用于ssh控制路径的目录。

此外，还为控制路径设置提供``%(directory)s``变量。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SSH_EXECUTABLE

这定义了SSH二进制文件的位置。默认为ssh，它将使用$PATH中可用的第一个SSH二进制文件。

此选项通常不需要，当访问系统SSH受限时，或者当使用SSH包装器连接到远程主机时，它可能很有用。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SSH_EXTRA_ARGS

专用于SSH CLI的额外参数。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SSH_HOST_KEY_CHECKING

请参阅使用此环境变量的选项的文档。

使用于： ansible.builtin.paramiko_ssh 连接插件, ansible.builtin.ssh 连接插件

ANSIBLE_SSH_PIPELINING

流水线处理减少了在远程服务器上执行模块所需的连接操作次数，方法是执行许多Ansible模块而无需实际的文件传输。

启用此功能可以带来非常显著的性能提升。

但是，这可能会与权限提升（become）冲突。例如，在使用sudo操作时，必须首先在目标主机的sudoers文件中禁用requiretty，这就是此功能默认情况下处于禁用状态的原因。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SSH_RETRIES

连接尝试次数。

只有当 Ansible 获取到返回码为 255 的 SSH 错误时，才会重试连接。

返回码非 255 的任何错误都表示程序执行出现问题。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SSH_TIMEOUT

请参阅使用此环境变量的选项的文档。

使用于： ansible.builtin.paramiko_ssh 连接插件, ansible.builtin.ssh 连接插件

ANSIBLE_SSH_TRANSFER_METHOD

通过 ssh 传输文件时首选的方法。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SSH_USETTY

向 ssh 命令添加 -tt 以强制分配 tty。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SSHPASS_PROMPT

sshpass 应该搜索的密码提示。受 sshpass 1.06 及更高版本支持。

当设置 pkcs11_provider 时，默认为 Enter PIN for。

使用于： ansible.builtin.ssh 连接插件

ANSIBLE_SU_EXE

su 可执行文件。

使用于： ansible.builtin.su become 插件

ANSIBLE_SU_FLAGS

传递给 su 的选项。

使用于： ansible.builtin.su become 插件

ANSIBLE_SU_PASS

传递给 su 的密码。

使用于： ansible.builtin.su become 插件

ANSIBLE_SU_PROMPT_L10N

用于提示检测的本地化字符串列表。

如果为空，我们将使用内置的字符串。

请勿在自定义条目中添加冒号 (:)。Ansible 会在每个提示的末尾添加冒号；如果在字符串中添加另一个冒号，您的提示将因“超时”错误而失败。

使用于： ansible.builtin.su become 插件

ANSIBLE_SU_USER

您“成为”以执行任务的用户

使用于： ansible.builtin.su become 插件

ANSIBLE_SUDO_EXE

Sudo 可执行文件。

使用于： ansible.builtin.sudo become 插件

ANSIBLE_SUDO_FLAGS

传递给 sudo 的选项。

使用于： ansible.builtin.sudo become 插件

ANSIBLE_SUDO_PASS

传递给 sudo 的密码。

使用于： ansible.builtin.sudo become 插件

ANSIBLE_SUDO_USER

您“成为”以执行任务的用户

使用于： ansible.builtin.sudo become 插件

ANSIBLE_SYSTEM_TMPDIRS

Ansible 用于验证 remote_tmp 的受管机器上的有效系统临时目录列表，当需要特定权限时。这些目录必须对所有人具有读、写和执行权限。此列表仅应包含系统管理员已预先创建并具有正确所有权和权限的目录，否则可能会出现安全问题。

当 remote_tmp 需要为系统临时目录并且它与列表中的任何目录不匹配时，将改为使用列表中的第一个目录。

由以下使用： ansible.builtin.sh shell插件

ANSIBLE_VARS_PLUGIN_STAGE

控制此变量插件的执行时机。

将此选项设置为 all 将在导入清单后以及任务需要时运行变量插件。

将此选项设置为 task 仅在任务需要时运行变量插件。

将此选项设置为 inventory 仅在解析清单后运行变量插件。

如果省略此选项，则使用全局 RUN_VARS_PLUGINS 配置来确定何时执行变量插件。

使用于： ansible.builtin.host_group_vars 变量插件

JUNIT_FAIL_ON_CHANGE

将任何报告“已更改”的任务都视为 junit 测试失败。

使用于： ansible.builtin.junit 回调插件

JUNIT_FAIL_ON_IGNORE

即使设置了 ignore_on_error，也将失败的任务视为 junit 测试失败。

使用于： ansible.builtin.junit 回调插件

JUNIT_HIDE_TASK_ARGUMENTS

隐藏任务的参数。

使用于： ansible.builtin.junit 回调插件

JUNIT_INCLUDE_SETUP_TASKS_IN_REPORT

最终报告中是否应包含设置任务。

使用于： ansible.builtin.junit 回调插件

JUNIT_OUTPUT_DIR

写入 XML 文件的目录。

使用于： ansible.builtin.junit 回调插件

JUNIT_REPLACE_OUT_OF_TREE_PATH

将树外相对任务路径的目录部分替换为给定的占位符。

使用于： ansible.builtin.junit 回调插件

JUNIT_TASK_CLASS

将输出配置为每个 yaml 文件一个类。

使用于： ansible.builtin.junit 回调插件

JUNIT_TASK_RELATIVE_PATH

将输出配置为使用相对于给定目录的相对路径。

使用于： ansible.builtin.junit 回调插件

JUNIT_TEST_CASE_PREFIX

仅当任务具有此值作为前缀时才将其视为测试用例。此外，失败的任务将被记录为失败的测试用例。

使用于： ansible.builtin.junit 回调插件