community.hashi_vault.vault_kv2_delete модуль — Удаление одной или нескольких версий секрета из хранилища секретов HashiCorp Vault KV версии 2
Примечание
Этот модуль входит в коллекцию community.hashi_vault (версия 6.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.hashi_vault. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: community.hashi_vault.vault_kv2_delete.
Добавлен в community.hashi_vault 3.4.0
Описание
- Удаление одной или нескольких версий секрета из хранилища секретов HashiCorp Vault KV версии 2.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
-
hvac(Библиотека Python) - Подробные требования см. на странице требований к коллекции.
Параметры
Параметр | Комментарии |
|---|---|
auth_method string | Метод аутентификации, который будет использоваться.
Варианты:
|
aws_access_key aliases: aws_access_key_id string | Ключ доступа AWS для использования. |
aws_iam_server_id string добавлено в 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 добавлено в 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 aliases: cacert string | Путь к сертификату, который будет использоваться для аутентификации. Если не указано иным способом, будет использоваться переменная среды |
cert_auth_private_key path добавлено в community.hashi_vault 1.4.0 | Для аутентификации |
cert_auth_public_key path добавлено в 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 | Пароль аутентификации. |
path string / required | Путь к секрету в Vault KV, который необходимо удалить. Этот путь указывается относительно engine_mount_point, поэтому путь монтирования включать не нужно. Для kv2 не включайте |
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. Используется в методах аутентификации Для аутентификации Для аутентификации |
secret_id string | Secret ID, который будет использоваться для аутентификации Vault AppRole. |
timeout integer added in 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 added in community.hashi_vault 0.2.0 | Для аутентификации с помощью токена выполнит операцию Отключите, если ваш токен не имеет возможности Варианты:
|
url string | URL службы Vault. Если не указано иным способом, будет использовано значение переменной среды Если |
username string | Имя пользователя для аутентификации. |
validate_certs boolean | Управляет проверкой и валидацией SSL-сертификатов, в основном вы хотите отключить только самозаверяющие. Будет заполнено обратным значением Будет установлено по умолчанию в Варианты:
|
versions list / elements=integer | Одна или несколько версий секрета для удаления. При отсутствии этого параметра удаляется последняя версия секрета. |
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
action_group | Группа действий: community.hashi_vault.vault | Используйте |
check_mode | Поддержка: частичная В режиме проверки модуль возвращает Рассмотрите использование community.hashi_vault.vault_kv2_get для предварительной проверки существования секрета. | Может работать в |
Примечания
Примечание
- Данный модуль всегда сообщает
changedстатус, поскольку он не может гарантировать идемпотентность. - Используйте
changed_whenдля управления этим в случаях, когда известно, что операция не изменяет состояние.
См. также
См. также
- community.hashi_vault.vault_kv2_get
-
Получение секрета из хранилища секретов KV версии 2 HashiCorp Vault.
- community.hashi_vault.vault_kv2_write
-
Выполнение операции записи в секрет KVv2 в HashiCorp Vault.
- Системы секретов KV2
-
Документация для системы секретов Vault KV, версия 2.
Примеры
- name: Delete the latest version of the secret/mysecret secret.
community.hashi_vault.vault_kv2_delete:
url: https://vault:8201
path: secret/mysecret
auth_method: userpass
username: user
password: '{{ passwd }}'
register: result
- name: Delete versions 1 and 3 of the secret/mysecret secret.
community.hashi_vault.vault_kv2_delete:
url: https://vault:8201
path: secret/mysecret
versions: [1, 3]
auth_method: userpass
username: user
password: '{{ passwd }}'
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
data словарь | Необработанный результат удаления по заданному пути. Обычно он пуст, но может содержать предупреждения или другую информацию. Возвращаемое значение: success |
Ссылки на сборку
© 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_kv2_delete_module.html