GlobalLB::VirtualServer

Introduced : BIG-IP_v9.2.0
This interface is deprecated. Please use GlobalLB::VirtualServerV2 in its stead. This interface will still work with some caveats. If the system holds a configuration rolled forward from earlier versions, there should be almost no problems using this interface. The only exception is that set_server will almost always fail, as the server name can no longer be changed after creating a virtual server. Otherwise, be aware that a VirtualServerDefinition value no longer uniquely identifies a virtual server. Using this interface with a configuration with more than one virtual server having the same VirtualServerDefinition values yields unpredictable results. The VirtualServer interface enables you to work with virtual servers associated with a server.

Methods

Method Description Introduced
add_dependency Adds the virtual servers to the dependency list that the specified virtual servers depend on. BIG-IP_v9.2.0
create Creates the specified virtual server. BIG-IP_v9.2.0
delete_all_virtual_servers Deletes all virtual servers. BIG-IP_v9.2.0
delete_virtual_server Deletes the specified virtual servers. BIG-IP_v9.2.0
get_all_statistics Gets the statistics for all the virtual servers. BIG-IP_v9.2.0
get_dependency Gets the list of virtual servers that the specified virtual servers depend on. BIG-IP_v9.2.0
get_enabled_state Gets the enabled states for the specified virtual servers. BIG-IP_v9.2.0
get_limit Gets all metrics limits for a sequence of virtual servers. BIG-IP_v9.2.0
get_list Gets a list of virtual servers. BIG-IP_v9.2.0
get_monitor_association Gets the monitor associations for the specified virtual servers, i.e. the monitor rules used by the virtual servers. BIG-IP_v9.2.0
get_object_status Gets the statuses of the specified virtual servers. BIG-IP_v9.2.0
get_parent_link Gets a parent links the specified virtual servers belong to. BIG-IP_v9.2.0
get_server Gets a list of servers the specified virtual servers belong to. BIG-IP_v9.2.0
get_statistics Gets the statistics for the specified virtual servers. BIG-IP_v9.2.0
get_translation Gets the translation IP addresses and ports for the specified virtual servers. BIG-IP_v9.2.0
get_version Gets the version information for this interface. BIG-IP_v9.2.0
remove_all_dependencies Removes any and all dependencies of the specified virtual servers. BIG-IP_v9.2.0
remove_dependency Removes the virtual servers from the dependency list that the specified virtual servers depend on. BIG-IP_v9.2.0
remove_monitor_association Removes the monitor associations for the specified virtual servers. This basically deletes the monitor associations between a virtual server and a monitor rule, i.e. the specified virtual servers will no longer be monitored. BIG-IP_v9.2.0
reset_statistics Resets the statistics for the specified virtual servers. BIG-IP_v9.2.0
set_enabled_state Sets the enabled states for the specified virtual servers. BIG-IP_v9.2.0
set_limit Sets the limits for virtual server metrics. BIG-IP_v9.2.0
set_monitor_association Sets/creates the monitor associations for the specified virtual servers. This basically creates the monitor associations between a virtual server and a monitor rule. BIG-IP_v9.2.0
set_server Sets the servers the specified virtual servers belong to. BIG-IP_v9.2.0
set_translation Sets the translation IP addresses and ports for the specified virtual servers. BIG-IP_v9.2.0

Structures

Structure

Description

MonitorAssociation

A struct that describes a virtual server&aposs monitor association.

VirtualServerMetricLimit

A struct that contains metric limits for a virtual server.

VirtualServerStatisticEntry

A struct that describes statistics for a particular virtual server.

VirtualServerStatistics

A struct that describes virtual server statistics and timestamp.


Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
MonitorAssociationSequence MonitorAssociation [] A sequence of monitor associations.
VirtualServerMetricLimitSequence VirtualServerMetricLimit [] A sequence of VirtualServerMetricLimit&aposs.
VirtualServerStatisticEntrySequence VirtualServerStatisticEntry [] A sequence of VirtualServer statistics.

See Also

Warning

The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code


The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.