community.hashi_vault.vault_database_static_role_get_credentials 模块 – 基于指定的静态角色返回当前凭据

注意

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

community.hashi_vault 6.2.0 中的新增功能

概要

• 返回基于指定的静态角色的当前凭据，由其 role_name 标识。

要求

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

• 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 字符串	用于对 Vault 进行 JWT 身份验证的 JSON Web 令牌 (JWT)。
mount_point 字符串	Vault 挂载点。 如果未指定，则使用给定身份验证方法的默认挂载点。 不适用于令牌身份验证。
namespace 字符串	秘密所在的 Vault 命名空间。此选项需要 HVAC 0.7.0+ 和 Vault 0.11+。 可选地，可以通过在身份验证挂载点和/或秘密路径前加上命名空间来实现（例如 mynamespace/secret/mysecret）。 如果设置了环境变量 VAULT_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*。
role_name 字符串 / 必需	应从中检索凭据的角色名称。
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 中运行，并返回已更改状态的预测，而无需修改目标。

说明

注意

• 此模块始终报告 changed 为 False，因为它是一个不修改数据的读取操作。

• 在已知操作不更改状态的情况下，使用 changed_when 来控制。

示例

- name: Returns the current credentials based on the named static role with the default mount point
  community.hashi_vault.vault_database_static_role_read:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
    role_name: SomeRole
  register: result

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

- name: Returns the current credentials based on the named static role with a custom mount point
  community.hashi_vault.vault_database_static_role_read:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
    engine_mount_point: db1
    role_name: SomeRole
  register: result

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

返回值

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

键	描述
data 字典	原始结果的 data 字段。也可以通过 raw.data 访问。 返回：成功 示例： {"last_vault_rotation\"": "2024-01-01T09:00:00+01:00", "password\"": "Th3_$3cr3t_P@ss!", "rotation_period\"": 86400, "ttl\"": 123456, "username": "SomeUser"}
raw 字典	操作的原始结果。 返回：成功 示例： {"auth": "null,", "data": {"last_vault_rotation\"": "2024-01-01T09:00:00+01:00", "password\"": "Th3_$3cr3t_P@ss!", "rotation_period\"": 86400, "ttl\"": 123456, "username": "SomeUser"}, "lease_duration": 0, "lease_id": "", "renewable": false, "request_id": "123456", "warnings": "null,", "wrap_info": null}
data 字典	原始结果的 data 字段。也可以通过 raw.data 访问。 返回：成功 示例： {"last_vault_rotation\"": "2024-01-01T09:00:00+01:00", "password\"": "Th3_$3cr3t_P@ss!", "rotation_period\"": 86400, "ttl\"": 123456, "username": "SomeUser"}

作者

• Martin Chmielewski (@M4rt1nCh)

集合链接

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