Class: IControl::GlobalLB::Region

Inherits:
Base
  • Object
show all
Defined in:
lib/icontrol/global_lb/region.rb,
lib/icontrol/global_lb.rb

Overview

The Region interface enables you to work with user-defined region definitions.

Defined Under Namespace

Classes: RegionDefinition, RegionDefinitionSequence, RegionItem, RegionItemSequence, RegionItemSequenceSequence

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

#add_region_item(opts) ⇒ Object

Adds this region items to this region definitions.

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.


20
21
22
23
# File 'lib/icontrol/global_lb/region.rb', line 20

def add_region_item(opts)
  opts = check_params(opts,[:items])
  super(opts)
end

#create(opts) ⇒ Object

Creates this region definitions with this region items.

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.


33
34
35
36
# File 'lib/icontrol/global_lb/region.rb', line 33

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

#delete_all_region_definitionsObject

Deletes all region definitions.

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/global_lb/region.rb', line 44

def delete_all_region_definitions
  super
end

#delete_region_definitionObject

Deletes this region definitions.

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.


54
55
56
# File 'lib/icontrol/global_lb/region.rb', line 54

def delete_region_definition
  super
end

#listRegionDefinition

Gets a list of of region definitions.

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.


65
66
67
# File 'lib/icontrol/global_lb/region.rb', line 65

def list
  super
end

#region_itemRegionItem[]

Gets the list of region items that define this region.

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.


76
77
78
# File 'lib/icontrol/global_lb/region.rb', line 76

def region_item
  super
end

#remove_all_region_itemsObject

Removes any and all region items in this region.

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.


94
95
96
# File 'lib/icontrol/global_lb/region.rb', line 94

def remove_all_region_items
  super
end

#remove_region_item(opts) ⇒ Object

Removes this region items from this region definitions.

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.


106
107
108
109
# File 'lib/icontrol/global_lb/region.rb', line 106

def remove_region_item(opts)
  opts = check_params(opts,[:items])
  super(opts)
end

#versionString

Gets the version information for this interface.

Returns:

  • (String)

84
85
86
# File 'lib/icontrol/global_lb/region.rb', line 84

def version
  super
end