Class: Ansible::Ruby::Modules::Riak

Inherits:

Base

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

Defined in:

lib/ansible/ruby/modules/generated/database/misc/riak.rb

Overview

This module can be used to join nodes to a cluster, check the status of the cluster.

Instance Method Summary

• #command ⇒ :ping, ...

  The command you would like to perform against the cluster.

• #config_dir ⇒ String^?

  The path to the riak configuration directory.

• #http_conn ⇒ String^?

  The ip address and port that is listening for Riak HTTP queries.

• #target_node ⇒ String^?

  The target node for certain operations (join, ping).

• #validate_certs ⇒ :yes, ...

  If C(no), SSL certificates will not be validated.

• #wait_for_handoffs ⇒ Boolean^?

  Number of seconds to wait for handoffs to complete.

• #wait_for_ring ⇒ Object^?

  Number of seconds to wait for all nodes to agree on the ring.

• #wait_for_service ⇒ :kv^?

  Waits for a riak service to come online before continuing.

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#command ⇒ :ping, ...

Returns The command you would like to perform against the cluster.

Returns:

• (:ping, :kv_test, :join, :plan, :commit, nil) —

  The command you would like to perform against the cluster.

# File 'lib/ansible/ruby/modules/generated/database/misc/riak.rb', line 12

attribute :command

#config_dir ⇒ String^?

Returns The path to the riak configuration directory.

Returns:

• (String, nil) —

  The path to the riak configuration directory

# File 'lib/ansible/ruby/modules/generated/database/misc/riak.rb', line 16

attribute :config_dir

#http_conn ⇒ String^?

Returns The ip address and port that is listening for Riak HTTP queries.

Returns:

• (String, nil) —

  The ip address and port that is listening for Riak HTTP queries

# File 'lib/ansible/ruby/modules/generated/database/misc/riak.rb', line 20

attribute :http_conn

#target_node ⇒ String^?

Returns The target node for certain operations (join, ping).

Returns:

• (String, nil) —

  The target node for certain operations (join, ping)

# File 'lib/ansible/ruby/modules/generated/database/misc/riak.rb', line 24

attribute :target_node

#validate_certs ⇒ :yes, ...

Returns If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Returns:

• (:yes, :no, nil) —

  If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

# File 'lib/ansible/ruby/modules/generated/database/misc/riak.rb', line 39

attribute :validate_certs

#wait_for_handoffs ⇒ Boolean^?

Returns Number of seconds to wait for handoffs to complete.

Returns:

• (Boolean, nil) —

  Number of seconds to wait for handoffs to complete.

# File 'lib/ansible/ruby/modules/generated/database/misc/riak.rb', line 28

attribute :wait_for_handoffs

#wait_for_ring ⇒ Object^?

Returns Number of seconds to wait for all nodes to agree on the ring.

Returns:

• (Object, nil) —

  Number of seconds to wait for all nodes to agree on the ring.

# File 'lib/ansible/ruby/modules/generated/database/misc/riak.rb', line 32

attribute :wait_for_ring

#wait_for_service ⇒ :kv^?

Returns Waits for a riak service to come online before continuing.

Returns:

• (:kv, nil) —

  Waits for a riak service to come online before continuing.

# File 'lib/ansible/ruby/modules/generated/database/misc/riak.rb', line 35

attribute :wait_for_service