community.general.mqtt (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Publish a message on an MQTT topic.

Requirements

• mosquitto

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
qos:
    choices:
    - '0'
    - '1'
    - '2'
    default: '0'
    description:
    - QoS (Quality of Service)
    type: str

port:
    default: 1883
    description:
    - MQTT broker port number
    type: int

topic:
    description:
    - MQTT topic name
    required: true
    type: str

retain:
    default: false
    description:
    - 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.
    type: bool

server:
    default: localhost
    description:
    - MQTT broker address/name
    type: str

ca_cert:
    aliases:
    - ca_certs
    description:
    - The path to the Certificate Authority certificate files that are to be treated as
      trusted by this client. If this is the only option given then the client will operate
      in a similar manner to a web browser. That is to say it will require the broker
      to have a certificate signed by the Certificate Authorities in ca_certs and will
      communicate using TLS v1, but will not attempt any form of authentication. This
      provides basic network encryption but may not be sufficient depending on how the
      broker is configured.
    type: path

payload:
    description:
    - Payload. The special string V("None") may be used to send a NULL (that is, empty)
      payload which is useful to simply notify with the O(topic) or to clear previously
      retained messages.
    required: true
    type: str

password:
    description:
    - Password for O(username) to authenticate against the broker.
    type: str

username:
    description:
    - Username to authenticate against the broker.
    type: str

client_id:
    description:
    - MQTT client identifier
    - If not specified, a value C(hostname + pid) will be used.
    type: str

client_key:
    aliases:
    - keyfile
    description:
    - The path pointing to the PEM encoded client private key. If this is not None it
      will be used as client information for TLS based authentication. Support for this
      feature is broker dependent.
    type: path

client_cert:
    aliases:
    - certfile
    description:
    - The path pointing to the PEM encoded client certificate. If this is not None it
      will be used as client information for TLS based authentication. Support for this
      feature is broker dependent.
    type: path

tls_version:
    choices:
    - tlsv1.1
    - tlsv1.2
    description:
    - Specifies the version of the SSL/TLS protocol to be used.
    - By default (if the python version supports it) the highest TLS version is detected.
      If unavailable, TLS v1 is used.
    type: str