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

Примечание

Этот модуль входит в коллекцию community.hashi_vault (версия 6.2.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 string	Метод аутентификации, который будет использоваться. `none` auth method was added in collection version `1.2.0`. `cert` auth method was added in collection version `1.4.0`. `aws_iam_login` was renamed `aws_iam` in collection version `2.1.0` and was removed in `3.0.0`. `azure` auth method was added in collection version `3.2.0`. Варианты: `"token"` ← (default) `"userpass"` `"ldap"` `"approle"` `"aws_iam"` `"azure"` `"jwt"` `"cert"` `"none"`
aws_access_key aliases: aws_access_key_id string	Ключ доступа AWS для использования.
aws_iam_server_id string added in community.hashi_vault 0.2.0	Если указано, устанавливает значение для использования для заголовка `X-Vault-AWS-IAM-Server-ID` в рамках запроса `GetCallerIdentity`.
aws_profile aliases: boto_profile string	Профиль AWS
aws_secret_key aliases: aws_secret_access_key string	Секретный ключ AWS, соответствующий ключу доступа.
aws_security_token string	Маркер безопасности AWS, если используются временные ключи доступа и секретные ключи.
azure_client_id string added in community.hashi_vault 3.2.0	Идентификатор клиента (также известный как идентификатор приложения) субъекта безопасности Azure AD или управляемой идентичности. Должен быть UUID. Если не указано, будет использоваться назначенная системой управляемая идентичность.
azure_client_secret string added in community.hashi_vault 3.2.0	Секретный ключ клиента субъекта безопасности Azure AD.
azure_resource string added in community.hashi_vault 3.2.0	URL-адрес ресурса для приложения, зарегистрированного в Azure Active Directory. Обычно не следует изменять значение по умолчанию. Значение по умолчанию: `"https://management.azure.com/"`
azure_tenant_id string added in community.hashi_vault 3.2.0	Идентификатор клиента Azure Active Directory (также известный как идентификатор каталога) субъекта безопасности. Должен быть UUID. Требуется при использовании субъекта безопасности для аутентификации в Vault, например, требуется, когда указаны как azure_client_id, так и azure_client_secret. Необязательно при использовании управляемой идентичности для аутентификации в Vault.
ca_cert aliases: cacert string	Путь к сертификату, который будет использоваться для аутентификации. Если не указано иным способом, будет использоваться переменная окружения `VAULT_CACERT`.
cert_auth_private_key path added in community.hashi_vault 1.4.0	Для аутентификации `cert`, путь к файлу с закрытым ключом для аутентификации в формате PEM.
cert_auth_public_key path added in community.hashi_vault 1.4.0	Для аутентификации `cert`, путь к файлу с сертификатом для аутентификации в формате PEM.
engine_mount_point string	Путь, куда подключен бэкэнд секретов.
jwt string	JSON Web Token (JWT), который будет использоваться для JWT-аутентификации в Vault.
mount_point string	Точка монтирования Vault. Если не указано, используется точка монтирования по умолчанию для данного метода аутентификации. Не применяется к токенной аутентификации.
namespace string	Пространство имен Vault, где находятся секреты. Эта опция требует HVAC 0.7.0+ и Vault 0.11+. Дополнительно, это можно сделать, добавив префикс к точке монтирования аутентификации и/или пути к секрету с пространством имен (например, `mynamespace/secret/mysecret`). Если установлена переменная окружения `VAULT_NAMESPACE`, ее значение будет использоваться в последнюю очередь среди всех способов указания namespace.

пароль строка	Пароль для аутентификации.
прокси любой добавлен в community.hashi_vault 1.1.0	URL(ы) прокси-серверов, используемых для доступа к службе Vault. Может быть строкой или словарем. Если это словарь, укажите схему (например, `http` или `https`) в качестве ключа, а URL — в качестве значения. Если это строка, укажите один URL, который будет использоваться в качестве прокси для схем `http` и `https`. Строка, которую можно интерпретировать как словарь, будет преобразована в него (см. примеры). Вы можете указать разные прокси для HTTP и HTTPS ресурсов. Если не указано, используются переменные среды из библиотеки Requests https://requests.readthedocs.io/en/master/user/advanced/#proxies.
регион строка	Регион AWS для создания подключения.
повторные попытки любой добавлен в community.hashi_vault 1.3.0	Позволяет повторять попытки при ошибках, основываясь на классе Retry в библиотеке urllib3. Данный набор предоставляет рекомендуемые значения по умолчанию для повторных попыток подключений к Vault. Этот параметр может быть указан как положительное число (целое число) или словарь. Если этот параметр не указан или число равно `0`, повторные попытки отключены. Число задаёт общее количество повторных попыток и использует значения по умолчанию из набора для других настроек. Значение словаря используется непосредственно для инициализации класса `Retry`, поэтому его можно использовать для полной настройки повторных попыток. Подробная информация о повторных попытках содержится в руководстве пользователя набора.
действие_повторной_попытки строка добавлен в community.hashi_vault 1.3.0	Управляет отображением сообщений при повторных попытках. Это не влияет, если запрос не повторяется. Варианты: `"ignore"` `"warn"` ← (по умолчанию)
идентификатор_роли строка	Идентификатор или имя роли Vault. Используется в `approle`, `aws_iam`, `azure` и `cert` методах аутентификации. Для аутентификации `cert`, если идентификатор_роли не указан, по умолчанию пробуются все роли с сертификатами и возвращается любая соответствующая. Для аутентификации `azure` идентификатор_роли обязателен.
имя_роли строка / обязательно	Имя роли, из которой необходимо получить данные учетных данных.
идентификатор_секрета строка	Идентификатор секрета, используемый для аутентификации Vault AppRole.
таймаут целое число добавлен в community.hashi_vault 1.3.0	Устанавливает таймаут соединения в секундах. Если не указано, используется значение по умолчанию библиотеки `hvac`.
токен строка	Токен Vault. Токен может быть указан явно, через перечисленные переменные [env] и также через переменную среды `VAULT_TOKEN`. Если токен не указан явно или через переменные среды, плагин проверит файл токена по заданному пути token_path и token_file. Порядок загрузки токенов (первый найденный — используется) `token param -> ansible var -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> token file`.
файл_токена строка	Если токен не указан, токен будет пытаться прочитать из этого файла в token_path. По умолчанию: `".vault-token"`
путь_к_токенам строка	Если токен не указан, будет пытаться прочитать файл_токена из этого пути.
проверка_токена логическое добавлен в community.hashi_vault 0.2.0	Для аутентификации по токену будет выполнена операция `lookup-self`, чтобы определить валидность токена перед его использованием. Отключите, если ваш токен не имеет возможности `lookup-self`. Варианты: `false` ← (по умолчанию) `true`
url строка	URL службы Vault. Если не указан другими способами, используется значение переменной среды `VAULT_ADDR`. Если `VAULT_ADDR` также не определен, произойдёт ошибка.
имя_пользователя строка	Имя пользователя для аутентификации.
проверять_сертификаты логическое	Управляет проверкой и валидацией SSL-сертификатов, в основном, нужно отключать только при самоподписанных сертификатах. Будет заполнен обратным значением `VAULT_SKIP_VERIFY`, если он задан, и проверять_сертификаты явно не указан. Будет по умолчанию `true`, если ни проверять_сертификаты, ни `VAULT_SKIP_VERIFY` не заданы. Варианты: `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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/hashi_vault/vault_database_static_role_get_credentials_module.html