Docs4dev
Docs
ansible / 2.6 / modules / sensu_silence_module.html

sensu_silence - Manage Sensu silence entries

New in version 2.4.

Synopsis

  • Create and clear (delete) a silence entries via the Sensu API for subscriptions and checks.

Parameters

Parameter Choices/Defaults Comments
check
Specifies the check which the silence entry applies to.
creator
Specifies the entity responsible for this entry.
expire
If specified, the silence entry will be automatically cleared after this number of seconds.
expire_on_resolve
bool
    Choices:
  • no
  • yes
If specified as true, the silence entry will be automatically cleared once the condition it is silencing is resolved.
reason
If specified, this free-form string is used to provide context or rationale for the reason this silence entry was created.
state
required
    Choices:
  • present ←
  • absent
Specifies to create or clear (delete) a silence entry via the Sensu API
subscription
required
Default:
[]
Specifies the subscription which the silence entry applies to.
To create a silence entry for a client append client: to client name. Example - client:server1.example.dev
url Default:
"http://127.0.01:4567"
Specifies the URL of the Sensu monitoring host server.

Examples

# Silence ALL checks for a given client
- name: Silence server1.example.dev
  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
  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
  sensu_silence:
    subscription: "client:{{ item.key }}"
    reason: "{{ item.value.reason }}"
    creator: "{{ ansible_user_id }}"
  with_dict: "{{ silence }}"

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author

  • Steven Bambling(@smbambling)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/sensu_silence_module.html