mqtt - Опубликовать сообщение в MQTT-теме для IoT
Краткое описание
- Опубликовать сообщение в MQTT-теме.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- mosquitto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ca_certs (добавлено в версии 2.3) | Значение по умолчанию: Нет | Путь к файлам сертификатов Удостоверяющего центра, которые должны считаться доверенными этим клиентом. Если это единственный предоставленный вариант, клиент будет работать аналогично веб-браузеру. То есть он будет требовать, чтобы у брокера был сертификат, подписанный Удостоверяющими центрами в ca_certs, и будет осуществлять коммуникацию с помощью TLS v1, но не будет пытаться выполнить какую-либо аутентификацию. Это обеспечивает базовый шифрование сети, но может быть недостаточно в зависимости от конфигурации брокера. |
| certfile (добавлено в версии 2.3) | Значение по умолчанию: Нет | Путь к клиенту, закодированному в PEM. Если он не равен None, он будет использоваться в качестве информации о клиенте для аутентификации TLS. Поддержка этой функции зависит от брокера. |
| client_id | Значение по умолчанию: имя_хоста + pid | Идентификатор MQTT-клиента |
| keyfile (добавлено в версии 2.3) | Значение по умолчанию: Нет | Путь к PEM-закодированному приватному ключу клиента. Если он не равен None, он будет использоваться в качестве информации о клиенте для аутентификации TLS. Поддержка этой функции зависит от брокера. |
| password | Пароль для username аутентификации у брокера. | |
| payload обязательно | Значение по умолчанию: Нет | Полезная нагрузка. Специальная строка "None" может использоваться для отправки NULL (т.е. пустой) полезной нагрузки, что полезно для простого уведомления о теме или для очистки ранее сохраненных сообщений. |
| port | Значение по умолчанию: 1883 | Порт MQTT-брокера |
| qos |
0 | QoS (Качество обслуживания) |
| retain | Значение по умолчанию: нет | Установка этого флага заставляет брокер сохранять (т.е. хранить) сообщение, чтобы приложения, которые впоследствии подписываются на тему, могли получить последнее сохраненное сообщение сразу. |
| server | Значение по умолчанию: localhost | Адрес/имя MQTT-брокера |
| topic обязательно | Значение по умолчанию: Нет | Имя MQTT-темы |
| username | Имя пользователя для аутентификации у брокера. |
Примечания
Примечание
- Этот модуль требует подключения к MQTT-брокеру, такому как Mosquitto http://mosquitto.org, и Python-клиенту Paho
mqtt(https://pypi.org/project/paho-mqtt/).
Примеры
- 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.5/modules/mqtt_module.html
