community.hashi_vault.vault_kv2_delete 模块 – 从 HashiCorp Vault 的 KV 版本 2 密钥存储中删除一个或多个密钥版本

注意

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

community.hashi_vault 3.4.0 中的新增功能

概要

• 从 HashiCorp Vault 的 KV 版本 2 密钥存储中删除一个或多个密钥版本。

要求

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

• 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 字符串	密钥后端挂载的路径。 默认值： "secret"
jwt 字符串	用于对 Vault 进行 JWT 身份验证的 JSON Web 令牌 (JWT)。
mount_point 字符串	Vault 挂载点。 如果未指定，则使用给定身份验证方法的默认挂载点。 不适用于令牌身份验证。
namespace 字符串	密钥所在的 Vault 命名空间。此选项需要 HVAC 0.7.0+ 和 Vault 0.11+。 或者，可以通过使用命名空间作为身份验证挂载点和/或密钥路径的前缀来实现此目的（例如 mynamespace/secret/mysecret）。 如果设置了环境变量 VAULT_NAMESPACE，则其值将在所有指定命名空间的方式中最后被使用。
密码 字符串	身份验证密码。
路径 字符串 / 必需	要删除的 Vault KV 路径。 这相对于 engine_mount_point，因此不应包含挂载路径。 对于 kv2，请勿包含 /data/ 或 /metadata/。
代理 任意 在 community.hashi_vault 1.1.0 中添加	用于访问 Vault 服务的代理 URL。 它可以是字符串或字典。 如果它是字典，请将方案（例如 http 或 https）作为键，并将 URL 作为值。 如果它是字符串，请提供一个将用作 http 和 https 方案的代理的单个 URL。 可以解释为字典的字符串将转换为字典（请参阅示例）。 您可以为 HTTP 和 HTTPS 资源指定不同的代理。 如果未指定，则使用Requests 库中的环境变量。
区域 字符串	要创建连接的 AWS 区域。
重试 任意 在 community.hashi_vault 1.3.0 中添加	允许基于 urllib3 库中的 Retry 类，在发生错误时进行重试。 此集合定义了重试连接到 Vault 的推荐默认值。 此选项可以指定为正数（整数）或字典。 如果未指定此选项或数字为 0，则禁用重试。 数字设置重试的总次数，并使用集合默认值进行其他设置。 字典值直接用于初始化 Retry 类，因此它可以用于完全自定义重试。 有关重试的详细信息，请参阅集合用户指南。
重试操作 字符串 在 community.hashi_vault 1.3.0 中添加	控制是否以及如何在重试时显示消息。 如果未重试请求，则此项无效。 选择 “忽略” "warn" ← (默认)
角色 ID 字符串	Vault 角色 ID 或名称。用于 approle，aws_iam，azure 和 cert 身份验证方法。 对于 cert 身份验证，如果未提供 role_id，则默认行为是尝试所有证书角色并返回任何匹配的角色。 对于 azure 身份验证，role_id 是必需的。
密钥 ID 字符串	用于 Vault AppRole 身份验证的密钥 ID。
超时 整数 在 community.hashi_vault 1.3.0 中添加	设置连接超时（以秒为单位）。 如果未设置，则使用 hvac 库的默认值。
令牌 字符串	Vault 令牌。可以通过列出的 [env] 变量以及 VAULT_TOKEN 环境变量显式指定令牌。 如果没有显式或通过 env 提供令牌，则插件将检查令牌文件，由 token_path 和 token_file 确定。 令牌加载的顺序（先找到的优先）是 token 参数 -> ansible 变量 -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> 令牌文件。
令牌文件 字符串	如果未指定令牌，将尝试从 token_path 中的此文件读取令牌。 默认值： ".vault-token"
令牌路径 字符串	如果未指定令牌，将尝试从此路径读取 token_file。
令牌验证 布尔值 在 community.hashi_vault 0.2.0 中添加	对于令牌身份验证，将执行 lookup-self 操作以确定令牌的有效性，然后再使用它。 如果您的令牌不具有 lookup-self 功能，请禁用此项。 选择 false ← (默认) true
URL 字符串	Vault 服务的 URL。 如果未通过任何其他方式指定，则将使用 VAULT_ADDR 环境变量的值。 如果也未定义 VAULT_ADDR，则会引发错误。
用户名 字符串	身份验证用户名。
验证证书 布尔值	控制 SSL 证书的验证，通常您只想在自签名证书的情况下关闭此项。 如果设置了 VAULT_SKIP_VERIFY 且未显式提供 validate_certs，则将使用 VAULT_SKIP_VERIFY 的反值填充此项。 如果未设置 validate_certs 或 VAULT_SKIP_VERIFY，则默认为 true。 选择 false true
版本 列表 / 元素=整数	要删除的一个或多个机密版本。 省略时，将删除机密的最新版本。

属性

属性	支持	描述
动作组	动作组： community.hashi_vault.vault	在 module_defaults 中使用 group/community.hashi_vault.vault 来为此模块设置默认值。
检查模式	支持： 部分 在检查模式下，模块返回 changed 状态，而不联系 Vault。 考虑使用 community.hashi_vault.vault_kv2_get 来首先验证机密是否存在。	可以在 check_mode 下运行，并返回更改状态预测，而不修改目标。

说明

注意

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

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

另请参阅

另请参阅

community.hashi_vault.vault_kv2_get

从 HashiCorp Vault 的 KV 版本 2 机密存储中获取机密。

community.hashi_vault.vault_kv2_write

对 HashiCorp Vault 中的 KVv2 机密执行写入操作。

KV2 机密引擎

Vault KV 机密引擎版本 2 的文档。

示例

- name: Delete the latest version of the secret/mysecret secret.
  community.hashi_vault.vault_kv2_delete:
    url: https://vault:8201
    path: secret/mysecret
    auth_method: userpass
    username: user
    password: '{{ passwd }}'
  register: result

- name: Delete versions 1 and 3 of the secret/mysecret secret.
  community.hashi_vault.vault_kv2_delete:
    url: https://vault:8201
    path: secret/mysecret
    versions: [1, 3]
    auth_method: userpass
    username: user
    password: '{{ passwd }}'

返回值

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

键	描述
数据 字典	针对给定路径的删除操作的原始结果。 通常为空，但可能包含警告或其他信息。 返回：成功

作者

• Isaac Wagner (@idwagner)

集合链接

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