community.general.onepassword_doc lookup – Получение документов, хранящихся в 1Password
Примечание
Этот плагин поиска является частью коллекции community.general (версия 9.5.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.general. Для использования этого плагина поиска требуются дополнительные компоненты, см. Требования для получения подробной информации.
Для использования в playbook, укажите: 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 / required | Идентификатор(ы) (без учёта регистра 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 string добавлено в community.general 8.1.0 | Токен для 1Password Connect. Должен использоваться в сочетании с Конфигурация:
|
domain string | Домен 1Password. Значение по умолчанию: |
master_password псевдонимы: vault_password string | Пароль, используемый для разблокировки указанного хранилища. |
secret_key string | Секретный ключ, используемый при первоначальном входе. |
section string | Секция элемента, содержащая поле для извлечения (без учёта регистра). При отсутствии будет возвращено первое совпадение из любой секции. |
service_account_token string | Ключ доступа для учётной записи сервиса. Работает только с 1Password CLI версии 2 или выше. Конфигурация:
|
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')
Возвращаемое значение
Ключ | Описание |
|---|---|
Возвращаемое значение список / элементы=строка | Запрошенный документ Возвращено: успех |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/onepassword_doc_lookup.html