Модуль community.hashi_vault.vault_database_static_role_create – Создание или обновление статического роли

Примечание

Этот модуль является частью коллекции 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_create.

Добавлен в 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`, путь к файлу с закрытым ключом для аутентификации в формате PEM.
cert_auth_public_key path added in community.hashi_vault 1.4.0	Для аутентификации `cert`, путь к файлу с сертификатом для аутентификации в формате PEM.
connection_name string / required	Имя подключения, под которым должна быть создана роль.
db_username 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 added in community.hashi_vault 1.1.0	URL(ы) к прокси-серверам, используемым для доступа к службе Vault. Может быть строкой или словарем. Если это словарь, укажите схему (например, `http` или `https`) в качестве ключа и URL в качестве значения. Если это строка, укажите один URL, который будет использоваться в качестве прокси для схем `http` и `https`. Строка, которая может быть интерпретирована как словарь, будет преобразована в словарь (см. примеры). Вы можете указать разные прокси для ресурсов HTTP и HTTPS. Если не указано, используются переменные окружения из библиотеки Requests.
region string	Регион AWS, для которого необходимо создать соединение.
retries any added in community.hashi_vault 1.3.0	Позволяет повторять попытки при ошибках, на основе класса Retry в библиотеке urllib3. Эта коллекция определяет рекомендуемые значения по умолчанию для повторных попыток подключения к Vault. Эта опция может быть указана как положительное число (целое число) или словарь. Если эта опция не указана или число равно `0`, то повторные попытки отключены. Число устанавливает общее количество повторных попыток и использует значения по умолчанию коллекции для других параметров. Значение словаря используется непосредственно для инициализации класса `Retry`, поэтому его можно использовать для полной настройки повторных попыток. Для получения подробной информации о повторных попытках см. руководство пользователя коллекции.
retry_action string added in community.hashi_vault 1.3.0	Управляет тем, следует ли и как отображать сообщения о повторных попытках. Это не влияет, если запрос не повторяется. Варианты: `"ignore"` `"warn"` ← (по умолчанию)
role_id string	Идентификатор или имя роли Vault. Используется в методах аутентификации `approle`, `aws_iam`, `azure` и `cert`. Для аутентификации `cert`, если role_id не указан, поведение по умолчанию заключается в попытке использования всех ролей сертификатов и возврате любой совпадающей. Для аутентификации `azure`, role_id обязателен.
role_name string / required	Имя роли, которая должна быть создана.
rotation_period integer	Период смены пароля в секундах (по умолчанию 24 часа) По умолчанию: `86400`
rotation_statements list / elements=string / required	SQL-запросы для смены пароля для заданного `db_username`
secret_id string	Secret ID, который будет использоваться для аутентификации Vault AppRole.
timeout integer added in community.hashi_vault 1.3.0	Устанавливает тайм-аут соединения в секундах. Если не указано, используется значение по умолчанию библиотеки `hvac`.
token string	Токен Vault. Токен может быть указан явно, через перечисленные переменные окружения [env], а также через переменную окружения `VAULT_TOKEN`. Если токен не указан явно или через env, то плагин проверит файл токена, как определено в 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 added in community.hashi_vault 0.2.0	Для аутентификации с помощью токена выполнит операцию `lookup-self` для определения действительности токена перед его использованием. Отключите, если ваш токен не имеет возможности `lookup-self`. Варианты: `false` ← (по умолчанию) `true`
url string	URL службы Vault. Если не указано иным способом, будет использовано значение переменной окружения `VAULT_ADDR`. Если `VAULT_ADDR` также не определено, будет вызвана ошибка.

Имя пользователя

строка

Имя пользователя для аутентификации.

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: Generate rotation statement
  ansible.builtin.set_fact:
    rotation_statements = ["ALTER USER \"{{name}}\" WITH PASSWORD '{{password}}';"]

- name: Create / update Static Role with the default mount point
  community.hashi_vault.vault_database_static_role_create:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
    connection_name: SomeConnection
    role_name: SomeRole
    db_username: '{{ db_username}}'
    rotation_statements: '{{ rotation_statements }}'
  register: response

- name: Display the result of the operation
  ansible.builtin.debug:
    msg: "{{ result }}"

- name: Create / update Static Role with a custom mount point
  community.hashi_vault.vault_database_static_role_create:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
    engine_mount_point: db1
    connection_name: SomeConnection
    role_name: SomeRole
    db_username: '{{ db_username}}'
    rotation_statements: '{{ rotation_statements }}'
  register: response

- 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_static_role_create_module.html