Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

gslbsite

August 17, 2023
Contributed by: 
C

Configuration for GSLB site resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
sitename <String> Read-write 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').

Minimum length = 1
sitetype <String> Read-write 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.

Default value: NONE

Possible values = REMOTE, LOCAL
siteipaddress <String> Read-write 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).

Minimum length = 1
publicip <String> Read-write 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.

Minimum length = 1
metricexchange <String> Read-write 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.

Default value: ENABLED

Possible values = ENABLED, DISABLED
nwmetricexchange <String> Read-write 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.

Default value: ENABLED

Possible values = ENABLED, DISABLED
sessionexchange <String> Read-write Exchange persistent session entries with other GSLB sites every five seconds.

Default value: ENABLED

Possible values = ENABLED, DISABLED
triggermonitor <String> Read-write 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.

Default value: ALWAYS

Possible values = ALWAYS, MEPDOWN, MEPDOWN_SVCDOWN
parentsite <String> Read-write Parent site of the GSLB site, in a parent-child topology.
clip <String> Read-write 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 <String> Read-write 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 <String> Read-write The naptr replacement suffix configured here will be used to construct the naptr replacement field in NAPTR record.

Minimum length = 1
backupparentlist <String[]> Read-write The list of backup gslb sites configured in preferred order. Need to be parent gsb sites.

Default value: "None"
status <String> Read-only Current metric exchange status.

Possible values = ACTIVE, INACTIVE, DOWN
persistencemepstatus <String> Read-only Network metric and persistence exchange MEP connection status.

Possible values = ACTIVE, INACTIVE, DOWN
version <Double> Read-only will be true if the remote site's version is ncore compatible with the local site.(>= 9.2).
curbackupparentip <String> Read-only Current active backup parent IP address since the configured is DOWN.
__count <Double> Read-only count parameter

Operations

(click to see Properties )

  • ADD
  • DELETE
  • UPDATE
  • UNSET
  • GET (ALL)
  • GET
  • COUNT

Some options that you can use for each operations:

  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.

  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

    To do this, you must specify the username and password in the request header of the NITRO request as follows:

    X-NITRO-USER: <username>

    X-NITRO-PASS: <password>

    Note: In such cases, make sure that the request header DOES not include the following:

    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note: *

Mandatory parameters are marked in red and placeholder content is marked in green

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbsite

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"gslbsite":{
<b>      "sitename":<String_value>,
</b>      "sitetype":<String_value>,
<b>      "siteipaddress":<String_value>,
</b>      "publicip":<String_value>,
      "metricexchange":<String_value>,
      "nwmetricexchange":<String_value>,
      "sessionexchange":<String_value>,
      "triggermonitor":<String_value>,
      "parentsite":<String_value>,
      "clip":<String_value>,
      "publicclip":<String_value>,
      "naptrreplacementsuffix":<String_value>,
      "backupparentlist":<String[]_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbsite/ sitename_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbsite

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"gslbsite":{
<b>      "sitename":<String_value>,
</b>      "metricexchange":<String_value>,
      "nwmetricexchange":<String_value>,
      "sessionexchange":<String_value>,
      "triggermonitor":<String_value>,
      "naptrreplacementsuffix":<String_value>,
      "backupparentlist":<String[]_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbsite? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload: 


{"gslbsite":{
<b>      "sitename":<String_value>,
</b>      "metricexchange":true,
      "nwmetricexchange":true,
      "sessionexchange":true,
      "triggermonitor":true,
      "naptrreplacementsuffix":true,
      "backupparentlist":true
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbsite

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/gslbsite? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/gslbsite? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of gslbsite resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/gslbsite? view=summary

Use this query-parameter to get the summary output of gslbsite resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/gslbsite? pagesize=#no;pageno=#no

Use this query-parameter to get the gslbsite resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{ "gslbsite": [ {
      "sitename":<String_value>,
      "sitetype":<String_value>,
      "siteipaddress":<String_value>,
      "publicip":<String_value>,
      "metricexchange":<String_value>,
      "status":<String_value>,
      "persistencemepstatus":<String_value>,
      "nwmetricexchange":<String_value>,
      "sessionexchange":<String_value>,
      "triggermonitor":<String_value>,
      "parentsite":<String_value>,
      "version":<Double_value>,
      "clip":<String_value>,
      "publicclip":<String_value>,
      "naptrreplacementsuffix":<String_value>,
      "backupparentlist":<String[]_value>,
      "curbackupparentip":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbsite/ sitename_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/gslbsite/ sitename_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/gslbsite/ sitename_value<String> ? view=summary

Use this query-parameter to get the summary output of gslbsite resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{  "gslbsite": [ {
      "sitename":<String_value>,
      "sitetype":<String_value>,
      "siteipaddress":<String_value>,
      "publicip":<String_value>,
      "metricexchange":<String_value>,
      "status":<String_value>,
      "persistencemepstatus":<String_value>,
      "nwmetricexchange":<String_value>,
      "sessionexchange":<String_value>,
      "triggermonitor":<String_value>,
      "parentsite":<String_value>,
      "version":<Double_value>,
      "clip":<String_value>,
      "publicclip":<String_value>,
      "naptrreplacementsuffix":<String_value>,
      "backupparentlist":<String[]_value>,
      "curbackupparentip":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/gslbsite? count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload: 


{ "gslbsite": [ { "__count": "#no"} ] }

<!--NeedCopy-->
gslbsite
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.