Модуль community.hashi_vault.vault_database_static_role_read – Запрос определения статической роли

Примечание

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

Добавлена в 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.
password string	Пароль аутентификации.

proxies any added in community.hashi_vault 1.1.0	URL(s) для прокси-серверов, используемых для доступа к службе Vault. Может быть строкой или словарем. Если это словарь, укажите схему (например, `http` или `https`) в качестве ключа и URL в качестве значения. Если это строка, укажите один URL, который будет использоваться в качестве прокси для схем `http` и `https`. Строка, которая может быть интерпретирована как словарь, будет преобразована в словарь (см. примеры). Можно указать разные прокси для HTTP и HTTPS ресурсов. Если не указано, используются переменные окружения из библиотеки Requests.
region string	Регион AWS, для которого необходимо создать соединение.
retries any added in community.hashi_vault 1.3.0	Позволяет повторять попытки при ошибках, на основе класса Retry в библиотеке urllib3. Эта коллекция определяет рекомендуемые значения по умолчанию для повторных попыток соединения с Vault. Этот параметр может быть задан как положительное число (целое число) или словарь. Если этот параметр не указан или число равно `0`, повторные попытки отключены. Число устанавливает общее количество повторных попыток и использует значения по умолчанию коллекции для других параметров. Значение словаря используется непосредственно для инициализации класса `Retry`, поэтому его можно использовать для полной настройки повторных попыток. Для подробной информации о повторных попытках см. руководство пользователя коллекции.
retry_action string added in community.hashi_vault 1.3.0	Управляет отображением сообщений о повторных попытках. Не оказывает влияния, если запрос не повторяется. Варианты: `"ignore"` `"warn"` ← (по умолчанию)
role_id string	ID роли или имя роли Vault. Используется в методах аутентификации `approle`, `aws_iam`, `azure` и `cert`. Для аутентификации `cert`, если role_id не указан, поведение по умолчанию заключается в попытке использования всех ролей сертификатов и возврате любой совпадающей. Для аутентификации `azure`, role_id обязателен.
role_name string / required	Имя роли, которое нужно считать из Hashicorp Vault.
secret_id string	Secret ID, который будет использоваться для аутентификации Vault AppRole.
timeout integer added in community.hashi_vault 1.3.0	Устанавливает таймаут соединения в секундах. Если не задано, используется значение по умолчанию библиотеки `hvac`.
token string	Токен Vault. Токен может быть указан явно, через перечисленные переменные [env], а также через переменную окружения `VAULT_TOKEN`. Если токен не указан явно или через env, плагин проверит наличие файла токена, как определено в token_path и token_file. Порядок загрузки токена (сначала найденный выигрывает) - `token param -> ansible var -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> token file`.
token_file string	Если токен не указан, попытается считать токен из этого файла в token_path. По умолчанию: `".vault-token"`
token_path string	Если токен не указан, попытается считать token_file из этого пути.
token_validate boolean added in community.hashi_vault 0.2.0	Для аутентификации токена выполнит операцию `lookup-self` для определения действительности токена перед его использованием. Отключите, если ваш токен не имеет возможности `lookup-self`. Варианты: `false` ← (по умолчанию) `true`
url string	URL службы Vault. Если не указано иным образом, будет использовано значение переменной окружения `VAULT_ADDR`. Если `VAULT_ADDR` также не определено, будет вызвана ошибка.
username string	Имя пользователя для аутентификации.
validate_certs boolean	Управляет проверкой и валидацией SSL-сертификатов, чаще всего отключается только для самоподписанных сертификатов. Будет заполнен обратным значением `VAULT_SKIP_VERIFY`, если оно установлено, и validate_certs не указан явно. Будет установлено значение по умолчанию `true`, если не установлены ни validate_certs, ни `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: Read Static Role with a 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: Read Static Role with a custom moint 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`. Возвращаемое значение: успех Пример: `{"credential_type": "password", "db_name": "SomeConnection", "last_vault_rotation\"": "2024-01-01T09:00:00 +01:00", "rotation_period\"": 86400, "rotation_statements\"": ["ALTER USER \"{{name}}\" WITH PASSWORD '{{password}}';"]}`
raw словарь	Сырой результат операции. Возвращаемое значение: успех Пример: `{"auth": null, "data": {"credential_type": "password", "db_name": "SomeConnection", "last_vault_rotation\"": "2024-01-01T09:00:00 +01:00", "rotation_period\"": 86400, "rotation_statements\"": ["ALTER USER \"{{name}}\" WITH PASSWORD '{{password}}';"]}, "lease_duration\"": 0, "lease_id": "", "renewable": false, "request_id": "123456", "username": "SomeUser", "warnings": null, "wrap_info": null}`
data словарь	Поле `data` сырого результата. К нему также можно получить доступ через `raw.data`. Возвращаемое значение: успех Пример: `{"credential_type": "password", "db_name": "SomeConnection", "last_vault_rotation\"": "2024-01-01T09:00:00 +01:00", "rotation_period\"": 86400, "rotation_statements\"": ["ALTER USER \"{{name}}\" WITH PASSWORD '{{password}}';"]}`

Авторы

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