Class: IControl::GlobalLB::Topology

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

Overview

The Topology interface enables you to work with topology attributes. For example, you can create and delete a topology. You can also use the Topology interface to add virtual server entries to, or remove virtual server entries from, a topology.

Defined Under Namespace

Classes: TopologyEndpoint, TopologyEndpointSequence, TopologyRecord, TopologyRecordSequence

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(opts)

Adds or creates this topology record.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :weights (long) —

    The weights for the records.

  • :orders (long) —

    The sort orders for the records. These sort orders are used when longest match sorting is not available.

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/global_lb/topology.rb', line 22

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

- (Object) delete_all_topology_records

Deletes all topology record.

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/global_lb/topology.rb', line 33

def delete_all_topology_records
  super
end

- (Object) delete_topology_record

Deletes this topology record.

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.



43
44
45
 
# File 'lib/icontrol/global_lb/topology.rb', line 43

def delete_topology_record
  super
end

- (TopologyRecord) list

Gets a list of of topology record.

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.



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

def list
  super
end

- (long) order

Gets the sort orders for this topology record.

Returns:

  • (long)

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/topology.rb', line 65

def order
  super
end

- (Object) set_order(opts)

Sets the sort orders used when longest match sorting is not available for this topology record.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :orders (long) —

    The sort orders to set.

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/global_lb/topology.rb', line 97

def set_order(opts)
  check_params(opts,[:orders])
  super
end

- (Object) set_weight(opts)

Sets the weights for this topology record.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :weights (long) —

    The weights to set.

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.



110
111
112
113
 
# File 'lib/icontrol/global_lb/topology.rb', line 110

def set_weight(opts)
  check_params(opts,[:weights])
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


73
74
75
 
# File 'lib/icontrol/global_lb/topology.rb', line 73

def version
  super
end

- (long) weight

Gets the weights for this links.

Returns:

  • (long)

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.



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

def weight
  super
end