34 lines
7.5 KiB
HTML
34 lines
7.5 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>ns_filediff</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">ns_filediff</p>
|
|
<P>Configuration for monitoring file list diff present in nsconfig folder of NetScaler instances resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">diff_summary<span class="property_type"><String></span></p><p class="property_description">diff summary.</p>
|
|
<p class="property_name">previous_filelist_details<span class="property_type"><String></span></p><p class="property_description">Comma separated list of files under nsconfig folder found in previous poll.</p>
|
|
<p class="property_name">host_name<span class="property_type"><String></span></p><p class="property_description">host name.</p>
|
|
<p class="property_name">diff_exists<span class="property_type"><String></span></p><p class="property_description">Diff exists. Possible values No Diff,NA,Diff Exists.</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">latest_filelist_details<span class="property_type"><String></span></p><p class="property_description">Comma separated list of files under nsconfig folder found in latest poll.</p>
|
|
<p class="property_name">display_name<span class="property_type"><String></span></p><p class="property_description">display name .</p>
|
|
<p class="property_name">total_count<span class="property_type"><Integer></span></p><p class="property_description">Total count available .</p>
|
|
<p class="property_name">file_name<span class="property_type"><String></span></p><p class="property_description">file name.</p>
|
|
<p class="property_name">filediff_na_count<span class="property_type"><Integer></span></p><p class="property_description">Total file diff not applicable count .</p>
|
|
<p class="property_name">filediff_count<span class="property_type"><Integer></span></p><p class="property_description">Total file diff count .</p>
|
|
<p class="property_name">last_modified<span class="property_type"><Double></span></p><p class="property_description">last modified timestamp of the file.</p>
|
|
<p class="property_name">diff_status<span class="property_type"><String></span></p><p class="property_description">diff status of the file. Possible values: added,modified,deleted.</p>
|
|
<p class="heading">Read only properties</p>
|
|
<p class="property_name">previous_polled_timestamp<span class="property_type"><Double></span></p><p class="property_description">Previous polled timestamp.</p>
|
|
<p class="property_name">latest_polled_timestamp<span class="property_type"><Double></span></p><p class="property_description">Latest polled timestamp.</p>
|
|
<p class="property_name">ip_address<span class="property_type"><String></span></p><p class="property_description">IP Address of NetScaler 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_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://<MGMT-IP>/nitro/v2/config/ns_filediff</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://<MGMT-IP>/nitro/v2/config/ns_filediff<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_filediff 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://<MGMT-IP>/nitro/v2/config/ns_filediff<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the ns_filediff resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/ns_filediff<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of ns_filediff 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<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>, "ns_filediff":[{<br> "diff_summary":<String_value></font>,<br> "previous_filelist_details":<String_value></font>,<br> "host_name":<String_value></font>,<br> "diff_exists":<String_value></font>,<br> "id":<String_value></font>,<br> "latest_filelist_details":<String_value></font>,<br> "previous_polled_timestamp":<Double_value></font>,<br> "display_name":<String_value></font>,<br> "latest_polled_timestamp":<Double_value></font>,<br> "ip_address":<String_value></font>,<br> "total_count":<Integer_value></font>,<br> "file_name":<String_value></font>,<br> "filediff_na_count":<Integer_value></font>,<br> "filediff_count":<Integer_value></font>,<br> "last_modified":<Double_value></font>,<br> "diff_status":<String_value></font>}]}</p>
|
|
</body>
|
|
</html>
|