community.hashi_vault.vault_write 模块 – 对 HashiCorp Vault 执行写入操作

注意

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

community.hashi_vault 2.4.0 中的新增功能

概要

• 对 HashiCorp Vault 中给定路径执行通用写入操作，并返回任何输出。

要求

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

• 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 格式。
data 字典	要序列化为 JSON 然后作为请求正文发送的字典。 如果字典包含名为 path 或 wrap_ttl 的键，则调用将使用 hvac<1.2 失败。 默认值： {}
jwt 字符串	用于 JWT 身份验证访问 Vault 的 JSON Web 令牌 (JWT)。
挂载点 (mount_point) 字符串	Vault 挂载点。 如果未指定，则使用给定身份验证方法的默认挂载点。 不适用于令牌身份验证。
命名空间 (namespace) 字符串	秘密所在的 Vault 命名空间。此选项需要 HVAC 0.7.0+ 和 Vault 0.11+。 或者，可以通过在身份验证挂载点和/或秘密路径前添加命名空间来实现此目的（例如 mynamespace/secret/mysecret）。 如果设置了环境变量 VAULT_NAMESPACE，则其值将在所有指定命名空间的方法中最后使用。
密码 (password) 字符串	身份验证密码。
路径 字符串 / 必需	要写入的 Vault 路径。
代理 (proxies) 任意 在 community.hashi_vault 1.1.0 中添加	用于访问 Vault 服务的代理的 URL。 可以是字符串或字典。 如果是字典，请提供方案（例如 http 或 https）作为键，并提供 URL 作为值。 如果是字符串，请提供一个将用作 http 和 https 方案代理的单个 URL。 可以解释为字典的字符串将转换为字典（参见示例）。 您可以为 HTTP 和 HTTPS 资源指定不同的代理。 如果未指定，则使用Requests 库的环境变量。
区域 (region) 字符串	要为其创建连接的 AWS 区域。
重试 (retries) 任意 在 community.hashi_vault 1.3.0 中添加	允许根据urllib3 库中的 Retry 类重试错误。 此集合定义了重试与 Vault 连接的推荐默认值。 此选项可以指定为正数（整数）或字典。 如果未指定此选项或数字为 0，则禁用重试。 数字设置重试的总数，并使用集合默认值进行其他设置。 字典值直接用于初始化 Retry 类，因此可以用于完全自定义重试。 有关重试的详细信息，请参见集合用户指南。
重试操作 (retry_action) 字符串 在 community.hashi_vault 1.3.0 中添加	控制是否以及如何显示重试的消息。 如果未重试请求，则此选项无效。 选项 "忽略" (ignore) "警告" ← (默认)
角色 ID (role_id) 字符串	Vault 角色 ID 或名称。用于 approle、aws_iam、azure 和 cert 身份验证方法。 对于 cert 身份验证，如果没有提供role_id，则默认行为是尝试所有证书角色并返回任何一个匹配的角色。 对于 azure 身份验证，需要role_id。
秘密 ID (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
包装 TTL (wrap_ttl) 字符串	指定带有持续时间的响应包装令牌创建。例如 15s、20m、25h。

属性

属性	支持	描述
action_group	操作组： community.hashi_vault.vault	在 module_defaults 中使用 group/community.hashi_vault.vault 为此模块设置默认值。
检查模式 (check_mode)	支持：部分 在检查模式下，将返回空响应，并且不会执行写入操作。	可以在 check_mode 中运行并返回更改状态预测，而无需修改目标。

注释

注意

• vault_write 是一个通用模块，用于执行尚未有专用模块的操作。如果存在特定模块，则应改用该模块。

• data 选项不被视为秘密，可能会被记录。如果data包含敏感值，请使用 no_log 关键字。

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

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

另请参阅

另请参阅

community.hashi_vault.vault_write 查找

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

community.hashi_vault.vault_read

对 HashiCorp Vault 执行读取操作。

community.hashi_vault.vault_read 查找

community.hashi_vault.vault_read 查找插件的官方文档。

示例

- name: Write a value to the cubbyhole via the remote host with userpass auth
  community.hashi_vault.vault_write:
    url: https://vault:8201
    path: cubbyhole/mysecret
    data:
      key1: val1
      key2: val2
    auth_method: userpass
    username: user
    password: '{{ passwd }}'
  register: result

- name: Display the result of the write (this can be empty)
  ansible.builtin.debug:
    msg: "{{ result.data }}"

- name: Write secret to Vault using key value V2 engine
  community.hashi_vault.vault_write:
    path: secret/data/mysecret
    data:
      data:
        key1: val1
        key2: val2

- name: Retrieve an approle role ID from Vault via the remote host
  community.hashi_vault.vault_read:
    url: https://vault:8201
    path: auth/approle/role/role-name/role-id
  register: approle_id

- name: Generate a secret-id for the given approle
  community.hashi_vault.vault_write:
    url: https://vault:8201
    path: auth/approle/role/role-name/secret-id
  register: secret_id

- name: Display the role ID and secret ID
  ansible.builtin.debug:
    msg:
      - "role-id: {{ approle_id.data.data.role_id }}"
      - "secret-id: {{ secret_id.data.data.secret_id }}"

返回值

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

键	描述
data 字典	对给定路径进行写入操作的原始结果。 返回：成功

作者

• Brian Scholer (@briantist)

集合链接

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