подстановка community.hashi_vault.vault_login — выполнение операции входа в HashiCorp Vault

Примечание

Этот модуль подстановки входит в коллекцию community.hashi_vault (версия 7.1.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.hashi_vault. Для работы с этим модулем подстановки требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: community.hashi_vault.vault_login.

Добавлено в community.hashi_vault 2.2.0

Краткое описание
Требования
Аргументы
Параметры ключевых слов
Примечания
См. также
Примеры
Возвращаемое значение

Краткое описание

Выполняет операцию входа по указанному пути в HashiCorp Vault и возвращает ответ на вход, включая токен.

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

hvac (библиотека Python)
Подробные сведения о требованиях см. на странице требований к коллекции.

Аргументы

Параметр	Комментарии
Аргументы строка	Этот параметр не используется, и любые переданные аргументы будут проигнорированы.

Параметры ключевых слов

В этом разделе описаны параметры ключевых слов подстановки. В следующих примерах это значения key1=value1, key2=value2 и т. д.: lookup('community.hashi_vault.vault_login', key1=value1, key2=value2, ...) и query('community.hashi_vault.vault_login', key1=value1, key2=value2, ...)

Параметр	Комментарии
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"` Конфигурация: Запись INI: [hashi_vault_collection] auth_method = token добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_AUTH_METHOD` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_auth_method добавлено в community.hashi_vault 1.2.0
aws_access_key псевдонимы: aws_access_key_id string	Ключ доступа AWS. Конфигурация: Переменная окружения: `EC2_ACCESS_KEY` Переменная окружения: `AWS_ACCESS_KEY` Переменная окружения: `AWS_ACCESS_KEY_ID`
aws_iam_server_id string добавлено в community.hashi_vault 0.2.0	Если указано, задаёт значение заголовка `X-Vault-AWS-IAM-Server-ID` для запроса `GetCallerIdentity`. Конфигурация: Запись INI: [hashi_vault_collection] aws_iam_server_id = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_AWS_IAM_SERVER_ID`
aws_profile псевдонимы: boto_profile string	Профиль AWS Конфигурация: Переменная окружения: `AWS_DEFAULT_PROFILE` Переменная окружения: `AWS_PROFILE`
aws_secret_key псевдонимы: aws_secret_access_key string	Секретный ключ AWS, соответствующий ключу доступа. Конфигурация: Переменная окружения: `EC2_SECRET_KEY` Переменная окружения: `AWS_SECRET_KEY` Переменная окружения: `AWS_SECRET_ACCESS_KEY`
aws_security_token string	Токен безопасности AWS при использовании временных ключей доступа и секретных ключей. Конфигурация: Переменная окружения: `EC2_SECURITY_TOKEN` Переменная окружения: `AWS_SESSION_TOKEN` Переменная окружения: `AWS_SECURITY_TOKEN`
azure_client_id string добавлено в community.hashi_vault 3.2.0	Идентификатор клиента (также известный как идентификатор приложения) субъекта-службы Azure AD или управляемого удостоверения. Должен быть UUID. Если не указано, будет использоваться управляемое удостоверение, назначенное системой. Конфигурация: Запись INI: [hashi_vault_collection] azure_client_id = VALUE Переменная окружения: `ANSIBLE_HASHI_VAULT_AZURE_CLIENT_ID` Переменная: ansible_hashi_vault_azure_client_id
azure_client_secret string добавлено в community.hashi_vault 3.2.0	Секрет клиента субъекта-службы Azure AD. Конфигурация: Переменная окружения: `ANSIBLE_HASHI_VAULT_AZURE_CLIENT_SECRET` Переменная: ansible_hashi_vault_azure_client_secret
azure_resource string добавлено в community.hashi_vault 3.2.0	URL ресурса приложения, зарегистрированного в Azure Active Directory. Обычно не следует менять значение по умолчанию. По умолчанию: `"https://management.azure.com/"` Конфигурация: Запись INI: [hashi_vault_collection] azure_resource = https://management.azure.com/ Переменная окружения: `ANSIBLE_HASHI_VAULT_AZURE_RESOURCE` Переменная: ansible_hashi_vault_azure_resource
azure_tenant_id string добавлено в community.hashi_vault 3.2.0	Идентификатор клиента Azure Active Directory (также известный как идентификатор каталога) субъекта-службы. Должен быть UUID. Обязателен при аутентификации в Vault с помощью субъекта-службы, например, когда указаны оба параметра azure_client_id и azure_client_secret. Необязателен при аутентификации в Vault с помощью управляемого удостоверения. Конфигурация: Запись INI: [hashi_vault_collection] azure_tenant_id = VALUE Переменная окружения: `ANSIBLE_HASHI_VAULT_AZURE_TENANT_ID` Переменная: ansible_hashi_vault_azure_tenant_id
ca_cert псевдонимы: cacert string	Путь к сертификату, используемому для аутентификации. Если значение не указано иным способом, будет использоваться переменная окружения `VAULT_CACERT`. Конфигурация: Запись INI: [hashi_vault_collection] ca_cert = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_CA_CERT` добавлено в community.hashi_vault 1.2.0 Переменная: ansible_hashi_vault_ca_cert добавлено в community.hashi_vault 1.2.0
cert_auth_private_key path добавлено в community.hashi_vault 1.4.0	Для аутентификации `cert` укажите путь к файлу закрытого ключа в формате PEM. Конфигурация: Запись INI: [hashi_vault_collection] cert_auth_private_key = VALUE Переменная окружения: `ANSIBLE_HASHI_VAULT_CERT_AUTH_PRIVATE_KEY` Переменная: ansible_hashi_vault_cert_auth_private_key добавлено в community.hashi_vault 6.2.0
cert_auth_public_key path добавлено в community.hashi_vault 1.4.0	Для аутентификации `cert` укажите путь к файлу сертификата в формате PEM. Конфигурация: Запись INI: [hashi_vault_collection] cert_auth_public_key = VALUE Переменная окружения: `ANSIBLE_HASHI_VAULT_CERT_AUTH_PUBLIC_KEY` Переменная: ansible_hashi_vault_cert_auth_public_key добавлено в community.hashi_vault 6.2.0
jwt string	JSON Web Token (JWT), используемый для JWT-аутентификации в Vault. Конфигурация: Переменная окружения: `ANSIBLE_HASHI_VAULT_JWT`
mount_point string	Точка монтирования Vault. Если не указана, используется точка монтирования по умолчанию для данного метода аутентификации. Не применяется для аутентификации по токену. Конфигурация: Запись INI: [hashi_vault_collection] mount_point = VALUE добавлено в community.hashi_vault 1.5.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_MOUNT_POINT` добавлено в community.hashi_vault 1.5.0 Переменная: ansible_hashi_vault_mount_point добавлено в community.hashi_vault 1.5.0
namespace string	Пространство имён Vault, в котором находятся секреты. Для этого параметра требуются HVAC 0.7.0+ и Vault 0.11+. Также этого можно добиться, добавив пространство имён в начало точки монтирования аутентификации и/или пути к секрету (например, `mynamespace/secret/mysecret`). Если задана переменная окружения `VAULT_NAMESPACE`, её значение будет иметь наивысший приоритет среди всех способов указания namespace. Конфигурация: Запись INI: [hashi_vault_collection] namespace = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_NAMESPACE` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_namespace добавлено в community.hashi_vault 1.2.0
password string	Пароль для аутентификации. Конфигурация: Переменная окружения: `ANSIBLE_HASHI_VAULT_PASSWORD` добавлено в community.hashi_vault 1.2.0 Переменная: ansible_hashi_vault_password добавлено в community.hashi_vault 1.2.0
proxies any добавлено в community.hashi_vault 1.1.0	URL-адреса прокси-серверов, используемых для доступа к службе Vault. Значением может быть строка или словарь. Если это словарь, укажите схему (например, `http` или `https`) в качестве ключа, а URL-адрес — в качестве значения. Если это строка, укажите один URL-адрес, который будет использоваться как прокси для схем `http` и `https`. Строка, которую можно интерпретировать как словарь, будет преобразована в словарь (см. примеры). Можно указать разные прокси для ресурсов HTTP и HTTPS. Если значение не указано, используются переменные окружения библиотеки Requests. Конфигурация: Запись INI: [hashi_vault_collection] proxies = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_PROXIES` Переменная: ansible_hashi_vault_proxies добавлено в community.hashi_vault 1.2.0
region string	Регион AWS, для которого создаётся подключение. Конфигурация: Переменная окружения: `EC2_REGION` Переменная окружения: `AWS_REGION`
retries any добавлено в community.hashi_vault 1.3.0	Позволяет повторять попытки при ошибках на основе класса Retry библиотеки urllib3. В этой коллекции заданы рекомендуемые значения по умолчанию для повторных подключений к Vault. Значением параметра может быть положительное число (целое) или словарь. Если параметр не задан или число равно `0`, повторные попытки отключены. Число задаёт общее количество повторных попыток; для остальных параметров используются значения коллекции по умолчанию. Значение-словарь напрямую используется для инициализации класса `Retry`, что позволяет полностью настроить повторные попытки. Подробные сведения о повторных попытках см. в руководстве пользователя коллекции. Конфигурация: Запись INI: [hashi_vault_collection] retries = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_RETRIES` Переменная: ansible_hashi_vault_retries
retry_action string добавлено в community.hashi_vault 1.3.0	Управляет тем, следует ли выводить сообщения при повторных попытках и каким образом. Не действует, если повторный запрос не выполняется. Варианты: `"ignore"` `"warn"` ← (по умолчанию) Конфигурация: Запись INI: [hashi_vault_collection] retry_action = warn добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_RETRY_ACTION` Переменная: ansible_hashi_vault_retry_action
role_id string	Идентификатор или имя роли Vault. Используется в методах аутентификации `approle`, `aws_iam`, `azure` и `cert`. Для аутентификации `cert`, если role_id не задан, по умолчанию выполняется попытка использовать все роли сертификатов и возвращается любая подходящая роль. Для аутентификации `azure` параметр role_id обязателен. Конфигурация: Запись INI: [hashi_vault_collection] role_id = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_ROLE_ID` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_role_id добавлено в community.hashi_vault 1.2.0
secret_id string	Идентификатор секрета для аутентификации в Vault с помощью AppRole. Конфигурация: Переменная окружения: `ANSIBLE_HASHI_VAULT_SECRET_ID` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_secret_id добавлено в community.hashi_vault 1.2.0
timeout integer добавлено в community.hashi_vault 1.3.0	Задаёт время ожидания подключения в секундах. Если значение не задано, используется значение по умолчанию библиотеки `hvac`. Конфигурация: Запись INI: [hashi_vault_collection] timeout = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_TIMEOUT` Переменная: ansible_hashi_vault_timeout
token string	Токен Vault. Токен можно указать явно, с помощью перечисленных переменных [env], а также через переменную окружения `VAULT_TOKEN`. Если токен не задан явно или через переменные окружения, плагин проверит наличие файла токена, заданного параметрами token_path и token_file. Порядок загрузки токена (используется первое найденное значение): `token param -> ansible var -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> token file`. Конфигурация: Переменная окружения: `ANSIBLE_HASHI_VAULT_TOKEN` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_token добавлено в community.hashi_vault 1.2.0
token_file string	Если токен не указан, будет предпринята попытка прочитать его из этого файла в token_path. По умолчанию: `".vault-token"` Конфигурация: Запись INI: [hashi_vault_collection] token_file = .vault-token добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_TOKEN_FILE` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_token_file добавлено в community.hashi_vault 1.2.0

token_path string	Если токен не указан, будет предпринята попытка прочитать token_file по этому пути. Конфигурация: Запись INI: [hashi_vault_collection] token_path = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_TOKEN_PATH` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_token_path добавлено в community.hashi_vault 1.2.0
token_validate boolean добавлено в community.hashi_vault 0.2.0	При аутентификации по токену перед его использованием будет выполнена операция `lookup-self`, чтобы определить, действителен ли токен. Отключите эту опцию, если у токена нет возможности `lookup-self`. Варианты: `false` `true` ← (по умолчанию) Конфигурация: Запись INI: [hashi_vault_collection] token_validate = true добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_TOKEN_VALIDATE` Переменная: ansible_hashi_vault_token_validate добавлено в community.hashi_vault 1.2.0
url string	URL сервиса Vault. Если значение не задано другим способом, будет использовано значение переменной окружения `VAULT_ADDR`. Если `VAULT_ADDR` также не определена, будет выдана ошибка. Конфигурация: Запись INI: [hashi_vault_collection] url = VALUE добавлено в community.hashi_vault 1.4.0 Переменная окружения: `ANSIBLE_HASHI_VAULT_ADDR` добавлено в community.hashi_vault 0.2.0 Переменная: ansible_hashi_vault_url добавлено в community.hashi_vault 1.2.0 Переменная: ansible_hashi_vault_addr добавлено в community.hashi_vault 1.2.0
username string	Имя пользователя для аутентификации. Конфигурация: Переменная окружения: `ANSIBLE_HASHI_VAULT_USERNAME` добавлено в community.hashi_vault 1.2.0 Переменная: ansible_hashi_vault_username добавлено в community.hashi_vault 1.2.0
validate_certs boolean	Управляет проверкой и подтверждением подлинности SSL-сертификатов; обычно отключать эту настройку следует только для самоподписанных сертификатов. Если задано `VAULT_SKIP_VERIFY`, значением будет противоположное значение, если validate_certs не задан явно. Если не заданы ни validate_certs, ни `VAULT_SKIP_VERIFY`, по умолчанию используется `true`. Варианты: `false` `true` Конфигурация: Переменная: ansible_hashi_vault_validate_certs добавлено в community.hashi_vault 1.2.0

Примечание

Перечисленные выше записи конфигурации для каждого типа записи (переменная Ansible, переменная окружения и т. д.) упорядочены от низкого к высокому приоритету. Например, переменная, расположенная ниже в списке, переопределит переменную, расположенную выше. Типы записей также упорядочены по приоритету от низкого к высокому. Например, запись ansible.cfg (расположенная выше в списке) переопределяется переменной Ansible (расположенной ниже в списке).

Примечания

Примечание

При совместном использовании именованных и позиционных параметров позиционные параметры необходимо указывать перед именованными: lookup('community.hashi_vault.vault_login', term1, term2, key1=value1, key2=value2) и query('community.hashi_vault.vault_login', term1, term2, key1=value1, key2=value2)
Этот lookup не использует тип string и некорректно работает в циклах. Возвращается только один ответ.
Вход в систему — это операция записи (создание токена, сохранённого в хранилище), поэтому этот модуль всегда сообщает changed=True, за исключением случаев использования аутентификации token, поскольку в этом случае новый токен не создаётся. Однако в сценариях Ansible может быть полезнее задать changed_when=false, если вы проверяете идемпотентность целевой системы.
Метод аутентификации none недопустим для этого плагина, поскольку возвращать нечего.
При аутентификации token фактический вход в систему не выполняется. Вместо этого дополнительная информация о переданном токене возвращается в структуре, похожей на ответы при входе в систему.
Метод аутентификации token возвращает полную информацию, только если token_validate=True. Если у токена нет возможности lookup-self, операция завершится ошибкой. Если token_validate=False, в структуре будет возвращено только значение самого токена.

См. также

community.hashi_vault.vault_login: Выполняет операцию входа в HashiCorp Vault.
Фильтр community.hashi_vault.vault_login_token: Официальная документация по плагину фильтра community.hashi_vault.vault_login_token.

Примеры

- name: Set a fact with a lookup result
  set_fact:
    login_data: "{{ lookup('community.hashi_vault.vault_login', url='https://vault', auth_method='userpass', username=user, password=pwd) }}"

- name: Retrieve an approle role ID (token via filter)
  community.hashi_vault.vault_read:
    url: https://vault:8201
    auth_method: token
    token: '{{ login_data | community.hashi_vault.vault_login_token }}'
    path: auth/approle/role/role-name/role-id
  register: approle_id

- name: Retrieve an approle role ID (token via direct dict access)
  community.hashi_vault.vault_read:
    url: https://vault:8201
    auth_method: token
    token: '{{ login_data.auth.client_token }}'
    path: auth/approle/role/role-name/role-id
  register: approle_id

- name: Login with GCP auth
  set_fact:
    gcp_login: "{{ lookup('community.hashi_vault.vault_login', auth_method='gcp', role_id='myroleid', jwt='myjwt', url='https://vault:8200') }}"

- name: Read a secret using the GCP login token
  community.hashi_vault.vault_read:
    url: https://vault:8200
    token: '{{ gcp_login.auth.client_token }}'
    path: secret/data/foo

Возвращаемое значение

Ключ	Описание
Возвращаемое значение list / elements=dictionary	Результат входа с использованием указанного метода аутентификации. Возвращается: успешно
auth dictionary	Элемент `auth` ответа при входе в систему. Возвращается: успешно
client_token string	Содержит токен, предоставленный операцией входа в систему (или входной токен, если auth_method=token). Возвращается: успешно
data dictionary	Элемент `data` ответа при входе в систему. Возвращается: успешно, если доступно

Авторы

Brian Scholer (@briantist)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/hashi_vault/vault_login_lookup.html