ANSIBLE.MQTT(3)                 ANSIBLE MODULES                ANSIBLE.MQTT(3)



NAME
       mqtt - Publish a message on an MQTT topic for the IoT

DESCRIPTION
       Publish a message on an MQTT topic.

OPTIONS
       client_id
              MQTT client identifier (default: hostname + pid)

       password
              Password for username to authenticate against the broker.

       payload
              Payload. The special string "None" may be used to send a NULL
              (i.e. empty) payload which is useful to simply notify with the
              topic or to clear previously retained messages.(required)

       port   MQTT broker port number (default: 1883)

       qos    QoS (Quality of Service) Choices: 0,1,2.

       retain Setting this flag causes the broker to retain (i.e. keep) the
              message so that applications that subsequently subscribe to the
              topic can received the last retained message immediately.

       server MQTT broker address/name (default: localhost)

       topic  MQTT topic name(required)

       username
              Username to authenticate against the broker..

NOTES
       This module requires a connection to an MQTT broker such as Mosquitto
       http://mosquitto.org and the mosquitto Python module
       (http://mosquitto.org/python).

EXAMPLES
       - local_action: mqtt
                     topic=service/ansible/{{ ansible_hostname }}
                     payload="Hello at {{ ansible_date_time.iso8601 }}"
                     qos=0
                     retain=false
                     client_id=ans001



AUTHOR
       Jan-Piet Mens

SEE ALSO
       ansible(1), http://ansible.github.com/modules.html#mqtt



1.4.5                             2014-02-12                   ANSIBLE.MQTT(3)
