sensu.sensu_go.event_info 模块 – 列出 Sensu 事件

注意

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

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

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

要在剧本中使用它，请指定：sensu.sensu_go.event_info。

注意

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

sensu.sensu_go 1.0.0 中的新增功能

摘要

要求

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

  • 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://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 ← (默认)

check

字符串

将结果限制为特定检查。

如果使用此参数，则也必须指定 *entity*。

entity

字符串

将结果限制为特定实体。

namespace

字符串

要在其中操作的 RBAC 命名空间。如果未设置此命名空间，则将使用 SENSU_NAMESPACE 环境变量的值。

默认值： "default"

另请参阅

另请参阅

sensu.sensu_go.event

管理 Sensu 事件。

示例

- name: List Sensu events
  sensu.sensu_go.event_info:
  register: result

- name: List Sensu events for api.example.com
  sensu.sensu_go.event_info:
    entity: api.example.com
  register: result

- name: Filter events by check and entity
  sensu.sensu_go.event_info:
    entity: api.example.com
    check: check-cpu
  register: result

返回值

公共返回值已在 此处 记录，以下是此模块特有的字段

键

描述

objects

列表 / 元素=字典

Sensu 事件列表。

返回：成功

示例： [{"check": {"check_hooks": null, "command": "check-cpu.sh -w 75 -c 90", "duration": 1.07055808, "env_vars": null, "executed": 1552594757, "handlers": [], "high_flap_threshold": 0, "history": [{"executed": 1552594757, "status": 0}], "interval": 60, "metadata": {"name": "check-cpu", "namespace": "default"}, "occurrences": 1, "occurrences_watermark": 1, "output": "CPU OK - Usage:3.96", "subscriptions": ["linux"], "timeout": 0, "total_state_change": 0, "ttl": 0}, "entity": {"deregister": false, "deregistration": {}, "entity_class": "agent", "last_seen": 1552594641, "metadata": {"name": "sensu-centos", "namespace": "default"}}, "id": "3a5948f3-6ffd-4ea2-a41e-334f4a72ca2f", "metadata": {"namespace": "default"}, "sequence": 1, "timestamp": 1552594758}]

作者

  • Paul Arthur (@flowerysong)

  • Aljaz Kosir (@aljazkosir)

  • Manca Bizjak (@mancabizjak)

  • Tadej Borovsak (@tadeboro)