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

Примечание

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

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

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

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

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

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

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

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

Требования

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

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

Параметры

Параметр	Комментарии
Terms list / elements=string / обязательный	Ключи, по которым нужно получить значения из данных для входа.

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

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

Параметр	Комментарии
bw_session string добавлено в community.general 8.4.0	Передать ключ сеанса вместо чтения из переменной окружения.
collection_id string добавлено в community.general 6.3.0	Идентификатор коллекции для фильтрации результатов по коллекции. Не задавайте параметр, чтобы не применять фильтрацию. `collection_id` и `collection_name` являются взаимоисключающими.
collection_name string добавлено в community.general 10.4.0	Имя коллекции для фильтрации результатов по коллекции. Не задавайте параметр, чтобы не применять фильтрацию. `collection_id` и `collection_name` являются взаимоисключающими.
field string	Поле для получения. Не задавайте параметр, чтобы получить весь ответ.
organization_id string добавлено в community.general 8.5.0	Идентификатор организации для фильтрации результатов по организации. Не задавайте параметр, чтобы не применять фильтрацию.
result_count integer добавлено в community.general 10.4.0	Ожидаемое количество результатов запроса поиска. Задача завершается с ошибкой, если `result_count` задан, но не совпадает с количеством результатов запроса. Оставьте параметр пустым, чтобы пропустить эту проверку.
search string добавлено в 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') }}

- name: "Get all Bitwarden records from collection"
  ansible.builtin.debug:
    msg: >-
      {{ lookup('community.general.bitwarden', None, collection_name='my_collections/test_collection') }}

- name: "Get Bitwarden record named 'a_test', ensure there is exactly one match"
  ansible.builtin.debug:
    msg: >-
      {{ lookup('community.general.bitwarden', 'a_test', result_count=1) }}

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

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

Ключ

Описание

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

list / elements=list

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

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

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

Авторы

Jonathan Lung (@lungj)

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

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