Модуль community.hashi_vault.vault_database_static_role_rotate_credentials — Триггер вращения учетных данных для статического роли
Примечание
Этот модуль входит в состав коллекции 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_static_role_rotate_credentials.
Новая функция в community.hashi_vault 6.2.0
Обзор
- Этот конечная точка используется для
- вращения учетных данных статической роли
- хранящихся для данного имени роли. Хотя статические роли вращаются автоматически Vault в соответствии с настроенными интервалами,
- пользователи могут использовать эту конечную точку для ручного запуска вращения, чтобы изменить хранящийся пароль и сбросить срок действия пароля статической роли.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
-
hvac(библиотека Python) >= 2.0.0 - Подробные требования см. в разделе требований к коллекции.
Параметры
Параметр | Комментарии |
|---|---|
auth_method string | Метод аутентификации, который будет использоваться.
Варианты:
|
aws_access_key aliases: aws_access_key_id string | Ключ доступа AWS для использования. |
aws_iam_server_id string added in community.hashi_vault 0.2.0 | Если указано, устанавливает значение для использования в заголовке |
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. Обычно не следует изменять значение по умолчанию. По умолчанию: |
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 | Путь к сертификату, который будет использоваться для аутентификации. Если не указано иным образом, будет использоваться переменная среды |
cert_auth_private_key path added in community.hashi_vault 1.4.0 | Для аутентификации |
cert_auth_public_key path added in community.hashi_vault 1.4.0 | Для аутентификации |
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+. Дополнительно, это может быть достигнуто путем добавления префикса к точке монтирования аутентификации и/или пути к секрету с пространством имен (например, Если установлена переменная среды |
password string | Пароль для аутентификации. |
proxies any added in community.hashi_vault 1.1.0 | URL(ы) прокси-серверов, используемых для доступа к службе Vault. Может быть строкой или словарем. Если это словарь, укажите схему (например, Если это строка, укажите один URL, который будет использоваться в качестве прокси для схем Строка, которая может быть интерпретирована как словарь, будет преобразована в словарь (см. примеры). Вы можете указать разные прокси для ресурсов HTTP и HTTPS. Если не указано, используются переменные среды из библиотеки Requests. |
region string | Регион AWS, для которого нужно создать подключение. |
retries any added in community.hashi_vault 1.3.0 | Позволяет повторять попытки при ошибках, основываясь на классе Retry в библиотеке urllib3. Эта коллекция определяет рекомендуемые значения по умолчанию для повторных попыток подключения к Vault. Этот параметр может быть задан как положительное число (целое число) или словарь. Если этот параметр не указан или число равно Число устанавливает общее количество повторных попыток и использует значения по умолчанию коллекции для других параметров. Значение словаря используется напрямую для инициализации класса Для подробной информации о повторных попытках см. руководство пользователя коллекции. |
retry_action string added in community.hashi_vault 1.3.0 | Управляет отображением сообщений о повторных попытках. Не влияет, если запрос не повторяется. Варианты:
|
role_id string | Идентификатор или имя роли Vault. Используется в методах аутентификации Для аутентификации Для аутентификации |
role_name string / required | Имя роли, для которой нужно сменить учетные данные. |
secret_id string | Секретный ID, используемый для аутентификации Vault AppRole. |
timeout integer added in community.hashi_vault 1.3.0 | Устанавливает тайм-аут подключения в секундах. Если не задано, используется значение по умолчанию библиотеки |
token string | Токен Vault. Токен может быть указан явно, через указанные переменные среды [env], а также через переменную среды Если токен не указан явно или через env, плагин проверит наличие файла токена, как определено в token_path и token_file. Порядок загрузки токена (первый найденный выигрывает) — |
token_file string | Если токен не указан, будет пытаться прочитать токен из этого файла в token_path. Значение по умолчанию: |
token_path string | Если токен не указан, будет пытаться прочитать token_file из этого пути. |
token_validate boolean added in community.hashi_vault 0.2.0 | Для токенной аутентификации выполнит операцию Отключите, если ваш токен не имеет возможности Варианты:
|
url string | URL службы Vault. Если не указано иными способами, будет использовано значение переменной среды Если |
username string | Имя пользователя для аутентификации. |
validate_certs boolean | Управляет проверкой и валидацией SSL-сертификатов, в основном вы хотите отключить только самоподписанные. Будет заполнено обратным значением Будет установлено по умолчанию в Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
action_group | Группа действий: community.hashi_vault.vault | Используйте |
check_mode | Поддержка: частичная В режиме проверки будет возвращён пример ответа, но вращение учетных данных в Hashicorp Vault не будет выполнено. | Может работать в режиме |
Примечания
Примечание
- Этот модуль всегда сообщает статус
changed, так как не может гарантировать идемпотентность. - Используйте
changed_whenдля управления этим в случаях, когда известно, что операция не изменяет состояние.
Примеры
- name: Rotate credentials of a static role with the default mount point
community.hashi_vault.vault_database_static_role_rotate_credentials:
url: https://vault:8201
auth_method: userpass
username: '{{ user }}'
password: '{{ passwd }}'
role_name: SomeRole
register: result
- name: Display the result of the operation
ansible.builtin.debug:
msg: "{{ result }}"
- name: Rotate credentials of a static role with a custom mount point
community.hashi_vault.vault_database_static_role_rotate_credentials:
url: https://vault:8201
auth_method: userpass
username: '{{ user }}'
password: '{{ passwd }}'
engine_mount_point: db1
role_name: SomeRole
register: result
- name: Display the result of the operation
ansible.builtin.debug:
msg: "{{ result }}"
Ссылки на коллекции
© 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_static_role_rotate_credentials_module.html