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

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/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/guides/acl.html.

Instance Method Summary

• #host ⇒ String^?

  Host of the consul agent defaults to localhost.

• #mgmt_token ⇒ String^?

  A management token is required to manipulate the acl lists.

• #name ⇒ String^?

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

• #port ⇒ Integer^?

  The port on which the consul agent is running.

• #rules ⇒ Array<Hash>, ...

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

• #scheme ⇒ String^?

  The protocol scheme on which the consul agent is running.

• #state ⇒ :present, ...

  Whether the ACL pair should be present or absent.

• #token ⇒ String^?

  The token key indentifying an ACL rule set.

• #token_type ⇒ :client, ...

  The type of token that should be created, either management or client.

• #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

#host ⇒ String^?

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

attribute :host

#mgmt_token ⇒ String^?

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

attribute :mgmt_token

#name ⇒ String^?

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

attribute :name

#port ⇒ Integer^?

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

attribute :port

#rules ⇒ Array<Hash>, ...

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

attribute :rules

#scheme ⇒ String^?

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

attribute :scheme

#state ⇒ :present, ...

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

attribute :state

#token ⇒ String^?

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

attribute :token

#token_type ⇒ :client, ...

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

attribute :token_type

#validate_certs ⇒ Boolean^?

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

attribute :validate_certs