Модуль community.hashi_vault.vault_database_roles_list — возвращает список доступных (динамических) ролей

Примечание

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

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

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

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

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

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

Обзор

Возвращает список доступных (динамических) ролей.

Требования

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

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

Параметры

Параметр	Комментарии
auth_method строка	Метод аутентификации. Метод аутентификации `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"`
aws_access_key псевдонимы: aws_access_key_id строка	Ключ доступа AWS.
aws_iam_server_id строка добавлено в community.hashi_vault 0.2.0	Если задано, устанавливает значение для заголовка `X-Vault-AWS-IAM-Server-ID` в запросе `GetCallerIdentity`.
aws_profile псевдонимы: boto_profile строка	Профиль AWS
aws_secret_key псевдонимы: aws_secret_access_key строка	Секретный ключ AWS, соответствующий ключу доступа.
aws_security_token строка	Токен безопасности AWS при использовании временных ключей доступа и секретных ключей.
azure_client_id строка добавлено в community.hashi_vault 3.2.0	Идентификатор клиента (также называемый идентификатором приложения) субъекта-службы Azure AD или управляемого удостоверения. Должен быть UUID. Если не задано, будет использоваться системное управляемое удостоверение.
azure_client_secret строка добавлено в community.hashi_vault 3.2.0	Секрет клиента субъекта-службы Azure AD.
azure_resource строка добавлено в community.hashi_vault 3.2.0	URL-адрес ресурса приложения, зарегистрированного в Azure Active Directory. Обычно его не следует менять относительно значения по умолчанию. По умолчанию: `"https://management.azure.com/"`
azure_tenant_id строка добавлено в community.hashi_vault 3.2.0	Идентификатор клиента Azure Active Directory (также называемый идентификатором каталога) субъекта-службы. Должен быть UUID. Обязателен при аутентификации в Vault с помощью субъекта-службы, например, если заданы оба параметра azure_client_id и azure_client_secret. Необязателен при аутентификации в Vault с помощью управляемого удостоверения.
ca_cert псевдонимы: cacert строка	Путь к сертификату, используемому для аутентификации. Если не задано никаким другим способом, будет использоваться переменная окружения `VAULT_CACERT`.
cert_auth_private_key путь добавлено в community.hashi_vault 1.4.0	Для аутентификации `cert` — путь к файлу закрытого ключа в формате PEM, используемого для аутентификации.
cert_auth_public_key путь добавлено в community.hashi_vault 1.4.0	Для аутентификации `cert` — путь к файлу сертификата в формате PEM, используемого для аутентификации.
engine_mount_point строка	Путь, по которому подключён бэкенд секретов.
jwt строка	JSON Web Token (JWT), используемый для аутентификации в Vault с помощью JWT.
mount_point строка	Точка монтирования Vault. Если не задано, используется точка монтирования по умолчанию для указанного метода аутентификации. Не применяется для аутентификации по токену.
namespace строка	Пространство имён Vault, в котором находятся секреты. Для этого параметра требуются HVAC 0.7.0+ и Vault 0.11+. Это также можно сделать, добавив пространство имён в начало точки монтирования аутентификации и/или пути к секрету (например, `mynamespace/secret/mysecret`). Если задана переменная окружения `VAULT_NAMESPACE`, её значение будет иметь наивысший приоритет среди всех способов указания namespace.
password строка	Пароль для аутентификации.
proxies любой добавлено в community.hashi_vault 1.1.0	URL-адрес(а) прокси-серверов, используемых для доступа к службе Vault. Значением может быть строка или словарь. Если это словарь, укажите схему (например, `http` или `https`) в качестве ключа, а URL-адрес — в качестве значения. Если это строка, укажите один URL-адрес, который будет использоваться как прокси для схем `http` и `https`. Строка, которую можно интерпретировать как словарь, будет преобразована в словарь (см. примеры). Для ресурсов HTTP и HTTPS можно указать разные прокси-серверы. Если не задано, используются переменные окружения библиотеки Requests.
region строка	Регион AWS, для которого создаётся подключение.
retries любой добавлено в community.hashi_vault 1.3.0	Позволяет повторять запросы при ошибках на основе класса Retry библиотеки urllib3. В этой коллекции заданы рекомендуемые значения по умолчанию для повторных подключений к Vault. Значением этого параметра может быть положительное число (целое число) или словарь. Если этот параметр не задан или число равно `0`, повторные попытки отключены. Число задаёт общее количество повторных попыток; для остальных настроек используются значения по умолчанию коллекции. Значение-словарь используется напрямую для инициализации класса `Retry`, поэтому с его помощью можно полностью настроить повторные попытки. Подробные сведения о повторных попытках см. в руководстве пользователя коллекции.
retry_action строка добавлено в community.hashi_vault 1.3.0	Определяет, следует ли выводить сообщения при повторных попытках и каким образом. Не влияет на запросы, для которых повторные попытки не выполняются. Варианты: `"ignore"` `"warn"` ← (по умолчанию)
role_id строка	Идентификатор или имя роли Vault. Используется в методах аутентификации `approle`, `aws_iam`, `azure` и `cert`. Для аутентификации `cert`, если role_id не задан, по умолчанию выполняется попытка использовать все роли сертификатов и возвращается любая подходящая. Для аутентификации `azure` параметр role_id обязателен.
secret_id строка	Идентификатор секрета для аутентификации в Vault с помощью AppRole.
timeout целое число добавлено в community.hashi_vault 1.3.0	Задаёт время ожидания подключения в секундах. Если не задано, используется значение по умолчанию библиотеки `hvac`.
token строка	Токен Vault. Токен можно указать явно, с помощью перечисленных переменных [env], а также с помощью переменной окружения `VAULT_TOKEN`. Если токен не задан явно или через переменные окружения, плагин проверит наличие файла токена, путь к которому определяется параметрами token_path и token_file. Порядок загрузки токена (используется первый найденный): `token param -> ansible var -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> token file`.
token_file строка	Если токен не задан, будет предпринята попытка прочитать его из этого файла в token_path. По умолчанию: `".vault-token"`
token_path строка	Если токен не задан, будет предпринята попытка прочитать файл token_file по этому пути.
token_validate логическое значение добавлено в community.hashi_vault 0.2.0	При аутентификации по токену перед его использованием выполняется операция `lookup-self` для проверки его действительности. Отключите эту настройку, если у токена отсутствует возможность `lookup-self`. Варианты: `false` ← (по умолчанию) `true`
url строка	URL-адрес службы Vault. Если не задано никаким другим способом, будет использоваться значение переменной окружения `VAULT_ADDR`. Если `VAULT_ADDR` также не задана, будет вызвана ошибка.
username строка	Имя пользователя для аутентификации.
validate_certs логическое значение	Управляет проверкой и валидацией SSL-сертификатов; обычно отключать её следует только для самоподписанных сертификатов. Если задана переменная `VAULT_SKIP_VERIFY` и параметр validate_certs не указан явно, для него будет установлено значение, обратное значению переменной. Если не заданы ни validate_certs, ни `VAULT_SKIP_VERIFY`, по умолчанию используется `true`. Варианты: `false` `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.hashi_vault.vault	Используйте `group/community.hashi_vault.vault` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная Этот модуль работает в режиме «только чтение» и выполняет одни и те же действия независимо от режима проверки.	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.

Примечания

Примечание

Этот API возвращает элемент с именем keys.
В Ansible обращение к data.keys или raw.data.keys не сработает, поскольку объект dict содержит метод с именем keys.
Вместо этого используйте roles для доступа к списку ролей либо синтаксис data["keys"] или raw.data["keys"] для доступа к списку через элемент dict.

Примеры

- name: List all roles with the default mount point
  community.hashi_vault.vault_database_roles_list:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
  register: result

- name: Display the result of the operation
  ansible.builtin.debug:
    msg: "{{ result }}"

- name: List all roles with a custom mount point
  community.hashi_vault.vault_database_roles_list:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
    engine_mount_point: db1
  register: result

- name: Display the result of the operation
  ansible.builtin.debug:
    msg: "{{ result }}"

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

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

Ключ	Описание
data словарь	Поле `data` исходного результата. Также доступно через `raw.data`. Возвращается: при успешном выполнении Пример: `{"keys": ["dyn_role1", "dyn_role2", "dyn_role3"]}`
keys список / элементы=строки	Список имён динамических ролей. Возвращается: при успешном выполнении Пример: `["dyn_role1", "dyn_role2", "dyn_role3"]`
raw словарь	Исходный результат операции. Возвращается: при успешном выполнении Пример: `{"auth": null, "data": {"keys": ["dyn_role1", "dyn_role2", "dyn_role3"]}, "lease_duration\"": 0, "lease_id": "", "renewable": false, "request_id": "123456", "username": "SomeUser", "warnings": null, "wrap_info": null}`
data словарь	Поле data ответа API. Возвращается: при успешном выполнении
keys список / элементы=строки	Список имён динамических ролей. Возвращается: при успешном выполнении Пример: `["dyn_role1", "dyn_role2", "dyn_role3"]`
roles список / элементы=строки	Список динамических ролей или пустой список. Также доступно через `data.keys` или `raw.data.keys`. Возвращается: при успешном выполнении Пример: `["dyn_role1", "dyn_role2", "dyn_role3"]`

Авторы

Martin Chmielewski (@M4rt1nCh)

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

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