# salt.returners.pushover_returner

Warning

This module will be removed from Salt in version 3009 in favor of the pushover Salt Extension.

Return salt data via pushover (http://www.pushover.net)

Added in version 2016.3.0.

The following fields can be set in the minion conf file:

    pushover.user (required)
    pushover.token (required)
    pushover.title (optional)
    pushover.device (optional)
    pushover.priority (optional)
    pushover.expire (optional)
    pushover.retry (optional)
    pushover.profile (optional)

Note

The `user` here is your user key, not the email address you use to login to pushover.net.

Alternative configuration values can be used by prefacing the configuration. Any values not found in the alternative configuration will be pulled from the default location:

    alternative.pushover.user
    alternative.pushover.token
    alternative.pushover.title
    alternative.pushover.device
    alternative.pushover.priority
    alternative.pushover.expire
    alternative.pushover.retry

PushOver settings may also be configured as:

      pushover:
          user: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
          token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
          title: Salt Returner
          device: phone
          priority: -1
          expire: 3600
          retry: 5

      alternative.pushover:
          user: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
          token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
          title: Salt Returner
          device: phone
          priority: 1
          expire: 4800
          retry: 2

      pushover_profile:
          pushover.token: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

      pushover:
          user: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
          profile: pushover_profile

      alternative.pushover:
          user: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
          profile: pushover_profile

    To use the PushOver returner, append '--return pushover' to the salt command. ex:

    .. code-block:: bash

      salt '*' test.ping --return pushover

    To use the alternative configuration, append '--return_config alternative' to the salt command. ex:

      salt '*' test.ping --return pushover --return_config alternative

To override individual configuration items, append --return_kwargs '{"key:": "value"}' to the salt command.

    salt '*' test.ping --return pushover --return_kwargs '{"title": "Salt is awesome!"}'

salt.returners.pushover_returner.returner(ret)

  Send an PushOver message with the data