所有集合环境变量索引<a class="headerlink" href="#index-of-all-collection-environment-variables" title="链接到此标题">

ANSIBLE_OPENTELEMETRY_DISABLE_LOGS

禁用发送日志。

ANSIBLE_OPENTELEMETRY_ENABLE_FROM_ENVIRONMENT

是否仅当给定的环境变量存在并设置为 true 时才启用此回调。

当您使用配置即代码，并且希望在 CI 中运行时发送分布式跟踪，而不是在本地运行 Ansible 时，这非常方便。

为此，它会将给定的 enable_from_environment 值作为环境变量进行评估，如果设置为 true，则将启用此插件。

ANSIBLE_OPENTELEMETRY_HIDE_TASK_ARGUMENTS

隐藏任务的参数。

使用于： community.general.elastic 回调插件, community.general.opentelemetry 回调插件

ANSIBLE_OPENTELEMETRY_STORE_SPANS_IN_FILE

它将导出的 span 存储在给定的文件中

ANSIBLE_PARAMIKO_BANNER_TIMEOUT

以秒为单位配置等待 SSH 横幅显示的时间。此选项受 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_PBRUN_EXE

Sudo 可执行文件。

ANSIBLE_PBRUN_FLAGS

传递给 pbrun 的选项。

ANSIBLE_PBRUN_PASS

pbrun 的密码。

ANSIBLE_PBRUN_USER

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

ANSIBLE_PBRUN_WRAP_EXECUTION

切换是否将 pbrun 调用的命令包装在 shell -c 中。

ANSIBLE_PERSISTENT_BUFFER_READ_TIMEOUT

以秒为单位配置在匹配命令提示符后等待从 Paramiko 通道读取数据的时间。此超时值确保匹配的命令提示符正确，并且没有更多数据需要从远程主机接收。

使用于: ansible.netcommon.network_cli 连接插件

ANSIBLE_PERSISTENT_LOG_MESSAGES

此标志将启用在 ansible 日志文件中记录执行的命令和从目标设备收到的响应。要使此选项起作用，需要将 'log_path' ansible 配置选项设置为具有写入权限的文件路径。

请务必充分了解启用此选项的安全隐患，因为它可能会通过在日志文件中记录敏感信息而产生安全漏洞。

使用于: ansible.netcommon.grpc 连接插件、ansible.netcommon.httpapi 连接插件、ansible.netcommon.netconf 连接插件、ansible.netcommon.network_cli 连接插件、ansible.netcommon.persistent 连接插件

ANSIBLE_PFEXEC_EXE

Sudo 可执行文件。

ANSIBLE_PFEXEC_FLAGS

传递给 pfexec 的选项。

ANSIBLE_PFEXEC_PASS

pfexec 密码。

ANSIBLE_PFEXEC_USER

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

此插件会忽略此设置，因为 pfexec 使用自己的 exec_attr 来确定这一点，但此处提供它是为了让 Ansible 能够做出任务执行所需的决策，例如文件权限。

ANSIBLE_PFEXEC_WRAP_EXECUTION

切换是否将 pfexec 调用的命令包装在 shell -c 中。

ANSIBLE_PKCS11_PROVIDER

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

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

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

ANSIBLE_PLATFORM_TYPE

设置平台类型。

使用于： ansible.netcommon.httpapi 连接插件

ANSIBLE_PMRUN_EXE

Sudo 可执行文件

使用于： community.general.pmrun 成为插件

ANSIBLE_PMRUN_FLAGS

传递给 pmrun 的选项。

使用于： community.general.pmrun 成为插件

ANSIBLE_PMRUN_PASS

pmrun 密码。

使用于： community.general.pmrun 成为插件

ANSIBLE_PODMAN_EXECUTABLE

podman 命令的可执行文件。

使用于： containers.podman.podman 连接插件

ANSIBLE_PODMAN_EXTRA_ARGS

传递给 podman 命令行的额外参数。

使用于： containers.podman.podman 连接插件

ANSIBLE_REDIS_HOST

Redis 主机的位置

使用于： community.general.redis 查找插件

ANSIBLE_REDIS_PORT

Redis 正在侦听的端口

使用于： community.general.redis 查找插件

ANSIBLE_REDIS_SOCKET

要查询 Redis 的套接字路径，设置此选项时会覆盖主机和端口选项。

使用于： community.general.redis 查找插件

ANSIBLE_REMOTE_PARAMIKO_PORT

要连接的远程端口。

ANSIBLE_REMOTE_TEMP

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

使用于： ansible.builtin.sh shell 插件, ansible.posix.csh shell 插件, ansible.posix.fish shell 插件

ANSIBLE_REMOTE_TMP

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

使用于： ansible.builtin.sh shell 插件, ansible.posix.csh shell 插件, ansible.posix.fish shell 插件

ANSIBLE_ROOT_CERTIFICATES_FILE

PEM 编码的根证书文件，用于创建启用 SSL 的通道，如果值为 None，它会从 gRPC 在运行时选择的默认位置读取根证书。

使用于： ansible.netcommon.grpc 连接插件

ANSIBLE_RUN0_EXE

run0 可执行文件。

使用于： community.general.run0 成为插件

ANSIBLE_RUN0_FLAGS

传递给 run0 的选项。

使用于： community.general.run0 成为插件

ANSIBLE_RUN0_USER

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

使用于： community.general.run0 成为插件

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_SELECTIVE_DONT_COLORIZE

此设置允许抑制着色输出。

使用于： community.general.selective 回调插件

ANSIBLE_SESU_EXE

sesu 可执行文件。

ANSIBLE_SESU_FLAGS

传递给 sesu 的选项。

ANSIBLE_SESU_PASS

传递给 sesu 的密码。

ANSIBLE_SESU_USER

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

使用于: ansible.builtin.default 回调插件, ansible.posix.debug 回调插件, ansible.posix.skippy 回调插件, community.general.counter_enabled 回调插件, community.general.default_without_diff 回调插件, community.general.dense 回调插件, community.general.diy 回调插件, community.general.timestamp 回调插件, community.general.unixy 回调插件, community.general.yaml 回调插件

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.posix.csh shell 插件, ansible.posix.fish shell 插件

ANSIBLE_SHOW_PER_HOST_START

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

ANSIBLE_SHOW_TASK_PATH_ON_FAILURE

当任务失败时，显示包含失败任务的文件路径和行号。当以 -vv 或更高详细级别运行时，将为每个任务自动显示此信息。

使用于: ansible.builtin.default 回调插件, ansible.posix.debug 回调插件, ansible.posix.skippy 回调插件, community.general.counter_enabled 回调插件, community.general.default_without_diff 回调插件, community.general.dense 回调插件, community.general.diy 回调插件, community.general.timestamp 回调插件, community.general.unixy 回调插件, community.general.yaml 回调插件

ANSIBLE_SOPS_AGE_KEY

一个或多个可用于解密加密文件的 age 私钥。

在调用 SOPS 时，将设置为 SOPS_AGE_KEY 环境变量。

需要 SOPS 3.7.1+。

使用于： community.sops.sops 查找插件, community.sops.sops 变量插件

ANSIBLE_SOPS_AGE_KEYFILE

包含 SOPS 可用于解密加密文件的 age 私钥的文件。

在调用 SOPS 时，将设置为 SOPS_AGE_KEY_FILE 环境变量。

默认情况下，SOPS 会在您的用户配置目录中查找 sops/age/keys.txt。

需要 SOPS 3.7.0+。

使用于： community.sops.sops 查找插件, community.sops.sops 变量插件

ANSIBLE_SOPS_AWS_ACCESS_KEY_ID

用于向 AWS 发出请求的 AWS 访问密钥 ID。

为 SOPS 调用设置环境变量 AWS_ACCESS_KEY_ID。

使用于： community.sops.sops 查找插件, community.sops.sops 变量插件

ANSIBLE_SOPS_AWS_PROFILE

用于向 AWS 发出请求的 AWS 配置文件。

这对应于 SOPS --aws-profile 选项。

使用于： community.sops.sops 查找插件, community.sops.sops 变量插件

ANSIBLE_SOPS_AWS_SECRET_ACCESS_KEY

用于向 AWS 发出请求的 AWS 秘密访问密钥。

为 SOPS 调用设置环境变量 AWS_SECRET_ACCESS_KEY。

使用于： community.sops.sops 查找插件, community.sops.sops 变量插件

ANSIBLE_SOPS_AWS_SESSION_TOKEN

用于向 AWS 发出请求的 AWS 会话令牌。

为 SOPS 调用设置环境变量 AWS_SESSION_TOKEN。

使用于： community.sops.sops 查找插件, community.sops.sops 变量插件

ANSIBLE_SOPS_BINARY

SOPS 二进制文件的路径。

默认情况下使用 sops。

使用于： community.sops.sops 查找插件, community.sops.sops 变量插件

ANSIBLE_SOPS_CONFIG_PATH

SOPS 配置文件的路径。

如果未设置，SOPS 将从加密或解密的文件开始递归搜索配置文件。

这对应于 SOPS --config 选项。

使用于： community.sops.sops 查找插件, community.sops.sops 变量插件

ANSIBLE_SOPS_ENABLE_LOCAL_KEYSERVICE

告诉 SOPS 使用本地密钥服务。

这对应于 SOPS --enable-local-keyservice 选项。

使用于： community.sops.sops 查找插件, community.sops.sops 变量插件

ANSIBLE_SOPS_KEYSERVICE

指定要在本地服务旁边使用的密钥服务。

必须以 协议://地址 的形式指定密钥服务，例如 tcp://myserver.com:5000。

这对应于 SOPS --keyservice 选项。

使用于： community.sops.sops 查找插件, community.sops.sops 变量插件

ANSIBLE_SSH_ARGS

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

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

ANSIBLE_SSH_COMMON_ARGS

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

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

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

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

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

ANSIBLE_SSH_HOST_KEY_CHECKING

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

使用于： ansible.builtin.paramiko_ssh 连接插件, ansible.builtin.ssh 连接插件, ansible.netcommon.libssh 连接插件, ansible.netcommon.netconf 连接插件, ansible.netcommon.network_cli 连接插件

ANSIBLE_SSH_PIPELINING

通过执行许多没有实际文件传输的 Ansible 模块，管道传输减少了在远程服务器上执行模块所需的连接操作次数。

启用此功能时，可以显著提高性能。

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

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

ANSIBLE_SSH_RETRIES

尝试连接的次数。

仅当 Ansible 收到返回代码为 255 的 SSH 错误时，Ansible 才会重试连接。

返回代码不是 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 成为插件, containers.podman.podman_unshare 成为插件

ANSIBLE_SUDO_FLAGS

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

使用于： ansible.builtin.sudo 成为插件, community.general.sudosu 成为插件

ANSIBLE_SUDO_PASS

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

使用于： ansible.builtin.sudo 成为插件, community.general.sudosu 成为插件, containers.podman.podman_unshare 成为插件

ANSIBLE_SUDO_USER

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

使用于： ansible.builtin.sudo 成为插件, community.general.sudosu 成为插件, containers.podman.podman_unshare 成为插件

ANSIBLE_SUDOSU_ALT_METHOD

是否使用替代方法调用 su。它不是运行 su -l user /path/to/shell -c command，而是运行 su -l user -c command。

当默认方法在您的系统上不起作用时使用此选项。

使用于： community.general.sudosu 成为插件

ANSIBLE_SYSLOG_SETUP

日志设置任务。

ANSIBLE_SYSTEM_TMPDIRS

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

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

使用于： ansible.builtin.sh shell 插件, ansible.posix.csh shell 插件, ansible.posix.fish shell 插件

ANSIBLE_VARS_PLUGIN_STAGE

控制此变量插件何时可以执行。

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

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

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

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

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

ANSIBLE_VARS_SOPS_PLUGIN_CACHE

是否缓存解密的文件。

如果禁用缓存，则几乎每个任务都会解密文件。这非常慢！

仅当您在 playbook 运行时修改变量文件并希望更新的结果可用于下一个任务时，才禁用缓存。

请注意，设置 stage=inventory 与设置 cache=true 的效果相同：变量将仅加载一次（在加载清单期间），并且不会为每个任务调用变量插件。

使用于： community.sops.sops 变量插件

ANSIBLE_VARS_SOPS_PLUGIN_HANDLE_UNENCRYPTED_FILES

如何处理与 valid_extensions 中的扩展名匹配但未通过 SOPS 加密的文件。

默认值 error 将产生错误。

值 skip 将简单地跳过这些文件。这需要 SOPS 3.9.0 或更高版本。

值 warn 将跳过这些文件并发出警告。这需要 SOPS 3.9.0 或更高版本。

注意，如果 SOPS 使用的存储无法解析该文件（例如，因为尽管其文件扩展名，但它不是有效的 JSON/YAML/…文件），这将无济于事。对于默认扩展名之外的扩展名，SOPS 使用二进制存储，该存储尝试将该文件解析为 JSON。

使用于： community.sops.sops 变量插件

ANSIBLE_VARS_SOPS_PLUGIN_STAGE

控制此变量插件何时可以执行。

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

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

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

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

使用于： community.sops.sops 变量插件

ANSIBLE_VARS_SOPS_PLUGIN_VALID_EXTENSIONS

查找“变量”文件时，请检查所有这些扩展名。

这些文件必须是通过 SOPS 加密的 YAML 或 JSON 文件。

默认情况下，当插件遇到与这些扩展名匹配但未通过 SOPS 加密的文件时，会产生错误。此行为可以通过 handle_unencrypted_files 选项进行控制。

使用于： community.sops.sops 变量插件

ANSIBLE_XO_HOST

XOA API 的 API 主机。

如果未在清单配置中指定该值，则将使用环境变量 ANSIBLE_XO_HOST 的值。

使用于： community.general.xen_orchestra 清单插件

ANSIBLE_XO_PASSWORD

Xen Orchestra 密码。

如果未在清单配置中指定该值，则将使用环境变量 ANSIBLE_XO_PASSWORD 的值。

使用于： community.general.xen_orchestra 清单插件

ANSIBLE_XO_USER

Xen Orchestra 用户。

如果未在清单配置中指定该值，则将使用环境变量 ANSIBLE_XO_USER 的值。

使用于： community.general.xen_orchestra 清单插件

ANSIBLE_ZABBIX_AUTH_KEY

指定 API 身份验证密钥

使用于： community.zabbix.zabbix httpapi 插件

ANSIBLE_ZABBIX_URL_PATH

指定 Zabbix WebUI URL 中的路径部分，例如，对于 https://myzabbixfarm.com/zabbixeu，zabbix_url_path=zabbixeu。

如果 Zabbix WebUI 在根目录运行，即 https://myzabbixfarm.com/，则将空字符串分配给此变量 zabbix_url_path: ''。

使用于： community.zabbix.zabbix httpapi 插件

AWS_ACCESS_KEY

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

AWS_ACCESS_KEY_ID

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

AWS_DEFAULT_PROFILE

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

AWS_DEFAULT_REGION

EC2 实例所在的区域。

使用于： community.aws.aws_ssm 连接插件

AWS_PROFILE

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

AWS_REGION

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

AWS_SECRET_ACCESS_KEY

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

AWS_SECRET_KEY

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

AWS_SECURITY_TOKEN

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

AWS_SESSION_TOKEN

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

AWS_URL

用于连接而不是默认 AWS 端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。

endpoint 别名已被弃用，将在 2024-12-01 之后的版本中删除。

使用于： amazon.aws.aws_account_attribute 查找插件, amazon.aws.aws_ec2 清单插件, amazon.aws.aws_rds 清单插件, amazon.aws.secretsmanager_secret 查找插件, amazon.aws.ssm_parameter 查找插件, community.aws.aws_mq 清单插件

BWS_ACCESS_TOKEN

用于此查找的 BWS 访问令牌。

使用于： community.general.bitwarden_secrets_manager 查找插件

CGROUP_CONTROL_GROUP

cgroups 控制组的名称

CGROUP_CPU_POLL_INTERVAL

用于确定 CPU 使用率的 CPU 轮询间隔。较低的值可能会产生不准确的结果，较高的值可能不够短，无法收集短任务的结果。

CGROUP_CUR_MEM_FILE

memory.usage_in_bytes 文件的路径。示例 /sys/fs/cgroup/memory/ansible_profile/memory.usage_in_bytes。

使用于： community.general.cgroup_memory_recap 回调插件

CGROUP_DISPLAY_RECAP

控制是否在末尾打印摘要，如果您将自动处理输出文件，则此选项很有用

CGROUP_FILE_NAME_FORMAT

文件名的格式。接受 %(counters), %(task_uuids), %(features), %(exts)。当 file_per_task 为 False 时，默认为 %(features.%(ext)s)；当 True 时，默认为 %(counters-%(task_uuid)s-%(feature)s.%(ext)s)

CGROUP_FILE_PER_TASK

当设置为 True 并与 write_files 一起使用时，此回调将为每个任务写入 1 个文件，而不是为整个 playbook 运行写入 1 个文件

CGROUP_MAX_MEM_FILE

cgroups memory.max_usage_in_bytes 文件的路径。示例 /sys/fs/cgroup/memory/ansible_profile/memory.max_usage_in_bytes。

使用于： community.general.cgroup_memory_recap 回调插件

CGROUP_MEMORY_POLL_INTERVAL

用于确定内存使用率的内存轮询间隔。较低的值可能会产生不准确的结果，较高的值可能不够短，无法收集短任务的结果。

CGROUP_OUTPUT_DIR

用于存储记录性能读取的文件输出目录。如果该值包含单个 %s，则 playbook 运行的开始时间将插入到该空格中。如果最深层的目录不存在，则只会创建该目录，不会创建父目录。

CGROUP_OUTPUT_FORMAT

输出格式，可以是 CSV 或 JSON-seq

CGROUP_PID_POLL_INTERVAL

用于确定 PID 数量的 PID 轮询间隔。较低的值可能会产生不准确的结果，较高的值可能不够短，无法收集短任务的结果。

CGROUP_WRITE_FILES

指示是否写入包含性能读取的文件

CLOUDSTACK_ENDPOINT

CloudStack API 的 URL，例如 https://cloud.example.com/client/api。

如果未给出，则会考虑 CLOUDSTACK_ENDPOINT 环境变量。

CLOUDSTACK_KEY

CloudStack API 的 API 密钥。

如果未给出，则会考虑 CLOUDSTACK_KEY 环境变量。

CLOUDSTACK_METHOD

用于查询 API 端点的 HTTP 方法。

如果未给出，则会考虑 CLOUDSTACK_METHOD 环境变量。

CLOUDSTACK_SECRET

CloudStack API 的密钥。

如果未设置，则会考虑 CLOUDSTACK_SECRET 环境变量。

CLOUDSTACK_TIMEOUT

HTTP 超时时间（秒）。

如果未给出，则会考虑 CLOUDSTACK_TIMEOUT 环境变量。

CLOUDSTACK_VERIFY

验证 CA 授权证书文件。

如果未给出，则会考虑 CLOUDSTACK_VERIFY 环境变量。

COBBLER_PASSWORD

Cobbler 身份验证密码。

使用于： community.general.cobbler 清单插件

COBBLER_SERVER

Cobbler 的 URL。

使用于： community.general.cobbler 清单插件

COBBLER_USER

Cobbler 身份验证用户。

使用于： community.general.cobbler 清单插件

CONJUR_ACCOUNT

Conjur 帐户

CONJUR_APPLIANCE_URL

Conjur 设备 URL

CONJUR_AUTHN_API_KEY

Conjur authn API 密钥

CONJUR_AUTHN_LOGIN

Conjur authn 登录名

CONJUR_AUTHN_TOKEN_FILE

访问令牌文件的路径

CONJUR_CERT_FILE

Conjur 证书文件的路径

CONJUR_CONFIG_FILE

Conjur 配置文件的路径。配置文件是一个 YAML 文件。

CONJUR_IDENTITY_FILE

Conjur 身份文件的路径。身份文件遵循 netrc 文件格式约定。

CONTROLLER_HOST

您的自动化平台控制器主机的网络地址。

使用于： awx.awx.controller 清单插件, awx.awx.controller_api 查找插件

CONTROLLER_INVENTORY

您希望导入的清单的 ID。

允许使用清单主键或其命名 URL slug。

主键值将接受为字符串或整数，URL slug 必须是字符串。

命名 URL slug 遵循“inventory_name++organization_name”的语法。

使用于： awx.awx.controller 清单插件

CONTROLLER_OAUTH_TOKEN

要使用的 OAuth 令牌。

使用于： awx.awx.controller 清单插件, awx.awx.controller_api 查找插件

CONTROLLER_PASSWORD

您的控制器用户的密码。

使用于： awx.awx.controller 清单插件, awx.awx.controller_api 查找插件

CONTROLLER_REQUEST_TIMEOUT

指定 Ansible 在请求控制器主机时应使用的超时时间。

默认为 10 秒

这不适用于导出或导入模块。

使用于： awx.awx.controller 清单插件, awx.awx.controller_api 查找插件

CONTROLLER_USERNAME

您计划用来访问控制器上清单的用户。

使用于： awx.awx.controller 清单插件, awx.awx.controller_api 查找插件

CONTROLLER_VERIFY_SSL

指定 Ansible 是否应验证控制器主机的 SSL 证书。

默认为 True，但这由共享的 module_utils 代码处理

使用于： awx.awx.controller 清单插件, awx.awx.controller_api 查找插件

DSV_CLIENT_ID

用于请求访问授权的 client_id。

使用于： community.general.dsv 查找插件

DSV_CLIENT_SECRET

与特定 client_id 关联的客户端密钥。

使用于： community.general.dsv 查找插件

DSV_TENANT

默认 url_template 中的第一个格式参数。

使用于： community.general.dsv 查找插件

DSV_TLD

租户的顶级域名；默认 url_template 中的第二个格式参数。

使用于： community.general.dsv 查找插件

DSV_URL_TEMPLATE

要添加到基本 URL 前以形成有效的 REST API 请求的路径。

使用于： community.general.dsv 查找插件

EC2_ACCESS_KEY

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

EC2_REGION

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

EC2_SECRET_KEY

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

EC2_SECURITY_TOKEN

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

EC2_URL

用于连接而不是默认 AWS 端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。

endpoint 别名已被弃用，将在 2024-12-01 之后的版本中删除。

使用于： amazon.aws.aws_account_attribute 查找插件, amazon.aws.aws_ec2 清单插件, amazon.aws.aws_rds 清单插件, amazon.aws.secretsmanager_secret 查找插件, amazon.aws.ssm_parameter 查找插件, community.aws.aws_mq 清单插件

ELASTIC_APM_API_KEY

使用 APM API 密钥

ELASTIC_APM_SECRET_TOKEN

使用 APM 服务器令牌

ELASTIC_APM_SERVER_URL

使用 APM 服务器及其环境变量。

ELASTIC_APM_SERVICE_NAME

服务名称资源属性。

ELASTIC_APM_VERIFY_SERVER_CERT

如果使用 HTTPS 连接，则验证 SSL 证书。

ETCDCTL_CACERT

etcd3 CA 授权。

ETCDCTL_CERT

etcd3 客户端证书。

ETCDCTL_DIAL_TIMEOUT

客户端超时。

ETCDCTL_ENDPOINTS

与 ETCDCTL_ENDPOINTS 环境变量对应的参数。使用 URL 格式指定 etcd3 连接，例如 https://hostname:2379，或 <host>:<port> 格式。

如果定义了 host 选项，则 host 部分将被覆盖。

如果定义了 port 选项，则 port 部分将被覆盖。

ETCDCTL_KEY

etcd3 客户端私钥。

ETCDCTL_PASSWORD

已验证用户的密码。

ETCDCTL_USER

已验证用户的用户名。

FOREMAN_CALLBACK_DISABLE

切换以使回调插件即使在加载后也禁用自身。

可以将其设置为 '1'，以防止即使加载了插件也无法使用。

FOREMAN_DIR_STORE

设置后，回调不会执行 HTTP 调用，而是将结果存储在给定目录中。

对于每个报告，都会创建一个新的 SEQ_NO-hostname.json 格式的文件。

对于每个事实，都会创建一个新的 SEQ_NO-hostname.json 格式的文件。

该值必须是有效的目录。

这用于调试和测试目的。

当设置为空白（默认）时，此功能将被关闭。

FOREMAN_PASSWORD

访问 Foreman 服务器的用户的密码。

FOREMAN_PROXY_URL

Foreman Smart Proxy 服务器的 URL。

FOREMAN_REPORT_TYPE

报告的端点类型：foreman 或 proxy

FOREMAN_SERVER

Foreman 服务器的 URL。

使用于： theforeman.foreman.foreman 回调插件, theforeman.foreman.foreman 清单插件

FOREMAN_SERVER_URL

Foreman 服务器的 URL。

使用于： theforeman.foreman.foreman 回调插件, theforeman.foreman.foreman 清单插件

FOREMAN_SSL_CERT

如果使用 https，则用于向 Foreman 验证身份的 X509 证书

FOREMAN_SSL_KEY

相应的私钥

FOREMAN_SSL_VERIFY

切换以决定是否验证 Foreman 证书。

可以将其设置为 '1' 以使用已安装的 CA 验证 SSL 证书，或将其设置为指向 CA 包的路径。

设置为 '0' 以禁用证书检查。

FOREMAN_URL

Foreman 服务器的 URL。

使用于： theforeman.foreman.foreman 回调插件, theforeman.foreman.foreman 清单插件

FOREMAN_USER

访问 Foreman 服务器的用户名。

FOREMAN_USERNAME

访问 Foreman 服务器的用户名。

FOREMAN_VALIDATE_CERTS

是否验证 Foreman 服务器的 TLS 证书。

GCE_CREDENTIALS_FILE_PATH

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

GCP_ACCESS_TOKEN

如果凭据类型为 accesstoken，则为 OAuth2 访问令牌。

GCP_AUTH_KIND

使用的凭据类型。

GCP_SCOPES

身份验证范围列表

GCP_SERVICE_ACCOUNT_CONTENTS

一个字符串，表示服务帐户 JSON 文件的内容。不应将其作为字典传递，而应作为具有服务帐户 json 文件（有效 JSON）确切内容的字符串传递。

GCP_SERVICE_ACCOUNT_EMAIL

如果选择了 machineaccount 并且用户不希望使用默认电子邮件，则为可选的服务帐户电子邮件地址。

GCP_SERVICE_ACCOUNT_FILE

如果选择 serviceaccount 作为类型，则为服务帐户 JSON 文件的路径。

GITLAB_API_TOKEN

用于登录的 GitLab 令牌。

使用于： community.general.gitlab_runners 清单插件

GITLAB_FILTER

从 GitLab API 筛选运行器

使用于： community.general.gitlab_runners 清单插件

GITLAB_SERVER_URL

GitLab 服务器的 URL，带有协议（即 http 或 https）。

使用于： community.general.gitlab_runners 清单插件

GRAFANA_API_KEY

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

使用于： community.grafana.grafana_annotations 回调插件, community.grafana.grafana_dashboard 查找插件

GRAFANA_DASHBOARD_ID

应在其中创建注释的 grafana 仪表板 ID。

GRAFANA_DASHBOARD_SEARCH

用于仪表板搜索的可选筛选器。

使用于： community.grafana.grafana_dashboard 查找插件

GRAFANA_ORG_ID

grafana 组织 ID。

使用于： community.grafana.grafana_dashboard 查找插件

GRAFANA_PANEL_IDS

应在其中创建注释的 grafana 面板 ID。提供单个整数或以逗号分隔的整数列表。

GRAFANA_PASSWORD

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

使用于： community.grafana.grafana_annotations 回调插件, community.grafana.grafana_dashboard 查找插件

GRAFANA_URL

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

使用于： community.grafana.grafana_annotations 回调插件, community.grafana.grafana_dashboard 查找插件

GRAFANA_USER

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

使用于： community.grafana.grafana_annotations 回调插件, community.grafana.grafana_dashboard 查找插件

GRAFANA_VALIDATE_CERT

验证 Grafana 服务器的 SSL 证书。（对于 HTTPS URL）

HCLOUD_ENDPOINT

Hetzner Cloud 的 API 端点。

使用于： hetzner.hcloud.hcloud 清单插件

HCLOUD_TOKEN

Hetzner Cloud 的 API 令牌。

使用于： hetzner.hcloud.hcloud 清单插件

HETZNER_DNS_TOKEN

Hetzner API 的令牌。

如果未提供，将从环境变量 HETZNER_DNS_TOKEN 中读取。

使用于： community.dns.hetzner_dns_records 清单插件

HROBOT_API_PASSWORD

Robot Web 服务用户的密码。

使用于： community.hrobot.robot 清单插件

HROBOT_API_USER

Robot Web 服务用户的用户名。

使用于： community.hrobot.robot 清单插件

HTTP_AGENT

在 HTTP 请求中设置的 HTTP ‘User-agent’ 值。

INFOBLOX_HOST

指定用于通过 REST 连接到 NIOS WAPI 远程实例的 DNS 主机名或地址。

也可以使用 INFOBLOX_HOST 环境变量指定值。

使用于： infoblox.nios_modules.nios_inventory 清单插件

INFOBLOX_PASSWORD

指定用于验证与 NIOS 远程实例连接的密码。

也可以使用 INFOBLOX_PASSWORD 环境变量指定值。

使用于： infoblox.nios_modules.nios_inventory 清单插件

INFOBLOX_USERNAME

配置用于验证与 NIOS 远程实例连接的用户名。

也可以使用 INFOBLOX_USERNAME 环境变量指定值。

使用于： infoblox.nios_modules.nios_inventory 清单插件

JABBER_PASS

Jabber 服务器用户的密码

JABBER_SERV

到 Jabber 服务器的连接信息

JABBER_TO

将接收消息的聊天标识符

JABBER_USER

用于身份验证的 Jabber 用户

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

K8S_AUTH_API_KEY

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

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

K8S_AUTH_CERT_FILE

用于通过 API 进行身份验证的证书的路径。

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

K8S_AUTH_CONTAINER

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

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

K8S_AUTH_CONTEXT

在 K8s 配置文件中找到的上下文的名称。

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

K8S_AUTH_EXTRA_ARGS

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

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

K8S_AUTH_HOST

用于访问 API 的 URL。

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

K8S_AUTH_KEY_FILE

用于通过 API 进行身份验证的密钥文件的路径。

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

K8S_AUTH_KUBECONFIG

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

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

K8S_AUTH_NAMESPACE

Pod 的命名空间

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

K8S_AUTH_PASSWORD

提供用于使用 API 进行身份验证的密码。

请注意，这会直接在命令行上传递信息，并且可能会暴露敏感数据。我们建议改用基于文件的身份验证选项。

使用于： kubernetes.core.kubectl 连接插件

K8S_AUTH_POD

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

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

K8S_AUTH_SERVER

用于访问 API 的 URL。

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

K8S_AUTH_SSL_CA_CERT

用于通过 API 进行身份验证的 CA 证书的路径。

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

K8S_AUTH_TOKEN

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

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

K8S_AUTH_USERNAME

提供用于使用 API 进行身份验证的用户名。

使用于： kubernetes.core.kubectl 连接插件

K8S_AUTH_VERIFY_SSL

是否验证 API 服务器的 SSL 证书。默认为 true。

使用于： community.okd.oc 连接插件，kubernetes.core.kubectl 连接插件

LINODE_ACCESS_TOKEN

Linode 帐户个人访问令牌。

使用于： community.general.linode 清单插件

LOGDNA_HOSTNAME

备用主机名；默认情况下为当前主机名。

使用于: community.general.logdna 回调插件

LOGDNA_INGESTION_KEY

LogDNA 采集密钥。

使用于: community.general.logdna 回调插件

LOGDNA_TAGS

标签。

使用于: community.general.logdna 回调插件

LOGENTRIES_ANSIBLE_TOKEN

logentries TCP 令牌。

LOGENTRIES_API

Logentries API 的 URI。

LOGENTRIES_FLATTEN

将复杂的数据结构展平为带有复杂键的单个字典。

LOGENTRIES_PORT

连接到 API 时使用的 HTTP 端口。

LOGENTRIES_TLS_PORT

启用 TLS 时，连接到 API 时要使用的端口。

LOGENTRIES_USE_TLS

切换以决定是否使用 TLS 加密与 API 服务器的通信。

LOGSTASH_FORMAT_VERSION

日志格式。

LOGSTASH_PORT

Logstash 正在监听的端口。

LOGSTASH_PRE_COMMAND

在运行之前执行命令，其结果将添加到 ansible_pre_command_output logstash 字段。

LOGSTASH_SERVER

Logstash 服务器的地址。

LOGSTASH_TYPE

消息类型。

MANIFOLD_API_TOKEN

manifold API 令牌

使用于： community.general.manifold 查找插件

MICROSOFT_AD_LDAP_AUTH_PROTOCOL

连接到 LDAP 主机时要使用的身份验证协议。

如果使用 LDAPS/StartTLS 并且指定了certificate，则默认为 certificate。否则，默认为 negotiate。

simple 是简单的身份验证，其中用户和密码以明文形式发送。它不支持任何加密，因此必须与 LDAPS 或 StartTLS 一起使用。如果在没有 TLS 的纯文本 LDAP 连接上使用，则必须指定 encrypt=False 以明确选择不加密。

certificate 是 TLS 客户端证书身份验证。它只能与 LDAPS 或 StartTLS 一起使用。有关如何指定用于身份验证的客户端证书的更多信息，请参阅certificate。

negotiate 将尝试协商 Kerberos 身份验证，并回退到 NTLM。如果 Kerberos 可用，则在未指定用户名或密码的情况下可以使用 Kerberos 凭据缓存。

kerberos 将使用 Kerberos 身份验证，不回退到 NTLM。

ntlm 将使用 NTLM 身份验证，不尝试 Kerberos。

negotiate、kerberos 和 ntlm 支持通过 LDAP 进行加密。

Kerberos 支持需要安装 pyspnego[kerberos] 附加组件。

有关更多信息，请参阅 LDAP 身份验证。

可以使用 Jinja2 模板值设置此选项。

MICROSOFT_AD_LDAP_CA_CERT

可以是用于证书验证的 CA 证书 PEM 或 DER 文件路径、PEM 证书目录或 CA 证书 PEM 字符串。

如果省略，用于验证的默认 CA 存储取决于当前的 Python 设置。

可以使用 Jinja2 模板值设置此选项。

MICROSOFT_AD_LDAP_CERT_VALIDATION

使用 TLS 连接时的证书验证行为。

可以将其设置为 always、ignore、ignore_hostname。

always 将执行证书主机名和 CA 验证。

ignore 将忽略任何证书错误。

ignore_hostname 将验证 CA 信任链，但会忽略 TLS 执行的任何主机名检查。

有关更多信息，请参阅证书验证。

可以使用 Jinja2 模板值设置此选项。

MICROSOFT_AD_LDAP_CERTIFICATE

用于证书身份验证的证书或带有密钥的证书捆绑包。

该值可以是包含证书的文件路径，也可以是 PEM 编码的证书字符串。

如果使用证书文件的路径，则该文件可以是 PEM 编码的证书、PEM 编码的证书和密钥捆绑包、DER 编码的证书或 PFX/PKCS12 编码的证书和密钥捆绑包。

如果指定的证书不包含密钥，请使用 certificate_key。

如果密钥使用密码加密，请使用 certificate_password。

可以使用 Jinja2 模板值设置此选项。

MICROSOFT_AD_LDAP_CERTIFICATE_KEY

用于证书身份验证的证书密钥。

该值可以是包含 PEM 或 DER 编码形式的密钥的文件路径，也可以是 PEM 编码的密钥字符串。

如果密钥使用密码加密，请使用 certificate_password。

可以使用 Jinja2 模板值设置此选项。

MICROSOFT_AD_LDAP_CERTIFICATE_PASSWORD

用于解密由 certificate 或 certificate_key 指定的证书密钥的密码。

可以使用 Jinja2 模板值设置此选项。

MICROSOFT_AD_LDAP_CONNECTION_TIMEOUT

在连接建立之前等待的超时时间（以秒为单位），超时将导致失败。

可以使用 Jinja2 模板值设置此选项。

MICROSOFT_AD_LDAP_ENCRYPT

连接是否需要加密。

可以使用身份验证协议或通过 TLS 执行加密。

auth_protocol negotiate、kerberos 和 ntlm 都支持通过 LDAP 进行加密，而 simple 不支持。

如果在没有 TLS 的 LDAP 上使用 auth_protocol=simple，则必须将其设置为 False。由于不使用加密，所有流量将以明文形式传输，应避免这种情况。

可以使用 Jinja2 模板值设置此选项。

MICROSOFT_AD_LDAP_PASSWORD

用于身份验证的密码。

如果 auth_protocol 为 simple 且未指定密码，则绑定将作为未经身份验证的绑定执行。

如果 auth_protocol 为 negotiate、kerberos 或 ntlm 且未指定密码，则它将尝试使用 username 指定的本地缓存凭据（如果可用）。

可以使用 Jinja2 模板值设置此选项。

MICROSOFT_AD_LDAP_PORT

用于连接的 LDAP 端口。

端口 389 用于 LDAP，端口 686 用于 LDAPS。

如果 tls_mode=ldaps，则默认为端口 636，否则为 389。

可以使用 Jinja2 模板值设置此选项。

MICROSOFT_AD_LDAP_SERVER

要连接的域控制器/服务器。

如果未指定，则服务器将从当前的 krb5.conf default_realm 设置派生，并通过 SRV DNS 查找。

有关更多信息，请参阅服务器查找。

可以使用 Jinja2 模板值设置此选项。

MICROSOFT_AD_LDAP_TLS_MODE

要使用的 TLS 操作。

如果将显式 port 设置为 636，则默认为 ldaps。

ldaps 将通过 LDAPS（端口 636）连接。

start_tls 将通过 LDAP（端口 389）连接，并在身份验证绑定之前执行 StartTLS 操作。

如果将要使用 TLS，建议使用 ldaps 而不是 start_tls。

可以使用 Jinja2 模板值设置此选项。

MICROSOFT_AD_LDAP_USERNAME

用于身份验证的用户名。

如果 auth_protocol 为 simple 且未指定用户名，则使用匿名身份验证。

如果 auth_protocol 为 negotiate、kerberos 或 ntlm 且未指定用户名，则它将尝试使用本地缓存凭据（如果可用），例如通过 kinit 检索的凭据。

可以使用 Jinja2 模板值设置此选项。

NETBOX_API

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

用于： netbox.netbox.nb_inventory 清单插件、netbox.netbox.nb_lookup 查找插件

NETBOX_API_KEY

NetBox API 令牌，以便能够读取 NetBox。

根据 NetBox 设置，这可能不是必需的。

如果您的 NetBox 部署正在使用更高级的身份验证（如 OAUTH），则可以为令牌提供“类型”和“值”。

如果您不提供“类型”和“值”参数，则 HTTP 授权标头将设置为“Token”，这是 NetBox 默认值

用于： netbox.netbox.nb_inventory 清单插件

NETBOX_API_TOKEN

通过 NetBox 创建的 API 令牌

根据 NetBox 设置，这可能不是必需的。

用于： netbox.netbox.nb_lookup 查找插件

NETBOX_TOKEN

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

用于： netbox.netbox.nb_inventory 清单插件、netbox.netbox.nb_lookup 查找插件

NETBOX_URL

要查询的 NetBox 实例的 URL

用于： netbox.netbox.nb_lookup 查找插件

NRDP_HOSTNAME

被动检查链接到的主机名。

NRDP_SERVICENAME

被动检查链接到的服务。

NRDP_TOKEN

允许推送 nrdp 事件的令牌。

NRDP_URL

nrdp 服务器的 URL。

NRDP_VALIDATE_CERTS

验证 nrdp 服务器的 SSL 证书。（用于 HTTPS URL。）

OME_HOSTNAME

OpenManage Enterprise 或 OpenManage Enterprise Modular IP 地址或主机名。

如果任务中未指定该值，则会改用环境变量 OME_HOSTNAME 的值。

使用于： dellemc.openmanage.ome_inventory 清单插件

OME_PASSWORD

OpenManage Enterprise 或 OpenManage Enterprise Modular 的密码。

如果任务中未指定该值，则会改用环境变量 OME_PASSWORD 的值。

使用于： dellemc.openmanage.ome_inventory 清单插件

OME_USERNAME

OpenManage Enterprise 或 OpenManage Enterprise Modular 的用户名。

如果任务中未指定该值，则会改用环境变量 OME_USERNAME 的值。

使用于： dellemc.openmanage.ome_inventory 清单插件

ONE_AUTH

如果未设置 api_username 或 api_password，则会尝试使用 ONE 身份验证文件进行身份验证。默认路径为 ~/.one/one_auth。

设置环境变量 ONE_AUTH 以覆盖此路径。

ONE_PASSWORD

用于登录 OpenNebula RPC 服务器的用户的密码或令牌。

如果未设置，则会使用 ONE_PASSWORD 环境变量的值。

ONE_URL

OpenNebula RPC 服务器的 URL。

建议使用 HTTPS，以便用户名/密码不会以未加密的方式通过网络传输。

如果未设置，则会使用 ONE_URL 环境变量的值。

ONE_USERNAME

用于登录 OpenNebula RPC 服务器的用户名。如果未设置，则会使用 ONE_USERNAME 环境变量的值。

请参阅 https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html#envvar-OTEL_EXPORTER_OTLP_TRACES_PROTOCOL。

ONLINE_API_KEY

Online OAuth 令牌。

使用于： community.general.online 清单插件

ONLINE_OAUTH_TOKEN

Online OAuth 令牌。

使用于： community.general.online 清单插件

ONLINE_TOKEN

Online OAuth 令牌。

使用于： community.general.online 清单插件

OP_CONNECT_HOST

1Password Connect 的主机。必须与 connect_token 结合使用。

使用于： community.general.onepassword 查找插件， community.general.onepassword_doc 查找插件， community.general.onepassword_raw 查找插件

OP_CONNECT_TOKEN

1Password Connect 的令牌。必须与 connect_host 结合使用。

使用于： community.general.onepassword 查找插件， community.general.onepassword_doc 查找插件， community.general.onepassword_raw 查找插件

OP_SERVICE_ACCOUNT_TOKEN

服务帐户的访问密钥。

仅适用于 1Password CLI 版本 2 或更高版本。

使用于： community.general.onepassword 查找插件， community.general.onepassword_doc 查找插件， community.general.onepassword_raw 查找插件

OS_CLIENT_CONFIG_FILE

覆盖 clouds.yaml 文件的路径。

如果给定此值，将首先搜索此值。

云凭据的搜索路径还补充了文件 /etc/ansible/openstack.{yaml,yml}。

默认搜索路径记录在 https://docs.openstack.org/os-client-config/latest/user/configuration.html#config-files。

使用于： openstack.cloud.openstack 清单插件

OTEL_EXPORTER_OTLP_TRACES_PROTOCOL

OTEL_EXPORTER_OTLP_TRACES_PROTOCOL 表示 span 的传输协议。

OTEL_SERVICE_NAME

服务名称资源属性。

OVIRT_PASSWORD

ovirt 身份验证密码。

使用于： ovirt.ovirt.ovirt 清单插件

OVIRT_URL

ovirt-engine API 的 URL。

使用于： ovirt.ovirt.ovirt 清单插件

OVIRT_USERNAME

ovirt 身份验证用户。

使用于： ovirt.ovirt.ovirt 清单插件

PASSWORD_STORE_DIR

密码存储的目录。

如果 backend=pass，则默认使用 ~/.password-store。

如果 backend=gopass，则默认值为 ~/.config/gopass/config.yml 中的 path 字段，如果 gopass 配置中未定义 path，则回退到 ~/.local/share/gopass/stores/root。

使用于： community.general.passwordstore 查找插件

PASSWORD_STORE_UMASK

为创建的 .gpg 文件设置 umask。第一个八进制数必须大于 3（用户可读）。

请注意，pass 的默认值为 '077'。

使用于： community.general.passwordstore 查找插件

PROFILE_ROLES_SUMMARY_ONLY

仅显示摘要，不显示单个任务配置文件。与 DISPLAY_SKIPPED_HOSTS=false 和/或 ANSIBLE_DISPLAY_OK_HOSTS=false 结合使用时尤其有用。

使用于： ansible.posix.profile_roles 回调插件

PROFILE_TASKS_SORT_ORDER

调整摘要任务的排序输出

使用于： ansible.posix.profile_tasks 回调插件

PROFILE_TASKS_SUMMARY_ONLY

仅显示摘要，不显示单个任务配置文件。与 DISPLAY_SKIPPED_HOSTS=false 和/或 ANSIBLE_DISPLAY_OK_HOSTS=false 结合使用时尤其有用。

使用于： ansible.posix.profile_tasks 回调插件

PROFILE_TASKS_TASK_OUTPUT_LIMIT

要在摘要中显示的任务数

使用于： ansible.posix.profile_tasks 回调插件

PROXMOX_PASSWORD

Proxmox 身份验证密码。

如果清单配置中未指定该值，则会改用环境变量 PROXMOX_PASSWORD 的值。

自 community.general 4.7.0 起，您还可以使用模板来指定 password 的值。

如果您未指定密码，则必须改为设置 token_id 和 token_secret。

PROXMOX_TOKEN_ID

Proxmox 身份验证令牌 ID。

如果清单配置中未指定该值，则会改用环境变量 PROXMOX_TOKEN_ID 的值。

要使用令牌身份验证，还必须指定 token_secret。如果您未指定 token_id 和 token_secret，则必须改为设置密码。

请确保向令牌授予明确的 pve 权限或禁用“权限分离”以改用用户的权限。

PROXMOX_TOKEN_SECRET

Proxmox 身份验证令牌密钥。

如果清单配置中未指定该值，则会改用环境变量 PROXMOX_TOKEN_SECRET 的值。

要使用令牌身份验证，还必须指定 token_id。如果您未指定 token_id 和 token_secret，则必须改为设置密码。

PROXMOX_URL

Proxmox 集群的 URL。

如果清单配置中未指定该值，则将使用环境变量 PROXMOX_URL 的值。

从 community.general 4.7.0 版本开始，您还可以使用模板来指定 url 的值。

PROXMOX_USER

Proxmox 身份验证用户。

如果清单配置中未指定该值，则将使用环境变量 PROXMOX_USER 的值。

从 community.general 4.7.0 版本开始，您还可以使用模板来指定 user 的值。

SCW_API_KEY

Scaleway OAuth 令牌。

如果未显式定义或在环境变量中定义，它将尝试在 scaleway-cli 配置文件中查找（$SCW_CONFIG_PATH、$XDG_CONFIG_HOME/scw/config.yaml 或 ~/.config/scw/config.yaml）。

有关如何生成令牌的更多详细信息。

使用于： community.general.scaleway 清单插件

SCW_OAUTH_TOKEN

Scaleway OAuth 令牌。

如果未显式定义或在环境变量中定义，它将尝试在 scaleway-cli 配置文件中查找（$SCW_CONFIG_PATH、$XDG_CONFIG_HOME/scw/config.yaml 或 ~/.config/scw/config.yaml）。

有关如何生成令牌的更多详细信息。

使用于： community.general.scaleway 清单插件

SCW_TOKEN

Scaleway OAuth 令牌。

如果未显式定义或在环境变量中定义，它将尝试在 scaleway-cli 配置文件中查找（$SCW_CONFIG_PATH、$XDG_CONFIG_HOME/scw/config.yaml 或 ~/.config/scw/config.yaml）。

有关如何生成令牌的更多详细信息。

使用于： community.general.scaleway 清单插件

SLACK_CHANNEL

要发布到的 Slack 房间。

SLACK_USERNAME

要作为其发布的用户名。

SLACK_VALIDATE_CERTS

验证 HTTPS URL 的 Slack 服务器的 SSL 证书。

SLACK_WEBHOOK_URL

Slack Webhook URL。

SMTPHOST

邮件传输代理，接受 SMTP 的服务器。

使用于： community.general.mail 回调插件

SOPS_ANSIBLE_AWX_DISABLE_VARS_PLUGIN_TEMPORARILY

临时禁用此插件。

如果 ansible-inventory 应该在不解密密钥的情况下运行（例如在 AWX 中），则此项很有用。

使用于： community.sops.sops 变量插件

SPLUNK_AUTHTOKEN

用于验证与 Splunk HTTP 收集器连接的令牌。

SPLUNK_BATCH

可以在多个 playbook 执行中设置的相关 ID。

SPLUNK_INCLUDE_MILLISECONDS

是否在发送到 Splunk HTTP 收集器的事件中包含毫秒作为生成的时间戳字段的一部分。

SPLUNK_URL

Splunk HTTP 收集器源的 URL。

SPLUNK_VALIDATE_CERTS

是否验证与 HEC 连接的证书。不建议设置为 false，除非您确定没有人可以拦截此插件和 HEC 之间的连接，因为将其设置为 false 允许中间人攻击！

SUMOLOGIC_URL

Sumologic HTTP 收集器源的 URL。

使用于： community.general.sumologic 回调插件

SYSLOG_FACILITY

要作为其登录的 Syslog 设备。

SYSLOG_PORT

syslog 服务器正在侦听的端口。

SYSLOG_SERVER

将接收事件的 Syslog 服务器。

TOWER_HOST

您的自动化平台控制器主机的网络地址。

使用于： awx.awx.controller 清单插件, awx.awx.controller_api 查找插件

TOWER_OAUTH_TOKEN

要使用的 OAuth 令牌。

使用于： awx.awx.controller 清单插件, awx.awx.controller_api 查找插件

TOWER_PASSWORD

您的控制器用户的密码。

使用于： awx.awx.controller 清单插件, awx.awx.controller_api 查找插件

TOWER_USERNAME

您计划用来访问控制器上清单的用户。

使用于： awx.awx.controller 清单插件, awx.awx.controller_api 查找插件

TOWER_VERIFY_SSL

指定 Ansible 是否应验证控制器主机的 SSL 证书。

默认为 True，但这由共享的 module_utils 代码处理

使用于： awx.awx.controller 清单插件, awx.awx.controller_api 查找插件

TRACEPARENT

W3C 跟踪上下文标头 traceparent。

使用于： community.general.elastic 回调插件, community.general.opentelemetry 回调插件

TSS_API_PATH_URI

要附加到基本 URL 以形成有效 REST API 请求的路径。

使用于： community.general.tss 查找插件

TSS_BASE_URL

服务器的基本 URL，例如 https://127.0.0.1/SecretServer。

使用于： community.general.tss 查找插件

TSS_DOMAIN

用于请求 OAuth2 访问授权的域。

当不提供 token 时，此项为可选。

需要 python-tss-sdk 版本 1.0.0 或更高版本。

使用于： community.general.tss 查找插件

TSS_PASSWORD

与提供的用户名关联的密码。

当不提供 token 时，此项为必需。

使用于： community.general.tss 查找插件

TSS_TOKEN

Thycotic 授权器的现有令牌。

如果提供，则不需要 username 和 password。

需要 python-tss-sdk 版本 1.0.0 或更高版本。

使用于： community.general.tss 查找插件

TSS_TOKEN_PATH_URI

要附加到基本 URL 以形成有效 OAuth2 访问授权请求的路径。

使用于： community.general.tss 查找插件

TSS_USERNAME

用于请求 OAuth2 访问授权的用户名。

使用于： community.general.tss 查找插件

VI_PASSWORD

连接的密码。

VI_PORTNUMBER

连接的端口。

VI_SERVER

连接的 FQDN 或 IP 地址（vCenter 或 ESXi 主机）。

VI_USERNAME

连接的用户名。

需要虚拟机上的以下权限：- VirtualMachine.GuestOperations.Execute - VirtualMachine.GuestOperations.Modify - VirtualMachine.GuestOperations.Query

使用于： vmware.vmware_rest.cluster_moid 查找插件, vmware.vmware_rest.datacenter_moid 查找插件, vmware.vmware_rest.datastore_moid 查找插件, vmware.vmware_rest.folder_moid 查找插件, vmware.vmware_rest.host_moid 查找插件, vmware.vmware_rest.network_moid 查找插件, vmware.vmware_rest.resource_pool_moid 查找插件, vmware.vmware_rest.vm_moid 查找插件

VMWARE_HOST

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

VMWARE_PASSWORD

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

VMWARE_PORT

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

使用于： community.vmware.vmware_host_inventory 清单插件, community.vmware.vmware_tools 连接插件, community.vmware.vmware_vm_inventory 清单插件

VMWARE_PROXY_HOST

接收所有 HTTPS 请求并中继它们的代理地址。

格式为主机名或 IP 地址。

使用于： community.vmware.vmware_host_inventory 清单插件, community.vmware.vmware_vm_inventory 清单插件

VMWARE_PROXY_PORT

接收所有 HTTPS 请求并中继它们的 HTTP 代理端口。

使用于： community.vmware.vmware_host_inventory 清单插件, community.vmware.vmware_vm_inventory 清单插件

VMWARE_REST_LOG_FILE

您可以使用此可选参数设置日志文件的位置。

此文件将用于记录 HTTP REST 交互。

该文件将存储在运行模块的主机上。

VMWARE_SERVER

vCenter 或 ESXi 服务器的名称。

使用于： community.vmware.vmware_host_inventory 清单插件, community.vmware.vmware_vm_inventory 清单插件

VMWARE_USER

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

VMWARE_USERNAME

vSphere 用户名。

接受 vault 加密变量。

接受 Jinja 模板化该值

使用于： community.vmware.vmware_host_inventory 清单插件, community.vmware.vmware_vm_inventory 清单插件

VMWARE_VALIDATE_CERTS

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

VULTR_API_ENDPOINT

API 端点的 URL（不带尾部斜杠）。

备用环境变量 VULTR_API_ENDPOINT。

使用于： vultr.cloud.vultr 清单插件

VULTR_API_KEY

Vultr API 的 API 密钥。

备用环境变量 VULTR_API_KEY。

使用于： vultr.cloud.vultr 清单插件

VULTR_API_RESULTS_PER_PAGE

当接收大量实例时，指定每次调用 API 应返回多少实例。

这不会决定返回多少结果；所有实例都会根据其他过滤器返回。

Vultr API 最大值为 500。

备用环境变量 VULTR_API_RESULTS_PER_PAGE。

使用于： vultr.cloud.vultr 清单插件

VULTR_API_TIMEOUT

到 Vultr API 的 HTTP 超时时间。

备用环境变量 VULTR_API_TIMEOUT。

使用于： vultr.cloud.vultr 清单插件

WORKSPACE_ID

Azure 日志分析工作区的 Workspace ID。

使用于： community.general.loganalytics 回调插件

WORKSPACE_SHARED_KEY

连接到 Azure 日志分析工作区的共享密钥。

使用于： community.general.loganalytics 回调插件

ZABBIX_PASSWORD

Zabbix 用户密码。

ZABBIX_SERVER

Zabbix 服务器的 URL，带有协议（http 或 https）。url 是 server_url 的别名。

ZABBIX_USERNAME

Zabbix 用户名。

ZABBIX_VALIDATE_CERTS

如果设置为 False，将不验证 SSL 证书。这应该仅在个人控制的使用自签名证书的站点上使用。