29 lines
7.0 KiB
HTML
29 lines
7.0 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>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"><Boolean></span></p><p class="property_description">sync operation.</p>
|
|
<p class="property_name">id<span class="property_type"><String></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"><String></span></p><p class="property_description">Product.</p>
|
|
<p class="property_name">feature<span class="property_type"><String></span></p><p class="property_description">Feature.</p>
|
|
<p class="property_name">license_type<span class="property_type"><String></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"><Integer></span></p><p class="property_description">Burst license available for this license.</p>
|
|
<p class="property_name">vpx_license_used<span class="property_type"><Integer></span></p><p class="property_description">Total license used by ADC/SDX.</p>
|
|
<p class="property_name">act_id<span class="property_type"><String></span></p><p class="property_description">Activity Id.</p>
|
|
<p class="property_name">user_info<span class="property_type"><license_user_detail[]></span></p><p class="property_description">userInfo.</p>
|
|
<p class="property_name">license_used<span class="property_type"><Integer></span></p><p class="property_description">Used Licenses.</p>
|
|
<p class="property_name">license_available<span class="property_type"><Integer></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\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#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://<MGMT-IP>/nitro/v2/config/license_info/id_value<String>?action=apply&onerror=<String_value></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<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">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": <String_value>}<p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/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<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "license_info":[{<br> "product":<String_value></font>,<br> "feature":<String_value></font>,<br> "license_type":<String_value></font>,<br> "burst_license_available":<Integer_value></font>,<br> "vpx_license_used":<Integer_value></font>,<br> "act_id":<String_value></font>,<br> "sync_operation":<Boolean_value></font>,<br> "id":<String_value></font>,<br> "user_info":[{<br> "parent_id":<String_value></font>,<br> "id":<String_value></font>,<br> "node":<String_value></font>,<br> "display":<String_value></font>,<br> "no_of_license":<Integer_value></font>,<br> "name":<String_value></font>,<br> "parent_name":<String_value></font>,<br> "time":<Integer_value></font>}],<br> "license_used":<Integer_value></font>,<br> "license_available":<Integer_value></font>}]}</p>
|
|
</body>
|
|
</html>
|