Модуль community.hashi_vault.vault_database_static_role_read — запрашивает определение статической роли

auth_method

string

Используемый метод аутентификации.

Метод аутентификации 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

string

Ключ доступа AWS для использования.

aws_iam_server_id

string

добавлено в community.hashi_vault 0.2.0

Если указано, задаёт значение заголовка X-Vault-AWS-IAM-Server-ID для запроса GetCallerIdentity.

aws_profile

псевдонимы: boto_profile

string

Профиль AWS

aws_secret_key

псевдонимы: aws_secret_access_key

string

Секретный ключ AWS, соответствующий ключу доступа.

aws_security_token

string

Токен безопасности AWS при использовании временных ключей доступа и секретных ключей.

azure_client_id

string

добавлено в community.hashi_vault 3.2.0

Идентификатор клиента (также известный как идентификатор приложения) субъекта-службы Azure AD или управляемого удостоверения. Должен быть UUID.

Если не указано, будет использоваться назначенное системой управляемое удостоверение.

azure_client_secret

string

добавлено в community.hashi_vault 3.2.0

Секрет клиента субъекта-службы Azure AD.

azure_resource

string

добавлено в community.hashi_vault 3.2.0

URL ресурса приложения, зарегистрированного в Azure Active Directory. Обычно не следует изменять значение по умолчанию.

По умолчанию: "https://management.azure.com/"

azure_tenant_id

string

добавлено в community.hashi_vault 3.2.0

Идентификатор клиента Azure Active Directory (также известный как идентификатор каталога) субъекта-службы. Должен быть UUID.

Обязателен при аутентификации в Vault с помощью субъекта-службы, например, когда указаны и azure_client_id, и azure_client_secret.

Необязателен при аутентификации в Vault с помощью управляемого удостоверения.

ca_cert

псевдонимы: cacert

string

Путь к сертификату, используемому для аутентификации.

Если значение не задано другим способом, будет использоваться переменная среды VAULT_CACERT.

cert_auth_private_key

path

добавлено в community.hashi_vault 1.4.0

Для аутентификации cert — путь к файлу закрытого ключа в формате PEM.

cert_auth_public_key

path

добавлено в community.hashi_vault 1.4.0

Для аутентификации cert — путь к файлу сертификата в формате PEM.

engine_mount_point

string

Путь, по которому подключён бэкенд секретов.

jwt

string

JSON Web Token (JWT), используемый для аутентификации в Vault с помощью JWT.

mount_point

string

Точка монтирования Vault.

Если не указана, используется точка монтирования по умолчанию для выбранного метода аутентификации.

Не применяется к аутентификации по токену.

namespace

string

Пространство имён Vault, в котором находятся секреты. Для этого параметра требуются HVAC версии 0.7.0 или выше и Vault версии 0.11 или выше.

Этого также можно добиться, добавив пространство имён в начало точки монтирования аутентификации и/или пути к секрету (например, mynamespace/secret/mysecret).

Если задана переменная среды VAULT_NAMESPACE, её значение будет иметь наивысший приоритет среди всех способов задать namespace.

password

string

Пароль для аутентификации.

proxies

any

добавлено в community.hashi_vault 1.1.0

URL прокси-серверов, используемых для доступа к службе Vault.

Значение может быть строкой или словарём.

Если указано значение типа «словарь», задайте схему (например, http или https) в качестве ключа, а URL — в качестве значения.

Если указана строка, задайте один URL, который будет использоваться в качестве прокси для схем http и https.

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

Можно указать разные прокси для ресурсов HTTP и HTTPS.

Если значение не указано, используются переменные среды библиотеки Requests.

region

string

Регион AWS, для которого создаётся подключение.

retries

any

добавлено в community.hashi_vault 1.3.0

Позволяет повторять запросы при ошибках на основе класса Retry библиотеки urllib3.

В этой коллекции заданы рекомендуемые значения по умолчанию для повторных подключений к Vault.

Для этого параметра можно указать положительное число (целое) или словарь.

Если параметр не указан или задано число 0, повторы отключены.

Число задаёт общее количество повторов; для остальных настроек используются значения коллекции по умолчанию.

Словарь напрямую используется для инициализации класса Retry, что позволяет полностью настроить повторы.

Подробные сведения о повторах см. в руководстве пользователя коллекции.

retry_action

string

добавлено в community.hashi_vault 1.3.0

Определяет, выводить ли сообщения о повторных попытках и как именно.

Не влияет на запросы, для которых повторные попытки не выполняются.

Варианты:

• "ignore"
• "warn" ← (по умолчанию)

role_id

string

Идентификатор или имя роли Vault. Используется в методах аутентификации approle, aws_iam, azure и cert.

При аутентификации cert, если role_id не задан, по умолчанию выполняется попытка использовать все роли сертификатов и возвращается любая подходящая роль.

При аутентификации azure параметр role_id обязателен.

role_name

string / обязательный

Имя роли, считываемой из Hashicorp Vault.

secret_id

string

Идентификатор секрета для аутентификации в Vault с помощью AppRole.

timeout

integer

добавлено в community.hashi_vault 1.3.0

Задаёт время ожидания подключения в секундах.

Если значение не задано, используется значение по умолчанию библиотеки hvac.

token

string

Токен Vault. Токен можно указать явно, с помощью перечисленных переменных среды [env], а также с помощью переменной среды VAULT_TOKEN.

Если токен не задан ни явно, ни через переменные среды, плагин проверит наличие файла токена, заданного параметрами 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

добавлено в 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 не указан явно, параметру будет присвоено противоположное значение.

Если не заданы ни 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 и возвращать прогноз изменения состояния, не изменяя целевой объект.

data

dictionary

Поле 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

dictionary

Необработанный результат операции.

Возвращается: при успехе

Пример: {"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

dictionary

Поле 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}}';"]}