Spec-Zone.ru › Ansible

Модуль community.hashi_vault.vault_database_connection_reset — Закрывает подключение connection_name и его подключаемый модуль, а затем перезапускает его с сохранённой конфигурацией

Примечание

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

Новая функция в community.hashi_vault 6.2.0

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

Описание

  • Сброс подключения к базе данных.

Требования

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

  • 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 auth, путь к файлу закрытого ключа для аутентификации в формате PEM.

cert_auth_public_key

path

added in community.hashi_vault 1.4.0

Для cert auth, путь к файлу сертификата для аутентификации в формате PEM.

connection_name

string / required

Имя соединения, которое будет сброшено.

engine_mount_point

string

Путь, по которому смонтирован секретный бэкэнд.

jwt

string

JSON Web Token (JWT), который будет использоваться для JWT-аутентификации в Vault.

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

Секретный ID, используемый для аутентификации 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 не указано явно.

Будет установлено значение по умолчанию 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: 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 }}"

Авторы

  • 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_reset_module.html

Spec-Zone.ru

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