sensu_subscription - Manage Sensu subscriptions
New in version 2.2.
Synopsis
- Manage which sensu channels a machine should subscribe to
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| backup
bool
|
|
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
required
|
The name of the channel
|
|
| path | Default:
"/etc/sensu/conf.d/subscriptions.json"
|
Path to the subscriptions json file
|
| state |
|
Whether the machine should subscribe or unsubscribe from the channel
|
Examples
# Subscribe to the nginx channel
- name: subscribe to nginx checks
sensu_subscription: name=nginx
# Unsubscribe from the common checks channel
- name: unsubscribe from common checks
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
|
success |
the reasons why the moule changed or did not change something
Sample:
["channel subscription was absent and state is `present'"]
|
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
- Anders Ingemann
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_subscription_module.html