sensu.sensu_go.pipe_handler 模块 – 管理 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.pipe_handler。

注意

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

sensu.sensu_go 1.0.0 中的新增功能

概要 

创建、更新或删除 Sensu 管道处理程序。
有关更多信息，请参阅 Sensu 文档：https://docs.sensu.io/sensu-go/latest/reference/handlers/#pipe-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` ←（默认值）
command 字符串	要执行的处理程序命令。事件数据通过 STDIN 传递到进程。如果 state 为 `present`，则为必需项。
env_vars 字典	要与命令执行一起使用的环境变量名称和值的映射。
filters 列表 / 元素=字符串	用于确定是否将检查结果传递给此处理程序的过滤器列表。
labels 字典	可在 Sensu 中访问的自定义元数据字段，以键/值对的形式表示。默认值： `{}`
mutator 字符串	用于在将检查结果传递给此处理程序之前转换它的 Mutator。
name 字符串 / 必需	Sensu 资源的名称。此名称（在适用的情况下与命名空间结合使用）唯一标识 Ansible 操作的资源。如果已存在具有选定名称的资源，Ansible 模块将更新它以匹配任务中的规范。有关有效名称和其他限制的更多详细信息，请参阅上游文档中关于 https://docs.sensu.io/sensu-go/latest/reference/ 的 name 元数据属性规范。
namespace 字符串	要在其中操作的 RBAC 命名空间。如果未设置此项，将使用 SENSU_NAMESPACE 环境变量的值。默认值： `"default"`
runtime_assets 列表 / 元素=字符串	运行处理程序 `command` 所需的运行时资产列表。
secrets 列表 / 元素=字典在 sensu.sensu_go 1.6.0 中添加	可用于命令的密钥列表。
name 字符串 / 必需在 sensu.sensu_go 1.6.0 中添加	将包含敏感数据的变量名。
密钥字符串 / 必需在 sensu.sensu_go 1.6.0 中添加	包含敏感数据的密钥名称。
状态字符串	Sensu 对象的预期状态。选项 `"present"` ← (默认) `"absent"`
超时整数	处理程序执行的超时时间。

另请参阅 

另请参阅

sensu.sensu_go.socket_handler: 管理 Sensu TCP/UDP 处理程序。
sensu.sensu_go.handler_info: 列出 Sensu 处理程序。
sensu.sensu_go.handler_set: 管理 Sensu 处理程序集。

示例 

- name: Setup InfluxDB handler
  sensu.sensu_go.pipe_handler:
    name: influx-db
    command: sensu-influxdb-handler -d sensu
    env_vars:
      INFLUXDB_ADDR: http://influxdb.default.svc.cluster.local:8086
      INFLUXDB_USER: sensu
      INFLUXDB_PASS: password
    runtime_assets:
      - sensu-influxdb-handler

- name: Delete  handler
  sensu.sensu_go.pipe_handler:
    name: influx-db
    state: absent

返回值 

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

键	描述
对象字典	表示 Sensu 管道处理程序的对象。返回: 成功示例: `{"command": "command-example", "metadata": {"name": "pipe_handler_minimum", "namespace": "default"}, "type": "pipe"}`

作者

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