поиск community.general.onepassword_doc — получение документов, хранящихся в 1Password

Примечание

Этот плагин поиска входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.general. Для использования этого плагина поиска могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.general.onepassword_doc.

Добавлено в community.general 8.1.0

Краткое описание
Требования
Аргументы
Именованные параметры
Примечания
Примеры
Возвращаемое значение

Краткое описание

community.general.onepassword_doc является обёрткой для утилиты командной строки op, позволяющей получать один или несколько документов из 1Password.

Требования

Следующие требования должны быть выполнены на локальном управляющем узле, который выполняет этот поиск.

op утилита командной строки 1Password версии 2 или новее.
См. https://support.1password.com/command-line/

Аргументы

Параметр	Комментарии
Terms list / elements=string / обязательный	Идентификатор(ы) (UUID или имя без учёта регистра) извлекаемого(ых) элемента(ов).

Именованные параметры

Здесь описаны именованные параметры поиска. В приведённых далее примерах это значения key1=value1, key2=value2 и так далее: lookup('community.general.onepassword_doc', key1=value1, key2=value2, ...) и query('community.general.onepassword_doc', key1=value1, key2=value2, ...)

Параметр	Комментарии
account_id string	Идентификатор целевой учётной записи.
connect_host string добавлено в community.general 8.1.0	Узел 1Password Connect. Необходимо использовать вместе с `connect_token`. Конфигурация: Переменная среды: `OP_CONNECT_HOST`
connect_token string добавлено в community.general 8.1.0	Токен для 1Password Connect. Необходимо использовать вместе с `connect_host`. Конфигурация: Переменная среды: `OP_CONNECT_TOKEN`
domain string	Домен 1Password. По умолчанию: `"1password.com"`
master_password псевдонимы: vault_password string	Пароль для разблокировки указанного хранилища.
secret_key string	Секретный ключ, используемый при первоначальном входе.
section string	Раздел элемента, содержащий извлекаемое поле (без учёта регистра). Если не указан, возвращается первое совпадение из любого раздела.
service_account_token string	Ключ доступа для сервисной учётной записи. Работает только с 1Password CLI версии 2 или новее. Конфигурация: Переменная среды: `OP_SERVICE_ACCOUNT_TOKEN` добавлено в community.general 8.2.0
subdomain string	Поддомен 1Password для аутентификации.
username string	Имя пользователя для входа.
vault string	Хранилище, содержащее извлекаемый элемент (без учёта регистра). Если не указано, выполняется поиск во всех хранилищах.

Примечания

Примечание

При совместном использовании именованных и позиционных параметров позиционные параметры необходимо указывать перед именованными: 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.
Учитывая крайне конфиденциальный характер этих учётных данных, настоятельно рекомендуется передавать только минимально необходимые в данный момент учётные данные. Также храните их в Ansible Vault, используя ключ, надёжность которого не ниже надёжности главного пароля 1Password.
Этот поиск сохраняет потенциально конфиденциальные данные из 1Password в виде фактов Ansible. Если включено кэширование, факты кэшируются, а значит эти данные могут храниться в открытом виде на диске или в базе данных.
Проверено с op версии 2.7.2.

Примеры

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

Возвращаемое значение

Ключ	Описание
Возвращаемое значение list / elements=string	Запрошенный документ. Возвращается: при успешном выполнении

Авторы

Sam Doran (@samdoran)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/onepassword_doc_lookup.html