community.general.onepassword_doc lookup – 从 1Password 获取存储的文档

注意

此 lookup 插件是 community.general 集合 (版本 10.1.0) 的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要其他要求才能使用此 lookup 插件，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：community.general.onepassword_doc。

community.general 8.1.0 中的新增功能

概要

要求

以下要求是在执行此 lookup 的本地控制器节点上需要的。

术语

参数

注释

术语

列表 / 元素=字符串 / 必需

要检索的项目标识符（不区分大小写的 UUID 或名称）。

关键字参数

这描述了 lookup 的关键字参数。这些是在以下示例中的值 key1=value1、key2=value2 等：lookup('community.general.onepassword_doc', key1=value1, key2=value2, ...) 和 query('community.general.onepassword_doc', key1=value1, key2=value2, ...)

参数

注释

account_id

字符串

要定位的帐户 ID。

connect_host

字符串

community.general 8.1.0 中新增

1Password Connect 的主机。必须与 connect_token 结合使用。

配置

connect_token

字符串

community.general 8.1.0 中新增

1Password Connect 的令牌。必须与 connect_host 结合使用。

配置

domain

字符串

1Password 的域名。

默认值： "1password.com"

master_password

别名：vault_password

字符串

用于解锁指定保管库的密码。

secret_key

字符串

执行初始登录时使用的密钥。

section

字符串

包含要检索的字段的项目部分（不区分大小写）。如果不存在，将返回来自任何部分的第一个匹配项。

service_account_token

字符串

服务帐户的访问密钥。

仅适用于 1Password CLI 2 版或更高版本。

配置

subdomain

字符串

要对其进行身份验证的 1Password 子域名。

username

字符串

用于登录的用户名。

vault

字符串

包含要检索的项目的保管库（不区分大小写）。如果不存在，将搜索所有保管库。

注释

注意

  • 当同时使用关键字参数和位置参数时，位置参数必须列在关键字参数之前：lookup('community.general.onepassword_doc', term1, term2, key1=value1, key2=value2) 和 query('community.general.onepassword_doc', term1, term2, key1=value1, key2=value2)

  • 文档内容是 1Password 中存储的精确字符串。

  • 此插件需要 op 版本 2 或更高版本。

  • 如果存在 1Password 会话，此查找将使用现有会话。如果不存在，并且您已经执行了初始登录（这意味着 ~/.op/config、~/.config/op/config 或 ~/.config/.op/config 存在），则仅需要 master_password。在这种情况下，您可以选择指定 subdomain，否则 op 将使用上次使用的子域。

  • 此查找可以通过提供 subdomain、username、secret_key 和 master_password 来执行初始登录。

  • 可以通过提供 account_id 来定位特定帐户。

  • 由于这些凭据的非常敏感的性质，强烈建议您只在任何给定时间传入所需的最小凭据。此外，请使用强度等于或高于 1Password 主密码的密钥将这些凭据存储在 Ansible Vault 中。

  • 此查找将来自 1Password 的潜在敏感数据存储为 Ansible 事实。如果启用缓存，则事实会受到缓存的影响，这意味着此数据可能会以明文形式存储在磁盘上或数据库中。

  • 已使用 op 版本 2.7.2 测试。

示例

- name: Retrieve a private key from 1Password
  ansible.builtin.debug:
    var: lookup('community.general.onepassword_doc', 'Private key')

返回值

键

描述

返回值

列表 / 元素=字符串

请求的文档

返回：成功

作者

  • Sam Doran (@samdoran)

提示

每个条目类型的配置项具有从低到高的优先级顺序。例如，列表中较低的变量将覆盖较高的变量。