Модуль community.hashi_vault.vault_database_connection_delete – Удаление подключения к базе данных

Примечание

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

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

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

Для использования в плейбуке укажите: community.hashi_vault.vault_database_connection_delete.

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

Обзор
Требования
Параметры
Атрибуты
Примечания
Примеры

Обзор

Удаляет подключение к базе данных, идентифицированное по connection_name в HashiCorp Vault.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

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

Параметры

Параметр	Комментарии
auth_method string	Метод аутентификации, который будет использоваться. `none` auth method was added in collection version `1.2.0`. `cert` auth method was added in collection version `1.4.0`. `aws_iam_login` was renamed `aws_iam` in collection version `2.1.0` and was removed in `3.0.0`. `azure` auth method was added in collection version `3.2.0`. Варианты: `"token"` ← (default) `"userpass"` `"ldap"` `"approle"` `"aws_iam"` `"azure"` `"jwt"` `"cert"` `"none"`
aws_access_key aliases: aws_access_key_id string	Секретный ключ доступа AWS для использования.
aws_iam_server_id string added in community.hashi_vault 0.2.0	Если указано, устанавливает значение для использования в заголовке `X-Vault-AWS-IAM-Server-ID` в рамках запроса `GetCallerIdentity`.
aws_profile aliases: boto_profile string	Профиль AWS
aws_secret_key aliases: aws_secret_access_key string	Секретный ключ AWS, соответствующий ключу доступа.
aws_security_token string	Маркер безопасности AWS, если используются временные ключи доступа и секретные ключи.
azure_client_id string added in community.hashi_vault 3.2.0	Идентификатор клиента (также известный как идентификатор приложения) субъекта безопасности Azure AD или управляемой идентичности. Должен быть UUID. Если не указано, будет использоваться назначенная системой управляемая идентичность.
azure_client_secret string added in community.hashi_vault 3.2.0	Секретный ключ клиента субъекта безопасности Azure AD.
azure_resource string added in community.hashi_vault 3.2.0	URL ресурса для приложения, зарегистрированного в Azure Active Directory. Обычно не следует изменять значение по умолчанию. Значение по умолчанию: `"https://management.azure.com/"`
azure_tenant_id string added in community.hashi_vault 3.2.0	Идентификатор клиента Azure Active Directory (также известный как идентификатор каталога) субъекта безопасности. Должен быть UUID. Требуется при использовании субъекта безопасности для аутентификации в Vault, например, требуется, когда указаны как azure_client_id, так и azure_client_secret. Необязательно при использовании управляемой идентичности для аутентификации в Vault.
ca_cert aliases: cacert string	Путь к сертификату, используемому для аутентификации. Если не указано иными средствами, будет использоваться переменная среды `VAULT_CACERT`.
cert_auth_private_key path added in community.hashi_vault 1.4.0	Для аутентификации `cert`, путь к файлу закрытого ключа для аутентификации в формате PEM.
cert_auth_public_key path added in community.hashi_vault 1.4.0	Для аутентификации `cert`, путь к файлу сертификата для аутентификации в формате PEM.
connection_name string / required	Имя соединения, которое будет удалено.
engine_mount_point string	Путь, по которому смонтирован бэкэнд секретов.
jwt string	JSON Web Token (JWT), используемый для JWT-аутентификации в Vault.
mount_point string	Точка монтирования Vault. Если не указано, используется точка монтирования по умолчанию для данного метода аутентификации. Не применяется к токенной аутентификации.

namespace строка	Пространство имён Vault, где хранятся секреты. Этот параметр требует HVAC 0.7.0+ и Vault 0.11+. В качестве альтернативы это можно сделать, добавив префикс к точке монтирования аутентификации и/или пути к секрету (например, `mynamespace/secret/mysecret`). Если переменная среды `VAULT_NAMESPACE` установлена, её значение будет использовано в последнюю очередь по сравнению со всеми другими способами указания namespace.
password строка	Пароль для аутентификации.
proxies любой добавлен в community.hashi_vault 1.1.0	URL(ы) прокси-серверов для доступа к службе Vault. Может быть строкой или словарем. Если это словарь, укажите схему (например, `http` или `https`) в качестве ключа, а URL — в качестве значения. Если это строка, укажите единственный URL, который будет использоваться в качестве прокси для схем `http` и `https`. Строка, интерпретируемая как словарь, будет преобразована в словарь (см. примеры). Вы можете указать разные прокси для ресурсов HTTP и HTTPS. Если не указано, используются переменные окружения из библиотеки Requests https://requests.readthedocs.io/en/master/user/advanced/#proxies.
region строка	Регион AWS для создания подключения.
retries любой добавлен в community.hashi_vault 1.3.0	Позволяет повторные попытки при ошибках, основанные на классе Retry в библиотеке urllib3. Этот сборник определяет рекомендуемые значения по умолчанию для повторных попыток подключения к Vault. Этот параметр можно указать как положительное число (целое число) или словарь. Если этот параметр не указан или число равно `0`, повторные попытки отключены. Число задаёт общее количество попыток, при этом другие параметры используют значения по умолчанию из сборника. Значение словаря используется непосредственно для инициализации класса `Retry`, что позволяет настроить повторные попытки полностью. Подробную информацию о повторных попытках см. в руководстве пользователя сборника.
retry_action строка добавлен в community.hashi_vault 1.3.0	Управляет отображением сообщений при повторных попытках. Это не повлияет, если запрос не будет повторён. Варианты: `"ignore"` `"warn"` ← (по умолчанию)
role_id строка	Идентификатор или имя роли Vault. Используется в `approle`, `aws_iam`, `azure` и `cert` методах аутентификации. Для аутентификации `cert`, если role_id не указан, поведение по умолчанию заключается в попытке использования всех ролей сертификатов и возврате любой подходящей роли. Для аутентификации `azure` параметр role_id обязателен.
secret_id строка	Идентификатор секрета для аутентификации Vault AppRole.
timeout целое число добавлен в community.hashi_vault 1.3.0	Устанавливает таймаут подключения в секундах. Если не задан, используется значение по умолчанию из библиотеки `hvac`.
token строка	Токен Vault. Токен может быть указан явно, через перечисленные переменные среды, а также через переменную `VAULT_TOKEN` среды. Если токен не указан явно или через переменные среды, плагин проверит наличие файла токена, как определено token_path и token_file. Порядок загрузки токенов (первый найденный имеет приоритет) `token param -> ansible var -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> token file`.
token_file строка	Если токен не указан, попытается прочитать токен из этого файла в token_path. Значение по умолчанию: `".vault-token"`
token_path строка	Если токен не указан, попытается прочитать token_file из этого пути.
token_validate булево добавлен в community.hashi_vault 0.2.0	Для аутентификации токеном выполнит операцию `lookup-self` для определения валидности токена перед его использованием. Отключить, если ваш токен не обладает возможностью `lookup-self`. Варианты: `false` ← (по умолчанию) `true`
url строка	URL службы Vault. Если не указан другими способами, будет использовано значение переменной среды `VAULT_ADDR`. Если `VAULT_ADDR` также не определён, будет выведено сообщение об ошибке.
username строка	Имя пользователя для аутентификации.
validate_certs булево	Управляет проверкой и валидацией SSL-сертификатов; обычно отключение нужно только для самоподписанных сертификатов. Будет задано обратное значение `VAULT_SKIP_VERIFY`, если оно задано, и validate_certs не указан явно. Будет установлено значение по умолчанию `true`, если ни validate_certs, ни `VAULT_SKIP_VERIFY` не заданы. Варианты: `false` `true`

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.hashi_vault.vault	Используйте `group/community.hashi_vault.vault` в `module_defaults` для установки значений по умолчанию для данного модуля.
check_mode	Поддержка: частичная В режиме проверки будет возвращен пример ответа, но удаление не будет выполнено в Hashicorp Vault.	Можно использовать в режиме `check_mode` и получить прогноз статуса изменения без модификации целевого объекта.

Примечания

Примечание

Этот модуль всегда сообщает статус changed, так как не может гарантировать идемпотентность.
Используйте changed_when для управления этим в случаях, когда известно, что операция не изменяет состояние.

Примеры

- name: Delete a Database Connection with the default mount point
  community.hashi_vault.vault_database_connection_delete:
    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: Delete a Database Connection with a custom mount point
  community.hashi_vault.vault_database_connection_delete:
    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 }}"

Авторы

Martin Chmielewski (@M4rt1nCh)

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

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