community.general.bitwarden поиск – Извлечение секретов из Bitwarden

Примечание

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

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

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

Для использования в playbook укажите: community.general.bitwarden.

Новая функция в community.general 5.4.0

Обзор
Требования
Термины
Параметры ключевых слов
Примечания
Примеры
Значение возврата

Обзор

Извлечение секретов из Bitwarden.

Требования

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

Утилита командной строки bw
Вход в Bitwarden
Хранилище Bitwarden разблокировано
BW_SESSION переменная среды установлена

Термины

Параметр	Комментарии
Термины список / элементы=строка / обязательно	Ключ(и) для извлечения значений из информации входа.

Параметры ключевых слов

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

Параметр	Комментарии
bw_session строка добавлен в community.general 8.4.0	Передать ключ сессии вместо чтения из среды.
collection_id строка добавлен в community.general 6.3.0	Идентификатор коллекции для фильтрации результатов по коллекции. Оставьте значение пустым, чтобы пропустить фильтрацию.
field строка	Поле для извлечения. Оставьте пустым, чтобы извлечь весь ответ.
organization_id строка добавлен в community.general 8.5.0	Идентификатор организации для фильтрации результатов по организации. Оставьте значение пустым, чтобы пропустить фильтрацию.
search строка добавлен в community.general 5.7.0	Поле для извлечения, например `name` или `id`. Если установлено `id`, может быть возвращено только ноль или один элемент. Используйте фильтр Jinja `first` для получения единственного элемента списка. Если установлено `None` или `''`, или если `_terms` пусто, записи не фильтруются по полям. По умолчанию: `"name"`

Примечания

Примечание

При совместном использовании параметров ключевых слов и позиционных параметров позиционные параметры должны быть перечислены перед параметрами ключевых слов: lookup('community.general.bitwarden', term1, term2, key1=value1, key2=value2) и query('community.general.bitwarden', term1, term2, key1=value1, key2=value2)

Примеры

- name: "Get 'password' from all Bitwarden records named 'a_test'"
  ansible.builtin.debug:
    msg: >-
      {{ lookup('community.general.bitwarden', 'a_test', field='password') }}

- name: "Get 'password' from Bitwarden record with ID 'bafba515-af11-47e6-abe3-af1200cd18b2'"
  ansible.builtin.debug:
    msg: >-
      {{ lookup('community.general.bitwarden', 'bafba515-af11-47e6-abe3-af1200cd18b2', search='id', field='password') | first }}

- name: "Get 'password' from all Bitwarden records named 'a_test' from collection"
  ansible.builtin.debug:
    msg: >-
      {{ lookup('community.general.bitwarden', 'a_test', field='password', collection_id='bafba515-af11-47e6-abe3-af1200cd18b2') }}

- name: "Get list of all full Bitwarden records named 'a_test'"
  ansible.builtin.debug:
    msg: >-
      {{ lookup('community.general.bitwarden', 'a_test') }}

- name: "Get custom field 'api_key' from all Bitwarden records named 'a_test'"
  ansible.builtin.debug:
    msg: >-
      {{ lookup('community.general.bitwarden', 'a_test', field='api_key') }}

- name: "Get 'password' from all Bitwarden records named 'a_test', using given session key"
  ansible.builtin.debug:
    msg: >-
      {{ lookup('community.general.bitwarden', 'a_test', field='password', bw_session='bXZ9B5TXi6...') }}

- name: "Get all Bitwarden records from collection"
  ansible.builtin.debug:
    msg: >-
      {{ lookup('community.general.bitwarden', None, collection_id='bafba515-af11-47e6-abe3-af1200cd18b2') }}

Значение возврата

Ключ	Описание
Возвращаемое значение список / элементы=список	Список с одним элементом, содержащий список запрошенных полей или JSON-объекты совпадений. Если вы используете `query`, вы получите список списков. Если вы используете `lookup` без `wantlist=true`, это всегда сводится к списку значений полей или JSON-объектов. Возвращается: успешно

Ключ

Описание

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

список / элементы=список

Список с одним элементом, содержащий список запрошенных полей или JSON-объекты совпадений.

Если вы используете query, вы получите список списков. Если вы используете lookup без wantlist=true, это всегда сводится к списку значений полей или JSON-объектов.

Возвращается: успешно

Авторы

Jonathan Lung (@lungj)

Подсказка

Элементы конфигурации для каждого типа записи имеют порядок приоритетов снизу вверх. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше.

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

© 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/bitwarden_lookup.html