gslbparameter¶

Configuration for GSLB parameter resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
ldnsentrytimeout	<Double>	Read-write	Time, in seconds, after which an inactive LDNS entry is removed. Default value: 180 Minimum value = 30 Maximum value = 65534
rtttolerance	<Double>	Read-write	Tolerance, in milliseconds, for newly learned round-trip time (RTT) values. If the difference between the old RTT value and the newly computed RTT value is less than or equal to the specified tolerance value, the LDNS entry in the network metric table is not updated with the new RTT value. Prevents the exchange of metrics when variations in RTT values are negligible. Default value: 5 Minimum value = 1 Maximum value = 100
ldnsmask	<String>	Read-write	The IPv4 network mask with which to create LDNS entries. Minimum length = 1
v6ldnsmasklen	<Double>	Read-write	Mask for creating LDNS entries for IPv6 source addresses. The mask is defined as the number of leading bits to consider, in the source IP address, when creating an LDNS entry. Default value: 128 Minimum value = 1 Maximum value = 128
ldnsprobeorder	<String[]>	Read-write	Order in which monitors should be initiated to calculate RTT. Possible values = PING, DNS, TCP
dropldnsreq	<String>	Read-write	Drop LDNS requests if round-trip time (RTT) information is not available. Default value: DISABLED Possible values = ENABLED, DISABLED
gslbsvcstatedelaytime	<Double>	Read-write	Amount of delay in updating the state of GSLB service to DOWN when MEP goes down. This parameter is applicable only if monitors are not bound to GSLB services. Default value: 0 Minimum value = 0 Maximum value = 3600
svcstatelearningtime	<Double>	Read-write	Time (in seconds) within which local or child site services remain in learning phase. GSLB site will enter the learning phase after reboot, HA failover, Cluster GSLB owner node changes or MEP being enabled on local node. Backup parent (if configured) will selectively move the adopted children's GSLB services to learning phase when primary parent goes down. While a service is in learning period, remote site will not honour the state and stats got through MEP for that service. State can be learnt from health monitor if bound explicitly. Default value: 0 Minimum value = 0 Maximum value = 3600
automaticconfigsync	<String>	Read-write	GSLB configuration will be synced automatically to remote gslb sites if enabled. Default value: DISABLED Possible values = ENABLED, DISABLED
mepkeepalivetimeout	<Double>	Read-write	Time duartion (in seconds) during which if no new packets received by Local gslb site from Remote gslb site then mark the MEP connection DOWN. Default value: 10 Minimum value = 1
gslbsyncinterval	<Double>	Read-write	Time duartion (in seconds) for which the gslb sync process will wait before checking for config changes. Default value: 10 Minimum value = 1
gslbsyncmode	<String>	Read-write	Mode in which configuration will be synced from master site to remote sites. Default value: IncrementalSync Possible values = IncrementalSync, FullSync
gslbsynclocfiles	<String>	Read-write	If disabled, Location files will not be synced to the remote sites as part of automatic sync. Default value: ENABLED Possible values = ENABLED, DISABLED
gslbconfigsyncmonitor	<String>	Read-write	If enabled, remote gslb site's rsync port will be monitored and site is considered for configuration sync only when the monitor is successful. Default value: DISABLED Possible values = ENABLED, DISABLED
gslbsyncsaveconfigcommand	<String>	Read-write	If enabled, 'save ns config' command will be treated as other GSLB commands and synced to GSLB nodes when auto gslb sync option is enabled. Default value: DISABLED Possible values = ENABLED, DISABLED
flags	<Double>	Read-only	State of the GSLB parameter.
builtin	<String[]>	Read-only	. Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
feature	<String>	Read-only	The feature to be checked while applying this config.
incarnation	<Double>	Read-only	This is a counter to maintain the gslb sync incarnation number.

Operations¶

(click to see Properties )

UPDATE
UNSET
GET (ALL)

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

update¶

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"gslbparameter":{
      "ldnsentrytimeout":<Double_value>,
      "rtttolerance":<Double_value>,
      "ldnsmask":<String_value>,
      "v6ldnsmasklen":<Double_value>,
      "ldnsprobeorder":<String[]_value>,
      "dropldnsreq":<String_value>,
      "gslbsvcstatedelaytime":<Double_value>,
      "svcstatelearningtime":<Double_value>,
      "automaticconfigsync":<String_value>,
      "mepkeepalivetimeout":<Double_value>,
      "gslbsyncinterval":<Double_value>,
      "gslbsyncmode":<String_value>,
      "gslbsynclocfiles":<String_value>,
      "gslbconfigsyncmonitor":<String_value>,
      "gslbsyncsaveconfigcommand":<String_value>
}}

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/gslbparameter? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"gslbparameter":{
      "ldnsentrytimeout":true,
      "rtttolerance":true,
      "ldnsmask":true,
      "v6ldnsmasklen":true,
      "ldnsprobeorder":true,
      "dropldnsreq":true,
      "gslbsvcstatedelaytime":true,
      "svcstatelearningtime":true,
      "automaticconfigsync":true,
      "mepkeepalivetimeout":true,
      "gslbsyncinterval":true,
      "gslbsyncmode":true,
      "gslbsynclocfiles":true,
      "gslbconfigsyncmonitor":true,
      "gslbsyncsaveconfigcommand":true
}}

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/gslbparameter

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:

{ "gslbparameter": [ {
      "flags":<Double_value>,
      "ldnsentrytimeout":<Double_value>,
      "rtttolerance":<Double_value>,
      "ldnsmask":<String_value>,
      "v6ldnsmasklen":<Double_value>,
      "ldnsprobeorder":<String[]_value>,
      "dropldnsreq":<String_value>,
      "gslbsvcstatedelaytime":<Double_value>,
      "svcstatelearningtime":<Double_value>,
      "automaticconfigsync":<String_value>,
      "builtin":<String[]_value>,
      "feature":<String_value>,
      "mepkeepalivetimeout":<Double_value>,
      "gslbsyncinterval":<Double_value>,
      "gslbsyncmode":<String_value>,
      "incarnation":<Double_value>,
      "gslbsynclocfiles":<String_value>,
      "gslbconfigsyncmonitor":<String_value>,
      "gslbsyncsaveconfigcommand":<String_value>
}]}