Class: IControl::Management::DBVariable

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/management/db_variable.rb,
lib/icontrol/management.rb

Overview

The DBVariable interface exposes methods that enable you to work directly with our internal database that contains configuration variables using name/value pairs.

Defined Under Namespace

Classes: VariableNameValue, VariableNameValueSequence

Instance Method Summary (collapse)

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

- (Object) create

Creates this variable in the database.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



16
17
18
 
# File 'lib/icontrol/management/db_variable.rb', line 16

def create
  super
end

- (Object) delete_variable

Deletes the variable referenced from the database.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



26
27
28
 
# File 'lib/icontrol/management/db_variable.rb', line 26

def delete_variable
  super
end

- (boolean) is_variable_available

Verifies the existence of this variable in the database.

Returns:

  • (boolean)

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



57
58
59
 
# File 'lib/icontrol/management/db_variable.rb', line 57

def is_variable_available
  super
end

- (VariableNameValue) list

Retrieves the values of all variable defined in the database. This list can potentially be huge.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



38
39
40
 
# File 'lib/icontrol/management/db_variable.rb', line 38

def list
  super
end

- (Object) modify

Modifies this variable in the database.



64
65
66
 
# File 'lib/icontrol/management/db_variable.rb', line 64

def modify
  super
end

- (VariableNameValue) query

Queries the values of this variable.

Returns:

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



75
76
77
 
# File 'lib/icontrol/management/db_variable.rb', line 75

def query
  super
end

- (Object) reset

Resets this variable to their default values.

Raises:

  • (IControl::IControl::Common::AccessDenied) —

    raised if the client credentials are not valid.

  • (IControl::IControl::Common::InvalidArgument) —

    raised if one of the arguments is invalid.

  • (IControl::IControl::Common::OperationFailed) —

    raised if an operation error occurs.



85
86
87
 
# File 'lib/icontrol/management/db_variable.rb', line 85

def reset
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


46
47
48
 
# File 'lib/icontrol/management/db_variable.rb', line 46

def version
  super
end