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

initial

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

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

@@ -0,0 +1,24 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../index.css" rel="stylesheet" type="text/css" />
<title>adc_feature_usage</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">adc_feature_usage</p>
<P>Configuration for ADC Feature Usage Information resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">sslvpn<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">SSLVPN feature config is present or not.</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">bot<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">BOT feature config is present or not.</p>
<p class="property_name">icaproxy<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">ICAProxy feature config is present or not.</p>
<p class="property_name">waf<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">WAF feature config is present or not.</p>
<p class="heading">Read only properties</p>
<p class="property_name">timestamp<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Timestamp of the feature details.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP address of device.</p>
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
<p class="property_name">onerror<span class=\"property_type\">&nbsp;&nbsp;&nbsp;&lt;String_value&gt;</span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p>
</body>
</html>

27
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Licenses/device_usage.html Normal file
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>device_usage</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">device_usage</p>
<P>Configuration for NetScaler Usage information resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">bandwidth_usage<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">bandwidth usage of the Instance.</p>
<p class="property_name">hostname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Host name of the device.</p>
<p class="property_name">timestamp<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Max Device usage information per hour at this timestamp.</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">total_limit<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total license limit for the user (including burst).</p>
<p class="property_name">base_limit<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Base limit usage for the user (excluding burst).</p>
<p class="property_name">timeslot<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Device usage information at this timestamp.</p>
<p class="heading">Read only properties</p>
<p class="property_name">license_usage<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">License used by the NetScaler (Bandwidth/vCPU).</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address of the device.</p>
<p class="property_name">license_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">License name for the 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="#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/device_usage</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_usage":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license_usage":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bandwidth_usage":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hostname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timestamp":&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;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_limit":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"base_limit":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeslot":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license_name":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

22
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Licenses/device_usage_summary.html Normal file
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>device_usage_summary</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">device_usage_summary</p>
<P>Configuration for NetScaler Usage summary resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">average_bandwidth_usage<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Average bandwidth usage of the Instance.</p>
<p class="property_name">bandwidth_usage<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Bandwidth usage of the Instance.</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">average_license_usage<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Average license usage of the Instance.</p>
<p class="heading">Read only properties</p>
<p class="property_name">license_usage<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">License used by the NetScaler (Bandwidth/vCPU).</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/device_usage_summary</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_usage_summary":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"average_bandwidth_usage":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bandwidth_usage":&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;"license_usage":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"average_license_usage":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

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

@@ -0,0 +1,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../index.css" rel="stylesheet" type="text/css" />
<title>flex_bundle</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">flex_bundle</p>
<P>Configuration for Flex license bundle resource.</P>
<p class="heading">Read/write properties</p>
<p class="heading">Read only properties</p>
<p class="property_name">entitled_units<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Entitled free flex license units.</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Display name of flex bundle parameter.</p>
<p class="property_name">spec<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Specification of flex license bundle.</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/flex_bundle</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/flex_bundle<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 flex_bundle 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/flex_bundle<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the flex_bundle 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/flex_bundle<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of flex_bundle 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, "flex_bundle":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"entitled_units":&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;"spec":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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

@@ -0,0 +1,35 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../index.css" rel="stylesheet" type="text/css" />
<title>las_license_info</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">las_license_info</p>
<P>Configuration for LAS License Feature Information resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">pem<span class="property_type">&lt;String&gt;</span></p><p class="property_description">PEM.</p>
<p class="property_name">licenseproductname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">License Product Name.</p>
<p class="property_name">licensemodel<span class="property_type">&lt;String&gt;</span></p><p class="property_description">License Model.</p>
<p class="property_name">licensesadate<span class="property_type">&lt;String&gt;</span></p><p class="property_description">License Subscription Advantage Date.</p>
<p class="property_name">licensetype<span class="property_type">&lt;String&gt;</span></p><p class="property_description">License Type.</p>
<p class="property_name">uniq_param<span class="property_type">&lt;String&gt;</span></p><p class="property_description">uniq_param combination of pem, licenseexpirydate and licensetype.</p>
<p class="property_name">licenseexpdate<span class="property_type">&lt;String&gt;</span></p><p class="property_description">License Expiration Date.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">.</p>
<p class="property_name">vendorstring<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Vendor String.</p>
<p class="property_name">token_exp<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Token Exp.</p>
<p class="property_name">localizedlicenseproductname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Localized License Product Name.</p>
<p class="property_name">licensesavailable<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Licenses Available.</p>
<p class="property_name">licenseedition<span class="property_type">&lt;String&gt;</span></p><p class="property_description">License Edition.</p>
<p class="property_name">token_nbf<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Token Nbf.</p>
<p class="property_name">localizedlicenseedition<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Localized License Edition.</p>
<p class="property_name">licenseoverdraft<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">License Overdraft.</p>
<p class="property_name">localizedlicensetype<span class="property_type">&lt;String&gt;</span></p><p class="property_description">localized License Type.</p>
<p class="property_name">localizedlicensemodel<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Localized License Model.</p>
<p class="property_name">licensesinuse<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Licenses In Use.</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>

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

@@ -0,0 +1,20 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../index.css" rel="stylesheet" type="text/css" />
<title>license_config</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">license_config</p>
<P>Configuration for License Configuration 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">System generated value.</p>
<p class="property_name">policyName<span class="property_type">&lt;String&gt;</span></p><p class="property_description">policyName.<br> Minimum length = 1<br> Maximum length = 256</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Addresse list.</p>
<p class="property_name">max_limit<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Max limit.</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><a href="#apply" class="operation">apply</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/license_config</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, "license_config":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"policyName":&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;"max_limit":&lt;Integer_value&gt;</font>}]}</p><p class="heading"><a name="apply">apply</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/license_config/id_value&lt;String&gt;?action=apply&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">{"license_config": { }}</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}
</body>
</html>

22
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Licenses/license_expiry_info.html Normal file
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>license_expiry_info</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">license_expiry_info</p>
<P>Configuration for NetScaler Console License Expiry Information resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">feature<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Feature Name.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Id is system generated key.</p>
<p class="property_name">expirycount<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Expiry Count.</p>
<p class="property_name">expirydays<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Expiry Days.</p>
<p class="property_name">contract_expiry<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Contract Expiry Days.</p>
<p class="property_name">licensetype<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Type of license: RetailS etc.</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/license_expiry_info</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, "license_expiry_info":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"feature":&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;"expirycount":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"expirydays":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contract_expiry":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"licensetype":&lt;String_value&gt;</font>}]}</p>
</body>
</html>

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

File diff suppressed because one or more lines are too long

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

@@ -0,0 +1,28 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../index.css" rel="stylesheet" type="text/css" />
<title>license_info</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">license_info</p>
<P>Configuration for License Information resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">sync_operation<span class="property_type">&lt;Boolean&gt;</span></p><p class="property_description">sync operation.</p>
<p class="property_name">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">System generated value.</p>
<p class="heading">Read only properties</p>
<p class="property_name">product<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Product.</p>
<p class="property_name">feature<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Feature.</p>
<p class="property_name">license_type<span class="property_type">&lt;String&gt;</span></p><p class="property_description">License Type [Retail, NFR, Eval, TP, System].</p>
<p class="property_name">burst_license_available<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Burst license available for this license.</p>
<p class="property_name">vpx_license_used<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total license used by ADC/SDX.</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">user_info<span class="property_type">&lt;license_user_detail[]&gt;</span></p><p class="property_description">userInfo.</p>
<p class="property_name">license_used<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Used Licenses.</p>
<p class="property_name">license_available<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Available Licenses.</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="#apply" class="operation">apply</a><a href="#get" class="operation">get</a><p class="heading"><a name="apply">apply</a></p><p class="key">URL:<span class="url_value">https://&lt;MGMT-IP&gt;/nitro/v2/config/license_info/id_value&lt;String&gt;?action=apply&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">{"license_info": { }}</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}<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/license_info</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, "license_info":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"product":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"feature":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license_type":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"burst_license_available":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"vpx_license_used":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"act_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sync_operation":&lt;Boolean_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"user_info":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parent_id":&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;"node":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"display":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"no_of_license":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"parent_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"time":&lt;Integer_value&gt;</font>}],<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license_used":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license_available":&lt;Integer_value&gt;</font>}]}</p>
</body>
</html>

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

File diff suppressed because one or more lines are too long

41
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Licenses/license_threshold.html Normal file
View File

File diff suppressed because one or more lines are too long

25
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Licenses/license_usage_day.html Normal file
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>license_usage_day</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">license_usage_day</p>
<P>Configuration for NetScaler Usage information resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">bandwidth_usage<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Peak bandwidth usage of the Instance in a day.</p>
<p class="property_name">hostname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Host name of the device.</p>
<p class="property_name">timeslot<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Device usage information at this timestamp.</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">total_limit<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total license limit for the user (including burst).</p>
<p class="heading">Read only properties</p>
<p class="property_name">license_usage<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Peak License used by the NetScaler (Bandwidth/vCPU) in a day.</p>
<p class="property_name">license_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">License name for the device.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">IP Address of the 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="#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/license_usage_day</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, "license_usage_day":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bandwidth_usage":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hostname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license_usage":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeslot":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license_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;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_limit":&lt;Integer_value&gt;</font>}]}</p>
</body>
</html>

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

@@ -0,0 +1,23 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
<link href="../../index.css" rel="stylesheet" type="text/css" />
<title>license_usage_hour</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">license_usage_hour</p>
<P>Configuration for NetScaler Usage information resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">total_limit<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Total license limit for the user (including burst).</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">timeslot<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Device usage information at this timestamp.</p>
<p class="property_name">base_limit<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Base license limit for the user (excluding burst).</p>
<p class="heading">Read only properties</p>
<p class="property_name">license_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">License name for the device.</p>
<p class="property_name">license_usage<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">License used by the NetScaler (Bandwidth/vCPU).</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/license_usage_hour</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, "license_usage_hour":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"total_limit":&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;"license_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeslot":&lt;Double_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"base_limit":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license_usage":&lt;Integer_value&gt;</font>}]}</p>
</body>
</html>

22
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Licenses/license_usage_month.html Normal file
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>license_usage_month</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">license_usage_month</p>
<P>Configuration for NetScaler Usage information monthly report 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">timeslot<span class="property_type">&lt;Double&gt;</span></p><p class="property_description">Total Device usage information per month at this timestamp.</p>
<p class="heading">Read only properties</p>
<p class="property_name">max_license_usage<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Max license used in a month by NetScaler (Bandwidth/vCPU).</p>
<p class="property_name">max_burst_license_usage<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">Max burst license used in a month by NetScaler (Bandwidth/vCPU).</p>
<p class="property_name">license_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">License name for the 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="#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/license_usage_month</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, "license_usage_month":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"max_license_usage":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"max_burst_license_usage":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"license_name":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"timeslot":&lt;Double_value&gt;</font>}]}</p>
</body>
</html>

25
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Licenses/license_user_detail.html Normal file
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>license_user_detail</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">license_user_detail</p>
<P>Configuration for License User Information resource.</P>
<p class="heading">Read/write properties</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">id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">.</p>
<p class="property_name">parent_name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">.</p>
<p class="heading">Read only properties</p>
<p class="property_name">node<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Node.</p>
<p class="property_name">display<span class="property_type">&lt;String&gt;</span></p><p class="property_description">display.</p>
<p class="property_name">no_of_license<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">No of licenses.</p>
<p class="property_name">name<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Name.</p>
<p class="property_name">time<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">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>
</body>
</html>

22
docs/Reference Docs/mas_nitro-rest_14.1-60.54/html/Licenses/platform_license_expiry.html Normal file
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>platform_license_expiry</title>
</head>
<body class="ns_body">
<p class="ns_wp_header">platform_license_expiry</p>
<P>Configuration for MPX/SDX Platform license Expiry Information resource.</P>
<p class="heading">Read/write properties</p>
<p class="property_name">host_id<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Host ID of the device.</p>
<p class="property_name">serialnumber<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Serial Number of the device.</p>
<p class="property_name">ip_address<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Ip address of the MPX/SDX device.</p>
<p class="property_name">expirydays<span class="property_type">&lt;Integer&gt;</span></p><p class="property_description">No of days for license expiry.</p>
<p class="property_name">hostname<span class="property_type">&lt;String&gt;</span></p><p class="property_description">Hostname of the device.</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="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/platform_license_expiry</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, "platform_license_expiry":[{<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"host_id":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"serialnumber":&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;"expirydays":&lt;Integer_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hostname":&lt;String_value&gt;</font>,<br>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"instance_state":&lt;String_value&gt;</font>}]}</p>
</body>
</html>