Class: Ansible::Ruby::Modules::Consul_acl

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

Overview

allows the addition, modification and deletion of ACL keys and associated rules in a consul cluster via the agent. For more details on using and configuring ACLs, see www.consul.io/docs/internals/acl.html.

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, remove_existing_validations, #to_h, validates

Constructor Details

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

Instance Method Details

#host ⇒ String?

Returns host of the consul agent defaults to localhost.

Returns:

  • (String, nil) —

    host of the consul agent defaults to localhost



35
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_acl.rb', line 35

attribute :host

#mgmt_token ⇒ String?

Returns a management token is required to manipulate the acl lists.

Returns:

  • (String, nil) —

    a management token is required to manipulate the acl lists



11
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_acl.rb', line 11

attribute :mgmt_token

#name ⇒ String?

Returns the name that should be associated with the acl key, this is opaque to Consul.

Returns:

  • (String, nil) —

    the name that should be associated with the acl key, this is opaque to Consul



23
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_acl.rb', line 23

attribute :name

#port ⇒ Integer?

Returns the port on which the consul agent is running.

Returns:

  • (Integer, nil) —

    the port on which the consul agent is running



39
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_acl.rb', line 39

attribute :port

#rules ⇒ Array<Hash>, ...

Returns an list of the rules that should be associated with a given token.

Returns:

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

    an list of the rules that should be associated with a given token.



31
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_acl.rb', line 31

attribute :rules

#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



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

attribute :scheme

#state ⇒ :present, ...

Returns whether the ACL pair should be present or absent, defaults to present.

Returns:

  • (:present, :absent, nil) —

    whether the ACL pair should be present or absent, defaults to present



15
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_acl.rb', line 15

attribute :state

#token ⇒ String?

Returns the token key indentifying an ACL rule set. If generated by consul this will be a UUID.

Returns:

  • (String, nil) —

    the token key indentifying an ACL rule set. If generated by consul this will be a UUID.



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

attribute :token

#type ⇒ :client, ...

Returns the type of token that should be created, either management or client, defaults to client.

Returns:

  • (:client, :management, nil) —

    the type of token that should be created, either management or client, defaults to client



19
 
# File 'lib/ansible/ruby/modules/generated/extras/clustering/consul_acl.rb', line 19

attribute :type

#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



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

attribute :validate_certs