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

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/extras/database/misc/redis.rb

Overview

Unified utility to interact with redis instances. ‘slave’ sets a redis instance in slave or master mode. ‘flush’ flushes all the instance or a specified db. ‘config’ (new in 1.6), ensures a configuration setting on an instance.

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

#command ⇒ :slave, ...

Returns The selected redis command.

Returns:

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

    The selected redis command



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

attribute :command

#db ⇒ String?

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

Returns:

  • (String, nil) —

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



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

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]



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

attribute :flush_mode

#login_host ⇒ String?

Returns The host running the database.

Returns:

  • (String, nil) —

    The host running the database



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

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)



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

attribute :login_password

#login_port ⇒ Integer?

Returns The port to connect to.

Returns:

  • (Integer, nil) —

    The port to connect to



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

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]



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

attribute :master_host

#master_port ⇒ String?

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

Returns:

  • (String, nil) —

    The port of the master instance [slave command]



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

attribute :master_port

#name ⇒ String?

Returns A redis config key.

Returns:

  • (String, nil) —

    A redis config key.



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

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]



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

attribute :slave_mode

#value ⇒ String?

Returns A redis config value.

Returns:

  • (String, nil) —

    A redis config value.



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

attribute :value