You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.pushbullet module – Sends notifications to Pushbullet

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

Synopsis

• This module sends push notifications via Pushbullet to channels or devices.

Requirements

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

• pushbullet.py

Parameters

Parameter	Comments
api_key string / required	Push bullet API token
body string	Body of the notification, e.g. Details of the fault you’re alerting.
channel string	The channel TAG you wish to broadcast a push notification, as seen on the “My Channels” > “Edit your channel” at Pushbullet page.
device string	The device NAME you wish to send a push notification, as seen on the Pushbullet main page.
push_type string	Thing you wish to push. Choices: "note" ← (default) "link"
title string / required	Title of the notification.
url string	URL field, used when push_type is link.

Attributes

Attribute	Support	Description
check_mode	Support: full	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

• Requires pushbullet.py Python package on the remote host. You can install it via pip with ($ pip install pushbullet.py). See https://github.com/randomchars/pushbullet.py

Examples

- name: Sends a push notification to a device
  community.general.pushbullet:
    api_key: "ABC123abc123ABC123abc123ABC123ab"
    device: "Chrome"
    title: "You may see this on Google Chrome"

- name: Sends a link to a device
  community.general.pushbullet:
    api_key: ABC123abc123ABC123abc123ABC123ab
    device: Chrome
    push_type: link
    title: Ansible Documentation
    body: https://docs.ansible.com/

- name: Sends a push notification to a channel
  community.general.pushbullet:
    api_key: ABC123abc123ABC123abc123ABC123ab
    channel: my-awesome-channel
    title: Broadcasting a message to the #my-awesome-channel folks

- name: Sends a push notification with title and body to a channel
  community.general.pushbullet:
    api_key: ABC123abc123ABC123abc123ABC123ab
    channel: my-awesome-channel
    title: ALERT! Signup service is down
    body: Error rate on signup service is over 90% for more than 2 minutes

Authors

• Willy Barro (@willybarro)

Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication