community.hashi_vault.vault_kv2_write 模块 – 对 HashiCorp Vault 中的 KVv2 密钥执行写入操作

注意

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

community.hashi_vault 4.2.0 中的新增功能

概要

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

要求

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

• 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 环境变量。
cas 整数	执行检查和设置操作。
cert_auth_private_key 路径 在 community.hashi_vault 1.4.0 中添加	对于 cert 身份验证，使用 PEM 格式进行身份验证的私钥文件的路径。
cert_auth_public_key 路径 在 community.hashi_vault 1.4.0 中添加	对于 cert 身份验证，使用 PEM 格式进行身份验证的证书文件的路径。
data 字典 / 必需	要写入的 KVv2 密钥数据。
engine_mount_point 字符串	安装密钥后端的位置。 默认值： "secret"
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 字符串	身份验证密码。
路径 字符串 / 必需	要写入的 Vault KVv2 路径。 这是相对于engine_mount_point的，因此不应包含挂载路径。
proxies 任意 在 community.hashi_vault 1.1.0 中添加	用于访问 Vault 服务的代理的 URL。 它可以是字符串或字典。 如果是字典，请使用方案（例如 http 或 https）作为键，URL 作为值。 如果是字符串，请提供一个将用作 http 和 https 方案代理的单个 URL。 可以解释为字典的字符串将被转换为字典（参见示例）。 您可以为 HTTP 和 HTTPS 资源指定不同的代理。 如果未指定，则使用Requests 库的环境变量。
read_before_write 布尔值	首先读取密钥，只有当data与读取的数据不同时才写入。 如果为 true，则需要对密钥具有 read 权限。 如果为 false，则此模块在非检查模式下将始终写入path。 选项 false ← (默认) true
region 字符串	要为此创建连接的 AWS 区域。
retries 任意 在 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。
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	支持：部分 如果read_before_write为 true，则支持完整的检查模式功能。 如果read_before_write为 false，则状态将始终为 changed，但在检查模式下不会执行写入操作。	可以在 check_mode 下运行并返回更改状态预测，而无需修改目标。

另请参阅

另请参阅

community.hashi_vault.vault_write

对 HashiCorp Vault 执行写入操作。

community.hashi_vault.vault_kv2_get

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

community.hashi_vault.vault_kv2_delete

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

community.hashi_vault.vault_write lookup

community.hashi_vault.vault_write lookup 插件的官方文档。

KV2 密钥引擎

Vault KV 密钥引擎（版本 2）的文档。

示例

- name: Write/create a secret
  community.hashi_vault.vault_kv2_write:
    url: https://vault:8200
    path: hello
    data:
      foo: bar

- name: Create a secret with CAS (the secret must not exist)
  community.hashi_vault.vault_kv2_write:
    url: https://vault:8200
    path: caspath
    cas: 0
    data:
      foo: bar

- name: Update a secret with CAS
  community.hashi_vault.vault_kv2_write:
    url: https://vault:8200
    path: caspath
    cas: 2
    data:
      hello: world

# This module does not have patch capability built in.
# Patching can be achieved with multiple tasks.

- name: Retrieve current secret
  register: current
  community.hashi_vault.vault_kv2_get:
    url: https://vault:8200
    path: hello

## patch without CAS
- name: Update the secret
  vars:
    values_to_update:
      foo: baz
      hello: goodbye
  community.hashi_vault.vault_kv2_write:
    url: https://vault:8200
    path: hello
    data: >-
      {{
        current.secret
        | combine(values_to_update)
      }}

## patch with CAS
- name: Update the secret
  vars:
    values_to_update:
      foo: baz
      hello: goodbye
  community.hashi_vault.vault_kv2_write:
    url: https://vault:8200
    path: hello
    cas: '{{ current.metadata.version | int }}'
    data: >-
      {{
        current.secret
        | combine(values_to_update)
      }}

返回值

公共返回值已在此处记录，以下是此模块独有的字段

键	描述
raw 字典	原始 Vault 响应。 返回：changed 示例： {"auth": null, "data": {"created_time": "2023-02-21T19:51:50.801757862Z", "custom_metadata": null, "deletion_time": "", "destroyed": false, "version": 1}, "lease_duration": 0, "lease_id": "", "renewable": false, "request_id": "52eb1aa7-5a38-9a02-9246-efc5bf9581ec", "warnings": null, "wrap_info": null}

作者

• Devon Mar (@devon-mar)

集合链接

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