所有集合环境变量索引
以下索引记录了集合中插件声明的所有环境变量。ansible-core 配置使用的环境变量记录在Ansible 配置设置中。
- ANSIBLE_ADMIN_USERS
预期拥有管理员权限的用户列表。控制器使用它来确定如何在远程用户和 become 用户之间共享临时文件。
- ANSIBLE_ASYNC_DIR
Ansible 在其中保留异步作业信息的目录。
- 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 callback 插件、ansible.builtin.minimal callback 插件
- ANSIBLE_CALLBACK_RESULT_FORMAT
定义回调输出中使用的任务结果格式。
这些格式不会导致回调发出有效的 JSON 或 YAML 格式。
输出包含这些格式，其中散布着其他非机器可解析的数据。
使用方： ansible.builtin.default callback 插件、ansible.builtin.minimal callback 插件
- ANSIBLE_CALLBACK_TREE_DIR
将包含每个主机 JSON 文件的目录。使用 adhoc 时，也可以通过
--tree选项设置。
- ANSIBLE_CHECK_MODE_MARKERS
切换以控制在检查模式下运行时是否显示标记。
标记是 playbook 执行开始和结束时的
DRY RUN（当调用ansible-playbook --check时）和作为在检查模式下运行的每个 play 和任务的后缀的CHECK MODE。
- ANSIBLE_COMMON_REMOTE_GROUP
当 Ansible 需要以其他用户身份执行模块时检查。
如果 setfacl 和 chown 都失败，并且不允许其他用户访问模块的文件，则会将它们 chgrp 到此组。
为了使此设置起作用，remote_user 和 become_user 必须共享一个公共组，并且此设置必须设置为该组。
- ANSIBLE_DISPLAY_FAILED_STDERR
切换以控制失败和不可访问的任务是显示到 STDERR 而不是 STDOUT。
- ANSIBLE_DISPLAY_OK_HOSTS
切换以控制在任务中是否显示“ok”任务/主机结果。
- ANSIBLE_INVENTORY_PLUGIN_EXTS
包含 YAML 文件的“有效”扩展名列表
- ANSIBLE_INVENTORY_PLUGIN_SCRIPT_STDERR
即使脚本成功，也可以切换显示 stderr
- ANSIBLE_INVENTORY_USE_EXTRA_VARS
将额外变量合并到可用于组合的可用变量中（优先级最高）。
- ANSIBLE_LOOKUP_URL_AGENT
要在请求中使用的 User-Agent。在 2.11 中，默认值已更改为
ansible-httpget。
- ANSIBLE_LOOKUP_URL_CA_PATH
要使用的 CA 证书捆绑包的文件系统路径字符串
- ANSIBLE_LOOKUP_URL_CIPHERS
用于请求的 SSL/TLS 密码
当提供列表时，所有密码将按顺序使用
:连接有关详细信息，请参阅OpenSSL 密码列表格式。
可用密码取决于 Python 和 OpenSSL/LibreSSL 版本
- ANSIBLE_LOOKUP_URL_FOLLOW_REDIRECTS
URI 模块是否应遵循重定向。
- ANSIBLE_LOOKUP_URL_FORCE
是否设置值为“no-cache”的“cache-control”标头
- ANSIBLE_LOOKUP_URL_FORCE_BASIC_AUTH
强制基本身份验证
- ANSIBLE_LOOKUP_URL_TIMEOUT
在放弃之前，等待服务器发送数据的时间
- ANSIBLE_LOOKUP_URL_UNIX_SOCKET
用于在与提供的 URL 建立连接时使用的 Unix 套接字文件的文件系统路径字符串
- ANSIBLE_LOOKUP_URL_UNREDIR_HEADERS
一个不附加到重定向请求的标头列表
- ANSIBLE_LOOKUP_URL_USE_GSSAPI
使用请求的 GSSAPI 处理程序
从 Ansible 2.11 开始，可以使用
username和password指定 GSSAPI 凭据。
- ANSIBLE_LOOKUP_URL_USE_NETRC
确定是否使用来自 ``~/.netrc`` 文件的凭据
默认情况下，.netrc 与基本身份验证标头一起使用
设置为 False 时，将忽略 .netrc 凭据
- ANSIBLE_PARAMIKO_BANNER_TIMEOUT
配置等待 SSH banner 呈现的秒数。此选项受 paramiko 1.15.0 或更新版本支持。
- ANSIBLE_PARAMIKO_HOST_KEY_CHECKING
如果您想避免 Ansible 用于连接主机的底层工具进行主机密钥检查，请将此项设置为 “False”。
- ANSIBLE_PARAMIKO_PRIVATE_KEY_FILE
用于身份验证的私钥文件路径。
- ANSIBLE_PARAMIKO_PROXY_COMMAND
通过跳转主机运行连接的代理信息。
- ANSIBLE_PARAMIKO_PTY
SUDO 通常需要 PTY，True 表示给予 PTY，False 表示不给予 PTY。
- ANSIBLE_PARAMIKO_RECORD_HOST_KEYS
将主机密钥保存到文件
- ANSIBLE_PARAMIKO_REMOTE_USER
登录/身份验证的用户
可以通过 CLI 使用
--user或-u选项进行设置。
- ANSIBLE_PARAMIKO_TIMEOUT
插件放弃建立 TCP 连接的超时秒数。
- ANSIBLE_PARAMIKO_USE_RSA_SHA2_ALGORITHMS
是否为公钥和主机密钥启用 RSA SHA2 算法
在低于 2.9 的 paramiko 版本上，此项仅影响主机密钥
为了匹配 paramiko<2.9 的行为，请将其设置为
False
- ANSIBLE_PKCS11_PROVIDER
PKCS11 智能卡提供程序，例如 opensc，示例：/usr/local/lib/opensc-pkcs11.so
需要 sshpass 1.06+ 版本，sshpass 必须支持 -P 选项。
- ANSIBLE_REMOTE_PARAMIKO_PORT
要连接的远程端口。
- ANSIBLE_REMOTE_TEMP
执行任务时在目标上使用的临时目录。
- ANSIBLE_REMOTE_TMP
执行任务时在目标上使用的临时目录。
- ANSIBLE_RUNAS_FLAGS
要传递给 runas 的选项，一个以空格分隔的 k=v 对列表
- ANSIBLE_RUNAS_PASS
密码
- ANSIBLE_RUNAS_USER
您“变成”以执行任务的用户
- ANSIBLE_SCP_EXECUTABLE
这定义了 scp 二进制文件的位置。它默认为
scp，它将使用 $PATH 中第一个可用的二进制文件。
- ANSIBLE_SCP_EXTRA_ARGS
独占于
scpCLI 的额外参数
- ANSIBLE_SFTP_BATCH_MODE
TODO：写一下
- ANSIBLE_SFTP_EXECUTABLE
这定义了 sftp 二进制文件的位置。它默认为
sftp，它将使用 $PATH 中第一个可用的二进制文件。
- ANSIBLE_SFTP_EXTRA_ARGS
独占于
sftpCLI 的额外参数
- ANSIBLE_SHELL_ALLOW_WORLD_READABLE_TEMP
这使得机器上创建的临时文件全局可读，并且会发出警告而不是使任务失败。
当变成非特权用户时，此项很有用。
- ANSIBLE_SHOW_PER_HOST_START
这会添加输出，显示每个主机何时开始执行任务。
- ANSIBLE_SHOW_TASK_PATH_ON_FAILURE
当任务失败时，显示包含失败任务的文件路径和行号。当以
-vv或更高级别的详细程度运行时，此信息会自动为每个任务显示。
- ANSIBLE_SSH_ARGS
要传递给所有 SSH CLI 工具的参数。
- ANSIBLE_SSH_COMMON_ARGS
所有 SSH CLI 工具的常用额外参数。
- 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_SSH_CONTROL_PATH_DIR
如果控制路径设置为空，则此项设置用于 ssh 控制路径的目录。
此外，为控制路径设置提供 ``%(directory)s`` 变量。
- ANSIBLE_SSH_EXECUTABLE
这定义了 SSH 二进制文件的位置。它默认为
ssh，它将使用 $PATH 中第一个可用的 SSH 二进制文件。通常不需要此选项，当对系统 SSH 的访问受到限制，或者当使用 SSH 包装器连接到远程主机时，它可能很有用。
- ANSIBLE_SSH_EXTRA_ARGS
独占于 SSH CLI 的额外参数。
- ANSIBLE_SSH_HOST_KEY_CHECKING
请参阅使用此环境变量的选项的文档。
使用于： ansible.builtin.paramiko_ssh 连接插件, ansible.builtin.ssh 连接插件
- ANSIBLE_SSH_PIPELINING
管道化通过执行多个 Ansible 模块而无需实际的文件传输，从而减少了在远程服务器上执行模块所需的连接操作次数。
启用后，可以带来非常显著的性能提升。
但是，这可能会与权限提升 (
become) 冲突。例如，当使用 sudo 操作时，您必须首先在目标主机的 sudoers 文件中禁用requiretty，这就是为什么默认情况下禁用此功能的原因。
- ANSIBLE_SSH_RETRIES
连接尝试次数。
仅当 Ansible 收到返回码为 255 的 SSH 错误时，它才会重试连接。
返回码为 255 以外的任何错误都表示程序执行存在问题。
- ANSIBLE_SSH_TIMEOUT
请参阅使用此环境变量的选项的文档。
使用于： ansible.builtin.paramiko_ssh 连接插件, ansible.builtin.ssh 连接插件
- ANSIBLE_SSH_TRANSFER_METHOD
通过 ssh 传输文件时要使用的首选方法
- ANSIBLE_SSH_USETTY
向 ssh 命令添加 -tt 以强制分配 tty。
- ANSIBLE_SSHPASS_PROMPT
sshpass 应搜索的密码提示。sshpass 1.06 及更高版本支持。
当设置了 pkcs11_provider 时，默认为
Enter PIN for。
- ANSIBLE_SU_EXE
Su 可执行文件
- ANSIBLE_SU_FLAGS
传递给 su 的选项
- ANSIBLE_SU_PASS
传递给 su 的密码
- ANSIBLE_SU_PROMPT_L10N
用于匹配提示检测的本地化字符串列表
如果为空，我们将使用内置的字符串
不要在自定义条目中添加冒号 (:)。Ansible 会在每个提示的末尾添加冒号；如果在您的字符串中添加另一个冒号，您的提示将会因为 “超时” 错误而失败。
- ANSIBLE_SU_USER
您“变成”以执行任务的用户
- ANSIBLE_SUDO_EXE
Sudo 可执行文件
- ANSIBLE_SUDO_FLAGS
传递给 sudo 的选项
- ANSIBLE_SUDO_PASS
传递给 sudo 的密码
- ANSIBLE_SUDO_USER
您“变成”以执行任务的用户
- ANSIBLE_SYSTEM_TMPDIRS
受管机器上有效的系统临时目录列表，供 Ansible 验证
remote_tmp是否匹配，当需要特定权限时。 这些目录必须是全局可读、可写和可执行的。 此列表应仅包含系统管理员已预先创建并具有正确所有权和权限的目录，否则可能会出现安全问题。当
remote_tmp需要是一个系统临时目录且与列表中的任何目录都不匹配时，将改为使用列表中的第一个目录。
- ANSIBLE_VARS_PLUGIN_STAGE
控制何时可以执行此变量插件。
将此选项设置为
all将在导入清单后以及任务需要时运行变量插件。将此选项设置为
task将仅在任务需要时运行变量插件。将此选项设置为
inventory将仅在解析清单后运行变量插件。如果省略此选项，则使用全局
RUN_VARS_PLUGINS配置来确定何时执行变量插件。
- JUNIT_FAIL_ON_CHANGE
将任何报告“已更改”的任务视为 junit 测试失败
- JUNIT_FAIL_ON_IGNORE
即使设置了 ignore_on_error，也将失败的任务视为 junit 测试失败
- JUNIT_HIDE_TASK_ARGUMENTS
隐藏任务的参数
- JUNIT_INCLUDE_SETUP_TASKS_IN_REPORT
是否应在最终报告中包含设置任务
- JUNIT_OUTPUT_DIR
用于写入 XML 文件的目录。
- JUNIT_REPLACE_OUT_OF_TREE_PATH
将树外相对任务路径的目录部分替换为给定的占位符
- JUNIT_TASK_CLASS
配置输出，使每个 yaml 文件一个类
- JUNIT_TASK_RELATIVE_PATH
配置输出，以使用给定目录的相对路径
- JUNIT_TEST_CASE_PREFIX
仅当任务具有此前缀值时，才将任务视为测试用例。此外，失败的任务会被记录为失败的测试用例。