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

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

добавлено в 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

добавлено в 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

aliases: 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), который будет использоваться для 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

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

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

Для аутентификации azure, role_id обязателен.

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