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
参数
参数 |
注释 |
|---|---|
具有较少限制的自定义元数据字段，作为键值对。 这些由 Sensu 保留，但不能作为令牌或标识符访问，主要用于外部工具。 默认值： |
|
身份验证参数。也可以使用 ENV 定义每个参数。 |
|
身份验证时应使用的 API 密钥。如果未设置此值，则将检查 SENSU_API_KEY 环境变量的值。 这替换了 *auth.user* 和 *auth.password* 参数。 有关 API 密钥的更多信息，请参阅 Sensu 官方文档 https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/。 |
|
应用于验证后端证书的 CA 捆绑包的路径。 如果未设置此参数，模块将使用 python 正在使用的 CA 捆绑包。 也可以通过 *SENSU_CA_PATH* 环境变量设置此参数。 |
|
Sensu 用户的密码。如果未设置此值，则将检查 SENSU_PASSWORD 环境变量的值。 如果设置了 *auth.api_key* 参数，则忽略此参数。 默认值： |
|
Sensu 后端 API 的位置。如果未设置此值，则将检查 SENSU_URL 环境变量的值。 默认值： |
|
用于连接到 Sensu API 的用户名。如果未设置此值，则将检查 SENSU_USER 环境变量的值。 如果设置了 *auth.api_key* 参数，则忽略此参数。 默认值： |
|
控制证书验证的标志。 如果您使用的是自签名证书，可以将此参数设置为 仅在开发场景中使用此参数！如果您在生产环境中使用自签名证书，请参见 *auth.ca_path* 参数。 也可以通过 *SENSU_VERIFY* 环境变量设置此参数。 选项
|
|
静默条目生效的 UNIX 时间戳。 |
|
条目应匹配的检查名称。 如果留空，静默条目将在检查位置包含一个星号。这表示任何源实体订阅与条目中指定的订阅匹配的事件都将被标记为静默，而不管检查名称如何。 如果缺少 *subscription* 参数，则需要此参数。 |
|
静默过期之前的秒数。 |
|
当检查开始返回 OK 状态（已解决）时，是否应删除条目。 选项
|
|
可在 Sensu 中访问的自定义元数据字段，作为键值对。 默认值： |
|
要在其中操作的 RBAC 命名空间。如果未设置此值，则将使用 SENSU_NAMESPACE 环境变量的值。 默认值： |
|
静默的原因。 |
|
Sensu 对象的目标状态。 选项
|
|
条目应匹配的订阅名称。 如果留空，静默条目将在订阅位置包含一个星号。这表示任何具有匹配检查名称的事件都将被标记为静默，而不管源实体订阅如何。 还可以通过利用每个实体订阅 (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 静默的对象。 已返回：成功 示例： |