Модуль community.general.onepassword_info – сбор сведений об элементах из 1Password

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

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

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

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

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

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

community.general.onepassword_info использует утилиту командной строки op для получения данных об одном или нескольких элементах 1Password.
Если хотя бы один из искомых элементов не найден, возникает критическая ошибка.
Рекомендуется использовать параметр no_log, чтобы избежать записи в журнал значений получаемых секретов.

Требования

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

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

Параметры

Параметр	Комментарии
auto_login dictionary	Словарь с данными для аутентификации. Если этот параметр задан, модуль пытается автоматически выполнить вход в 1Password. Если параметр не задан, перед запуском Ansible необходимо предварительно войти в систему с помощью CLI 1Password. Настоятельно рекомендуется хранить учетные данные 1Password в Ansible Vault. Убедитесь, что ключ, используемый для шифрования Ansible Vault, по надежности не уступает мастер-паролю 1Password или превосходит его.
master_password string / обязательный	Мастер-пароль для вашего поддомена. Этот параметр всегда обязателен, если указан `auto_login`.
secret_key string	Секретный ключ для вашего поддомена. Требуется только для первого входа.
subdomain string	Имя поддомена 1Password (`subdomain`.1password.com). Если параметр не указан, используется последний поддомен.
username string	Имя пользователя 1Password. Требуется только для первого входа.
cli_path path	Используется для указания точного пути к интерфейсу командной строки `op`. По умолчанию: `"op"`
search_terms list / элементы=dictionary / обязательный	Список из одного или нескольких условий поиска. Каждое условие поиска может быть простой строкой или словарем, предоставляющим больше возможностей настройки. Если передана простая строка, предполагается, что `search_terms[].field` имеет значение `password`. Если передан словарь, доступны следующие поля.
field string	Имя поля, которое нужно найти в этом элементе (необязательный параметр; по умолчанию используется `password` или `document`, если у элемента есть вложение).
name string	Имя искомого элемента 1Password (обязательный параметр).
section string	Имя раздела этого элемента, содержащего указанное поле (необязательный параметр; если он не указан, поиск выполняется во всех разделах).
vault string	Имя хранилища 1Password, в котором нужно выполнить поиск. Параметр полезен, если у пользователя 1Password есть доступ к нескольким хранилищам (необязательный).

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Модуль может работать в режиме `check_mode` и возвращать прогноз статуса изменений, не изменяя целевой объект.
diff_mode	Поддержка: Н/Д Это действие не изменяет состояние.	В режиме diff возвращает сведения об изменениях (или об изменениях, которые, возможно, необходимо внести в `check_mode`).

Примечания

Примечание

Проверено с версией op 0.5.5.
Основано на подключаемом модуле поиска community.general.onepassword, созданном Scott Buchanan <sbuchanan@ri.pn>.

Примеры

# Gather secrets from 1Password, assuming there is a 'password' field:
- name: Get a password
  community.general.onepassword_info:
    search_terms: My 1Password item
  delegate_to: localhost
  register: my_1password_item
  no_log: true       # Don't want to log the secrets to the console!

# Gather secrets from 1Password, with more advanced search terms:
- name: Get a password
  community.general.onepassword_info:
    search_terms:
      - name: My 1Password item
        field: Custom field name       # optional, defaults to 'password'
        section: Custom section name   # optional, defaults to 'None'
        vault: Name of the vault       # optional, only necessary if there is more than 1 Vault available
  delegate_to: localhost
  register: my_1password_item
  no_log: true                         # Don't want to log the secrets to the console!

# Gather secrets combining simple and advanced search terms to retrieve two items, one of which we fetch two
# fields. In the first 'password' is fetched, as a field name is not specified (default behaviour) and in the
# second, 'Custom field name' is fetched, as that is specified explicitly.
- name: Get a password
  community.general.onepassword_info:
    search_terms:
      - My 1Password item              # 'name' is optional when passing a simple string...
      - name: My Other 1Password item  # ...but it can also be set for consistency
      - name: My 1Password item
        field: Custom field name       # optional, defaults to 'password'
        section: Custom section name   # optional, defaults to 'None'
        vault: Name of the vault       # optional, only necessary if there is more than 1 Vault available
      - name: A 1Password item with document attachment
  delegate_to: localhost
  register: my_1password_item
  no_log: true                         # Don't want to log the secrets to the console!

- name: Debug a password (for example)
  ansible.builtin.debug:
    msg: "{{ my_1password_item['onepassword']['My 1Password item'] }}"

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

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
onepassword dictionary	Словарь, содержащий все элементы 1Password, соответствующие заданным условиям поиска. Показывает результат, который был бы возвращен в третьем примере выше. Возвращается: success Пример: `{"A 1Password item with document attachment": {"document": "the contents of the document attached to this item"}, "My 1Password item": {"Custom field name": "the value of this field", "password": "the value of this field"}, "My Other 1Password item": {"password": "the value of this field"}}`

Ключ

Описание

onepassword

dictionary

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

Возвращается: success

Пример: {"A 1Password item with document attachment": {"document": "the contents of the document attached to this item"}, "My 1Password item": {"Custom field name": "the value of this field", "password": "the value of this field"}, "My Other 1Password item": {"password": "the value of this field"}}

Авторы

Ryan Conway (@Rylon)

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

© 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_info_module.html