domain
Configuration for AF Domain Report table resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| __count | <Double> | Read-write | count.. |
| miss_count | <Double> | Read-write | Total time window breaches for this Domain in given sampled timeframe. |
| cache_hits | <Double> | Read-write | Total requests to this Domain for cache hits in given sampled timeframe.. |
| http_content_type_name | <String> | Read-write | HTTP Content TYPE Name.. Maximum length = 256 |
| total_bytes_cache_bypass | <Double> | Read-write | Cache Bypass total bytes accounted by this URL in sampled timeframe.. |
| ic_non_cache_hits | <Double> | Read-write | Total requests to this APP for cache bypass in given sampled timeframe.. |
| id | <String> | Read-write | Id is DomainName. Maximum length = 255 |
| num_of_bandwidth_mcb | <Double> | Read-write | No of missed count breaches for bandwidth to this domain in the sampled timeframe.. |
| total_bytes_cache_miss | <Double> | Read-write | Cache Miss total bytes accounted by this URL in sampled timeframe.. |
| ic_miss | <Double> | Read-write | Total requests to this APP for cache miss in given sampled timeframe.. |
| cache_miss | <Double> | Read-write | Total requests to this Domain for cache miss in given sampled timeframe.. |
| name | <String> | Read-write | Domain Name. Maximum length = 255 |
| total_bytes | <Double> | Read-write | Total bytes accounted by this URL in sampled timeframe.. |
| percent_bw_saved | <Double> | Read-write | Percentage of bw save to this Domain in given sampled timeframe.. |
| server_response_time | <Double> | Read-write | Server response time.. |
| num_of_hits_mcb | <Double> | Read-write | No of missed count breaches breaches for hits to this domain in the sampled timeframe.. |
| network_latency_server_side | <Double> | Read-write | Network latency server side.. |
| application_response_time | <Double> | Read-write | Application response time.. |
| total_bytes_ic_hits | <Double> | Read-write | IC Cache Hits total bytes accounted by this URL in sampled timeframe.. |
| num_of_open_connections_mcb | <Double> | Read-write | No of missed count breaches for open connections to this domain in the sampled timeframe.. |
| hits_breach | <Double> | Read-write | Hits breach values reported to this domain in the sampled timeframe.. |
| total_bytes_cache_hits | <Double> | Read-write | Cache Hits total bytes accounted by this URL in sampled timeframe.. |
| ic_no_store_reason | <String> | Read-write | ic_no_store_reason.. Maximum length = 256 |
| network_latency_client_side | <Double> | Read-write | Network latency client side.. |
| total_bytes_ic_miss | <Double> | Read-write | Cache Miss total bytes accounted by this URL in sampled timeframe.. |
| max_transaction_time | <Double> | Read-write | Last Transaction Time for this URL in the sampled timeframe.. |
| cache_bypass | <Double> | Read-write | Total requests to this Domain for cache bypass in given sampled timeframe.. |
| open_connections_breach | <Double> | Read-write | open connection breache value reported to this domain in the sampled timeframe.. |
| num_of_hits_breaches | <Double> | Read-write | No of times the timewindow breaches for hits to this domain in the sampled timeframe.. |
| ip_address | <String> | Read-write | App Ip Address.. Maximum length = 255 |
| netscaler_processing_time | <Double> | Read-write | NetScaler processing time.. |
| percentage_usage | <Double> | Read-write | Percentage_usage of this Domain in given sampled timeframe.. |
| bandwidth_breach | <Double> | Read-write | bandwidth breach reported values to this domain in the sampled timeframe.. |
| num_of_bandwidth_breaches | <Double> | Read-write | No of times the timewindow breaches for bandwidth to this domain in the sampled timeframe.. |
| ic_hits | <Double> | Read-write | Total requests to this APP for cache hits in given sampled timeframe.. |
| num_of_open_connections_breaches | <Double> | Read-write | No of times the timewindow breaches for open connections to this domain in the sampled timeframe.. |
| total_bytes_ic_reval | <Double> | Read-write | Cache Reval total bytes accounted by this URL in sampled timeframe.. |
| response_time_breach | <Double> | Read-write | Response time reported breach value to this domain in the sampled timeframe.. |
| rpt_sample_time | <Double> | Read-write | Report Sample time.. |
| miss_count_breaches | <Double> | Read-write | No of times the timewindow breaches count exceeds the configured miss count breach threshold to this Domain. |
| ic_utilization | <Double> | Read-write | Total IC utilization in given sampled timeframe.. |
| ic_reval | <Double> | Read-write | Total requests to this APP for cache bypass in given sampled timeframe.. |
| num_of_response_time_breaches | <Double> | Read-write | No of times the timewindow breaches for response time to this domain in the sampled timeframe.. |
| num_of_response_time_mcb | <Double> | Read-write | No of missed count breaches for response time to this domain in the sampled timeframe.. |
| total_requests | <Double> | Read-write | Total requests to this Domain in given sampled timeframe.. |
| http_media_type_name | <String> | Read-write | HTTP MEDIA TYPE Name.. Maximum length = 30 |
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 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>.
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/domain
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "domain":[{
"__count":<Double_value>,
"miss_count":<Double_value>,
"cache_hits":<Double_value>,
"http_content_type_name":<String_value>,
"total_bytes_cache_bypass":<Double_value>,
"ic_non_cache_hits":<Double_value>,
"id":<String_value>,
"num_of_bandwidth_mcb":<Double_value>,
"total_bytes_cache_miss":<Double_value>,
"operating_system_name":<String_value>,
"ic_miss":<Double_value>,
"vpn_user_name":<String_value>,
"cache_miss":<Double_value>,
"http_req_method_name":<String_value>,
"name":<String_value>,
"total_bytes":<Double_value>,
"user_agent_name":<String_value>,
"percent_bw_saved":<Double_value>,
"server_response_time":<Double_value>,
"num_of_hits_mcb":<Double_value>,
"network_latency_server_side":<Double_value>,
"client_ip_address":<String_value>,
"application_response_time":<Double_value>,
"total_bytes_ic_hits":<Double_value>,
"num_of_open_connections_mcb":<Double_value>,
"hits_breach":<Double_value>,
"total_bytes_cache_hits":<Double_value>,
"ic_no_store_reason":<String_value>,
"http_resp_status_name":<String_value>,
"network_latency_client_side":<Double_value>,
"total_bytes_ic_miss":<Double_value>,
"max_transaction_time":<Double_value>,
"uri_url":<String_value>,
"cache_bypass":<Double_value>,
"open_connections_breach":<Double_value>,
"num_of_hits_breaches":<Double_value>,
"ip_address":<String_value>,
"netscaler_processing_time":<Double_value>,
"percentage_usage":<Double_value>,
"bandwidth_breach":<Double_value>,
"num_of_bandwidth_breaches":<Double_value>,
"ic_hits":<Double_value>,
"num_of_open_connections_breaches":<Double_value>,
"total_bytes_ic_reval":<Double_value>,
"response_time_breach":<Double_value>,
"server_ip_address":<String_value>,
"rpt_sample_time":<Double_value>,
"miss_count_breaches":<Double_value>,
"device_ip_address":<String_value>,
"ic_utilization":<Double_value>,
"ic_reval":<Double_value>,
"num_of_response_time_breaches":<Double_value>,
"num_of_response_time_mcb":<Double_value>,
"total_requests":<Double_value>,
"http_media_type_name":<String_value>}]}