модуль community.general.mqtt — публикация сообщения в теме MQTT для Интернета вещей

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для работы с этим модулем могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.mqtt.

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры

Краткое описание

Публикация сообщения в теме MQTT.

Требования

Следующие требования должны быть выполнены на хосте, где выполняется этот модуль.

mosquitto

Параметры

Параметр	Комментарии
ca_cert псевдонимы: ca_certs путь	Путь к файлам сертификатов центра сертификации, которым этот клиент доверяет. Если указан только этот параметр, клиент работает аналогично веб-браузеру. Иными словами, он требует, чтобы брокер имел сертификат, подписанный одним из центров сертификации из ca_certs, и использует TLS v1 для связи, но не пытается выполнять аутентификацию. Это обеспечивает базовое шифрование сетевого трафика, но может быть недостаточно в зависимости от конфигурации брокера.
client_cert псевдонимы: certfile путь	Путь к сертификату клиента в кодировке PEM. Если параметр задан, сертификат используется как данные клиента для аутентификации на основе TLS. Поддержка этой функции зависит от брокера.
client_id строка	Идентификатор клиента MQTT. Если не указан, используется значение `hostname + pid`.
client_key псевдонимы: keyfile путь	Путь к закрытому ключу клиента в кодировке PEM. Если параметр задан, ключ используется как данные клиента для аутентификации на основе TLS. Поддержка этой функции зависит от брокера.
password строка	Пароль для аутентификации `username` у брокера.
payload строка / обязательный	Полезная нагрузка. Специальную строку `"None"` можно использовать для отправки NULL (то есть пустой) полезной нагрузки. Это удобно, чтобы просто отправить уведомление с помощью `topic` или удалить ранее сохранённые сообщения.
port целое число	Номер порта брокера MQTT. По умолчанию: `1883`
qos строка	QoS (качество обслуживания). Варианты: `"0"` ← (по умолчанию) `"1"` `"2"`
retain логический	Если установить этот флаг, брокер сохранит сообщение, чтобы приложения, которые впоследствии подпишутся на тему, сразу получили последнее сохранённое сообщение. Варианты: `false` ← (по умолчанию) `true`
server строка	Адрес/имя брокера MQTT. По умолчанию: `"localhost"`
tls_version строка	Указывает версию протокола SSL/TLS, которую следует использовать. По умолчанию определяется самая новая версия TLS (если это поддерживается версией Python). Если это невозможно, используется TLS v1. Варианты: `"tlsv1.1"` `"tlsv1.2"`
topic строка / обязательный	Имя темы MQTT.
username строка	Имя пользователя для аутентификации у брокера.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Модуль может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме diff возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

Примечания

Примечание

Для работы этого модуля требуется подключение к брокеру 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/mqtt_module.html