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

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

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>sdx_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">sdx_summary</p>
<P>Configuration for SDX Summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="heading">Read only properties</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="property_name">value<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Value of category.</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">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_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Type 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="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/sdx_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/sdx_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 sdx_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/sdx_summary<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the sdx_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/sdx_summary<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of sdx_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, "sdx_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"category_name":&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;"device_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_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"subcategory_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,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>sdx_upgrade</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">sdx_upgrade</p>
<P>Configuration for Upgrade SDX resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">mail_profiles<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Comma separated list of Mail profiles.</p>
<p class="property_name">scheduleTimesEpoch<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Schedule time epoch (string representation of 11 digit numbers)..</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name.<br> Maximum length = 128</p>
<p class="property_name">is_remote_download<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">True if upgrade is remote download instead of direct upload from NetScaler Console.</p>
<p class="property_name">device_groups<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">Device Group Array on which for which job is run.</p>
<p class="property_name">do_cleanup<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">True, if user wants to clean the image files once upgrade is completed successfully.</p>
<p class="property_name">sdx_ip_address_arr<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">List of NetScaler SDX IP Address.</p>
<p class="property_name">scheduleId<span class="property_type">&lt;String&gt;</span></p><p class="property_description">scheduleId is used to refer maintenaince schedule task.</p>
<p class="property_name">slack_profile<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Slack profile.</p>
<p class="property_name">image_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">image_name.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="heading">Read only properties</p>
<p class="property_name">task_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Task 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="#upgrade" class="operation">upgrade</a><p class="heading"><a name="upgrade">upgrade</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/sdx_upgrade?action=upgrade&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">{"sdx_upgrade": {<br><font color=#FF0000><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image_name":&lt;String_value&gt;</b></font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_groups":&lt;String_value[]&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sdx_ip_address_arr":&lt;String_value[]&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"slack_profile":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"scheduleTimesEpoch":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"mail_profiles":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"is_remote_download":&lt;Boolean_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"scheduleId":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"do_cleanup":&lt;Boolean_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&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, "sdx_upgrade":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"mail_profiles":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"scheduleTimesEpoch":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"task_id":&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;"is_remote_download":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_groups":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"do_cleanup":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sdx_ip_address_arr":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"scheduleId":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"slack_profile":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"image_name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>vpx_info</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">vpx_info</p>
<P>Configuration for Bandwidth info of VPX on SDX 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 of the VPX on SDX.</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Vpx name.<br> Minimum length = 1<br> Maximum length = 128</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">.</p>
<p class="property_name">license_edition<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Type of License Edition.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="heading">Read only properties</p>
<p class="property_name">throughput<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Throughput in Mbps.</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/vpx_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/vpx_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 vpx_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/vpx_info<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the vpx_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/vpx_info<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of vpx_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, "vpx_info":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"throughput":&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;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license_edition":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,29 @@
<!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_disk_space_details</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">adc_disk_space_details</p>
<P>Configuration for Check and clean disk space for NetScaler resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">device<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler IP Address for space check and cleanup.</p>
<p class="property_name">files<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">Files to remove.</p>
<p class="property_name">folders<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">Folders to remove.</p>
<p class="heading">Read only properties</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is Activity Id.</p>
<p class="property_name">disk0_perusage<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">NetScaler Disk0 Utilization (%).</p>
<p class="property_name">disk0_free<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Disk0 Free space in MB.</p>
<p class="property_name">disk1_free<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Disk1 free space in MB.</p>
<p class="property_name">disk1_perusage<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">NetScaler Disk0 Utilization (%).</p>
<p class="property_name">disk1_total<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Disk1 total space in MB.</p>
<p class="property_name">disk0_used<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Disk0 used space in percentage.</p>
<p class="property_name">disk1_used<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Disk1 used space in percentage.</p>
<p class="property_name">disk0_total<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Disk0 total space in MB.</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_disk_space_details</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_disk_space_details<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_disk_space_details 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_disk_space_details<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the adc_disk_space_details 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_disk_space_details<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of adc_disk_space_details 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_disk_space_details":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"disk0_perusage":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"disk0_free":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"disk1_free":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"disk1_perusage":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"disk1_total":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"disk0_used":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"disk1_used":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"disk0_total":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"files":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"folders":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>adc_update_appflow_info</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">adc_update_appflow_info</p>
<P>Configuration for Execute the Appflow Info Query through Remote Proxy Handler resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">export_option<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Export Options: TCP, ICA.</p>
<p class="property_name">icalog<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ICA log.</p>
<p class="property_name">ns_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">securityinsight<span class="property_type">&lt;String&gt;</span></p><p class="property_description">securityinsight.</p>
<p class="property_name">metricslog<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">metricslog.</p>
<p class="property_name">es4nslog<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ESNS enable.</p>
<p class="property_name">appflowlog_effective<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Appflowlog effective (validating AppFlow config) enabled or disabled.</p>
<p class="property_name">rule<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Rule.</p>
<p class="property_name">webinsight<span class="property_type">&lt;String&gt;</span></p><p class="property_description">webinsight.</p>
<p class="property_name">agent_list<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Agent List, on which traffic will flow.</p>
<p class="property_name">appflow_policy_rule<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Appflow policy rule.</p>
<p class="property_name">videoanalytics<span class="property_type">&lt;String&gt;</span></p><p class="property_description">videoanalytics.</p>
<p class="property_name">transport<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Transport type..<br> Minimum length = 1<br> Maximum length = 20</p>
<p class="property_name">vsvr_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Vserver name.<br> Minimum length = 1<br> Maximum length = 100</p>
<p class="property_name">analytics_managed<span class="property_type">&lt;String&gt;</span></p><p class="property_description">analytics is user/auto enabled/disabled.</p>
<p class="property_name">transactionlog<span class="property_type">&lt;String&gt;</span></p><p class="property_description">transactionlog.</p>
<p class="property_name">action<span class="property_type">&lt;String&gt;</span></p><p class="property_description">action.</p>
<p class="property_name">policy_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">policy_name.<br> Minimum length = 1<br> Maximum length = 256</p>
<p class="property_name">priority<span class="property_type">&lt;String&gt;</span></p><p class="property_description">priority.</p>
<p class="property_name">clientsidemeasurements<span class="property_type">&lt;String&gt;</span></p><p class="property_description">clientsidemeasurements.</p>
<p class="property_name">collectors<span class="property_type">&lt;String&gt;</span></p><p class="property_description">collectors.</p>
<p class="property_name">collector_ip<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Collector IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">type.</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_update_appflow_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/adc_update_appflow_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 adc_update_appflow_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/adc_update_appflow_info<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the adc_update_appflow_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/adc_update_appflow_info<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of adc_update_appflow_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, "adc_update_appflow_info":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"export_option":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"icalog":&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;"securityinsight":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"metricslog":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"es4nslog":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appflowlog_effective":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rule":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"webinsight":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"agent_list":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"appflow_policy_rule":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"videoanalytics":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"transport":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vsvr_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"analytics_managed":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"transactionlog":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"action":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"policy_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"priority":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clientsidemeasurements":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"collectors":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"collector_ip":&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,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>analytics_feature_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">analytics_feature_summary</p>
<P>Configuration for Holds information regarding count of vips per analytics feature enabled resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">bot_insights<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">vip count with bot insights enableds.</p>
<p class="property_name">hdx_insights<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">vip count with HDX insights enabled.</p>
<p class="property_name">gateway_insights<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">vip count with gateway insights enabled.</p>
<p class="property_name">security_insights<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">vip count with security insights enabled.</p>
<p class="property_name">web_insights<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">vip count with web insights enabled.</p>
<p class="property_name">waf_insights<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">vip count with waf insights enabled.</p>
<p class="property_name">client_side_measurement<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">vip count with ClientSideMeasurement enabled.</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/analytics_feature_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/analytics_feature_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 analytics_feature_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/analytics_feature_summary<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the analytics_feature_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/analytics_feature_summary<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of analytics_feature_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, "analytics_feature_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bot_insights":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hdx_insights":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gateway_insights":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"security_insights":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"web_insights":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"waf_insights":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"client_side_measurement":&lt;Integer_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

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

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,17 @@
<!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>ns_callhome_poll_policy</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_callhome_poll_policy</p>
<P>Configuration for NetScaler CallHome Polling Policy resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">polling_interval<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Frequency of polling in minutes.<br> Minimum value = 30<br> Maximum 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="#update" class="operation">update</a><a href="#get" class="operation">get</a><p class="heading"><a name="update">update</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ns_callhome_poll_policy/</span></p><p class="key">HTTPS Method:<span class="value">PUT</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">{"ns_callhome_poll_policy":{<br><font color=#FF0000><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"polling_interval":&lt;Integer_value&gt;</b></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, "ns_callhome_poll_policy":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"polling_interval":&lt;Integer_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/ns_callhome_poll_policy</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, "ns_callhome_poll_policy":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"polling_interval":&lt;Integer_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>ns_cluster_nodegroup</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_cluster_nodegroup</p>
<P>Configuration for ns_cluster_nodegroup resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">clip<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Cluster IPAddress where this nodegroup will be added.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Cluster Node Group Name.</p>
<p class="property_name">password<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Password of the Configuration Coordinator node(Cluster IP).<br> Minimum length = 1<br> Maximum length = 128</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/ns_cluster_nodegroup?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">{"ns_cluster_nodegroup": {<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"password":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clip":&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, "ns_cluster_nodegroup":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clip":&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;"password":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>ns_command</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_command</p>
<P>Configuration for NetScaler configuration template command resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">parent_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">.</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">parent_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">.</p>
<p class="property_name">command<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler Command.</p>
<p class="heading">Read only properties</p>
<p class="property_name">index<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Command Index.</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>

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>ns_config_replicate</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_config_replicate</p>
<P>Configuration for NetScaler Configuration Replicate resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">source_device<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Source NetScaler IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">target_device<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">Target device IP Address Array on which replicate config from source 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><a href="#replicate" class="operation">replicate</a><p class="heading"><a name="replicate">replicate</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ns_config_replicate?action=replicate&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">{"ns_config_replicate": {<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"target_device":&lt;String_value[]&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"source_device":&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, "ns_config_replicate":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"source_device":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"target_device":&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,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>ns_hapair_template</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_hapair_template</p>
<P>Configuration for NetScaler HA Pair Configure Template resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">mail_profiles<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Comma separated list of Mail profiles.</p>
<p class="property_name">inc_enabled<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">Turn on INC mode on self node.</p>
<p class="property_name">scheduleTimesEpoch<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Schedule time epoch (string representation of 11 digit numbers)..</p>
<p class="property_name">primary_nodeid<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Prmiary Node ID.<br> Maximum value = </p>
<p class="property_name">secondary_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Secondary HA Node IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">configCoordinator<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Node to be designated as Config Coordinator - primary or secondary.</p>
<p class="property_name">secondary_rpcnodepassword<span class="property_type">&lt;String&gt;</span></p><p class="property_description">RPC Node Password for secondary node.<br> Minimum length = 1<br> Maximum length = 127</p>
<p class="property_name">primary_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Primary HA Node IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">nssecondary_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Secondary HA Node NSIP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">nsprimary_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Primary HA Node NSIP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">execute_sequentially<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">True if configuration template is to be applied to devices sequentially.</p>
<p class="property_name">backplane<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Backplane Interface.<br> Minimum length = 1<br> Maximum length = 32</p>
<p class="property_name">primary_rpcnodepassword<span class="property_type">&lt;String&gt;</span></p><p class="property_description">RPC Node Password for primary node.<br> Minimum length = 1<br> Maximum length = 127</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name.<br> Maximum length = 128</p>
<p class="property_name">slack_profile<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Slack profile.</p>
<p class="property_name">clip<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Cluster IPAddress.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">on_error<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Behaviour on encountering error while applying configuration template on a device: CONTINUE|EXIT.<br> Minimum length = 1<br> Maximum length = 16</p>
<p class="property_name">scheduleId<span class="property_type">&lt;String&gt;</span></p><p class="property_description">scheduleId is used to refer maintenaince schedule task.</p>
<p class="property_name">secondary_nodeid<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Secondary Node ID.<br> Maximum value = </p>
<p class="property_name">clusterid<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Cluster Id.<br> Minimum value = 1<br> Maximum value = </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="#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/ns_hapair_template</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/ns_hapair_template<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 ns_hapair_template 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/ns_hapair_template<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_hapair_template 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/ns_hapair_template<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_hapair_template 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, "ns_hapair_template":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sync_operation":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"mail_profiles":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"inc_enabled":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"scheduleTimesEpoch":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"primary_nodeid":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"secondary_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"configCoordinator":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"secondary_rpcnodepassword":&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;"primary_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"nssecondary_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"nsprimary_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"execute_sequentially":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"backplane":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"primary_rpcnodepassword":&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;"slack_profile":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clip":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"on_error":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"scheduleId":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"secondary_nodeid":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clusterid":&lt;Integer_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,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>ns_mpxcluster_template</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_mpxcluster_template</p>
<P>Configuration for NetScaler MPX Cluster Template resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">clip<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Cluster IPAddress.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">clusterid<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Cluster Id.<br> Minimum value = 1<br> Maximum value = </p>
<p class="property_name">backplane<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Backplane Interface.<br> Minimum length = 1<br> Maximum length = 32</p>
<p class="property_name">cco<span class="property_type">&lt;String&gt;</span></p><p class="property_description">CCO IP address.</p>
<p class="property_name">devices<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">Device IP Address Array on which template is applied.</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/ns_mpxcluster_template</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/ns_mpxcluster_template<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 ns_mpxcluster_template 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/ns_mpxcluster_template<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_mpxcluster_template 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/ns_mpxcluster_template<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_mpxcluster_template 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, "ns_mpxcluster_template":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clip":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"clusterid":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sync_operation":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"backplane":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cco":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"devices":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>ns_netprofile</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_netprofile</p>
<P>Configuration for NetScaler Net Profile resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Net Proile.</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">ns_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="heading">Read only properties</p>
<p class="property_name">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Display Name.</p>
<p class="property_name">partition_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Partition 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" 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/ns_netprofile</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, "ns_netprofile":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"partition_name":&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;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>ns_network_interface</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_network_interface</p>
<P>Configuration for NS Network Interfaces resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ns_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">devicename<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device/Interface Name.<br> Minimum length = 1<br> Maximum length = 100</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">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device Display Name.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">errifindiscards<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of error free incoming packets discarded.</p>
<p class="property_name">nicerrifoutdiscards<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Number of error free outgoing packets discarded.</p>
<p class="heading">Read only properties</p>
<p class="property_name">poll_time<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Last Polling Time.</p>
<p class="property_name">state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">State Enabled|Disabled.</p>
<p class="property_name">partition_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Partition Name.</p>
<p class="property_name">hostname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Assign hostname to managed device, if this is not provided, name will be set as host name .</p>
<p class="property_name">description<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Interface 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" 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/ns_network_interface</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, "ns_network_interface":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"devicename":&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;"poll_time":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"state":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"partition_name":&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;"display_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"errifindiscards":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"nicerrifoutdiscards":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"description":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>ns_ns_appflowcollector</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_ns_appflowcollector</p>
<P>Configuration for AppFlow Collector for NetScaler resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">transport<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Transport type like logstream, IPfix.<br> Minimum length = 1<br> Maximum length = 20</p>
<p class="property_name">ipaddress<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ipaddress.<br> Minimum length = 1<br> Maximum length = 20</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">name.<br> Minimum length = 1<br> Maximum length = 256</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">port<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">port.</p>
<p class="property_name">state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">state of the collector.<br> Minimum length = 1<br> Maximum length = 10</p>
<p class="property_name">ns_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="heading">Read only properties</p>
<p class="property_name">poll_time<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Last Polling Time.</p>
<p class="property_name">partition_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Partition Name.</p>
<p class="property_name">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Display Name.</p>
<p class="property_name">netprofile<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Net Profile.</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/ns_ns_appflowcollector</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/ns_ns_appflowcollector<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 ns_ns_appflowcollector 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/ns_ns_appflowcollector<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_ns_appflowcollector 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/ns_ns_appflowcollector<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_ns_appflowcollector 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, "ns_ns_appflowcollector":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"transport":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"poll_time":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"partition_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ipaddress":&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;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"port":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"state":&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;"ns_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"netprofile":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

View File

@@ -0,0 +1,31 @@
<!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>ns_ns_appflowparam</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_ns_appflowparam</p>
<P>Configuration for Appflow param for NetScaler resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">httpdomain<span class="property_type">&lt;String&gt;</span></p><p class="property_description">HTTP Domain Traffic logging.</p>
<p class="property_name">httpuseragent<span class="property_type">&lt;String&gt;</span></p><p class="property_description">HTTP User-Agent logging.</p>
<p class="property_name">httpmethod<span class="property_type">&lt;String&gt;</span></p><p class="property_description">HTTP Method logging.</p>
<p class="property_name">observationdomainName<span class="property_type">&lt;String&gt;</span></p><p class="property_description">observationdomainName.<br> Minimum length = 1<br> Maximum length = 1024</p>
<p class="property_name">events<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Events Enabled/Disabled.</p>
<p class="property_name">aaausername<span class="property_type">&lt;String&gt;</span></p><p class="property_description">AAA Username logging.</p>
<p class="property_name">httpxforwardedfor<span class="property_type">&lt;String&gt;</span></p><p class="property_description">.<br> Minimum length = 1<br> Maximum length = 10</p>
<p class="property_name">httpcookie<span class="property_type">&lt;String&gt;</span></p><p class="property_description">httpCookie Enabled/Disabled.<br> Minimum length = 1<br> Maximum length = 10</p>
<p class="property_name">metrics<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Metrics Enabled/Disabled.</p>
<p class="property_name">auditlogs<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Auditlogs Enabled/Disabled.</p>
<p class="property_name">template_interval<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Template refresh interval.</p>
<p class="property_name">observationdomainid<span class="property_type">&lt;String&gt;</span></p><p class="property_description">observationdomainid.<br> Minimum length = 1<br> Maximum length = 256</p>
<p class="property_name">urlcategory<span class="property_type">&lt;String&gt;</span></p><p class="property_description">URL Category.</p>
<p class="property_name">securityinsighttraffic<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Security Insight Traffic logging.</p>
<p class="property_name">httpquerywithurl<span class="property_type">&lt;String&gt;</span></p><p class="property_description">httpquerywithurl Enabled/Disabled.<br> Minimum length = 1<br> Maximum length = 10</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/ns_ns_appflowparam</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/ns_ns_appflowparam<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 ns_ns_appflowparam 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/ns_ns_appflowparam<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_ns_appflowparam 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/ns_ns_appflowparam<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_ns_appflowparam 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, "ns_ns_appflowparam":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"httpdomain":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"httpuseragent":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"httpmethod":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"observationdomainName":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"events":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"aaausername":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"httpxforwardedfor":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"httpcookie":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"metrics":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"auditlogs":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"template_interval":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"observationdomainid":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"urlcategory":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"securityinsighttraffic":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"httpquerywithurl":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

View File

@@ -0,0 +1,27 @@
<!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>ns_ns_ip</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_ns_ip</p>
<P>Configuration for IP on NetScaler resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">netmask<span class="property_type">&lt;String&gt;</span></p><p class="property_description">netmask.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">ns_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler IP Address where IP needs to be created.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">state ENABLED/DISABLED.<br> Minimum length = 1<br> Maximum length = 64</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">mgmtaccess<span class="property_type">&lt;String&gt;</span></p><p class="property_description">mgmtaccess ENABLED/DISABLED.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">ipaddress<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler ipaddress that needs to be created.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">hostname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Hostname of the managed device.<br> Minimum length = 1<br> Maximum length = 256</p>
<p class="property_name">type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Type of IP Address, Possible Values: SNIP, NSIP, VIP.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">save_config<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if save config is required.</p>
<p class="heading">Read only properties</p>
<p class="property_name">partition_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Partition 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="#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/ns_ns_ip?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">{"ns_ns_ip": {<br><font color=#FF0000><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"netmask":&lt;String_value&gt;</b></font>,<br><font color=#FF0000><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</b></font>,<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;"type":&lt;String_value&gt;</b></font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hostname":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"save_config":&lt;Boolean_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"mgmtaccess":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"state":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"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, "ns_ns_ip":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"netmask":&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;"state":&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;"partition_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"mgmtaccess":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ipaddress":&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;"type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"save_config":&lt;Boolean_value&gt;</font>}]}</p>
</body>
</html>

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>ns_ns_ipv6</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_ns_ipv6</p>
<P>Configuration for IPV6 on NetScaler resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ipv6address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler ipaddress that needs to be created.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Type of IPv6 Address.</p>
<p class="property_name">hostname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Hostname of the managed device.<br> Minimum length = 1<br> Maximum length = 256</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">scope<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Scope of IPv6 Address, Possible Values: GLobal and Link Local.</p>
<p class="property_name">state<span class="property_type">&lt;String&gt;</span></p><p class="property_description">state ENABLED/DISABLED.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">ns_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler IP Address where IP needs to be created.<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>
</body>
</html>

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>ns_ns_mode</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_ns_mode</p>
<P>Configuration for NetScaler Mode resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">pmtud<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if pmtud feature is enabled.</p>
<p class="property_name">mediaclassification<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if mediaclassification feature is enabled.</p>
<p class="property_name">rise_rhi<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if rise_rhi feature is enabled.</p>
<p class="property_name">iradv<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if iradv feature is enabled.</p>
<p class="property_name">sradv6<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if sradv6 feature is enabled.</p>
<p class="property_name">l2<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if l2 feature is enabled.</p>
<p class="property_name">bridgebpdus<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if bridgebpdus feature is enabled.</p>
<p class="property_name">sradv<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if sradv feature is enabled.</p>
<p class="property_name">usnip<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if usnip feature is enabled.</p>
<p class="property_name">usip<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if usip feature is enabled.</p>
<p class="property_name">fr<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if fr feature is enabled.</p>
<p class="property_name">cka<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if cka feature is enabled.</p>
<p class="property_name">tcpb<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if tcpb feature is enabled.</p>
<p class="property_name">l3<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if l3 feature is enabled.</p>
<p class="property_name">dradv<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if dradv feature is enabled.</p>
<p class="property_name">ns_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">mbf<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if mbf feature is enabled.</p>
<p class="property_name">dradv6<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if dradv6 feature is enabled.</p>
<p class="property_name">ulfd<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if ulfd feature is enabled.</p>
<p class="property_name">ns_ip_address_arr<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">List of NetScaler IP Addresses.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">rise_apbr<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if rise_apbr feature is enabled.</p>
<p class="property_name">edge<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">true, if edge feature is enabled.</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/ns_ns_mode</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/ns_ns_mode<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 ns_ns_mode 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/ns_ns_mode<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_ns_mode 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/ns_ns_mode<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_ns_mode 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, "ns_ns_mode":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pmtud":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"mediaclassification":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rise_rhi":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"iradv":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sradv6":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"l2":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bridgebpdus":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sradv":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"usnip":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"usip":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"fr":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cka":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tcpb":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"l3":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dradv":&lt;Boolean_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;"mbf":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dradv6":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ulfd":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address_arr":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rise_apbr":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"edge":&lt;Boolean_value&gt;</font>}]}</p>
</body>
</html>

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>ns_ns_rollbackcmd</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_ns_rollbackcmd</p>
<P>Configuration for NetScaler Rollback command resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">command<span class="property_type">&lt;String&gt;</span></p><p class="property_description">command .</p>
<p class="property_name">rollback_command<span class="property_type">&lt;String&gt;</span></p><p class="property_description">roll back command.</p>
<p class="property_name">ns_ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">NetScaler IP Address.</p>
<p class="property_name">response<span class="property_type">&lt;String&gt;</span></p><p class="property_description">response.</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/ns_ns_rollbackcmd</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/ns_ns_rollbackcmd<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 ns_ns_rollbackcmd 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/ns_ns_rollbackcmd<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_ns_rollbackcmd 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/ns_ns_rollbackcmd<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_ns_rollbackcmd 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, "ns_ns_rollbackcmd":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"command":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rollback_command":&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;"response":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>ns_ns_runningconfig</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_ns_runningconfig</p>
<P>Configuration for NetScaler Running Configuration resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ns_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="heading">Read only properties</p>
<p class="property_name">partition_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Partition Name.</p>
<p class="property_name">withdefaults<span class="property_type">&lt;String&gt;</span></p><p class="property_description">withdefaults.</p>
<p class="property_name">response<span class="property_type">&lt;String&gt;</span></p><p class="property_description">response.</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/ns_ns_runningconfig</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, "ns_ns_runningconfig":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"partition_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"withdefaults":&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;"response":&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>ns_ns_savedconfig</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_ns_savedconfig</p>
<P>Configuration for NetScaler Saved Configuration resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ns_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="heading">Read only properties</p>
<p class="property_name">response<span class="property_type">&lt;String&gt;</span></p><p class="property_description">response.</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/ns_ns_savedconfig</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, "ns_ns_savedconfig":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"response":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>ns_ns_timeout</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_ns_timeout</p>
<P>Configuration for NetScaler Timeout on NetScaler resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">timeout<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Timeout.<br> Maximum value = </p>
<p class="property_name">ns_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="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="#set" class="operation">set</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/ns_ns_timeout</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/ns_ns_timeout<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 ns_ns_timeout 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/ns_ns_timeout<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_ns_timeout 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/ns_ns_timeout<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_ns_timeout 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, "ns_ns_timeout":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeout":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>}]}</p><p class="heading"><a name="set">set</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/ns_ns_timeout/ns_ip_address_value&lt;String&gt;</span></p><p class="key">HTTPS Method:<span class="value">PUT</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">{"ns_ns_timeout":{<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeout":&lt;Integer_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&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, "ns_ns_timeout":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeout":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>ns_partition</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_partition</p>
<P>Configuration for NetScaler Partition resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ns_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">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">partition_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Partition ID.</p>
<p class="property_name">partitionmac<span class="property_type">&lt;String&gt;</span></p><p class="property_description">vmac used by the partition.</p>
<p class="property_name">partition_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Partition 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" 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/ns_partition</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, "ns_partition":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"partition_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"partitionmac":&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;"partition_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>ns_poll_data</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_poll_data</p>
<P>Configuration for Performance Poll Data for NetScaler devices resource.</P>
<p class="heading">Read/write properties</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">device_ip_address<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="property_name">counter_group<span class="property_type">&lt;String&gt;</span></p><p class="property_description">CounterGroup.<br> Minimum length = 1<br> Maximum length = 100</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/ns_poll_data?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">{"ns_poll_data": {<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_ip_address":&lt;String_value&gt;</font>,<br><font color=#000000>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"counter_group":&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, "ns_poll_data":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"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;"counter_group":&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/ns_poll_data</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, "ns_poll_data":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"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;"counter_group":&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>ns_save_config</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_save_config</p>
<P>Configuration for Save configuration on NetScaler resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ns_ip_address_arr<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">List of NetScaler IP Address.<br> Minimum length = 1<br> Maximum length = 1024</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/ns_save_config?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">{"ns_save_config": {<br><font color=#FF0000><b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address_arr":&lt;String_value[]&gt;</b></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, "ns_save_config":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"act_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address_arr":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,26 @@
<!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>ns_sslcipher_binding</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_sslcipher_binding</p>
<P>Configuration for NetScaler SSL Cipher Binding resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">cipherpriority<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">cipherpriority.</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">ciphergroupname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ciphergroupname.</p>
<p class="property_name">ns_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">hexcode<span class="property_type">&lt;String&gt;</span></p><p class="property_description">hexcode.</p>
<p class="property_name">ciphername<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ciphername.</p>
<p class="heading">Read only properties</p>
<p class="property_name">poll_time<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Last Polling Time.</p>
<p class="property_name">partition_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Partition Name.</p>
<p class="property_name">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Display 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" 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/ns_sslcipher_binding</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, "ns_sslcipher_binding":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"poll_time":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"partition_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cipherpriority":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ciphergroupname":&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;"ns_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hexcode":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ciphername":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>ns_sslparameter</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_sslparameter</p>
<P>Configuration for NetScaler SSL Parameter resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">sendclosenotify<span class="property_type">&lt;String&gt;</span></p><p class="property_description">sendclosenotify.</p>
<p class="property_name">dropreqwithnohostheader<span class="property_type">&lt;String&gt;</span></p><p class="property_description">dropreqwithnohostheader.</p>
<p class="property_name">ns_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">pushflag<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">pushflag.</p>
<p class="property_name">denysslreneg<span class="property_type">&lt;String&gt;</span></p><p class="property_description">denysslreneg.</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">quantumsize<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">quantumsize.</p>
<p class="property_name">pushenctriggertimeout<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">pushenctriggertimeout.</p>
<p class="property_name">ssltriggertimeout<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">ssltriggertimeout.</p>
<p class="property_name">strictcachecks<span class="property_type">&lt;String&gt;</span></p><p class="property_description">strictcachecks.</p>
<p class="property_name">encrypttriggerpktcount<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">encrypttriggerpktcount.</p>
<p class="property_name">snihttphostmatch<span class="property_type">&lt;String&gt;</span></p><p class="property_description">snihttphostmatch.</p>
<p class="property_name">insertionencoding<span class="property_type">&lt;String&gt;</span></p><p class="property_description">insertionencoding.</p>
<p class="property_name">defaultprofile<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">defaultprofile.</p>
<p class="heading">Read only properties</p>
<p class="property_name">poll_time<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Last Polling Time.</p>
<p class="property_name">partition_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Partition Name.</p>
<p class="property_name">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Display 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" 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/ns_sslparameter</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, "ns_sslparameter":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"poll_time":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sendclosenotify":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dropreqwithnohostheader":&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;"partition_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pushflag":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"denysslreneg":&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;"quantumsize":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pushenctriggertimeout":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ssltriggertimeout":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"strictcachecks":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"encrypttriggerpktcount":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"snihttphostmatch":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"insertionencoding":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"defaultprofile":&lt;Boolean_value&gt;</font>}]}</p>
</body>
</html>

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,25 @@
<!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>ns_sslprofile_cipher_binding</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_sslprofile_cipher_binding</p>
<P>Configuration for NetScaler SSL Profile Cipher Binding resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ns_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">ciphername<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ciphername.</p>
<p class="property_name">profilename<span class="property_type">&lt;String&gt;</span></p><p class="property_description">profilename.</p>
<p class="property_name">cipherpriority<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">cipherpriority.</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">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Display Name.</p>
<p class="property_name">poll_time<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Last Polling Time.</p>
<p class="property_name">partition_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Partition 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" 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/ns_sslprofile_cipher_binding</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, "ns_sslprofile_cipher_binding":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ns_ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ciphername":&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;"profilename":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cipherpriority":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"poll_time":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"partition_name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

View File

@@ -0,0 +1,25 @@
<!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>ns_sslvserver_cipher_binding</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_sslvserver_cipher_binding</p>
<P>Configuration for NetScaler SSL Vserver Cipher Binding resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">ciphername<span class="property_type">&lt;String&gt;</span></p><p class="property_description">ciphername.</p>
<p class="property_name">ns_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">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is system generated key.</p>
<p class="property_name">cipherpriority<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">cipherpriority.</p>
<p class="property_name">sslvserver<span class="property_type">&lt;String&gt;</span></p><p class="property_description">sslvserver.</p>
<p class="heading">Read only properties</p>
<p class="property_name">display_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Display Name.</p>
<p class="property_name">partition_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Partition Name.</p>
<p class="property_name">poll_time<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Last Polling 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" 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/ns_sslvserver_cipher_binding</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, "ns_sslvserver_cipher_binding":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ciphername":&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;"partition_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"poll_time":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cipherpriority":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sslvserver":&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>ns_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_summary</p>
<P>Configuration for NetScaler Summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="heading">Read only properties</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">device_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Device Type.</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_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of Subcategory.</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">category_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of Category.</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="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/ns_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/ns_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 ns_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/ns_summary<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_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/ns_summary<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_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, "ns_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"category_type":&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;"value":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"subcategory_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"subcategory_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"category_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"device_family":&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,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>ns_version</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_version</p>
<P>Configuration for NetScaler Version Information 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">NetScaler IP Address for callhome.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="property_name">version<span class="property_type">&lt;String&gt;</span></p><p class="property_description">The contact person's E-mail address.<br> Maximum length = 78</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/ns_version</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/ns_version<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 ns_version 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/ns_version<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_version 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/ns_version<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_version 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, "ns_version":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ip_address":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"version":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>ns_visualizer_cs_bindings</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_visualizer_cs_bindings</p>
<P>Configuration for visualizer csvserver binding resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of lbvserver.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="heading">Read only properties</p>
<p class="property_name">csvserver_lbvserver_binding<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">Service binding of Csvserver.</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/ns_visualizer_cs_bindings</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/ns_visualizer_cs_bindings<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 ns_visualizer_cs_bindings 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/ns_visualizer_cs_bindings<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_visualizer_cs_bindings 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/ns_visualizer_cs_bindings<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_visualizer_cs_bindings 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, "ns_visualizer_cs_bindings":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&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;"csvserver_lbvserver_binding":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>ns_visualizer_csvserver</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_visualizer_csvserver</p>
<P>Configuration for visualizer csvserver resource.</P>
<p class="heading">Read/write properties</p>
<p class="heading">Read only properties</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of csvserver.</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/ns_visualizer_csvserver</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/ns_visualizer_csvserver<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 ns_visualizer_csvserver 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/ns_visualizer_csvserver<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_visualizer_csvserver 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/ns_visualizer_csvserver<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_visualizer_csvserver 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, "ns_visualizer_csvserver":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>ns_visualizer_gslb_bindings</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_visualizer_gslb_bindings</p>
<P>Configuration for visualizer gslbvserver binding resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of gslbvserver.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address.<br> Minimum length = 1<br> Maximum length = 64</p>
<p class="heading">Read only properties</p>
<p class="property_name">gslbdomain_gslbvserver_binding<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">Service binding of Gslbvserver.</p>
<p class="property_name">gslbdomain_lbmonitor_binding<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">lb monitor binding of Gslbvserver.</p>
<p class="property_name">gslbdomain_gslbservice_binding<span class="property_type">&lt;String[]&gt;</span></p><p class="property_description">GSLB service binding of Gslbvserver.</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/ns_visualizer_gslb_bindings</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/ns_visualizer_gslb_bindings<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 ns_visualizer_gslb_bindings 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/ns_visualizer_gslb_bindings<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_visualizer_gslb_bindings 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/ns_visualizer_gslb_bindings<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_visualizer_gslb_bindings 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, "ns_visualizer_gslb_bindings":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"gslbdomain_gslbvserver_binding":&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;"gslbdomain_lbmonitor_binding":&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;"gslbdomain_gslbservice_binding":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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>ns_visualizer_gslbdomain</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">ns_visualizer_gslbdomain</p>
<P>Configuration for visualizer gslbdomain resource.</P>
<p class="heading">Read/write properties</p>
<p class="heading">Read only properties</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name of GSLB Vserver Domain.</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/ns_visualizer_gslbdomain</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/ns_visualizer_gslbdomain<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 ns_visualizer_gslbdomain 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/ns_visualizer_gslbdomain<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_visualizer_gslbdomain 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/ns_visualizer_gslbdomain<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_visualizer_gslbdomain 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, "ns_visualizer_gslbdomain":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

Some files were not shown because too many files have changed in this diff Show More