Class: IControl::LocalLB::Rule

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/local_lb/rule.rb,
lib/icontrol/local_lb.rb

Overview

The Rule interface enables you to manipulate a local load balancer's rules. For example, use the Rule interface to get a list of all rules, create rules, delete rules, modify rules, and query rules.

Defined Under Namespace

Classes: RuleDefinition, RuleDefinitionSequence, RuleStatisticEntry, RuleStatisticEntrySequence, RuleStatistics

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

- (RuleStatistics) all_statistics

Gets the statistics for all the rule.

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.



55
56
57
 
# File 'lib/icontrol/local_lb/rule.rb', line 55

def all_statistics
  super
end

- (Object) create(opts)

Creates this rule.

Parameters:

  • opts (Hash)

Options Hash (opts):

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.



22
23
24
25
 
# File 'lib/icontrol/local_lb/rule.rb', line 22

def create(opts)
  check_params(opts,[:rules])
  super
end

- (Object) delete_all_rules

Deletes all user-defined rule.

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.



33
34
35
 
# File 'lib/icontrol/local_lb/rule.rb', line 33

def delete_all_rules
  super
end

- (Object) delete_rule

Deletes this rule. An exception will be raised when attempting to delete a default system rule.

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.



44
45
46
 
# File 'lib/icontrol/local_lb/rule.rb', line 44

def delete_rule
  super
end

- (String) list

Gets a list of all rule.

Returns:

  • (String)

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.



66
67
68
 
# File 'lib/icontrol/local_lb/rule.rb', line 66

def list
  super
end

- (Object) modify_rule(opts)

Modifies this rule.

Parameters:

  • opts (Hash)

Options Hash (opts):

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.



97
98
99
100
 
# File 'lib/icontrol/local_lb/rule.rb', line 97

def modify_rule(opts)
  check_params(opts,[:rules])
  super
end

- (RuleDefinition) query_all_rules

Queries all rule.

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.



109
110
111
 
# File 'lib/icontrol/local_lb/rule.rb', line 109

def query_all_rules
  super
end

- (RuleDefinition) query_rule

Queries this rule.

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.



120
121
122
 
# File 'lib/icontrol/local_lb/rule.rb', line 120

def query_rule
  super
end

- (Object) reset_statistics

Resets the statistics for this rule.

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.



130
131
132
 
# File 'lib/icontrol/local_lb/rule.rb', line 130

def reset_statistics
  super
end

- (RuleStatistics) statistics

Gets the statistics for this rule.

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.



77
78
79
 
# File 'lib/icontrol/local_lb/rule.rb', line 77

def statistics
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


85
86
87
 
# File 'lib/icontrol/local_lb/rule.rb', line 85

def version
  super
end