Модуль community.hashi_vault.vault_database_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.

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

Пример: {"creation_statements": ["CREATE ROLE \"{{name}}\" WITH LOGIN PASSWORD '{{password}}' VALID UNTIL '{{expiration}}';", "GRANT SELECT ON ALL TABLES IN SCHEMA public TO \"{{name}}\";"], "credential_type": "password", "db_name": "database", "default_ttl": 3600, "max_ttl": 86400, "renew_statements": [], "revocation_statements": [], "rollback_statements": []}

raw

dictionary

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

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

Пример: {"auth": null, "data": {"creation_statements": ["CREATE ROLE \"{{name}}\" WITH LOGIN PASSWORD '{{password}}' VALID UNTIL '{{expiration}}';", "GRANT SELECT ON ALL TABLES IN SCHEMA public TO \"{{name}}\";"], "credential_type": "password", "db_name": "database", "default_ttl": 3600, "max_ttl": 86400, "renew_statements": [], "revocation_statements": [], "rollback_statements": []}, "lease_duration\"": 0, "lease_id": "", "renewable": false, "request_id": "123456", "username": "SomeUser", "warnings": null, "wrap_info": null}

data

dictionary

Поле data необработанного результата. Также доступно через raw.data.

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

Пример: {"creation_statements": ["CREATE ROLE \"{{name}}\" WITH LOGIN PASSWORD '{{password}}' VALID UNTIL '{{expiration}}';", "GRANT SELECT ON ALL TABLES IN SCHEMA public TO \"{{name}}\";"], "credential_type": "password", "db_name": "database", "default_ttl": 3600, "max_ttl": 86400, "renew_statements": [], "revocation_statements": [], "rollback_statements": []}