64 lines
17 KiB
HTML
64 lines
17 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>server</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">server</p>
|
|
<P>Configuration for AF Server Report table resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">http_req_method_name<span class="property_type"><String></span></p><p class="property_description">HTTP Request Method..<br> Maximum length = 30</p>
|
|
<p class="property_name">ic_no_store_reason<span class="property_type"><String></span></p><p class="property_description">ic_no_store_reason..<br> Maximum length = 256</p>
|
|
<p class="property_name">total_bytes_ic_miss<span class="property_type"><Double></span></p><p class="property_description">Cache Miss total bytes accounted by this URL in sampled timeframe..</p>
|
|
<p class="property_name">total_bytes<span class="property_type"><Double></span></p><p class="property_description">Total bytes accounted by this URL in sampled timeframe..</p>
|
|
<p class="property_name">ssl_cipher_name<span class="property_type"><String></span></p><p class="property_description">SSL cipher name..<br> Maximum length = 256</p>
|
|
<p class="property_name">ssl_key_strength_name<span class="property_type"><String></span></p><p class="property_description">SSL key strength name..<br> Maximum length = 256</p>
|
|
<p class="property_name">cache_bypass<span class="property_type"><Double></span></p><p class="property_description">Total requests to this APP for cache bypass in given sampled timeframe..</p>
|
|
<p class="property_name">http_content_type_name<span class="property_type"><String></span></p><p class="property_description">HTTP Content TYPE Name..<br> Maximum length = 256</p>
|
|
<p class="property_name">app_unit_name<span class="property_type"><String></span></p><p class="property_description">Client App Name.<br> Maximum length = 255</p>
|
|
<p class="property_name">__count<span class="property_type"><Double></span></p><p class="property_description">count..</p>
|
|
<p class="property_name">server_response_time_max<span class="property_type"><Double></span></p><p class="property_description">Max value of Server response time..</p>
|
|
<p class="property_name">operating_system_name<span class="property_type"><String></span></p><p class="property_description">Client Operating System Name..<br> Maximum length = 30</p>
|
|
<p class="property_name">percent_bw_saved<span class="property_type"><Double></span></p><p class="property_description">Percentage of bw save to this APP in given sampled timeframe..</p>
|
|
<p class="property_name">rpt_sample_time<span class="property_type"><Double></span></p><p class="property_description">Report Sample time..</p>
|
|
<p class="property_name">application_name<span class="property_type"><String></span></p><p class="property_description">Application Name.<br> Maximum length = 255</p>
|
|
<p class="property_name">ic_reval<span class="property_type"><Double></span></p><p class="property_description">Total requests to this APP for cache bypass in given sampled timeframe..</p>
|
|
<p class="property_name">device_ip_address<span class="property_type"><String></span></p><p class="property_description">NetScaler IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">ic_miss<span class="property_type"><Double></span></p><p class="property_description">Total requests to this APP for cache miss in given sampled timeframe..</p>
|
|
<p class="property_name">ic_non_cache_hits<span class="property_type"><Double></span></p><p class="property_description">Total requests to this APP for cache bypass in given sampled timeframe..</p>
|
|
<p class="property_name">total_bytes_cache_miss<span class="property_type"><Double></span></p><p class="property_description">Cache Miss total bytes accounted by this URL in sampled timeframe..</p>
|
|
<p class="property_name">http_resp_status_name<span class="property_type"><String></span></p><p class="property_description">HTTP Response Status Method..<br> Maximum length = 30</p>
|
|
<p class="property_name">ssl_certificate_name<span class="property_type"><String></span></p><p class="property_description">SSL certificate name..<br> Maximum length = 256</p>
|
|
<p class="property_name">network_latency_server_side<span class="property_type"><Double></span></p><p class="property_description">Network latency server side..</p>
|
|
<p class="property_name">ctnsappname_b<span class="property_type"><String></span></p><p class="property_description">Backend LB vserver.<br> Maximum length = 255</p>
|
|
<p class="property_name">total_bytes_cache_bypass<span class="property_type"><Double></span></p><p class="property_description">Cache Bypass total bytes accounted by this URL in sampled timeframe..</p>
|
|
<p class="property_name">network_latency_server_side_max<span class="property_type"><Double></span></p><p class="property_description">Max value of Network latency server side..</p>
|
|
<p class="property_name">cache_hits<span class="property_type"><Double></span></p><p class="property_description">Total requests to this APP for cache hits in given sampled timeframe..</p>
|
|
<p class="property_name">max_transaction_time<span class="property_type"><Double></span></p><p class="property_description">Last Transaction Time for this URL in the sampled timeframe..</p>
|
|
<p class="property_name">vpn_user_name<span class="property_type"><String></span></p><p class="property_description">vpn user name..<br> Maximum length = 255</p>
|
|
<p class="property_name">domain_name<span class="property_type"><String></span></p><p class="property_description">Domain Name..<br> Maximum length = 2000</p>
|
|
<p class="property_name">ip_address<span class="property_type"><String></span></p><p class="property_description">Ip Address of this Server..<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">uri_url<span class="property_type"><String></span></p><p class="property_description">HTTP Request URL..<br> Maximum length = 2000</p>
|
|
<p class="property_name">ic_utilization<span class="property_type"><Double></span></p><p class="property_description">Total IC utilization in given sampled timeframe..</p>
|
|
<p class="property_name">server_type<span class="property_type"><String></span></p><p class="property_description">Server Type..<br> Maximum length = 2000</p>
|
|
<p class="property_name">client_ip_address<span class="property_type"><String></span></p><p class="property_description">Top Clients for this Server..<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">http_media_type_name<span class="property_type"><String></span></p><p class="property_description">HTTP MEDIA TYPE Name..<br> Maximum length = 30</p>
|
|
<p class="property_name">total_requests<span class="property_type"><Double></span></p><p class="property_description">Total Requests for this server in given sampled timeframe..</p>
|
|
<p class="property_name">ssl_protocol_name<span class="property_type"><String></span></p><p class="property_description">SSL protocol name..<br> Maximum length = 256</p>
|
|
<p class="property_name">total_bytes_cache_hits<span class="property_type"><Double></span></p><p class="property_description">Cache Hits total bytes accounted by this URL in sampled timeframe..</p>
|
|
<p class="property_name">ssl_cipher_negotiated_cipher_name<span class="property_type"><String></span></p><p class="property_description">SSL cipher name..<br> Maximum length = 256</p>
|
|
<p class="property_name">total_bytes_ic_reval<span class="property_type"><Double></span></p><p class="property_description">Cache Reval total bytes accounted by this URL in sampled timeframe..</p>
|
|
<p class="property_name">total_bytes_ic_hits<span class="property_type"><Double></span></p><p class="property_description">IC Cache Hits total bytes accounted by this URL in sampled timeframe..</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Id is Server IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">user_agent_name<span class="property_type"><String></span></p><p class="property_description">User Agent Name..<br> Maximum length = 30</p>
|
|
<p class="property_name">ic_hits<span class="property_type"><Double></span></p><p class="property_description">Total requests to this APP for cache hits in given sampled timeframe..</p>
|
|
<p class="property_name">cache_miss<span class="property_type"><Double></span></p><p class="property_description">Total requests to this APP for cache miss in given sampled timeframe..</p>
|
|
<p class="property_name">server_response_time<span class="property_type"><Double></span></p><p class="property_description">Server response time..</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/server</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>report_end_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the end time until where summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>cr_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate cr is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>sla_enabled</b></p><p class="key"><span class="value">Use this query-parameter to indicate sla is enabled or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">0, 1</span></span></p><p class="key"><b>order_by</b></p><p class="key"><span class="value">Use this query-parameter to get the result that is ordered by the given property.</span></p><p class="key"><span class="value">Possible Values:<span class="value">total_requests, total_bytes, server_response_time, network_latency_server_side</span></span></p><p class="key"><b>report_start_time</b></p><p class="key"><span class="value">Use this query-parameter to specify the start time from which the summary for report is considered.</span></p><p class="key"><span class="value">Possible Values:<span class="value">time in milli seconds</span></span></p><p class="key"><b>type</b></p><p class="key"><span class="value">Use this query-parameter to specify the type.</span></p><p class="key"><span class="value">Possible Values:<span class="value">total_requests, total_bytes, server_response_time, network_latency_server_side</span></span></p><p class="key"><b>asc</b></p><p class="key"><span class="value">Use this query-parameter to specify whether the results should be in ascending order or not.</span></p><p class="key"><span class="value">Possible Values:<span class="value">yes, no</span></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "server":[{<br> "http_req_method_name":<String_value></font>,<br> "ic_no_store_reason":<String_value></font>,<br> "total_bytes_ic_miss":<Double_value></font>,<br> "total_bytes":<Double_value></font>,<br> "ssl_cipher_name":<String_value></font>,<br> "ssl_key_strength_name":<String_value></font>,<br> "cache_bypass":<Double_value></font>,<br> "http_content_type_name":<String_value></font>,<br> "app_unit_name":<String_value></font>,<br> "__count":<Double_value></font>,<br> "server_response_time_max":<Double_value></font>,<br> "operating_system_name":<String_value></font>,<br> "percent_bw_saved":<Double_value></font>,<br> "rpt_sample_time":<Double_value></font>,<br> "application_name":<String_value></font>,<br> "ic_reval":<Double_value></font>,<br> "device_ip_address":<String_value></font>,<br> "ic_miss":<Double_value></font>,<br> "ic_non_cache_hits":<Double_value></font>,<br> "total_bytes_cache_miss":<Double_value></font>,<br> "http_resp_status_name":<String_value></font>,<br> "ssl_certificate_name":<String_value></font>,<br> "network_latency_server_side":<Double_value></font>,<br> "ctnsappname_b":<String_value></font>,<br> "total_bytes_cache_bypass":<Double_value></font>,<br> "network_latency_server_side_max":<Double_value></font>,<br> "cache_hits":<Double_value></font>,<br> "max_transaction_time":<Double_value></font>,<br> "vpn_user_name":<String_value></font>,<br> "domain_name":<String_value></font>,<br> "ip_address":<String_value></font>,<br> "uri_url":<String_value></font>,<br> "ic_utilization":<Double_value></font>,<br> "server_type":<String_value></font>,<br> "client_ip_address":<String_value></font>,<br> "http_media_type_name":<String_value></font>,<br> "total_requests":<Double_value></font>,<br> "ssl_protocol_name":<String_value></font>,<br> "total_bytes_cache_hits":<Double_value></font>,<br> "ssl_cipher_negotiated_cipher_name":<String_value></font>,<br> "total_bytes_ic_reval":<Double_value></font>,<br> "total_bytes_ic_hits":<Double_value></font>,<br> "id":<String_value></font>,<br> "user_agent_name":<String_value></font>,<br> "ic_hits":<Double_value></font>,<br> "cache_miss":<Double_value></font>,<br> "server_response_time":<Double_value></font>}]}</p>
|
|
</body>
|
|
</html>
|