af_geoclient¶
Configuration for af geoclient API resource resource.
Properties¶
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
__count | <Double> | Read-write | count of geo location record.. |
country_code | <String> | Read-write | Country Code. |
network_latency_client_side | <Double> | Read-write | Network latency client side in selected geo client.. |
city | <String> | Read-write | City Name. |
country | <String> | Read-write | Country Name. |
total_user | <Double> | Read-write | Count of user i.e. various client IP addresses in the selected region.. |
region_code | <String> | Read-write | Region Code. |
region | <String> | Read-write | Region Name. |
total_bytes | <Double> | Read-write | Total bytes accounted by this in selected geo client.. |
bandwidth | <Double> | Read-write | Average Bandwidth.. |
network_latency_server_side | <Double> | Read-write | Network latency server side in selected geo client.. |
client_ip_address | <String> | Read-write | Client IP Address.
Minimum length = 1 Maximum length = 64 |
application_response_time | <Double> | Read-write | Application response time.. |
total_requests | <Double> | Read-write | Count of URL request in selected geo client.. |
Operations¶
(click to see Properties )
- 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
The following parameters can be used in the nitro request : onerror <String_value>
Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE
get (all)¶
URL: https://<MGMT-IP>/nitro/v2/config/af_geoclient
Query-parameters:
HTTPS Method: GET
Response:
HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "af_geoclient":[{
"__count":<Double_value>,
"country_code":<String_value>,
"network_latency_client_side":<Double_value>,
"city":<String_value>,
"app_unit_name":<String_value>,
"country":<String_value>,
"total_user":<Double_value>,
"region_code":<String_value>,
"region":<String_value>,
"total_bytes":<Double_value>,
"device_ip_address":<String_value>,
"domain_name":<String_value>,
"bandwidth":<Double_value>,
"network_latency_server_side":<Double_value>,
"client_ip_address":<String_value>,
"application_response_time":<Double_value>,
"total_requests":<Double_value>}]}