所有集合环境变量索引

以下索引记录了集合中插件声明的所有环境变量。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

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

标记是在剧本执行的开始和结束处（当调用 ansible-playbook --check）显示 DRY RUN，以及在检查模式下运行的每个播放和任务的末尾显示 CHECK MODE。

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

ANSIBLE_COMMON_REMOTE_GROUP

当 Ansible 需要以不同用户身份执行模块时，会检查。

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

为了使这正常工作，远程用户和 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

请求中使用的用户代理。默认值在 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 开始，如果为 null（默认），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 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 回调插件