Модуль community.hashi_vault.vault_database_connection_reset — закрывает connection_name и связанный с ним плагин, а затем перезапускает его с сохранённой конфигурацией
Примечание
Этот модуль входит в коллекцию community.hashi_vault (версия 7.1.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.hashi_vault. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в playbook, укажите: community.hashi_vault.vault_database_connection_reset.
Добавлено в 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 | Для аутентификации |
connection_name string / обязательный | Имя подключения, которое требуется сбросить. |
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 | Поддержка: частичная В режиме проверки будет возвращён пример ответа, но сброс в Hashicorp Vault выполнен не будет. | Можно запустить в режиме |
Примечания
Примечание
- Этот модуль всегда сообщает статус
changed, поскольку не может гарантировать идемпотентность. - Используйте
changed_whenдля управления этим поведением в случаях, когда известно, что операция не изменяет состояние.
Примеры
- name: Reset a Database Connection with the default mount point
community.hashi_vault.vault_database_connection_reset:
url: https://vault:8201
auth_method: userpass
username: '{{ user }}'
password: '{{ passwd }}'
connection_name: SomeName
register: result
- name: Display the result of the operation
ansible.builtin.debug:
msg: "{{ result }}"
- name: Reset a Database Connection with a custom mount point
community.hashi_vault.vault_database_connection_reset:
url: https://vault:8201
auth_method: userpass
username: '{{ user }}'
password: '{{ passwd }}'
engine_mount_point: db1
connection_name: SomeName
register: result
- name: Display the result of the operation
ansible.builtin.debug:
msg: "{{ result }}"
Ссылки на коллекцию
© 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_connection_reset_module.html