mqtt – Опубликовать сообщение в теме MQTT для IoT
Описание
- Опубликовать сообщение в теме MQTT.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- mosquitto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ca_cert - Добавлен в 2.3 | Путь к файлам сертификатов Удостоверяющего центра, которые должны считаться доверенными этим клиентом. Если это единственный заданный параметр, клиент будет работать аналогично веб-браузеру. То есть он будет требовать, чтобы у брокера был сертификат, подписанный Удостоверяющими центрами в ca_certs, и будет осуществлять связь с использованием TLS v1, но не будет пытаться выполнить какую-либо аутентификацию. Это обеспечивает базовый шифрование сети, но может быть недостаточно в зависимости от настроек брокера. Псевдонимы: ca_certs | |
| client_cert - Добавлен в 2.3 | Путь к PEM-кодированному сертификату клиента. Если это не None, он будет использоваться в качестве информации о клиенте для аутентификации TLS. Поддержка этой функции зависит от брокера. Псевдонимы: certfile | |
| client_id - | По умолчанию: "имя_хоста + pid" | Идентификатор клиента MQTT |
| client_key - Добавлен в 2.3 | Путь к PEM-кодированному приватному ключу клиента. Если это не None, он будет использоваться в качестве информации о клиенте для аутентификации TLS. Поддержка этой функции зависит от брокера. Псевдонимы: keyfile | |
| password - | Пароль для username аутентификации у брокера. | |
| payload - / обязательно | Полезная нагрузка. Специальная строка "None" может использоваться для отправки нулевой (т.е. пустой) полезной нагрузки, что полезно для простого уведомления с использованием темы или для очистки ранее сохраненных сообщений. | |
| 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. [community]
Авторы
- 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.8/modules/mqtt_module.html
