Class: IControl::GlobalLB::Pool

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

Overview

The Pool interface enables you to work with pools and their attributes.

Defined Under Namespace

Classes: MonitorAssociation, MonitorAssociationSequence, PoolMemberDefinition, PoolMemberDefinitionSequence, PoolMemberDefinitionSequenceSequence, PoolMetricLimit, PoolMetricLimitSequence, PoolStatisticEntry, PoolStatisticEntrySequence, PoolStatistics

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_member(opts) ⇒ Object

Adds members to this pool.

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.



25
26
27
28
 
# File 'lib/icontrol/global_lb/pool.rb', line 25

def add_member(opts)
  opts = check_params(opts,[:members])
  super(opts)
end

#all_statistics ⇒ PoolStatistics

Gets the statistics for all the pool.

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.



71
72
73
 
# File 'lib/icontrol/global_lb/pool.rb', line 71

def all_statistics
  super
end

#alternate_lb_method ⇒ LBMethod

Gets the alternate load balancing methods for this pool.

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.



82
83
84
 
# File 'lib/icontrol/global_lb/pool.rb', line 82

def alternate_lb_method
  super
end

#answers_to_return ⇒ long

Gets the number of answers to return for this pool.

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.



93
94
95
 
# File 'lib/icontrol/global_lb/pool.rb', line 93

def answers_to_return
  super
end

#cname ⇒ String

Gets the CNAMEs for this pool.

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.



104
105
106
 
# File 'lib/icontrol/global_lb/pool.rb', line 104

def cname
  super
end

#create(opts) ⇒ Object

Creates this pool.

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.



39
40
41
42
 
# File 'lib/icontrol/global_lb/pool.rb', line 39

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

#delete_all_pools ⇒ Object

Deletes all pool.

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/global_lb/pool.rb', line 50

def delete_all_pools
  super
end

#delete_pool ⇒ Object

Deletes this pool.

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.



60
61
62
 
# File 'lib/icontrol/global_lb/pool.rb', line 60

def delete_pool
  super
end

#dynamic_ratio_state ⇒ EnabledState

Gets the states to indicate whether to use dynamic ratio to modify the behavior of QOS.

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.



116
117
118
 
# File 'lib/icontrol/global_lb/pool.rb', line 116

def dynamic_ratio_state
  super
end

#enabled_state ⇒ EnabledState

Gets the enabled state of this pool.

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.



127
128
129
 
# File 'lib/icontrol/global_lb/pool.rb', line 127

def enabled_state
  super
end

#fallback_ip ⇒ String

Gets the fallback/emergency failure IP for this pool.

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.



138
139
140
 
# File 'lib/icontrol/global_lb/pool.rb', line 138

def fallback_ip
  super
end

#fallback_lb_method ⇒ LBMethod

Gets the fallback load balancing methods for this pool.

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.



149
150
151
 
# File 'lib/icontrol/global_lb/pool.rb', line 149

def fallback_lb_method
  super
end

#limit ⇒ PoolMetricLimit

Gets all metrics limits for a sequence of pool.

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.



160
161
162
 
# File 'lib/icontrol/global_lb/pool.rb', line 160

def limit
  super
end

#list ⇒ String

Gets a list of pool.

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.



171
172
173
 
# File 'lib/icontrol/global_lb/pool.rb', line 171

def list
  super
end

#manual_resume_state ⇒ EnabledState

Gets the states indicating whether to disable pool members when pool member status goes from Green to Red.

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.



183
184
185
 
# File 'lib/icontrol/global_lb/pool.rb', line 183

def manual_resume_state
  super
end

#member ⇒ PoolMemberDefinition[]

Gets a list of pool members.

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.



194
195
196
 
# File 'lib/icontrol/global_lb/pool.rb', line 194

def member
  super
end

#monitor_association ⇒ MonitorAssociation

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

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.



205
206
207
 
# File 'lib/icontrol/global_lb/pool.rb', line 205

def monitor_association
  super
end

#object_status ⇒ ObjectStatus

Gets the statuses of this pool.

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.



216
217
218
 
# File 'lib/icontrol/global_lb/pool.rb', line 216

def object_status
  super
end

#preferred_lb_method ⇒ LBMethod

Gets the preferred load balancing methods for this pool.

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.



227
228
229
 
# File 'lib/icontrol/global_lb/pool.rb', line 227

def preferred_lb_method
  super
end

#qos_coefficient_bps ⇒ long

Gets the relative weight for bits per second when the load balancing mode is set to LB_METHOD_QOS.

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.



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

def qos_coefficient_bps
  super
end

#qos_coefficient_connection_rate ⇒ long

Gets the relative weight for connection rate when the load balancing mode is set to LB_METHOD_QOS. This function is deprecated and new applications should use vs_score.

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.



251
252
253
 
# File 'lib/icontrol/global_lb/pool.rb', line 251

def qos_coefficient_connection_rate
  super
end

#qos_coefficient_hit_ratio ⇒ long

Gets the relative weight for ping packet completion rate when the load balancing mode is set to LB_METHOD_QOS.

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.



263
264
265
 
# File 'lib/icontrol/global_lb/pool.rb', line 263

def qos_coefficient_hit_ratio
  super
end

#qos_coefficient_hops ⇒ long

Gets the relative weight for hops when the load balancing mode is set to LB_METHOD_QOS.

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.



274
275
276
 
# File 'lib/icontrol/global_lb/pool.rb', line 274

def qos_coefficient_hops
  super
end

#qos_coefficient_lcs ⇒ long

Gets the relative weight for link capacity when the load balancing mode is set to LB_METHOD_QOS.

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.



286
287
288
 
# File 'lib/icontrol/global_lb/pool.rb', line 286

def qos_coefficient_lcs
  super
end

#qos_coefficient_packet_rate ⇒ long

Gets the relative weight for packet rate when the load balancing mode is set to LB_METHOD_QOS.

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.



297
298
299
 
# File 'lib/icontrol/global_lb/pool.rb', line 297

def qos_coefficient_packet_rate
  super
end

#qos_coefficient_rtt ⇒ long

Gets the relative weight for round-trip time when the load balancing mode is set to LB_METHOD_QOS.

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.



309
310
311
 
# File 'lib/icontrol/global_lb/pool.rb', line 309

def qos_coefficient_rtt
  super
end

#qos_coefficient_topology ⇒ long

Gets the relative weight for topology when the load balancing mode is set to LB_METHOD_QOS.

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.



320
321
322
 
# File 'lib/icontrol/global_lb/pool.rb', line 320

def qos_coefficient_topology
  super
end

#qos_coefficient_vs_capacity ⇒ long

Gets the relative weight for virtual server capacity when the load balancing mode is set to LB_METHOD_QOS.

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.



332
333
334
 
# File 'lib/icontrol/global_lb/pool.rb', line 332

def qos_coefficient_vs_capacity
  super
end

#qos_coefficient_vs_score ⇒ long

Gets the relative weight for virtual server (VS) score when the load balancing mode is set to LB_METHOD_QOS.

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.



344
345
346
 
# File 'lib/icontrol/global_lb/pool.rb', line 344

def qos_coefficient_vs_score
  super
end

#remove_member(opts) ⇒ Object

Removes members from this pool.

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.



398
399
400
401
 
# File 'lib/icontrol/global_lb/pool.rb', line 398

def remove_member(opts)
  opts = check_params(opts,[:members])
  super(opts)
end

#remove_monitor_association ⇒ Object

Removes the monitor associations for this pool. This basically deletes the monitor associations between a pool and a monitor rule, i.e. this pool 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.



411
412
413
 
# File 'lib/icontrol/global_lb/pool.rb', line 411

def remove_monitor_association
  super
end

#reset_statistics ⇒ Object

Resets the statistics for this pool.

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.



421
422
423
 
# File 'lib/icontrol/global_lb/pool.rb', line 421

def reset_statistics
  super
end

#set_alternate_lb_method(opts) ⇒ Object

Sets the alternate load balancing methods for this pool.

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.



433
434
435
436
 
# File 'lib/icontrol/global_lb/pool.rb', line 433

def set_alternate_lb_method(opts)
  opts = check_params(opts,[:lb_methods])
  super(opts)
end

#set_answers_to_return(opts) ⇒ Object

Sets the number of answers to return for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :answers (long) —

    The Round Robin LDNS limits to set for the pools.

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.



446
447
448
449
 
# File 'lib/icontrol/global_lb/pool.rb', line 446

def set_answers_to_return(opts)
  opts = check_params(opts,[:answers])
  super(opts)
end

#set_cname(opts) ⇒ Object

Sets the CNAMEs for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :cnames (String) —

    The CNAMEs for the specified pools.

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.



459
460
461
462
 
# File 'lib/icontrol/global_lb/pool.rb', line 459

def set_cname(opts)
  opts = check_params(opts,[:cnames])
  super(opts)
end

#set_dynamic_ratio_state(opts) ⇒ Object

Sets the states to indicate whether to use dynamic ratio to modify the behavior of QOS.

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.



473
474
475
476
 
# File 'lib/icontrol/global_lb/pool.rb', line 473

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

#set_enabled_state(opts) ⇒ Object

Sets the enabled state of this pool.

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.



486
487
488
489
 
# File 'lib/icontrol/global_lb/pool.rb', line 486

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

#set_fallback_ip(opts) ⇒ Object

Sets the fallback/emergency failure IP for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :ips (String) —

    The fallback IP addresses for the specified pools.

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.



499
500
501
502
 
# File 'lib/icontrol/global_lb/pool.rb', line 499

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

#set_fallback_lb_method(opts) ⇒ Object

Sets the fallback load balancing methods for this pool.

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.



512
513
514
515
 
# File 'lib/icontrol/global_lb/pool.rb', line 512

def set_fallback_lb_method(opts)
  opts = check_params(opts,[:lb_methods])
  super(opts)
end

#set_limit(opts) ⇒ Object

Sets the limits for pool 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.



525
526
527
528
 
# File 'lib/icontrol/global_lb/pool.rb', line 525

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

#set_manual_resume_state(opts) ⇒ Object

Sets the states indicating whether to disable pool members when pool member status goes from Green to Red.

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.



539
540
541
542
 
# File 'lib/icontrol/global_lb/pool.rb', line 539

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

#set_monitor_association(opts) ⇒ Object

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



553
554
555
556
 
# File 'lib/icontrol/global_lb/pool.rb', line 553

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

#set_preferred_lb_method(opts) ⇒ Object

Sets the preferred load balancing methods for this pool.

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.



566
567
568
569
 
# File 'lib/icontrol/global_lb/pool.rb', line 566

def set_preferred_lb_method(opts)
  opts = check_params(opts,[:lb_methods])
  super(opts)
end

#set_qos_coefficient_bps(opts) ⇒ Object

Sets the relative weight for bits per second when the load balancing mode is set to LB_METHOD_QOS.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The bits per second QoS coefficients of the specified pools.

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.



580
581
582
583
 
# File 'lib/icontrol/global_lb/pool.rb', line 580

def set_qos_coefficient_bps(opts)
  opts = check_params(opts,[:values])
  super(opts)
end

#set_qos_coefficient_connection_rate(opts) ⇒ Object

Sets the relative weight for connection rate when the load balancing mode is set to LB_METHOD_QOS. This function is deprecated and new applications should use vs_score.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The connection rate QoS coefficients of the specified pools.

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.



594
595
596
597
 
# File 'lib/icontrol/global_lb/pool.rb', line 594

def set_qos_coefficient_connection_rate(opts)
  opts = check_params(opts,[:values])
  super(opts)
end

#set_qos_coefficient_hit_ratio(opts) ⇒ Object

Sets the relative weight for ping packet completion rate when the load balancing mode is set to LB_METHOD_QOS.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The ping packet completion rate QoS coefficients of the specified pools.

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.



608
609
610
611
 
# File 'lib/icontrol/global_lb/pool.rb', line 608

def set_qos_coefficient_hit_ratio(opts)
  opts = check_params(opts,[:values])
  super(opts)
end

#set_qos_coefficient_hops(opts) ⇒ Object

Sets the relative weight for hops when the load balancing mode is set to LB_METHOD_QOS.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The hops QoS coefficients of the specified pools.

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.



621
622
623
624
 
# File 'lib/icontrol/global_lb/pool.rb', line 621

def set_qos_coefficient_hops(opts)
  opts = check_params(opts,[:values])
  super(opts)
end

#set_qos_coefficient_lcs(opts) ⇒ Object

Sets the relative weight for link capacity when the load balancing mode is set to LB_METHOD_QOS.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The link capacity QoS coefficients of the specified pools.

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.



635
636
637
638
 
# File 'lib/icontrol/global_lb/pool.rb', line 635

def set_qos_coefficient_lcs(opts)
  opts = check_params(opts,[:values])
  super(opts)
end

#set_qos_coefficient_packet_rate(opts) ⇒ Object

Sets the relative weight for packet rate when the load balancing mode is set to LB_METHOD_QOS.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The packet rate QoS coefficients of the specified pools.

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.



648
649
650
651
 
# File 'lib/icontrol/global_lb/pool.rb', line 648

def set_qos_coefficient_packet_rate(opts)
  opts = check_params(opts,[:values])
  super(opts)
end

#set_qos_coefficient_rtt(opts) ⇒ Object

Sets the relative weight for round-trip time when the load balancing mode is set to LB_METHOD_QOS.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The RTT QoS coefficients of the specified pools.

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.



662
663
664
665
 
# File 'lib/icontrol/global_lb/pool.rb', line 662

def set_qos_coefficient_rtt(opts)
  opts = check_params(opts,[:values])
  super(opts)
end

#set_qos_coefficient_topology(opts) ⇒ Object

Sets the relative weight for topology when the load balancing mode is set to LB_METHOD_QOS.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The topology QoS coefficients of the specified pools.

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.



675
676
677
678
 
# File 'lib/icontrol/global_lb/pool.rb', line 675

def set_qos_coefficient_topology(opts)
  opts = check_params(opts,[:values])
  super(opts)
end

#set_qos_coefficient_vs_capacity(opts) ⇒ Object

Sets the relative weight for virtual server capacity when the load balancing mode is set to LB_METHOD_QOS.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The virtual server capacity QoS coefficients of the specified pools.

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.



689
690
691
692
 
# File 'lib/icontrol/global_lb/pool.rb', line 689

def set_qos_coefficient_vs_capacity(opts)
  opts = check_params(opts,[:values])
  super(opts)
end

#set_qos_coefficient_vs_score(opts) ⇒ Object

Sets the relative weight for virtual server (VS) score when the load balancing mode is set to LB_METHOD_QOS.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The VS score QoS coefficients of the specified pools.

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.



703
704
705
706
 
# File 'lib/icontrol/global_lb/pool.rb', line 703

def set_qos_coefficient_vs_score(opts)
  opts = check_params(opts,[:values])
  super(opts)
end

#set_ttl(opts) ⇒ Object

Sets the TTL values for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The TTLs of the specified pools.

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.



716
717
718
719
 
# File 'lib/icontrol/global_lb/pool.rb', line 716

def set_ttl(opts)
  opts = check_params(opts,[:values])
  super(opts)
end

#set_verify_member_availability_state(opts) ⇒ Object

Sets the states to indicate whether to check the availability of pool member availability before using them.

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.



730
731
732
733
 
# File 'lib/icontrol/global_lb/pool.rb', line 730

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

#statistics ⇒ PoolStatistics

Gets the statistics for this pool.

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.



355
356
357
 
# File 'lib/icontrol/global_lb/pool.rb', line 355

def statistics
  super
end

#ttl ⇒ long

Gets the TTL values for this pool.

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.



366
367
368
 
# File 'lib/icontrol/global_lb/pool.rb', line 366

def ttl
  super
end

#verify_member_availability_state ⇒ EnabledState

Gets the states to indicate whether to check the availability of pool member availability before using them.

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.



378
379
380
 
# File 'lib/icontrol/global_lb/pool.rb', line 378

def verify_member_availability_state
  super
end

#version ⇒ String

Gets the version information for this interface.

Returns:

  • (String) 


386
387
388
 
# File 'lib/icontrol/global_lb/pool.rb', line 386

def version
  super
end