mqtt - Опубликовать сообщение в MQTT-теме для IoT
Обзор
- Опубликовать сообщение в MQTT-теме.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- mosquitto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ca_certs (добавлено в версии 2.3) | Путь к файлам сертификатов Удостоверяющего центра, которые будут считаться доверенными этим клиентом. Если это единственный указанный параметр, клиент будет работать аналогично веб-браузеру. Это означает, что он потребует от брокера наличие сертификата, подписанного Удостоверяющим центром в ca_certs, и будет использовать TLS версии 1, но не будет пытаться выполнить какой-либо вид аутентификации. Это обеспечивает базовый шифрование сети, но может быть недостаточно в зависимости от настроек брокера. | |
| certfile (добавлено в версии 2.3) | Путь к клиенту PEM-кодированному сертификату. Если этот параметр не равен None, он будет использоваться как информация клиента для аутентификации на основе TLS. Поддержка этой функции зависит от брокера. | |
| client_id | Значение по умолчанию: "имя хоста + PID" | Идентификатор MQTT-клиента |
| keyfile (добавлено в версии 2.3) | Путь к PEM-кодированному приватному ключу клиента. Если этот параметр не равен None, он будет использоваться как информация клиента для аутентификации на основе TLS. Поддержка этой функции зависит от брокера. | |
| password | Пароль для username аутентификации у брокера. | |
| payload обязательно | Полезная нагрузка. Специальная строка "None" может быть использована для отправки нулевой (т.е. пустой) полезной нагрузки, что полезно для простого уведомления по теме или для удаления ранее сохраненных сообщений. | |
| port | Значение по умолчанию: 1883 | Номер порта MQTT-брокера |
| qos |
0 | QoS (Качество обслуживания) |
| retain bool |
| Установка этого флага заставляет брокер сохранять (т.е. хранить) сообщение, чтобы приложения, которые впоследствии подпишутся на тему, могли сразу получить последнее сохраненное сообщение. |
| 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
Статус
Этот модуль помечен как предварительный просмотр, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что его поддерживает сообщество Ansible. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- 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.6/modules/mqtt_module.html
