On this page
community.general.pushbullet – Sends notifications to Pushbullet
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.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 | Choices/Defaults | 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.
         | 
     
| title
        
        string / required
         | 
      
        
        Title of the notification.
         | 
     |
| url
        
        string
         | 
      
        
        URL field, used when push_type is  link.
        | 
     
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)
 
© 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/pushbullet_module.html