Модуль community.hashi_vault.vault_kv2_write — Выполнение операции записи секрета KVv2 в 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.

cas

integer

Выполнить операцию проверки и установки.

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

data

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

Данные секрета KVv2 для записи.

engine_mount_point

string

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

По умолчанию: "secret"

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

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

path

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

Путь Vault KVv2, в который выполняется запись.

Путь указывается относительно engine_mount_point, поэтому путь монтирования включать не нужно.

proxies

any

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

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

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

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

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

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

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

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

read_before_write

boolean

Сначала прочитать секрет и записывать его, только если data отличается от прочитанных данных.

Если true, для секрета требуется разрешение read.

Если false, этот модуль всегда будет выполнять запись в path, если не включён режим проверки.

Варианты:

• false ← (по умолчанию)
• true

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

Поддержка: частичная

Если read_before_write имеет значение true, поддерживается полная функциональность режима проверки.

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

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

raw

dictionary

Необработанный ответ Vault.

Возвращается: changed

Пример: {"auth": null, "data": {"created_time": "2023-02-21T19:51:50.801757862Z", "custom_metadata": null, "deletion_time": "", "destroyed": false, "version": 1}, "lease_duration": 0, "lease_id": "", "renewable": false, "request_id": "52eb1aa7-5a38-9a02-9246-efc5bf9581ec", "warnings": null, "wrap_info": null}