community.general.pingdom module – Pause/unpause Pingdom alerts

Note

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

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.pingdom.

Synopsis

  • This module will let you pause/unpause Pingdom alerts

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

checkid

string / required

Pingdom ID of the check.

key

string / required

Pingdom API key.

passwd

string / required

Pingdom user password.

state

string / required

Define whether or not the check should be running or paused.

Choices:

  • "running"

  • "paused"

  • "started"

  • "stopped"

uid

string / required

Pingdom user ID.

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

  • This module does not yet have support to add/remove checks.

Examples

- name: Pause the check with the ID of 12345
  community.general.pingdom:
    uid: example@example.com
    passwd: password123
    key: apipassword123
    checkid: 12345
    state: paused

- name: Unpause the check with the ID of 12345
  community.general.pingdom:
    uid: example@example.com
    passwd: password123
    key: apipassword123
    checkid: 12345
    state: running

Authors

  • Dylan Silva (@thaumos)

  • Justin Johns