community.hashi_vault.vault_database_role_delete 模块 – 删除角色定义

注意

此模块是 community.hashi_vault 集合 (版本 6.2.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.hashi_vault。您需要其他要求才能使用此模块，有关详细信息，请参见要求。

要在 playbook 中使用它，请指定：community.hashi_vault.vault_database_role_delete。

community.hashi_vault 6.2.0 中的新增功能

概要 

删除角色定义.

要求 

执行此模块的主机需要以下要求。

hvac (Python 库)
有关详细要求，请参见集合要求页面。

参数 

参数	注释
auth_method 字符串	要使用的身份验证方法。 `none` 身份验证方法在集合版本 `1.2.0` 中添加。 `cert` 身份验证方法在集合版本 `1.4.0` 中添加。 `aws_iam_login` 在集合版本 `2.1.0` 中重命名为 `aws_iam`，并在 `3.0.0` 中删除。 `azure` 身份验证方法在集合版本 `3.2.0` 中添加。选项 `"token"` ← (默认) `"userpass"` `"ldap"` `"approle"` `"aws_iam"` `"azure"` `"jwt"` `"cert"` `"none"`
aws_access_key 别名：aws_access_key_id 字符串	要使用的 AWS 访问密钥。
aws_iam_server_id 字符串在 community.hashi_vault 0.2.0 中添加	如果指定，则设置要用于 `X-Vault-AWS-IAM-Server-ID` 标头的值，作为 `GetCallerIdentity` 请求的一部分。
aws_profile 别名：boto_profile 字符串	AWS 配置文件
aws_secret_key 别名：aws_secret_access_key 字符串	与访问密钥对应的 AWS 密钥。
aws_security_token 字符串	如果使用临时访问密钥和密钥，则使用 AWS 安全令牌。
azure_client_id 字符串在 community.hashi_vault 3.2.0 中添加	Azure AD 服务主体或托管身份的客户端 ID（也称为应用程序 ID）。应为 UUID。如果未指定，将使用系统分配的托管身份。
azure_client_secret 字符串在 community.hashi_vault 3.2.0 中添加	Azure AD 服务主体的客户端密钥。
azure_resource 字符串在 community.hashi_vault 3.2.0 中添加	在 Azure Active Directory 中注册的应用程序的资源 URL。通常不应更改默认值。默认值： `"https://management.azure.com/"`
azure_tenant_id 字符串在 community.hashi_vault 3.2.0 中添加	服务主体的 Azure Active Directory 租户 ID（也称为目录 ID）。应为 UUID。使用服务主体向 Vault 进行身份验证时需要，例如，当同时指定了 azure_client_id 和 azure_client_secret 时需要。使用托管身份向 Vault 进行身份验证时可选。
ca_cert 别名：cacert 字符串	用于身份验证的证书路径。如果没有通过任何其他方式指定，则将使用 `VAULT_CACERT` 环境变量。
cert_auth_private_key 路径在 community.hashi_vault 1.4.0 中添加	对于 `cert` 身份验证，要使用 PEM 格式进行身份验证的私钥文件路径。
cert_auth_public_key 路径在 community.hashi_vault 1.4.0 中添加	对于 `cert` 身份验证，要使用 PEM 格式进行身份验证的证书文件路径。
engine_mount_point 字符串	挂载秘密后端的路径。
jwt 字符串	用于 JWT 身份验证到 Vault 的 JSON Web 令牌 (JWT)。
mount_point 字符串	Vault 挂载点。如果未指定，则使用给定身份验证方法的默认挂载点。不适用于令牌身份验证。
namespace 字符串	秘密所在的 Vault 命名空间。此选项需要 HVAC 0.7.0+ 和 Vault 0.11+。或者，可以通过在身份验证挂载点和/或秘密路径前添加命名空间来实现（例如 `mynamespace/secret/mysecret`）。如果设置了环境变量 `VAULT_NAMESPACE`，则其值将在所有指定 namespace 的方式中最后使用。
password 字符串	身份验证密码。
proxies 任意在 community.hashi_vault 1.1.0 中添加	用于访问 Vault 服务的代理的 URL。它可以是字符串或字典。如果是字典，请提供方案（例如 `http` 或 `https`）作为键，并提供 URL 作为值。如果它是字符串，请提供一个单一的URL，该URL将同时用作`http`和`https`方案的代理。可以解释为字典的字符串将被转换为字典（参见示例）。您可以为HTTP和HTTPS资源指定不同的代理。如果未指定，则使用Requests库的环境变量。
区域字符串	用于创建连接的AWS区域。
重试任意在community.hashi_vault 1.3.0中添加	允许根据urllib3库中的Retry类重试错误。此集合定义了重试与Vault连接的推荐默认值。此选项可以指定为正数（整数）或字典。如果未指定此选项或数字为`0`，则禁用重试。数字设置重试的总数，并使用集合默认值进行其他设置。字典值直接用于初始化`Retry`类，因此可以用来完全自定义重试。有关重试的详细信息，请参阅集合用户指南。
retry_action 字符串在community.hashi_vault 1.3.0中添加	控制是否以及如何显示重试时的消息。如果未重试请求，则此选项无效。选项 `"忽略"` `"警告"` ← (默认)
role_id 字符串	Vault角色ID或名称。用于`approle`、`aws_iam`、`azure`和`cert`身份验证方法。对于`cert`身份验证，如果没有提供role_id，则默认行为是尝试所有证书角色并返回任何一个匹配的角色。对于`azure`身份验证，需要role_id。
role_name 字符串 / 必需	要为其轮换凭据的角色名称。
secret_id 字符串	用于Vault AppRole身份验证的密钥ID。
超时整数在community.hashi_vault 1.3.0中添加	设置连接超时（以秒为单位）。如果未设置，则使用`hvac`库的默认值。
令牌字符串	Vault令牌。令牌可以显式指定，通过列出的[env]变量指定，也可以通过`VAULT_TOKEN`环境变量指定。如果没有通过显式或环境变量提供令牌，插件将检查令牌文件，由token_path和token_file确定。令牌加载顺序（先找到先赢）为`token 参数 -> ansible 变量 -> ANSIBLE_HASHI_VAULT_TOKEN -> VAULT_TOKEN -> 令牌文件`。
token_file 字符串	如果未指定令牌，将尝试从token_path中的此文件读取令牌。默认值：`".vault-token"`
token_path 字符串	如果未指定令牌，将尝试从此路径读取token_file。
token_validate 布尔值在 community.hashi_vault 0.2.0 中添加	对于令牌身份验证，将在使用令牌之前执行`lookup-self`操作以确定令牌的有效性。如果您的令牌没有`lookup-self`功能，请禁用。选项 `false` ← (默认) `true`
url 字符串	Vault服务的URL。如果没有通过其他任何方式指定，则将使用`VAULT_ADDR`环境变量的值。如果`VAULT_ADDR`也没有定义，则将引发错误。
用户名字符串	身份验证用户名。
validate_certs 布尔值	控制SSL证书的验证和确认，大多数情况下只有在使用自签名证书时才需要关闭。如果设置了`VAULT_SKIP_VERIFY`且未显式提供validate_certs，则将填充`VAULT_SKIP_VERIFY`的反值。如果既未设置validate_certs也未设置`VAULT_SKIP_VERIFY`，则默认为`true`。选项 `false` `true`

属性 

属性	支持	描述
action_group	操作组： community.hashi_vault.vault	在`module_defaults`中使用`group/community.hashi_vault.vault`为该模块设置默认值。
check_mode	支持：部分在检查模式下，将返回示例响应，但在HashiCorp Vault中不会执行删除操作。	可以在`check_mode`下运行并返回更改状态预测，而无需修改目标。

注释 

注意

适用于静态和动态角色。
此模块始终报告changed状态，因为它无法保证幂等性。
在已知操作不会更改状态的情况下，使用changed_when进行控制。

示例 

- name: Delete a Role with the default mount point
  community.hashi_vault.vault_database_role_delete:
    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: Delete a Role with a custom mount point
  community.hashi_vault.vault_database_role_delete:
    url: https://vault:8201
    auth_method: userpass
    username: '{{ user }}'
    password: '{{ passwd }}'
    engine_mount_path: db1
    role_name: SomeRole
  register: result

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

作者

Martin Chmielewski (@M4rt1nCh)