community.hashi_vault.vault_database_roles_list 模块 – 返回可用（动态）角色列表

注意

此模块是 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_database_roles_list。

community.hashi_vault 6.2.0 中的新增功能

概要

• 返回可用（动态）角色列表。

要求

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

• hvac (Python 库)

• 有关详细要求，请参阅 集合要求页面。

参数

参数	注释
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 中添加的。 选择 "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 中添加	如果指定，则将该值设置为在 GetCallerIdentity 请求中用作 X-Vault-AWS-IAM-Server-ID 标头的值。
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 格式。
engine_mount_point 字符串	安装 secret 后端的路径。
jwt 字符串	用于 JWT 身份验证到 Vault 的 JSON Web Token (JWT)。
mount_point 字符串	Vault 安装点。 如果未指定，则使用给定身份验证方法的默认安装点。 不适用于令牌身份验证。
namespace 字符串	秘密所在的 Vault 命名空间。此选项需要 HVAC 0.7.0+ 和 Vault 0.11+。 可选地，可以通过使用命名空间作为身份验证挂载点和/或秘密路径的前缀来实现此目的（例如 mynamespace/secret/mysecret）。 如果设置了环境变量 VAULT_NAMESPACE，其值将在所有指定 *namespace* 的方式中最后使用。
password 字符串	身份验证密码。
proxies any 在 community.hashi_vault 1.1.0 中添加	用于访问 Vault 服务的代理的 URL。 它可以是字符串或字典。 如果它是一个字典，请将方案（例如，http 或 https）作为键，并将 URL 作为值提供。 如果它是一个字符串，请提供一个将用作 http 和 https 方案的代理的单个 URL。 可以解释为字典的字符串将被转换为字典（请参阅示例）。 您可以为 HTTP 和 HTTPS 资源指定不同的代理。 如果未指定，则使用Requests 库中的环境变量。
region 字符串	创建连接的 AWS 区域。
retries any 在 community.hashi_vault 1.3.0 中添加	允许基于 urllib3 库中的 Retry 类 在错误时进行重试。 此集合定义了重试与 Vault 连接的建议默认值。 此选项可以指定为正数（整数）或字典。 如果未指定此选项或数字为 0，则禁用重试。 数字设置重试总次数，并对其他设置使用集合默认值。 字典值直接用于初始化 Retry 类，因此可以用于完全自定义重试。 有关重试的详细信息，请参阅集合用户指南。
retry_action 字符串 在 community.hashi_vault 1.3.0 中添加	控制是否以及如何在重试时显示消息。 如果未重试请求，则此选项无效。 选择 "ignore" "warn" ← (默认)
role_id 字符串	Vault 角色 ID 或名称。用于 approle，aws_iam，azure 和 cert 身份验证方法。 对于 cert 身份验证，如果未提供 _role_id_，则默认行为是尝试所有证书角色并返回任何匹配的角色。 对于 azure 身份验证，_role_id_ 是必需的。
secret_id 字符串	用于 Vault AppRole 身份验证的 Secret ID。
timeout 整数 在 community.hashi_vault 1.3.0 中添加	设置连接超时时间（以秒为单位）。 如果未设置，则使用 hvac 库的默认值。
token 字符串	Vault 令牌。可以通过列出的 [env] 变量以及 VAULT_TOKEN env 变量显式指定令牌。 如果没有显式或通过 env 提供令牌，则插件将检查令牌文件，由 _token_path_ 和 _token_file_ 确定。 令牌加载的顺序（先找到的获胜）是 token param -> ansible var -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> token file。
token_file 字符串	如果未指定令牌，将尝试从 _token_path_ 中的此文件读取令牌。 默认值： ".vault-token"
token_path 字符串	如果未指定令牌，将尝试从此路径读取 _token_file_。
token_validate 布尔值 在 community.hashi_vault 0.2.0 中添加	对于令牌身份验证，将执行 lookup-self 操作，以确定令牌的有效性，然后再使用它。 如果您的令牌没有 lookup-self 功能，请禁用此选项。 选择 false ← (默认) true
url 字符串	Vault 服务的 URL。 如果未通过任何其他方式指定，则将使用 VAULT_ADDR 环境变量的值。 如果 VAULT_ADDR 也未定义，则会引发错误。
username 字符串	身份验证用户名。
validate_certs 布尔值	控制 SSL 证书的验证和校验，通常只有在使用自签名证书时才需要关闭此选项。 如果设置了 VAULT_SKIP_VERIFY 且未显式提供 _validate_certs_，则将使用 VAULT_SKIP_VERIFY 的反向值填充此选项。 如果未设置 _validate_certs_ 或 VAULT_SKIP_VERIFY，则默认为 true。 选择 false true

属性

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

备注

注意

• 此 API 返回一个名为 keys 的成员。

• 在 Ansible 中，访问 data.keys 或 raw.data.keys 将不起作用，因为字典对象包含一个名为 keys 的方法。

• 请改为使用 roles 访问角色列表，或者使用语法 data["keys"] 或 raw.data["keys"] 通过字典成员访问列表。

示例

- name: List all roles with the default mount point
  community.hashi_vault.vault_database_roles_list:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
  register: result

- name: Display the result of the operation
  ansible.builtin.debug:
    msg: "{{ result }}"

- name: List all roles with a custom mount point
  community.hashi_vault.vault_database_roles_list:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
    engine_mount_point: db1
  register: result

- name: Display the result of the operation
  ansible.builtin.debug:
    msg: "{{ result }}"

返回值

通用返回值记录在此处，以下是此模块独有的字段

键	描述
data 字典	原始结果的 data 字段。也可以通过 raw.data 访问此字段。 返回值：成功 示例： {"keys": ["dyn_role1", "dyn_role2", "dyn_role3"]}
keys 列表 / 元素=字符串	动态角色名称的列表。 返回值：成功 示例： ["dyn_role1", "dyn_role2", "dyn_role3"]
raw 字典	操作的原始结果。 返回值：成功 示例： {"auth": null, "data": {"keys": ["dyn_role1", "dyn_role2", "dyn_role3"]}, "lease_duration\"": 0, "lease_id": "", "renewable": false, "request_id": "123456", "username": "SomeUser", "warnings": null, "wrap_info": null}
data 字典	API 响应的 data 字段。 返回值：成功
keys 列表 / 元素=字符串	动态角色名称的列表。 返回值：成功 示例： ["dyn_role1", "dyn_role2", "dyn_role3"]
roles 列表 / 元素=字符串	动态角色列表或空列表。也可以通过 data.keys 或 raw.data.keys 访问此列表。 返回值：成功 示例： ["dyn_role1", "dyn_role2", "dyn_role3"]

作者

• Martin Chmielewski (@M4rt1nCh)

集合链接

• 问题跟踪器
• 存储库（源）
• 讨论、问答、故障排除
• 通信