community.general.pushover module – Send notifications through https://pushover.net

Note

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

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

Synopsis

  • Send notifications through pushover to subscriber list of devices and email addresses. Requires pushover app on devices.

Parameters

Parameter

Comments

app_token

string / required

Pushover issued token identifying your pushover app.

device

string

added in community.general 1.2.0

A device the message should be sent to. Multiple devices can be specified, separated by a comma.

msg

string / required

What message you wish to send.

pri

string

Message priority (see https://pushover.net for details).

Choices:

  • "-2"

  • "-1"

  • "0" ← (default)

  • "1"

  • "2"

title

string

Message title.

user_key

string / required

Pushover issued authentication key for your user.

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

  • You need a pushover.net account to use this module. But no account is required to receive messages.

Examples

- name: Send notifications via pushover.net
  community.general.pushover:
    msg: '{{ inventory_hostname }} is acting strange ...'
    app_token: wxfdksl
    user_key: baa5fe97f2c5ab3ca8f0bb59
  delegate_to: localhost

- name: Send notifications via pushover.net
  community.general.pushover:
    title: 'Alert!'
    msg: '{{ inventory_hostname }} has exploded in flames, It is now time to panic'
    pri: 1
    app_token: wxfdksl
    user_key: baa5fe97f2c5ab3ca8f0bb59
  delegate_to: localhost

- name: Send notifications via pushover.net to a specific device
  community.general.pushover:
    msg: '{{ inventory_hostname }} has been lost somewhere'
    app_token: wxfdksl
    user_key: baa5fe97f2c5ab3ca8f0bb59
    device: admins-iPhone
  delegate_to: localhost

Authors

  • Jim Richardson (@weaselkeeper)

  • Bernd Arnold (@wopfel)