28 lines
4.9 KiB
HTML
28 lines
4.9 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>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"><Double></span></p><p class="property_description">bandwidth usage of the Instance.</p>
|
|
<p class="property_name">hostname<span class="property_type"><String></span></p><p class="property_description">Host name of the device.</p>
|
|
<p class="property_name">timestamp<span class="property_type"><Double></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"><String></span></p><p class="property_description">Id is system generated key.</p>
|
|
<p class="property_name">total_limit<span class="property_type"><Integer></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"><Integer></span></p><p class="property_description">Base limit usage for the user (excluding burst).</p>
|
|
<p class="property_name">timeslot<span class="property_type"><Double></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"><Integer></span></p><p class="property_description">License used by the NetScaler (Bandwidth/vCPU).</p>
|
|
<p class="property_name">ip_address<span class="property_type"><String></span></p><p class="property_description">IP Address of the device.</p>
|
|
<p class="property_name">license_name<span class="property_type"><String></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\"> <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="#get" class="operation">get</a><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/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<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>, "device_usage":[{<br> "license_usage":<Integer_value></font>,<br> "bandwidth_usage":<Double_value></font>,<br> "hostname":<String_value></font>,<br> "timestamp":<Double_value></font>,<br> "ip_address":<String_value></font>,<br> "id":<String_value></font>,<br> "total_limit":<Integer_value></font>,<br> "base_limit":<Integer_value></font>,<br> "timeslot":<Double_value></font>,<br> "license_name":<String_value></font>}]}</p>
|
|
</body>
|
|
</html>
|