Модуль community.hashi_vault.vault_database_connections_list — возвращает список доступных подключений
Примечание
Этот модуль входит в коллекцию community.hashi_vault (версия 7.1.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install community.hashi_vault. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: community.hashi_vault.vault_database_connections_list.
Добавлено в community.hashi_vault 6.2.0
Краткое описание
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
-
hvac(библиотека Python) - Подробные сведения о требованиях см. на странице требований коллекции.
Параметры
Параметр | Описание |
|---|---|
auth_method string | Используемый метод аутентификации. Метод аутентификации Метод аутентификации
Метод аутентификации Метод аутентификации Варианты:
|
aws_access_key псевдонимы: aws_access_key_id string | Ключ доступа AWS для использования. |
aws_iam_server_id string добавлено в community.hashi_vault 0.2.0 | Если параметр задан, он устанавливает значение, используемое для заголовка |
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. Обычно его не следует изменять относительно значения по умолчанию. По умолчанию: |
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 | Путь к сертификату, используемому для аутентификации. Если не задан другим способом, будет использоваться переменная среды |
cert_auth_private_key path добавлено в community.hashi_vault 1.4.0 | Для аутентификации |
cert_auth_public_key path добавлено в community.hashi_vault 1.4.0 | Для аутентификации |
engine_mount_point string | Путь, по которому подключён бэкенд секретов. |
jwt string | JSON Web Token (JWT), используемый для аутентификации в Vault с помощью JWT. |
mount_point string | Точка монтирования Vault. Если не задана, используется точка монтирования по умолчанию для указанного метода аутентификации. Не применяется при аутентификации с помощью токена. |
namespace string | Пространство имён Vault, в котором находятся секреты. Для этого параметра требуются HVAC 0.7.0+ и Vault 0.11+. Кроме того, его можно задать, добавив пространство имён перед точкой монтирования аутентификации и/или путём секрета (например, Если задана переменная среды |
password string | Пароль для аутентификации. |
proxies any добавлено в community.hashi_vault 1.1.0 | URL-адреса прокси-серверов, используемых для доступа к службе Vault. Значение может быть строкой или словарём. Если задан словарь, укажите схему (например, Если задана строка, укажите один URL-адрес, который будет использоваться как прокси для схем Строка, которую можно интерпретировать как словарь, будет преобразована в словарь (см. примеры). Для ресурсов HTTP и HTTPS можно указать разные прокси-серверы. Если параметр не задан, используются переменные среды библиотеки Requests. |
region string | Регион AWS, для которого создаётся подключение. |
retries any добавлено в community.hashi_vault 1.3.0 | Позволяет повторять запросы при ошибках на основе класса Retry библиотеки urllib3. В этой коллекции заданы рекомендуемые значения по умолчанию для повторных подключений к Vault. Этот параметр можно указать в виде положительного числа (целого) или словаря. Если параметр не задан или его значение равно Число задаёт общее количество повторных попыток; для остальных параметров используются значения коллекции по умолчанию. Значение-словарь напрямую используется для инициализации класса Подробную информацию о повторных попытках см. в руководстве пользователя коллекции. |
retry_action string добавлено в community.hashi_vault 1.3.0 | Определяет, нужно ли выводить сообщения при повторных попытках и каким образом. Не влияет на запросы, которые не выполняются повторно. Варианты:
|
role_id string | Идентификатор или имя роли Vault. Используется для методов аутентификации При аутентификации При аутентификации |
secret_id string | Идентификатор секрета для аутентификации Vault AppRole. |
timeout integer добавлено в community.hashi_vault 1.3.0 | Задаёт время ожидания подключения в секундах. Если не задано, используется значение по умолчанию библиотеки |
token string | Токен Vault. Токен можно указать явно, через перечисленные переменные среды [env], а также через переменную среды Если токен не указан явно или через переменные среды, плагин проверит наличие файла токена, определяемого параметрами token_path и token_file. Порядок загрузки токена (используется первое найденное значение): |
token_file string | Если токен не задан, модуль попытается прочитать его из этого файла в token_path. По умолчанию: |
token_path string | Если токен не задан, модуль попытается прочитать файл token_file из этого пути. |
token_validate boolean добавлено в community.hashi_vault 0.2.0 | При аутентификации с помощью токена перед его использованием выполняется операция Отключите эту проверку, если у токена нет возможности Варианты:
|
url string | URL-адрес службы Vault. Если не задан другим способом, будет использоваться значение переменной среды Если |
username string | Имя пользователя для аутентификации. |
validate_certs boolean | Управляет проверкой и валидацией сертификатов SSL; обычно отключать проверку следует только для самоподписанных сертификатов. Если задана переменная Если не заданы ни validate_certs, ни Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
action_group | Группа действий: community.hashi_vault.vault | Используйте |
check_mode | Поддержка: полная Этот модуль предназначен только для чтения и работает одинаково независимо от режима проверки. | Может выполняться в режиме |
Примечания
Примечание
- Этот модуль всегда сообщает
changedкак False, поскольку выполняет операцию чтения и не изменяет данные. - Используйте
changed_whenдля управления этим поведением в случаях, когда известно, что операция не меняет состояние.
Примеры
- name: List Database Connections with the default mount point
community.hashi_vault.vault_database_connections_list:
url: https://vault:8201
auth_method: userpass
username: '{{ user }}'
password: '{{ passwd }}'
register: result
- name: Display the result of the operation
ansible.builtin.debug:
msg: "{{ result }}"
- name: List Database Connections with a custom mount point
community.hashi_vault.vault_database_connections_list:
url: https://vault:8201
auth_method: userpass
username: '{{ user }}'
password: '{{ passwd }}'
engine_mount_point: db1
register: result
- name: Display the result of the operation
ansible.builtin.debug:
msg: "{{ result }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; далее перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
connections список / элементы=строка | Список подключений к базам данных или пустой список. Также доступно через Возвращается: при успешном выполнении Пример: |
data словарь | Поле Возвращается: при успешном выполнении Пример: |
|
keys список / элементы=строка |
Список подключений к базам данных. Возвращается: при успешном выполнении Пример: |
raw словарь | Необработанный результат операции. Возвращается: при успешном выполнении Пример: |
|
data словарь |
Поле данных ответа API. Возвращается: при успешном выполнении |
|
keys список / элементы=строка |
Список подключений к базам данных. Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 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_database_connections_list_module.html