W3cubDocs

/Ansible

uptimerobot - Pause and start Uptime Robot monitoring

New in version 1.9.

Synopsis

  • This module will let you start and pause Uptime Robot Monitoring

Requirements (on host that executes module)

  • Valid Uptime Robot API Key

Options

parameter required default choices comments
apikey
yes
Uptime Robot API key.
monitorid
yes
ID of the monitor to check.
state
yes
  • started
  • paused
Define whether or not the monitor should be running or paused.

Examples

# Pause the monitor with an ID of 12345.
- uptimerobot:
    monitorid: 12345
    apikey: 12345-1234512345
    state: paused

# Start the monitor with an ID of 12345.
- uptimerobot:
    monitorid: 12345
    apikey: 12345-1234512345
    state: started

Notes

Note

  • Support for adding and removing monitors and alert contacts has not yet been implemented.

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–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/uptimerobot_module.html