---
title: GLB.Service
slug: ps/help/en_us/vtm/controlapi/glbservice
docTags: 
createdAt: 2026-08-02T08:52:22.836Z
---

URI: http\://soap.zeus.com/zxtm/1.0/GLB/Service/

The GLB.Service interface allows management of Global Load Balancing Services. Using this interface, you can create, delete and rename pool objects, and manage their configuration.

### Methods

### addDNSSECMappings( names, mappings ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Add a set of DNSSEC domain to key mappings to the GLB services specified.

```bash
void addDNSSECMappings(
String[] names
GLB.Service.DNSSECMapping[][] mappings
)
```

### addDomains( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

For each named GLB service, add new DNS domain names to the list of domains to load balance

```bash
void addDomains(
String[] names
String[][] values
)
```

### addDraining( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Add the list of locations that are draining for this service.

```bash
void addDraining(
String[] names
String[][] values
)
```

### addGLBService( names, domains ) throws ObjectAlreadyExists, InvalidObjectName, DeploymentError, InvalidInput, LicenseError

Add each of the named GLB Services, using the domain lists for each.

```bash
void addGLBService(
String[] names
String[][] domains
)
```

### addLastResortResponse( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Add Last Resort Response.

```bash
void addLastResortResponse(
String[] names
String[][] values
)
```

### addLocalIPAddresses( names, localips ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

This method is now deprecated and is replaced by addServiceIPAddresses

```bash
void addLocalIPAddresses(
String[] names
GLB.Service.LocalIPList[][] localips
)
```

### addLocations( names, locations ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Add new locations to each of the named GLB services.

```bash
void addLocations(
String[] names
String[][] locations
)
```

### addMonitors( names, monitors ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Add Monitors to the named GLB Services

```bash
void addMonitors(
String[] names
GLB.Service.MonitorList[][] monitors
)
```

### addMonitorsByLocation( location, names, monitors ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Add Monitors to the named GLB Services This is a location specific function, any action will operate on the specified location.

```bash
void addMonitorsByLocation(
String location
String[] names
GLB.Service.MonitorList[][] monitors
)
```

### addRules( names, rules ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Add new rules to be run on DNS packets for each of the named GLB services. New rules are run after existing rules. If any of the rules are already configured to run, then they are enabled and flags are set to the values passed in.

```bash
void addRules(
String[] names
GLB.Service.Rule[][] rules
)
```

### addRulesByLocation( location, names, rules ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Add new rules to be run on DNS packets for each of the named GLB services. New rules are run after existing rules. If any of the rules are already configured to run, then they are enabled and flags are set to the values passed in. This is a location specific function, any action will operate on the specified location.

```bash
void addRulesByLocation(
String location
String[] names
GLB.Service.Rule[][] rules
)
```

### addServiceIPAddresses( names, localips ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Add Service IP addresses to the named GLB Services

```bash
void addServiceIPAddresses(
String[] names
GLB.Service.LocalIPList[][] localips
)
```

### deleteGLBService( names ) throws ObjectDoesNotExist, DeploymentError

Delete each of the named GLB Services.

```bash
void deleteGLBService(
String[] names
)
```

### getAlgorithm( names ) throws ObjectDoesNotExist, LicenseError

Get the load balancing algorithm to use.

```bash
GLB.Service.Algorithm[] getAlgorithm(
String[] names
)
```

### getAllMonitorsNeeded( names ) throws ObjectDoesNotExist, LicenseError

Get whether all monitors assigned to a location need to report success in order for it to be considered healthy.

```bash
Boolean[] getAllMonitorsNeeded(
String[] names
)
```

### getAutoFailback( names ) throws ObjectDoesNotExist, LicenseError

Get whether automatic failback mode is enabled.

```bash
Boolean[] getAutoFailback(
String[] names
)
```

### getAutoRecovery( names ) throws ObjectDoesNotExist, LicenseError

Get whether automatic recovery of the last location to fail is enabled.

```bash
Boolean[] getAutoRecovery(
String[] names
)
```

### getDNSSECMappings( names ) throws ObjectDoesNotExist, LicenseError

Get the load for the named GLB Services

```bash
GLB.Service.DNSSECMapping[][] getDNSSECMappings(
String[] names
)
```

### getDisableOnFailure( names ) throws ObjectDoesNotExist, LicenseError

Get whether "Disable on Failure" mode is enabled.

```bash
Boolean[] getDisableOnFailure(
String[] names
)
```

### getDomains( names ) throws ObjectDoesNotExist, LicenseError

Get the list of domain names to load balance, for each of the named GLB services

```bash
String[][] getDomains(
String[] names
)
```

### getDraining( names ) throws ObjectDoesNotExist, LicenseError

Get the list of locations that are draining for this service.

```bash
String[][] getDraining(
String[] names
)
```

### getEnabled( names ) throws ObjectDoesNotExist, LicenseError

Get whether we perform DNS manipulation.

```bash
Boolean[] getEnabled(
String[] names
)
```

### getGLBServiceNames()

Get the names of all of the configured GLB Services.

```bash
String[] getGLBServiceNames()
```

### getGeoEffect( names ) throws ObjectDoesNotExist, LicenseError

Get the influence of locality on location choice

```bash
Unsigned Integer[] getGeoEffect(
String[] names
)
```

### getLastResortResponse( names ) throws ObjectDoesNotExist, LicenseError

Get Last Resort Response.

```bash
String[][] getLastResortResponse(
String[] names
)
```

### getLoad( names ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Get the load for the named GLB Services

```bash
GLB.Service.Load[][] getLoad(
String[] names
)
```

### getLocalIPAddresses( names ) throws ObjectDoesNotExist, LicenseError

This method is now deprecated and is replaced by getServiceIPAddresses

```bash
GLB.Service.LocalIPList[][] getLocalIPAddresses(
String[] names
)
```

### getLocations( names ) throws ObjectDoesNotExist, LicenseError

Get the locations configured for the named GLB services.

```bash
String[][] getLocations(
String[] names
)
```

### getLogEnabled( names ) throws ObjectDoesNotExist, LicenseError

Get whether each of the named GLB services should log each connection.

```bash
Boolean[] getLogEnabled(
String[] names
)
```

### getLogEnabledByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get whether each of the named GLB services should log each connection. This is a location specific function, any action will operate on the specified location.

```bash
Boolean[] getLogEnabledByLocation(
String location
String[] names
)
```

### getLogFilename( names ) throws ObjectDoesNotExist, LicenseError

Get the name of the file used to store query logs, for each of the named GLB services.

```bash
String[] getLogFilename(
String[] names
)
```

### getLogFilenameByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get the name of the file used to store query logs, for each of the named GLB services. This is a location specific function, any action will operate on the specified location.

```bash
String[] getLogFilenameByLocation(
String location
String[] names
)
```

### getLogFormat( names ) throws ObjectDoesNotExist, LicenseError

Get the log file format for each of the named GLB services.

```bash
String[] getLogFormat(
String[] names
)
```

### getLogFormatByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get the log file format for each of the named GLB services. This is a location specific function, any action will operate on the specified location.

```bash
String[] getLogFormatByLocation(
String location
String[] names
)
```

### getMonitors( names ) throws ObjectDoesNotExist, LicenseError

Get the Monitors configured for the named GLB Services

```bash
GLB.Service.MonitorList[][] getMonitors(
String[] names
)
```

### getMonitorsByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get the Monitors configured for the named GLB Services This is a location specific function, any action will operate on the specified location.

```bash
GLB.Service.MonitorList[][] getMonitorsByLocation(
String location
String[] names
)
```

### getReturnIPsOnFail( names ) throws ObjectDoesNotExist, LicenseError

Get whether to return all or no IP addresses on a complete failure

```bash
Boolean[] getReturnIPsOnFail(
String[] names
)
```

### getRules( names ) throws ObjectDoesNotExist, LicenseError

Get the rules that are run on DNS packets for each of the named GLB services.

```bash
GLB.Service.Rule[][] getRules(
String[] names
)
```

### getRulesByLocation( location, names ) throws ObjectDoesNotExist, LicenseError

Get the rules that are run on DNS packets for each of the named GLB services. This is a location specific function, any action will operate on the specified location.

```bash
GLB.Service.Rule[][] getRulesByLocation(
String location
String[] names
)
```

### getServiceIPAddresses( names ) throws ObjectDoesNotExist, LicenseError

Get the Service IP addresses configured for the named GLB Services

```bash
GLB.Service.LocalIPList[][] getServiceIPAddresses(
String[] names
)
```

### getTTL( names ) throws ObjectDoesNotExist, LicenseError

Get The TTL for the DNS resource records handled by the GLB service.

```bash
Integer[] getTTL(
String[] names
)
```

### removeDNSSECMappings( names, mappings ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Remove the specified DNSSEC domain to key mappings.

```bash
void removeDNSSECMappings(
String[] names
GLB.Service.DNSSECMapping[][] mappings
)
```

### removeDomains( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

For each named GLB service, remove DNS domain names from the list of domains to load balance

```bash
void removeDomains(
String[] names
String[][] values
)
```

### removeDraining( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Remove the list of locations that are draining for this service.

```bash
void removeDraining(
String[] names
String[][] values
)
```

### removeLastResortResponse( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Remove Last Resort Response.

```bash
void removeLastResortResponse(
String[] names
String[][] values
)
```

### removeLocalIPAddresses( names, localips ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

This method is now deprecated and is replaced by removeServiceIPAddresses

```bash
void removeLocalIPAddresses(
String[] names
GLB.Service.LocalIPList[][] localips
)
```

### removeLocations( names, locations ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

For each of the named GLB services, remove locations.

```bash
void removeLocations(
String[] names
String[][] locations
)
```

### removeMonitors( names, monitors ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Remove Monitors from the named GLB Services

```bash
void removeMonitors(
String[] names
GLB.Service.MonitorList[][] monitors
)
```

### removeMonitorsByLocation( location, names, monitors ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Remove Monitors from the named GLB Services This is a location specific function, any action will operate on the specified location.

```bash
void removeMonitorsByLocation(
String location
String[] names
GLB.Service.MonitorList[][] monitors
)
```

### removeRules( names, rules ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

For each of the named GLB services, remove rules from the list of rules that are run on DNS packets.

```bash
void removeRules(
String[] names
String[][] rules
)
```

### removeRulesByLocation( location, names, rules ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

For each of the named GLB services, remove rules from the list of rules that are run on DNS packets. This is a location specific function, any action will operate on the specified location.

```bash
void removeRulesByLocation(
String location
String[] names
String[][] rules
)
```

### removeServiceIPAddresses( names, localips ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Remove Service IP addresses from the named GLB Services

```bash
void removeServiceIPAddresses(
String[] names
GLB.Service.LocalIPList[][] localips
)
```

### renameGLBService( names, new\_names ) throws ObjectDoesNotExist, InvalidInput, ObjectAlreadyExists, DeploymentError, LicenseError

Rename each of the named GLB Services.

```bash
void renameGLBService(
String[] names
String[] new_names
)
```

### setAlgorithm( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the load balancing algorithm to use.

```bash
void setAlgorithm(
String[] names
GLB.Service.Algorithm[] values
)
```

### setAllMonitorsNeeded( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set whether all monitors assigned to a location need to report success in order for it to be considered healthy.

```bash
void setAllMonitorsNeeded(
String[] names
Boolean[] values
)
```

### setAutoFailback( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set whether automatic failback mode is enabled.

```bash
void setAutoFailback(
String[] names
Boolean[] values
)
```

### setAutoRecovery( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set whether automatic recovery of the last location to fail is enabled.

```bash
void setAutoRecovery(
String[] names
Boolean[] values
)
```

### setDNSSECMappings( names, mappings ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the DNSSEC domain to key mappings to the GLB services specified. All previous mappings for this service will be removed.

```bash
void setDNSSECMappings(
String[] names
GLB.Service.DNSSECMapping[][] mappings
)
```

### setDisableOnFailure( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set whether "Disable on Failure" mode is enabled.

```bash
void setDisableOnFailure(
String[] names
Boolean[] values
)
```

### setDomains( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the list of domain names to load balance, for each of the named GLB services

```bash
void setDomains(
String[] names
String[][] values
)
```

### setDraining( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the list of locations that are draining for this service.

```bash
void setDraining(
String[] names
String[][] values
)
```

### setEnabled( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set whether we perform DNS manipulation.

```bash
void setEnabled(
String[] names
Boolean[] values
)
```

### setGeoEffect( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the influence of locality on location choice

```bash
void setGeoEffect(
String[] names
Unsigned Integer[] values
)
```

### setLastResortResponse( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set Last Resort Response.

```bash
void setLastResortResponse(
String[] names
String[][] values
)
```

### setLoad( names, loads ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the load for the named GLB Services

```bash
void setLoad(
String[] names
GLB.Service.Load[][] loads
)
```

### setLocalIPAddresses( names, localips ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

This method is now deprecated and is replaced by setServiceIPAddresses

```bash
void setLocalIPAddresses(
String[] names
GLB.Service.LocalIPList[][] localips
)
```

### setLocations( names, locations ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the locations configured for each of the named GLB services.

```bash
void setLocations(
String[] names
String[][] locations
)
```

### setLogEnabled( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set whether each of the named GLB services should log each connection.

```bash
void setLogEnabled(
String[] names
Boolean[] values
)
```

### setLogEnabledByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set whether each of the named GLB services should log each connection. This is a location specific function, any action will operate on the specified location.

```bash
void setLogEnabledByLocation(
String location
String[] names
Boolean[] values
)
```

### setLogFilename( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the name of the file used to store query logs, for each of the named GLB services.

```bash
void setLogFilename(
String[] names
String[] values
)
```

### setLogFilenameByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the name of the file used to store query logs, for each of the named GLB services. This is a location specific function, any action will operate on the specified location.

```bash
void setLogFilenameByLocation(
String location
String[] names
String[] values
)
```

### setLogFormat( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the log file format for each of the named GLB services.

```bash
void setLogFormat(
String[] names
String[] values
)
```

### setLogFormatByLocation( location, names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the log file format for each of the named GLB services. This is a location specific function, any action will operate on the specified location.

```bash
void setLogFormatByLocation(
String location
String[] names
String[] values
)
```

### setMonitors( names, monitors ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the Monitors configured for the named GLB Services

```bash
void setMonitors(
String[] names
GLB.Service.MonitorList[][] monitors
)
```

### setMonitorsByLocation( location, names, monitors ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the Monitors configured for the named GLB Services This is a location specific function, any action will operate on the specified location.

```bash
void setMonitorsByLocation(
String location
String[] names
GLB.Service.MonitorList[][] monitors
)
```

### setReturnIPsOnFail( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set whether to return all or no IP addresses on a complete failure

```bash
void setReturnIPsOnFail(
String[] names
Boolean[] values
)
```

### setRules( names, rules ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the rules that are run on DNS packets for each of the named GLB services.

```bash
void setRules(
String[] names
GLB.Service.Rule[][] rules
)
```

### setRulesByLocation( location, names, rules ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the rules that are run on DNS packets for each of the named GLB services. This is a location specific function, any action will operate on the specified location.

```bash
void setRulesByLocation(
String location
String[] names
GLB.Service.Rule[][] rules
)
```

### setServiceIPAddresses( names, localips ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set the Service IP addresses configured for the named GLB Services

```bash
void setServiceIPAddresses(
String[] names
GLB.Service.LocalIPList[][] localips
)
```

### setTTL( names, values ) throws ObjectDoesNotExist, InvalidInput, DeploymentError, LicenseError

Set The TTL for the DNS resource records handled by the GLB service.

```bash
void setTTL(
String[] names
Integer[] values
)
```

### Structures

### GLB.Service.DNSSECMapping

This contains a mapping between DNS domains and DNSSEC keys used to alter signed responses.

```bash
struct GLB.Service.DNSSECMapping {
# The domain of these keys sign.
String domain;
# An array of DNSSEC key names.
String[] keys;
}
```

### GLB.Service.Load

This structure contains the load for a GLB location.

```bash
struct GLB.Service.Load {
# The glb location.
String location;
# The load metric at the corresponding location.
Integer load;
}
```

### GLB.Service.LocalIPList

This structure contains the list of IP addresses for a GLB location.

```bash
struct GLB.Service.LocalIPList {
# The glb location.
String location;
# The IP Addresses or IP Masks that are present at the corresponding
# location.
String[] addresses;
}
```

### GLB.Service.MonitorList

This structure contains the list of monitors for a GLB location.

```bash
struct GLB.Service.MonitorList {
# The glb location.
String location;
# The monitors determining the health of the corresponding location.
String[] monitors;
}
```

### GLB.Service.Rule

This structure contains the information on how a rule is assigned to a virtual server.

```bash
struct GLB.Service.Rule {
# The name of the rule.
String name;
# Whether the rule is enabled or not.
Boolean enabled;
}
```

### Enumerations

### GLB.Service.Algorithm

```bash
enum GLB.Service.Algorithm {
# Load
load,
# Geographic
geo,
# Adaptive
hybrid,
# Round Robin
roundrobin,
# Weighted Random
weightedrandom,
# Primary/Backup
chained
}
```