community.hashi_vault.vault_kv1_get 模块 – 从 HashiCorp Vault 的 KV 版本 1 秘密存储中获取密钥

注意

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

community.hashi_vault 2.5.0 新增

概要

• 从 HashiCorp Vault 的 KV 版本 1 秘密存储中获取密钥。

要求

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

• 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 中添加	如果指定，则设置要在 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 格式。
engine_mount_point 字符串	秘密后端挂载的路径。 默认: "kv"
jwt 字符串	用于 JWT 向 Vault 进行身份验证的 JSON Web 令牌 (JWT)。
mount_point 字符串	Vault 挂载点。 如果未指定，则使用给定身份验证方法的默认挂载点。 不适用于令牌身份验证。
namespace 字符串	秘密所在的 Vault 命名空间。此选项需要 HVAC 0.7.0+ 和 Vault 0.11+。 或者，可以通过在身份验证挂载点和/或密钥路径前加上命名空间来实现（例如，mynamespace/secret/mysecret）。 如果设置了环境变量 VAULT_NAMESPACE，则其值将在所有指定命名空间的方式中最后被使用。
password 字符串	身份验证密码。
路径 string / required	要读取的 Vault KV 路径。 这是相对于engine_mount_point的路径，因此不应包含挂载路径。
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 身份验证的密钥 ID。
timeout integer 在 community.hashi_vault 1.3.0 中添加	设置连接超时时间（以秒为单位）。 如果未设置，则使用 hvac 库的默认值。
token 字符串	Vault 令牌。可以通过列出的 [env] 变量以及 VAULT_TOKEN 环境变量显式指定令牌。 如果没有显式提供令牌，或通过环境变量提供，则插件将检查令牌文件，由 token_path 和 token_file 确定。 令牌加载的顺序（先找到的优先）是 token 参数 -> ansible 变量 -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> 令牌文件。
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	支持：完全 此模块是“只读”的，并且在检查模式下运行方式相同。	可以在 check_mode 中运行并返回更改状态预测，而无需修改目标。

另请参阅

另请参阅

community.hashi_vault.vault_kv1_get lookup

community.hashi_vault.vault_kv1_get 查询插件的官方文档。

community.hashi_vault.vault_kv2_get

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

KV1 密钥引擎

Vault KV 密钥引擎版本 1 的文档。

示例

- name: Read a kv1 secret from Vault via the remote host with userpass auth
  community.hashi_vault.vault_kv1_get:
    url: https://vault:8201
    path: hello
    auth_method: userpass
    username: user
    password: '{{ passwd }}'
  register: response
  # equivalent API path is kv/hello

- name: Display the results
  ansible.builtin.debug:
    msg:
      - "Secret: {{ response.secret }}"
      - "Data: {{ response.data }} (same as secret in kv1)"
      - "Metadata: {{ response.metadata }} (response info in kv1)"
      - "Full response: {{ response.raw }}"
      - "Value of key 'password' in the secret: {{ response.secret.password }}"

- name: Read a secret from kv1 with a different mount via the remote host
  community.hashi_vault.vault_kv1_get:
    url: https://vault:8201
    engine_mount_point: custom/kv1/mount
    path: hello
  register: response
  # equivalent API path is custom/kv1/mount/hello

- name: Display the results
  ansible.builtin.debug:
    msg:
      - "Secret: {{ response.secret }}"
      - "Data: {{ response.data }} (same as secret in kv1)"
      - "Metadata: {{ response.metadata }} (response info in kv1)"
      - "Full response: {{ response.raw }}"

返回值

常见返回值记录在这里，以下是此模块独有的字段

键	描述
data dictionary	原始结果的 data 字段。也可以通过 raw.data 访问。 返回：成功 示例： {"Key1": "value1", "Key2": "value2"}
metadata dictionary	这是一个合成结果。它与删除了 data 的 raw 相同。 返回：成功 示例： {"auth": null, "lease_duration": 2764800, "lease_id": "", "renewable": false, "request_id": "e99f145f-f02a-7073-1229-e3f191057a70", "warnings": null, "wrap_info": null}
raw dictionary	针对给定路径读取的原始结果。 返回：成功 示例： {"auth": null, "data": {"Key1": "value1", "Key2": "value2"}, "lease_duration": 2764800, "lease_id": "", "renewable": false, "request_id": "e99f145f-f02a-7073-1229-e3f191057a70", "warnings": null, "wrap_info": null}
secret dictionary	原始结果的 data 字段。这与返回值中的 data 相同。 返回：成功 示例： {"Key1": "value1", "Key2": "value2"}

作者

• Brian Scholer (@briantist)

集合链接

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