mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 20:31:27 -07:00
Relocating extras into lib/ansible/modules/ after merge
This commit is contained in:
James Cammarata
Matt Clay
parent
c65ba07d2c
commit
011ea55a8f
596 changed files with 0 additions and 266 deletions
216
lib/ansible/modules/notification/mqtt.py
Normal file
216
lib/ansible/modules/notification/mqtt.py
Normal file
|
|
@ -0,0 +1,216 @@
|
|||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# (c) 2013, 2014, Jan-Piet Mens <jpmens () gmail.com>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
|
||||
ANSIBLE_METADATA = {'status': ['preview'],
|
||||
'supported_by': 'community',
|
||||
'version': '1.0'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: mqtt
|
||||
short_description: Publish a message on an MQTT topic for the IoT
|
||||
version_added: "1.2"
|
||||
description:
|
||||
- Publish a message on an MQTT topic.
|
||||
options:
|
||||
server:
|
||||
description:
|
||||
- MQTT broker address/name
|
||||
required: false
|
||||
default: localhost
|
||||
port:
|
||||
description:
|
||||
- MQTT broker port number
|
||||
required: false
|
||||
default: 1883
|
||||
username:
|
||||
description:
|
||||
- Username to authenticate against the broker.
|
||||
required: false
|
||||
password:
|
||||
description:
|
||||
- Password for C(username) to authenticate against the broker.
|
||||
required: false
|
||||
client_id:
|
||||
description:
|
||||
- MQTT client identifier
|
||||
required: false
|
||||
default: hostname + pid
|
||||
topic:
|
||||
description:
|
||||
- MQTT topic name
|
||||
required: true
|
||||
default: null
|
||||
payload:
|
||||
description:
|
||||
- Payload. The special string C("None") may be used to send a NULL
|
||||
(i.e. empty) payload which is useful to simply notify with the I(topic)
|
||||
or to clear previously retained messages.
|
||||
required: true
|
||||
default: null
|
||||
qos:
|
||||
description:
|
||||
- QoS (Quality of Service)
|
||||
required: false
|
||||
default: 0
|
||||
choices: [ "0", "1", "2" ]
|
||||
retain:
|
||||
description:
|
||||
- Setting this flag causes the broker to retain (i.e. keep) the message so that
|
||||
applications that subsequently subscribe to the topic can received the last
|
||||
retained message immediately.
|
||||
required: false
|
||||
default: False
|
||||
ca_certs:
|
||||
description:
|
||||
- The path to the Certificate Authority certificate files that are to be
|
||||
treated as trusted by this client. If this is the only option given
|
||||
then the client will operate in a similar manner to a web browser. That
|
||||
is to say it will require the broker to have a certificate signed by the
|
||||
Certificate Authorities in ca_certs and will communicate using TLS v1,
|
||||
but will not attempt any form of authentication. This provides basic
|
||||
network encryption but may not be sufficient depending on how the broker
|
||||
is configured.
|
||||
required: False
|
||||
default: None
|
||||
version_added: 2.3
|
||||
certfile:
|
||||
description:
|
||||
- The path pointing to the PEM encoded client certificate. If this is not
|
||||
None it will be used as client information for TLS based
|
||||
authentication. Support for this feature is broker dependent.
|
||||
required: False
|
||||
default: None
|
||||
version_added: 2.3
|
||||
keyfile:
|
||||
description:
|
||||
- The path pointing to the PEM encoded client private key. If this is not
|
||||
None it will be used as client information for TLS based
|
||||
authentication. Support for this feature is broker dependent.
|
||||
required: False
|
||||
default: None
|
||||
version_added: 2.3
|
||||
|
||||
|
||||
# informational: requirements for nodes
|
||||
requirements: [ mosquitto ]
|
||||
notes:
|
||||
- This module requires a connection to an MQTT broker such as Mosquitto
|
||||
U(http://mosquitto.org) and the I(Paho) C(mqtt) Python client (U(https://pypi.python.org/pypi/paho-mqtt)).
|
||||
author: "Jan-Piet Mens (@jpmens)"
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- local_action: mqtt
|
||||
topic=service/ansible/{{ ansible_hostname }}
|
||||
payload="Hello at {{ ansible_date_time.iso8601 }}"
|
||||
qos=0
|
||||
retain=false
|
||||
client_id=ans001
|
||||
'''
|
||||
|
||||
# ===========================================
|
||||
# MQTT module support methods.
|
||||
#
|
||||
|
||||
HAS_PAHOMQTT = True
|
||||
try:
|
||||
import socket
|
||||
import paho.mqtt.publish as mqtt
|
||||
except ImportError:
|
||||
HAS_PAHOMQTT = False
|
||||
|
||||
# ===========================================
|
||||
# Main
|
||||
#
|
||||
|
||||
def main():
|
||||
|
||||
module = AnsibleModule(
|
||||
argument_spec=dict(
|
||||
server = dict(default = 'localhost'),
|
||||
port = dict(default = 1883, type='int'),
|
||||
topic = dict(required = True),
|
||||
payload = dict(required = True),
|
||||
client_id = dict(default = None),
|
||||
qos = dict(default="0", choices=["0", "1", "2"]),
|
||||
retain = dict(default=False, type='bool'),
|
||||
username = dict(default = None),
|
||||
password = dict(default = None, no_log=True),
|
||||
ca_certs = dict(default = None, type='path'),
|
||||
certfile = dict(default = None, type='path'),
|
||||
keyfile = dict(default = None, type='path'),
|
||||
),
|
||||
supports_check_mode=True
|
||||
)
|
||||
|
||||
if not HAS_PAHOMQTT:
|
||||
module.fail_json(msg="Paho MQTT is not installed")
|
||||
|
||||
server = module.params.get("server", 'localhost')
|
||||
port = module.params.get("port", 1883)
|
||||
topic = module.params.get("topic")
|
||||
payload = module.params.get("payload")
|
||||
client_id = module.params.get("client_id", '')
|
||||
qos = int(module.params.get("qos", 0))
|
||||
retain = module.params.get("retain")
|
||||
username = module.params.get("username", None)
|
||||
password = module.params.get("password", None)
|
||||
ca_certs = module.params.get("ca_certs", None)
|
||||
certfile = module.params.get("certfile", None)
|
||||
keyfile = module.params.get("keyfile", None)
|
||||
|
||||
if client_id is None:
|
||||
client_id = "%s_%s" % (socket.getfqdn(), os.getpid())
|
||||
|
||||
if payload and payload == 'None':
|
||||
payload = None
|
||||
|
||||
auth=None
|
||||
if username is not None:
|
||||
auth = { 'username' : username, 'password' : password }
|
||||
|
||||
tls=None
|
||||
if ca_certs is not None:
|
||||
tls = {'ca_certs': ca_certs, 'certfile': certfile,
|
||||
'keyfile': keyfile}
|
||||
|
||||
try:
|
||||
rc = mqtt.single(topic, payload,
|
||||
qos=qos,
|
||||
retain=retain,
|
||||
client_id=client_id,
|
||||
hostname=server,
|
||||
port=port,
|
||||
auth=auth,
|
||||
tls=tls)
|
||||
except Exception:
|
||||
e = get_exception()
|
||||
module.fail_json(msg="unable to publish to MQTT broker %s" % (e))
|
||||
|
||||
module.exit_json(changed=False, topic=topic)
|
||||
|
||||
# import module snippets
|
||||
from ansible.module_utils.basic import *
|
||||
from ansible.module_utils.pycompat24 import get_exception
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Add table
Add a link
Reference in a new issue