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 中添加	如果指定，则将值设置为用于 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 格式进行身份验证的证书文件路径。
engine_mount_point 字符串	秘密后端挂载的路径。
jwt 字符串	用于 JWT 身份验证到 Vault 的 JSON Web 令牌 (JWT)。
mount_point 字符串	Vault 挂载点。 如果未指定，则使用给定身份验证方法的默认挂载点。 不适用于令牌身份验证。
namespace 字符串	Vault 中存放密钥的命名空间。此选项需要 HVAC 0.7.0+ 和 Vault 0.11+。 或者，可以通过在身份验证挂载点和/或密钥路径前添加命名空间来实现此目的（例如 mynamespace/secret/mysecret）。 如果设置了环境变量VAULT_NAMESPACE，则其值将在所有指定namespace的方法中最后使用。
password 字符串	身份验证密码。
proxies 任何 在 community.hashi_vault 1.1.0 中添加	用于访问 Vault 服务的代理的 URL。 它可以是字符串或字典。 如果是字典，请提供方案（例如 http 或 https）作为键，并提供 URL 作为值。 如果是字符串，则提供单个 URL，该 URL 将用作 http 和 https 方案的代理。 可以解释为字典的字符串将转换为字典（参见示例）。 您可以为 HTTP 和 HTTPS 资源指定不同的代理。 如果未指定，则使用Requests 库中的环境变量。
region 字符串	要为其创建连接的 AWS 区域。
retries 任何 在 community.hashi_vault 1.3.0 中添加	允许根据urllib3 库中的 Retry 类重试错误。 此集合定义了重试连接到 Vault 的推荐默认值。 此选项可以指定为正数（整数）或字典。 如果未指定此选项或数字为0，则禁用重试。 数字设置重试的总数，并使用集合默认值进行其他设置。 字典值直接用于初始化Retry类，因此可用于完全自定义重试。 有关重试的详细信息，请参阅集合用户指南。
retry_action 字符串 在 community.hashi_vault 1.3.0 中添加	控制是否以及如何显示retries的消息。 如果未重试请求，则此选项无效。 选项 "忽略" "警告" ← (默认)
role_id 字符串	Vault 角色 ID 或名称。用于approle、aws_iam、azure和cert身份验证方法。 对于cert身份验证，如果未提供role_id，则默认行为是尝试所有证书角色并返回任何一个匹配的角色。 对于azure身份验证，需要role_id。
secret_id 字符串	用于 Vault AppRole 身份验证的密钥 ID。
timeout 整数 在 community.hashi_vault 1.3.0 中添加	设置连接超时（秒）。 如果未设置，则使用hvac库的默认值。
token 字符串	Vault 令牌。可以通过列出的 [env] 变量以及VAULT_TOKEN环境变量显式指定令牌。 如果未显式或通过环境变量提供令牌，则插件将检查令牌文件，该文件由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	支持：完全支持 此模块为“只读”模块，其运行方式与检查模式无关。	可以在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 响应的数据字段。 返回：成功
keys 列表 / 元素=字符串	动态角色名称列表。 返回：成功 示例：["dyn_role1", "dyn_role2", "dyn_role3"]
角色 列表 / 元素=字符串	动态角色列表或空列表。也可以通过data.keys 或 raw.data.keys访问。 返回：成功 示例：["dyn_role1", "dyn_role2", "dyn_role3"]

作者

• Martin Chmielewski (@M4rt1nCh)

资源链接

• 问题追踪
• 代码仓库
• 讨论、问答、故障排除
• 通信