community.hashi_vault.vault_list 模块 – 对 HashiCorp Vault 执行列表操作

注意

此模块是 community.hashi_vault 集合（版本 6.2.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install community.hashi_vault。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

要在 playbook 中使用它，请指定： community.hashi_vault.vault_list。

community.hashi_vault 4.1.0 中的新功能

概要 

对 HashiCorp Vault 中给定路径执行通用列表操作。

要求 

执行此模块的主机需要以下要求。

hvac (Python 库)
有关详细要求，请参阅集合要求页面。

参数 

参数	注释
auth_method 字符串	要使用的身份验证方法。在集合版本 `1.2.0` 中添加了 `none` 身份验证方法。在集合版本 `1.4.0` 中添加了 `cert` 身份验证方法。 `aws_iam_login` 在集合版本 `2.1.0` 中重命名为 `aws_iam`，并在 `3.0.0` 中删除。在集合版本 `3.2.0` 中添加了 `azure` 身份验证方法。选择 `"token"` ← (默认) `"userpass"` `"ldap"` `"approle"` `"aws_iam"` `"azure"` `"jwt"` `"cert"` `"none"`
aws_access_key 别名：aws_access_key_id 字符串	要使用的 AWS 访问密钥。
aws_iam_server_id 字符串在 community.hashi_vault 0.2.0 中添加	如果指定，则设置要用于 `X-Vault-AWS-IAM-Server-ID` 标头的值，作为 `GetCallerIdentity` 请求的一部分。
aws_profile 别名：boto_profile 字符串	AWS 配置文件
aws_secret_key 别名：aws_secret_access_key 字符串	与访问密钥对应的 AWS 秘密密钥。
aws_security_token 字符串	如果使用临时访问密钥和秘密密钥，则使用 AWS 安全令牌。
azure_client_id 字符串在 community.hashi_vault 3.2.0 中添加	Azure AD 服务主体或托管标识的客户端 ID（也称为应用程序 ID）。应为 UUID。如果未指定，将使用系统分配的托管标识。
azure_client_secret 字符串在 community.hashi_vault 3.2.0 中添加	Azure AD 服务主体的客户端密码。
azure_resource 字符串在 community.hashi_vault 3.2.0 中添加	在 Azure Active Directory 中注册的应用程序的资源 URL。通常不应更改为默认值。默认值: `"https://management.azure.com/"`
azure_tenant_id 字符串在 community.hashi_vault 3.2.0 中添加	服务主体的 Azure Active Directory 租户 ID（也称为目录 ID）。应为 UUID。当使用服务主体向 Vault 进行身份验证时是必需的，例如，当同时指定 azure_client_id 和 azure_client_secret 时是必需的。当使用托管标识向 Vault 进行身份验证时是可选的。
ca_cert 别名：cacert 字符串	用于身份验证的证书的路径。如果未通过任何其他方式指定，将使用 `VAULT_CACERT` 环境变量。
cert_auth_private_key 路径在 community.hashi_vault 1.4.0 中添加	对于 `cert` 身份验证，用于进行身份验证的私钥文件的路径，采用 PEM 格式。
cert_auth_public_key 路径在 community.hashi_vault 1.4.0 中添加	对于 `cert` 身份验证，用于进行身份验证的证书文件的路径，采用 PEM 格式。
jwt 字符串	用于 Vault 的 JWT 身份验证的 JSON Web 令牌 (JWT)。
mount_point 字符串	Vault 挂载点。如果未指定，则使用给定身份验证方法的默认挂载点。不适用于令牌身份验证。
namespace 字符串	秘密所在的 Vault 命名空间。此选项需要 HVAC 0.7.0+ 和 Vault 0.11+。或者，可以通过在身份验证挂载点和/或秘密路径前加上命名空间来实现此目的（例如 `mynamespace/secret/mysecret`）。如果设置了环境变量 `VAULT_NAMESPACE`，则它的值将在所有指定命名空间的方式中最后被使用。
密码字符串	身份验证密码。
路径字符串 / 必需	要列出的 Vault 路径。
代理任意在 community.hashi_vault 1.1.0 中添加	用于访问 Vault 服务的代理 URL。它可以是字符串或字典。如果是字典，请将方案（例如 `http` 或 `https`）作为键，并将 URL 作为值。如果是字符串，请提供一个 URL，它将用作 `http` 和 `https` 方案的代理。可以解释为字典的字符串将被转换为字典（请参阅示例）。您可以为 HTTP 和 HTTPS 资源指定不同的代理。如果未指定，则使用Requests 库中的环境变量。
区域字符串	用于创建连接的 AWS 区域。
重试任意在 community.hashi_vault 1.3.0 中添加	允许基于 urllib3 库中的 Retry 类，在错误时进行重试。此集合定义了重试与 Vault 连接的建议默认值。此选项可以指定为正数（整数）或字典。如果未指定此选项或数字为 `0`，则禁用重试。数字设置重试的总次数，并使用集合默认值进行其他设置。字典值直接用于初始化 `Retry` 类，因此可以用于完全自定义重试。有关重试的详细信息，请参阅集合用户指南。
重试操作字符串在 community.hashi_vault 1.3.0 中添加	控制是否以及如何显示关于重试的消息。如果未重试请求，则此项无效。选择 `"忽略"` `"warn"` ← (默认)
角色 ID 字符串	Vault 角色 ID 或名称。用于 `approle`、`aws_iam`、`azure` 和 `cert` 身份验证方法。对于 `cert` 身份验证，如果没有提供 role_id，则默认行为是尝试所有证书角色，并返回任何匹配的角色。对于 `azure` 身份验证，需要 role_id。
秘密 ID 字符串	用于 Vault AppRole 身份验证的秘密 ID。
超时整数在 community.hashi_vault 1.3.0 中添加	设置连接超时时间（以秒为单位）。如果未设置，则使用 `hvac` 库的默认值。
令牌字符串	Vault 令牌。可以通过列出的 [env] 变量显式指定令牌，也可以通过 `VAULT_TOKEN` 环境变量指定令牌。如果没有显式或通过 env 提供令牌，则插件将检查令牌文件，由 token_path 和 token_file 确定。令牌加载的顺序（先找到的优先）是 `token 参数 -> ansible 变量 -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> 令牌文件`。
令牌文件字符串	如果未指定令牌，将尝试从 token_path 中的此文件读取令牌。默认值: `".vault-token"`
令牌路径字符串	如果未指定令牌，将尝试从此路径读取 token_file。
令牌验证布尔值在 community.hashi_vault 0.2.0 中添加	对于令牌身份验证，将在使用之前执行 `lookup-self` 操作，以确定令牌的有效性。如果您的令牌不具备 `lookup-self` 功能，请禁用此选项。选择 `false` ← (默认) `true`
URL 字符串	Vault 服务的 URL。如果未通过任何其他方式指定，则将使用 `VAULT_ADDR` 环境变量的值。如果也未定义 `VAULT_ADDR`，则会引发错误。
用户名字符串	身份验证用户名。
验证证书布尔值	控制 SSL 证书的验证，通常只会在使用自签名证书时关闭此选项。如果设置了 `VAULT_SKIP_VERIFY` 并且没有明确提供 validate_certs，则将使用 `VAULT_SKIP_VERIFY` 的反向值填充此选项。如果未设置 validate_certs 或 `VAULT_SKIP_VERIFY`，则默认为 `true`。选择 `false` `true`

属性 

属性	支持	描述
操作组	操作组: community.hashi_vault.vault	在 `module_defaults` 中使用 `group/community.hashi_vault.vault` 为此模块设置默认值。
检查模式	支持: 完整此模块是“只读”的，并且在检查模式下操作方式相同。	可以在 `check_mode` 中运行，并返回更改状态预测，而无需修改目标。

另请参阅 

另请参阅

community.hashi_vault.vault_list 查找: community.hashi_vault.vault_list 查找插件的官方文档。

示例 

- name: List kv2 secrets from Vault via the remote host with userpass auth
  community.hashi_vault.vault_list:
    url: https://vault:8201
    path: secret/metadata
    # For kv2, the path needs to follow the pattern 'mount_point/metadata' or 'mount_point/metadata/path' to list all secrets in that path
    auth_method: userpass
    username: user
    password: '{{ passwd }}'
  register: secret

- name: Display the secrets found at the path provided above
  ansible.builtin.debug:
    msg: "{{ secret.data.data['keys'] }}"
    # Note that secret.data.data.keys won't work as 'keys' is a built-in method

- name: List access policies from Vault via the remote host
  community.hashi_vault.vault_list:
    url: https://vault:8201
    path: sys/policies/acl
  register: policies

- name: Display the policy names
  ansible.builtin.debug:
    msg: "{{ policies.data.data['keys'] }}"
    # Note that secret.data.data.keys won't work as 'keys' is a built-in method

返回值 

通用返回值记录在这里，以下是此模块特有的字段

键	描述
数据字典	针对给定路径的列表的原始结果。已返回: 成功

作者

Tom Kivlin (@tomkivlin)