On this page
community.general.pingdom – Pause/unpause Pingdom alerts
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.pingdom
.
Synopsis
- This module will let you pause/unpause Pingdom alerts
Requirements
The below requirements are needed on the host that executes this module.
- This pingdom python library: https://github.com/mbabineau/pingdom-python
Parameters
Parameter | Choices/Defaults | 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.
|
uid
string / required
|
Pingdom user ID.
|
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 (!UNKNOWN)
© 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/pingdom_module.html