Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию 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_connection_delete.

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

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

Обзор

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

Требования

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

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

Параметры

Параметр

Комментарии

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.

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 или новее.

Также можно указать пространство имён в начале точки монтирования аутентификации и/или пути к секрету (например, mynamespace/secret/mysecret).

Если задана переменная среды VAULT_NAMESPACE, её значение будет иметь наивысший приоритет среди всех способов указания namespace.

password

string

Пароль для аутентификации.

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

Поддержка: частичная

В режиме проверки будет возвращён пример ответа, но удаление в 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–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_delete_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API