community.general.sensu_silence module – Manage Sensu silence entries
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.sensu_silence
.
Synopsis
Create and clear (delete) a silence entries via the Sensu API for subscriptions and checks.
Aliases: monitoring.sensu.sensu_silence
Parameters
Parameter |
Comments |
---|---|
Specifies the check which the silence entry applies to. |
|
Specifies the entity responsible for this entry. |
|
If specified, the silence entry will be automatically cleared after this number of seconds. |
|
If specified as true, the silence entry will be automatically cleared once the condition it is silencing is resolved. Choices:
|
|
If specified, this free-form string is used to provide context or rationale for the reason this silence entry was created. |
|
Specifies to create or clear (delete) a silence entry via the Sensu API Choices:
|
|
Specifies the subscription which the silence entry applies to. To create a silence entry for a client prepend |
|
Specifies the URL of the Sensu monitoring host server. Default: |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
# 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 }}"