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

Inherits:

Base

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

Defined in:

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

Overview

Publish a message on an MQTT topic.

Instance Method Summary

• #ca_certs ⇒ Object^?

  The path to the Certificate Authority certificate files that are to be treated as trusted by this client.

• #certfile ⇒ Object^?

  The path pointing to the PEM encoded client certificate.

• #client_id ⇒ String^?

  MQTT client identifier.

• #keyfile ⇒ Object^?

  The path pointing to the PEM encoded client private key.

• #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 ⇒ :yes, ...

  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

#ca_certs ⇒ Object^?

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

attribute :ca_certs

#certfile ⇒ Object^?

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

attribute :certfile

#client_id ⇒ String^?

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

attribute :client_id

#keyfile ⇒ Object^?

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

attribute :keyfile

#password ⇒ Object^?

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

attribute :password

#payload ⇒ String

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

attribute :payload

#port ⇒ Integer^?

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

attribute :port

#qos ⇒ 0, ...

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

attribute :qos

#retain ⇒ :yes, ...

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

attribute :retain

#server ⇒ String^?

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

attribute :server

#topic ⇒ String

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

attribute :topic

#username ⇒ Object^?

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

attribute :username