Class: Ansible::Ruby::Modules::Redis

Inherits:

Base

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

Defined in:

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

Overview

Unified utility to interact with redis instances.

Instance Method Summary

• #command ⇒ :config, ...

  The selected redis command,C(config) (new in 1.6), ensures a configuration setting on an instance.,C(flush) flushes all the instance or a specified db.,C(slave) sets a redis instance in slave or master mode.

• #db ⇒ Integer^?

  The database to flush (used in db mode) [flush command].

• #flush_mode ⇒ :all, ...

  Type of flush (all the dbs in a redis instance or a specific one) [flush command].

• #login_host ⇒ String^?

  The host running the database.

• #login_password ⇒ Object^?

  The password used to authenticate with (usually not used).

• #login_port ⇒ Integer^?

  The port to connect to.

• #master_host ⇒ String^?

  The host of the master instance [slave command].

• #master_port ⇒ Integer^?

  The port of the master instance [slave command].

• #name ⇒ String^?

  A redis config key.

• #slave_mode ⇒ :master, ...

  The mode of the redis instance [slave command].

• #value ⇒ Integer^?

  A redis config value.

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

#command ⇒ :config, ...

Returns The selected redis command,C(config) (new in 1.6), ensures a configuration setting on an instance.,C(flush) flushes all the instance or a specified db.,C(slave) sets a redis instance in slave or master mode.

Returns:

• (:config, :flush, :slave) —

  The selected redis command,C(config) (new in 1.6), ensures a configuration setting on an instance.,C(flush) flushes all the instance or a specified db.,C(slave) sets a redis instance in slave or master mode.

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

attribute :command

#db ⇒ Integer^?

Returns The database to flush (used in db mode) [flush command].

Returns:

• (Integer, nil) —

  The database to flush (used in db mode) [flush command]

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

attribute :db

#flush_mode ⇒ :all, ...

Returns Type of flush (all the dbs in a redis instance or a specific one) [flush command].

Returns:

• (:all, :db, nil) —

  Type of flush (all the dbs in a redis instance or a specific one) [flush command]

# File 'lib/ansible/ruby/modules/generated/database/misc/redis.rb', line 43

attribute :flush_mode

#login_host ⇒ String^?

Returns The host running the database.

Returns:

• (String, nil) —

  The host running the database

# File 'lib/ansible/ruby/modules/generated/database/misc/redis.rb', line 19

attribute :login_host

#login_password ⇒ Object^?

Returns The password used to authenticate with (usually not used).

Returns:

• (Object, nil) —

  The password used to authenticate with (usually not used)

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

attribute :login_password

#login_port ⇒ Integer^?

Returns The port to connect to.

Returns:

• (Integer, nil) —

  The port to connect to

# File 'lib/ansible/ruby/modules/generated/database/misc/redis.rb', line 23

attribute :login_port

#master_host ⇒ String^?

Returns The host of the master instance [slave command].

Returns:

• (String, nil) —

  The host of the master instance [slave command]

# File 'lib/ansible/ruby/modules/generated/database/misc/redis.rb', line 27

attribute :master_host

#master_port ⇒ Integer^?

Returns The port of the master instance [slave command].

Returns:

• (Integer, nil) —

  The port of the master instance [slave command]

# File 'lib/ansible/ruby/modules/generated/database/misc/redis.rb', line 31

attribute :master_port

#name ⇒ String^?

Returns A redis config key.

Returns:

• (String, nil) —

  A redis config key.

# File 'lib/ansible/ruby/modules/generated/database/misc/redis.rb', line 47

attribute :name

#slave_mode ⇒ :master, ...

Returns the mode of the redis instance [slave command].

Returns:

• (:master, :slave, nil) —

  the mode of the redis instance [slave command]

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

attribute :slave_mode

#value ⇒ Integer^?

Returns A redis config value.

Returns:

• (Integer, nil) —

  A redis config value.

# File 'lib/ansible/ruby/modules/generated/database/misc/redis.rb', line 51

attribute :value