24 lines
7.0 KiB
HTML
24 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>af_templates</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">af_templates</p>
|
|
<P>Configuration for AF Templates resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">observationPointId<span class="property_type"><Integer></span></p><p class="property_description">Observation Point ID.</p>
|
|
<p class="property_name">template_field_length<span class="property_type"><Integer></span></p><p class="property_description">Template Field Length.</p>
|
|
<p class="property_name">template_field_name<span class="property_type"><String></span></p><p class="property_description">Templates field names..<br> Minimum length = 1<br> Maximum length = 255</p>
|
|
<p class="property_name">template_rx_time<span class="property_type"><Double></span></p><p class="property_description">Start Time.</p>
|
|
<p class="property_name">template_field_id<span class="property_type"><Integer></span></p><p class="property_description">Protocol.</p>
|
|
<p class="property_name">template_id<span class="property_type"><Integer></span></p><p class="property_description">AF Template ID.</p>
|
|
<p class="property_name">exporter_id<span class="property_type"><Double></span></p><p class="property_description">The exporter ID mapping back to the af_exporter table.</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="#modify" class="operation">modify</a><a href="#get_all" class="operation">get (all)</a><p class="heading"><a name="modify">modify</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/af_templates/<p class="key">Query-parameters:<span class="url_value"></span></p></span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">HTTPS 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">{"af_templates":{<br><font color=#FF0000><b> "template_id":<Integer_value></b></font>,<br><font color=#FF0000><b> "exporter_id":<Double_value></b></font>,<br><font color=#000000> "observationPointId":<Integer_value></font>,<br><font color=#000000> "template_field_length":<Integer_value></font>,<br><font color=#000000> "template_field_id":<Integer_value></font>,<br><font color=#000000> "template_field_name":<String_value></font>,<br><font color=#000000> "template_rx_time":<Double_value></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": <String_value>, "af_templates":[{<br> "observationPointId":<Integer_value></font>,<br> "template_field_length":<Integer_value></font>,<br> "template_field_name":<String_value></font>,<br> "template_rx_time":<Double_value></font>,<br> "template_field_id":<Integer_value></font>,<br> "template_id":<Integer_value></font>,<br> "exporter_id":<Double_value></font>}]}</p><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/af_templates</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">HTTPS 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>, "af_templates":[{<br> "observationPointId":<Integer_value></font>,<br> "template_field_length":<Integer_value></font>,<br> "template_field_name":<String_value></font>,<br> "template_rx_time":<Double_value></font>,<br> "template_field_id":<Integer_value></font>,<br> "template_id":<Integer_value></font>,<br> "exporter_id":<Double_value></font>}]}</p>
|
|
</body>
|
|
</html>
|