Class: IControl::LocalLB::VirtualAddress

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

Overview

The VirtualAddress interface enables you to work with the states, statistics, limits, availability, and settings of a local load balancer's virtual address.

Defined Under Namespace

Classes: VirtualAddressStatisticEntry, VirtualAddressStatisticEntrySequence, VirtualAddressStatistics

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

- (VirtualAddressStatistics) all_statistics

Gets the statistics for all the virtual addresse.

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.



28
29
30
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 28

def all_statistics
  super
end

- (EnabledState) arp_state

Gets the ARP states for this virtual addresse.

Returns:

  • (EnabledState)

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.



39
40
41
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 39

def arp_state
  super
end

- (ULong64) connection_limit

Gets the connection limits for this virtual addresse.

Returns:

  • (ULong64)

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.



50
51
52
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 50

def connection_limit
  super
end

- (Object) delete_virtual_address

Deletes this virtual addresse.

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.



17
18
19
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 17

def delete_virtual_address
  super
end

- (EnabledState) enabled_state

Gets the enabled states of this virtual addresse.

Returns:

  • (EnabledState)

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.



61
62
63
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 61

def enabled_state
  super
end

- (EnabledState) is_floating_state

Gets the the states that indicate whether these virtual addresse should be shared between the redundant pair. This is typically used in one-armed Combo pair, where GTM is only licensed on one of the boxes. Default is TRUE.

Returns:

  • (EnabledState)

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.



74
75
76
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 74

def is_floating_state
  super
end

- (String) list

Gets a list of virtual addresse.

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.



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

def list
  super
end

- (ObjectStatus) object_status

Gets the status of each of this virtual addresse.

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.



96
97
98
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 96

def object_status
  super
end

- (Object) reset_statistics

Resets the statistics for this virtual addresse.

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.



159
160
161
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 159

def reset_statistics
  super
end

- (EnabledState) route_advertisement_state

Gets the route advertisement states for this virtual addresse.

Returns:

  • (EnabledState)

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.



107
108
109
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 107

def route_advertisement_state
  super
end

- (Object) set_arp_state(opts)

Sets the ARP states for this virtual addresse.

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.



171
172
173
174
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 171

def set_arp_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_connection_limit(opts)

Sets the connection limits of this virtual addresse.

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.



184
185
186
187
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 184

def set_connection_limit(opts)
  check_params(opts,[:limits])
  super
end

- (Object) set_enabled_state(opts)

Sets the enabled states of this virtual addresse.

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.



197
198
199
200
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 197

def set_enabled_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_is_floating_state(opts)

Sets the states that indicate whether these virtual addresse should be shared between the redundant pair. This is typically used in one-armed Combo pair, where GTM is only licensed on one of the boxes. Default is TRUE.

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.



212
213
214
215
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 212

def set_is_floating_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_route_advertisement_state(opts)

Sets the route advertisement states for this virtual addresse.

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.



225
226
227
228
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 225

def set_route_advertisement_state(opts)
  check_params(opts,[:states])
  super
end

- (Object) set_status_dependency_scope(opts)

Sets the status dependency scopes that are used to calculate the virtual addresse' status based on the related virtual servers' status.

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.



239
240
241
242
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 239

def set_status_dependency_scope(opts)
  check_params(opts,[:scopes])
  super
end

- (Object) set_unit_id(opts)

Sets the unit IDs for this virtual addresse.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :unit_ids (long) —

    The unit IDs 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.



252
253
254
255
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 252

def set_unit_id(opts)
  check_params(opts,[:unit_ids])
  super
end

- (VirtualAddressStatistics) statistics

Gets the statistics for this virtual addresse.

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.



118
119
120
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 118

def statistics
  super
end

- (VirtualAddressStatusDependency) status_dependency_scope

Gets the status dependency scopes that are used to calculate the virtual addresse' status based on the related virtual servers' status.

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.



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

def status_dependency_scope
  super
end

- (long) unit_id

Gets the list of unit IDs used by this virtual addresse.

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.



141
142
143
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 141

def unit_id
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String) 


149
150
151
 
# File 'lib/icontrol/local_lb/virtual_address.rb', line 149

def version
  super
end