mqtt – Опубликовать сообщение в MQTT-теме для IoT
Обзор
- Опубликовать сообщение в MQTT-теме.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- mosquitto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
|
ca_cert
-
|
Путь к файлам сертификата Удостоверяющего центра, которые должны считаться доверенными этим клиентом. Если это единственный указанный параметр, клиент будет работать аналогично веб-браузеру. То есть, он потребует, чтобы у брокера был сертификат, подписанный Удостоверяющими центрами в ca_certs, и будет взаимодействовать с использованием TLS v1, но не будет пытаться выполнить какой-либо вид аутентификации. Это обеспечивает базовую шифрование сети, но может быть недостаточно в зависимости от конфигурации брокера.
Псевдонимы: ca_certs |
|
|
client_cert
-
|
Путь к клиенту сертификату в формате PEM. Если это не None, он будет использоваться как информация о клиенте для аутентификации TLS. Поддержка этой функции зависит от брокера.
Псевдонимы: certfile |
|
|
client_id
-
|
По умолчанию: "имя хоста + pid"
|
Идентификатор MQTT-клиента
|
|
client_key
-
|
Путь к приватному ключу клиента в формате PEM. Если это не None, он будет использоваться как информация о клиенте для аутентификации TLS. Поддержка этой функции зависит от брокера.
Псевдонимы: keyfile |
|
|
password
-
|
Пароль для аутентификации у брокера.
|
|
|
payload
- / обязательно
|
Загрузка. Специальная строка
"None" может использоваться для отправки пустого (i.e. пустого) полезного груза, что полезно, чтобы просто уведомить по теме или очистить ранее сохранённые сообщения. |
|
|
port
-
|
По умолчанию: 1883
|
Порт MQTT-брокера
|
|
qos
-
|
0
|
QoS (Качество обслуживания)
|
|
retain
boolean
|
|
Установка этого флага заставляет брокера сохранять (т.е. сохранять) сообщение, чтобы приложения, которые впоследствии подписываются на тему, могли сразу получить последнее сохраненное сообщение.
|
|
server
-
|
По умолчанию: "localhost"
|
Адрес/имя MQTT-брокера
|
|
tls_version
строка
добавлено в 2.9
|
|
Указывает версию протокола SSL/TLS, которая должна использоваться.
По умолчанию (если версия Python его поддерживает) обнаруживается самая высокая версия TLS. Если недоступна, используется TLS v1.
|
|
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.9/modules/mqtt_module.html
