所有集合环境变量的索引

以下索引记录了集合中的插件声明的所有环境变量。Ansible 核心配置使用的环境变量在 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

切换以控制在检查模式下运行时是否显示标记。

标记是在剧本执行开始和结束时（当调用 ansible-playbook --check 时）的 DRY RUN，以及在检查模式下运行的每个执行的剧本和任务中的 CHECK MODE 后缀。

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

ANSIBLE_COMMON_REMOTE_GROUP

在 Ansible 需要以不同用户身份执行模块时进行检查。

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

为了使此功能正常工作，remote_user 和 become_user 必须共享一个共同组，并且此设置必须设置为该组。

由以下使用： 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

请求中使用的用户代理。默认值在 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

urllib2、all/yes、safe、none 的字符串，用于确定如何跟随重定向

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

ANSIBLE_LOOKUP_URL_FORCE

是否使用“cache-control”头并将其值设置为“no-cache”

由以下使用： 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 横幅显示的时间量。此选项由 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 成为插件

ANSIBLE_RUNAS_PASS

密码

使用方式： ansible.builtin.runas 成为插件

ANSIBLE_RUNAS_USER

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

使用方式： ansible.builtin.runas 成为插件

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

将 -tt 添加到 ssh 命令以强制分配 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 成为插件

ANSIBLE_SU_FLAGS

传递给 su 的选项

使用方式： ansible.builtin.su 成为插件

ANSIBLE_SU_PASS

传递给 su 的密码

使用方式： ansible.builtin.su 成为插件

ANSIBLE_SU_PROMPT_L10N

要匹配的本地化字符串列表，用于提示检测

如果为空，我们将使用内置的列表

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

使用方式： ansible.builtin.su 成为插件

ANSIBLE_SU_USER

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

使用方式： ansible.builtin.su 成为插件

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 回调插件