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
|
<!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/Snmp.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">Snmp.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 2009 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> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <Event.idl></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"></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"> 9</span> <span class="comment"> * Device Settings</span></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> module <a class="code" href="namespacedevsettings.html">devsettings</a> {</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> /** SNMP agent settings interface */</span></div><div class="line"><a name="l00014"></a><span class="lineno"><a class="line" href="interfacedevsettings_1_1Snmp__1__0__2.html"> 14</a></span>  <span class="keyword">interface </span><a class="code" href="interfacedevsettings_1_1Snmp__1__0__2.html">Snmp_1_0_2</a> {</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> </div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="interfacedevsettings_1_1Snmp__1__0__2.html#ad4adfee450b8c8bd7a6b3ae80f8c2b0d"> 16</a></span>  constant <span class="keywordtype">int</span> ERR_INVALID_PARAMS = 1; <span class="comment">///< Invalid parameters</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span><span class="comment"></span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> /** SNMP agent configuration */</span></div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html"> 19</a></span>  structure <a class="code" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html">Configuration</a> {</div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a09cfc874d14e1ba083004fbe6a66ac28"> 20</a></span>  <span class="keywordtype">boolean</span> <a class="code" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a09cfc874d14e1ba083004fbe6a66ac28">v2enable</a>; <span class="comment">///< SNMP v1 / 2c enabled</span></div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a717aa9995f29cb9fc213809d93bfa7dc"> 21</a></span> <span class="comment"></span> <span class="keywordtype">boolean</span> <a class="code" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a717aa9995f29cb9fc213809d93bfa7dc">v3enable</a>; <span class="comment">///< SNMP v3 enabled</span></div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#adf499ba87c0fac90d67bd2a344e4a35e"> 22</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#adf499ba87c0fac90d67bd2a344e4a35e">readComm</a>; <span class="comment">///< read community string</span></div><div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#aa79365d91e9d61808615d87a7120474b"> 23</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#aa79365d91e9d61808615d87a7120474b">writeComm</a>; <span class="comment">///< write community string</span></div><div class="line"><a name="l00024"></a><span class="lineno"><a class="line" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a1908415949d87fb5e9eff7f17daf71c6"> 24</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a1908415949d87fb5e9eff7f17daf71c6">sysContact</a>; <span class="comment">///< system contact</span></div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a7f22b8d9d17e74f38f28238cde747496"> 25</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a7f22b8d9d17e74f38f28238cde747496">sysName</a>; <span class="comment">///< system name</span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a24f5f3c8f227f0a947335a386051b8be"> 26</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a24f5f3c8f227f0a947335a386051b8be">sysLocation</a>; <span class="comment">///< system location</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span> };</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  valueobject ConfigurationChangedEvent extends <a class="code" href="namespaceidl.html">idl</a>.Event {</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="interfacedevsettings_1_1Snmp__1__0__2.html#a880fb18a905db6b9f31ad6b0e80f138c"> 30</a></span>  <span class="keywordtype">string</span> userName; <span class="comment">///< user who triggered event</span></div><div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="interfacedevsettings_1_1Snmp__1__0__2.html#acc59ae92253be99be7f6b5d46ab3028f"> 31</a></span> <span class="comment"></span> <span class="keywordtype">string</span> <a class="code" href="interfacedevsettings_1_1Snmp__1__0__2.html#acc59ae92253be99be7f6b5d46ab3028f">ipAddr</a>; <span class="comment">///< ip or device on which user is logged in</span></div><div class="line"><a name="l00032"></a><span class="lineno"><a class="line" href="interfacedevsettings_1_1Snmp__1__0__2.html#ac7ca3c3d1e240230dbf557c1eaaffcee"> 32</a></span> <span class="comment"></span> <a class="code" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html">Configuration</a> <a class="code" href="interfacedevsettings_1_1Snmp__1__0__2.html#ac7ca3c3d1e240230dbf557c1eaaffcee">oldConfig</a>; <span class="comment">///< old configuration</span></div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="interfacedevsettings_1_1Snmp__1__0__2.html#a3edcc4f57dba656eab835dd758eb7005"> 33</a></span> <span class="comment"></span> <a class="code" href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html">Configuration</a> <a class="code" href="interfacedevsettings_1_1Snmp__1__0__2.html#a3edcc4f57dba656eab835dd758eb7005">newConfig</a>; <span class="comment">///< new configuration</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></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"> /**</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> * Retrieve the SNMP agent configuration.</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> *</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * @return SNMP agent configuration</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>  Configuration getConfiguration();</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"></span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /**</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> * Set the SNMP agent configuration.</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> *</span></div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * @param cfg New SNMP agent settings</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> *</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * @return 1 if any parameters are invalid</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="keywordtype">int</span> setConfiguration(in Configuration cfg);</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></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"> * Retrieve the SNMP V3 Engine ID.</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> *</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * @return SNMP V3 Engine ID</span></div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> */</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keywordtype">string</span> getV3EngineId();</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="line"><a name="l00061"></a><span class="lineno"> 61</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> }</div><div class="ttc" id="structdevsettings_1_1Snmp__1__0__2_1_1Configuration_html_adf499ba87c0fac90d67bd2a344e4a35e"><div class="ttname"><a href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#adf499ba87c0fac90d67bd2a344e4a35e">devsettings::Snmp_1_0_2::Configuration::readComm</a></div><div class="ttdeci">string readComm</div><div class="ttdoc">read community string </div><div class="ttdef"><b>Definition:</b> Snmp.idl:22</div></div>
<div class="ttc" id="structdevsettings_1_1Snmp__1__0__2_1_1Configuration_html_a7f22b8d9d17e74f38f28238cde747496"><div class="ttname"><a href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a7f22b8d9d17e74f38f28238cde747496">devsettings::Snmp_1_0_2::Configuration::sysName</a></div><div class="ttdeci">string sysName</div><div class="ttdoc">system name </div><div class="ttdef"><b>Definition:</b> Snmp.idl:25</div></div>
<div class="ttc" id="structdevsettings_1_1Snmp__1__0__2_1_1Configuration_html_a717aa9995f29cb9fc213809d93bfa7dc"><div class="ttname"><a href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a717aa9995f29cb9fc213809d93bfa7dc">devsettings::Snmp_1_0_2::Configuration::v3enable</a></div><div class="ttdeci">boolean v3enable</div><div class="ttdoc">SNMP v3 enabled. </div><div class="ttdef"><b>Definition:</b> Snmp.idl:21</div></div>
<div class="ttc" id="interfacedevsettings_1_1Snmp__1__0__2_html"><div class="ttname"><a href="interfacedevsettings_1_1Snmp__1__0__2.html">devsettings::Snmp_1_0_2</a></div><div class="ttdoc">SNMP agent settings interface. </div><div class="ttdef"><b>Definition:</b> Snmp.idl:14</div></div>
<div class="ttc" id="structdevsettings_1_1Snmp__1__0__2_1_1Configuration_html_a1908415949d87fb5e9eff7f17daf71c6"><div class="ttname"><a href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a1908415949d87fb5e9eff7f17daf71c6">devsettings::Snmp_1_0_2::Configuration::sysContact</a></div><div class="ttdeci">string sysContact</div><div class="ttdoc">system contact </div><div class="ttdef"><b>Definition:</b> Snmp.idl:24</div></div>
<div class="ttc" id="namespaceidl_html"><div class="ttname"><a href="namespaceidl.html">idl</a></div><div class="ttdoc">Basic IDL definitions. </div><div class="ttdef"><b>Definition:</b> Event.idl:10</div></div>
<div class="ttc" id="namespacedevsettings_html"><div class="ttname"><a href="namespacedevsettings.html">devsettings</a></div><div class="ttdoc">Device Settings. </div><div class="ttdef"><b>Definition:</b> Modbus.idl:9</div></div>
<div class="ttc" id="interfacedevsettings_1_1Snmp__1__0__2_html_ac7ca3c3d1e240230dbf557c1eaaffcee"><div class="ttname"><a href="interfacedevsettings_1_1Snmp__1__0__2.html#ac7ca3c3d1e240230dbf557c1eaaffcee">devsettings::Snmp_1_0_2::oldConfig</a></div><div class="ttdeci">Configuration oldConfig</div><div class="ttdoc">old configuration </div><div class="ttdef"><b>Definition:</b> Snmp.idl:32</div></div>
<div class="ttc" id="structdevsettings_1_1Snmp__1__0__2_1_1Configuration_html_aa79365d91e9d61808615d87a7120474b"><div class="ttname"><a href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#aa79365d91e9d61808615d87a7120474b">devsettings::Snmp_1_0_2::Configuration::writeComm</a></div><div class="ttdeci">string writeComm</div><div class="ttdoc">write community string </div><div class="ttdef"><b>Definition:</b> Snmp.idl:23</div></div>
<div class="ttc" id="interfacedevsettings_1_1Snmp__1__0__2_html_acc59ae92253be99be7f6b5d46ab3028f"><div class="ttname"><a href="interfacedevsettings_1_1Snmp__1__0__2.html#acc59ae92253be99be7f6b5d46ab3028f">devsettings::Snmp_1_0_2::ipAddr</a></div><div class="ttdeci">string ipAddr</div><div class="ttdoc">ip or device on which user is logged in </div><div class="ttdef"><b>Definition:</b> Snmp.idl:31</div></div>
<div class="ttc" id="interfacedevsettings_1_1Snmp__1__0__2_html_a3edcc4f57dba656eab835dd758eb7005"><div class="ttname"><a href="interfacedevsettings_1_1Snmp__1__0__2.html#a3edcc4f57dba656eab835dd758eb7005">devsettings::Snmp_1_0_2::newConfig</a></div><div class="ttdeci">Configuration newConfig</div><div class="ttdoc">new configuration </div><div class="ttdef"><b>Definition:</b> Snmp.idl:33</div></div>
<div class="ttc" id="structdevsettings_1_1Snmp__1__0__2_1_1Configuration_html"><div class="ttname"><a href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html">devsettings::Snmp_1_0_2::Configuration</a></div><div class="ttdoc">SNMP agent configuration. </div><div class="ttdef"><b>Definition:</b> Snmp.idl:19</div></div>
<div class="ttc" id="structdevsettings_1_1Snmp__1__0__2_1_1Configuration_html_a24f5f3c8f227f0a947335a386051b8be"><div class="ttname"><a href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a24f5f3c8f227f0a947335a386051b8be">devsettings::Snmp_1_0_2::Configuration::sysLocation</a></div><div class="ttdeci">string sysLocation</div><div class="ttdoc">system location </div><div class="ttdef"><b>Definition:</b> Snmp.idl:26</div></div>
<div class="ttc" id="structdevsettings_1_1Snmp__1__0__2_1_1Configuration_html_a09cfc874d14e1ba083004fbe6a66ac28"><div class="ttname"><a href="structdevsettings_1_1Snmp__1__0__2_1_1Configuration.html#a09cfc874d14e1ba083004fbe6a66ac28">devsettings::Snmp_1_0_2::Configuration::v2enable</a></div><div class="ttdeci">boolean v2enable</div><div class="ttdoc">SNMP v1 / 2c enabled. </div><div class="ttdef"><b>Definition:</b> Snmp.idl:20</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>
|
