New in version 2.2.
parameter | required | default | choices | comments |
---|---|---|---|---|
backup |
no |
|
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 |
yes | The name of the channel | ||
path |
no | /etc/sensu/conf.d/subscriptions.json | Path to the subscriptions json file | |
state |
no | present |
|
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 Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
reasons | the reasons why the moule changed or did not change something | success | list | ["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.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.