sensu_subscription - Manage Sensu subscriptions
New in version 2.2.
Synopsis
- Manage which sensu channels a machine should subscribe to
Options
| 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
|
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 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'"] |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/sensu_subscription_module.html