Gecko [ goons4good.org ]

Name	Size	Permission	Date
__pycache__	[ DIR ]	drwxr-xr-x	2022-10-11 05:09
__init__.py	5.98 KB	-rw-r--r--	2022-05-16 09:16
appoptics_return.py	6.11 KB	-rw-r--r--	2022-05-16 09:16
carbon_return.py	8.24 KB	-rw-r--r--	2022-05-16 09:16
cassandra_cql_return.py	15.17 KB	-rw-r--r--	2022-05-16 09:16
cassandra_return.py	2.07 KB	-rw-r--r--	2022-05-16 09:16
couchbase_return.py	8.91 KB	-rw-r--r--	2022-05-16 09:16
couchdb_return.py	10.35 KB	-rw-r--r--	2022-05-16 09:16
django_return.py	2.27 KB	-rw-r--r--	2022-05-16 09:16
elasticsearch_return.py	12.18 KB	-rw-r--r--	2022-05-16 09:16
etcd_return.py	6.32 KB	-rw-r--r--	2022-05-16 09:16
highstate_return.py	15.59 KB	-rw-r--r--	2022-05-16 09:16
influxdb_return.py	8.03 KB	-rw-r--r--	2022-05-16 09:16
kafka_return.py	2.12 KB	-rw-r--r--	2022-05-16 09:16
librato_return.py	4.29 KB	-rw-r--r--	2022-05-16 09:16
local.py	541 B	-rw-r--r--	2022-05-16 09:16
local_cache.py	17.1 KB	-rw-r--r--	2022-05-16 09:16
mattermost_returner.py	4.08 KB	-rw-r--r--	2022-05-16 09:16
memcache_return.py	5.72 KB	-rw-r--r--	2022-05-16 09:16
mongo_future_return.py	10.08 KB	-rw-r--r--	2022-05-16 09:16
mongo_return.py	6.11 KB	-rw-r--r--	2022-05-16 09:16
multi_returner.py	2.82 KB	-rw-r--r--	2022-05-16 09:16
mysql.py	18.61 KB	-rw-r--r--	2022-05-16 09:16
nagios_nrdp_return.py	4.92 KB	-rw-r--r--	2022-05-16 09:16
odbc.py	7.77 KB	-rw-r--r--	2022-05-16 09:16
pgjsonb.py	17.18 KB	-rw-r--r--	2022-05-16 09:16
postgres.py	10.2 KB	-rw-r--r--	2022-05-16 09:16
postgres_local_cache.py	10.73 KB	-rw-r--r--	2022-05-16 09:16
pushover_returner.py	6.55 KB	-rw-r--r--	2022-05-16 09:16
rawfile_json.py	2.23 KB	-rw-r--r--	2022-05-16 09:16
redis_return.py	8.52 KB	-rw-r--r--	2022-05-16 09:16
sentry_return.py	5.3 KB	-rw-r--r--	2022-05-16 09:16
slack_returner.py	6.02 KB	-rw-r--r--	2022-05-16 09:16
slack_webhook_return.py	11.22 KB	-rw-r--r--	2022-05-16 09:16
sms_return.py	2.64 KB	-rw-r--r--	2022-05-16 09:16
smtp_return.py	8.2 KB	-rw-r--r--	2022-05-16 09:16
splunk.py	6.69 KB	-rw-r--r--	2022-05-16 09:16
sqlite3_return.py	7.73 KB	-rw-r--r--	2022-05-16 09:16
syslog_return.py	5.26 KB	-rw-r--r--	2022-05-16 09:16
telegram_return.py	1.92 KB	-rw-r--r--	2022-05-16 09:16
xmpp_return.py	4.85 KB	-rw-r--r--	2022-05-16 09:16
zabbix_return.py	2.45 KB	-rw-r--r--	2022-05-16 09:16

Rename

"""
Return data by SMS.

.. versionadded:: 2015.5.0

:maintainer:    Damian Myerscough
:maturity:      new
:depends:       twilio
:platform:      all

To enable this returner the minion will need the python twilio library
installed and the following values configured in the minion or master
config:

.. code-block:: yaml

twilio.sid: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
    twilio.token: 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
    twilio.to: '+1415XXXXXXX'
    twilio.from: '+1650XXXXXXX'

To use the sms returner, append '--return sms' to the salt command.

.. code-block:: bash

salt '*' test.ping --return sms

"""

import logging

import salt.returners

log = logging.getLogger(__name__)

try:
    import twilio

# Grab version, ensure elements are ints
    twilio_version = tuple([int(x) for x in twilio.__version_info__])
    if twilio_version > (5,):
        TWILIO_5 = False
        from twilio.rest import Client as TwilioRestClient
        from twilio.rest import TwilioException as TwilioRestException
    else:
        TWILIO_5 = True
        from twilio.rest import TwilioRestClient
        from twilio import TwilioRestException  # pylint: disable=no-name-in-module

HAS_TWILIO = True
except ImportError:
    HAS_TWILIO = False

__virtualname__ = "sms"

def __virtual__():
    if HAS_TWILIO:
        return __virtualname__

return False, "Could not import sms returner; twilio is not installed."

def _get_options(ret=None):
    """
    Get the Twilio options from salt.
    """
    attrs = {"sid": "sid", "token": "token", "to": "to", "from": "from"}

_options = salt.returners.get_returner_options(
        __virtualname__, ret, attrs, __salt__=__salt__, __opts__=__opts__
    )
    return _options

def returner(ret):
    """
    Return a response in an SMS message
    """
    _options = _get_options(ret)

sid = _options.get("sid", None)
    token = _options.get("token", None)
    sender = _options.get("from", None)
    receiver = _options.get("to", None)

if sid is None or token is None:
        log.error("Twilio sid/authentication token missing")
        return None

if sender is None or receiver is None:
        log.error("Twilio to/from fields are missing")
        return None

client = TwilioRestClient(sid, token)

try:
        message = client.messages.create(
            body="Minion: {}\nCmd: {}\nSuccess: {}\n\nJid: {}".format(
                ret["id"], ret["fun"], ret["success"], ret["jid"]
            ),
            to=receiver,
            from_=sender,
        )
    except TwilioRestException as e:
        log.error("Twilio [https://www.twilio.com/docs/errors/%s]", e.code)
        return False

return True