Download full document:

location

Configuration for location resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
ipfrom<String>Read-writeFirst IP address in the range, in dotted decimal notation.
Minimum length = 1
ipto<String>Read-writeLast IP address in the range, in dotted decimal notation.
Minimum length = 1
preferredlocation<String>Read-writeString of qualifiers, in dotted notation, describing the geographical location of the IP address range. Each qualifier is more specific than the one that precedes it, as in continent.country.region.city.isp.organization. For example, "NA.US.CA.San Jose.ATT.citrix".
Note: A qualifier that includes a dot (.) or space ( ) must be enclosed in double quotation marks.
Minimum length = 1
longitude<Integer>Read-writeNumerical value, in degrees, specifying the longitude of the geographical location of the IP address-range.
Note: Longitude and latitude parameters are used for selecting a service with the static proximity GSLB method. If they are not specified, selection is based on the qualifiers specified for the location.
Minimum value = -180
Maximum value = 180
latitude<Integer>Read-writeNumerical value, in degrees, specifying the latitude of the geographical location of the IP address-range.
Note: Longitude and latitude parameters are used for selecting a service with the static proximity GSLB method. If they are not specified, selection is based on the qualifiers specified for the location.
Minimum value = -90
Maximum value = 90
q1label<String>Read-onlyLeast specific location qualifier.
q2label<String>Read-onlyLocation qualifier 2.
q3label<String>Read-onlyLocation qualifier 3.
q4label<String>Read-onlyLocation qualifier 4.
q5label<String>Read-onlyLocation qualifier 5.
q6label<String>Read-onlyMost specific location qualifier.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

ADD| DELETE| 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 redand placeholder content is marked in <green>.

add

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

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"location":{
<b>"ipfrom":<String_value>,
</b><b>"ipto":<String_value>,
</b><b>"preferredlocation":<String_value>,
</b>"longitude":<Integer_value>,
"latitude":<Integer_value>
}}

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/location/ipfrom_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

get (all)

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

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/location?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/location?filter=property-name1:property-val1,property-name2:property-val2

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

view

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

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

pagination

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

Use this query-parameter to get the location 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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "location": [ {
"ipfrom":<String_value>,
"ipto":<String_value>,
"preferredlocation":<String_value>,
"q1label":<String_value>,
"q2label":<String_value>,
"q3label":<String_value>,
"q4label":<String_value>,
"q5label":<String_value>,
"q6label":<String_value>,
"longitude":<Integer_value>,
"latitude":<Integer_value>
}]}

get

URL:http://<netscaler-ip-address>/nitro/v1/config/location/ipfrom_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/location/ipfrom_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/location/ipfrom_value<String>?view=summary

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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "location": [ {
"ipfrom":<String_value>,
"ipto":<String_value>,
"preferredlocation":<String_value>,
"q1label":<String_value>,
"q2label":<String_value>,
"q3label":<String_value>,
"q4label":<String_value>,
"q5label":<String_value>,
"q6label":<String_value>,
"longitude":<Integer_value>,
"latitude":<Integer_value>
}]}

count

URL:http://<netscaler-ip-address>/nitro/v1/config/location?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 errorResponse Headers:

Content-Type:application/json

Response Payload:

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