New in version 2.2.
Parameter |
Choices/Defaults |
Comments |
|---|---|---|
|
backup
|
|
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
|
# 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
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'"]
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.