Citrix ADM NITRO API Reference

domain

June 20, 2023

Contributed by:

Configuration for AF Domain Report table resource.

Properties

(click to see Operations )

Name	Permissions	Description
cache_hits	Read-write	Total requests to this Domain for cache hits in given sampled timeframe..
num_of_bandwidth_mcb	Read-write	No of missed count breaches for bandwidth to this domain in the sampled timeframe..
ic_miss	Read-write	Total requests to this domain for cache miss in given sampled timeframe..
name	Read-write	Domain Name. Maximum length = 255
cache_miss	Read-write	Total requests to this Domain for cache miss in given sampled timeframe..
total_bytes	Read-write	Total bytes accounted by this domain in sampled timeframe..
num_of_hits_mcb	Read-write	No of missed count breaches breaches for hits to this domain in the sampled timeframe..
application_response_time	Read-write	Application response time..
num_of_open_connections_mcb	Read-write	No of missed count breaches for open connections to this domain in the sampled timeframe..
total_bytes_cache_hits	Read-write	Cache Hits total bytes accounted by this domain in sampled timeframe..
hits_breach	Read-write	Hits breach values reported to this domain in the sampled timeframe..
network_latency_client_side	Read-write	Network latency client side..
max_transaction_time	Read-write	Last Transaction Time for this URL in the sampled timeframe..
total_bytes_ic_miss	Read-write	Cache Miss total bytes accounted by this domain in sampled timeframe..
open_connections_breach	Read-write	Open connection breache value reported to this domain in the sampled timeframe..
bandwidth_breach	Read-write	bandwidth breach reported values to this domain in the sampled timeframe..
num_of_bandwidth_breaches	Read-write	No of times the timewindow breaches for bandwidth to this domain in the sampled timeframe..
total_bytes_ic_reval	Read-write	Cache Reval total bytes accounted by this domain in sampled timeframe..
rpt_sample_time	Read-write	Report Sample time..
ic_utilization	Read-write	Total IC utilization in given sampled timeframe..
num_of_response_time_breaches	Read-write	No of times the timewindow breaches for response time to this domain in the sampled timeframe..
num_of_response_time_mcb	Read-write	No of missed count breaches for response time to this domain in the sampled timeframe..
http_media_type_name	Read-write	HTTP MEDIA TYPE Name.. Maximum length = 30
__count	Read-write	count..
miss_count	Read-write	Cache Miss total bytes accounted by this domain in sampled timeframe..
total_bytes_cache_bypass	Read-write	Cache Bypass total bytes accounted by this domain in sampled timeframe..
http_content_type_name	Read-write	HTTP Content TYPE Name.. Maximum length = 256
ic_non_cache_hits	Read-write	Total requests to this domain for cache bypass in given sampled timeframe..
id	Read-write	Id is DomainName. Maximum length = 255
total_bytes_cache_miss	Read-write	Cache Miss total bytes accounted by this domain in sampled timeframe..
percent_bw_saved	Read-write	Percentage of bw save to this Domain in given sampled timeframe..
server_response_time	Read-write	Server response time..
network_latency_server_side	Read-write	Network latency server side..
total_bytes_ic_hits	Read-write	IC Cache Hits total bytes accounted by this domain in sampled timeframe..
ic_no_store_reason	Read-write	IC No Store Reason.. Maximum length = 256
cache_bypass	Read-write	Total requests to this Domain for cache bypass in given sampled timeframe..
num_of_hits_breaches	Read-write	No of times the timewindow breaches for hits to this domain in the sampled timeframe..
netscaler_processing_time	Read-write	Citrix ADC processing time..
ip_address	Read-write	Vserver IP Address.. Maximum length = 255
percentage_usage	Read-write	Percentage_usage of this Domain in given sampled timeframe..
num_of_open_connections_breaches	Read-write	No of times the timewindow breaches for open connections to this domain in the sampled timeframe..
ic_hits	Read-write	Total requests to this domain for cache hits in given sampled timeframe..
response_time_breach	Read-write	Response time reported breach value to this domain in the sampled timeframe..
miss_count_breaches	Read-write	No of times the timewindow breaches count exceeds the configured miss count breach threshold to this Domain.
ic_reval	Read-write	Total requests to this domain for cache bypass in given sampled timeframe..
total_requests	Read-write	Total requests to this Domain in given sampled timeframe..

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/domain Query-parameters:

cr_enabled Use this query-parameter to indicate cr is enabled or not.

Possible Values: 0, 1 report_start_time Use this query-parameter to specify the start time from which the summary for report is considered.

Possible Values: time in milli seconds report_end_time Use this query-parameter to specify the end time until where summary for report is considered.

Possible Values: time in milli seconds asc Use this query-parameter to specify whether the results should be in ascending order or not.

Possible Values: yes, no sla_enabled Use this query-parameter to indicate sla is enabled or not.

Possible Values: 0, 1 order_by Use this query-parameter to get the result that is ordered by the given property.

Possible Values: total_requests, total_bytes, application_response_time type Use this query-parameter to specify the type.

Possible Values: total_requests, total_bytes, application_response_time 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, "domain":[{
"cache_hits":<Double_value>,
"operating_system_name":<String_value>,
"num_of_bandwidth_mcb":<Double_value>,
"ic_miss":<Double_value>,
"name":<String_value>,
"cache_miss":<Double_value>,
"total_bytes":<Double_value>,
"num_of_hits_mcb":<Double_value>,
"application_response_time":<Double_value>,
"client_ip_address":<String_value>,
"num_of_open_connections_mcb":<Double_value>,
"total_bytes_cache_hits":<Double_value>,
"hits_breach":<Double_value>,
"http_resp_status_name":<String_value>,
"network_latency_client_side":<Double_value>,
"max_transaction_time":<Double_value>,
"total_bytes_ic_miss":<Double_value>,
"open_connections_breach":<Double_value>,
"bandwidth_breach":<Double_value>,
"num_of_bandwidth_breaches":<Double_value>,
"server_ip_address":<String_value>,
"total_bytes_ic_reval":<Double_value>,
"rpt_sample_time":<Double_value>,
"ic_utilization":<Double_value>,
"num_of_response_time_breaches":<Double_value>,
"num_of_response_time_mcb":<Double_value>,
"http_media_type_name":<String_value>,
"__count":<Double_value>,
"miss_count":<Double_value>,
"total_bytes_cache_bypass":<Double_value>,
"http_content_type_name":<String_value>,
"ic_non_cache_hits":<Double_value>,
"id":<String_value>,
"total_bytes_cache_miss":<Double_value>,
"vpn_user_name":<String_value>,
"http_req_method_name":<String_value>,
"user_agent_name":<String_value>,
"percent_bw_saved":<Double_value>,
"server_response_time":<Double_value>,
"network_latency_server_side":<Double_value>,
"total_bytes_ic_hits":<Double_value>,
"ic_no_store_reason":<String_value>,
"cache_bypass":<Double_value>,
"uri_url":<String_value>,
"num_of_hits_breaches":<Double_value>,
"netscaler_processing_time":<Double_value>,
"ip_address":<String_value>,
"percentage_usage":<Double_value>,
"num_of_open_connections_breaches":<Double_value>,
"ic_hits":<Double_value>,
"response_time_breach":<Double_value>,
"device_ip_address":<String_value>,
"miss_count_breaches":<Double_value>,
"ic_reval":<Double_value>,
"total_requests":<Double_value>}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

domain

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

domain

Properties

Operations

get (all)

In this article