Модуль community.hashi_vault.vault_database_static_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_static_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 static roles with the default mount point
  community.hashi_vault.vault_database_static_roles_list:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
  register: response

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

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

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

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

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

Ключ	Описание
data dictionary	Поле `data` исходного результата. К нему также можно обратиться через `raw.data`. Возвращается: success Пример: `{"keys": ["role1", "role2", "role3"]}`
keys list / elements=string	Список имен ролей. Возвращается: success Пример: `["role1", "role2", "role3"]`
raw dictionary	Необработанный результат операции. Возвращается: success Пример: `{"auth": null, "data": {"keys": ["role1", "role2", "role3"]}, "lease_duration\"": 0, "lease_id": "", "renewable": false, "request_id": "123456", "username": "SomeUser", "warnings": null, "wrap_info": null}`
data dictionary	Поле data ответа API. Возвращается: success
keys list / elements=string	Список имен ролей. Возвращается: success Пример: `["role1", "role2", "role3"]`
roles list / elements=string	Список ролей или пустой список. К нему также можно обратиться через `data.keys` или `raw.data.keys`. Возвращается: success Пример: `["role1", "role2", "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_static_roles_list_module.html