Class: Ansible::Ruby::Modules::Consul_session

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/clustering/consul_session.rb

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#checks ⇒ Array<String>, ...

Returns a list of checks that will be used to verify the session health. If all the checks fail, the session will be invalidated and any locks associated with the session will be release and can be acquired once the associated lock delay has expired.

Returns:

  • (Array<String>, String, nil) —

    a list of checks that will be used to verify the session health. If all the checks fail, the session will be invalidated and any locks associated with the session will be release and can be acquired once the associated lock delay has expired.



28
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_session.rb', line 28

attribute :checks

#datacenter ⇒ Object?

Returns name of the datacenter in which the session exists or should be created.

Returns:

  • (Object, nil) —

    name of the datacenter in which the session exists or should be created.



25
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_session.rb', line 25

attribute :datacenter

#delay ⇒ String?

Returns the optional lock delay that can be attached to the session when it is created. Locks for invalidated sessions ar blocked from being acquired until this delay has expired. Valid units for delays include ‘ns’, ‘us’, ‘ms’, ‘s’, ‘m’, ‘h’.

Returns:

  • (String, nil) —

    the optional lock delay that can be attached to the session when it is created. Locks for invalidated sessions ar blocked from being acquired until this delay has expired. Valid units for delays include ‘ns’, ‘us’, ‘ms’, ‘s’, ‘m’, ‘h’



18
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_session.rb', line 18

attribute :delay

#host ⇒ String?

Returns host of the consul agent defaults to localhost.

Returns:

  • (String, nil) —

    host of the consul agent defaults to localhost



32
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_session.rb', line 32

attribute :host

#name ⇒ String?

Returns the name that should be associated with the session. This is opaque to Consul and not required.

Returns:

  • (String, nil) —

    the name that should be associated with the session. This is opaque to Consul and not required.



14
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_session.rb', line 14

attribute :name

#node ⇒ Object?

Returns the name of the node that with which the session will be associated. by default this is the name of the agent.

Returns:

  • (Object, nil) —

    the name of the node that with which the session will be associated. by default this is the name of the agent.



22
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_session.rb', line 22

attribute :node

#port ⇒ Integer?

Returns the port on which the consul agent is running.

Returns:

  • (Integer, nil) —

    the port on which the consul agent is running



36
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_session.rb', line 36

attribute :port

#scheme ⇒ String?

Returns the protocol scheme on which the consul agent is running.

Returns:

  • (String, nil) —

    the protocol scheme on which the consul agent is running



40
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_session.rb', line 40

attribute :scheme

#state ⇒ :present, ...

Returns whether the session should be present i.e. created if it doesn’t exist, or absent, removed if present. If created, the ID for the session is returned in the output. If absent, the name or ID is required to remove the session. Info for a single session, all the sessions for a node or all available sessions can be retrieved by specifying info, node or list for the state; for node or info, the node name or session id is required as parameter.

Returns:

  • (:present, :absent, :info, :node, :list, nil) —

    whether the session should be present i.e. created if it doesn’t exist, or absent, removed if present. If created, the ID for the session is returned in the output. If absent, the name or ID is required to remove the session. Info for a single session, all the sessions for a node or all available sessions can be retrieved by specifying info, node or list for the state; for node or info, the node name or session id is required as parameter.



10
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_session.rb', line 10

attribute :state

#validate_certs ⇒ Boolean?

Returns whether to verify the tls certificate of the consul agent.

Returns:

  • (Boolean, nil) —

    whether to verify the tls certificate of the consul agent



44
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_session.rb', line 44

attribute :validate_certs