community.hashi_vault.vault_database_rotate_root_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_rotate_root_credentials。

community.hashi_vault 6.2.0 中的新增功能

概要

• 触发由其 connection_name 标识的数据库连接的 根凭据轮换。

要求

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

• 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 中添加	如果指定，则将该值设置为在 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 格式）。
connection_name 字符串 / 必需	应触发根凭据轮换的连接名称。
engine_mount_point 字符串	安装 secret 后端的路径。
jwt 字符串	用于 Vault JWT 身份验证的 JSON Web Token (JWT)。
mount_point 字符串	Vault 挂载点。 如果未指定，则使用给定身份验证方法的默认挂载点。 不适用于令牌身份验证。
namespace 字符串	Secret 所在的 Vault 命名空间。此选项需要 HVAC 0.7.0+ 和 Vault 0.11+。 或者，可以通过在身份验证挂载点和/或 secret 路径前加上命名空间来实现（例如 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 integer 在 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 boolean 在 community.hashi_vault 0.2.0 中添加	对于令牌身份验证，将执行 lookup-self 操作以确定令牌的有效性，然后再使用它。 如果您的令牌没有 lookup-self 功能，请禁用此项。 选项 false ← (默认) true
url 字符串	Vault 服务的 URL。 如果未通过任何其他方式指定，则将使用 VAULT_ADDR 环境变量的值。 如果 VAULT_ADDR 也未定义，则会引发错误。
username 字符串	身份验证用户名。
validate_certs boolean	控制 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: Trigger root credentiaL rotation with the default mount point
  community.hashi_vault.vault_database_rotate_root_credentials:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
    connection_name: SomeName
  register: result

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

- name: Trigger root credential rotation with the default mount point
  community.hashi_vault.vault_database_rotate_root_credentials:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
    engine_mount_point: db1
    connection_name: SomeName
  register: result

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

作者

• Martin Chmielewski (@M4rt1nCh)

集合链接

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