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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
|
<!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: net::Diagnostics Interface Reference</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="namespacenet.html">net</a></li><li class="navelem"><a class="el" href="interfacenet_1_1Diagnostics.html">Diagnostics</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="interfacenet_1_1Diagnostics-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">net::Diagnostics Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="interfacenet_1_1Diagnostics.html" title="Diagnostics interface. ">Diagnostics</a> interface.
<a href="interfacenet_1_1Diagnostics.html#details">More...</a></p>
<p><code>import"<a class="el" href="Diagnostics_8idl_source.html">Diagnostics.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a4c0900c5fc46f0ea73d10c962b60fc6f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacenet_1_1Diagnostics.html#a4c0900c5fc46f0ea73d10c962b60fc6f">ping</a> (in string hostName, in int count, out vector< string > results)</td></tr>
<tr class="memdesc:a4c0900c5fc46f0ea73d10c962b60fc6f"><td class="mdescLeft"> </td><td class="mdescRight">Ping a network host (send out ICMP echo requests) <a href="#a4c0900c5fc46f0ea73d10c962b60fc6f">More...</a><br /></td></tr>
<tr class="separator:a4c0900c5fc46f0ea73d10c962b60fc6f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a82c7566fb8a05e4335d2edec0c682cdf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacenet_1_1Diagnostics.html#a82c7566fb8a05e4335d2edec0c682cdf">traceRoute</a> (in string hostName, in int timeout, in boolean useIcmp, out vector< string > results)</td></tr>
<tr class="memdesc:a82c7566fb8a05e4335d2edec0c682cdf"><td class="mdescLeft"> </td><td class="mdescRight">Get the route packet trace to a network host. <a href="#a82c7566fb8a05e4335d2edec0c682cdf">More...</a><br /></td></tr>
<tr class="separator:a82c7566fb8a05e4335d2edec0c682cdf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3bf9fd1bb702bfb59934b372a5e4f222"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacenet_1_1Diagnostics.html#a3bf9fd1bb702bfb59934b372a5e4f222">listTcpConnections</a> (out vector< string > results)</td></tr>
<tr class="memdesc:a3bf9fd1bb702bfb59934b372a5e4f222"><td class="mdescLeft"> </td><td class="mdescRight">List the currently active TCP connections (netstat -ta) (lists both listening as well as established connections) <a href="#a3bf9fd1bb702bfb59934b372a5e4f222">More...</a><br /></td></tr>
<tr class="separator:a3bf9fd1bb702bfb59934b372a5e4f222"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a91f78e514ef273ebf095dc55ee9f1734"><td class="memItemLeft" align="right" valign="top"><a id="a91f78e514ef273ebf095dc55ee9f1734"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacenet_1_1Diagnostics.html#a91f78e514ef273ebf095dc55ee9f1734">NO_ERROR</a> = 0</td></tr>
<tr class="memdesc:a91f78e514ef273ebf095dc55ee9f1734"><td class="mdescLeft"> </td><td class="mdescRight">No error. <br /></td></tr>
<tr class="separator:a91f78e514ef273ebf095dc55ee9f1734"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b152e8a175a4c40cb43249a915b0cf0"><td class="memItemLeft" align="right" valign="top"><a id="a7b152e8a175a4c40cb43249a915b0cf0"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacenet_1_1Diagnostics.html#a7b152e8a175a4c40cb43249a915b0cf0">ERR_INVALID_PARAM</a> = 1</td></tr>
<tr class="memdesc:a7b152e8a175a4c40cb43249a915b0cf0"><td class="mdescLeft"> </td><td class="mdescRight">Invalid parameters. <br /></td></tr>
<tr class="separator:a7b152e8a175a4c40cb43249a915b0cf0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acf232243f033963e64661a5d6336c5ea"><td class="memItemLeft" align="right" valign="top"><a id="acf232243f033963e64661a5d6336c5ea"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacenet_1_1Diagnostics.html#acf232243f033963e64661a5d6336c5ea">ERR_EXEC_FAIL</a> = 2</td></tr>
<tr class="memdesc:acf232243f033963e64661a5d6336c5ea"><td class="mdescLeft"> </td><td class="mdescRight">Error during execution. <br /></td></tr>
<tr class="separator:acf232243f033963e64661a5d6336c5ea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acbc36ba97db5adc7039ffff172d91d59"><td class="memItemLeft" align="right" valign="top"><a id="acbc36ba97db5adc7039ffff172d91d59"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacenet_1_1Diagnostics.html#acbc36ba97db5adc7039ffff172d91d59">ERR_TIMEOUT</a> = 3</td></tr>
<tr class="memdesc:acbc36ba97db5adc7039ffff172d91d59"><td class="mdescLeft"> </td><td class="mdescRight">Timeout. <br /></td></tr>
<tr class="separator:acbc36ba97db5adc7039ffff172d91d59"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8f9aba0cc98b18d9ff2ddf2a745502bd"><td class="memItemLeft" align="right" valign="top"><a id="a8f9aba0cc98b18d9ff2ddf2a745502bd"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacenet_1_1Diagnostics.html#a8f9aba0cc98b18d9ff2ddf2a745502bd">ERR_RESOLVE_FAIL</a> = 4</td></tr>
<tr class="memdesc:a8f9aba0cc98b18d9ff2ddf2a745502bd"><td class="mdescLeft"> </td><td class="mdescRight">Name resolution failure. <br /></td></tr>
<tr class="separator:a8f9aba0cc98b18d9ff2ddf2a745502bd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="interfacenet_1_1Diagnostics.html" title="Diagnostics interface. ">Diagnostics</a> interface. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a3bf9fd1bb702bfb59934b372a5e4f222"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3bf9fd1bb702bfb59934b372a5e4f222">◆ </a></span>listTcpConnections()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int net::Diagnostics::listTcpConnections </td>
<td>(</td>
<td class="paramtype">out vector< string > </td>
<td class="paramname"><em>results</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>List the currently active TCP connections (netstat -ta) (lists both listening as well as established connections) </p>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR if netstat was successful </dd>
<dd>
ERR_EXEC_FAIL if there was an error during netstat execution </dd></dl>
</div>
</div>
<a id="a4c0900c5fc46f0ea73d10c962b60fc6f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c0900c5fc46f0ea73d10c962b60fc6f">◆ </a></span>ping()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int net::Diagnostics::ping </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>hostName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in int </td>
<td class="paramname"><em>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out vector< string > </td>
<td class="paramname"><em>results</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ping a network host (send out ICMP echo requests) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hostName</td><td>host that should be pinged </td></tr>
<tr><td class="paramname">count</td><td>number of echo requests that should be sent (up to 20) </td></tr>
<tr><td class="paramname">results</td><td>output of the ping command</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR if ping command was successful </dd>
<dd>
ERR_INVALID_PARAM if any parameters were invalid </dd>
<dd>
ERR_EXEC_FAIL if there was an error during ping execution </dd>
<dd>
ERR_RESOLVE_FAIL if the host name could not be resolved </dd></dl>
</div>
</div>
<a id="a82c7566fb8a05e4335d2edec0c682cdf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a82c7566fb8a05e4335d2edec0c682cdf">◆ </a></span>traceRoute()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int net::Diagnostics::traceRoute </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>hostName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in int </td>
<td class="paramname"><em>timeout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in boolean </td>
<td class="paramname"><em>useIcmp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out vector< string > </td>
<td class="paramname"><em>results</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the route packet trace to a network host. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">hostName</td><td>destination host to track </td></tr>
<tr><td class="paramname">timeout</td><td>Timeout (in seconds) to wait for traceroute results (up to 900) </td></tr>
<tr><td class="paramname">useIcmp</td><td>use ICMP packets instead of UDP packets </td></tr>
<tr><td class="paramname">results</td><td>trace output</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>NO_ERROR if traceroute was successful </dd>
<dd>
ERR_INVALID_PARAM if any parameters were invalid </dd>
<dd>
ERR_EXEC_FAIL if there was an error during traceroute execution </dd>
<dd>
ERR_TIMEOUT if traceroute didn't finish before timeout elapsed </dd>
<dd>
ERR_RESOLVE_FAIL if the host name could not be resolved </dd></dl>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li>pdu-json-rpc-api/idl/<a class="el" href="Diagnostics_8idl_source.html">Diagnostics.idl</a></li>
</ul>
</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>
|
