所有集合环境变量索引

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

请求中使用的用户代理。默认值在 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算法用于公钥和主机密钥

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

要匹配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

TODO：编写它

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