community.general.mqtt – Опубликовать сообщение в MQTT-теме для IoT

Примечание

Этот плагин входит в коллекцию community.general (версия 1.3.2).

Для его установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать его в книге задач, укажите: community.general.mqtt.

Обзор
Требования
Параметры
Примечания
Примеры

Обзор

Опубликовать сообщение в MQTT-теме.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

mosquitto

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ca_cert путь		Путь к файлам сертификата Удостоверяющего центра, которые должны рассматриваться этим клиентом как доверенные. Если это единственный предоставленный параметр, клиент будет работать аналогично веб-браузеру. То есть он будет требовать, чтобы у брокера был сертификат, подписанный Удостоверяющими центрами в ca_certs, и будет использовать TLS v1 для связи, но не будет пытаться выполнить какую-либо аутентификацию. Это обеспечивает базовое шифрование сети, но может быть недостаточно в зависимости от конфигурации брокера. Псевдонимы: ca_certs
client_cert путь		Путь к клиенту PEM-кодированный сертификат. Если это не None, он будет использоваться в качестве информации о клиенте для аутентификации на основе TLS. Поддержка этой функции зависит от брокера. Псевдонимы: certfile
client_id строка		Идентификатор MQTT-клиента Если не указано, будет использовано значение `hostname + pid`.
client_key путь		Путь к клиенту PEM-кодированный закрытый ключ. Если это не None, он будет использоваться в качестве информации о клиенте для аутентификации на основе TLS. Поддержка этой функции зависит от брокера. Псевдонимы: keyfile
password строка		Пароль для `username` для аутентификации у брокера.
payload строка / обязательно		Загрузка. Специальная строка `"None"` может использоваться для отправки пустой загрузки (т.е. пустой), что полезно для простого уведомления с помощью topic или для удаления ранее сохраненных сообщений.
port целое число	По умолчанию: 1883	Номер порта MQTT-брокера
qos строка	Варианты: 0 ← 1 2	QoS (Качество обслуживания)
retain логическое значение	Варианты: нет ← да	Установив этот флаг, брокер сохранит (т.е. сохранит) сообщение, чтобы приложения, которые впоследствии подпишутся на тему, могли получить последнее сохранённое сообщение немедленно.
server строка	По умолчанию: "localhost"	Адрес/имя MQTT-брокера
tls_version строка	Варианты: tlsv1.1 tlsv1.2	Указывает версию протокола SSL/TLS, который будет использоваться. По умолчанию (если это поддерживается версией Python) определяется наивысшая версия TLS. Если она недоступна, используется TLS v1.
topic строка / обязательно		Имя MQTT-темы
username строка		Имя пользователя для аутентификации у брокера.

Примечания

Примечание

Для этого модуля требуется подключение к MQTT-брокеру, такому как Mosquitto http://mosquitto.org, и клиенту Python Paho mqtt (https://pypi.org/project/paho-mqtt/).

Примеры

- 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

Авторы

Jan-Piet Mens (@jpmens)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/mqtt_module.html