Class: IControl::LocalLB::VirtualServer

Inherits:

Base

Object
Base
IControl::LocalLB::VirtualServer

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

Instance Method Summary (collapse)

- (HardwareAccelerationMode) actual_hardware_acceleration

Gets the actual hardware acceleration modes for this virtual server.
- (Object) add_authentication_profile(opts)

Adds/associates authentication profiles to this virtual server.
- (Object) add_clone_pool(opts)

Adds/associates clone pools to this virtual server.
- (Object) add_httpclass_profile(opts)

Adds/associates HTTP class profiles to this virtual server.
- (Object) add_persistence_profile(opts)

Adds/associates persistence profiles to this virtual server.
- (Object) add_profile(opts)

Adds/associates profiles to this virtual server.
- (Object) add_rule(opts)

Adds/associates rules to this virtual server.
- (VirtualServerStatistics) all_statistics

Gets the statistics for all the virtual server.
- (VirtualServerAuthentication[]) authentication_profile

Gets the lists of authentication profiles this virtual server are associated with.
- (VirtualServerClonePool[]) clone_pool

Gets the lists of clone pools this virtual server are associated with.
- (VirtualServerCMPEnableMode) cmp_enable_mode

Gets the CMP enable modes from this virtual server.
- (EnabledState) cmp_enabled_state

Gets the CMP enabled states for this virtual server.
- (ULong64) connection_limit

Gets the connection limits for this virtual server.
- (EnabledState) connection_mirror_state

Gets the mirror connection states for this virtual server.
- (Object) create(opts)

Creates or updates virtual server from this resources.
- (String) default_pool_name

Gets the default pool names for this virtual server.
- (Object) delete_all_virtual_servers

Deletes all virtual server.
- (Object) delete_persistence_record(opts)

Deletes the persistence records based on this persistent modes for this virtual server.
- (Object) delete_virtual_server

Deletes this virtual server.
- (IPPortDefinition) destination

Gets the destination IP and port of this virtual server.
- (EnabledState) enabled_state

Gets the enabled state of this virtual server.
- (String) fallback_persistence_profile

Gets the persistence profiles to use for fallback persistence for this virtual server.
- (ULong64) gtm_score

Returns the gtm scores for this virtual server.
- (VirtualServerHttpClass[]) httpclass_profile

Gets the lists of HTTP class profiles this virtual server are associated with.
- (String) last_hop_pool

Gets the last hop pools for this virtual server.
- (String) list

Gets a list of virtual server.
- (VirtualServerModuleScore[]) module_score

Returns the module scores for this virtual server.
- (ObjectStatus) object_status

Gets the status of each of this virtual server.
- (VirtualServerPersistence[]) persistence_profile

Gets the lists of persistence profiles this virtual server are associated with.
- (PersistenceRecord[]) persistence_record(opts)

Gets the persistence records based on this persistent modes for this virtual server.
- (VirtualServerProfileAttribute[]) profile

Gets the lists of profiles this virtual server are associated with.
- (ProtocolType) protocol

Gets the protocols supported by this virtual server.
- (String) rate_class

Gets the rate classes that will be used to rate limit the traffic.
- (Object) remove_all_authentication_profiles

Removes all authentication profiles from this virtual server.
- (Object) remove_all_clone_pools

Removes all clone pools from this virtual server.
- (Object) remove_all_httpclass_profiles

Removes all HTTP class profiles from this virtual server.
- (Object) remove_all_persistence_profiles

Removes all persistence profiles from this virtual server.
- (Object) remove_all_profiles

Removes all profiles from this virtual server.
- (Object) remove_all_rules

Removes all rules from this virtual server.
- (Object) remove_authentication_profile(opts)

Removes authentication profiles from this virtual server.
- (Object) remove_clone_pool(opts)

Removes clone pools from this virtual server.
- (Object) remove_httpclass_profile(opts)

Removes HTTP class profiles from this virtual server.
- (Object) remove_persistence_profile(opts)

Removes persistence profiles from this virtual server.
- (Object) remove_profile(opts)

Removes profiles from this virtual server.
- (Object) remove_rule(opts)

Removes rules from this virtual server.
- (Object) reset_statistics

Resets the statistics for this virtual server.
- (VirtualServerRule[]) rule

Gets the lists of rules this virtual server are associated with.
- (Object) set_cmp_enabled_state(opts)

Sets the CMP enabled states for this virtual server.
- (Object) set_connection_limit(opts)

Sets the connection limits of this virtual server.
- (Object) set_connection_mirror_state(opts)

Sets the mirror connection states for this virtual server.
- (Object) set_default_pool_name(opts)

Sets the default pool names for this virtual server.
- (Object) set_destination(opts)

Sets the destination IP and port for this virtual server.
- (Object) set_enabled_state(opts)

Sets the enabled state of this virtual server.
- (Object) set_fallback_persistence_profile(opts)

Sets the persistence profiles to use for fallback persistence for this virtual server.
- (Object) set_gtm_score(opts)

Sets the gtm score for this virtual server.
- (Object) set_last_hop_pool(opts)

Sets the last hop pools for this virtual server.
- (Object) set_protocol(opts)

Sets the protocols supported by this virtual server, one of IP, TCP or UDP.
- (Object) set_rate_class(opts)

Sets the rate classes that will be used to rate limit the traffic.
- (Object) set_snat_automap

Sets the SNAT automap state for this virtual server.
- (Object) set_snat_none

Sets the state to use no SNATs for this virtual server.
- (Object) set_snat_pool(opts)

Sets the SNAT pools to be used in iSNAT configurations for this virtual server.
- (Object) set_source_port_behavior(opts)

Sets the source port behavior for this virtual server.
- (Object) set_translate_address_state(opts)

Sets the address translation states for this virtual server.
- (Object) set_translate_port_state(opts)

Sets the port translation states for this virtual server.
- (Object) set_type(opts)

Sets the types for this virtual server.
- (Object) set_vlan(opts)

Sets VLANs to the list of VLANs on which access to this Virtual Servers are enabled/disabled.
- (Object) set_wildmask(opts)

Sets the wildmasks for this virtual server.
- (String) snat_pool

Gets the SNAT pools to be used in iSNAT configurations for this virtual server.
- (SnatType) snat_type

Gets the SNAT type for this virtual server.
- (SourcePortBehavior) source_port_behavior

Gets the source port behavior for this virtual server.
- (VirtualServerStatistics) statistics

Gets the statistics for this virtual server.
- (EnabledState) translate_address_state

Gets the address translation states for this virtual server.
- (EnabledState) translate_port_state

Gets the port translation states for this virtual server.
- (VirtualServerType) type

Gets the types of this virtual server.
- (String) version

Gets the version information for this interface.
- (VLANFilterList) vlan

Gets the lists of VLANs on which access to this Virtual Servers are enabled/disabled.
- (String) wildmask

Gets the wildmasks for this virtual server.

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class IControl::Base

Instance Method Details

- (`HardwareAccelerationMode`) actual_hardware_acceleration

Gets the actual hardware acceleration modes for this virtual server.

Returns:

(HardwareAccelerationMode)

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

- (`Object`) add_authentication_profile(opts)

Adds/associates authentication profiles to this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:profiles (IControl::LocalLB::VirtualServer::VirtualServerAuthentication[]) —

The authentication profiles to add to the 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.

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

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

- (`Object`) add_clone_pool(opts)

Adds/associates clone pools to this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:clone_pools (IControl::LocalLB::VirtualServer::VirtualServerClonePool[]) —

The clone pools to add to the 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.

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

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

- (`Object`) add_httpclass_profile(opts)

Adds/associates HTTP class profiles to this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:profiles (IControl::LocalLB::VirtualServer::VirtualServerHttpClass[]) —

The HTTP class profiles to add to the 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.

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

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

- (`Object`) add_persistence_profile(opts)

Adds/associates persistence profiles to this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:profiles (IControl::LocalLB::VirtualServer::VirtualServerPersistence[]) —

The persistence profiles to add to the 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.

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

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

- (`Object`) add_profile(opts)

Adds/associates profiles to this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:profiles (IControl::LocalLB::VirtualServer::VirtualServerProfile[]) —

The profiles to add to the 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.

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

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

- (`Object`) add_rule(opts)

Adds/associates rules to this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:rules (IControl::LocalLB::VirtualServer::VirtualServerRule[]) —

The rules to add to the 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.

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

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

- (`VirtualServerStatistics`) all_statistics

Gets the statistics for all the virtual server.

Returns:

(VirtualServerStatistics)

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

- (`VirtualServerAuthentication[]`) authentication_profile

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

Returns:

(VirtualServerAuthentication[])

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

- (`VirtualServerClonePool[]`) clone_pool

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

Returns:

(VirtualServerClonePool[])

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

- (`VirtualServerCMPEnableMode`) cmp_enable_mode

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.

Returns:

(VirtualServerCMPEnableMode)

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

- (`EnabledState`) cmp_enabled_state

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.

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.



239
240
241

# File 'lib/icontrol/local_lb/virtual_server.rb', line 239

def cmp_enabled_state
  super
end

- (`ULong64`) connection_limit

Gets the connection limits for this virtual server.

Returns:

(ULong64)

Raises:

(IControl::IControl::Common::AccessDenied) —

raised if the client credentials are not valid.
(IControl::IControl::Common::InvalidArgument) —

raised if one of the arguments is invalid.
(IControl::IControl::Common::OperationFailed) —

raised if an operation error occurs.



250
251
252

# File 'lib/icontrol/local_lb/virtual_server.rb', line 250

def connection_limit
  super
end

- (`EnabledState`) connection_mirror_state

Gets the mirror connection states for this virtual server.

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.



261
262
263

# File 'lib/icontrol/local_lb/virtual_server.rb', line 261

def connection_mirror_state
  super
end

- (`Object`) create(opts)

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

Parameters:

opts (Hash)

Options Hash (opts):

:definitions (IControl::Common::VirtualServerDefinition) —

The virtual server definitions, address, port, and protocols the virtual servers will be using, for protocol, only IP (which includes both TCP and UDP), TCP or UDP are supported.
:wildmasks (String) —

The network masks used to look up the specified virtual servers.
:resources (IControl::LocalLB::VirtualServer::VirtualServerResource) —

The resources associated with the virtual servers.
:profiles (IControl::LocalLB::VirtualServer::VirtualServerProfile[]) —

The profiles to associate with the 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.

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

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

- (`String`) default_pool_name

Gets the default pool names for this virtual server.

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.



272
273
274

# File 'lib/icontrol/local_lb/virtual_server.rb', line 272

def default_pool_name
  super
end

- (`Object`) delete_all_virtual_servers

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

- (`Object`) delete_persistence_record(opts)

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

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

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

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

- (`Object`) delete_virtual_server

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

- (`IPPortDefinition`) destination

Gets the destination IP and port of this virtual server.

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.



283
284
285

# File 'lib/icontrol/local_lb/virtual_server.rb', line 283

def destination
  super
end

- (`EnabledState`) enabled_state

Gets the enabled state of this virtual server.

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.



294
295
296

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

def enabled_state
  super
end

- (`String`) fallback_persistence_profile

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

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.



305
306
307

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

def fallback_persistence_profile
  super
end

- (`ULong64`) gtm_score

Returns the gtm scores for this virtual server.

Returns:

(ULong64)

Raises:

(IControl::IControl::Common::AccessDenied) —

raised if the client credentials are not valid.
(IControl::IControl::Common::InvalidArgument) —

raised if one of the arguments is invalid.
(IControl::IControl::Common::OperationFailed) —

raised if an operation error occurs.



316
317
318

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

def gtm_score
  super
end

- (`VirtualServerHttpClass[]`) httpclass_profile

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.

Returns:

(VirtualServerHttpClass[])

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

- (`String`) last_hop_pool

Gets the last hop pools for this virtual server.

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.



340
341
342

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

def last_hop_pool
  super
end

- (`String`) list

Gets a list of virtual server.

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.



351
352
353

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

def list
  super
end

- (`VirtualServerModuleScore[]`) module_score

Returns the module scores for this virtual server.

Returns:

(VirtualServerModuleScore[])

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

- (`ObjectStatus`) object_status

Gets the status of each of this virtual server.

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.



373
374
375

# File 'lib/icontrol/local_lb/virtual_server.rb', line 373

def object_status
  super
end

- (`VirtualServerPersistence[]`) persistence_profile

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

Returns:

(VirtualServerPersistence[])

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

- (`PersistenceRecord[]`) persistence_record(opts)

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

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

Returns:

(PersistenceRecord[])

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.

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

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

- (`VirtualServerProfileAttribute[]`) profile

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

Returns:

(VirtualServerProfileAttribute[])

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

- (`ProtocolType`) protocol

Gets the protocols supported by this virtual server.

Returns:

(ProtocolType)

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

- (`String`) rate_class

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

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.



431
432
433

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

def rate_class
  super
end

- (`Object`) remove_all_authentication_profiles

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

- (`Object`) remove_all_clone_pools

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

- (`Object`) remove_all_httpclass_profiles

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

- (`Object`) remove_all_persistence_profiles

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

- (`Object`) remove_all_profiles

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

- (`Object`) remove_all_rules

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

- (`Object`) remove_authentication_profile(opts)

Removes authentication profiles from this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:profiles (IControl::LocalLB::VirtualServer::VirtualServerAuthentication[]) —

The authentication profiles to remove from the 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.

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

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

- (`Object`) remove_clone_pool(opts)

Removes clone pools from this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:clone_pools (IControl::LocalLB::VirtualServer::VirtualServerClonePool[]) —

The clone pools to remove from the 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.

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

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

- (`Object`) remove_httpclass_profile(opts)

Removes HTTP class profiles from this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:profiles (IControl::LocalLB::VirtualServer::VirtualServerHttpClass[]) —

The HTTP class profiles to remove from the 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.

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

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

- (`Object`) remove_persistence_profile(opts)

Removes persistence profiles from this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:profiles (IControl::LocalLB::VirtualServer::VirtualServerPersistence[]) —

The persistence profiles to remove from the 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.

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

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

- (`Object`) remove_profile(opts)

Removes profiles from this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:profiles (IControl::LocalLB::VirtualServer::VirtualServerProfile[]) —

The profiles to remove from the 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.

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

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

- (`Object`) remove_rule(opts)

Removes rules from this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:rules (IControl::LocalLB::VirtualServer::VirtualServerRule[]) —

The rules to remove from the 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.

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

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

- (`Object`) reset_statistics

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

- (`VirtualServerRule[]`) rule

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.

Returns:

(VirtualServerRule[])

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

- (`Object`) set_cmp_enabled_state(opts)

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.

Parameters:

opts (Hash)

Options Hash (opts):

:states (IControl::Common::EnabledState) —

The CMP enabled states to apply.

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.

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

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

- (`Object`) set_connection_limit(opts)

Sets the connection limits of this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:limits (IControl::Common::ULong64) —

The connection limits to set.

Raises:

(IControl::IControl::Common::AccessDenied) —

raised if the client credentials are not valid.
(IControl::IControl::Common::InvalidArgument) —

raised if one of the arguments is invalid.
(IControl::IControl::Common::OperationFailed) —

raised if an operation error occurs.

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

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

- (`Object`) set_connection_mirror_state(opts)

Sets the mirror connection states for this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:states (IControl::Common::EnabledState) —

The mirror connection states 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.

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

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

- (`Object`) set_default_pool_name(opts)

Sets the default pool names for this virtual server.

Parameters:

opts (Hash)

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.

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

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

- (`Object`) set_destination(opts)

Sets the destination IP and port for this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:destinations (IControl::Common::IPPortDefinition) —

The destinations to set.

Raises:

(IControl::IControl::Common::AccessDenied) —

raised if the client credentials are not valid.
(IControl::IControl::Common::InvalidArgument) —

raised if one of the arguments is invalid.
(IControl::IControl::Common::OperationFailed) —

raised if an operation error occurs.

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

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

- (`Object`) set_enabled_state(opts)

Sets the enabled state of this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:states (IControl::Common::EnabledState) —

The enabled states to set.

Raises:

(IControl::IControl::Common::AccessDenied) —

raised if the client credentials are not valid.
(IControl::IControl::Common::InvalidArgument) —

raised if one of the arguments is invalid.
(IControl::IControl::Common::OperationFailed) —

raised if an operation error occurs.

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

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

- (`Object`) set_fallback_persistence_profile(opts)

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

Parameters:

opts (Hash)

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.

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

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

- (`Object`) set_gtm_score(opts)

Sets the gtm score for this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:scores (IControl::Common::ULong64) —

The GTM score value to set

Raises:

(IControl::IControl::Common::AccessDenied) —

raised if the client credentials are not valid.
(IControl::IControl::Common::InvalidArgument) —

raised if one of the arguments is invalid.
(IControl::IControl::Common::OperationFailed) —

raised if an operation error occurs.

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

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

- (`Object`) set_last_hop_pool(opts)

Sets the last hop pools for this virtual server.

Parameters:

opts (Hash)

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.

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

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

- (`Object`) set_protocol(opts)

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

Parameters:

opts (Hash)

Options Hash (opts):

:protocols (IControl::Common::ProtocolType) —

The protocols to set.

Raises:

(IControl::IControl::Common::AccessDenied) —

raised if the client credentials are not valid.
(IControl::IControl::Common::InvalidArgument) —

raised if one of the arguments is invalid.
(IControl::IControl::Common::OperationFailed) —

raised if an operation error occurs.

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

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

- (`Object`) set_rate_class(opts)

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

Parameters:

opts (Hash)

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.

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

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

- (`Object`) set_snat_automap

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

- (`Object`) set_snat_none

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

- (`Object`) set_snat_pool(opts)

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

Parameters:

opts (Hash)

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.

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

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

- (`Object`) set_source_port_behavior(opts)

Sets the source port behavior for this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:source_port_behaviors (IControl::Common::SourcePortBehavior) —

The source port behaviors to set.

Raises:

(IControl::IControl::Common::AccessDenied) —

raised if the client credentials are not valid.
(IControl::IControl::Common::InvalidArgument) —

raised if one of the arguments is invalid.
(IControl::IControl::Common::OperationFailed) —

raised if an operation error occurs.

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

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

- (`Object`) set_translate_address_state(opts)

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

Parameters:

opts (Hash)

Options Hash (opts):

:states (IControl::Common::EnabledState) —

The address translation states to apply.

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.

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

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

- (`Object`) set_translate_port_state(opts)

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

Parameters:

opts (Hash)

Options Hash (opts):

:states (IControl::Common::EnabledState) —

The port translation states to apply.

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.

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

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

- (`Object`) set_type(opts)

Sets the types for this virtual server.

Parameters:

opts (Hash)

Options Hash (opts):

:types (IControl::LocalLB::VirtualServer::VirtualServerType) —

The types to set.

Raises:

(IControl::IControl::Common::AccessDenied) —

raised if the client credentials are not valid.
(IControl::IControl::Common::InvalidArgument) —

raised if one of the arguments is invalid.
(IControl::IControl::Common::OperationFailed) —

raised if an operation error occurs.

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

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

- (`Object`) set_vlan(opts)

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

Parameters:

opts (Hash)

Options Hash (opts):

:vlans (IControl::Common::VLANFilterList) —

The VLAN names to add to the list of enabled/disabled VLANs .

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.

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

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

- (`Object`) set_wildmask(opts)

Sets the wildmasks for this virtual server.

Parameters:

opts (Hash)

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.

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

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

- (`String`) snat_pool

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

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.



455
456
457

# File 'lib/icontrol/local_lb/virtual_server.rb', line 455

def snat_pool
  super
end

- (`SnatType`) snat_type

Gets the SNAT type for this virtual server.

Returns:

(SnatType)

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

- (`SourcePortBehavior`) source_port_behavior

Gets the source port behavior for this virtual server.

Returns:

(SourcePortBehavior)

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

- (`VirtualServerStatistics`) statistics

Gets the statistics for this virtual server.

Returns:

(VirtualServerStatistics)

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

- (`EnabledState`) translate_address_state

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

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.



500
501
502

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

def translate_address_state
  super
end

- (`EnabledState`) translate_port_state

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

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.



512
513
514

# File 'lib/icontrol/local_lb/virtual_server.rb', line 512

def translate_port_state
  super
end

- (`VirtualServerType`) type

Gets the types of this virtual server.

Returns:

(VirtualServerType)

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

- (`String`) version

Gets the version information for this interface.

Returns:

(String)



531
532
533

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

def version
  super
end

- (`VLANFilterList`) vlan

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

Returns:

(VLANFilterList)

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

- (`String`) wildmask

Gets the wildmasks for this virtual server.

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.



553
554
555

# File 'lib/icontrol/local_lb/virtual_server.rb', line 553

def wildmask
  super
end

Class: IControl::LocalLB::VirtualServer

Overview

Defined Under Namespace

Instance Method Summary (collapse)

Dynamic Method Handling

Instance Method Details

- (HardwareAccelerationMode) actual_hardware_acceleration

- (Object) add_authentication_profile(opts)

- (Object) add_clone_pool(opts)

- (Object) add_httpclass_profile(opts)

- (Object) add_persistence_profile(opts)

- (Object) add_profile(opts)

- (Object) add_rule(opts)

- (VirtualServerStatistics) all_statistics

- (VirtualServerAuthentication[]) authentication_profile

- (VirtualServerClonePool[]) clone_pool

- (VirtualServerCMPEnableMode) cmp_enable_mode

- (EnabledState) cmp_enabled_state

- (ULong64) connection_limit

- (EnabledState) connection_mirror_state

- (Object) create(opts)

- (String) default_pool_name

- (Object) delete_all_virtual_servers

- (Object) delete_persistence_record(opts)

- (Object) delete_virtual_server

- (IPPortDefinition) destination

- (EnabledState) enabled_state

- (String) fallback_persistence_profile

- (ULong64) gtm_score

- (VirtualServerHttpClass[]) httpclass_profile

- (String) last_hop_pool

- (String) list

- (VirtualServerModuleScore[]) module_score

- (ObjectStatus) object_status

- (VirtualServerPersistence[]) persistence_profile

- (PersistenceRecord[]) persistence_record(opts)

- (VirtualServerProfileAttribute[]) profile

- (ProtocolType) protocol

- (String) rate_class

- (Object) remove_all_authentication_profiles

- (Object) remove_all_clone_pools

- (Object) remove_all_httpclass_profiles

- (Object) remove_all_persistence_profiles

- (Object) remove_all_profiles

- (Object) remove_all_rules

- (Object) remove_authentication_profile(opts)

- (Object) remove_clone_pool(opts)

- (Object) remove_httpclass_profile(opts)

- (Object) remove_persistence_profile(opts)

- (Object) remove_profile(opts)

- (Object) remove_rule(opts)

- (Object) reset_statistics

- (VirtualServerRule[]) rule

- (Object) set_cmp_enabled_state(opts)

- (Object) set_connection_limit(opts)

- (Object) set_connection_mirror_state(opts)

- (Object) set_default_pool_name(opts)

- (Object) set_destination(opts)

- (Object) set_enabled_state(opts)

- (Object) set_fallback_persistence_profile(opts)

- (Object) set_gtm_score(opts)

- (Object) set_last_hop_pool(opts)

- (Object) set_protocol(opts)

- (Object) set_rate_class(opts)

- (Object) set_snat_automap

- (Object) set_snat_none

- (Object) set_snat_pool(opts)

- (Object) set_source_port_behavior(opts)

- (Object) set_translate_address_state(opts)

- (Object) set_translate_port_state(opts)

- (Object) set_type(opts)

- (Object) set_vlan(opts)

- (Object) set_wildmask(opts)

- (String) snat_pool

- (SnatType) snat_type

- (SourcePortBehavior) source_port_behavior

- (VirtualServerStatistics) statistics

- (EnabledState) translate_address_state

- (EnabledState) translate_port_state

- (VirtualServerType) type

- (`HardwareAccelerationMode`) actual_hardware_acceleration

- (`Object`) add_authentication_profile(opts)

- (`Object`) add_clone_pool(opts)

- (`Object`) add_httpclass_profile(opts)

- (`Object`) add_persistence_profile(opts)

- (`Object`) add_profile(opts)

- (`Object`) add_rule(opts)

- (`VirtualServerStatistics`) all_statistics

- (`VirtualServerAuthentication[]`) authentication_profile

- (`VirtualServerClonePool[]`) clone_pool

- (`VirtualServerCMPEnableMode`) cmp_enable_mode

- (`EnabledState`) cmp_enabled_state

- (`ULong64`) connection_limit

- (`EnabledState`) connection_mirror_state

- (`Object`) create(opts)

- (`String`) default_pool_name

- (`Object`) delete_all_virtual_servers

- (`Object`) delete_persistence_record(opts)

- (`Object`) delete_virtual_server

- (`IPPortDefinition`) destination

- (`EnabledState`) enabled_state

- (`String`) fallback_persistence_profile

- (`ULong64`) gtm_score

- (`VirtualServerHttpClass[]`) httpclass_profile

- (`String`) last_hop_pool

- (`String`) list

- (`VirtualServerModuleScore[]`) module_score

- (`ObjectStatus`) object_status

- (`VirtualServerPersistence[]`) persistence_profile

- (`PersistenceRecord[]`) persistence_record(opts)

- (`VirtualServerProfileAttribute[]`) profile

- (`ProtocolType`) protocol

- (`String`) rate_class

- (`Object`) remove_all_authentication_profiles

- (`Object`) remove_all_clone_pools

- (`Object`) remove_all_httpclass_profiles

- (`Object`) remove_all_persistence_profiles

- (`Object`) remove_all_profiles

- (`Object`) remove_all_rules

- (`Object`) remove_authentication_profile(opts)

- (`Object`) remove_clone_pool(opts)

- (`Object`) remove_httpclass_profile(opts)

- (`Object`) remove_persistence_profile(opts)

- (`Object`) remove_profile(opts)

- (`Object`) remove_rule(opts)

- (`Object`) reset_statistics

- (`VirtualServerRule[]`) rule

- (`Object`) set_cmp_enabled_state(opts)

- (`Object`) set_connection_limit(opts)

- (`Object`) set_connection_mirror_state(opts)

- (`Object`) set_default_pool_name(opts)

- (`Object`) set_destination(opts)

- (`Object`) set_enabled_state(opts)

- (`Object`) set_fallback_persistence_profile(opts)

- (`Object`) set_gtm_score(opts)

- (`Object`) set_last_hop_pool(opts)

- (`Object`) set_protocol(opts)

- (`Object`) set_rate_class(opts)

- (`Object`) set_snat_automap

- (`Object`) set_snat_none

- (`Object`) set_snat_pool(opts)

- (`Object`) set_source_port_behavior(opts)

- (`Object`) set_translate_address_state(opts)

- (`Object`) set_translate_port_state(opts)

- (`Object`) set_type(opts)

- (`Object`) set_vlan(opts)

- (`Object`) set_wildmask(opts)

- (`String`) snat_pool

- (`SnatType`) snat_type

- (`SourcePortBehavior`) source_port_behavior

- (`VirtualServerStatistics`) statistics

- (`EnabledState`) translate_address_state

- (`EnabledState`) translate_port_state

- (`VirtualServerType`) type

- (`String`) version

- (`VLANFilterList`) vlan

- (`String`) wildmask