community.general.mqtt – Опубликовать сообщение в MQTT-теме для IoT
Примечание
Этот плагин входит в состав коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Чтобы использовать его в книге задач, укажите: community.general.mqtt.
Обзор
- Опубликовать сообщение в MQTT-теме.
Требования
Ниже перечислены требования, которые должны быть выполнены на узле, выполняющем этот модуль.
- mosquitto
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| ca_cert путь | Путь к файлам сертификата Удостоверяющего центра, которые должны рассматриваться этим клиентом как доверенные. Если это единственный указанный параметр, клиент будет работать аналогично веб-браузеру. То есть он будет требовать от брокера наличие сертификата, подписанного Удостоверяющими центрами в ca_certs, и будет обмениваться данными с использованием TLS v1, но не будет пытаться выполнить какую-либо аутентификацию. Это обеспечивает базовую шифрование сети, но может быть недостаточно в зависимости от конфигурации брокера. псевдонимы: ca_certs | |
| client_cert путь | Путь к клиенту PEM-кодированный сертификат. Если это не None, он будет использоваться как информация клиента для TLS-аутентификации. Поддержка этой функции зависит от брокера. псевдонимы: certfile | |
| client_id строка | Идентификатор MQTT-клиента Если не указано, будет использовано значение hostname + pid. | |
| client_key путь | Путь к PEM-кодированный закрытый ключ клиента. Если это не None, он будет использоваться как информация клиента для TLS-аутентификации. Поддержка этой функции зависит от брокера. псевдонимы: keyfile | |
| password строка | Пароль для username для аутентификации у брокера. | |
| payload строка / обязательно | Полезная нагрузка. Специальная строка "None" может использоваться для отправки NULL (т. е. пустой) полезной нагрузки, что полезно для простого уведомления о теме или для очистки ранее сохраненных сообщений. | |
| port целое число | По умолчанию: 1883 | Номер порта MQTT-брокера |
| qos строка |
| QoS (Качество обслуживания) |
| retain булево |
| Установка этого флага заставляет брокер сохранять (т. е. хранить) сообщение, чтобы приложения, которые впоследствии подписываются на тему, могли сразу получить последнее сохраненное сообщение. |
| server строка | По умолчанию: "localhost" | Адрес/имя MQTT-брокера |
| tls_version строка |
| Указывает версию протокола SSL/TLS, который будет использоваться. По умолчанию (если версия Python поддерживает это) обнаруживается самая высокая версия TLS. Если недоступна, используется TLS v1. |
| topic строка / обязательно | Имя MQTT-темы | |
| username строка | Имя пользователя для аутентификации у брокера. |
Примечания
Примечание
- Этот модуль требует подключения к MQTT-брокеру, например, Mosquitto http://mosquitto.org, и клиенту Python Paho
mqtt(https://pypi.org/project/paho-mqtt/).
Примеры
- name: Publish a message on an MQTT topic
community.general.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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/mqtt_module.html
