Class: IControl::LocalLB::Pool

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

Overview

The Pool interface enables you to work with attributes, and statistics for pools. You can also use this interface to create pools, add members to a pool, delete members from a pool, find out the load balancing mode for a pool, and set the load balancing mode for a pool.

Defined Under Namespace

Classes: MonitorAssociation, MonitorAssociationSequence, 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

#action_on_service_down ⇒ ServiceDownAction

Gets the action to take when the node goes down 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/local_lb/pool.rb', line 82

def action_on_service_down
  super
end

#active_member_count ⇒ long

Gets the current active member counts 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/local_lb/pool.rb', line 93

def active_member_count
  super
end

#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.



23
24
25
26
 
# File 'lib/icontrol/local_lb/pool.rb', line 23

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

#aggregate_dynamic_ratio ⇒ long

Gets the aggregate dynamic ratio values from all the members of the 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.



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

def aggregate_dynamic_ratio
  super
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.



115
116
117
 
# File 'lib/icontrol/local_lb/pool.rb', line 115

def all_statistics
  super
end

#allow_nat_state ⇒ EnabledState

Gets the states indicating whether NATs are allowed for 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.



126
127
128
 
# File 'lib/icontrol/local_lb/pool.rb', line 126

def allow_nat_state
  super
end

#allow_snat_state ⇒ EnabledState

Gets the states indicating whether SNATs are allowed for 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.



137
138
139
 
# File 'lib/icontrol/local_lb/pool.rb', line 137

def allow_snat_state
  super
end

#client_ip_tos ⇒ long

Gets the IP ToS values for client traffic 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.



148
149
150
 
# File 'lib/icontrol/local_lb/pool.rb', line 148

def client_ip_tos
  super
end

#client_link_qos ⇒ long

Gets the link QoS values for client traffic 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.



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

def client_link_qos
  super
end

#create(opts) ⇒ Object

Creates a new 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.



37
38
39
40
 
# File 'lib/icontrol/local_lb/pool.rb', line 37

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.



48
49
50
 
# File 'lib/icontrol/local_lb/pool.rb', line 48

def delete_all_pools
  super
end

#delete_persistence_record(opts) ⇒ Object

Deletes the persistence records based on this persistent modes for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :persistence_modes (IControl::LocalLB::PersistenceMode) —

    The persistence modes from which we delete the persistence records. If the specified persistence mode is PERSIST_MODE_NONE, then all persistence records regardless of persistence mode will be deleted for that 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
63
 
# File 'lib/icontrol/local_lb/pool.rb', line 60

def delete_persistence_record(opts)
  opts = check_params(opts,[:persistence_modes])
  super(opts)
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.



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

def delete_pool
  super
end

#gateway_failsafe_unit_id ⇒ long

Gets the gateway failsafe unit IDs 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.



170
171
172
 
# File 'lib/icontrol/local_lb/pool.rb', line 170

def gateway_failsafe_unit_id
  super
end

#lb_method ⇒ LBMethod

Gets the 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.



181
182
183
 
# File 'lib/icontrol/local_lb/pool.rb', line 181

def lb_method
  super
end

#list ⇒ String

Gets a list of all 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.



192
193
194
 
# File 'lib/icontrol/local_lb/pool.rb', line 192

def list
  super
end

#member ⇒ IPPortDefinition[]

Gets a list of pool members.

Returns:

  • (IPPortDefinition[])

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.



203
204
205
 
# File 'lib/icontrol/local_lb/pool.rb', line 203

def member
  super
end

#members ⇒ Object 



3
4
5
 
# File 'lib/icontrol/base/icontrol_overlay/local_lb/pool.rb', line 3

def members
  @members ||= IControl::LocalLB::PoolMember.new(:id => id)
end

#minimum_active_member ⇒ long

Gets the minimum active member counts 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.



214
215
216
 
# File 'lib/icontrol/local_lb/pool.rb', line 214

def minimum_active_member
  super
end

#minimum_up_member ⇒ long

Gets the minimum member counts that are required to be UP 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.



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

def minimum_up_member
  super
end

#minimum_up_member_action ⇒ HAAction

Gets the actions to be taken if the minimum number of members required to be UP for this pool is not met.

Returns:

  • (HAAction)

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.



237
238
239
 
# File 'lib/icontrol/local_lb/pool.rb', line 237

def minimum_up_member_action
  super
end

#minimum_up_member_enabled_state ⇒ EnabledState

Gets the states indicating that the feature that requires a minimum number of members to be UP is enabled/disabled for 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.



249
250
251
 
# File 'lib/icontrol/local_lb/pool.rb', line 249

def minimum_up_member_enabled_state
  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.



260
261
262
 
# File 'lib/icontrol/local_lb/pool.rb', line 260

def monitor_association
  super
end

#monitor_instance ⇒ MonitorInstanceState[]

Gets the monitor instance information for this pool, i.e. the monitor instance information for the pool members of 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.



272
273
274
 
# File 'lib/icontrol/local_lb/pool.rb', line 272

def monitor_instance
  super
end

#object_status ⇒ ObjectStatus

Gets the statuses of 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.



283
284
285
 
# File 'lib/icontrol/local_lb/pool.rb', line 283

def object_status
  super
end

#persistence_record(opts) ⇒ PersistenceRecord[]

Gets the persistence records based on this persistent modes for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :persistence_modes (IControl::LocalLB::PersistenceMode) —

    The persistence modes from which we retrieve the persistence records. If the specified persistence mode is PERSIST_MODE_NONE, then all persistence records regardless of persistence mode will be returned for that 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.



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

def persistence_record(opts)
  opts = check_params(opts,[:persistence_modes])
  super(opts)
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.



373
374
375
376
 
# File 'lib/icontrol/local_lb/pool.rb', line 373

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.



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

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.



396
397
398
 
# File 'lib/icontrol/local_lb/pool.rb', line 396

def reset_statistics
  super
end

#server_ip_tos ⇒ long

Gets the IP ToS values for server traffic 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.



308
309
310
 
# File 'lib/icontrol/local_lb/pool.rb', line 308

def server_ip_tos
  super
end

#server_link_qos ⇒ long

Gets the link QoS values for server traffic 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.



319
320
321
 
# File 'lib/icontrol/local_lb/pool.rb', line 319

def server_link_qos
  super
end

#set_action_on_service_down(opts) ⇒ Object

Sets the action to take when the node goes down 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.



408
409
410
411
 
# File 'lib/icontrol/local_lb/pool.rb', line 408

def set_action_on_service_down(opts)
  opts = check_params(opts,[:actions])
  super(opts)
end

#set_allow_nat_state(opts) ⇒ Object

Sets the states indicating whether NATs are allowed 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.



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

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

#set_allow_snat_state(opts) ⇒ Object

Sets the states indicating whether SNATs are allowed 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.



434
435
436
437
 
# File 'lib/icontrol/local_lb/pool.rb', line 434

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

#set_client_ip_tos(opts) ⇒ Object

Sets the IP ToS values for client traffic for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The client IP ToS values.

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.



447
448
449
450
 
# File 'lib/icontrol/local_lb/pool.rb', line 447

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

#set_client_link_qos(opts) ⇒ Object

Sets the link QoS values for client traffic for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The client-side link QoS values.

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.



460
461
462
463
 
# File 'lib/icontrol/local_lb/pool.rb', line 460

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

#set_gateway_failsafe_unit_id(opts) ⇒ Object

Sets the gateway failsafe unit IDs for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :unit_ids (long) —

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



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

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

#set_lb_method(opts) ⇒ Object

Sets the 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.



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

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

#set_minimum_active_member(opts) ⇒ Object

Sets the minimum active member counts for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The minimum active member counts 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.



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

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

#set_minimum_up_member(opts) ⇒ Object

Sets the minimum member counts that are required to be UP for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The minimum UP member counts 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.



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

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

#set_minimum_up_member_action(opts) ⇒ Object

Sets the actions to be taken if the minimum number of members required to be UP for this pool is not met.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :actions (IControl::Common::HAAction) —

    The actions to be taken if the minimum number of members required to be UP for the specified pools is not met.

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.



526
527
528
529
 
# File 'lib/icontrol/local_lb/pool.rb', line 526

def set_minimum_up_member_action(opts)
  opts = check_params(opts,[:actions])
  super(opts)
end

#set_minimum_up_member_enabled_state(opts) ⇒ Object

Sets the states indicating that the feature that requires a minimum number of members to be UP is enabled/disabled 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.



540
541
542
543
 
# File 'lib/icontrol/local_lb/pool.rb', line 540

def set_minimum_up_member_enabled_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.



554
555
556
557
 
# File 'lib/icontrol/local_lb/pool.rb', line 554

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

#set_server_ip_tos(opts) ⇒ Object

Sets the IP ToS values for server traffic for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The server IP ToS values.

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.



567
568
569
570
 
# File 'lib/icontrol/local_lb/pool.rb', line 567

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

#set_server_link_qos(opts) ⇒ Object

Sets the link QoS values for server traffic for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The server link QoS values.

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/local_lb/pool.rb', line 580

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

#set_simple_timeout(opts) ⇒ Object

Sets the simple timeouts for this pool.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :simple_timeouts (long) —

    The simple timeouts.

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.



593
594
595
596
 
# File 'lib/icontrol/local_lb/pool.rb', line 593

def set_simple_timeout(opts)
  opts = check_params(opts,[:simple_timeouts])
  super(opts)
end

#set_slow_ramp_time(opts) ⇒ Object

Sets the ramp-up time (in seconds) to gradually ramp up the load on newly added or freshly detected UP pool members.

Parameters:

  • opts (Hash)

Options Hash (opts):

  • :values (long) —

    The ramp-up times.

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.



607
608
609
610
 
# File 'lib/icontrol/local_lb/pool.rb', line 607

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

#simple_timeout ⇒ long

Gets the simple timeouts 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.



330
331
332
 
# File 'lib/icontrol/local_lb/pool.rb', line 330

def simple_timeout
  super
end

#slow_ramp_time ⇒ long

Gets the ramp-up time (in seconds) to gradually ramp up the load on newly added or freshly detected UP pool members.

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.



342
343
344
 
# File 'lib/icontrol/local_lb/pool.rb', line 342

def slow_ramp_time
  super
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.



353
354
355
 
# File 'lib/icontrol/local_lb/pool.rb', line 353

def statistics
  super
end

#version ⇒ String

Gets the version information for this interface.

Returns:

  • (String) 


361
362
363
 
# File 'lib/icontrol/local_lb/pool.rb', line 361

def version
  super
end