GlobalLB::Server

Introduced : BIG-IP_v9.2.0
The Server interface enables you to work with servers within a data center.

Methods

Method Description Introduced
add_device_ip Adds the addresses to the specified devices. Each device must contain at least one address. These should not be floating addresses. BIG-IP_v13.0.0
add_ip This method has been deprecated. Please use add_ip_v2 in its stead. Adds the IP addresses to the specified servers. BIG-IP_v9.2.0
add_ip_v2 This method has been deprecated. Please use add_device_ip in its stead. Adds the IP addresses to the specified servers. BIG-IP_v11.0.0
add_metadata Adds the metadata for the specified servers. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
create This method has been deprecated. Please use create_v2 in its stead. Creates the specified servers. BIG-IP_v9.2.0
create_device Create a new device associated with a server and add device addresses to it. Every server consists of one or more devices. In the case where multiple devices are configured, the assumption is these devices are in a failover group or are logically represented as a single server. BIG-IP_v13.0.0
create_v2 Creates the specified servers. BIG-IP_v11.0.0
delete_all_servers Deletes all servers. BIG-IP_v9.2.0
delete_device Deletes the specified devices. BIG-IP_v13.0.0
delete_server Deletes the specified servers. BIG-IP_v9.2.0
get_all_device_statistics Gets the statistics for all devices. BIG-IP_v13.0.0
get_all_statistics Gets the statistics for all the servers. BIG-IP_v9.2.0
get_allow_path_state Gets the states indicating whether path information gathering is allowed for the specified servers. BIG-IP_v9.2.0
get_allow_service_check_state Gets the states indicating whether service check is allowed for the specified servers. BIG-IP_v9.2.0
get_allow_snmp_state Gets the states indicating whether SNMP information gathering is allowed for the specified servers. BIG-IP_v9.2.0
get_auto_configuration_state Gets the states indicating whether autoconfig is enabled/disabled. If enabled, GTM will attempt to gather all virtual servers based on the specified servers. BIG-IP_v9.2.0
get_data_center Gets the data centers that the specified servers belong to. BIG-IP_v9.2.0
get_description Gets the descriptions for a set of servers. BIG-IP_v11.0.0
get_device_description Gets the descriptions for a set of devices. BIG-IP_v13.0.0
get_device_ip Gets the addresses for a set of devices. BIG-IP_v13.0.0
get_device_ip_description Gets the descriptions for a set of device addresses. BIG-IP_v13.0.0
get_device_ip_explicit_link Gets the explicit links for a set of device addresses. BIG-IP_v13.0.0
get_device_ip_translation Gets the translation addresses for a set of device addresses. BIG-IP_v13.0.0
get_device_list Gets a list of all devices in all servers. BIG-IP_v13.0.0
get_device_list_by_server Gets a list of all devices in the specified servers. BIG-IP_v13.0.0
get_device_statistics Gets the statistics for the specified devices. BIG-IP_v13.0.0
get_enabled_state Gets the enabled states for the specified servers. BIG-IP_v9.2.0
get_ip This method has been deprecated. Please use get_ip_v2 in its stead. Gets the IP addresses that belong to the specified servers. BIG-IP_v9.2.0
get_ip_v2 This method has been deprecated. Please use get_device_ip in its stead. Gets the IP addresses that belong to the specified servers. BIG-IP_v11.0.0
get_limit Gets all metrics limits for a sequence of servers. BIG-IP_v9.2.0
get_link_auto_configuration_state Gets the states indicating whether autoconfig is enabled/disabled. If enabled, GTM will attempt to look up the links&aposs default gateways. BIG-IP_v9.2.0
get_list Gets a list of servers. BIG-IP_v9.2.0
get_metadata Gets the user metadata for the specified servers. User metadata, also metadata for short, is mainly a name/value pair that is associated with a metadata capable config (MCC) object. Some exmaples of MCC objects are ltm pool and virtual server. The combination of the MCC object name and the metadata name uniguely identify an instance of the metadata. One MCC object may have multiple instances of metadata associated with it. In addition to name/value pair, metadata also has a persistence attribute. See Common::MetadataPersistence for its definition. BIG-IP_v11.2.0
get_metadata_description Gets the metadata descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
get_metadata_persistence Gets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
get_metadata_value Gets the metadata values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
get_monitor_association Gets the monitor associations for the specified servers, i.e. the monitor rules used by the servers. BIG-IP_v9.2.0
get_monitor_rule Gets the monitor rules for a set of servers. BIG-IP_v13.0.0
get_object_status Gets the statuses of the specified servers. BIG-IP_v9.2.0
get_prober_address Gets the prober addresses for the specified servers. This function is deprecated and new applications should use get_prober_pool. BIG-IP_v9.2.0
get_prober_pool Gets the prober pool for the specified servers. BIG-IP_v11.0.0
get_prober_selection Gets the prober selections for the specified servers. BIG-IP_v13.0.0
get_server_type This method has been deprecated. Please use get_server_type_v2 in its stead. If the server is SERVER_TYPE_BIGIP and it has more than one device, this will return SERVER_TYPE_BIGIP_REDUNDANT. Otherwise it will return SERVER_TYPE_BIGIP_STANDALONE. This method will never return server type SERVER_TYPE_BIGIP. Gets the server types of the specified servers. BIG-IP_v9.2.0
get_server_type_v2 Gets the server types of the specified servers. BIG-IP_v13.0.0
get_statistics Gets the statistics for the specified servers. BIG-IP_v9.2.0
get_version Gets the version information for this interface. BIG-IP_v9.2.0
remove_all_metadata Removes all the metadata instances for the specified servers. BIG-IP_v11.2.0
remove_device_ip Removes the addresses from the specified devices. BIG-IP_v13.0.0
remove_ip This method has been deprecated. Please use remove_ip_v2 in its stead. Removes the IP addresses from the specified servers. BIG-IP_v9.2.0
remove_ip_v2 This method has been deprecated. Please use remove_device_ip in its stead. Removes the IP addresses from the specified servers. BIG-IP_v11.0.0
remove_metadata Removes the metadata for the specified servers and names. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
remove_monitor_association Removes the monitor associations for the specified servers. This basically deletes the monitor associations between a server and a monitor rule, i.e. the specified servers will no longer be monitored. BIG-IP_v9.2.0
remove_monitor_rule Removes the monitor rules for the specified servers. The specified servers will no longer be monitored. BIG-IP_v13.0.0
reset_device_statistics Resets the statistics for the specified devices. BIG-IP_v13.0.0
reset_statistics Resets the statistics for the specified servers. BIG-IP_v9.2.0
set_allow_path_state Sets the states indicating whether path information gathering is allowed for the specified servers. BIG-IP_v9.2.0
set_allow_service_check_state Sets the states indicating whether service check is allowed for the specified servers. BIG-IP_v9.2.0
set_allow_snmp_state Sets the states indicating whether SNMP information gathering is allowed for the specified servers. BIG-IP_v9.2.0
set_auto_configuration_state Sets the states indicating whether autoconfig is enabled/disabled. If enabled, GTM will attempt to gather all virtual servers based on the specified servers. BIG-IP_v9.2.0
set_data_center Moves the specified servers to the new data centers. BIG-IP_v9.2.0
set_description Sets the description for a set of servers. This is an arbitrary field which can be used for any purpose. BIG-IP_v11.0.0
set_device_description Sets the descriptions for a set of devices. This is an arbitrary field which can be used for any purpose. BIG-IP_v13.0.0
set_device_ip_description Sets the descriptions for a set of device addresses. This is an arbitrary field which can be used for any purpose. BIG-IP_v13.0.0
set_device_ip_explicit_link Sets the explicit link for a set of device addresses. The explicit link will override the automatic link association and associate the device address with the specified gateway link. BIG-IP_v13.0.0
set_device_ip_translation Sets the translation address for a set of device addresses. If address translation is being used, the translation address represents the internal (private) address that corresponds with the external device IP address. BIG-IP_v13.0.0
set_enabled_state Sets the enabled states for the specified servers. BIG-IP_v9.2.0
set_limit Sets the limits for server metrics. BIG-IP_v9.2.0
set_link_auto_configuration_state Sets the states indicating whether autoconfig is enabled/disabled for the servers&apos links. If enabled, GTM will attempt to look up the links&aposs default gateways. BIG-IP_v9.2.0
set_metadata_description Sets the descriptions for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
set_metadata_persistence Sets the persistence for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
set_metadata_value Sets the values for the specified metadata. For definition of the metadata, refer to the get_metadata method description. BIG-IP_v11.2.0
set_monitor_association Sets/creates the monitor associations for the specified servers. This basically creates the monitor associations between a server and a monitor rule. BIG-IP_v9.2.0
set_monitor_rule Sets the monitor rule for a set of servers. BIG-IP_v13.0.0
set_prober_address Sets the prober addresses for the specified servers. This function is deprecated and new applications should use set_prober_pool. (as of 11.0.0 this function creates (if needed) a single member prober pool named after the address given that has one member which is the server corresponding to the address given.) BIG-IP_v9.2.0
set_prober_pool Sets the prober pool for the specified servers. (The system uses a Server&aposs Data Center prober pool, if specified, if a prober pool has not been set for the Server). BIG-IP_v11.0.0
set_prober_selection Sets the prober selections for the specified servers. Note that if prober selections are not set for a server, the prober selections for the data center are used. BIG-IP_v13.0.0
set_server_type Sets the server types of the specified servers. BIG-IP_v9.2.0

Structures

Structure

Description

DeviceDefinition

A struct that describes a device within a server

DeviceStatisticEntry

A struct that describes statistics for a particular device.

DeviceStatistics

A struct that describes device statistics and timestamp.

MonitorAssociation

A struct that describes a server&aposs monitor association.

ServerIPDefinition

This structure has been deprecated due to the deprecation of the ServerIPsForUnitID structure. Please use ServerIPDefinitionV2 in its stead. A struct that contains definition for the server and the associated IP addresses.

ServerIPs

A struct that contains the server IP addresses.

ServerIPsForUnitID

This structure has been deprecated due to changing from unit IDs to device names. Please use ServerIPsForDevice in its stead. A struct that contains definition for the server.

ServerMetricLimit

A struct that contains metric limits for a server.

ServerStatisticEntry

A struct that describes statistics for a particular server.

ServerStatistics

A struct that describes server statistics and timestamp.


Enumerations

Enumeration Description

Exceptions

Exception Description

Constants

Constant Type Value Description

Aliases

Alias Type Description
DeviceSequence DeviceDefinition [] A sequence of devices.
DeviceSequenceSequence DeviceDefinition [] [] A sequence of device sequences.
DeviceStatisticEntrySequence DeviceStatisticEntry [] A sequence of device statistics.
MonitorAssociationSequence MonitorAssociation [] A sequence of monitor associations.
ServerIPSequence ServerIPDefinition [] A sequence of ServerIPDefinition&aposs.
ServerIPsForUnitIDSequence ServerIPsForUnitID [] A sequence of ServerIPsForUnitID&aposs.
ServerIPsSequence ServerIPs [] A sequence of ServerIPs&aposs.
ServerIPsSequenceSequence ServerIPs [] [] A sequence of ServerIPs sequences.
ServerMetricLimitSequence ServerMetricLimit [] A sequence of ServerMetricLimit&aposs.
ServerStatisticEntrySequence ServerStatisticEntry [] A sequence of Server 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.