Class: IControl::GlobalLB::Link

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

Overview

The Link interface enables you to work with links within a data center.

Defined Under Namespace

Classes: LinkCostSegment, LinkCostSegmentSequence, LinkCostSegmentSequenceSequence, LinkIPDefinition, LinkIPSequence, LinkMetricLimit, LinkMetricLimitSequence, LinkStatisticEntry, LinkStatisticEntrySequence, LinkStatistics, MonitorAssociation, MonitorAssociationSequence

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

Adds the cost segments for this link.

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.



27
28
29
30
# File 'lib/icontrol/global_lb/link.rb', line 27

def add_cost_segment(opts)
  check_params(opts,[:cost_segments])
  super
end

- (Object) add_ip(opts)

Adds the IP addresses to this link.

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.



40
41
42
43
# File 'lib/icontrol/global_lb/link.rb', line 40

def add_ip(opts)
  check_params(opts,[:ips])
  super
end

- (LinkStatistics) all_statistics

Gets the statistics for all the link.

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.



85
86
87
# File 'lib/icontrol/global_lb/link.rb', line 85

def all_statistics
  super
end

- (LinkCostSegment[]) cost_segment

Gets the list of cost segments for this link.

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/global_lb/link.rb', line 96

def cost_segment
  super
end

- (Object) create(opts)

Creates this link.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :data_centers (String)

    The data centers associated with the links.

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.



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

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

- (String) data_center

Gets the data centers that this link belong to.

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.



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

def data_center
  super
end

Deletes all link.

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.



64
65
66
# File 'lib/icontrol/global_lb/link.rb', line 64

def delete_all_links
  super
end

Deletes this link.

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/global_lb/link.rb', line 74

def delete_link
  super
end

- (EnabledState) duplex_state

Gets the states indicating whether this link use duplex.

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.



118
119
120
# File 'lib/icontrol/global_lb/link.rb', line 118

def duplex_state
  super
end

- (EnabledState) enabled_state

Gets the enabled state of this link.

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.



129
130
131
# File 'lib/icontrol/global_lb/link.rb', line 129

def enabled_state
  super
end

- (LinkMetricLimit) inbound_limit

Gets the inbound limits for link metrics.

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.



140
141
142
# File 'lib/icontrol/global_lb/link.rb', line 140

def inbound_limit
  super
end

- (LinkIPDefinition) ip

Gets the IP addresses that belong to this link.

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.



151
152
153
# File 'lib/icontrol/global_lb/link.rb', line 151

def ip
  super
end

- (String) isp_name

Gets the ISP names for this link.

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.



162
163
164
# File 'lib/icontrol/global_lb/link.rb', line 162

def isp_name
  super
end

- (String) list

Gets a list of link.

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.



173
174
175
# File 'lib/icontrol/global_lb/link.rb', line 173

def list
  super
end

- (MonitorAssociation) monitor_association

Gets the monitor associations for this link, i.e. the monitor rules used by the link.

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.



184
185
186
# File 'lib/icontrol/global_lb/link.rb', line 184

def monitor_association
  super
end

- (ObjectStatus) object_status

Gets the statuses of this link.

Returns:

  • (ObjectStatus)

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.



195
196
197
# File 'lib/icontrol/global_lb/link.rb', line 195

def object_status
  super
end

- (LinkMetricLimit) outbound_limit

Gets the outbound limits for link metrics.

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.



206
207
208
# File 'lib/icontrol/global_lb/link.rb', line 206

def outbound_limit
  super
end

- (ULong64) prepaid_traffic

Gets the prepaid traffic bandwidth values for this link.

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.



217
218
219
# File 'lib/icontrol/global_lb/link.rb', line 217

def prepaid_traffic
  super
end

- (long) ratio

Gets the ratios used to load-balance the traffic for this link.

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.



228
229
230
# File 'lib/icontrol/global_lb/link.rb', line 228

def ratio
  super
end

- (Object) remove_all_cost_segments

Removes any and all cost segment of this link.

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.



290
291
292
# File 'lib/icontrol/global_lb/link.rb', line 290

def remove_all_cost_segments
  super
end

- (Object) remove_cost_segment(opts)

Removes the cost segments for this link.

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.



302
303
304
305
# File 'lib/icontrol/global_lb/link.rb', line 302

def remove_cost_segment(opts)
  check_params(opts,[:cost_segments])
  super
end

- (Object) remove_ip(opts)

Removes the IP addresses from this link.

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.



315
316
317
318
# File 'lib/icontrol/global_lb/link.rb', line 315

def remove_ip(opts)
  check_params(opts,[:ips])
  super
end

- (Object) remove_monitor_association

Removes the monitor associations for this link. This basically deletes the monitor associations between a link and a monitor rule, i.e. this link will no longer be monitored.

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.



328
329
330
# File 'lib/icontrol/global_lb/link.rb', line 328

def remove_monitor_association
  super
end

- (Object) reset_statistics

Resets the statistics for this link.

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.



338
339
340
# File 'lib/icontrol/global_lb/link.rb', line 338

def reset_statistics
  super
end

- (Object) set_data_center(opts)

Moves this link to the new data centers.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :data_centers (String)

    The names of the new data centers.

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.



350
351
352
353
# File 'lib/icontrol/global_lb/link.rb', line 350

def set_data_center(opts)
  check_params(opts,[:data_centers])
  super
end

- (Object) set_duplex_state(opts)

Sets the states indicating whether this link use duplex.

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.



363
364
365
366
# File 'lib/icontrol/global_lb/link.rb', line 363

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

- (Object) set_enabled_state(opts)

Sets the enabled state of this link.

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.



376
377
378
379
# File 'lib/icontrol/global_lb/link.rb', line 376

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

- (Object) set_inbound_limit(opts)

Sets the inbound limits for link metrics.

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.



389
390
391
392
# File 'lib/icontrol/global_lb/link.rb', line 389

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

- (Object) set_isp_name(opts)

Sets the ISP names for this link.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :isp_names (String)

    The ISP names.

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.



402
403
404
405
# File 'lib/icontrol/global_lb/link.rb', line 402

def set_isp_name(opts)
  check_params(opts,[:isp_names])
  super
end

- (Object) set_monitor_association(opts)

Sets/creates the monitor associations for this link. This basically creates the monitor associations between a link and a monitor 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.



416
417
418
419
# File 'lib/icontrol/global_lb/link.rb', line 416

def set_monitor_association(opts)
  check_params(opts,[:monitor_associations])
  super
end

- (Object) set_outbound_limit(opts)

Sets the outbound limits for link metrics.

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.



429
430
431
432
# File 'lib/icontrol/global_lb/link.rb', line 429

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

- (Object) set_prepaid_traffic(opts)

Sets the prepaid traffic bandwidth values for this link.

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.



442
443
444
445
# File 'lib/icontrol/global_lb/link.rb', line 442

def set_prepaid_traffic(opts)
  check_params(opts,[:prepaids])
  super
end

- (Object) set_ratio(opts)

Sets the ratios used to load-balance the traffic for this link.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ratios (long)

    The ratios 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.



455
456
457
458
# File 'lib/icontrol/global_lb/link.rb', line 455

def set_ratio(opts)
  check_params(opts,[:ratios])
  super
end

- (Object) set_total_limit(opts)

Sets the total limits for link metrics.

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.



468
469
470
471
# File 'lib/icontrol/global_lb/link.rb', line 468

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

Sets the IP addresses on the uplink side of the router, used for SNMP probing only.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :uplinks (String)

    The uplink addresses.

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.



481
482
483
484
# File 'lib/icontrol/global_lb/link.rb', line 481

def set_uplink_address(opts)
  check_params(opts,[:uplinks])
  super
end

- (Object) set_weight_type(opts)

Sets the weight types for this link.

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.



494
495
496
497
# File 'lib/icontrol/global_lb/link.rb', line 494

def set_weight_type(opts)
  check_params(opts,[:weight_types])
  super
end

- (LinkStatistics) statistics

Gets the statistics for this link.

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.



239
240
241
# File 'lib/icontrol/global_lb/link.rb', line 239

def statistics
  super
end

- (LinkMetricLimit) total_limit

Gets the total limits for link metrics.

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.



250
251
252
# File 'lib/icontrol/global_lb/link.rb', line 250

def total_limit
  super
end

Gets the IP addresses on the uplink side of the router, used for SNMP probing only.

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.



261
262
263
# File 'lib/icontrol/global_lb/link.rb', line 261

def uplink_address
  super
end

- (String) version

Gets the version information for this interface.

Returns:

  • (String)


269
270
271
# File 'lib/icontrol/global_lb/link.rb', line 269

def version
  super
end

- (LinkWeightType) weight_type

Gets the weight types for this link.

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.



280
281
282
# File 'lib/icontrol/global_lb/link.rb', line 280

def weight_type
  super
end