ADC CLI Commands

gslb-site

The following operations can be performed on “gslb-site”:

add unset set show rename stat rm

add gslb site

Creates a global server load balancing site.

Synopsis

add gslb site \[] \[-publicIP <ip\_addr|ipv6\_addr|\*>] \[-metricExchange \( ENABLED | DISABLED )] \[-nwMetricExchange \( ENABLED | DISABLED )] \[-sessionExchange \( ENABLED | DISABLED )] \[-triggerMonitor ] \[-parentSite | -backupParentlist ...] \[-clip <ip\_addr|ipv6\_addr|\*> \[]] \[-naptrReplacementSuffix ] \[-sitePassword ]

Arguments

siteName Name for the GSLB site. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the virtual server is created.

CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my gslbsite” or ‘my gslbsite’).

siteType Type of site to create. If the type is not specified, the appliance automatically detects and sets the type on the basis of the IP address being assigned to the site. If the specified site IP address is owned by the appliance (for example, a MIP address or SNIP address), the site is a local site. Otherwise, it is a remote site.

Possible values: REMOTE, LOCAL Default value: NONE

siteIPAddress IP address for the GSLB site. The GSLB site uses this IP address to communicate with other GSLB sites. For a local site, use any IP address that is owned by the appliance (for example, a SNIP or MIP address, or the IP address of the ADNS service).

publicIP Public IP address for the local site. Required only if the appliance is deployed in a private address space and the site has a public IP address hosted on an external firewall or a NAT device.

metricExchange Exchange metrics with other sites. Metrics are exchanged by using Metric Exchange Protocol (MEP). The appliances in the GSLB setup exchange health information once every second.

If you disable metrics exchange, you can use only static load balancing methods (such as round robin, static proximity, or the hash-based methods), and if you disable metrics exchange when a dynamic load balancing method (such as least connection) is in operation, the appliance falls back to round robin. Also, if you disable metrics exchange, you must use a monitor to determine the state of GSLB services. Otherwise, the service is marked as DOWN.

Possible values: ENABLED, DISABLED Default value: ENABLED

nwMetricExchange Exchange, with other GSLB sites, network metrics such as round-trip time (RTT), learned from communications with various local DNS (LDNS) servers used by clients. RTT information is used in the dynamic RTT load balancing method, and is exchanged every 5 seconds.

Possible values: ENABLED, DISABLED Default value: ENABLED

sessionExchange Exchange persistent session entries with other GSLB sites every five seconds.

Possible values: ENABLED, DISABLED Default value: ENABLED

triggerMonitor Specify the conditions under which the GSLB service must be monitored by a monitor, if one is bound. Available settings function as follows:

  • ALWAYS - Monitor the GSLB service at all times.
  • MEPDOWN - Monitor the GSLB service only when the exchange of metrics through the Metrics Exchange Protocol (MEP) is disabled. MEPDOWN_SVCDOWN - Monitor the service in either of the following situations:
  • The exchange of metrics through MEP is disabled.
  • The exchange of metrics through MEP is enabled but the status of the service, learned through metrics exchange, is DOWN.

Possible values: ALWAYS, MEPDOWN, MEPDOWN_SVCDOWN Default value: ALWAYS

parentSite Parent site of the GSLB site, in a parent-child topology.

clip Cluster IP address. Specify this parameter to connect to the remote cluster site for GSLB auto-sync. Note: The cluster IP address is defined when creating the cluster.

publicCLIP IP address to be used to globally access the remote cluster when it is deployed behind a NAT. It can be same as the normal cluster IP address.

naptrReplacementSuffix The naptr replacement suffix configured here will be used to construct the naptr replacement field in NAPTR record.

backupParentlist The list of backup gslb sites configured in preferred order. Need to be parent gsb sites. Default value: “None”

sitePassword Password to be used for mep communication between gslb site nodes.

Example

add site new_york LOCAL 192.168.100.12 -publicIP 65.200.211.139

unset gslb site

Use this command to remove gslb site settings.Refer to the set gslb site command for meanings of the arguments.

Synopsis

unset gslb site [-metricExchange] [-nwMetricExchange] [-sessionExchange] [-triggerMonitor] [-naptrReplacementSuffix] [-backupParentlist]

set gslb site

Modifies the specified parameters of a global server load balancing (GSLB) site.

Synopsis

set gslb site \[-metricExchange \( ENABLED | DISABLED )] \[-nwMetricExchange \( ENABLED | DISABLED )] \[-sessionExchange \( ENABLED | DISABLED )] \[-triggerMonitor ] \[-naptrReplacementSuffix ] \[-parentSite ] \[-backupParentlist ...]

Arguments

siteName Name of the GSLB site.

metricExchange Exchange metrics with other sites. Metrics are exchanged by using Metric Exchange Protocol (MEP). The appliances in the GSLB setup exchange health information once every second.

If you disable metrics exchange, you can use only static load balancing methods (such as round robin, static proximity, or the hash-based methods), and if you disable metrics exchange when a dynamic load balancing method (such as least connection) is in operation, the appliance falls back to round robin. Also, if you disable metrics exchange, you must use a monitor to determine the state of GSLB services. Otherwise, the service is marked as DOWN.

Possible values: ENABLED, DISABLED Default value: ENABLED

nwMetricExchange Exchange, with other GSLB sites, network metrics such as round-trip time (RTT), learned from communications with various local DNS (LDNS) servers used by clients. RTT information is used in the dynamic RTT load balancing method, and is exchanged every 5 seconds.

Possible values: ENABLED, DISABLED Default value: ENABLED

sessionExchange Exchange persistent session entries with other GSLB sites every five seconds.

Possible values: ENABLED, DISABLED Default value: ENABLED

triggerMonitor Specify the conditions under which the GSLB service must be monitored by a monitor, if one is bound. Available settings function as follows:

  • ALWAYS - Monitor the GSLB service at all times.
  • MEPDOWN - Monitor the GSLB service only when the exchange of metrics through the Metrics Exchange Protocol (MEP) is disabled. MEPDOWN_SVCDOWN - Monitor the service in either of the following situations:
  • The exchange of metrics through MEP is disabled.
  • The exchange of metrics through MEP is enabled but the status of the service, learned through metrics exchange, is DOWN.

Possible values: ALWAYS, MEPDOWN, MEPDOWN_SVCDOWN Default value: ALWAYS

naptrReplacementSuffix The naptr replacement suffix configured here will be used to construct the naptr replacement field in NAPTR record.

parentSite Parent site of the GSLB site, in a parent-child topology.

backupParentlist The list of backup gslb sites configured in preferred order. Need to be parent gsb sites. Default value: “None”

Example

set gslb site new_york - metricExchange DISABLED

show gslb site

Displays the parameters of all the GSLB sites configured on the appliance, or the parameters of the specified GSLB site.

Synopsis

show gslb site [] show gslb site stats - alias for 'stat gslb site'

Arguments

siteName Name of the GSLB site. If you specify a site name, details of all the site’s constituent services are also displayed.

Output

siteType Specifies whether the site is LOCAL or REMOTE.

siteIPAddress The IP address of the site.

publicIP The Public IP of the gslb site.

metricExchange Exchange metrics with other sites. Metrics are exchanged by using Metric Exchange Protocol (MEP). The appliances in the GSLB setup exchange health information once every second.

If you disable metrics exchange, you can use only static load balancing methods (such as round robin, static proximity, or the hash-based methods), and if you disable metrics exchange when a dynamic load balancing method (such as least connection) is in operation, the appliance falls back to round robin. Also, if you disable metrics exchange, you must use a monitor to determine the state of GSLB services. Otherwise, the service is marked as DOWN.

serviceName Service name.

IPAddress IP Address of the gslb service.

port Port number of the gslb service.

state State of the gslb service.

status Current metric exchange status.

persistenceMEPStatus Network metric and persistence exchange MEP connection status

serviceType Service type.

nwMetricExchange Specifies whether the exchange of network metrics like RTT is enabled or disabled.

sessionExchange Specifies whether the exchange of persistence session entries is enabled or disabled.

triggerMonitor Specify the conditions under which the GSLB service must be monitored by a monitor, if one is bound. Available settings function as follows:

  • ALWAYS - Monitor the GSLB service at all times.
  • MEPDOWN - Monitor the GSLB service only when the exchange of metrics through the Metrics Exchange Protocol (MEP) is disabled. MEPDOWN_SVCDOWN - Monitor the service in either of the following situations:
  • The exchange of metrics through MEP is disabled.
  • The exchange of metrics through MEP is enabled but the status of the service, learned through metrics exchange, is DOWN.

parentSite Parent site of the GSLB site, in a parent-child topology.

cnameEntry The cname of the gslb service.

stateflag stateflag

version will be true if the remote site’s version is ncore compatible with the local site.(>= 9.2)

clip Cluster IP address. Specify this parameter to connect to the remote cluster site for GSLB auto-sync. Note: The cluster IP address is defined when creating the cluster.

publicCLIP IP address to be used to globally access the remote cluster when it is deployed behind a NAT. It can be same as the normal cluster IP address.

naptrReplacementSuffix The naptr replacement suffix configured here will be used to construct the naptr replacement field in NAPTR record.

backupParentlist The list of backup gslb sites configured in preferred order. Need to be parent gsb sites.

curBackupparentIP Current active backup parent IP address since the configured is DOWN.

serviceGroupName Servicegroup name.

svcitmnum This field is introduced for maintaining service items ordering while displaying gslb service groups

svcgrnm This field is introduced for displaying service groups bound to site.

siteState Site state.

oldName Old name for the GSLB site. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the virtual server is created.

CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my gslbsite” or ‘my gslbsite’).

devno count

Example

show site new_york

rename gslb site

Renames a global server load balancing site.

Synopsis

rename gslb site @ @

Arguments

siteName Existing name of the GSLB site.

newName New name for the GSLB site.

Example

rename gslb site gslb_site gslb_site_new

stat gslb site

Displays statistics for a GSLB site.

Synopsis

stat gslb site [] \[-detail] \[-fullValues] \[-ntimes <positive\_integer>] \[-logFile <input\_filename>] \[-clearstats \( basic | full )]

Arguments

siteName Name of the GSLB site for which to display detailed statistics. If a name is not specified, basic information about all GSLB sites is displayed.

detail Specifies detailed output (including more statistics). The output can be quite voluminous. Without this argument, the output will show only a summary.

fullValues Specifies that numbers and strings should be displayed in their full form. Without this option, long strings are shortened and large numbers are abbreviated

ntimes The number of times, in intervals of seven seconds, the statistics should be displayed. Default value: 1 Minimum value: 0

logFile The name of the log file to be used as input.

clearstats Clear the statsistics / counters

Possible values: basic, full

Output

count devno stateflag

Counters

Gslb Site Public IP address (Public IP) The public IP address of this GSLB site.

Gslb Site private IP address (Private IP) The private IP address of this GSLB site.

Metric Exchange State (MEPstate) Indicates the status of the Metric Exchange Policy at this GSLB site.

Persistence Exchange (PersMEP) Indicates whether Persistence entries exchange is enabled or disabled at this GSLB site.

Network Metric Exchange (NwMEP) Indicates whether network metric exchange is enabled or disabled at this GSLB site.

Metric Exchange (MEP) Indicates whether metric exchange is enabled or disabled at this GSLB site.

GSLB Site type (sitetype) Indicates whether this GSLB site is local or remote.

Gslb Site private IP address (Private IP) The private IP address of this GSLB site.

Gslb Site public IP address (Public IP) The public IP address of this GSLB site.

Site Metric Metric Exchange State (SiteMetricMEPstate) Indicates the status of the site metric Metric Exchange connection at this GSLB site.

Network Metric Metric Exchange State (NwMetricMEPstate) Indicates the status of the network metric Metric Exchange connection at this GSLB site.

Request bytes (Reqb) Total number of request bytes received by the virtual servers represented by all GSLB services associated with this GSLB site.

Response bytes (Rspb) Number of response bytes received by the virtual servers represented by all GSLB services associated with this GSLB site.

Requests (Req) Total number of requests received by the virtual servers represented by all GSLB services associated with this GSLB site.

Responses (Rsp) Number of responses received by the virtual servers represented by all GSLB services associated with this GSLB site.

Current client connections (ClntConn) Number of current client connections to the virtual servers represented by all GSLB services associated with this GSLB site.

Current server connections (SvrConn) Number of current connections to the real servers behind the virtual servers represented by all GSLB services associated with this GSLB site.

rm gslb site

Removes a global server load balancing (GSLB) site and all its constituent GSLB services.

Synopsis

rm gslb site

Arguments

siteName Name of the GSLB site to remove.

Example

rm gslb site new_york

gslb-site