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
-
|
Пароль для аутентификации с брокером.
|
|
|
payload
- / обязательно
|
Полезная нагрузка. Специальная строка
"None" может использоваться для отправки NULL (т.е. пустой) полезной нагрузки, что полезно для простого уведомления с помощью темы или для очистки ранее сохраненных сообщений. |
|
|
port
-
|
По умолчанию: 1883
|
Номер порта брокера MQTT
|
|
qos
-
|
0
|
QoS (Качество обслуживания)
|
|
retain
boolean
|
|
Установка этого флага заставляет брокера сохранять (т.е. хранить) сообщение, чтобы приложения, которые впоследствии подпишутся на тему, могли немедленно получить последнее сохраненное сообщение.
|
|
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 поддержка модулей. [сообщество]
Авторы
- 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.7/modules/mqtt_module.html
