community.hashi_vault.vault_database_rotate_root_credentials module – Выполняет ротацию учетных данных root, сохраненных для подключения к базе данных. Этот пользователь должен иметь разрешение на изменение собственного пароля.
Примечание
Этот модуль входит в коллекцию 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_rotate_root_credentials.
Добавлено в community.hashi_vault 6.2.0
Краткое описание
- Запускает ротацию учетных данных root для подключения к базе данных, определяемого по
connection_name.
Требования
Следующие требования необходимы на узле, выполняющем этот модуль.
-
hvac(библиотека Python) >= 2.0.0 - Подробные сведения о требованиях см. на странице требований коллекции.
Параметры
Параметр | Комментарии |
|---|---|
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 / обязательный | Имя подключения, для которого следует запустить ротацию учетных данных root. |
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: Trigger root credentiaL rotation with the default mount point
community.hashi_vault.vault_database_rotate_root_credentials:
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: Trigger root credential rotation with the default mount point
community.hashi_vault.vault_database_rotate_root_credentials:
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_rotate_root_credentials_module.html