community.general.uptimerobot module – Pause and start Uptime Robot monitoring

Note

This module is part of the community.general collection (version 6.6.2).

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. You need further requirements to be able to use this module, see Requirements for details.

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

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.

Choices:

  • "started"

  • "paused"

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

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)