onepassword_facts – Извлечение фактов из элементов 1Password

Новое в версии 2.7.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус

Обзор

onepassword_facts оборачивает утилиту командной строки op для извлечения данных об одном или нескольких элементах 1Password и возвращает их как Ansible факты.
Происходит ошибка fatal, если любой из искомых элементов не найден.
Рекомендуется использовать опцию no_log для предотвращения записи значений секретов, которые извлекаются.

Требования

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

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auto_login -		Значение по умолчанию: {}	Словарь, содержащий данные для аутентификации. Если это значение установлено, onepassword_facts попытается автоматически войти в 1Password. Необходимые значения могут храниться в Ansible Vault и передаваться модулю таким образом. Без этого параметра необходимо предварительно войти в систему через 1Password CLI перед запуском Ansible.
	account -		Имя учетной записи 1Password (<account>.1password.com).
	masterpassword -		Главный пароль для вашего пользователя.
	secretkey -		Секретный ключ для вашего пользователя.
	username -		Имя пользователя 1Password.
cli_path -		Значение по умолчанию: "op"	Используется для указания точного пути к интерфейсу командной строки `op`
search_terms - / обязательно			Список одного или нескольких поисковых терминов. Каждый поисковый термин может быть простой строкой или словарем для большего контроля. При передаче простой строки предполагается, что поле равно `password`. При передаче словаря доступны следующие поля.
	field -		Имя поля для поиска в этом элементе (необязательно, по умолчанию "password" (или "document", если элемент имеет вложение).
	name -		Имя элемента 1Password для поиска (обязательно).
	section -		Имя раздела в этом элементе, содержащем указанное поле (необязательно, будет просматриваться все разделы, если не указано).
	vault -		Имя конкретного хранилища 1Password для поиска, полезно, если ваш пользователь 1Password имеет доступ к нескольким хранилищам (необязательно).

Примечания

Примечание

Основано на плагине поиска onepassword от Скотта Баканана <sbuchanan@ri.pn>.

Примеры

# Gather secrets from 1Password, assuming there is a 'password' field:
- name: Get a password
  onepassword_facts:
    search_terms: My 1Password item
  delegate_to: local
  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
  onepassword_facts:
    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: local
  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
  onepassword_facts:
    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: local
  no_log:      true   # Don't want to log the secrets to the console!

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

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

Ключ	Возвращаемое	Описание
onepassword словарь	успех	Словарь каждого элемента 1Password, соответствующего заданным поисковым терминам, показывает, что будет возвращено в третьем примере выше. Пример: {'Мой элемент 1Password': {'password': 'значение этого поля', 'Наименование пользовательского поля': 'значение этого поля'}, 'Мой другой элемент 1Password': {'password': 'значение этого поля'}, 'Элемент 1Password с вложением документа': {'document': 'содержимое документа, прикрепленного к этому элементу'}}

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Райан Конвей (@rylon)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/onepassword_facts_module.html