server

Configuration for AF Server Report table resource.

Read/write properties

http_req_method_name<String>

HTTP Request Method..
Maximum length = 30

ic_no_store_reason<String>

ic_no_store_reason..
Maximum length = 256

total_bytes_ic_miss<Double>

Cache Miss total bytes accounted by this URL in sampled timeframe..

total_bytes<Double>

Total bytes accounted by this URL in sampled timeframe..

ssl_cipher_name<String>

SSL cipher name..
Maximum length = 256

ssl_key_strength_name<String>

SSL key strength name..
Maximum length = 256

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>

Client App Name.
Maximum length = 255

__count<Double>

count..

server_response_time_max<Double>

Max value of Server response time..

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..

rpt_sample_time<Double>

Report Sample time..

application_name<String>

Application Name.
Maximum length = 255

ic_reval<Double>

Total requests to this APP for cache bypass in given 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..

total_bytes_cache_miss<Double>

Cache Miss total bytes accounted by this URL in sampled timeframe..

http_resp_status_name<String>

HTTP Response Status Method..
Maximum length = 30

ssl_certificate_name<String>

SSL certificate name..
Maximum length = 256

network_latency_server_side<Double>

Network latency server side..

ctnsappname_b<String>

Backend LB vserver.
Maximum length = 255

total_bytes_cache_bypass<Double>

Cache Bypass total bytes accounted by this URL in sampled timeframe..

network_latency_server_side_max<Double>

Max value of Network latency server side..

cache_hits<Double>

Total requests to this APP for cache hits in given sampled timeframe..

max_transaction_time<Double>

Last Transaction Time for this URL in the sampled timeframe..

vpn_user_name<String>

vpn user name..
Maximum length = 255

domain_name<String>

Domain Name..
Maximum length = 2000

ip_address<String>

Ip Address of this Server..
Minimum length = 1
Maximum length = 64

uri_url<String>

HTTP Request URL..
Maximum length = 2000

ic_utilization<Double>

Total IC utilization in given sampled timeframe..

server_type<String>

Server Type..
Maximum length = 2000

client_ip_address<String>

Top Clients for this Server..
Minimum length = 1
Maximum length = 64

http_media_type_name<String>

HTTP MEDIA TYPE Name..
Maximum length = 30

total_requests<Double>

Total Requests for this server 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

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..

id<String>

Id is Server IP Address..
Minimum length = 1
Maximum length = 64

user_agent_name<String>

User Agent Name..
Maximum length = 30

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..

server_response_time<Double>

Server response time..

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

get (all)

get (all)

URL:https://<MGMT-IP>/nitro/v2/config/server

Query-parameters:

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

cr_enabled

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

Possible Values:0, 1

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, server_response_time, network_latency_server_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

type

Use this query-parameter to specify the type.

Possible Values:total_requests, total_bytes, server_response_time, network_latency_server_side

asc

Use this query-parameter to specify whether the results should be in ascending order or not.

Possible Values:yes, no

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 (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:JSON

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "server":[{
      "http_req_method_name":<String_value>,
      "ic_no_store_reason":<String_value>,
      "total_bytes_ic_miss":<Double_value>,
      "total_bytes":<Double_value>,
      "ssl_cipher_name":<String_value>,
      "ssl_key_strength_name":<String_value>,
      "cache_bypass":<Double_value>,
      "http_content_type_name":<String_value>,
      "app_unit_name":<String_value>,
      "__count":<Double_value>,
      "server_response_time_max":<Double_value>,
      "operating_system_name":<String_value>,
      "percent_bw_saved":<Double_value>,
      "rpt_sample_time":<Double_value>,
      "application_name":<String_value>,
      "ic_reval":<Double_value>,
      "device_ip_address":<String_value>,
      "ic_miss":<Double_value>,
      "ic_non_cache_hits":<Double_value>,
      "total_bytes_cache_miss":<Double_value>,
      "http_resp_status_name":<String_value>,
      "ssl_certificate_name":<String_value>,
      "network_latency_server_side":<Double_value>,
      "ctnsappname_b":<String_value>,
      "total_bytes_cache_bypass":<Double_value>,
      "network_latency_server_side_max":<Double_value>,
      "cache_hits":<Double_value>,
      "max_transaction_time":<Double_value>,
      "vpn_user_name":<String_value>,
      "domain_name":<String_value>,
      "ip_address":<String_value>,
      "uri_url":<String_value>,
      "ic_utilization":<Double_value>,
      "server_type":<String_value>,
      "client_ip_address":<String_value>,
      "http_media_type_name":<String_value>,
      "total_requests":<Double_value>,
      "ssl_protocol_name":<String_value>,
      "total_bytes_cache_hits":<Double_value>,
      "ssl_cipher_negotiated_cipher_name":<String_value>,
      "total_bytes_ic_reval":<Double_value>,
      "total_bytes_ic_hits":<Double_value>,
      "id":<String_value>,
      "user_agent_name":<String_value>,
      "ic_hits":<Double_value>,
      "cache_miss":<Double_value>,
      "server_response_time":<Double_value>}]}