mmolloy/nscertkeycreate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial

Browse Source
This commit is contained in:
deamonkai
2026-01-23 12:11:21 -06:00
commit fc94008530
16494 changed files with 2974672 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/aa_ind_details_l2.html Normal file
View File

@@ -0,0 +1,34 @@
<!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>aa_ind_details_l2</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">aa_ind_details_l2</p>
<P>Configuration for Indicator Alert Details resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">violation_ratio<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">violation_ratio.</p>
<p class="property_name">violation_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">violation_count.</p>
<p class="property_name">confidence<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">confidence.</p>
<p class="property_name">window_end_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Window End time..</p>
<p class="property_name">appname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ApplicationName.<br> Maximum length = 255</p>
<p class="property_name">ind_value<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Indicator Value.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">ind_detection_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">ind_detection_msg<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Indicator Detection Message.<br> Maximum length = 512</p>
<p class="property_name">severity<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Severity of the alert [ CRITICAL/MEDIUM/LOW ].</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address.<br> Maximum length = 512</p>
<p class="property_name">ind_id<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Indicator Rule Id.</p>
<p class="property_name">window_start_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Window start time..</p>
<p class="property_name">ctnsappname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">AppName.<br> Maximum length = 255</p>
<p class="property_name">svcname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">svcname.<br> Maximum length = 255</p>
<p class="property_name">ind_weight_desc<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Indicator weight description.</p>
<p class="property_name">ind_category_desc<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Indicator category description.</p>
<p class="property_name">ind_name_desc<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Indicator name description.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/aa_ind_details_l2</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/aa_ind_details_l2<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of aa_ind_details_l2 resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/aa_ind_details_l2<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the aa_ind_details_l2 resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/aa_ind_details_l2<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of aa_ind_details_l2 resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "aa_ind_details_l2":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"violation_ratio":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"violation_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"confidence":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"window_end_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_value":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_detection_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_detection_msg":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"severity":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_id":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"window_start_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ctnsappname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"svcname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_weight_desc":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_category_desc":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ind_name_desc":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

38
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/adc_application_summary.html Normal file
View File

@@ -0,0 +1,38 @@
<!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>adc_application_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">adc_application_summary</p>
<P>Configuration for application summarized information resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">issues_detected<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Array of all app issues affecting health score. Each array element tells issueId, penalty and time when it occured.<br> Maximum length = 2048</p>
<p class="property_name">pkt_sent_cur<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Pkts Sent.</p>
<p class="property_name">response_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">total time taken by the app to send response to client.</p>
<p class="property_name">curr_state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Current State.<br> Maximum length = 50</p>
<p class="property_name">total_requests<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Requests.</p>
<p class="property_name">clnt_connections<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Current Client Connections.</p>
<p class="property_name">ssl_rating<span class="property_type">&lt;String&gt;</span></p><p class="property_description">A+ / non-A+ / NA.<br> Maximum length = 50</p>
<p class="property_name">pkt_recvd_cur<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Pkts Received.</p>
<p class="property_name">vslbhealth<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Vserver Health.</p>
<p class="property_name">tags<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Tags associated with apps.</p>
<p class="property_name">throughput<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Throughput ..</p>
<p class="property_name">vservername<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Vserver Name.<br> Maximum length = 255</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Field to store the ip address as it is along with any extension.<br> Maximum length = 512</p>
<p class="property_name">appcategory<span class="property_type">&lt;String&gt;</span></p><p class="property_description">App Category.<br> Maximum length = 255</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Session total bytes.</p>
<p class="property_name">error_percentage<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of 5xx response received wrt total requests.</p>
<p class="property_name">appname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">AppName.<br> Maximum length = 255</p>
<p class="property_name">health_score<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">App Health Score.</p>
<p class="property_name">srvr_connections<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Current Server Connections.</p>
<p class="property_name">vservertype<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Vserver Tyoe.<br> Maximum length = 255</p>
<p class="heading">Read only properties</p>
<p class="property_name">application_class<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application class.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/adc_application_summary</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/adc_application_summary<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of adc_application_summary resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/adc_application_summary<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the adc_application_summary resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/adc_application_summary<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of adc_application_summary resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "adc_application_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"issues_detected":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pkt_sent_cur":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"response_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"curr_state":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_requests":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clnt_connections":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ssl_rating":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pkt_recvd_cur":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vslbhealth":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tags":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"throughput":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vservername":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"application_class":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appcategory":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"error_percentage":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"health_score":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"srvr_connections":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vservertype":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

22
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/adc_waf_bot_profile_config.html Normal file
View File

File diff suppressed because one or more lines are too long

33
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/anomaly_details.html Normal file
View File

@@ -0,0 +1,33 @@
<!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>anomaly_details</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">anomaly_details</p>
<P>Configuration for AF Transaction Report table resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">serv_tot_hits<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Last Transaction Time for this URL in the sampled timeframe..</p>
<p class="property_name">hits_rate<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Hits Rate.</p>
<p class="property_name">max_avg_ttfb<span class="property_type">&lt;Double&gt;</span></p><p class="property_description"> max_avg_ttfb time..</p>
<p class="property_name">avg_ttfb<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Render time..</p>
<p class="property_name">max_hits<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Count of this URL in given sampled timeframe..</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address.<br> Maximum length = 512</p>
<p class="property_name">server_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Server Source IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">ctnsappname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">AppName.<br> Maximum length = 255</p>
<p class="property_name">metric_key<span class="property_type">&lt;String&gt;</span></p><p class="property_description">metric_key..<br> Maximum length = 30</p>
<p class="property_name">state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">State up/down.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">hits_total<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes accounted by this URL in sampled timeframe..</p>
<p class="property_name">reason<span class="property_type">&lt;String&gt;</span></p><p class="property_description">HTTP Request URL..<br> Maximum length = 100</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">usecase<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Use Case..<br> Maximum length = 100</p>
<p class="property_name">svcname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">AppName.<br> Maximum length = 255</p>
<p class="property_name">metric_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">HTTP Request Method..<br> Maximum length = 30</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/anomaly_details</span></p><p class="key">Query-parameters:<span class="url_value"></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"><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, load_time, render_time</span></span></p><p class="key"><b>ns_vsvrs</b></p><p class="key"><span class="value">Use this query-parameter to provide the infomation of netscaler and virutal server combination.</span></p><p class="key"><span class="value">Possible Values:<span class="value">((ns_ip1, vsvrname1)|(ns_ip2, vsvrname2)|(ns_ip3, vsvrname3)</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>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, load_time, render_time</span></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">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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "anomaly_details":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"serv_tot_hits":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hits_rate":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"max_avg_ttfb":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"avg_ttfb":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"max_hits":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"server_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ctnsappname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"metric_key":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"state":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hits_total":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"reason":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"usecase":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"svcname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"metric_name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

23
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/anomaly_events.html Normal file
View File

@@ -0,0 +1,23 @@
<!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>anomaly_events</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">anomaly_events</p>
<P>Configuration for AF Transaction Report table resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address.<br> Maximum length = 512</p>
<p class="property_name">svcname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">svcname.<br> Maximum length = 255</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of records.</p>
<p class="property_name">event_value<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Event Value.</p>
<p class="property_name">ctnsappname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">AppName.<br> Maximum length = 255</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">event_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Event Type..<br> Maximum length = 255</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/anomaly_events</span></p><p class="key">Query-parameters:<span class="url_value"></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>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"><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, load_time, render_time</span></span></p><p class="key"><b>ns_vsvrs</b></p><p class="key"><span class="value">Use this query-parameter to provide the infomation of netscaler and virutal server combination.</span></p><p class="key"><span class="value">Possible Values:<span class="value">((ns_ip1, vsvrname1)|(ns_ip2, vsvrname2)|(ns_ip3, vsvrname3)</span></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>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, load_time, render_time</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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "anomaly_events":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"svcname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"event_value":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ctnsappname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"event_type":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

20
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/anomaly_summary.html Normal file
View File

@@ -0,0 +1,20 @@
<!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>anomaly_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">anomaly_summary</p>
<P>Configuration for AF Transaction Report table resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">metric_key<span class="property_type">&lt;String&gt;</span></p><p class="property_description">HTTP Request Host..<br> Maximum length = 255</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">metric_value<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Metric Value..</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/anomaly_summary</span></p><p class="key">Query-parameters:<span class="url_value"></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"><b>ns_vsvrs</b></p><p class="key"><span class="value">Use this query-parameter to provide the infomation of netscaler and virutal server combination.</span></p><p class="key"><span class="value">Possible Values:<span class="value">((ns_ip1, vsvrname1)|(ns_ip2, vsvrname2)|(ns_ip3, vsvrname3)</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, load_time, render_time</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>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, load_time, render_time</span></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">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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "anomaly_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"metric_key":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"metric_value":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

21
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/app_category.html Normal file
View File

File diff suppressed because one or more lines are too long

21
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/app_device.html Normal file
View File

@@ -0,0 +1,21 @@
<!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>app_device</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">app_device</p>
<P>Configuration for Details of the device used by managed app resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">device_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Instance ID for the device.</p>
<p class="property_name">parent_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Instance ID for the parent.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is system generated key for all the app-device mapping.</p>
<p class="property_name">device_mgmt_ip<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IPv4 or IPv6 Address assigned to the device.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">parent_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Nmae of the parent device.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/app_filter.html Normal file
View File

File diff suppressed because one or more lines are too long

25
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/app_info.html Normal file
View File

File diff suppressed because one or more lines are too long

35
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/app_service_graph_node_edges.html Normal file
View File

@@ -0,0 +1,35 @@
<!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>app_service_graph_node_edges</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">app_service_graph_node_edges</p>
<P>Configuration for API used to report the global service graph for per app. resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">destination<span class="property_type">&lt;String&gt;</span></p><p class="property_description">CS VServer Name.</p>
<p class="property_name">source_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">LB VServer Name.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NS IP Address.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is system generated key.</p>
<p class="property_name">tot_svr_ttfb_transactions<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of Transactions.</p>
<p class="property_name">tot_svr_busy_err<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Server Errors.</p>
<p class="property_name">source<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Source Node.</p>
<p class="property_name">type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Vserver Type.</p>
<p class="property_name">svcname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Service Name.</p>
<p class="property_name">tot_svr_ttfb<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Service Resp Rate.</p>
<p class="property_name">response_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Response Time.</p>
<p class="property_name">ctnsappname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Vserver Name.</p>
<p class="property_name">vservername<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Vserver Name.</p>
<p class="property_name">tot_requests<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Requests.</p>
<p class="property_name">tot_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Bytes(Data Volume).</p>
<p class="property_name">destination_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Service Name.</p>
<p class="property_name">tot_reqbytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Request Bytes.</p>
<p class="property_name">appname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">App name.</p>
<p class="property_name">tot_respbytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Response Bytes.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/app_service_graph_node_edges</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/app_service_graph_node_edges<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of app_service_graph_node_edges resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/app_service_graph_node_edges<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the app_service_graph_node_edges resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/app_service_graph_node_edges<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of app_service_graph_node_edges resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "app_service_graph_node_edges":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"destination":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"source_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tot_svr_ttfb_transactions":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tot_svr_busy_err":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"source":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"svcname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tot_svr_ttfb":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"response_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ctnsappname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vservername":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tot_requests":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tot_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"destination_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tot_reqbytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tot_respbytes":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

49
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/app_summary.html Normal file
View File

@@ -0,0 +1,49 @@
<!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>app_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">app_summary</p>
<P>Configuration for APP Report table resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">state_code<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Up:1, Down:2, OutOfService:3.</p>
<p class="property_name">application_class<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application class.<br> Maximum length = 255</p>
<p class="property_name">total_requests<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Requests.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">issues_detected<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Array of all app issues affecting health score. Each array element tells issueId, penalty and time when it occured.<br> Maximum length = 2048</p>
<p class="property_name">clnt_connections<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Current Client Connections.</p>
<p class="property_name">pkt_sent<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Pkts Sent.</p>
<p class="property_name">appcategory<span class="property_type">&lt;String&gt;</span></p><p class="property_description">App Category.<br> Maximum length = 255</p>
<p class="property_name">exporter_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Exporter ID.<br> Maximum length = 255</p>
<p class="property_name">throughput_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Throughput ..</p>
<p class="property_name">clnt_connections_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Current Client Connections.</p>
<p class="property_name">app_ssl_rating<span class="property_type">&lt;String&gt;</span></p><p class="property_description">SSL Rating.<br> Maximum length = 50</p>
<p class="property_name">appname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">AppName.<br> Maximum length = 255</p>
<p class="property_name">health_score<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">App Health Score.</p>
<p class="property_name">health_score_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">App Health Score.</p>
<p class="property_name">throughput<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Throughput ..</p>
<p class="property_name">pkt_recvd<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Pkts Received.</p>
<p class="property_name">srvr_connections<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Current Server Connections.</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Session total bytes.</p>
<p class="property_name">vsvr_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Vserver IP Address.</p>
<p class="property_name">vservername<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Vserver Name.<br> Maximum length = 255</p>
<p class="property_name">response_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">total time taken by the app to send response to client.</p>
<p class="property_name">total_bytes_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Session total bytes.</p>
<p class="property_name">vslbhealth<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Vserver Health.</p>
<p class="property_name">total_requests_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Requests.</p>
<p class="property_name">curr_state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Current State.<br> Maximum length = 50</p>
<p class="property_name">error_percentage<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of 5xx response received wrt total requests.</p>
<p class="property_name">response_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Session response bytes.</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">hostname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler Hostname.</p>
<p class="property_name">srvr_connections_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Current Server Connections.</p>
<p class="property_name">request_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Session request bytes.</p>
<p class="property_name">app_family<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application Family.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/app_summary</span></p><p class="key">Query-parameters:<span class="url_value"></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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "app_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"state_code":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"application_class":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_requests":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"issues_detected":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clnt_connections":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pkt_sent":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appcategory":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"exporter_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"throughput_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clnt_connections_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"app_ssl_rating":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"health_score":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"health_score_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"throughput":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pkt_recvd":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"srvr_connections":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vsvr_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vservername":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"response_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vslbhealth":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_requests_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"curr_state":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"error_percentage":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"response_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hostname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"srvr_connections_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"request_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"app_family":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

24
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/app_template_info.html Normal file
View File

@@ -0,0 +1,24 @@
<!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>app_template_info</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">app_template_info</p>
<P>Configuration for App Template Info resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">downloads<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Number of downloads for the template.</p>
<p class="property_name">comments<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">Comments for the template.</p>
<p class="property_name">desc<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Description for the template.</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Template Name.</p>
<p class="property_name">rating<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Rating for the template.</p>
<p class="property_name">download_link<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Download link for the template.</p>
<p class="property_name">version<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Version Supported.</p>
<p class="property_name">updated_on<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Updated date of the template.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/app_template_info</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/app_template_info<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of app_template_info resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/app_template_info<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the app_template_info resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/app_template_info<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of app_template_info resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "app_template_info":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"downloads":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"comments":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"desc":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rating":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"download_link":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"version":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"updated_on":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

40
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_app_summary.html Normal file
View File

@@ -0,0 +1,40 @@
<!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>appdashboard_app_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_app_summary</p>
<P>Configuration for Provides the app dashboard full summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Session total bytes.</p>
<p class="property_name">appcategory<span class="property_type">&lt;String&gt;</span></p><p class="property_description">App Category.<br> Maximum length = 255</p>
<p class="property_name">health_score_str<span class="property_type">&lt;String&gt;</span></p><p class="property_description">App Health Score.</p>
<p class="property_name">error_percentage<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of 5xx response received wrt total requests.</p>
<p class="property_name">appname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">AppName.<br> Maximum length = 255</p>
<p class="property_name">srvr_connections<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Current Server Connections.</p>
<p class="property_name">response_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">total time taken by the app to send response to client.</p>
<p class="property_name">clnt_connections<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Current Client Connections.</p>
<p class="property_name">total_requests<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Requests.</p>
<p class="property_name">curr_state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Current State.<br> Maximum length = 50</p>
<p class="property_name">throughput<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Throughput ..</p>
<p class="property_name">apps_affected<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">All parent application names separated by comma that are affected by this referenced application.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Field to store the ip address as it is along with any extension.<br> Maximum length = 512</p>
<p class="property_name">vsvr_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Vserver IP address.</p>
<p class="property_name">health_score<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">App Health Score.</p>
<p class="property_name">pkt_sent_cur<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Pkts Sent.</p>
<p class="property_name">issues_detected<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Array of all app issues affecting health score. Each array element tells issueId, penalty and time when it occured.</p>
<p class="property_name">hostname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler Hostname.</p>
<p class="property_name">ssl_rating<span class="property_type">&lt;String&gt;</span></p><p class="property_description">A+ / non-A+ / NA.<br> Maximum length = 50</p>
<p class="property_name">vslbhealth<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Vserver Health.</p>
<p class="property_name">pkt_recvd_cur<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Pkts Received.</p>
<p class="property_name">tags<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Tags associated with apps.</p>
<p class="heading">Read only properties</p>
<p class="property_name">application_class<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application class.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/appdashboard_app_summary</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/appdashboard_app_summary<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of appdashboard_app_summary resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/appdashboard_app_summary<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the appdashboard_app_summary resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/appdashboard_app_summary<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of appdashboard_app_summary resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "appdashboard_app_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"application_class":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appcategory":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"health_score_str":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"error_percentage":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"srvr_connections":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"response_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clnt_connections":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_requests":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"curr_state":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"throughput":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"apps_affected":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vsvr_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"health_score":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pkt_sent_cur":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"issues_detected":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hostname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ssl_rating":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vslbhealth":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pkt_recvd_cur":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tags":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_appcategory_summary.html Normal file
View File

@@ -0,0 +1,18 @@
<!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>appdashboard_appcategory_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_appcategory_summary</p>
<P>Configuration for Provides the app state filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">filter_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of applications with current filter value.</p>
<p class="property_name">filter_key<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Filter key.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_appscore_summary.html Normal file
View File

@@ -0,0 +1,18 @@
<!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>appdashboard_appscore_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_appscore_summary</p>
<P>Configuration for Provides the app state filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">filter_key<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Filter key.</p>
<p class="property_name">filter_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of applications with current filter value.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_apptype_summary.html Normal file
View File

@@ -0,0 +1,18 @@
<!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>appdashboard_apptype_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_apptype_summary</p>
<P>Configuration for Provides the app state filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">filter_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of applications with current filter value.</p>
<p class="property_name">filter_key<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Filter key.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_client_connection_summary.html Normal file
View File

@@ -0,0 +1,19 @@
<!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>appdashboard_client_connection_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_client_connection_summary</p>
<P>Configuration for Provides the client connection filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">bin_start<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range start.</p>
<p class="property_name">bin_end<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range end.</p>
<p class="property_name">count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Count of items falling in this bucket.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_issue_summary.html Normal file
View File

@@ -0,0 +1,18 @@
<!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>appdashboard_issue_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_issue_summary</p>
<P>Configuration for Provides the app state filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">filter_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of applications with current filter value.</p>
<p class="property_name">filter_key<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Filter key.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_lb_health_summary.html Normal file
View File

@@ -0,0 +1,19 @@
<!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>appdashboard_lb_health_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_lb_health_summary</p>
<P>Configuration for Provides the lb vserver health filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">bin_end<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range end.</p>
<p class="property_name">count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Count of items falling in this bucket.</p>
<p class="property_name">bin_start<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range start.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_packet_rcv_summary.html Normal file
View File

@@ -0,0 +1,19 @@
<!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>appdashboard_packet_rcv_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_packet_rcv_summary</p>
<P>Configuration for Provides the packets received filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">bin_end<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range end.</p>
<p class="property_name">count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Count of items falling in this bucket.</p>
<p class="property_name">bin_start<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range start.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_packet_sent_summary.html Normal file
View File

@@ -0,0 +1,19 @@
<!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>appdashboard_packet_sent_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_packet_sent_summary</p>
<P>Configuration for Provides the packet sent filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">bin_start<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range start.</p>
<p class="property_name">bin_end<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range end.</p>
<p class="property_name">count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Count of items falling in this bucket.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_responsetime_summary.html Normal file
View File

@@ -0,0 +1,19 @@
<!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>appdashboard_responsetime_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_responsetime_summary</p>
<P>Configuration for Provides the response time filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">bin_start<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range start.</p>
<p class="property_name">bin_end<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range end.</p>
<p class="property_name">count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Count of items falling in this bucket.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_server_connection_summary.html Normal file
View File

@@ -0,0 +1,19 @@
<!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>appdashboard_server_connection_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_server_connection_summary</p>
<P>Configuration for Provides the server connection filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">bin_start<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range start.</p>
<p class="property_name">bin_end<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range end.</p>
<p class="property_name">count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Count of items falling in this bucket.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_sslrating_summary.html Normal file
View File

@@ -0,0 +1,18 @@
<!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>appdashboard_sslrating_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_sslrating_summary</p>
<P>Configuration for Provides the app state filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">filter_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of applications with current filter value.</p>
<p class="property_name">filter_key<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Filter key.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_state_summary.html Normal file
View File

@@ -0,0 +1,18 @@
<!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>appdashboard_state_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_state_summary</p>
<P>Configuration for Provides the app state filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">filter_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of applications with current filter value.</p>
<p class="property_name">filter_key<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Filter key.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_throughput_summary.html Normal file
View File

@@ -0,0 +1,19 @@
<!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>appdashboard_throughput_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_throughput_summary</p>
<P>Configuration for Provides the throughput filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">bin_start<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range start.</p>
<p class="property_name">bin_end<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range end.</p>
<p class="property_name">count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Count of items falling in this bucket.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_total_request_summary.html Normal file
View File

@@ -0,0 +1,19 @@
<!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>appdashboard_total_request_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_total_request_summary</p>
<P>Configuration for Provides the total request filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">bin_start<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range start.</p>
<p class="property_name">bin_end<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range end.</p>
<p class="property_name">count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Count of items falling in this bucket.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appdashboard_volume_summary.html Normal file
View File

@@ -0,0 +1,19 @@
<!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>appdashboard_volume_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">appdashboard_volume_summary</p>
<P>Configuration for Provides the response time filter summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">bin_start<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range start.</p>
<p class="property_name">bin_end<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bin range end.</p>
<p class="property_name">count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Count of items falling in this bucket.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

58
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/application.html Normal file
View File

File diff suppressed because one or more lines are too long

21
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appscore_factor.html Normal file
View File

File diff suppressed because one or more lines are too long

34
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/appscore_threshold_config.html Normal file
View File

File diff suppressed because one or more lines are too long

21
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/authorized_application.html Normal file
View File

@@ -0,0 +1,21 @@
<!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>authorized_application</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">authorized_application</p>
<P>Configuration for Authorized applications for each user resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">application_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application Name.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is system generated key..</p>
<p class="heading">Read only properties</p>
<p class="property_name">authorized_scope_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">authorized_scope ID.</p>
<p class="property_name">application_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ID of the application.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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>
</body>
</html>

35
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/global_service_graph_config_mapping.html Normal file
View File

@@ -0,0 +1,35 @@
<!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>global_service_graph_config_mapping</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">global_service_graph_config_mapping</p>
<P>Configuration for Config Data for Global Service Graph resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">gslb_adc_display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">GSLB Device IP Address.</p>
<p class="property_name">ns_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device IP Address.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">k8s_labels<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Labels in Kubernetes.</p>
<p class="property_name">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device IP Address.</p>
<p class="property_name">k8s_pod_state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Pod State in Kubernetes.</p>
<p class="property_name">k8s_service_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Service Name in Kubernetes.<br> Maximum length = 255</p>
<p class="property_name">k8s_pod_ip<span class="property_type">&lt;String&gt;</span></p><p class="property_description">POD Ip.</p>
<p class="property_name">k8s_pod_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Pod Name in Kubernetes.</p>
<p class="property_name">svc_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Service Name.</p>
<p class="property_name">gslb_adc_ip<span class="property_type">&lt;String&gt;</span></p><p class="property_description">GSLB NetScaler IP.</p>
<p class="property_name">gslbvserver_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">GSLB VServer Name.</p>
<p class="property_name">csvserver_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">CS VServer Name.</p>
<p class="property_name">k8s_namespace<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Namespace of service in Kubernetes.<br> Maximum length = 255</p>
<p class="property_name">k8s_cluster_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Kubernetes cluster name.<br> Maximum length = 255</p>
<p class="property_name">rec_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Record Identifier.</p>
<p class="property_name">servername<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Server Name.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is system generated key.</p>
<p class="property_name">lbvserver_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">LB VServer Name.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/global_service_graph_config_mapping</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/global_service_graph_config_mapping<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of global_service_graph_config_mapping resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/global_service_graph_config_mapping<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the global_service_graph_config_mapping resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/global_service_graph_config_mapping<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of global_service_graph_config_mapping resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "global_service_graph_config_mapping":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gslb_adc_display_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"k8s_labels":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"k8s_pod_state":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"k8s_service_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"k8s_pod_ip":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"k8s_pod_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"svc_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gslb_adc_ip":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gslbvserver_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"csvserver_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"k8s_namespace":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"k8s_cluster_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rec_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"servername":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"lbvserver_name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

21
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/global_service_graph_node_edges.html Normal file
View File

@@ -0,0 +1,21 @@
<!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>global_service_graph_node_edges</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">global_service_graph_node_edges</p>
<P>Configuration for API used to report the global service graph for multi apps. resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">destination<span class="property_type">&lt;String&gt;</span></p><p class="property_description">CS VServer Name.</p>
<p class="property_name">source<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Source Node.</p>
<p class="property_name">source_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">LB VServer Name.</p>
<p class="property_name">destination_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Service Name.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is system generated key.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/global_service_graph_node_edges</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/global_service_graph_node_edges<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of global_service_graph_node_edges resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/global_service_graph_node_edges<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the global_service_graph_node_edges resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://&lt;MGMT-IP&gt;/nitro/v2/config/global_service_graph_node_edges<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of global_service_graph_node_edges resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "global_service_graph_node_edges":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"destination":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"source":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"source_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"destination_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

19
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/job_trigger.html Normal file
View File

@@ -0,0 +1,19 @@
<!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>job_trigger</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">job_trigger</p>
<P>Configuration for API used to trigger AppServer Job given Job Scheduler name resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">job_schedule_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Job Schedule Name.</p>
<p class="property_name">next_scheduletime<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Next Schedule Time.</p>
<p class="property_name">job_status<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Job Status.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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="#post" class="operation">post</a><p class="heading"><a name="post">post</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/job_trigger?action=post&onerror=&lt;String_value&gt;</span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"job_trigger": {<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"job_status":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"job_schedule_name":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"next_scheduletime":&lt;Double_value&gt;</font>}}</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 Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": &ltString_value&gt, "job_trigger":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"job_schedule_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"next_scheduletime":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"job_status":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

23
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/lean_data.html Normal file
View File

@@ -0,0 +1,23 @@
<!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>lean_data</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">lean_data</p>
<P>Configuration for API to provide the report for lean data. resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">appname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Application Name.<br> Maximum length = 255</p>
<p class="property_name">ctnsappname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Vserver name.<br> Maximum length = 255</p>
<p class="property_name">throughput<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Throughput.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Netscaler IP Address..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes consumed..</p>
<p class="property_name">total_requests<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total requests..</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/lean_data</span></p><p class="key">Query-parameters:<span class="url_value"></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"><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_bytes, throughput, app_launch_count</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 seconds</span></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 seconds</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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "lean_data":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ctnsappname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"throughput":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_requests":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

51
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/security_app_dashboard_details.html Normal file
View File

File diff suppressed because one or more lines are too long

36
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/swg_domain_summary.html Normal file
View File

@@ -0,0 +1,36 @@
<!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>swg_domain_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">swg_domain_summary</p>
<P>Configuration for swg_domain_summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">total_requests<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total transactions.</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes .</p>
<p class="property_name">url_reputation<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">URL reputation.</p>
<p class="property_name">total_ssl_intercepts<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Intercepts.</p>
<p class="property_name">url_group_category<span class="property_type">&lt;String&gt;</span></p><p class="property_description">URL Group Category.</p>
<p class="property_name">port<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">protocol used.</p>
<p class="property_name">total_bytes_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes out.</p>
<p class="property_name">protocol<span class="property_type">&lt;String&gt;</span></p><p class="property_description">protocol used.</p>
<p class="property_name">operating_system<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Client Operating System Name..<br> Maximum length = 255</p>
<p class="property_name">total_bytes_in<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes in.</p>
<p class="property_name">total_bytes_out<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes out.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample time..</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">user_agent<span class="property_type">&lt;String&gt;</span></p><p class="property_description">User Agent Name..<br> Maximum length = 255</p>
<p class="property_name">domain_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Domain Name.<br> Maximum length = 255</p>
<p class="property_name">exporter_id<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Exporter ID.</p>
<p class="property_name">total_requests_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total transactions.</p>
<p class="property_name">total_bytes_out_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes out.</p>
<p class="property_name">total_ssl_intercepts_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Intercepts.</p>
<p class="property_name">total_bytes_in_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes in.</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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/swg_domain_summary</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>group_by</b></p><p class="key"><span class="value">Use this query-parameter to get the result that is grouped by according to the given property.</span></p><p class="key"><span class="value">Possible Values:<span class="value">domain_name, url_group_category, port, protocol, operating_system</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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "swg_domain_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_requests":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url_reputation":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_ssl_intercepts":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url_group_category":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"port":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"protocol":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"operating_system":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes_in":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes_out":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user_agent":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"domain_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"exporter_id":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_requests_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes_out_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_ssl_intercepts_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes_in_prev":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

28
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/swg_ssl_details.html Normal file
View File

@@ -0,0 +1,28 @@
<!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>swg_ssl_details</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">swg_ssl_details</p>
<P>Configuration for swg_ssl_details resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">domain_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">HTTP Request URL..<br> Maximum length = 2000</p>
<p class="property_name">total_not_intercepted<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">total_not_intercepted.</p>
<p class="property_name">exporter_id<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Exporter ID.</p>
<p class="property_name">ssli_policy_action<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">ssli_policy_action.</p>
<p class="property_name">ssli_executed_action<span class="property_type">&lt;String&gt;</span></p><p class="property_description">SSL Executed Action..<br> Maximum length = 255</p>
<p class="property_name">ssli_reason_for_action<span class="property_type">&lt;String&gt;</span></p><p class="property_description">SSL REASON Codes..<br> Maximum length = 255</p>
<p class="property_name">user_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">User Name.<br> Maximum length = 255</p>
<p class="property_name">total_not_attempted_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">total_not_attempted_prev.</p>
<p class="property_name">total_not_attempted<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">total_not_attempted.</p>
<p class="property_name">total_not_intercepted_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">total_not_intercepted_prev.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample 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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/swg_ssl_details</span></p><p class="key">Query-parameters:<span class="url_value"></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">rpt_sample_time</span></span></p><p class="key"><b>group_by</b></p><p class="key"><span class="value">Use this query-parameter to get the result that is grouped by according total_not_attempted the given property.</span></p><p class="key"><span class="value">Possible Values:<span class="value">rpt_sample_time</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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "swg_ssl_details":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"domain_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_not_intercepted":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"exporter_id":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ssli_policy_action":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ssli_executed_action":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ssli_reason_for_action":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_not_attempted_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_not_attempted":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_not_intercepted_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

60
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/swg_trans_details.html Normal file
View File

File diff suppressed because one or more lines are too long

53
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/swg_user_details.html Normal file
View File

File diff suppressed because one or more lines are too long

38
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/swg_user_summary.html Normal file
View File

@@ -0,0 +1,38 @@
<!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>swg_user_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">swg_user_summary</p>
<P>Configuration for SWG Transaction Report resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">__count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">count..</p>
<p class="property_name">user_agent<span class="property_type">&lt;String&gt;</span></p><p class="property_description">User Agent Name..<br> Maximum length = 255</p>
<p class="property_name">exporter_id<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Exporter ID.</p>
<p class="property_name">total_requests_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total transactions.</p>
<p class="property_name">total_bytes_out_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes out.</p>
<p class="property_name">user_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">User Name.<br> Maximum length = 255</p>
<p class="property_name">total_ssl_intercepts_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Intercepts.</p>
<p class="property_name">total_bytes_in_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes in.</p>
<p class="property_name">total_bytes<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes .</p>
<p class="property_name">total_requests<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total transactions.</p>
<p class="property_name">user_count_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">User Count Prev.</p>
<p class="property_name">url_reputation<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">URL reputation.</p>
<p class="property_name">url_group_category<span class="property_type">&lt;String&gt;</span></p><p class="property_description">URL Group Category.</p>
<p class="property_name">total_ssl_intercepts<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Intercepts.</p>
<p class="property_name">port<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">protocol used.</p>
<p class="property_name">total_bytes_prev<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes out.</p>
<p class="property_name">user_count<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">User Count.</p>
<p class="property_name">protocol<span class="property_type">&lt;String&gt;</span></p><p class="property_description">protocol used.</p>
<p class="property_name">operating_system<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Client Operating System Name..<br> Maximum length = 255</p>
<p class="property_name">total_bytes_in<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes in.</p>
<p class="property_name">total_bytes_out<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total bytes out.</p>
<p class="property_name">rpt_sample_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Report Sample 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\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</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://&lt;MGMT-IP&gt;/nitro/v2/config/swg_user_summary</span></p><p class="key">Query-parameters:<span class="url_value"></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"><b>group_by</b></p><p class="key"><span class="value">Use this query-parameter to get the result that is grouped by according total_not_attempted the given property.</span></p><p class="key"><span class="value">Possible Values:<span class="value">url_reputation, user_agent, rpt_sample_time, url_group_category</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">rpt_sample_time</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&lt;String&gt;</span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value&lt;String&gt;</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&lt;String&gt;</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": &ltString_value&gt, "swg_user_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"__count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user_agent":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"exporter_id":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_requests_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes_out_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_ssl_intercepts_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes_in_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_requests":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user_count_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url_reputation":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"url_group_category":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_ssl_intercepts":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"port":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes_prev":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user_count":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"protocol":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"operating_system":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes_in":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_bytes_out":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rpt_sample_time":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

18
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Applications/user_filter_preference.html Normal file
View File

File diff suppressed because one or more lines are too long