Модуль community.hashi_vault.vault_kv1_get — получение секрета из хранилища секретов KV версии 1 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, используемого для аутентификации.

engine_mount_point

string

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

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

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 / обязательный

Путь KV Vault для чтения.

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

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.data.

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

Пример: {"Key1": "value1", "Key2": "value2"}

metadata

dictionary

Это синтетический результат. Он совпадает с raw, из которого удалено data.

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

Пример: {"auth": null, "lease_duration": 2764800, "lease_id": "", "renewable": false, "request_id": "e99f145f-f02a-7073-1229-e3f191057a70", "warnings": null, "wrap_info": null}

raw

dictionary

Исходный результат чтения по указанному пути.

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

Пример: {"auth": null, "data": {"Key1": "value1", "Key2": "value2"}, "lease_duration": 2764800, "lease_id": "", "renewable": false, "request_id": "e99f145f-f02a-7073-1229-e3f191057a70", "warnings": null, "wrap_info": null}

secret

dictionary

Поле data исходного результата. Оно идентично data в возвращаемых значениях.

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

Пример: {"Key1": "value1", "Key2": "value2"}