locationparameter
Configuration for location parameter resource.
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| context | <String> | Read-write | Context for describing locations. In geographic context, qualifier labels are assigned by default in the following sequence: Continent.Country.Region.City.ISP.Organization. In custom context, the qualifiers labels can have any meaning that you designate.
Possible values = geographic, custom
|
| q1label | <String> | Read-write | Label specifying the meaning of the first qualifier. Can be specified for custom context only.
Minimum length = 1
|
| q2label | <String> | Read-write | Label specifying the meaning of the second qualifier. Can be specified for custom context only.
Minimum length = 1
|
| q3label | <String> | Read-write | Label specifying the meaning of the third qualifier. Can be specified for custom context only.
Minimum length = 1
|
| q4label | <String> | Read-write | Label specifying the meaning of the fourth qualifier. Can be specified for custom context only.
Minimum length = 1
|
| q5label | <String> | Read-write | Label specifying the meaning of the fifth qualifier. Can be specified for custom context only.
Minimum length = 1
|
| q6label | <String> | Read-write | Label specifying the meaning of the sixth qualifier. Can be specified for custom context only.
Minimum length = 1
|
| Locationfile | <String> | Read-only | Currently loaded location database file. |
| format | <String> | Read-only | Location file format.
Possible values = netscaler, ip-country, ip-country-isp, ip-country-region-city, ip-country-region-city-isp, geoip-country, geoip-region, geoip-city, geoip-country-org, geoip-country-isp, geoip-city-isp-org
|
| custom | <Double> | Read-only | Number of configured custom locations. |
| Static | <Double> | Read-only | Number of configured locations in the database file (static locations). |
| lines | <Double> | Read-only | Number of lines in the databse files. |
| errors | <Double> | Read-only | Number of errros encountered while reading the database file. |
| warnings | <Double> | Read-only | Number of warnings encountered while reading the database file. |
| entries | <Double> | Read-only | Number of successfully added entries. |
| locationfile6 | <String> | Read-only | Currently loaded location database file. |
| format6 | <String> | Read-only | Location file format.
Possible values = netscaler6, geoip-country6
|
| custom6 | <Double> | Read-only | Number of configured custom locations. |
| static6 | <Double> | Read-only | Number of configured locations in the database file (static locations). |
| lines6 | <Double> | Read-only | Number of lines in the databse files. |
| errors6 | <Double> | Read-only | Number of errros encountered while reading the database file. |
| warnings6 | <Double> | Read-only | Number of warnings encountered while reading the database file. |
| entries6 | <Double> | Read-only | Number of successfully added entries. |
| flags | <Double> | Read-only | Information needed for display. This argument passes information from the kernel to the user space. |
| status | <Double> | Read-only | This argument displays when the status (success or failure) of database loading. |
| databasemode | <String> | Read-only | This argument displays the database mode.
Possible values = File, Internal, Not applicable
|
| flushing | <String> | Read-only | This argument displays the state of flushing.
Possible values = In progress, Idle
|
| loading | <String> | Read-only | This argument displays the state of loading.
Possible values = In progress, Idle
|
| matchwildcardtoany | <String> | Read-only | Indicates whether wildcard qualifiers should match any other qualifier including non-wildcard. Option to fallback after default behavior changes to not match.
Default value: NO
Possible values = YES, NO
|
Operations
(click to see Properties)
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 Citrix ADC appliance, the URL is as follows:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/login?warning=yesIf 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 Citrix ADC 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>.
update
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/locationparameter
HTTP Method:PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"locationparameter":{
"context":<String_value>,
"q1label":<String_value>,
"q2label":<String_value>,
"q3label":<String_value>,
"q4label":<String_value>,
"q5label":<String_value>,
"q6label":<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 Citrix ADC specific errors). The response payload provides details of the error
unset
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/locationparameter?action=unset
HTTP Method:POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json
Request Payload:
{"locationparameter":{
"context":true,
"q1label":true,
"q2label":true,
"q3label":true,
"q4label":true,
"q5label":true,
"q6label":true
}}
Response:
HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error
get (all)
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/locationparameter
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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "locationparameter": [ {
"context":<String_value>,
"q1label":<String_value>,
"q2label":<String_value>,
"q3label":<String_value>,
"q4label":<String_value>,
"q5label":<String_value>,
"q6label":<String_value>,
"Locationfile":<String_value>,
"format":<String_value>,
"custom":<Double_value>,
"Static":<Double_value>,
"lines":<Double_value>,
"errors":<Double_value>,
"warnings":<Double_value>,
"entries":<Double_value>,
"locationfile6":<String_value>,
"format6":<String_value>,
"custom6":<Double_value>,
"static6":<Double_value>,
"lines6":<Double_value>,
"errors6":<Double_value>,
"warnings6":<Double_value>,
"entries6":<Double_value>,
"flags":<Double_value>,
"status":<Double_value>,
"databasemode":<String_value>,
"flushing":<String_value>,
"loading":<String_value>,
"matchwildcardtoany":<String_value>
}]}