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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/notification/mqtt.rb

Overview

Publish a message on an MQTT topic.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

attr_option, attr_options, attribute, fix_inclusion, #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?

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

Returns:

  • (Object, nil) —

    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.



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

attribute :ca_certs

#certfile ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



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

attribute :certfile

#client_id ⇒ String?

Returns MQTT client identifier.

Returns:

  • (String, nil) —

    MQTT client identifier



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

attribute :client_id

#keyfile ⇒ Object?

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

Returns:

  • (Object, nil) —

    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.



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

attribute :keyfile

#password ⇒ Object?

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

Returns:

  • (Object, nil) —

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



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

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.



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

attribute :payload

#port ⇒ Integer?

Returns MQTT broker port number.

Returns:

  • (Integer, nil) —

    MQTT broker port number



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

attribute :port

#qos ⇒ 0, ...

Returns QoS (Quality of Service).

Returns:

  • (0, 1, 2, nil) —

    QoS (Quality of Service)



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

attribute :qos

#retain ⇒ :yes, ...

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:

  • (:yes, :no, 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.



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

attribute :retain

#server ⇒ String?

Returns MQTT broker address/name.

Returns:

  • (String, nil) —

    MQTT broker address/name



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

attribute :server

#topic ⇒ String

Returns MQTT topic name.

Returns:

  • (String) —

    MQTT topic name



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

attribute :topic

#username ⇒ Object?

Returns Username to authenticate against the broker.

Returns:

  • (Object, nil) —

    Username to authenticate against the broker.



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

attribute :username