sensu.sensu_go.socket_handler 模块 – 管理 Sensu TCP/UDP 处理程序

注意

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

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

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

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

注意

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

sensu.sensu_go 1.0.0 中的新增功能

概要 

创建、更新或删除 Sensu socket 处理程序。
有关更多信息，请参阅 Sensu 文档 https://docs.sensu.io/sensu-go/latest/reference/handlers/#tcp-udp-handlers。

要求 

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

python >= 2.7

参数 

参数	注释
annotations 字典	具有较少限制的自定义元数据字段，作为键值对。这些由 Sensu 保留，但不能作为令牌或标识符访问，主要用于外部工具。默认值： `{}`
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://127.0.0.1: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` ← (默认)
filters 列表 / 元素=字符串	确定是否将检查结果传递给此处理程序时要使用的过滤器列表。
host 字符串	要连接到的 socket 主机地址 (IP 或主机名)。如果 state 为 `present`，则为必填项。
labels 字典	可在 Sensu 中访问的自定义元数据字段，作为键值对。默认值： `{}`
mutator 字符串	在将检查结果传递给此处理程序之前，要调用的用于转换检查结果的 mutator。
name 字符串 / 必填	Sensu 资源的名称。此名称（在适用的情况下与命名空间结合使用）唯一标识 Ansible 操作的资源。如果具有所选名称的资源已存在，Ansible 模块将更新它以匹配任务中的规范。有关有效名称和其他限制的更多详细信息，请参阅上游文档中关于 name 元数据属性规范的说明 https://docs.sensu.io/sensu-go/latest/reference/。
namespace 字符串	要操作的 RBAC 命名空间。如果未设置此值，则将使用 SENSU_NAMESPACE 环境变量的值。默认值： `"default"`
port 整数	要连接到的 socket 端口。如果 state 为 `present`，则为必填项。
state 字符串	Sensu 对象的目标状态。选项 `"present"` ← (默认) `"absent"`
timeout 整数	处理程序执行的超时时间。
type 字符串	处理程序类型。如果 state 为 `present`，则为必填项。选项 `"tcp"` `"udp"`

另请参阅 

另请参阅

sensu.sensu_go.handler_info: 列出 Sensu 处理程序。
sensu.sensu_go.pipe_handler: 管理 Sensu pipe 处理程序。
sensu.sensu_go.handler_set: 管理 Sensu 处理程序集。

示例 

- name: TCP handler
  sensu.sensu_go.socket_handler:
    name: tcp_handler
    type: tcp
    host: 10.0.1.99
    port: 4444

- name: UDP handler
  sensu.sensu_go.socket_handler:
    name: udp_handler
    type: udp
    host: 10.0.1.99
    port: 4444

- name: Delete a handler
  sensu.sensu_go.socket_handler:
    name: udp_handler
    state: absent

返回值 

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

键	描述
对象字典	表示Sensu套接字处理器的对象。返回值：成功示例： `[{"metadata": {"name": "udp_handler", "namespace": "default"}, "socket": {"host": "10.0.1.99", "port": 4444}, "type": "udp"}]`

作者

Aljaz Kosir (@aljazkosir)
Miha Plesko (@miha-plesko)
Tadej Borovsak (@tadeboro)