community.general.mqtt – Publish a message on an MQTT topic for the IoT

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

Synopsis

Publish a message on an MQTT topic.

Requirements

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

mosquitto

Parameters

Parameter	Choices/Defaults	Comments
ca_cert path		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. aliases: ca_certs
client_cert path		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. aliases: certfile
client_id string		MQTT client identifier If not specified, a value `hostname + pid` will be used.
client_key path		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. aliases: keyfile
password string		Password for `username` to authenticate against the broker.
payload string / required		Payload. The special string `"None"` may be used to send a NULL (i.e. empty) payload which is useful to simply notify with the topic or to clear previously retained messages.
port integer	Default: 1883	MQTT broker port number
qos string	Choices: 0 ← 1 2	QoS (Quality of Service)
retain boolean	Choices: no ← yes	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.
server string	Default: "localhost"	MQTT broker address/name
tls_version string	Choices: tlsv1.1 tlsv1.2	Specifies the version of the SSL/TLS protocol to be used. By default (if the python version supports it) the highest TLS version is detected. If unavailable, TLS v1 is used.
topic string / required		MQTT topic name
username string		Username to authenticate against the broker.

Notes

Note

This module requires a connection to an MQTT broker such as Mosquitto http://mosquitto.org and the Paho mqtt Python client (https://pypi.org/project/paho-mqtt/).

Examples

- name: Publish a message on an MQTT topic
  community.general.mqtt:
    topic: 'service/ansible/{{ ansible_hostname }}'
    payload: 'Hello at {{ ansible_date_time.iso8601 }}'
    qos: 0
    retain: False
    client_id: ans001
  delegate_to: localhost

Authors

Jan-Piet Mens (@jpmens)

© 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/mqtt_module.html

Docs

Docs4dev

Title here