Class: Ansible::Ruby::Modules::Consul_kv

Inherits:

Base

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

Defined in:

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

Overview

Allows the retrieval, addition, modification and deletion of key/value entries in a consul cluster via the agent. The entire contents of the record, including the indices, flags and session are returned as ‘value’. If the key represents a prefix then Note that when a value is removed, the existing value if any is returned as part of the results. See www.consul.io/docs/agent/http.html#kv for more details.

Instance Method Summary

• #cas ⇒ Object^?

  Used when acquiring a lock with a session.

• #flags ⇒ Object^?

  Opaque integer value that can be passed when setting a value.

• #host ⇒ String^?

  Host of the consul agent.

• #key ⇒ String

  The key at which the value should be stored.

• #port ⇒ Integer^?

  The port on which the consul agent is running.

• #recurse ⇒ :yes, ...

  If the key represents a prefix, each entry with the prefix can be retrieved by setting this to C(yes).

• #scheme ⇒ String^?

  The protocol scheme on which the consul agent is running.

• #session ⇒ String^?

  The session that should be used to acquire or release a lock associated with a key/value pair.

• #state ⇒ :absent, ...

  The action to take with the supplied key and value.

• #token ⇒ Object^?

  The token key indentifying an ACL rule set that controls access to the key value pair.

• #validate_certs ⇒ :yes, ...

  Whether to verify the tls certificate of the consul agent.

• #value ⇒ String, Integer

  The value should be associated with the given key, required if C(state) is C(present).

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

#cas ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/clustering/consul_kv.rb', line 37

attribute :cas

#flags ⇒ Object^?

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

attribute :flags

#host ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/clustering/consul_kv.rb', line 43

attribute :host

#key ⇒ String

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

attribute :key

#port ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/clustering/consul_kv.rb', line 47

attribute :port

#recurse ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/clustering/consul_kv.rb', line 26

attribute :recurse

#scheme ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/clustering/consul_kv.rb', line 51

attribute :scheme

#session ⇒ String^?

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

attribute :session

#state ⇒ :absent, ...

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

attribute :state

#token ⇒ Object^?

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

attribute :token

#validate_certs ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/clustering/consul_kv.rb', line 55

attribute :validate_certs

#value ⇒ String, Integer

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

attribute :value