client
Configuration for AF Client Report table resource.
Read/write properties
ssl_certificate_name<String>
SSL certificate name..
Maximum length = 256
load_time<Double>
URI Load time..
total_bytes_cache_bypass<Double>
Cache Bypass total bytes accounted by this URL in sampled timeframe..
ctnsappname_b<String>
Backend LB vserver.
Maximum length = 255
vpn_user_name<String>
vpn user name..
Maximum length = 255
max_transaction_time<Double>
Last Transaction Time for this URL in the sampled timeframe..
cache_hits<Double>
Total requests to this APP for cache hits in given sampled timeframe..
network_latency_client_side_max<Double>
Max value of Network latency client side..
domain_name<String>
Domain Name..
Maximum length = 2000
uri_url<String>
HTTP Request URL..
Maximum length = 2000
ip_address<String>
Source IP Address.
Minimum length = 1
Maximum length = 64
ic_utilization<Double>
Total IC utilization in given sampled timeframe..
ssl_protocol_name<String>
SSL protocol name..
Maximum length = 256
total_bytes_cache_hits<Double>
Cache Hits total bytes accounted by this URL in sampled timeframe..
ssl_cipher_negotiated_cipher_name<String>
SSL cipher name..
Maximum length = 256
http_media_type_name<String>
HTTP MEDIA TYPE Name..
Maximum length = 30
total_requests<Double>
Count of this URL in given sampled timeframe..
ssl_cipher_failure_frontend<String>
SSL cipher failure frontend..
Maximum length = 256
ic_hits<Double>
Total requests to this APP for cache hits in given sampled timeframe..
cache_miss<Double>
Total requests to this APP for cache miss in given sampled timeframe..
total_bytes_ic_reval<Double>
Cache Reval total bytes accounted by this URL in sampled timeframe..
total_bytes_ic_hits<Double>
IC Cache Hits total bytes accounted by this URL in sampled timeframe..
user_agent_name<String>
User Agent Name..
Maximum length = 30
id<String>
Id is Client IP Address..
Minimum length = 1
Maximum length = 64
mismatchCiphers<String>
SSL mismatch cipher failure..
Maximum length = 256
render_time<Double>
Render time..
http_req_method_name<String>
HTTP Request Method..
Maximum length = 30
ic_no_store_reason<String>
ic_no_store_reason..
Maximum length = 256
ssl_key_strength_name<String>
SSL key strength name..
Maximum length = 256
total_bytes_ic_miss<Double>
Cache Miss total bytes accounted by this URL in sampled timeframe..
ssl_cipher_name<String>
SSL cipher name..
Maximum length = 256
total_bytes<Double>
Total bytes accounted by this URL in sampled timeframe..
cache_bypass<Double>
Total requests to this APP for cache bypass in given sampled timeframe..
http_content_type_name<String>
HTTP Content TYPE Name..
Maximum length = 256
app_unit_name<String>
AppName.
Maximum length = 255
server_ip_address<String>
Server Source IP Address.
Minimum length = 1
Maximum length = 64
__count<Double>
count..
application_name<String>
Application Name.
Maximum length = 255
rpt_sample_time<Double>
Report Sample time..
ssl_cipher_failure_backend<String>
SSL cipher failure backend..
Maximum length = 256
operating_system_name<String>
Client Operating System Name..
Maximum length = 30
percent_bw_saved<Double>
Percentage of bw save to this APP in given sampled timeframe..
unsupportedCiphers<String>
SSL unsupported cipher failure..
Maximum length = 256
ic_reval<Double>
Total requests to this APP for cache bypass in given sampled timeframe..
total_bytes_cache_miss<Double>
Cache Miss total bytes accounted by this URL in sampled timeframe..
device_ip_address<String>
NetScaler IP Address..
Minimum length = 1
Maximum length = 64
ic_miss<Double>
Total requests to this APP for cache miss in given sampled timeframe..
ic_non_cache_hits<Double>
Total requests to this APP for cache bypass in given sampled timeframe..
network_latency_client_side<Double>
Network latency client side..
http_resp_status_name<String>
HTTP Response Status Method..
Maximum length = 30
Operations
NOTE: In request payload, Mandatory parameters are marked red and bold.
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
URL:https://<MGMT-IP>/nitro/v2/config/client
Query-parameters:
sla_enabled
Use this query-parameter to indicate sla is enabled or not.
Possible Values:0, 1
cr_enabled
Use this query-parameter to indicate cr is enabled or not.
Possible Values:0, 1
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
order_by
Use this query-parameter to get the result that is ordered by the given property.
Possible Values:total_requests, render_time, network_latency_client_side
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
asc
Use this query-parameter to specify whether the results should be in ascending order or not.
Possible Values:yes, no
type
Use this query-parameter to specify the type.
Possible Values:total_requests, render_time, network_latency_client_side
HTTPS Method:GET
HTTPS Request Headers:
Accept:application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response:
HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx
Response Headers:
Content-Type:application/json
Response Payload:JSON
{ "errorcode": 0, "message": "Done", "severity": <String_value>, "client":[{
"ssl_certificate_name":<String_value>,
"load_time":<Double_value>,
"total_bytes_cache_bypass":<Double_value>,
"ctnsappname_b":<String_value>,
"vpn_user_name":<String_value>,
"max_transaction_time":<Double_value>,
"cache_hits":<Double_value>,
"network_latency_client_side_max":<Double_value>,
"domain_name":<String_value>,
"uri_url":<String_value>,
"ip_address":<String_value>,
"ic_utilization":<Double_value>,
"ssl_protocol_name":<String_value>,
"total_bytes_cache_hits":<Double_value>,
"ssl_cipher_negotiated_cipher_name":<String_value>,
"http_media_type_name":<String_value>,
"total_requests":<Double_value>,
"ssl_cipher_failure_frontend":<String_value>,
"ic_hits":<Double_value>,
"cache_miss":<Double_value>,
"total_bytes_ic_reval":<Double_value>,
"total_bytes_ic_hits":<Double_value>,
"user_agent_name":<String_value>,
"id":<String_value>,
"mismatchCiphers":<String_value>,
"render_time":<Double_value>,
"http_req_method_name":<String_value>,
"ic_no_store_reason":<String_value>,
"ssl_key_strength_name":<String_value>,
"total_bytes_ic_miss":<Double_value>,
"ssl_cipher_name":<String_value>,
"total_bytes":<Double_value>,
"cache_bypass":<Double_value>,
"http_content_type_name":<String_value>,
"app_unit_name":<String_value>,
"server_ip_address":<String_value>,
"__count":<Double_value>,
"application_name":<String_value>,
"rpt_sample_time":<Double_value>,
"ssl_cipher_failure_backend":<String_value>,
"operating_system_name":<String_value>,
"percent_bw_saved":<Double_value>,
"unsupportedCiphers":<String_value>,
"ic_reval":<Double_value>,
"total_bytes_cache_miss":<Double_value>,
"device_ip_address":<String_value>,
"ic_miss":<Double_value>,
"ic_non_cache_hits":<Double_value>,
"network_latency_client_side":<Double_value>,
"http_resp_status_name":<String_value>}]}