community.general.sensu_subscription – Manage Sensu subscriptions
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.sensu_subscription.
Synopsis
- Manage which sensu channels a machine should subscribe to
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| backup
boolean
|
|
Create a backup file (if yes), including the timestamp information so you
can get the original file back if you somehow clobbered it incorrectly.
|
| name
string / required
|
The name of the channel
|
|
| path
string
|
Default:
"/etc/sensu/conf.d/subscriptions.json"
|
Path to the subscriptions json file
|
| state
string
|
|
Whether the machine should subscribe or unsubscribe from the channel
|
Examples
# Subscribe to the nginx channel
- name: Subscribe to nginx checks
community.general.sensu_subscription: name=nginx
# Unsubscribe from the common checks channel
- name: Unsubscribe from common checks
community.general.sensu_subscription: name=common state=absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| reasons
list / elements=string
|
success |
the reasons why the module changed or did not change something
Sample:
["channel subscription was absent and state is `present'"]
|
Authors
- Anders Ingemann (@andsens)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/sensu_subscription_module.html