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

注意

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

sensu.sensu_go 1.0.0 中的新增功能

概要 

创建、更新或删除 Sensu 静默。
有关更多信息，请参阅 Sensu 文档：https://docs.sensu.io/sensu-go/latest/reference/silencing/。

要求 

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

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` ←（默认）
begin 整数	静默条目生效的 UNIX 时间。
check 字符串	条目应匹配的检查的名称。如果留空，静默条目将在检查位置包含星号。这表示任何事件（其中原始实体的订阅与条目中指定的订阅匹配）都将被标记为静默，而与检查名称无关。如果缺少 subscription 参数，则此参数是必需的。
expire 整数	静默过期前的秒数。
expire_on_resolve 布尔值	如果检查开始返回 OK 状态（解决），是否应删除该条目。选项 `false` `true`
labels 字典	可以在 Sensu 中访问的自定义元数据字段，以键/值对形式。默认： `{}`
namespace 字符串	要在其中操作的 RBAC 命名空间。如果未设置此项，将使用 SENSU_NAMESPACE 环境变量的值。默认： `"default"`
reason 字符串	静默的原因。
state 字符串	Sensu 目标对象的状态。选项 `"present"` ←（默认） `"absent"`
subscription 字符串	条目应匹配的订阅的名称。如果留空，静默条目将在订阅位置包含星号。这表示任何具有匹配检查名称的事件都将被标记为静默，而与原始实体的订阅无关。也可以利用每个实体的订阅 (entity:<entity_name>) 来定位特定实体。如果缺少 check 参数，则此参数是必需的。

另请参阅 

另请参阅

sensu.sensu_go.silence_info: 列出 Sensu 静默条目。

示例 

- name: Silence a specific check
  sensu.sensu_go.silence:
    subscription: proxy
    check: check-disk

- name: Silence specific check regardless of the originating entities subscription
  sensu.sensu_go.silence:
    check: check-cpu

- name: Silence all checks on a specific entity
  sensu.sensu_go.silence:
    subscription: entity:important-entity
    expire: 120
    reason: rebooting the world

- name: Delete a silencing entry
  sensu.sensu_go.silence:
    subscription: entity:important-entity
    state: absent

返回值 

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

键	描述
对象字典	表示 Sensu 静默的对象。返回: 成功示例: `{"begin": 1542671205, "check": null, "creator": "admin", "expire": -1, "expire_on_resolve": false, "metadata": {"annotations": null, "labels": null, "name": "entity:i-424242:*", "namespace": "default"}, "reason": null, "subscription": "entity:i-424242"}`

作者

Paul Arthur (@flowerysong)
Aljaz Kosir (@aljazkosir)
Manca Bizjak (@mancabizjak)
Tadej Borovsak (@tadeboro)