community.general.sensu_handler 模块 – 管理 Sensu 处理程序配置

注意

此模块是 community.general 集合（版本 10.1.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.general。

要在 playbook 中使用它，请指定：community.general.sensu_handler。

概要 

管理 Sensu 处理程序配置
有关更多信息，请参阅 Sensu 文档：https://sensuapp.org/docs/latest/reference/handlers.html

参数 

参数	注释
command 字符串	要执行的处理程序命令。事件数据通过 STDIN 传递给进程。注意：command 属性仅对 Pipe 处理程序（即配置了 “type”: “pipe” 的处理程序）是必需的。
filter 字符串	用于筛选处理程序事件的 Sensu 事件过滤器（名称）。
filters 列表 / 元素=字符串	用于筛选处理程序事件的 Sensu 事件过滤器（名称）数组。每个数组项必须是字符串。
handle_flapping 布尔值	是否应处理处于抖动状态的事件。选择 `false` ← (默认) `true`
handle_silenced 布尔值	是否应处理与一个或多个静默条目匹配的事件。选择 `false` ← (默认) `true`
handlers 列表 / 元素=字符串	用于使用处理程序集的事件的 Sensu 事件处理程序（名称）数组。注意：handlers 属性仅对处理程序集（即配置了 “type”: “set” 的处理程序）是必需的。
mutator 字符串	用于修改处理程序事件数据的 Sensu 事件修改器（名称）。
name 字符串 / 必需	处理程序的唯一名称。名称不能包含特殊字符或空格。
pipe 字典	用于配置 Sensu 传输管道的管道定义范围。注意：pipe 属性仅对 Transport 处理程序（即配置了 “type”: “transport” 的处理程序）是必需的。
severities 列表 / 元素=字符串	处理程序将处理的检查结果严重性数组。注意：事件解决会绕过此筛选。示例：[ ‘warning’, ‘critical’, ‘unknown’ ]。
socket 字典	用于配置 TCP/UDP 处理程序套接字的套接字定义范围。注意：socket 属性仅对 TCP/UDP 处理程序（即配置了 “type”: “tcp” 或 “type”: “udp” 的处理程序）是必需的。
state 字符串	处理程序是否应存在选择 `"present"` ← (默认) `"absent"`
timeout 整数	处理程序执行持续时间的超时（以秒为单位，硬停止）。仅由 pipe 和 tcp 处理程序类型使用。默认值: `10`
type 字符串	处理程序类型选择 `"pipe"` `"tcp"` `"udp"` `"transport"` `"set"`

属性 

属性	支持	描述
check_mode	支持: 完全	可以在 `check_mode` 中运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持: 无	在 diff 模式下，将返回已更改（或可能需要在 `check_mode` 中更改）的详细信息。

注释 

注意

支持检查模式

示例 

# Configure a handler that sends event data as STDIN (pipe)
- name: Configure IRC Sensu handler
  community.general.sensu_handler:
    name: "irc_handler"
    type: "pipe"
    command: "/usr/local/bin/notify-irc.sh"
    severities:
      - "ok"
      - "critical"
      - "warning"
      - "unknown"
    timeout: 15
  notify:
    - Restart sensu-client
    - Restart sensu-server

# Delete a handler
- name: Delete IRC Sensu handler
  community.general.sensu_handler:
    name: "irc_handler"
    state: "absent"

# Example of a TCP handler
- name: Configure TCP Sensu handler
  community.general.sensu_handler:
    name: "tcp_handler"
    type: "tcp"
    timeout: 30
    socket:
      host: "10.0.1.99"
      port: 4444
  register: handler
  notify:
    - Restart sensu-client
    - Restart sensu-server

- name: Secure Sensu handler configuration file
  ansible.builtin.file:
    path: "{{ handler['file'] }}"
    owner: "sensu"
    group: "sensu"
    mode: "0600"

返回值 

通用返回值记录在此处，以下是此模块独有的字段

键	描述
config 字典	状态为 present 时的有效处理程序配置已返回: 成功示例: `{"command": "/usr/local/bin/notify-irc.sh", "name": "irc", "type": "pipe"}`
file 字符串	处理程序配置文件的路径已返回: 成功示例: `"/etc/sensu/conf.d/handlers/irc.json"`
name 字符串	处理程序的名称已返回: 成功示例: `"irc"`

作者

David Moreau Simard (@dmsimard)