sensu.sensu_go.secrets_provider_env 模块 – 管理 Sensu Env 密钥提供程序

注意

此模块是 sensu.sensu_go 集合（版本 1.14.0）的一部分。

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

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

要在 playbook 中使用它，请指定：sensu.sensu_go.secrets_provider_env。

注意

由于违反了 Ansible 包含要求，sensu.sensu_go 集合将从 Ansible 12 中删除。该集合存在未解决的健全性测试失败。有关更多信息，请参阅讨论线程。

sensu.sensu_go 1.6.0 中的新增功能

概要 

创建或删除 Sensu Go Env 密钥提供程序。
该模块在名为 env 的密钥提供程序上运行。
有关更多信息，请参阅 Sensu Go 文档，网址为 https://docs.sensu.io/sensu-go/latest/operations/manage-secrets/secrets-providers/。

要求 

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

python >= 2.7

参数 

参数	注释
auth 字典	身份验证参数。也可以使用 ENV 定义其中的每一个。
api_key 字符串在 sensu.sensu_go 1.3.0 中添加	进行身份验证时应使用的 API 密钥。如果未设置此项，则将检查 SENSU_API_KEY 环境变量的值。这取代了 auth.user 和 auth.password 参数。有关 API 密钥的更多信息，请参阅 Sensu 官方文档，网址为 https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/。
ca_path 路径在 sensu.sensu_go 1.5.0 中添加	应该用来验证后端证书的 CA 包的路径。如果未设置此参数，则模块将使用 python 正在使用的 CA 包。也可以通过 SENSU_CA_PATH 环境变量设置此参数。
password 字符串	Sensu 用户的密码。如果未设置此项，则将检查 SENSU_PASSWORD 环境变量的值。如果设置了 auth.api_key 参数，则忽略此参数。默认值： `"P@ssw0rd!"`
url 字符串	Sensu 后端 API 的位置。如果未设置此项，则将检查 SENSU_URL 环境变量的值。默认值： `"https://:8080"`
user 字符串	用于连接到 Sensu API 的用户名。如果未设置此项，则将检查 SENSU_USER 环境变量的值。如果设置了 auth.api_key 参数，则忽略此参数。默认值： `"admin"`
verify 布尔值在 sensu.sensu_go 1.5.0 中添加	控制证书验证的标志。如果使用的是自签名证书，则可以将此参数设置为 `false`。仅在开发场景中使用此参数！如果您在生产中使用自签名证书，请参阅 auth.ca_path 参数。也可以通过 SENSU_VERIFY 环境变量设置此参数。选择 `false` `true` ← （默认值）
state 字符串	Sensu 对象的目标状态。选择 `"present"` ← （默认值） `"absent"`

另请参阅 

另请参阅

sensu.sensu_go.secrets_provider_vault: 管理 Sensu VaultProvider 密钥提供程序。
sensu.sensu_go.secrets_provider_info: 列出 Sensu 密钥提供程序。
sensu.sensu_go.secret: 管理 Sensu Go 密钥。
sensu.sensu_go.secret_info: 列出可用的 Sensu Go 密钥。

示例 

- name: Create the env secrets provider
  sensu.sensu_go.secrets_provider_env:

- name: Delete the env secrets provider
  sensu.sensu_go.secrets_provider_env:
    state: absent

返回值 

常见返回值在此处记录此处，以下是此模块特有的字段

键	描述
对象字典	表示 Sensu Env 密钥提供程序的对象。返回：成功示例： `[{"metadata": {"name": "env"}}]`

作者

Aljaz Kosir (@aljazkosir)
Manca Bizjak (@mancabizjak)
Miha Dolinar (@mdolin)
Tadej Borovsak (@tadeboro)