Поиск community.hashi_vault.vault_list — выполнение операции перечисления в HashiCorp Vault

Примечание

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

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

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

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

Добавлено в community.hashi_vault 4.1.0

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

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

Выполняет универсальную операцию перечисления по заданному пути в HashiCorp Vault.

Требования

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

hvac (библиотека Python)
Подробные сведения о требованиях см. на странице требований к коллекции.

Термины

Параметр	Комментарии
Термины строка / обязательный	Путь (пути) в Vault для перечисления.

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

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

Параметр	Комментарии
auth_method string	Используемый метод аутентификации. Метод аутентификации `none` добавлен в коллекцию версии `1.2.0`. Метод аутентификации `cert` добавлен в коллекцию версии `1.4.0`. `aws_iam_login` переименован в `aws_iam` в коллекции версии `2.1.0` и удален в `3.0.0`. Метод аутентификации `azure` добавлен в коллекцию версии `3.2.0`. Метод аутентификации `gcp` добавлен в коллекцию версии `7.1.0`. Варианты: `"token"` ← (по умолчанию) `"userpass"` `"ldap"` `"approle"` `"aws_iam"` `"azure"` `"jwt"` `"cert"` `"gcp"` `"none"` Конфигурация: Запись INI: [hashi_vault_collection] auth_method = token добавлено в community.hashi_vault 1.4.0 Переменная среды: `ANSIBLE_HASHI_VAULT_AUTH_METHOD` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_auth_method добавлено в community.hashi_vault 1.2.0
aws_access_key псевдонимы: aws_access_key_id string	Ключ доступа AWS. Конфигурация: Переменная среды: `EC2_ACCESS_KEY` Переменная среды: `AWS_ACCESS_KEY` Переменная среды: `AWS_ACCESS_KEY_ID`
aws_iam_server_id string добавлено в community.hashi_vault 0.2.0	Если задано, устанавливает значение для заголовка `X-Vault-AWS-IAM-Server-ID` в запросе `GetCallerIdentity`. Конфигурация: Запись INI: [hashi_vault_collection] aws_iam_server_id = VALUE добавлено в community.hashi_vault 1.4.0 Переменная среды: `ANSIBLE_HASHI_VAULT_AWS_IAM_SERVER_ID`
aws_profile псевдонимы: boto_profile string	Профиль AWS Конфигурация: Переменная среды: `AWS_DEFAULT_PROFILE` Переменная среды: `AWS_PROFILE`
aws_secret_key псевдонимы: aws_secret_access_key string	Секретный ключ AWS, соответствующий ключу доступа. Конфигурация: Переменная среды: `EC2_SECRET_KEY` Переменная среды: `AWS_SECRET_KEY` Переменная среды: `AWS_SECRET_ACCESS_KEY`
aws_security_token string	Токен безопасности AWS при использовании временных ключей доступа и секретных ключей. Конфигурация: Переменная среды: `EC2_SECURITY_TOKEN` Переменная среды: `AWS_SESSION_TOKEN` Переменная среды: `AWS_SECURITY_TOKEN`
azure_client_id string добавлено в community.hashi_vault 3.2.0	Идентификатор клиента (также известный как идентификатор приложения) субъекта-службы Azure AD или управляемого удостоверения. Должен быть UUID. Если не задано, будет использоваться управляемое удостоверение, назначенное системой. Конфигурация: Запись INI: [hashi_vault_collection] azure_client_id = VALUE Переменная среды: `ANSIBLE_HASHI_VAULT_AZURE_CLIENT_ID` Переменная: ansible_hashi_vault_azure_client_id
azure_client_secret string добавлено в community.hashi_vault 3.2.0	Секрет клиента субъекта-службы Azure AD. Конфигурация: Переменная среды: `ANSIBLE_HASHI_VAULT_AZURE_CLIENT_SECRET` Переменная: ansible_hashi_vault_azure_client_secret
azure_resource string добавлено в community.hashi_vault 3.2.0	URL ресурса для приложения, зарегистрированного в Azure Active Directory. Обычно его не следует изменять относительно значения по умолчанию. По умолчанию: `"https://management.azure.com/"` Конфигурация: Запись INI: [hashi_vault_collection] azure_resource = https://management.azure.com/ Переменная среды: `ANSIBLE_HASHI_VAULT_AZURE_RESOURCE` Переменная: ansible_hashi_vault_azure_resource
azure_tenant_id string добавлено в community.hashi_vault 3.2.0	Идентификатор клиента Azure Active Directory (также известный как идентификатор каталога) субъекта-службы. Должен быть UUID. Обязателен при использовании субъекта-службы для аутентификации в Vault, например, если заданы оба параметра azure_client_id и azure_client_secret. Необязателен при использовании управляемого удостоверения для аутентификации в Vault. Конфигурация: Запись INI: [hashi_vault_collection] azure_tenant_id = VALUE Переменная среды: `ANSIBLE_HASHI_VAULT_AZURE_TENANT_ID` Переменная: ansible_hashi_vault_azure_tenant_id
ca_cert псевдонимы: cacert string	Путь к сертификату, используемому для аутентификации. Если он не задан никаким другим способом, будет использоваться переменная среды `VAULT_CACERT`. Конфигурация: Запись INI: [hashi_vault_collection] ca_cert = VALUE добавлено в community.hashi_vault 1.4.0 Переменная среды: `ANSIBLE_HASHI_VAULT_CA_CERT` добавлено в community.hashi_vault 1.2.0 Переменная: ansible_hashi_vault_ca_cert добавлено в community.hashi_vault 1.2.0
cert_auth_private_key path добавлено в community.hashi_vault 1.4.0	Для аутентификации `cert` — путь к файлу закрытого ключа в формате PEM. Конфигурация: Запись INI: [hashi_vault_collection] cert_auth_private_key = VALUE Переменная среды: `ANSIBLE_HASHI_VAULT_CERT_AUTH_PRIVATE_KEY` Переменная: ansible_hashi_vault_cert_auth_private_key добавлено в community.hashi_vault 6.2.0
cert_auth_public_key path добавлено в community.hashi_vault 1.4.0	Для аутентификации `cert` — путь к файлу сертификата в формате PEM. Конфигурация: Запись INI: [hashi_vault_collection] cert_auth_public_key = VALUE Переменная среды: `ANSIBLE_HASHI_VAULT_CERT_AUTH_PUBLIC_KEY` Переменная: ansible_hashi_vault_cert_auth_public_key добавлено в community.hashi_vault 6.2.0
jwt string	JSON Web Token (JWT), используемый для аутентификации в Vault с помощью JWT. Конфигурация: Переменная среды: `ANSIBLE_HASHI_VAULT_JWT`
mount_point string	Точка монтирования Vault. Если не задана, используется точка монтирования по умолчанию для соответствующего метода аутентификации. Не применяется для аутентификации по токену. Конфигурация: Запись INI: [hashi_vault_collection] mount_point = VALUE добавлено в community.hashi_vault 1.5.0 Переменная среды: `ANSIBLE_HASHI_VAULT_MOUNT_POINT` добавлено в community.hashi_vault 1.5.0 Переменная: ansible_hashi_vault_mount_point добавлено в community.hashi_vault 1.5.0
namespace string	Пространство имен Vault, в котором хранятся секреты. Для этого параметра требуется HVAC версии 0.7.0+ и Vault версии 0.11+. Этого также можно добиться, добавив пространство имен в начало точки монтирования аутентификации и/или пути к секрету (например, `mynamespace/secret/mysecret`). Если задана переменная среды `VAULT_NAMESPACE`, ее значение будет использоваться последним среди всех способов задания namespace. Конфигурация: Запись INI: [hashi_vault_collection] namespace = VALUE добавлено в community.hashi_vault 1.4.0 Переменная среды: `ANSIBLE_HASHI_VAULT_NAMESPACE` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_namespace добавлено в community.hashi_vault 1.2.0
password string	Пароль для аутентификации. Конфигурация: Переменная среды: `ANSIBLE_HASHI_VAULT_PASSWORD` добавлено в community.hashi_vault 1.2.0 Переменная: ansible_hashi_vault_password добавлено в community.hashi_vault 1.2.0
proxies any добавлено в community.hashi_vault 1.1.0	URL прокси-серверов, используемых для доступа к службе Vault. Значение может быть строкой или словарем. Если это словарь, укажите схему (например, `http` или `https`) в качестве ключа, а URL — в качестве значения. Если это строка, укажите один URL, который будет использоваться в качестве прокси для схем `http` и `https`. Строка, которую можно интерпретировать как словарь, будет преобразована в словарь (см. примеры). Для ресурсов HTTP и HTTPS можно указать разные прокси. Если параметр не задан, используются переменные среды библиотеки Requests. Конфигурация: Запись INI: [hashi_vault_collection] proxies = VALUE добавлено в community.hashi_vault 1.4.0 Переменная среды: `ANSIBLE_HASHI_VAULT_PROXIES` Переменная: ansible_hashi_vault_proxies добавлено в community.hashi_vault 1.2.0
region string	Регион AWS, для которого создается подключение. Конфигурация: Переменная среды: `EC2_REGION` Переменная среды: `AWS_REGION`
retries any добавлено в community.hashi_vault 1.3.0	Позволяет повторять запросы при ошибках на основе класса Retry библиотеки urllib3. В этой коллекции заданы рекомендуемые значения по умолчанию для повторных подключений к Vault. Для этого параметра можно указать положительное число (целое) или словарь. Если параметр не задан или число равно `0`, повторы отключены. Число задает общее количество повторов; для остальных параметров используются значения коллекции по умолчанию. Значение-словарь используется непосредственно для инициализации класса `Retry`, поэтому с его помощью можно полностью настроить повторы. Подробные сведения о повторах см. в руководстве пользователя коллекции. Конфигурация: Запись INI: [hashi_vault_collection] retries = VALUE добавлено в community.hashi_vault 1.4.0 Переменная среды: `ANSIBLE_HASHI_VAULT_RETRIES` Переменная: ansible_hashi_vault_retries
retry_action string добавлено в community.hashi_vault 1.3.0	Управляет тем, показывать ли сообщения о повторах и каким образом. Не влияет на запросы, которые не повторяются. Варианты: `"ignore"` `"warn"` ← (по умолчанию) Конфигурация: Запись INI: [hashi_vault_collection] retry_action = warn добавлено в community.hashi_vault 1.4.0 Переменная среды: `ANSIBLE_HASHI_VAULT_RETRY_ACTION` Переменная: ansible_hashi_vault_retry_action
role_id string	Идентификатор или имя роли Vault. Используется в методах аутентификации `approle`, `aws_iam`, `azure` и `cert`. Для аутентификации `cert`, если role_id не задан, по умолчанию выполняется попытка использовать все роли сертификатов и возвращается любая подходящая. Для аутентификации `azure` параметр role_id обязателен. Конфигурация: Запись INI: [hashi_vault_collection] role_id = VALUE добавлено в community.hashi_vault 1.4.0 Переменная среды: `ANSIBLE_HASHI_VAULT_ROLE_ID` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_role_id добавлено в community.hashi_vault 1.2.0
secret_id string	Идентификатор секрета для аутентификации Vault AppRole. Конфигурация: Переменная среды: `ANSIBLE_HASHI_VAULT_SECRET_ID` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_secret_id добавлено в community.hashi_vault 1.2.0
timeout integer добавлено в community.hashi_vault 1.3.0	Задает время ожидания подключения в секундах. Если параметр не задан, используется значение по умолчанию библиотеки `hvac`. Конфигурация: Запись INI: [hashi_vault_collection] timeout = VALUE добавлено в community.hashi_vault 1.4.0 Переменная среды: `ANSIBLE_HASHI_VAULT_TIMEOUT` Переменная: ansible_hashi_vault_timeout
token string	Токен Vault. Токен можно указать явно, через перечисленные переменные [env], а также через переменную среды `VAULT_TOKEN`. Если токен не задан явно или через переменные среды, плагин проверит наличие файла токена, определяемого параметрами token_path и token_file. Порядок загрузки токена (используется первое найденное значение): `token param -> ansible var -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> token file`. Конфигурация: Переменная среды: `ANSIBLE_HASHI_VAULT_TOKEN` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_token добавлено в community.hashi_vault 1.2.0
token_file string	Если токен не задан, будет предпринята попытка прочитать его из этого файла в token_path. По умолчанию: `".vault-token"` Конфигурация: Запись INI: [hashi_vault_collection] token_file = .vault-token добавлено в community.hashi_vault 1.4.0 Переменная среды: `ANSIBLE_HASHI_VAULT_TOKEN_FILE` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_token_file добавлено в community.hashi_vault 1.2.0

token_path string	Если токен не указан, будет предпринята попытка прочитать файл token_file по этому пути. Конфигурация: Запись INI: [hashi_vault_collection] token_path = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_TOKEN_PATH` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_token_path добавлено в community.hashi_vault 1.2.0
token_validate boolean добавлено в community.hashi_vault 0.2.0	При аутентификации по токену перед его использованием будет выполнена операция `lookup-self` для проверки действительности токена. Отключите эту функцию, если у вашего токена нет возможности `lookup-self`. Варианты: `false` ← (по умолчанию) `true` Конфигурация: Запись INI: [hashi_vault_collection] token_validate = false добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_TOKEN_VALIDATE` Переменная: ansible_hashi_vault_token_validate добавлено в community.hashi_vault 1.2.0
url string	URL-адрес службы Vault. Если значение не указано иным способом, будет использоваться значение переменной окружения `VAULT_ADDR`. Если также не задан `VAULT_ADDR`, будет выдана ошибка. Конфигурация: Запись INI: [hashi_vault_collection] url = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_ADDR` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_url добавлено в community.hashi_vault 1.2.0 Переменная: ansible_hashi_vault_addr добавлено в community.hashi_vault 1.2.0
username string	Имя пользователя для аутентификации. Конфигурация: Переменная окружения: `ANSIBLE_HASHI_VAULT_USERNAME` добавлено в community.hashi_vault 1.2.0 Переменная: ansible_hashi_vault_username добавлено в community.hashi_vault 1.2.0
validate_certs boolean	Управляет проверкой и валидацией SSL-сертификатов; обычно отключать её следует только для самоподписанных сертификатов. Если задано значение `VAULT_SKIP_VERIFY`, параметру будет присвоено противоположное значение, если validate_certs не задан явно. Если не заданы ни validate_certs, ни `VAULT_SKIP_VERIFY`, по умолчанию будет использоваться значение `true`. Варианты: `false` `true` Конфигурация: Переменная: ansible_hashi_vault_validate_certs добавлено в community.hashi_vault 1.2.0

Примечание

Для каждого типа записи (переменная Ansible, переменная окружения и т. д.) перечисленные выше параметры конфигурации упорядочены по приоритету от низкого к высокому. Например, переменная, находящаяся ниже в списке, переопределит переменную, расположенную выше. Типы записей также упорядочены по приоритету от низкого к высокому. Например, запись ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Примечания

Примечание

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

См. также

community.hashi_vault.vault_list: Выполняет операцию перечисления элементов в HashiCorp Vault.

Примеры

- name: List all secrets at a path
  ansible.builtin.debug:
    msg: "{{ lookup('community.hashi_vault.vault_list', 'secret/metadata', url='https://vault:8201') }}"
    # For kv2, the path needs to follow the pattern 'mount_point/metadata' or 'mount_point/metadata/path' to list all secrets in that path

- name: List access policies
  ansible.builtin.debug:
    msg: "{{ lookup('community.hashi_vault.vault_list', 'sys/policies/acl', url='https://vault:8201') }}"

- name: Perform multiple list operations with a single Vault login
  vars:
    paths:
      - secret/metadata
      - sys/policies/acl
  ansible.builtin.debug:
    msg: "{{ lookup('community.hashi_vault.vault_list', *paths, auth_method='userpass', username=user, password=pwd) }}"

- name: Perform multiple list operations with a single Vault login in a loop
  vars:
    paths:
      - secret/metadata
      - sys/policies/acl
  ansible.builtin.debug:
    msg: '{{ item }}'
  loop: "{{ query('community.hashi_vault.vault_list', *paths, auth_method='userpass', username=user, password=pwd) }}"

- name: Perform list operations with a single Vault login in a loop (via with_)
  vars:
    ansible_hashi_vault_auth_method: userpass
    ansible_hashi_vault_username: '{{ user }}'
    ansible_hashi_vault_password: '{{ pwd }}'
  ansible.builtin.debug:
    msg: '{{ item }}'
  with_community.hashi_vault.vault_list:
    - secret/metadata
    - sys/policies/acl

- name: Create fact consisting of list of dictionaries each with secret name (e.g. username) and value of a key (e.g. 'password') within that secret
  ansible.builtin.set_fact:
    credentials: >-
      {{
        credentials
        | default([]) + [
          {
            'username': item,
            'password': lookup('community.hashi_vault.vault_kv2_get', item, engine_mount_point='vpn-users').secret.password
          }
        ]
      }}
  loop: "{{ query('community.hashi_vault.vault_list', 'vpn-users/metadata')[0].data['keys'] }}"
  no_log: true

- ansible.builtin.debug:
    msg: "{{ credentials }}"

- name: Create the same as above without looping, and only 2 logins
  vars:
    secret_names: >-
      {{
        query('community.hashi_vault.vault_list', 'vpn-users/metadata')
        | map(attribute='data')
        | map(attribute='keys')
        | flatten
      }}
    secret_values: >-
      {{
        lookup('community.hashi_vault.vault_kv2_get', *secret_names, engine_mount_point='vpn-users')
        | map(attribute='secret')
        | map(attribute='password')
        | flatten
      }}
    credentials_dict: "{{ dict(secret_names | zip(secret_values)) }}"
  ansible.builtin.set_fact:
    credentials_dict: "{{ credentials_dict }}"
    credentials_list: "{{ credentials_dict | dict2items(key_name='username', value_name='password') }}"
  no_log: true

- ansible.builtin.debug:
    msg:
      - "Dictionary: {{ credentials_dict }}"
      - "List: {{ credentials_list }}"

- name: List all userpass users and output the token policies for each user
  ansible.builtin.debug:
    msg: "{{ lookup('community.hashi_vault.vault_read', 'auth/userpass/users/' + item).data.token_policies }}"
  loop: "{{ query('community.hashi_vault.vault_list', 'auth/userpass/users')[0].data['keys'] }}"

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

Ключ	Описание
Возвращаемое значение list / elements=dictionary	Необработанный результат чтения по указанному пути. Возвращается: success

Авторы

Tom Kivlin (@tomkivlin)

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

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