Модуль community.hashi_vault.vault_login — выполнение операции входа в HashiCorp Vault

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

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

Может выполняться в режиме check_mode и возвращать прогноз изменения состояния без внесения изменений в целевую систему.

login

dictionary

Результат входа с использованием указанного метода аутентификации.

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

auth

dictionary

Поле auth ответа на вход.

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

client_token

string

Содержит токен, предоставленный операцией входа (или входной токен, если auth_method=token).

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

data

dictionary

Поле data ответа на вход.

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