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

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>cc_las_poll_interval</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">cc_las_poll_interval</p>
<P>Configuration for LAS CC poll interval resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">console_las_refresh<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">LAS blob refresh interval between console and LAS.</p>
<p class="property_name">console_ns_refresh<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">LAS blob refresh interval between console and NS.</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 VM Instances.</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><a href="#get" class="operation">get</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/cc_las_poll_interval</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/cc_las_poll_interval<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 cc_las_poll_interval 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/cc_las_poll_interval<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the cc_las_poll_interval 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/cc_las_poll_interval<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of cc_las_poll_interval 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, "cc_las_poll_interval":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"console_las_refresh":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"console_ns_refresh":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>}]}</p><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/cc_las_poll_interval/id_value&lt;String&gt;</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, "cc_las_poll_interval":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"console_las_refresh":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"console_ns_refresh":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>device_generic_resrc</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">device_generic_resrc</p>
<P>Configuration for Device generic utility resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ipaddress<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">List of SVM IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">resource_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Type of resource.<br> Minimum length = 1</p>
<p class="property_name">sync<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">Ping SVM to check its status.</p>
<p class="property_name">failure_action<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Action taken on failure .</p>
<p class="property_name">payload<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Payload/Body Request .</p>
<p class="property_name">device_family_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device family type.<br> Minimum length = 1</p>
<p class="heading">Read only properties</p>
<p class="property_name">act_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Activity Id.</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="#add" class="operation">add</a><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/device_generic_resrc?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">{"device_generic_resrc": {<br><font color=#FF0000><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ipaddress":&lt;String_value[]&gt;</b></font>,<br><font color=#FF0000><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"resource_type":&lt;String_value&gt;</b></font>,<br><font color=#FF0000><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"payload":&lt;String_value&gt;</b></font>,<br><font color=#FF0000><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_family_type":&lt;String_value&gt;</b></font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sync":&lt;Boolean_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"failure_action":&lt;String_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, "device_generic_resrc":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ipaddress":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"resource_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sync":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"failure_action":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"payload":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"act_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_family_type":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,39 @@
<!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>device_license_info</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">device_license_info</p>
<P>Configuration for Device License Info resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">instance_state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Managed device instance state.</p>
<p class="property_name">details<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Details about license state.</p>
<p class="property_name">flexed_instance_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Flexed instance type and count, like Multi Tenant:1,Single Tenant:6,Bare Metal:1,CPX:1.</p>
<p class="property_name">is_las_license<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">is device LAS Licensed.</p>
<p class="property_name">last_updated_time<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Last Updated Time.</p>
<p class="property_name">instance_mode<span class="property_type">&lt;String&gt;</span></p><p class="property_description">instance mode of device.</p>
<p class="heading">Read only properties</p>
<p class="property_name">license_pool<span class="property_type">&lt;String&gt;</span></p><p class="property_description">License Pool.</p>
<p class="property_name">allocated_advanced_bw<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Running advanced license capacity of VM.</p>
<p class="property_name">hours_to_expiry<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">No of Hours after which grace license expires.</p>
<p class="property_name">allocated_standard_bw<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Running standard license capacity of VM.</p>
<p class="property_name">current_throughput<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Current Througput of device.</p>
<p class="property_name">configured_on_vm<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Configured license capacity of VM.</p>
<p class="property_name">allocated<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Allocate license on License server.</p>
<p class="property_name">managed_device_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device id managaed device.</p>
<p class="property_name">allocated_instance<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Running instance license capacity of VM.</p>
<p class="property_name">license_state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">State of device, UP only if device accessible.</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of managed device.</p>
<p class="property_name">grace<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">True if this device is managed by NMX.</p>
<p class="property_name">allocated_on_vm<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Running license capacity of VM.</p>
<p class="property_name">allocated_premium_bw<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Running premium license capacity of VM.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address for this managed device.</p>
<p class="property_name">type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Type of device, (Xen | NS).</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/device_license_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/device_license_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 device_license_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/device_license_info<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the device_license_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/device_license_info<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of device_license_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, "device_license_info":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license_pool":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"instance_state":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"details":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"allocated_advanced_bw":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hours_to_expiry":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"allocated_standard_bw":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"current_throughput":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"flexed_instance_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"configured_on_vm":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"allocated":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"managed_device_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"is_las_license":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"allocated_instance":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license_state":&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;"grace":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"allocated_on_vm":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"allocated_premium_bw":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"last_updated_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;"type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"instance_mode":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

File diff suppressed because one or more lines are too long

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>device_registration</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">device_registration</p>
<P>Configuration for device_registration resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">agent_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Agent Id.</p>
<p class="property_name">device_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device to be registered for discovery..<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">device_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device Type of the device to be registered for discovery.<br> Minimum length = 1<br> Maximum length = 64</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="#add" class="operation">add</a><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/device_registration?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">{"device_registration": {<br><font color=#FF0000><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_ip_address":&lt;String_value&gt;</b></font>,<br><font color=#FF0000><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_type":&lt;String_value&gt;</b></font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"agent_id":&lt;String_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, "device_registration":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"agent_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_type":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

View File

@@ -0,0 +1,32 @@
<!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>device_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">device_summary</p>
<P>Configuration for City wise devices summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">cityname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">City Name.<br> Maximum length = 255</p>
<p class="heading">Read only properties</p>
<p class="property_name">total_devices_outofservice<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total devices out of service city wise..</p>
<p class="property_name">total_major_events<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total major events..</p>
<p class="property_name">total_events<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total events city wise..</p>
<p class="property_name">longitude<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">longitude of the city.</p>
<p class="property_name">total_number_of_agents<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total number of agents deployed city wise..</p>
<p class="property_name">total_devices_up<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total agents down city wise..</p>
<p class="property_name">total_devices_down<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total agents down city wise..</p>
<p class="property_name">total_agents_outofservice<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total agents out of service city wise..</p>
<p class="property_name">total_critical_events<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total Critical events city wise..</p>
<p class="property_name">total_number_of_devices<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total number of devices deployed city wise...</p>
<p class="property_name">tenant_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Tenant Id.</p>
<p class="property_name">total_agents_down<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total agents down city wise..</p>
<p class="property_name">latitude<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">latitude of the city.</p>
<p class="property_name">total_agents_up<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total agents up city wise..</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/device_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/device_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 device_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/device_summary<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the device_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/device_summary<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of device_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, "device_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_devices_outofservice":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_major_events":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_events":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"longitude":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_number_of_agents":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_devices_up":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_devices_down":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_agents_outofservice":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_critical_events":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_number_of_devices":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tenant_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_agents_down":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"latitude":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_agents_up":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cityname":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

View File

@@ -0,0 +1,32 @@
<!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>devicewise_detail_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">devicewise_detail_summary</p>
<P>Configuration for Ns event devices summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">memory_usage<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">memory usage of a device.</p>
<p class="property_name">agent_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Agent Id.<br> Maximum length = 255</p>
<p class="property_name">is_agent<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">Is this device acting as Gateway..</p>
<p class="property_name">throughput<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Assign throughput in Mbps to VM Instance.</p>
<p class="property_name">cityname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">City Name.<br> Maximum length = 255</p>
<p class="property_name">agent_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Agent Name.<br> Maximum length = 255</p>
<p class="property_name">type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Type of device, (Xen | NS).<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="heading">Read only properties</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Total number of devices deployed city wise...</p>
<p class="property_name">agent_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Total number of devices deployed city wise...</p>
<p class="property_name">vm_cpu_usage<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">CPU Usage (%) of VM Instance.</p>
<p class="property_name">total_events<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total minor events..</p>
<p class="property_name">instances<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Total number of devices managed by this agent.</p>
<p class="property_name">instance_state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">State of device, UP only if device accessible.</p>
<p class="property_name">platform<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Platform on which Agent is deployed. e.g. XenServer, kubernetes.</p>
<p class="property_name">tenant_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Tenant Id.</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/devicewise_detail_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/devicewise_detail_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 devicewise_detail_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/devicewise_detail_summary<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the devicewise_detail_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/devicewise_detail_summary<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of devicewise_detail_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, "devicewise_detail_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"memory_usage":&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;"agent_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"agent_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vm_cpu_usage":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_events":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"is_agent":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"throughput":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"instances":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cityname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"instance_state":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"platform":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"agent_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tenant_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"type":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,22 @@
<!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>image</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">image</p>
<P>Configuration for Image File resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">file_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">File Name.<br> Minimum length = 1<br> Maximum length = 256</p>
<p class="property_name">file_location_path<span class="property_type">&lt;String&gt;</span></p><p class="property_description">File Location on Client for upload/download.<br> Minimum length = 1</p>
<p class="heading">Read only properties</p>
<p class="property_name">file_size<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">file_size.</p>
<p class="property_name">file_last_modified_epoch<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Last Modified (Epoch).</p>
<p class="property_name">file_last_modified<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Last Modified.</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>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

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>instance_score_threshold</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">instance_score_threshold</p>
<P>Configuration for Device Score Setting resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">persistent_factor<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Indicator persistent factor.</p>
<p class="property_name">platform<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Instance Platform.</p>
<p class="property_name">indicator_weight<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Indicator weight.</p>
<p class="property_name">instance_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Instance type.</p>
<p class="property_name">indicator_low<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Indicator low threshold value.</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">indicator<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Property or indicator name.</p>
<p class="property_name">indicator_high<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Indicator high threshold 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/instance_score_threshold</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/instance_score_threshold<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 instance_score_threshold 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/instance_score_threshold<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the instance_score_threshold 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/instance_score_threshold<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of instance_score_threshold 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, "instance_score_threshold":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"persistent_factor":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"platform":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"indicator_weight":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"instance_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"indicator_low":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"indicator":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"indicator_high":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

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>inventory</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">inventory</p>
<P>Configuration for Inventory resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">devices<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">List of Device IPAddresses.</p>
<p class="property_name">agent_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Agent ID.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">device_ipaddress<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="heading">Read only properties</p>
<p class="property_name">act_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Activity Id.</p>
<p class="property_name">device_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Status of inventory.</p>
<p class="property_name">customer_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">customer name.</p>
<p class="property_name">inventory_status<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Status of inventory.</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="#add" class="operation">add</a><a href="#get" class="operation">get</a><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/inventory?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">{"inventory": {<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"agent_id":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_ipaddress":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"devices":&lt;String_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, "inventory":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"act_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"devices":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"agent_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_ipaddress":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"customer_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"inventory_status":&lt;String_value&gt;</font>}]}</p><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/inventory</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, "inventory":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"act_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"devices":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"agent_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_ipaddress":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"customer_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"inventory_status":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

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>managed_device_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">managed_device_summary</p>
<P>Configuration for Managed Device Summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="heading">Read only properties</p>
<p class="property_name">device_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device Type.</p>
<p class="property_name">category_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Type of Category.</p>
<p class="property_name">value<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Value of category.</p>
<p class="property_name">subcategory_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Type of Subcategory.</p>
<p class="property_name">subcategory_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of Subcategory.</p>
<p class="property_name">device_family<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device family.</p>
<p class="property_name">category_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of Category.</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/managed_device_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/managed_device_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 managed_device_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/managed_device_summary<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the managed_device_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/managed_device_summary<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of managed_device_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, "managed_device_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"category_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"value":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"subcategory_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"subcategory_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_family":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"category_name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>ping</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ping</p>
<P>Configuration for Ping resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">device_ipaddress<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="heading">Read only properties</p>
<p class="property_name">ping_status<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Status of ping.</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" class="operation">get</a><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ping</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, "ping":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ping_status":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_ipaddress":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>traceroute</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">traceroute</p>
<P>Configuration for Traceroute resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">device_ipaddress<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="heading">Read only properties</p>
<p class="property_name">traceroute_status<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Status of traceroute.</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" class="operation">get</a><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/traceroute</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, "traceroute":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"traceroute_status":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_ipaddress":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

File diff suppressed because one or more lines are too long