Модуль community.hashi_vault.vault_database_connection_read — возвращает параметры конфигурации для connection_name

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, используемого для аутентификации.

connection_name

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

Имя подключения для чтения.

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 обязателен.

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. К нему также можно обратиться через raw.data.

Возвращается: при успешном выполнении

Пример: {"allowed_roles": [], "connection_details": {"connection_url": "postgresql://{{username}}:{{password}}@postgres:5432/postgres?sslmode=disable", "username": "UserName"}, "password_policy\"": "", "plugin_name\"": "postgresql-database-plugin", "plugin_version\"": "", "root_credentials_rotate_statements\"": []}

raw

dictionary

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

Возвращается: при успешном выполнении

Пример: {"auth": "null,", "data": {"allowed_roles": [], "connection_details": {"connection_url": "postgresql://{{username}}:{{password}}@postgres:5432/postgres?sslmode=disable", "username": "UserName"}, "password_policy\"": "", "plugin_name\"": "postgresql-database-plugin", "plugin_version\"": "", "root_credentials_rotate_statements\"": []}}

data

dictionary

Поле data результата raw. К нему также можно обратиться через raw.data.

Возвращается: при успешном выполнении

Пример: {"allowed_roles": [], "connection_details": {"connection_url": "postgresql://{{username}}:{{password}}@postgres:5432/postgres?sslmode=disable", "username": "UserName"}, "password_policy\"": "", "plugin_name\"": "postgresql-database-plugin", "plugin_version\"": "", "root_credentials_rotate_statements\"": []}