community.hashi_vault.vault_database_static_role_rotate_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_rotate_credentials。

community.hashi_vault 6.2.0 新增

概要

• 此端点用于

• 轮换为给定角色名称存储的静态角色凭据。

• 虽然静态角色由 Vault 在配置的轮换周期自动轮换，

• 但用户可以使用此端点手动触发轮换以更改存储的密码并重置静态角色密码的 TTL。

要求

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

• hvac (Python 库) >= 2.0.0

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

参数

参数	注释
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 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 中添加	控制是否以及如何在 retries 上显示消息。 如果未重试请求，则此项无效。 选择 "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 环境变量指定。 如果未显式或通过 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	支持: 部分 在检查模式下，将返回示例响应，但不会在 Hashicorp Vault 中执行凭据轮换。	可以在 check_mode 中运行并返回已更改的状态预测，而无需修改目标。

注释

注意

• 此模块始终报告 changed 状态，因为它无法保证幂等性。

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

示例

- name: Rotate credentials of a static role with the default mount point
  community.hashi_vault.vault_database_static_role_rotate_credentials:
    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: Rotate credentials of a static role with a custom mount point
  community.hashi_vault.vault_database_static_role_rotate_credentials:
    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 }}"

作者

• Martin Chmielewski (@M4rt1nCh)

集合链接

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