Class: Ansible::Ruby::Modules::Mqtt

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Mqtt

Defined in:

lib/ansible/ruby/modules/generated/extras/notification/mqtt.rb

Overview

Publish a message on an MQTT topic.

Instance Method Summary

• #client_id ⇒ String^?

  MQTT client identifier.

• #password ⇒ Object^?

  Password for C(username) to authenticate against the broker.

• #payload ⇒ String

  Payload.

• #port ⇒ Integer^?

  MQTT broker port number.

• #qos ⇒ 0, ...

  QoS (Quality of Service).

• #retain ⇒ Boolean^?

  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 ⇒ String^?

  MQTT broker address/name.

• #topic ⇒ String

  MQTT topic name.

• #username ⇒ Object^?

  Username to authenticate against the broker.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#client_id ⇒ String^?

Returns MQTT client identifier.

Returns:

• (String, nil) —

  MQTT client identifier

# File 'lib/ansible/ruby/modules/generated/extras/notification/mqtt.rb', line 25

attribute :client_id

#password ⇒ Object^?

Returns Password for C(username) to authenticate against the broker.

Returns:

• (Object, nil) —

  Password for C(username) to authenticate against the broker.

# File 'lib/ansible/ruby/modules/generated/extras/notification/mqtt.rb', line 22

attribute :password

#payload ⇒ String

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

Returns:

• (String) —

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

# File 'lib/ansible/ruby/modules/generated/extras/notification/mqtt.rb', line 33

attribute :payload

#port ⇒ Integer^?

Returns MQTT broker port number.

Returns:

• (Integer, nil) —

  MQTT broker port number

# File 'lib/ansible/ruby/modules/generated/extras/notification/mqtt.rb', line 15

attribute :port

#qos ⇒ 0, ...

Returns QoS (Quality of Service).

Returns:

• (0, 1, 2, nil) —

  QoS (Quality of Service)

# File 'lib/ansible/ruby/modules/generated/extras/notification/mqtt.rb', line 37

attribute :qos

#retain ⇒ Boolean^?

Returns 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.

Returns:

• (Boolean, nil) —

  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.

# File 'lib/ansible/ruby/modules/generated/extras/notification/mqtt.rb', line 41

attribute :retain

#server ⇒ String^?

Returns MQTT broker address/name.

Returns:

• (String, nil) —

  MQTT broker address/name

# File 'lib/ansible/ruby/modules/generated/extras/notification/mqtt.rb', line 11

attribute :server

#topic ⇒ String

Returns MQTT topic name.

Returns:

• (String) —

  MQTT topic name

# File 'lib/ansible/ruby/modules/generated/extras/notification/mqtt.rb', line 29

attribute :topic

#username ⇒ Object^?

Returns Username to authenticate against the broker.

Returns:

• (Object, nil) —

  Username to authenticate against the broker.

# File 'lib/ansible/ruby/modules/generated/extras/notification/mqtt.rb', line 19

attribute :username