Модуль community.hashi_vault.vault_database_static_role_get_credentials — возвращает текущие учетные данные на основе указанной статической роли

Примечание

Этот модуль входит в коллекцию 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_role_get_credentials.

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

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

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

Возвращает текущие учетные данные указанной статической роли, идентифицируемой по role_name.

Требования

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

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 обязателен.
role_name строка / обязательный	Имя роли, из которой необходимо получить учетные данные.
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` и возвращать прогноз изменения состояния, не изменяя целевой узел.

Примечания

Примечание

Этот модуль всегда сообщает changed как False, поскольку выполняет операцию чтения, не изменяющую данные.
Используйте changed_when для управления этим поведением в случаях, когда известно, что операция не изменяет состояние.

Примеры

- name: Returns the current credentials based on the named static role with the default mount point
  community.hashi_vault.vault_database_static_role_read:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
    role_name: SomeRole
  register: result

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

- name: Returns the current credentials based on the named static role with a custom mount point
  community.hashi_vault.vault_database_static_role_read:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
    engine_mount_point: db1
    role_name: SomeRole
  register: result

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

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

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

Ключ	Описание
data словарь	Поле `data` необработанного результата. К нему также можно обратиться через `raw.data`. Возвращается: при успешном выполнении Пример: `{"last_vault_rotation\"": "2024-01-01T09:00:00+01:00", "password\"": "Th3_$3cr3t_P@ss!", "rotation_period\"": 86400, "ttl\"": 123456, "username": "SomeUser"}`
raw словарь	Необработанный результат операции. Возвращается: при успешном выполнении Пример: `{"auth": "null,", "data": {"last_vault_rotation\"": "2024-01-01T09:00:00+01:00", "password\"": "Th3_$3cr3t_P@ss!", "rotation_period\"": 86400, "ttl\"": 123456, "username": "SomeUser"}, "lease_duration": 0, "lease_id": "", "renewable": false, "request_id": "123456", "warnings": "null,", "wrap_info": null}`
data словарь	Поле `data` необработанного результата. К нему также можно обратиться через `raw.data`. Возвращается: при успешном выполнении Пример: `{"last_vault_rotation\"": "2024-01-01T09:00:00+01:00", "password\"": "Th3_$3cr3t_P@ss!", "rotation_period\"": 86400, "ttl\"": 123456, "username": "SomeUser"}`

Авторы

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_role_get_credentials_module.html