community.general.uptimerobot – Pause and start Uptime Robot monitoring
Note
This plugin is part of the community.general collection (version 3.8.1).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.general.
To use it in a playbook, specify: community.general.uptimerobot.
Synopsis
- This module will let you start and pause Uptime Robot Monitoring
Requirements
The below requirements are needed on the host that executes this module.
- Valid Uptime Robot API Key
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| apikey
string / required
|
Uptime Robot API key.
|
|
| monitorid
string / required
|
ID of the monitor to check.
|
|
| state
string / required
|
|
Define whether or not the monitor should be running or paused.
|
Notes
Note
- Support for adding and removing monitors and alert contacts has not yet been implemented.
Examples
- name: Pause the monitor with an ID of 12345
community.general.uptimerobot:
monitorid: 12345
apikey: 12345-1234512345
state: paused
- name: Start the monitor with an ID of 12345
community.general.uptimerobot:
monitorid: 12345
apikey: 12345-1234512345
state: started
Authors
- Nate Kingsley (@nate-kingsley)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/uptimerobot_module.html