sensu.sensu_go.handler_set 模块 – 管理 Sensu 处理程序集
注意
此模块是 sensu.sensu_go 集合 (版本 1.14.0) 的一部分。
如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install sensu.sensu_go。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。
要在 playbook 中使用它，请指定： sensu.sensu_go.handler_set。
注意
由于违反了 Ansible 包含要求，sensu.sensu_go 集合将从 Ansible 12 中移除。该集合存在 未解决的健全性测试失败。请参阅 讨论主题 获取更多信息。
sensu.sensu_go 1.0.0 中的新增功能
概要
创建、更新或删除 Sensu 处理程序集。
更多信息，请参考 Sensu 文档 https://docs.sensu.io/sensu-go/latest/reference/handlers/#handler-sets.
要求
以下要求在执行此模块的主机上是必需的。
python >= 2.7
参数
参数 |
注释 |
|---|---|
具有较少限制的自定义元数据字段，作为键值对。 这些由 Sensu 保留，但不能作为令牌或标识符访问，主要用于外部工具。 默认值： |
|
身份验证参数。也可以使用 ENV 定义每个参数。 |
|
进行身份验证时应使用的 API 密钥。如果未设置此项，则会检查 SENSU_API_KEY 环境变量的值。 这将替换 *auth.user* 和 *auth.password* 参数。 有关 API 密钥的更多信息，请参阅 Sensu 官方文档：https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/. |
|
应用于验证后端证书的 CA 证书包的路径。 如果未设置此参数，模块将使用 python 使用的 CA 证书包。 也可以通过 *SENSU_CA_PATH* 环境变量设置此参数。 |
|
Sensu 用户的密码。如果未设置此项，则会检查 SENSU_PASSWORD 环境变量的值。 如果设置了 *auth.api_key* 参数，则忽略此参数。 默认值： |
|
Sensu 后端 API 的位置。如果未设置此项，则会检查 SENSU_URL 环境变量的值。 默认值： |
|
用于连接到 Sensu API 的用户名。如果未设置此项，则会检查 SENSU_USER 环境变量的值。 如果设置了 *auth.api_key* 参数，则忽略此参数。 默认值： |
|
控制证书验证的标志。 如果您使用的是自签名证书，可以将此参数设置为 仅在开发场景中使用此参数！如果您在生产环境中使用自签名证书，请参阅 *auth.ca_path* 参数。 也可以通过 *SENSU_VERIFY* 环境变量设置此参数。 选项
|
|
使用处理程序集的事件的 Sensu 事件处理程序（名称）列表。 如果 *state* 为 |
|
可以在 Sensu 中访问的自定义元数据字段，作为键值对。 默认值： |
|
Sensu 资源的名称。此名称（在适用情况下与命名空间组合）唯一标识 Ansible 操作的资源。 如果具有所选名称的资源已存在，Ansible 模块会将其更新以匹配任务中的规范。 有关有效名称和其他限制的更多详细信息，请参阅上游文档中关于 https://docs.sensu.io/sensu-go/latest/reference/ 的 *name* 元数据属性规范。 |
|
要操作的 RBAC 命名空间。如果未设置此项，则将使用 SENSU_NAMESPACE 环境变量的值。 默认值： |
|
Sensu 对象的目标状态。 选项
|
另请参阅
另请参阅
- sensu.sensu_go.socket_handler
管理 Sensu TCP/UDP 处理程序。
- sensu.sensu_go.pipe_handler
管理 Sensu 管道处理程序。
- sensu.sensu_go.handler_info
列出 Sensu 处理程序。
示例
- name: Create a handler set
sensu.sensu_go.handler_set:
name: notify_all_the_things
handlers:
- slack
- tcp_handler
- udp_handler
- name: Delete a handler set
sensu.sensu_go.handler_set:
name: notify_all_the_things
state: absent
返回值
常见的返回值已记录在 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
表示 Sensu 处理程序集的对象。 返回：成功 示例： |