所有集合环境变量索引
以下索引记录了集合中插件声明的所有环境变量。ansible-core 配置使用的环境变量在Ansible 配置设置中有文档记录。
- AIM_CLIPASSWORDSDK_CMD
Cyberark CLI 实用程序。
- ANSIBLE_ADMIN_USERS
预期具有管理员权限的用户列表。控制器使用此列表来确定如何在远程用户和 become 用户之间共享临时文件。
使用于: ansible.builtin.sh shell 插件, ansible.posix.csh shell 插件, ansible.posix.fish shell 插件
- ANSIBLE_ASYNC_DIR
ansible 将保存异步作业信息的目录
使用于: ansible.builtin.sh shell 插件, ansible.posix.csh shell 插件, ansible.posix.fish shell 插件
- ANSIBLE_BECOME_PASS
请参阅使用此环境变量的选项的文档。
使用于: ansible.builtin.runas become 插件, ansible.builtin.su become 插件, ansible.builtin.sudo become 插件, ansible.netcommon.enable become 插件, community.general.doas become 插件, community.general.dzdo become 插件, community.general.ksu become 插件, community.general.machinectl become 插件, community.general.pbrun become 插件, community.general.pfexec become 插件, community.general.pmrun become 插件, community.general.sesu become 插件, community.general.sudosu become 插件, containers.podman.podman_unshare become 插件
- ANSIBLE_CACHE_REDIS_KEYSET_NAME
用户定义的缓存键集名称。
- ANSIBLE_CACHE_REDIS_SENTINEL
redis sentinel 服务名称(或引用为集群名称)。
- ANSIBLE_CALLBACK_DIY_ON_ANY_MSG
用于回调 on_any 的输出。
- ANSIBLE_CALLBACK_DIY_ON_FILE_DIFF_MSG
用于回调 on_file_diff 的输出。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_HANDLER_TASK_START_MSG
用于回调 playbook_on_handler_task_start 的输出。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_HANDLER_TASK_START_MSG_COLOR
用于
playbook_on_handler_task_start_msg
的输出颜色。模板应呈现一个有效的颜色值。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_INCLUDE_MSG
用于回调 playbook_on_include 的输出。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_INCLUDE_MSG_COLOR
用于
playbook_on_include_msg
的输出颜色。模板应呈现一个有效的颜色值。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NO_HOSTS_MATCHED_MSG
用于回调 playbook_on_no_hosts_matched 的输出。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NO_HOSTS_MATCHED_MSG_COLOR
用于
playbook_on_no_hosts_matched_msg
的输出颜色。模板应呈现一个有效的颜色值。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NO_HOSTS_REMAINING_MSG
用于回调 playbook_on_no_hosts_remaining 的输出。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NO_HOSTS_REMAINING_MSG_COLOR
用于
playbook_on_no_hosts_remaining_msg
的输出颜色。模板应呈现一个有效的颜色值。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NOTIFY_MSG
用于回调 playbook_on_notify 的输出。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_PLAY_START_MSG
用于回调 playbook_on_play_start 的输出。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_PLAY_START_MSG_COLOR
用于
playbook_on_play_start_msg
的输出颜色。模板应呈现一个有效的颜色值。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_SETUP_MSG
用于回调 playbook_on_setup 的输出。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_START_MSG
用于回调 playbook_on_start 的输出。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_STATS_MSG
用于回调 playbook_on_stats 的输出。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_TASK_START_MSG
用于回调 playbook_on_task_start 的输出。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_TASK_START_MSG_COLOR
用于
playbook_on_task_start_msg
的输出颜色。模板应呈现一个有效的颜色值。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_VARS_PROMPT_MSG
用于回调 playbook_on_vars_prompt 的输出。
- ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_VARS_PROMPT_MSG_COLOR
用于
playbook_on_vars_prompt_msg
的输出颜色。模板应呈现一个有效的颜色值。
- ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_FAILED_MSG
用于回调 runner_item_on_failed 的输出。
- ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_FAILED_MSG_COLOR
用于
runner_item_on_failed_msg
的输出颜色。模板应呈现一个有效的颜色值。
- ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_OK_MSG
用于回调 runner_item_on_ok 的输出。
- ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_SKIPPED_MSG
用于回调 runner_item_on_skipped 的输出。
- ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_SKIPPED_MSG_COLOR
用于
runner_item_on_skipped_msg
的输出颜色。模板应呈现一个有效的颜色值。
- ANSIBLE_CALLBACK_DIY_RUNNER_ON_FAILED_MSG
用于回调 runner_on_failed 的输出。
- ANSIBLE_CALLBACK_DIY_RUNNER_ON_NO_HOSTS_MSG
用于回调 runner_on_no_hosts 的输出。
- ANSIBLE_CALLBACK_DIY_RUNNER_ON_OK_MSG
用于回调 runner_on_ok 的输出。
- ANSIBLE_CALLBACK_DIY_RUNNER_ON_SKIPPED_MSG
用于回调 runner_on_skipped 的输出。
- ANSIBLE_CALLBACK_DIY_RUNNER_ON_START_MSG
用于回调 runner_on_start 的输出。
- ANSIBLE_CALLBACK_DIY_RUNNER_ON_UNREACHABLE_MSG
用于回调 runner_on_unreachable 的输出。
- ANSIBLE_CALLBACK_DIY_RUNNER_ON_UNREACHABLE_MSG_COLOR
用于
runner_on_unreachable_msg
的输出颜色。模板应呈现一个有效的颜色值。
- ANSIBLE_CALLBACK_DIY_RUNNER_RETRY_MSG
用于回调 runner_retry 的输出。
- 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 回调插件, community.general.default_without_diff 回调插件, community.general.timestamp 回调插件
- ANSIBLE_CALLBACK_RESULT_FORMAT
定义回调输出中使用的任务结果格式。
这些格式不会导致回调发出有效的 JSON 或 YAML 格式。
输出包含这些格式,并与其他非机器可解析的数据混杂在一起。
使用者: ansible.builtin.default 回调插件, ansible.builtin.minimal 回调插件, community.general.default_without_diff 回调插件, community.general.timestamp 回调插件
- ANSIBLE_CALLBACK_TIMESTAMP_TIMEZONE
用于 IANA 时区格式的时间戳的时区。
例如
America/New_York
,Asia/Tokyo
)。在 Python < 3.9 上忽略。
- ANSIBLE_CALLBACK_TREE_DIR
将包含每个主机 JSON 文件的目录。使用 adhoc 时,也可以通过
--tree
选项设置。
- ANSIBLE_CERTIFICATE_CHAIN_FILE
用于创建启用 SSL 的通道的 PEM 编码证书链文件。如果该值为 None,则不使用证书链。
- ANSIBLE_CHECK_MODE_MARKERS
切换以控制在检查模式下运行时是否显示标记。
标记是在剧本执行开始和结束时(当调用
ansible-playbook --check
时)的DRY RUN
,以及在检查模式下运行的每个剧本和任务的后缀CHECK MODE
。使用于: 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_CHROOT_DISABLE_ROOT_CHECK
不检查用户是否为 root。
- ANSIBLE_CHROOT_EXE
用户指定的 chroot 二进制文件
- ANSIBLE_COMMON_REMOTE_GROUP
当 Ansible 需要以其他用户身份执行模块时进行检查。
如果 setfacl 和 chown 都失败,并且不允许其他用户访问模块的文件,则会将这些文件的组更改为这个组。
为了使此功能正常工作,remote_user 和 become_user 必须共享一个公共组,并且此设置必须设置为该组。
使用于: ansible.builtin.sh shell 插件, ansible.posix.csh shell 插件, ansible.posix.fish shell 插件
- ANSIBLE_CONSUL_CLIENT_CERT
用于验证 TLS 连接的客户端证书。
- ANSIBLE_CONSUL_URL
要连接的目标。
应该如下所示:
https://my.consul.server:8500
。
- ANSIBLE_CONSUL_VALIDATE_CERTS
是否验证 TLS 连接。
- ANSIBLE_DISPLAY_FAILED_STDERR
切换以控制失败和不可达的任务是否显示到 STDERR(而不是 STDOUT)
使用于: 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_DISPLAY_OK_HOSTS
切换以控制是否在任务中显示“ok”任务/主机结果
使用于: 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_DOAS_EXE
Doas 可执行文件。
- ANSIBLE_DOAS_FLAGS
传递给 doas 的选项。
- ANSIBLE_DOAS_PASS
doas 提示的密码。
- ANSIBLE_DOAS_PROMPT_L10N
用于匹配提示检测的本地化字符串列表。
如果为空,我们将使用内置的字符串。
- ANSIBLE_DOAS_USER
您“成为”以执行任务的用户。
- ANSIBLE_DOCKER_PRIVILEGED
是否应使用扩展权限运行命令。
请注意,这允许命令有可能逃脱容器。请谨慎使用!
使用于: community.docker.docker 连接插件, community.docker.docker_api 连接插件
- ANSIBLE_DOCKER_TIMEOUT
控制执行开始后,我们可以等待多长时间才能访问从容器读取输出。
使用于: community.docker.docker 连接插件, community.docker.docker_api 连接插件
- ANSIBLE_DOCKER_WORKING_DIR
请参阅使用此环境变量的选项的文档。
使用于: community.docker.docker 连接插件, community.docker.docker_api 连接插件
- ANSIBLE_DZDO_EXE
Dzdo 可执行文件。
- ANSIBLE_DZDO_FLAGS
传递给 dzdo 的选项。
- ANSIBLE_DZDO_PASS
传递给 dzdo 的选项。
- ANSIBLE_DZDO_USER
您“成为”以执行任务的用户。
- ANSIBLE_ENABLE_PASS
密码
- ANSIBLE_EOS_USE_SESSIONS
指定是否应在远程主机上使用会话
- ANSIBLE_ETCD_URL
包含 etcd 服务器 URL 的环境变量
- ANSIBLE_ETCD_VERSION
包含 etcd 协议版本的环境变量
- ANSIBLE_GPRC_SSL_TARGET_NAME_OVERRIDE
此选项覆盖用于 SSL 主机名检查的 SSL 目标名称。用于 SSL 主机名检查的名称将是目标参数(假设安全通道是 SSL 通道)。如果指定此参数,并且底层不是 SSL 通道,则会被忽略。
- ANSIBLE_GRPC_CONNECTION_TYPE
此选项指示 grpc 类型,并且可以代替 network_os 使用。(例如 cisco.iosxr.iosxr)
- ANSIBLE_HASHI_VAULT_ADDR
Vault 服务的 URL。
如果未通过任何其他方式指定,则将使用
VAULT_ADDR
环境变量的值。如果
VAULT_ADDR
也未定义,则会引发错误。使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_AUTH_METHOD
要使用的身份验证方法。
none
身份验证方法是在集合版本1.2.0
中添加的。cert
身份验证方法是在集合版本1.4.0
中添加的。aws_iam_login
在集合版本2.1.0
中重命名为aws_iam
,并在3.0.0
中删除。azure
身份验证方法是在集合版本3.2.0
中添加的。使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_AWS_IAM_SERVER_ID
如果指定,则设置
X-Vault-AWS-IAM-Server-ID
标头的值,作为GetCallerIdentity
请求的一部分。使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_AZURE_CLIENT_ID
Azure AD 服务主体或托管标识的客户端 ID(也称为应用程序 ID)。应该是一个 UUID。
如果未指定,将使用系统分配的托管标识。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_AZURE_CLIENT_SECRET
Azure AD 服务主体的客户端密钥。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_AZURE_RESOURCE
在 Azure Active Directory 中注册的应用程序的资源 URL。通常不应更改默认值。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_AZURE_TENANT_ID
服务主体的 Azure Active Directory 租户 ID(也称为目录 ID)。应为 UUID。
当使用服务主体向 Vault 进行身份验证时,此项为必需,例如,当同时指定了 azure_client_id 和 azure_client_secret 时。
当使用托管标识向 Vault 进行身份验证时,此项为可选。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_CA_CERT
用于身份验证的证书的路径。
如果未通过任何其他方式指定,则将使用
VAULT_CACERT
环境变量。使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_CERT_AUTH_PRIVATE_KEY
对于
cert
身份验证,用于进行身份验证的私钥文件的路径,采用 PEM 格式。使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_CERT_AUTH_PUBLIC_KEY
对于
cert
身份验证,用于进行身份验证的证书文件的路径,采用 PEM 格式。使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_JWT
用于对 Vault 进行 JWT 身份验证的 JSON Web 令牌 (JWT)。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_MOUNT_POINT
Vault 的挂载点。
如果未指定,则使用给定身份验证方法的默认挂载点。
不适用于令牌身份验证。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_NAMESPACE
秘密所在的 Vault 命名空间。此选项需要 HVAC 0.7.0+ 和 Vault 0.11+。
可选地,可以通过在身份验证挂载点和/或秘密路径前加上命名空间来实现(例如
mynamespace/secret/mysecret
)。如果设置了环境变量
VAULT_NAMESPACE
,则将在所有指定 *namespace* 的方式中最后使用它的值。使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_PASSWORD
身份验证密码。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_PROXIES
用于访问 Vault 服务的代理 URL。
它可以是字符串或字典。
如果它是字典,请提供方案(例如
http
或https
)作为键,并将 URL 作为值。如果它是字符串,请提供一个将用作
http
和https
方案的代理的单个 URL。可以解释为字典的字符串将被转换为字典(请参见示例)。
您可以为 HTTP 和 HTTPS 资源指定不同的代理。
如果未指定,则使用 Requests 库中的环境变量。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_RETRIES
允许基于 urllib3 库中的 Retry 类 在出现错误时重试。
此集合为重试与 Vault 的连接定义了建议的默认值。
此选项可以指定为正数(整数)或字典。
如果未指定此选项或数字为
0
,则禁用重试。一个数字设置重试的总次数,并使用集合默认值进行其他设置。
字典值直接用于初始化
Retry
类,因此可以用来完全自定义重试。有关重试的详细信息,请参阅集合用户指南。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_RETRY_ACTION
控制是否以及如何显示 *retries* 上的消息。
如果未重试请求,则此操作无效。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_ROLE_ID
Vault 角色 ID 或名称。用于
approle
、aws_iam
、azure
和cert
身份验证方法。对于
cert
身份验证,如果未提供 *role_id*,则默认行为是尝试所有证书角色并返回任何匹配的角色。对于
azure
身份验证,*role_id* 是必需的。使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_SECRET_ID
用于 Vault AppRole 身份验证的 Secret ID。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_TIMEOUT
设置连接超时(以秒为单位)。
如果未设置,则使用
hvac
库的默认值。使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_TOKEN
Vault 令牌。可以通过列出的 [env] 变量以及
VAULT_TOKEN
环境变量显式指定令牌。如果未显式提供令牌或通过环境变量提供令牌,则插件将检查令牌文件,如 *token_path* 和 *token_file* 所确定的。
令牌加载的顺序(先找到的优先)是
token param -> ansible var -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> token file
。使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_TOKEN_FILE
如果未指定令牌,则会尝试从此文件中的 *token_path* 中读取令牌。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_TOKEN_PATH
如果未指定令牌,则会尝试从此路径读取 *token_file*。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_TOKEN_VALIDATE
对于令牌身份验证,将在使用令牌之前执行
lookup-self
操作来确定令牌的有效性。如果您的令牌没有
lookup-self
功能,请禁用此选项。使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HASHI_VAULT_USERNAME
身份验证用户名。
使用于: community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- ANSIBLE_HIERA_BIN
用于执行 Hiera 的二进制文件。
由以下项目使用: community.general.hiera lookup 插件
- ANSIBLE_HIERA_CFG
描述 Hiera 层级结构的文件。
由以下项目使用: community.general.hiera lookup 插件
- ANSIBLE_HOST_KEY_AUTO_ADD
默认情况下,Ansible 会在将 SSH 密钥添加到已知主机文件之前提示用户。由于持久连接(例如 network_cli)在后台进程中运行,因此永远不会提示用户。通过启用此选项,未知主机密钥将自动添加到已知主机文件中。
请务必完全理解在生产系统上启用此选项的安全性含义,因为它可能会产生安全漏洞。
由以下项目使用: ansible.netcommon.network_cli 连接插件
- ANSIBLE_HOSTTECH_API_PASSWORD
Hosttech API 用户的密码。
如果提供,则还必须提供
hosttech_username
。与
hosttech_token
互斥。
- ANSIBLE_HOSTTECH_API_USERNAME
Hosttech API 用户的用户名。
如果提供,则还必须提供
hosttech_password
。与
hosttech_token
互斥。
- ANSIBLE_HOSTTECH_DNS_TOKEN
Hosttech API 用户的密码。
与
hosttech_username
和hosttech_password
互斥。自 community.dns 1.2.0 起,可以使用别名
api_token
。
- ANSIBLE_HTTPAPI_LOGIN_DOMAIN
用于身份验证的登录域名。
默认值为 Local。
由以下项目使用: cisco.mso.mso httpapi 插件
- ANSIBLE_IGNORE_ERRORS
是否忽略失败时的错误。
由以下项目使用: community.general.logdna 回调插件
- ANSIBLE_INVENTORY_PLUGIN_EXTS
包含 YAML 文件的“有效”扩展名列表
由以下项目使用: ansible.builtin.yaml 库存插件
- ANSIBLE_INVENTORY_PLUGIN_SCRIPT_STDERR
即使脚本成功,也切换显示 stderr
- ANSIBLE_INVENTORY_USE_EXTRA_VARS
将额外变量合并到可用于组合的变量中(优先级最高)。
使用于: amazon.aws.aws_ec2 inventory 插件, amazon.aws.aws_rds inventory 插件, ansible.builtin.constructed inventory 插件, azure.azcollection.azure_rm inventory 插件, cloudscale_ch.cloud.inventory inventory 插件, community.aws.aws_mq inventory 插件, community.digitalocean.digitalocean inventory 插件, community.docker.docker_containers inventory 插件, community.docker.docker_machine inventory 插件, community.docker.docker_swarm inventory 插件, community.general.gitlab_runners inventory 插件, community.general.icinga2 inventory 插件, community.general.linode inventory 插件, community.general.nmap inventory 插件, community.general.opennebula inventory 插件, community.general.proxmox inventory 插件, community.general.stackpath_compute inventory 插件, community.general.virtualbox inventory 插件, community.general.xen_orchestra inventory 插件, community.hrobot.robot inventory 插件, community.libvirt.libvirt inventory 插件, community.vmware.vmware_host_inventory inventory 插件, community.vmware.vmware_vm_inventory inventory 插件, community.zabbix.zabbix_inventory inventory 插件, google.cloud.gcp_compute inventory 插件, hetzner.hcloud.hcloud inventory 插件, kubevirt.core.kubevirt inventory 插件, microsoft.ad.ldap inventory 插件, netbox.netbox.nb_inventory inventory 插件, ngine_io.cloudstack.instance inventory 插件, openstack.cloud.openstack inventory 插件, ovirt.ovirt.ovirt inventory 插件, telekom_mms.icinga_director.icinga_director_inventory inventory 插件, theforeman.foreman.foreman inventory 插件, vultr.cloud.vultr inventory 插件
- ANSIBLE_IOS_COMMIT_CONFIRM_IMMEDIATE
启用或禁用提交确认模式。
在自定义/默认超时后确认推送的配置。(默认为 1 分钟)。
对于自定义超时配置,请设置 commit_confirm_timeout 值。
在 commit_confirm_immediate 上,当变量未显式声明时,commit_confirm_timeout 的默认值被视为 1 分钟。
- ANSIBLE_IOS_COMMIT_CONFIRM_TIMEOUT
在指定的时间(以分钟为单位)内试用提交配置。
在不指定 commit_confirm_immediate 的情况下使用 commit_confirm_timeout,将需要使用 ios_command 模块显式地
configure confirm
来确认/提交所做的更改。请参考示例以了解用例演示。
- ANSIBLE_IOSXR_COMMIT_COMMENT
向确认的提交添加注释。
- ANSIBLE_IOSXR_COMMIT_CONFIRMED
启用或禁用确认提交模式
- ANSIBLE_IOSXR_COMMIT_CONFIRMED_TIMEOUT
在指定的时间(以秒或分钟为单位)内试用提交配置。
- ANSIBLE_IOSXR_COMMIT_LABEL
向确认的提交添加标签。
- ANSIBLE_IOSXR_CONFIG_MODE_EXCLUSIVE
启用或禁用独占配置模式
- ANSIBLE_JSON_INDENT
请参阅使用此环境变量的选项的文档。
- ANSIBLE_KSU_EXE
Su 可执行文件。
- ANSIBLE_KSU_FLAGS
要传递给 ksu 的选项。
- ANSIBLE_KSU_PASS
Ksu 密码。
- ANSIBLE_KSU_PROMPT_L10N
用于匹配提示检测的本地化字符串列表。
如果为空,我们将使用内置的字符串。
- ANSIBLE_KSU_USER
您“成为”以执行任务的用户。
- ANSIBLE_LIBSSH_CONFIG_FILE
备用 SSH 配置文件位置
- ANSIBLE_LIBSSH_HOST_KEY_AUTO_ADD
TODO:写一下
- ANSIBLE_LIBSSH_HOST_KEY_CHECKING
如果您想避免 Ansible 用于连接主机的底层工具进行主机密钥检查,请将其设置为“False”
- ANSIBLE_LIBSSH_LOOK_FOR_KEYS
TODO:写一下
- ANSIBLE_LIBSSH_PROXY_COMMAND
通过跳转主机运行连接的代理信息。
此外,如果设置了此插件,此插件还将扫描 'ssh' 插件设置中的 'ssh_args'、'ssh_extra_args' 和 'ssh_common_args' 以查找代理信息。
- ANSIBLE_LIBSSH_PTY
TODO:写一下
- ANSIBLE_LIBSSH_REMOTE_USER
要登录/验证的用户
可以通过 CLI 通过
--user
或-u
选项设置。
- ANSIBLE_LOG_FOLDER
将创建日志文件的文件夹。
- 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
用于确定如何跟随重定向的 urllib2 字符串,可以是 all/yes、safe 或 none。
- 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_MACHINECTL_EXE
Machinectl 可执行文件。
- ANSIBLE_MACHINECTL_FLAGS
传递给 machinectl 的选项。
- ANSIBLE_MACHINECTL_PASS
machinectl 的密码。
- ANSIBLE_MACHINECTL_USER
您“成为”以执行任务的用户。
- ANSIBLE_MERGE_VARIABLES_OVERRIDE
当键被覆盖时,返回错误、打印警告或忽略它。
默认行为
error
会在键被覆盖时导致插件失败。当使用
warn
和ignore
时,请注意,重要的是要知道变量在合并之前是按名称排序的。此顺序中较晚变量的键将覆盖此顺序中较早变量的同名键。为避免潜在的混淆,请尽可能使用override=error
。
- ANSIBLE_MERGE_VARIABLES_PATTERN_TYPE
更改搜索指定模式的方式。
- ANSIBLE_NETCONF_HOST_KEY_CHECKING
如果您想避免 Ansible 用于连接主机的底层工具进行主机密钥检查,请将其设置为“False”
- ANSIBLE_NETCONF_PROXY_COMMAND
通过跳转主机运行连接的代理信息。
这需要在控制器上安装 ncclient >= 0.6.10。
- ANSIBLE_NETWORK_CLI_RETRIES
连接到远程主机的尝试次数。每次尝试后,重试之间的延迟时间以秒为单位的 2 的幂增加,直到最大尝试次数耗尽或触发任何
persistent_command_timeout
或persistent_connect_timeout
定时器。由以下项目使用: ansible.netcommon.network_cli 连接插件
- ANSIBLE_NETWORK_CLI_SSH_TYPE
network_cli
连接插件将使用 Python 包来创建到远程主机的 SSH 连接。libssh 将使用 ansible-pylibssh 包,该包需要安装才能工作。
paramiko 将改为使用 paramiko 包来管理 SSH 连接。
如果安装了 ansible-pylibssh 包,auto 将使用它,否则将回退到 paramiko。
由以下项目使用: ansible.netcommon.network_cli 连接插件
- ANSIBLE_NETWORK_IMPORT_MODULES
通过启用直接执行来减少 CPU 使用率和网络模块执行时间。模块将不会被打包并通过 shell 执行,而是将由 Ansible 控制节点使用与 Ansible 进程相同的 Python 解释器直接执行。注意 - 与
asynchronous mode
不兼容。注意 - 需要 Python 3 和 Ansible 2.9.16 或更高版本。注意 - 对于 Ansible 2.9.x,任务中需要完全限定的模块名称。使用位置: ansible.netcommon.grpc 连接插件, ansible.netcommon.httpapi 连接插件, ansible.netcommon.netconf 连接插件, ansible.netcommon.network_cli 连接插件, ansible.netcommon.persistent 连接插件
- ANSIBLE_NETWORK_SINGLE_USER_MODE
此选项启用从目标获取的数据的缓存以供重用。当目标设备进入配置模式时,缓存将失效。
仅适用于已实现此功能的平台。
由以下项目使用: ansible.netcommon.network_cli 连接插件
- ANSIBLE_NMAP_ADDRESS
要扫描的网络 IP 或 IP 范围,您可以使用简单的范围 (10.2.2.15-25) 或 CIDR 表示法。
- ANSIBLE_NMAP_EXCLUDE
要排除的地址列表。
例如
10.2.2.15-25
或10.2.2.15,10.2.2.16
。
- ANSIBLE_NSENTER_PID
使用 nsenter 连接的 PID。
除非您以非 root 用户身份附加,否则默认值应该可以。
- ANSIBLE_OPENTELEMETRY_DISABLE_ATTRIBUTES_IN_LOGS
禁用将 span 属性填充到日志中。
- 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
通过跳转主机运行连接的代理信息。
此外,如果设置了此插件,此插件还将扫描 'ssh' 插件设置中的 'ssh_args'、'ssh_extra_args' 和 'ssh_common_args' 以查找代理信息。
- 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_PLATFORM_TYPE
设置平台类型。
- ANSIBLE_PMRUN_EXE
Sudo 可执行文件
- ANSIBLE_PMRUN_FLAGS
传递给 pmrun 的选项。
- ANSIBLE_PMRUN_PASS
pmrun 密码。
- ANSIBLE_PODMAN_EXECUTABLE
podman 命令的可执行文件。
- ANSIBLE_PODMAN_EXTRA_ARGS
传递给 podman 命令行的额外参数。
- ANSIBLE_REDIS_HOST
Redis 主机的位置
- ANSIBLE_REDIS_PORT
Redis 正在侦听的端口
- ANSIBLE_REDIS_SOCKET
要查询 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
用于创建启用 SSL 的通道的 PEM 编码根证书文件,如果该值为 None,则它会从 gRPC 在运行时选择的默认位置读取根证书。
- ANSIBLE_RUN0_EXE
run0
可执行文件。
- ANSIBLE_RUN0_FLAGS
传递给 run0 的选项。
- ANSIBLE_RUN0_USER
您“成为”以执行任务的用户。
- ANSIBLE_RUNAS_FLAGS
传递给 runas 的选项,以空格分隔的 k=v 对列表
- ANSIBLE_RUNAS_PASS
密码
- ANSIBLE_RUNAS_USER
您要“成为”的用户以执行任务
- ANSIBLE_SCP_EXECUTABLE
这定义了 scp 二进制文件的位置。它默认为
scp
,这将使用 $PATH 中第一个可用的二进制文件。
- ANSIBLE_SCP_EXTRA_ARGS
scp
CLI 的额外独有选项。
- ANSIBLE_SELECTIVE_DONT_COLORIZE
此设置允许禁止输出着色。
- ANSIBLE_SESU_EXE
sesu 可执行文件。
- ANSIBLE_SESU_FLAGS
传递给 sesu 的选项。
- ANSIBLE_SESU_PASS
传递给 sesu 的密码。
- ANSIBLE_SESU_USER
您“成为”以执行任务的用户。
- ANSIBLE_SFTP_BATCH_MODE
TODO:写一下
- ANSIBLE_SFTP_EXECUTABLE
此项定义 sftp 二进制文件的位置。默认值为
sftp
,它将使用 $PATH 中第一个可用的二进制文件。
- ANSIBLE_SFTP_EXTRA_ARGS
仅用于
sftp
CLI 的额外参数
- ANSIBLE_SHELL_ALLOW_WORLD_READABLE_TEMP
此项设置会使在机器上创建的临时文件为全局可读,并且会发出警告而不是使任务失败。
当转换为非特权用户时,此项很有用。
使用于: ansible.builtin.sh shell 插件, ansible.posix.csh shell 插件, ansible.posix.fish shell 插件
- ANSIBLE_SHOW_PER_HOST_START
此项添加输出,显示每个主机何时开始执行任务
使用于: 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_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 lookup 插件, community.sops.sops vars 插件
- ANSIBLE_SOPS_AGE_KEYFILE
包含 SOPS 可用于解密加密文件的 age 私钥的文件。
当调用 SOPS 时,将设置为
SOPS_AGE_KEY_FILE
环境变量。默认情况下,SOPS 会在您的用户配置目录中查找
sops/age/keys.txt
。需要 SOPS 3.7.0+。
使用于: community.sops.sops lookup 插件, community.sops.sops vars 插件
- ANSIBLE_SOPS_AWS_ACCESS_KEY_ID
用于向 AWS 发送请求的 AWS 访问密钥 ID。
为 SOPS 调用设置环境变量
AWS_ACCESS_KEY_ID
。使用于: community.sops.sops lookup 插件, community.sops.sops vars 插件
- ANSIBLE_SOPS_AWS_PROFILE
用于向 AWS 发送请求的 AWS 配置文件。
这对应于 SOPS 的
--aws-profile
选项。使用于: community.sops.sops lookup 插件, community.sops.sops vars 插件
- ANSIBLE_SOPS_AWS_SECRET_ACCESS_KEY
用于向 AWS 发送请求的 AWS 秘密访问密钥。
为 SOPS 调用设置环境变量
AWS_SECRET_ACCESS_KEY
。使用于: community.sops.sops lookup 插件, community.sops.sops vars 插件
- ANSIBLE_SOPS_AWS_SESSION_TOKEN
用于向 AWS 发送请求的 AWS 会话令牌。
为 SOPS 调用设置环境变量
AWS_SESSION_TOKEN
。使用于: community.sops.sops lookup 插件, community.sops.sops vars 插件
- ANSIBLE_SOPS_BINARY
SOPS 二进制文件的路径。
默认使用
sops
。使用于: community.sops.sops lookup 插件, community.sops.sops vars 插件
- ANSIBLE_SOPS_CONFIG_PATH
SOPS 配置文件的路径。
如果未设置,SOPS 将从加密或解密的文件开始递归搜索配置文件。
这对应于 SOPS 的
--config
选项。使用于: community.sops.sops lookup 插件, community.sops.sops vars 插件
- ANSIBLE_SOPS_ENABLE_LOCAL_KEYSERVICE
告知 SOPS 使用本地密钥服务。
这对应于 SOPS 的
--enable-local-keyservice
选项。使用于: community.sops.sops lookup 插件, community.sops.sops vars 插件
- ANSIBLE_SOPS_KEYSERVICE
指定要使用(在本地密钥服务之外)的密钥服务。
密钥服务必须以
protocol://address
的形式指定,例如tcp://myserver.com:5000
。这对应于 SOPS 的
--keyservice
选项。使用于: community.sops.sops lookup 插件, community.sops.sops vars 插件
- ANSIBLE_SSH_ARGS
请参阅使用此环境变量的选项的文档。
使用于: ansible.builtin.paramiko_ssh 连接插件, ansible.builtin.ssh 连接插件, ansible.netcommon.libssh 连接插件
- ANSIBLE_SSH_COMMON_ARGS
请参阅使用此环境变量的选项的文档。
使用于: ansible.builtin.paramiko_ssh 连接插件, 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_SSH_CONTROL_PATH_DIR
如果控制路径设置为空,则此项设置用于 ssh 控制路径的目录。
此外,为控制路径设置提供 ``%(directory)s`` 变量。
- ANSIBLE_SSH_EXECUTABLE
此项定义 SSH 二进制文件的位置。默认值为
ssh
,它将使用 $PATH 中第一个可用的 SSH 二进制文件。通常不需要此选项,当限制对系统 SSH 的访问,或者当使用 SSH 包装器连接到远程主机时,此选项可能很有用。
- ANSIBLE_SSH_EXTRA_ARGS
请参阅使用此环境变量的选项的文档。
使用于: ansible.builtin.paramiko_ssh 连接插件, 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_SSH_RETRIES
连接尝试次数。
仅当 Ansible 收到返回码为 255 的 SSH 错误时,Ansible 才会重试连接。
返回码为 255 以外的任何错误都表示程序执行存在问题。
- ANSIBLE_SSH_TIMEOUT
请参阅使用此环境变量的选项的文档。
使用于: ansible.builtin.paramiko_ssh 连接插件, ansible.builtin.ssh 连接插件
- ANSIBLE_SSH_TRANSFER_METHOD
通过 ssh 传输文件时要使用的首选方法
- ANSIBLE_SSH_USETTY
将 -tt 添加到 ssh 命令以强制分配 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.builtin.sudo become 插件, containers.podman.podman_unshare become 插件
- ANSIBLE_SUDO_FLAGS
请参阅使用此环境变量的选项的文档。
使用于: ansible.builtin.sudo become 插件,community.general.sudosu become 插件
- ANSIBLE_SUDO_PASS
请参阅使用此环境变量的选项的文档。
使用于: ansible.builtin.sudo become 插件,community.general.sudosu become 插件,containers.podman.podman_unshare become 插件
- ANSIBLE_SUDO_USER
请参阅使用此环境变量的选项的文档。
使用于: ansible.builtin.sudo become 插件,community.general.sudosu become 插件,containers.podman.podman_unshare become 插件
- ANSIBLE_SUDOSU_ALT_METHOD
是否使用替代方法调用
su
。它不是运行su -l user /path/to/shell -c command
,而是运行su -l user -c command
。当默认方法在您的系统上不起作用时,请使用此方法。
- 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
控制何时可以执行此 vars 插件。
将此选项设置为
all
将在导入清单之后以及任务需要时运行 vars 插件。将此选项设置为
task
将仅在任务需要时运行 vars 插件。将此选项设置为
inventory
将仅在解析清单后运行 vars 插件。如果省略此选项,则使用全局
RUN_VARS_PLUGINS
配置来确定何时执行 vars 插件。
- ANSIBLE_VARS_SOPS_PLUGIN_CACHE
是否缓存解密的文件。
如果禁用缓存,则几乎每个任务都会解密文件。这非常慢!
仅当您在 playbook 运行期间修改变量文件,并希望从下一个任务开始提供更新的结果时才禁用缓存。
请注意,设置
stage=inventory
与设置cache=true
具有相同的效果:变量将仅加载一次(在清单加载期间),并且不会为每个任务调用 vars 插件。
- 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。
- ANSIBLE_VARS_SOPS_PLUGIN_STAGE
控制何时可以执行此 vars 插件。
将此选项设置为
all
将在导入清单之后以及任务需要时运行 vars 插件。将此选项设置为
task
将仅在任务需要时运行 vars 插件。将此选项设置为
inventory
将仅在解析清单后运行 vars 插件。如果省略此选项,则使用全局
RUN_VARS_PLUGINS
配置来确定何时执行 vars 插件。
- ANSIBLE_VARS_SOPS_PLUGIN_VALID_EXTENSIONS
在查找“变量”文件时,检查所有这些扩展名。
这些文件必须是 SOPS 加密的 YAML 或 JSON 文件。
默认情况下,当遇到与这些扩展名匹配但未进行 SOPS 加密的文件时,该插件将产生错误。可以使用
handle_unencrypted_files
选项来控制此行为。
- ANSIBLE_XO_HOST
XOA API 的 API 主机。
如果未在清单配置中指定该值,则将使用环境变量
ANSIBLE_XO_HOST
的值。
- ANSIBLE_XO_PASSWORD
Xen Orchestra 密码。
如果未在清单配置中指定该值,则将使用环境变量
ANSIBLE_XO_PASSWORD
的值。
- ANSIBLE_XO_USER
Xen Orchestra 用户。
如果未在清单配置中指定该值,则将使用环境变量
ANSIBLE_XO_USER
的值。
- ANSIBLE_ZABBIX_AUTH_KEY
指定 API 身份验证密钥
- ANSIBLE_ZABBIX_URL_PATH
指定 Zabbix WebUI URL 中的路径部分,例如,对于 https://myzabbixfarm.com/zabbixeu,zabbix_url_path=zabbixeu。
如果 Zabbix WebUI 在根目录中运行,即 https://myzabbixfarm.com/,则将空字符串分配给此变量
zabbix_url_path: ''
。
- AWS_ACCESS_KEY
请参阅使用此环境变量的选项的文档。
使用于: amazon.aws.aws_account_attribute lookup 插件,amazon.aws.aws_ec2 清单插件,amazon.aws.aws_rds 清单插件,amazon.aws.secretsmanager_secret lookup 插件,amazon.aws.ssm_parameter lookup 插件,community.aws.aws_mq 清单插件,community.hashi_vault.hashi_vault lookup 插件,community.hashi_vault.vault_kv1_get lookup 插件,community.hashi_vault.vault_kv2_get lookup 插件,community.hashi_vault.vault_list lookup 插件,community.hashi_vault.vault_login lookup 插件,community.hashi_vault.vault_read lookup 插件,community.hashi_vault.vault_token_create lookup 插件,community.hashi_vault.vault_write lookup 插件
- AWS_ACCESS_KEY_ID
请参阅使用此环境变量的选项的文档。
使用于: 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 清单插件, community.aws.aws_ssm 连接插件, community.general.credstash 查找插件, community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- AWS_DEFAULT_PROFILE
请参阅使用此环境变量的选项的文档。
使用于: amazon.aws.aws_account_attribute lookup 插件,amazon.aws.aws_ec2 清单插件,amazon.aws.aws_rds 清单插件,amazon.aws.secretsmanager_secret lookup 插件,amazon.aws.ssm_parameter lookup 插件,community.aws.aws_mq 清单插件,community.hashi_vault.hashi_vault lookup 插件,community.hashi_vault.vault_kv1_get lookup 插件,community.hashi_vault.vault_kv2_get lookup 插件,community.hashi_vault.vault_list lookup 插件,community.hashi_vault.vault_login lookup 插件,community.hashi_vault.vault_read lookup 插件,community.hashi_vault.vault_token_create lookup 插件,community.hashi_vault.vault_write lookup 插件
- AWS_DEFAULT_REGION
EC2 实例所在的区域。
- AWS_PROFILE
请参阅使用此环境变量的选项的文档。
使用于: 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 清单插件, community.aws.aws_ssm 连接插件, community.general.credstash 查找插件, community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- AWS_REGION
请参阅使用此环境变量的选项的文档。
使用于: 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 清单插件, community.aws.aws_ssm 连接插件, community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- AWS_SECRET_ACCESS_KEY
请参阅使用此环境变量的选项的文档。
使用于: 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 清单插件, community.aws.aws_ssm 连接插件, community.general.credstash 查找插件, community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- AWS_SECRET_KEY
请参阅使用此环境变量的选项的文档。
使用于: amazon.aws.aws_account_attribute lookup 插件,amazon.aws.aws_ec2 清单插件,amazon.aws.aws_rds 清单插件,amazon.aws.secretsmanager_secret lookup 插件,amazon.aws.ssm_parameter lookup 插件,community.aws.aws_mq 清单插件,community.hashi_vault.hashi_vault lookup 插件,community.hashi_vault.vault_kv1_get lookup 插件,community.hashi_vault.vault_kv2_get lookup 插件,community.hashi_vault.vault_list lookup 插件,community.hashi_vault.vault_login lookup 插件,community.hashi_vault.vault_read lookup 插件,community.hashi_vault.vault_token_create lookup 插件,community.hashi_vault.vault_write lookup 插件
- AWS_SECURITY_TOKEN
请参阅使用此环境变量的选项的文档。
使用于: amazon.aws.aws_account_attribute lookup 插件,amazon.aws.aws_ec2 清单插件,amazon.aws.aws_rds 清单插件,amazon.aws.secretsmanager_secret lookup 插件,amazon.aws.ssm_parameter lookup 插件,community.aws.aws_mq 清单插件,community.hashi_vault.hashi_vault lookup 插件,community.hashi_vault.vault_kv1_get lookup 插件,community.hashi_vault.vault_kv2_get lookup 插件,community.hashi_vault.vault_list lookup 插件,community.hashi_vault.vault_login lookup 插件,community.hashi_vault.vault_read lookup 插件,community.hashi_vault.vault_token_create lookup 插件,community.hashi_vault.vault_write lookup 插件
- AWS_SESSION_TOKEN
请参阅使用此环境变量的选项的文档。
使用于: 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 清单插件, community.aws.aws_ssm 连接插件, community.general.credstash 查找插件, community.hashi_vault.hashi_vault 查找插件, community.hashi_vault.vault_kv1_get 查找插件, community.hashi_vault.vault_kv2_get 查找插件, community.hashi_vault.vault_list 查找插件, community.hashi_vault.vault_login 查找插件, community.hashi_vault.vault_read 查找插件, community.hashi_vault.vault_token_create 查找插件, community.hashi_vault.vault_write 查找插件
- AWS_URL
用于连接的 URL,而不是默认的 AWS 端点。虽然这可以用于连接其他 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 访问令牌。
- 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
。
- CGROUP_DISPLAY_RECAP
控制是否在最后打印摘要,如果您将自动处理输出文件,这将非常有用
- CGROUP_FILE_NAME_FORMAT
文件名格式。接受
%(counter
s)、%(task_uuid
s)、%(feature
s)、%(ext
s)。默认值为当file_per_task
为False
时为%(feature
s.%(ext)s),当True
时为%(counter
s-%(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
。
- 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 身份验证密码。
- COBBLER_SERVER
Cobbler 的 URL。
- COBBLER_USER
Cobbler 身份验证用户。
- CONJUR_ACCOUNT
Conjur 帐户
- CONJUR_APPLIANCE_URL
Conjur 设备 URL
- CONJUR_AUTHN_API_KEY
Conjur 身份验证 API 密钥
- CONJUR_AUTHN_LOGIN
Conjur 身份验证登录名
- CONJUR_AUTHN_TOKEN_FILE
访问令牌文件的路径
- CONJUR_CERT_FILE
Conjur 证书文件的路径
- CONJUR_CONFIG_FILE
Conjur 配置文件的路径。配置文件为 YAML 文件。
- CONJUR_IDENTITY_FILE
Conjur 身份文件的路径。身份文件遵循 netrc 文件格式约定。
- CONTROLLER_HOST
Automation Platform Controller 主机的网络地址。
使用于: awx.awx.controller inventory 插件, awx.awx.controller_api lookup 插件
- CONTROLLER_INVENTORY
您希望导入的清单的 ID。
允许使用清单主键或其命名的 URL slug。
主键值将接受为字符串或整数,URL slug 必须为字符串。
命名的 URL slug 遵循 “inventory_name++organization_name” 的语法。
- CONTROLLER_OAUTH_TOKEN
要使用的 OAuth 令牌。
使用于: awx.awx.controller inventory 插件, awx.awx.controller_api lookup 插件
- CONTROLLER_PASSWORD
您的 Controller 用户的密码。
使用于: awx.awx.controller inventory 插件, awx.awx.controller_api lookup 插件
- CONTROLLER_REQUEST_TIMEOUT
指定 Ansible 在向 Controller 主机发送请求时应使用的超时时间。
默认为 10 秒
这不适用于导出或导入模块。
使用于: awx.awx.controller inventory 插件, awx.awx.controller_api lookup 插件
- CONTROLLER_USERNAME
您计划用于访问 Controller 上清单的用户。
使用于: awx.awx.controller inventory 插件, awx.awx.controller_api lookup 插件
- CONTROLLER_VERIFY_SSL
指定 Ansible 是否应验证 Controller 主机的 SSL 证书。
默认为 True,但这由共享的 module_utils 代码处理
使用于: awx.awx.controller inventory 插件, awx.awx.controller_api lookup 插件
- DSV_CLIENT_ID
用于请求访问授权的 client_id。
- DSV_CLIENT_SECRET
与特定
client_id
关联的客户端密钥。
- DSV_TENANT
默认
url_template
中的第一个格式参数。
- DSV_TLD
租户的顶级域名;默认
url_template
中的第二个格式参数。
- DSV_URL_TEMPLATE
添加到基本 URL 前面以形成有效 REST API 请求的路径。
- EC2_ACCESS_KEY
请参阅使用此环境变量的选项的文档。
使用于: amazon.aws.aws_account_attribute lookup 插件,amazon.aws.aws_ec2 清单插件,amazon.aws.aws_rds 清单插件,amazon.aws.secretsmanager_secret lookup 插件,amazon.aws.ssm_parameter lookup 插件,community.aws.aws_mq 清单插件,community.hashi_vault.hashi_vault lookup 插件,community.hashi_vault.vault_kv1_get lookup 插件,community.hashi_vault.vault_kv2_get lookup 插件,community.hashi_vault.vault_list lookup 插件,community.hashi_vault.vault_login lookup 插件,community.hashi_vault.vault_read lookup 插件,community.hashi_vault.vault_token_create lookup 插件,community.hashi_vault.vault_write lookup 插件
- EC2_REGION
请参阅使用此环境变量的选项的文档。
使用于: amazon.aws.aws_account_attribute lookup 插件,amazon.aws.aws_ec2 清单插件,amazon.aws.aws_rds 清单插件,amazon.aws.secretsmanager_secret lookup 插件,amazon.aws.ssm_parameter lookup 插件,community.aws.aws_mq 清单插件,community.hashi_vault.hashi_vault lookup 插件,community.hashi_vault.vault_kv1_get lookup 插件,community.hashi_vault.vault_kv2_get lookup 插件,community.hashi_vault.vault_list lookup 插件,community.hashi_vault.vault_login lookup 插件,community.hashi_vault.vault_read lookup 插件,community.hashi_vault.vault_token_create lookup 插件,community.hashi_vault.vault_write lookup 插件
- EC2_SECRET_KEY
请参阅使用此环境变量的选项的文档。
使用于: amazon.aws.aws_account_attribute lookup 插件,amazon.aws.aws_ec2 清单插件,amazon.aws.aws_rds 清单插件,amazon.aws.secretsmanager_secret lookup 插件,amazon.aws.ssm_parameter lookup 插件,community.aws.aws_mq 清单插件,community.hashi_vault.hashi_vault lookup 插件,community.hashi_vault.vault_kv1_get lookup 插件,community.hashi_vault.vault_kv2_get lookup 插件,community.hashi_vault.vault_list lookup 插件,community.hashi_vault.vault_login lookup 插件,community.hashi_vault.vault_read lookup 插件,community.hashi_vault.vault_token_create lookup 插件,community.hashi_vault.vault_write lookup 插件
- EC2_SECURITY_TOKEN
请参阅使用此环境变量的选项的文档。
使用于: amazon.aws.aws_account_attribute lookup 插件,amazon.aws.aws_ec2 清单插件,amazon.aws.aws_rds 清单插件,amazon.aws.secretsmanager_secret lookup 插件,amazon.aws.ssm_parameter lookup 插件,community.aws.aws_mq 清单插件,community.hashi_vault.hashi_vault lookup 插件,community.hashi_vault.vault_kv1_get lookup 插件,community.hashi_vault.vault_kv2_get lookup 插件,community.hashi_vault.vault_list lookup 插件,community.hashi_vault.vault_login lookup 插件,community.hashi_vault.vault_read lookup 插件,community.hashi_vault.vault_token_create lookup 插件,community.hashi_vault.vault_write lookup 插件
- EC2_URL
用于连接的 URL,而不是默认的 AWS 端点。虽然这可以用于连接其他 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 令牌。
- GITLAB_FILTER
从 GitLab API 筛选 runner
- GITLAB_SERVER_URL
GitLab 服务器的 URL,带有协议(即 http 或 https)。
- GRAFANA_API_KEY
请参阅使用此环境变量的选项的文档。
使用于: community.grafana.grafana_annotations 回调插件, community.grafana.grafana_dashboard 查找插件
- GRAFANA_DASHBOARD_ID
将在其中创建注释的 Grafana 仪表板 ID。
- GRAFANA_DASHBOARD_SEARCH
用于仪表板搜索的可选过滤器。
- GRAFANA_ORG_ID
Grafana 组织 ID。
- 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 端点。
- HCLOUD_TOKEN
Hetzner Cloud 的 API 令牌。
- HETZNER_DNS_TOKEN
Hetzner API 的令牌。
如果未提供,将从环境变量
HETZNER_DNS_TOKEN
中读取。
- HROBOT_API_PASSWORD
Robot Web 服务用户的密码。
- HROBOT_API_USER
Robot Web 服务用户的用户名。
- HTTP_AGENT
在 HTTP 请求中设置的 HTTP“User-agent”值。
- INFOBLOX_HOST
指定 DNS 主机名或地址,用于通过 REST 连接到 NIOS WAPI 的远程实例。
也可以使用
INFOBLOX_HOST
环境变量指定值。
- INFOBLOX_PASSWORD
指定用于对连接到 NIOS 远程实例进行身份验证的密码。
也可以使用
INFOBLOX_PASSWORD
环境变量指定值。
- INFOBLOX_USERNAME
配置用于对连接到 NIOS 远程实例进行身份验证的用户名。
也可以使用
INFOBLOX_USERNAME
环境变量指定值。
- JABBER_PASS
用户到 Jabber 服务器的密码
- JABBER_SERV
Jabber 服务器的连接信息
- JABBER_TO
将接收消息的聊天标识符
- JABBER_USER
用于身份验证的 Jabber 用户
- 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
仅当任务以此值作为前缀时,才将其视为测试用例。此外,失败的任务会记录为失败的测试用例。
- K8S_AUTH_API_KEY
请参阅使用此环境变量的选项的文档。
- K8S_AUTH_CERT_FILE
用于与 API 进行身份验证的证书路径。
- K8S_AUTH_CONTAINER
请参阅使用此环境变量的选项的文档。
- K8S_AUTH_CONTEXT
在 K8s 配置文件中找到的上下文的名称。
- K8S_AUTH_EXTRA_ARGS
请参阅使用此环境变量的选项的文档。
- K8S_AUTH_HOST
用于访问 API 的 URL。
- K8S_AUTH_KEY_FILE
用于与 API 进行身份验证的密钥文件路径。
- K8S_AUTH_KUBECONFIG
请参阅使用此环境变量的选项的文档。
- K8S_AUTH_NAMESPACE
Pod 的命名空间
- K8S_AUTH_PASSWORD
提供用于与 API 进行身份验证的密码。
请注意,这会直接在命令行上传递信息,可能会暴露敏感数据。我们建议改用基于文件的身份验证选项。
- K8S_AUTH_POD
请参阅使用此环境变量的选项的文档。
- K8S_AUTH_SERVER
用于访问 API 的 URL。
- K8S_AUTH_SSL_CA_CERT
用于与 API 进行身份验证的 CA 证书路径。
- K8S_AUTH_TOKEN
请参阅使用此环境变量的选项的文档。
- K8S_AUTH_USERNAME
提供用于与 API 进行身份验证的用户名。
- K8S_AUTH_VERIFY_SSL
是否验证 API 服务器的 SSL 证书。默认为true。
- LINODE_ACCESS_TOKEN
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 令牌
- MICROSOFT_AD_LDAP_AUTH_PROTOCOL
连接到 LDAP 主机时要使用的身份验证协议。
如果使用 LDAPS/StartTLS 并且指定了 certificate,则默认为
certificate
。否则,默认为negotiate
。simple
是简单的身份验证,其中用户和密码以纯文本形式发送。它不支持任何加密,因此必须与 LDAPS 或 StartTLS 一起使用。如果通过没有 TLS 的纯文本 LDAP 连接使用,则必须指定encrypt=False
以显式选择不加密。certificate
是 TLS 客户端证书身份验证。它只能与 LDAPS 或 StartTLS 一起使用。有关如何指定用于身份验证的客户端证书的更多信息,请参见证书。negotiate
将尝试协商 Kerberos 身份验证,并回退到 NTLM。如果 Kerberos 可用,则如果未指定用户名或密码,可以使用 Kerberos 凭据缓存。kerberos
将使用 Kerberos 身份验证,不回退到 NTLM。ntlm
将使用 NTLM 身份验证,不尝试 Kerberos。negotiate
、kerberos
和ntlm
支持通过 LDAP 进行加密。Kerberos 支持需要安装
pyspnego[kerberos]
扩展。有关更多信息,请参阅 LDAP 身份验证。
此选项可以使用 Jinja2 模板值进行设置。
由以下项使用: microsoft.ad.ldap 清单插件
- MICROSOFT_AD_LDAP_CA_CERT
可以是用于证书验证的 CA 证书 PEM 或 DER 文件路径、PEM 证书目录或 CA 证书 PEM 字符串。
如果省略,用于验证的默认 CA 存储取决于当前 Python 设置。
此选项可以使用 Jinja2 模板值进行设置。
由以下项使用: microsoft.ad.ldap 清单插件
- MICROSOFT_AD_LDAP_CERT_VALIDATION
使用 TLS 连接时的证书验证行为。
可以设置为
always
、ignore
或ignore_hostname
。always
将执行证书主机名和 CA 验证。ignore
将忽略任何证书错误。ignore_hostname
将验证 CA 信任链,但会忽略 TLS 执行的任何主机名检查。有关更多信息,请参阅 证书验证。
此选项可以使用 Jinja2 模板值进行设置。
由以下项使用: microsoft.ad.ldap 清单插件
- MICROSOFT_AD_LDAP_CERTIFICATE
用于证书身份验证的证书或包含密钥的证书包。
该值可以是包含证书的文件路径,也可以是 PEM 编码证书的字符串。
如果使用证书文件的路径,则该文件可以是 PEM 编码的证书、PEM 编码的证书和密钥包、DER 编码的证书或 PFX/PKCS12 编码的证书和密钥包。
如果指定的证书不包含密钥,请使用 certificate_key。
如果密钥使用密码加密,请使用 certificate_password。
此选项可以使用 Jinja2 模板值进行设置。
由以下项使用: microsoft.ad.ldap 清单插件
- MICROSOFT_AD_LDAP_CERTIFICATE_KEY
用于证书身份验证的证书密钥。
该值可以是包含 PEM 或 DER 编码格式密钥的文件路径,也可以是 PEM 编码密钥的字符串。
如果密钥使用密码加密,请使用 certificate_password。
此选项可以使用 Jinja2 模板值进行设置。
由以下项使用: microsoft.ad.ldap 清单插件
- MICROSOFT_AD_LDAP_CERTIFICATE_PASSWORD
用于解密由 certificate 或 certificate_key 指定的证书密钥的密码。
此选项可以使用 Jinja2 模板值进行设置。
由以下项使用: microsoft.ad.ldap 清单插件
- MICROSOFT_AD_LDAP_CONNECTION_TIMEOUT
在连接建立之前等待的超时时间(以秒为单位),超时后连接失败。
此选项可以使用 Jinja2 模板值进行设置。
由以下项使用: microsoft.ad.ldap 清单插件
- MICROSOFT_AD_LDAP_ENCRYPT
是否需要对连接进行加密。
加密可以使用身份验证协议或通过 TLS 进行。
auth_protocol
negotiate
、kerberos
和ntlm
都支持通过 LDAP 进行加密,而simple
则不支持。如果在使用 LDAP 时使用
auth_protocol=simple
而不使用 TLS,则必须将其设置为False
。由于未使用加密,因此所有流量都将以明文形式传输,应避免使用。此选项可以使用 Jinja2 模板值进行设置。
由以下项使用: microsoft.ad.ldap 清单插件
- MICROSOFT_AD_LDAP_PASSWORD
用于身份验证的密码。
如果 auth_protocol 为
simple
且未指定密码,则绑定将作为未经验证的绑定执行。如果 auth_protocol 为
negotiate
、kerberos
或ntlm
且未指定密码,则它将尝试使用 username 指定的本地缓存凭据(如果可用)。此选项可以使用 Jinja2 模板值进行设置。
由以下项使用: microsoft.ad.ldap 清单插件
- MICROSOFT_AD_LDAP_PORT
用于连接的 LDAP 端口。
端口 389 用于 LDAP,端口 686 用于 LDAPS。
如果
tls_mode=ldaps
,则默认为端口636
,否则为389
。此选项可以使用 Jinja2 模板值进行设置。
由以下项使用: microsoft.ad.ldap 清单插件
- MICROSOFT_AD_LDAP_SERVER
要连接的域控制器/服务器。
如果未指定,服务器将从当前的 krb5.conf
default_realm
设置和 SRV DNS 查找中派生。有关更多信息,请参阅 服务器查找。
此选项可以使用 Jinja2 模板值进行设置。
由以下项使用: microsoft.ad.ldap 清单插件
- 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 清单插件
- MICROSOFT_AD_LDAP_USERNAME
用于身份验证的用户名。
如果 auth_protocol 为
simple
且未指定用户名,则使用匿名身份验证。如果 auth_protocol 为
negotiate
、kerberos
或ntlm
且未指定用户名,则它将尝试使用本地缓存凭据(如果可用),例如通过kinit
检索的凭据。此选项可以使用 Jinja2 模板值进行设置。
由以下项使用: microsoft.ad.ldap 清单插件
- NETBOX_API
请参阅使用此环境变量的选项的文档。
由以下项使用: netbox.netbox.nb_inventory 清单插件, netbox.netbox.nb_lookup 查找插件
- NETBOX_API_KEY
NetBox API 令牌,用于读取 NetBox。
根据 NetBox 的设置,这可能不是必需的。
如果您的 NetBox 部署使用更高级的身份验证(如 OAUTH),则可以为令牌提供“type”和“value”。
如果未提供“type”和“value”参数,则 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
被动检查链接到的主机名。
由以下项使用: community.general.nrdp 回调插件
- NRDP_SERVICENAME
被动检查链接到的服务。
由以下项使用: community.general.nrdp 回调插件
- NRDP_TOKEN
允许推送 nrdp 事件的令牌。
由以下项使用: community.general.nrdp 回调插件
- NRDP_URL
nrdp 服务器的 URL。
由以下项使用: community.general.nrdp 回调插件
- NRDP_VALIDATE_CERTS
验证 nrdp 服务器的 SSL 证书。(用于 HTTPS URL。)
由以下项使用: community.general.nrdp 回调插件
- OME_HOSTNAME
OpenManage Enterprise 或 OpenManage Enterprise Modular IP 地址或主机名。
如果任务中未指定该值,则会使用环境变量
OME_HOSTNAME
的值。
- OME_PASSWORD
OpenManage Enterprise 或 OpenManage Enterprise Modular 密码。
如果任务中未指定该值,则会使用环境变量
OME_PASSWORD
的值。
- OME_USERNAME
OpenManage Enterprise 或 OpenManage Enterprise Modular 用户名。
如果任务中未指定该值,则会使用环境变量
OME_USERNAME
的值。
- ONE_AUTH
如果
api_username
或api_password
都未设置,则它将尝试使用 ONE 认证文件进行身份验证。默认路径为~/.one/one_auth
。设置环境变量
ONE_AUTH
以覆盖此路径。
- ONE_PASSWORD
用于登录 OpenNebula RPC 服务器的用户的密码或令牌。
如果未设置,则会使用
ONE_PASSWORD
环境变量的值。
- ONE_USERNAME
用于登录 OpenNebula RPC 服务器的用户名。如果未设置,则会使用
ONE_USERNAME
环境变量的值。
- ONLINE_API_KEY
Online OAuth 令牌。
- ONLINE_OAUTH_TOKEN
Online OAuth 令牌。
- ONLINE_TOKEN
Online OAuth 令牌。
- OP_CONNECT_HOST
1Password Connect 的主机。必须与
connect_token
结合使用。使用于: community.general.onepassword lookup 插件, community.general.onepassword_doc lookup 插件, community.general.onepassword_raw lookup 插件
- OP_CONNECT_TOKEN
1Password Connect 的令牌。必须与
connect_host
结合使用。使用于: community.general.onepassword lookup 插件, community.general.onepassword_doc lookup 插件, community.general.onepassword_raw lookup 插件
- OP_SERVICE_ACCOUNT_TOKEN
服务账户的访问密钥。
仅适用于 1Password CLI 版本 2 或更高版本。
使用于: community.general.onepassword lookup 插件, community.general.onepassword_doc lookup 插件, community.general.onepassword_raw lookup 插件
- OS_CLIENT_CONFIG_FILE
覆盖
clouds.yaml
文件的路径。如果给出了此值,将首先搜索它。
云凭据的搜索路径会补充
/etc/ansible/openstack.{yaml,yml}
文件。默认搜索路径记录在 https://docs.openstack.org/os-client-config/latest/user/configuration.html#config-files。
- OTEL_EXPORTER_OTLP_TRACES_PROTOCOL
OTEL_EXPORTER_OTLP_TRACES_PROTOCOL
表示 span 的传输协议。
- OTEL_SERVICE_NAME
服务名称资源属性。
- OVIRT_PASSWORD
ovirt 身份验证密码。
- OVIRT_URL
指向 ovirt-engine API 的 URL。
- OVIRT_USERNAME
ovirt 身份验证用户。
- PASSWORD_STORE_DIR
密码存储的目录。
如果
backend=pass
,则默认使用~/.password-store
。如果
backend=gopass
,则默认值为~/.config/gopass/config.yml
中的path
字段,如果 gopass 配置中未定义path
,则回退到~/.local/share/gopass/stores/root
。
- PASSWORD_STORE_UMASK
设置创建的
.gpg
文件的 umask。第一个八进制数必须大于 3(用户可读)。请注意,pass 的默认值为
'077'
。
- PROFILE_ROLES_SUMMARY_ONLY
仅显示摘要,不显示各个任务配置文件。与
DISPLAY_SKIPPED_HOSTS=false
和/或ANSIBLE_DISPLAY_OK_HOSTS=false
结合使用时特别有用。
- PROFILE_TASKS_SORT_ORDER
调整摘要任务的排序输出
- PROFILE_TASKS_SUMMARY_ONLY
仅显示摘要,不显示各个任务配置文件。与
DISPLAY_SKIPPED_HOSTS=false
和/或ANSIBLE_DISPLAY_OK_HOSTS=false
结合使用时特别有用。
- PROFILE_TASKS_TASK_OUTPUT_LIMIT
摘要中要显示的任务数
- 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 身份验证令牌密钥。
如果 inventory 配置中未指定该值,则会使用环境变量
PROXMOX_TOKEN_SECRET
的值。要使用令牌身份验证,您还必须指定
token_id
。如果您不指定token_id
和token_secret
,则必须设置密码。
- PROXMOX_URL
Proxmox 集群的 URL。
如果 inventory 配置中未指定该值,则会使用环境变量
PROXMOX_URL
的值。从 community.general 4.7.0 版本开始,您还可以使用模板来指定
url
的值。
- PROXMOX_USER
Proxmox 身份验证用户。
如果 inventory 配置中未指定该值,则会使用环境变量
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
)。有关 如何生成令牌 的更多详细信息。
- SCW_OAUTH_TOKEN
Scaleway OAuth 令牌。
如果未显式定义或在环境变量中定义,它将尝试在 scaleway-cli 配置文件中查找(
$SCW_CONFIG_PATH
、$XDG_CONFIG_HOME/scw/config.yaml
或~/.config/scw/config.yaml
)。有关 如何生成令牌 的更多详细信息。
- SCW_TOKEN
Scaleway OAuth 令牌。
如果未显式定义或在环境变量中定义,它将尝试在 scaleway-cli 配置文件中查找(
$SCW_CONFIG_PATH
、$XDG_CONFIG_HOME/scw/config.yaml
或~/.config/scw/config.yaml
)。有关 如何生成令牌 的更多详细信息。
- SLACK_CHANNEL
要发布到的 Slack 房间。
- SLACK_USERNAME
要发布的用户名。
- SLACK_VALIDATE_CERTS
验证 HTTPS URL 的 Slack 服务器的 SSL 证书。
- SLACK_WEBHOOK_URL
Slack Webhook URL。
- SMTPHOST
邮件传输代理,接受 SMTP 的服务器。
- SOPS_ANSIBLE_AWX_DISABLE_VARS_PLUGIN_TEMPORARILY
临时禁用此插件。
如果 ansible-inventory 应该在不解密密钥的情况下运行(例如在 AWX 中),则此选项很有用。
- SPLUNK_AUTHTOKEN
用于验证与 Splunk HTTP 收集器连接的令牌。
- SPLUNK_BATCH
可以在多个 playbook 执行中设置的相关 ID。
- SPLUNK_INCLUDE_MILLISECONDS
是否将毫秒作为发送到 Splunk HTTP 收集器的事件中生成的 timestamp 字段的一部分。
- SPLUNK_URL
Splunk HTTP 收集器源的 URL。
- SPLUNK_VALIDATE_CERTS
是否验证与 HEC 连接的证书。不建议设置为
false
,除非您确定没有人可以拦截此插件和 HEC 之间的连接,因为设置为false
会允许中间人攻击!
- SUMOLOGIC_URL
Sumologic HTTP 收集器源的 URL。
- SYSLOG_FACILITY
要记录为的 Syslog 设备。
- SYSLOG_PORT
syslog 服务器正在侦听的端口。
- SYSLOG_SERVER
将接收事件的 Syslog 服务器。
- TOWER_HOST
Automation Platform Controller 主机的网络地址。
使用于: awx.awx.controller inventory 插件, awx.awx.controller_api lookup 插件
- TOWER_OAUTH_TOKEN
要使用的 OAuth 令牌。
使用于: awx.awx.controller inventory 插件, awx.awx.controller_api lookup 插件
- TOWER_PASSWORD
您的 Controller 用户的密码。
使用于: awx.awx.controller inventory 插件, awx.awx.controller_api lookup 插件
- TOWER_USERNAME
您计划用于访问 Controller 上清单的用户。
使用于: awx.awx.controller inventory 插件, awx.awx.controller_api lookup 插件
- TOWER_VERIFY_SSL
指定 Ansible 是否应验证 Controller 主机的 SSL 证书。
默认为 True,但这由共享的 module_utils 代码处理
使用于: awx.awx.controller inventory 插件, awx.awx.controller_api lookup 插件
- TRACEPARENT
W3C Trace Context 标头 traceparent。
使用位置: community.general.elastic 回调插件, community.general.opentelemetry 回调插件
- TSS_API_PATH_URI
要附加到基本 URL 以形成有效的 REST API 请求的路径。
- TSS_BASE_URL
服务器的基本 URL,例如
https://127.0.0.1/SecretServer
。
- TSS_DOMAIN
用于请求 OAuth2 访问授权的域。
当未提供
token
时,此项为可选。需要
python-tss-sdk
1.0.0 或更高版本。
- TSS_PASSWORD
与提供的用户名关联的密码。
当未提供
token
时,此项为必需。
- TSS_TOKEN
Thycotic 授权程序的现有令牌。
如果提供,则不需要
username
和password
。需要
python-tss-sdk
1.0.0 或更高版本。
- TSS_TOKEN_PATH_URI
要附加到基本 URL 以形成有效的 OAuth2 访问授权请求的路径。
- TSS_USERNAME
用于请求 OAuth2 访问授权的用户名。
- VI_PASSWORD
连接的密码。
- VI_PORTNUMBER
连接的端口。
- VI_SERVER
连接的 FQDN 或 IP 地址(vCenter 或 ESXi 主机)。
- VI_USERNAME
连接的用户名。
需要在虚拟机上具有以下权限:- VirtualMachine.GuestOperations.Execute - VirtualMachine.GuestOperations.Modify - VirtualMachine.GuestOperations.Query
- VMWARE_HOST
请参阅使用此环境变量的选项的文档。
使用于: community.vmware.vmware_host_inventory 清单插件, community.vmware.vmware_tools 连接插件, community.vmware.vmware_vm_inventory 清单插件, 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_PASSWORD
请参阅使用此环境变量的选项的文档。
使用于: community.vmware.vmware_host_inventory 清单插件, community.vmware.vmware_tools 连接插件, community.vmware.vmware_vm_inventory 清单插件, 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_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.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_SERVER
vCenter 或 ESXi 服务器的名称。
使用于: community.vmware.vmware_host_inventory 清单插件, community.vmware.vmware_vm_inventory 清单插件
- VMWARE_USER
请参阅使用此环境变量的选项的文档。
使用于: community.vmware.vmware_host_inventory 清单插件, community.vmware.vmware_tools 连接插件, community.vmware.vmware_vm_inventory 清单插件, 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_USERNAME
vSphere 用户名。
接受 vault 加密变量。
接受 Jinja 来模板化该值
使用于: community.vmware.vmware_host_inventory 清单插件, community.vmware.vmware_vm_inventory 清单插件
- VMWARE_VALIDATE_CERTS
请参阅使用此环境变量的选项的文档。
使用于: community.vmware.vmware_host_inventory 清单插件, community.vmware.vmware_tools 连接插件, community.vmware.vmware_vm_inventory 清单插件, 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 查找插件
- VULTR_API_ENDPOINT
API 端点的 URL(不带尾部斜杠)。
回退环境变量
VULTR_API_ENDPOINT
。
- VULTR_API_KEY
Vultr API 的 API 密钥。
回退环境变量
VULTR_API_KEY
。
- VULTR_API_RESULTS_PER_PAGE
当接收大量实例时,指定每次调用 API 应返回多少个实例。
这不决定返回多少结果;所有实例都根据其他过滤器返回。
Vultr API 最大值为 500。
回退环境变量
VULTR_API_RESULTS_PER_PAGE
。
- VULTR_API_TIMEOUT
到 Vultr API 的 HTTP 超时。
回退环境变量
VULTR_API_TIMEOUT
。
- WORKSPACE_ID
Azure Log Analytics 工作区的 Workspace ID。
- WORKSPACE_SHARED_KEY
连接到 Azure Log Analytics 工作区的共享密钥。
- ZABBIX_PASSWORD
Zabbix 用户密码。
- ZABBIX_SERVER
Zabbix 服务器的 URL,带协议(http 或 https)。
url
是server_url
的别名。
- ZABBIX_USERNAME
Zabbix 用户名。
- ZABBIX_VALIDATE_CERTS
如果设置为 False,则不会验证 SSL 证书。这应该只在使用自签名证书的个人控制站点上使用。