1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan PX2/PX3 JSON-RPC API: pdu-json-rpc-api/idl/Diagnostics.idl Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Raritan PX2/PX3 JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6f2e57e4ed4c9ccdca310d1229964312.html">pdu-json-rpc-api</a></li><li class="navelem"><a class="el" href="dir_8ea0db9e05c169824aafe6441489b6ed.html">idl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Diagnostics.idl</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* SPDX-License-Identifier: BSD-3-Clause */</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2010 Raritan Inc. All rights reserved.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/**</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Network Configuration</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> */</span></div><div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="namespacenet.html"> 9</a></span> module <a class="code" href="namespacenet.html">net</a> {</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> /** Diagnostics interface */</span></div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="interfacenet_1_1Diagnostics.html"> 12</a></span>  <span class="keyword">interface </span><a class="code" href="interfacenet_1_1Diagnostics.html">Diagnostics</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="interfacenet_1_1Diagnostics.html#a91f78e514ef273ebf095dc55ee9f1734"> 13</a></span>  constant <span class="keywordtype">int</span> NO_ERROR = 0; <span class="comment">///< No error</span></div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="interfacenet_1_1Diagnostics.html#a7b152e8a175a4c40cb43249a915b0cf0"> 14</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_INVALID_PARAM = 1; <span class="comment">///< Invalid parameters</span></div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="interfacenet_1_1Diagnostics.html#acf232243f033963e64661a5d6336c5ea"> 15</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_EXEC_FAIL = 2; <span class="comment">///< Error during execution</span></div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="interfacenet_1_1Diagnostics.html#acbc36ba97db5adc7039ffff172d91d59"> 16</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_TIMEOUT = 3; <span class="comment">///< Timeout</span></div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="interfacenet_1_1Diagnostics.html#a8f9aba0cc98b18d9ff2ddf2a745502bd"> 17</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_RESOLVE_FAIL = 4; <span class="comment">///< Name resolution failure</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span><span class="comment"></span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> /**</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Ping a network host (send out ICMP echo requests)</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * </span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * @param hostName host that should be pinged</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * @param count number of echo requests that should be sent (up to 20)</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * @param results output of the ping command</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> *</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * @return NO_ERROR if ping command was successful</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * @return ERR_INVALID_PARAM if any parameters were invalid</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * @return ERR_EXEC_FAIL if there was an error during ping execution</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * @return ERR_RESOLVE_FAIL if the host name could not be resolved</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> */</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordtype">int</span> ping(in <span class="keywordtype">string</span> hostName, in <span class="keywordtype">int</span> count, out vector<string> results);</div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"></span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> /**</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * Get the route packet trace to a network host</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * @param hostName destination host to track</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * @param timeout Timeout (in seconds) to wait for traceroute results (up to 900)</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * @param useIcmp use ICMP packets instead of UDP packets</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @param results trace output</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> *</span></div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"> * @return NO_ERROR if traceroute was successful</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * @return ERR_INVALID_PARAM if any parameters were invalid</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> * @return ERR_EXEC_FAIL if there was an error during traceroute execution</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * @return ERR_TIMEOUT if traceroute didn't finish before timeout elapsed</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> * @return ERR_RESOLVE_FAIL if the host name could not be resolved</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> */</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">int</span> traceRoute(in <span class="keywordtype">string</span> hostName, in <span class="keywordtype">int</span> timeout,</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  in <span class="keywordtype">boolean</span> useIcmp, out vector<string> results);</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"></span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> /**</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> * List the currently active TCP connections (netstat -ta)</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> * (lists both listening as well as established connections)</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> *</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> * @return NO_ERROR if netstat was successful</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * @return ERR_EXEC_FAIL if there was an error during netstat execution</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> */</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">int</span> listTcpConnections(out vector<string> results);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  };</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> }</div><div class="ttc" id="namespacenet_html"><div class="ttname"><a href="namespacenet.html">net</a></div><div class="ttdoc">Network Configuration. </div><div class="ttdef"><b>Definition:</b> Diagnostics.idl:9</div></div>
<div class="ttc" id="interfacenet_1_1Diagnostics_html"><div class="ttname"><a href="interfacenet_1_1Diagnostics.html">net::Diagnostics</a></div><div class="ttdoc">Diagnostics interface. </div><div class="ttdef"><b>Definition:</b> Diagnostics.idl:12</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 21 2020 10:20:37 for Raritan PX2/PX3 JSON-RPC API by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.14
</small></address>
</body>
</html>
|
