Class: IControl::LocalLB::VirtualServer

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

Overview

The VirtualServer interface enables you to work with the states, statistics, limits, availability, and settings of a local load balancer's virtual servers. For example, you can use the Virtual Server interface to create a virtual server from a specified pool or rule or to delete a virtual server from a specified pool.

Defined Under Namespace

Classes: VirtualServerAuthentication, VirtualServerAuthenticationSequence, VirtualServerAuthenticationSequenceSequence, VirtualServerCMPEnableMode, VirtualServerCMPEnableModeSequence, VirtualServerClonePool, VirtualServerClonePoolSequence, VirtualServerClonePoolSequenceSequence, VirtualServerHttpClass, VirtualServerHttpClassSequence, VirtualServerHttpClassSequenceSequence, VirtualServerModuleScore, VirtualServerModuleScoreSequence, VirtualServerModuleScoreSequenceSequence, VirtualServerPersistence, VirtualServerPersistenceSequence, VirtualServerPersistenceSequenceSequence, VirtualServerProfile, VirtualServerProfileAttribute, VirtualServerProfileAttributeSequence, VirtualServerProfileAttributeSequenceSequence, VirtualServerProfileSequence, VirtualServerProfileSequenceSequence, VirtualServerResource, VirtualServerResourceSequence, VirtualServerRule, VirtualServerRuleSequence, VirtualServerRuleSequenceSequence, VirtualServerStatisticEntry, VirtualServerStatisticEntrySequence, VirtualServerStatistics, VirtualServerType, VirtualServerTypeSequence

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

#actual_hardware_accelerationHardwareAccelerationMode

Gets the actual hardware acceleration modes for this virtual server.

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.



180
181
182
# File 'lib/icontrol/local_lb/virtual_server.rb', line 180

def actual_hardware_acceleration
  super
end

#add_authentication_profile(opts) ⇒ Object

Adds/associates authentication profiles to this virtual server.

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.



53
54
55
56
# File 'lib/icontrol/local_lb/virtual_server.rb', line 53

def add_authentication_profile(opts)
  check_params(opts,[:profiles])
  super
end

#add_clone_pool(opts) ⇒ Object

Adds/associates clone pools to this virtual server.

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.



66
67
68
69
# File 'lib/icontrol/local_lb/virtual_server.rb', line 66

def add_clone_pool(opts)
  check_params(opts,[:clone_pools])
  super
end

#add_httpclass_profile(opts) ⇒ Object

Adds/associates HTTP class profiles to this virtual server.

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.



79
80
81
82
# File 'lib/icontrol/local_lb/virtual_server.rb', line 79

def add_httpclass_profile(opts)
  check_params(opts,[:profiles])
  super
end

#add_persistence_profile(opts) ⇒ Object

Adds/associates persistence profiles to this virtual server.

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.



92
93
94
95
# File 'lib/icontrol/local_lb/virtual_server.rb', line 92

def add_persistence_profile(opts)
  check_params(opts,[:profiles])
  super
end

#add_profile(opts) ⇒ Object

Adds/associates profiles to this virtual server.

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.



105
106
107
108
# File 'lib/icontrol/local_lb/virtual_server.rb', line 105

def add_profile(opts)
  check_params(opts,[:profiles])
  super
end

#add_rule(opts) ⇒ Object

Adds/associates rules to this virtual server.

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.



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

def add_rule(opts)
  check_params(opts,[:rules])
  super
end

#all_statisticsVirtualServerStatistics

Gets the statistics for all the virtual server.

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.



191
192
193
# File 'lib/icontrol/local_lb/virtual_server.rb', line 191

def all_statistics
  super
end

#authentication_profileVirtualServerAuthentication[]

Gets the lists of authentication profiles this virtual server are associated with.

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.



202
203
204
# File 'lib/icontrol/local_lb/virtual_server.rb', line 202

def authentication_profile
  super
end

#clone_poolVirtualServerClonePool[]

Gets the lists of clone pools this virtual server are associated with.

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.



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

def clone_pool
  super
end

#cmp_enable_modeVirtualServerCMPEnableMode

Gets the CMP enable modes from this virtual server. This is read-only, as the modes are set according to the system and configuration, and influenced by the desired CMP enabled state.

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.



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

def cmp_enable_mode
  super
end

#cmp_enabled_stateEnabledState

Gets the CMP enabled states for this virtual server. Enables or disables CMP. Note that this setting can influence the CMP enable mode set automatically by the system and configuration. You can not always enable CMP, but you can always disable it.

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/local_lb/virtual_server.rb', line 239

def cmp_enabled_state
  super
end

#connection_limitULong64

Gets the connection limits for this virtual server.

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/local_lb/virtual_server.rb', line 250

def connection_limit
  super
end

#connection_mirror_stateEnabledState

Gets the mirror connection states for this virtual server.

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/local_lb/virtual_server.rb', line 261

def connection_mirror_state
  super
end

#create(opts) ⇒ Object

Creates or updates virtual server from this resources. Takes additional, optional parameters that enable you to override the default optional values.

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.



135
136
137
138
# File 'lib/icontrol/local_lb/virtual_server.rb', line 135

def create(opts)
  check_params(opts,[:definitions,:wildmasks,:resources,:profiles])
  super
end

#default_pool_nameString

Gets the default pool names for this virtual server.

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/virtual_server.rb', line 272

def default_pool_name
  super
end

#delete_all_virtual_serversObject

Deletes all virtual server.

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.



146
147
148
# File 'lib/icontrol/local_lb/virtual_server.rb', line 146

def delete_all_virtual_servers
  super
end

#delete_persistence_record(opts) ⇒ Object

Deletes the persistence records based on this persistent modes for this virtual server.

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 virtual server.

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.



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

def delete_persistence_record(opts)
  check_params(opts,[:persistence_modes])
  super
end

#delete_virtual_serverObject

Deletes this virtual server.

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.



169
170
171
# File 'lib/icontrol/local_lb/virtual_server.rb', line 169

def delete_virtual_server
  super
end

#destinationIPPortDefinition

Gets the destination IP and port of this virtual server.

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/virtual_server.rb', line 283

def destination
  super
end

#enabled_stateEnabledState

Gets the enabled state of this virtual server.

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.



294
295
296
# File 'lib/icontrol/local_lb/virtual_server.rb', line 294

def enabled_state
  super
end

#fallback_persistence_profileString

Gets the persistence profiles to use for fallback persistence for this virtual server.

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.



305
306
307
# File 'lib/icontrol/local_lb/virtual_server.rb', line 305

def fallback_persistence_profile
  super
end

#gtm_scoreULong64

Returns the gtm scores for this virtual server.

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.



316
317
318
# File 'lib/icontrol/local_lb/virtual_server.rb', line 316

def gtm_score
  super
end

#httpclass_profileVirtualServerHttpClass[]

Gets the lists of HTTP class profiles this virtual server are associated with. If a specified virtual server is not associated with any HTTP class profile, then the list of HTTP class profiles for that virtual server will be empty.

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.



329
330
331
# File 'lib/icontrol/local_lb/virtual_server.rb', line 329

def httpclass_profile
  super
end

#last_hop_poolString

Gets the last hop pools for this virtual server.

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.



340
341
342
# File 'lib/icontrol/local_lb/virtual_server.rb', line 340

def last_hop_pool
  super
end

#listString

Gets a list of virtual server.

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.



351
352
353
# File 'lib/icontrol/local_lb/virtual_server.rb', line 351

def list
  super
end

#module_scoreVirtualServerModuleScore[]

Returns the module scores for this virtual server.

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.



362
363
364
# File 'lib/icontrol/local_lb/virtual_server.rb', line 362

def module_score
  super
end

#object_statusObjectStatus

Gets the status of each of this virtual server.

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
# File 'lib/icontrol/local_lb/virtual_server.rb', line 373

def object_status
  super
end

#persistence_profileVirtualServerPersistence[]

Gets the lists of persistence profiles this virtual server are associated with.

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.



384
385
386
# File 'lib/icontrol/local_lb/virtual_server.rb', line 384

def persistence_profile
  super
end

#persistence_record(opts) ⇒ PersistenceRecord[]

Gets the persistence records based on this persistent modes for this virtual server.

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 virtual server.

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.



397
398
399
400
# File 'lib/icontrol/local_lb/virtual_server.rb', line 397

def persistence_record(opts)
  check_params(opts,[:persistence_modes])
  super
end

#profileVirtualServerProfileAttribute[]

Gets the lists of profiles this virtual server are associated with.

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.



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

def profile
  super
end

#protocolProtocolType

Gets the protocols supported by this virtual server.

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.



420
421
422
# File 'lib/icontrol/local_lb/virtual_server.rb', line 420

def protocol
  super
end

#rate_classString

Gets the rate classes that will be used to rate limit the traffic.

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.



431
432
433
# File 'lib/icontrol/local_lb/virtual_server.rb', line 431

def rate_class
  super
end

#remove_all_authentication_profilesObject

Removes all authentication profiles from this virtual server.

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.



563
564
565
# File 'lib/icontrol/local_lb/virtual_server.rb', line 563

def remove_all_authentication_profiles
  super
end

#remove_all_clone_poolsObject

Removes all clone pools from this virtual server.

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.



573
574
575
# File 'lib/icontrol/local_lb/virtual_server.rb', line 573

def remove_all_clone_pools
  super
end

#remove_all_httpclass_profilesObject

Removes all HTTP class profiles from this virtual server.

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.



583
584
585
# File 'lib/icontrol/local_lb/virtual_server.rb', line 583

def remove_all_httpclass_profiles
  super
end

#remove_all_persistence_profilesObject

Removes all persistence profiles from this virtual server.

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
# File 'lib/icontrol/local_lb/virtual_server.rb', line 593

def remove_all_persistence_profiles
  super
end

#remove_all_profilesObject

Removes all profiles from this virtual server.

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.



603
604
605
# File 'lib/icontrol/local_lb/virtual_server.rb', line 603

def remove_all_profiles
  super
end

#remove_all_rulesObject

Removes all rules from this virtual server.

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.



613
614
615
# File 'lib/icontrol/local_lb/virtual_server.rb', line 613

def remove_all_rules
  super
end

#remove_authentication_profile(opts) ⇒ Object

Removes authentication profiles from this virtual server.

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.



625
626
627
628
# File 'lib/icontrol/local_lb/virtual_server.rb', line 625

def remove_authentication_profile(opts)
  check_params(opts,[:profiles])
  super
end

#remove_clone_pool(opts) ⇒ Object

Removes clone pools from this virtual server.

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.



638
639
640
641
# File 'lib/icontrol/local_lb/virtual_server.rb', line 638

def remove_clone_pool(opts)
  check_params(opts,[:clone_pools])
  super
end

#remove_httpclass_profile(opts) ⇒ Object

Removes HTTP class profiles from this virtual server.

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.



651
652
653
654
# File 'lib/icontrol/local_lb/virtual_server.rb', line 651

def remove_httpclass_profile(opts)
  check_params(opts,[:profiles])
  super
end

#remove_persistence_profile(opts) ⇒ Object

Removes persistence profiles from this virtual server.

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.



664
665
666
667
# File 'lib/icontrol/local_lb/virtual_server.rb', line 664

def remove_persistence_profile(opts)
  check_params(opts,[:profiles])
  super
end

#remove_profile(opts) ⇒ Object

Removes profiles from this virtual server.

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.



677
678
679
680
# File 'lib/icontrol/local_lb/virtual_server.rb', line 677

def remove_profile(opts)
  check_params(opts,[:profiles])
  super
end

#remove_rule(opts) ⇒ Object

Removes rules from this virtual server.

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.



690
691
692
693
# File 'lib/icontrol/local_lb/virtual_server.rb', line 690

def remove_rule(opts)
  check_params(opts,[:rules])
  super
end

#reset_statisticsObject

Resets the statistics for this virtual server.

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.



701
702
703
# File 'lib/icontrol/local_lb/virtual_server.rb', line 701

def reset_statistics
  super
end

#ruleVirtualServerRule[]

Gets the lists of rules this virtual server are associated with. If a specified virtual server is not associated with any rule, then the list of rules for that virtual server will be empty.

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.



444
445
446
# File 'lib/icontrol/local_lb/virtual_server.rb', line 444

def rule
  super
end

#set_cmp_enabled_state(opts) ⇒ Object

Sets the CMP enabled states for this virtual server. Enables or disables CMP. Note that this setting can influence the CMP enable mode set automatically by the system and configuration. You can not always enable CMP, but you can always disable it.

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.



715
716
717
718
# File 'lib/icontrol/local_lb/virtual_server.rb', line 715

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

#set_connection_limit(opts) ⇒ Object

Sets the connection limits of this virtual server.

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.



728
729
730
731
# File 'lib/icontrol/local_lb/virtual_server.rb', line 728

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

#set_connection_mirror_state(opts) ⇒ Object

Sets the mirror connection states for this virtual server.

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.



741
742
743
744
# File 'lib/icontrol/local_lb/virtual_server.rb', line 741

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

#set_default_pool_name(opts) ⇒ Object

Sets the default pool names for this virtual server.

Options Hash (opts):

  • :default_pools (String)

    The default pool names for the specified virtual servers.

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.



754
755
756
757
# File 'lib/icontrol/local_lb/virtual_server.rb', line 754

def set_default_pool_name(opts)
  check_params(opts,[:default_pools])
  super
end

#set_destination(opts) ⇒ Object

Sets the destination IP and port for this virtual server.

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.



767
768
769
770
# File 'lib/icontrol/local_lb/virtual_server.rb', line 767

def set_destination(opts)
  check_params(opts,[:destinations])
  super
end

#set_enabled_state(opts) ⇒ Object

Sets the enabled state of this virtual server.

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.



780
781
782
783
# File 'lib/icontrol/local_lb/virtual_server.rb', line 780

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

#set_fallback_persistence_profile(opts) ⇒ Object

Sets the persistence profiles to use for fallback persistence for this virtual server.

Options Hash (opts):

  • :profile_names (String)

    The persistence profiles to use for fallback persistence for the specified virtual servers.

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.



793
794
795
796
# File 'lib/icontrol/local_lb/virtual_server.rb', line 793

def set_fallback_persistence_profile(opts)
  check_params(opts,[:profile_names])
  super
end

#set_gtm_score(opts) ⇒ Object

Sets the gtm score for this virtual server.

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.



806
807
808
809
# File 'lib/icontrol/local_lb/virtual_server.rb', line 806

def set_gtm_score(opts)
  check_params(opts,[:scores])
  super
end

#set_last_hop_pool(opts) ⇒ Object

Sets the last hop pools for this virtual server.

Options Hash (opts):

  • :last_hop_pools (String)

    The last hop pools of the specified virtual servers. Empty strings remove the last hop pools from the specified virtual servers.

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.



819
820
821
822
# File 'lib/icontrol/local_lb/virtual_server.rb', line 819

def set_last_hop_pool(opts)
  check_params(opts,[:last_hop_pools])
  super
end

#set_protocol(opts) ⇒ Object

Sets the protocols supported by this virtual server, one of IP, TCP or UDP.

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.



832
833
834
835
# File 'lib/icontrol/local_lb/virtual_server.rb', line 832

def set_protocol(opts)
  check_params(opts,[:protocols])
  super
end

#set_rate_class(opts) ⇒ Object

Sets the rate classes that will be used to rate limit the traffic.

Options Hash (opts):

  • :rate_classes (String)

    The rate classes used to rate limit the traffic.

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.



845
846
847
848
# File 'lib/icontrol/local_lb/virtual_server.rb', line 845

def set_rate_class(opts)
  check_params(opts,[:rate_classes])
  super
end

#set_snat_automapObject

Sets the SNAT automap state for this virtual server.

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.



856
857
858
# File 'lib/icontrol/local_lb/virtual_server.rb', line 856

def set_snat_automap
  super
end

#set_snat_noneObject

Sets the state to use no SNATs for this virtual server.

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.



866
867
868
# File 'lib/icontrol/local_lb/virtual_server.rb', line 866

def set_snat_none
  super
end

#set_snat_pool(opts) ⇒ Object

Sets the SNAT pools to be used in iSNAT configurations for this virtual server.

Options Hash (opts):

  • :snatpools (String)

    The SNAT pools of the specified virtual servers.

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.



878
879
880
881
# File 'lib/icontrol/local_lb/virtual_server.rb', line 878

def set_snat_pool(opts)
  check_params(opts,[:snatpools])
  super
end

#set_source_port_behavior(opts) ⇒ Object

Sets the source port behavior for this virtual server.

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.



891
892
893
894
# File 'lib/icontrol/local_lb/virtual_server.rb', line 891

def set_source_port_behavior(opts)
  check_params(opts,[:source_port_behaviors])
  super
end

#set_translate_address_state(opts) ⇒ Object

Sets the address translation states for this virtual server. Enables or disables address translation.

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.



905
906
907
908
# File 'lib/icontrol/local_lb/virtual_server.rb', line 905

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

#set_translate_port_state(opts) ⇒ Object

Sets the port translation states for this virtual server. Enables or disables port translation.

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.



919
920
921
922
# File 'lib/icontrol/local_lb/virtual_server.rb', line 919

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

#set_type(opts) ⇒ Object

Sets the types for this virtual server.

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.



932
933
934
935
# File 'lib/icontrol/local_lb/virtual_server.rb', line 932

def set_type(opts)
  check_params(opts,[:types])
  super
end

#set_vlan(opts) ⇒ Object

Sets VLANs to the list of VLANs on which access to this Virtual Servers are enabled/disabled.

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.



945
946
947
948
# File 'lib/icontrol/local_lb/virtual_server.rb', line 945

def set_vlan(opts)
  check_params(opts,[:vlans])
  super
end

#set_wildmask(opts) ⇒ Object

Sets the wildmasks for this virtual server.

Options Hash (opts):

  • :wildmasks (String)

    The wildmasks for the specified virtual servers.

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.



958
959
960
961
# File 'lib/icontrol/local_lb/virtual_server.rb', line 958

def set_wildmask(opts)
  check_params(opts,[:wildmasks])
  super
end

#snat_poolString

Gets the SNAT pools to be used in iSNAT configurations for this virtual server.

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
# File 'lib/icontrol/local_lb/virtual_server.rb', line 455

def snat_pool
  super
end

#snat_typeSnatType

Gets the SNAT type for this virtual server.

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.



466
467
468
# File 'lib/icontrol/local_lb/virtual_server.rb', line 466

def snat_type
  super
end

#source_port_behaviorSourcePortBehavior

Gets the source port behavior for this virtual server.

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.



477
478
479
# File 'lib/icontrol/local_lb/virtual_server.rb', line 477

def source_port_behavior
  super
end

#statisticsVirtualServerStatistics

Gets the statistics for this virtual server.

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.



488
489
490
# File 'lib/icontrol/local_lb/virtual_server.rb', line 488

def statistics
  super
end

#translate_address_stateEnabledState

Gets the address translation states for this virtual server. Enables or disables address translation.

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.



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

def translate_address_state
  super
end

#translate_port_stateEnabledState

Gets the port translation states for this virtual server. Enables or disables port translation.

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
# File 'lib/icontrol/local_lb/virtual_server.rb', line 512

def translate_port_state
  super
end

#typeVirtualServerType

Gets the types of this virtual server.

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.



523
524
525
# File 'lib/icontrol/local_lb/virtual_server.rb', line 523

def type
  super
end

#versionString

Gets the version information for this interface.



531
532
533
# File 'lib/icontrol/local_lb/virtual_server.rb', line 531

def version
  super
end

#vlanVLANFilterList

Gets the lists of VLANs on which access to this Virtual Servers are enabled/disabled.

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.



542
543
544
# File 'lib/icontrol/local_lb/virtual_server.rb', line 542

def vlan
  super
end

#wildmaskString

Gets the wildmasks for this virtual server.

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
# File 'lib/icontrol/local_lb/virtual_server.rb', line 553

def wildmask
  super
end