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

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/clustering/consul_session.rb

Overview

Allows the addition, modification and deletion of sessions in a consul cluster. These sessions can then be used in conjunction with key value pairs to implement distributed locks. In depth documentation for working with sessions can be found at www.consul.io/docs/internals/sessions.html

Instance Method Summary

• #behavior ⇒ :delete, ...

  The optional behavior that can be attached to the session when it is created.

• #checks ⇒ Array<String>, ...

  A list of checks that will be used to verify the session health.

• #datacenter ⇒ Object^?

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

• #delay ⇒ Integer^?

  The optional lock delay that can be attached to the session when it is created.

• #host ⇒ String^?

  The host of the consul agent defaults to localhost.

• #name ⇒ String^?

  The name that should be associated with the session.

• #node ⇒ Object^?

  The name of the node that with which the session will be associated.

• #port ⇒ Integer^?

  The port on which the consul agent is running.

• #scheme ⇒ String^?

  The protocol scheme on which the consul agent is running.

• #state ⇒ :absent, ...

  Whether the session should be present i.e.

• #validate_certs ⇒ Boolean^?

  Whether to verify the tls certificate of the consul agent.

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

#behavior ⇒ :delete, ...

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

attribute :behavior

#checks ⇒ Array<String>, ...

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

attribute :checks

#datacenter ⇒ Object^?

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

attribute :datacenter

#delay ⇒ Integer^?

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

attribute :delay

#host ⇒ String^?

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

attribute :host

#name ⇒ String^?

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

attribute :name

#node ⇒ Object^?

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

attribute :node

#port ⇒ Integer^?

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

attribute :port

#scheme ⇒ String^?

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

attribute :scheme

#state ⇒ :absent, ...

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

attribute :state

#validate_certs ⇒ Boolean^?

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

attribute :validate_certs