community.general.sensu_silence 模块 – 管理 Sensu 静默条目

注意

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

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

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

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

概要

  • 通过 Sensu API 为订阅和检查创建和清除（删除）静默条目。

参数

参数

注释

check

字符串

指定静默条目适用的检查。

creator

字符串

指定负责此条目的实体。

expire

整数

如果指定，静默条目将在该秒数后自动清除。

expire_on_resolve

布尔值

如果指定为 true，则一旦静默的条件得到解决，静默条目将自动清除。

选择

  • false

  • true

reason

字符串

如果指定，此自由格式字符串用于为创建此静默条目的原因提供上下文或基本原理。

state

字符串

指定通过 Sensu API 创建或清除（删除）静默条目

选择

  • "present" ←（默认）

  • "absent"

subscription

字符串 / 必需

指定静默条目适用的订阅。

要为客户端创建静默条目，请在客户端名称前加上 client:。示例 - client:server1.example.dev

url

字符串

指定 Sensu 监视主机服务器的 URL。

默认值： "http://127.0.01:4567"

属性

属性

支持

描述

check_mode

支持： 完全

可以在 check_mode 下运行，并返回更改的状态预测，而无需修改目标。

diff_mode

支持： 无

当处于差异模式时，将返回有关已更改的内容（或可能需要在 check_mode 中更改的内容）的详细信息。

示例

# Silence ALL checks for a given client
- name: Silence server1.example.dev
  community.general.sensu_silence:
    subscription: client:server1.example.dev
    creator: "{{ ansible_user_id }}"
    reason: Performing maintenance

# Silence specific check for a client
- name: Silence CPU_Usage check for server1.example.dev
  community.general.sensu_silence:
    subscription: client:server1.example.dev
    check: CPU_Usage
    creator: "{{ ansible_user_id }}"
    reason: Investigation alert issue

# Silence multiple clients from a dict
  silence:
    server1.example.dev:
      reason: 'Deployment in progress'
    server2.example.dev:
      reason: 'Deployment in progress'

- name: Silence several clients from a dict
  community.general.sensu_silence:
    subscription: "client:{{ item.key }}"
    reason: "{{ item.value.reason }}"
    creator: "{{ ansible_user_id }}"
  with_dict: "{{ silence }}"

作者

  • Steven Bambling (@smbambling)