sensu.sensu_go.silence – Manage Sensu silences

Note

This plugin is part of the sensu.sensu_go collection (version 1.12.0).

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 sensu.sensu_go.

To use it in a playbook, specify: sensu.sensu_go.silence.

New in version 1.0.0: of sensu.sensu_go

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7

Parameters

Parameter Choices/Defaults Comments
annotations
dictionary
Custom metadata fields with fewer restrictions, as key/value pairs.
These are preserved by Sensu but not accessible as tokens or identifiers, and are mainly intended for use with external tools.
auth
dictionary
Authentication parameters. Can define each of them with ENV as well.
api_key
string
added in 1.3.0 of sensu.sensu_go
The API key that should be used when authenticating. If this is not set, the value of the SENSU_API_KEY environment variable will be checked.
This replaces auth.user and auth.password parameters.
For more information about the API key, refer to the official Sensu documentation at https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
ca_path
path
added in 1.5.0 of sensu.sensu_go
Path to the CA bundle that should be used to validate the backend certificate.
If this parameter is not set, module will use the CA bundle that python is using.
It is also possible to set this parameter via the SENSU_CA_PATH environment variable.
password
string
Default:
"P@ssw0rd!"
The Sensu user's password. If this is not set the value of the SENSU_PASSWORD environment variable will be checked.
This parameter is ignored if the auth.api_key parameter is set.
url
string
Default:
"http://localhost:8080"
Location of the Sensu backend API. If this is not set the value of the SENSU_URL environment variable will be checked.
user
string
Default:
"admin"
The username to use for connecting to the Sensu API. If this is not set the value of the SENSU_USER environment variable will be checked.
This parameter is ignored if the auth.api_key parameter is set.
verify
boolean
added in 1.5.0 of sensu.sensu_go
    Choices:
  • no
  • yes
Flag that controls the certificate validation.
If you are using self-signed certificates, you can set this parameter to false.
ONLY USE THIS PARAMETER IN DEVELOPMENT SCENARIOS! In you use self-signed certificates in production, see the auth.ca_path parameter.
It is also possible to set this parameter via the SENSU_VERIFY environment variable.
begin
integer
UNIX time at which silence entry goes into effect.
check
string
The name of the check the entry should match.
If left empty a silencing entry will contain an asterisk in the check position. This indicates that any event where the originating entities subscriptions match the subscription specified in the entry will be marked as silenced, regardless of the check name.
This parameter is required if the subscription parameter is absent.
expire
integer
Number of seconds until the silence expires.
expire_on_resolve
boolean
    Choices:
  • no
  • yes
If the entry should be deleted when a check begins return OK status (resolves).
labels
dictionary
Custom metadata fields that can be accessed within Sensu, as key/value pairs.
namespace
string
Default:
"default"
RBAC namespace to operate in. If this is not set the value of the SENSU_NAMESPACE environment variable will be used.
reason
string
Reason for silencing.
state
string
    Choices:
  • present
  • absent
Target state of the Sensu object.
subscription
string
The name of the subscription the entry should match.
If left empty a silencing entry will contain an asterisk in the subscription position. This indicates that any event with a matching check name will be marked as silenced, regardless of the originating entities subscriptions.
Specific entity can also be targeted by taking advantage of per-entity subscription (entity:<entity_name>).
This parameter is required if the check parameter is absent.

See Also

See also

sensu.sensu_go.silence_info

The official documentation on the sensu.sensu_go.silence_info module.

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
object
dictionary
success
Object representing Sensu silence.

Sample:
{'begin': 1542671205, 'check': None, 'creator': 'admin', 'expire': -1, 'expire_on_resolve': False, 'metadata': {'annotations': None, 'labels': None, 'name': 'entity:i-424242:*', 'namespace': 'default'}, 'reason': None, 'subscription': 'entity:i-424242'}


Authors

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/silence_module.html