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
|
<!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: usermgmt Module 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">usermgmt Module Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>User Management
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structusermgmt_1_1Account.html">Account</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Account information <a href="structusermgmt_1_1Account.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structusermgmt_1_1AuxInfo.html">AuxInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Auxiliary user information. <a href="structusermgmt_1_1AuxInfo.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structusermgmt_1_1Preferences.html">Preferences</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">User preferences <a href="structusermgmt_1_1Preferences.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1Role.html">Role</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Role management interface <a href="interfaceusermgmt_1_1Role.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1RoleManager.html">RoleManager</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="interfaceusermgmt_1_1Role.html" title="Role management interface ">Role</a> manager interface. <a href="interfaceusermgmt_1_1RoleManager.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structusermgmt_1_1SnmpV3Settings.html">SnmpV3Settings</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">SNMPv3 settings. <a href="structusermgmt_1_1SnmpV3Settings.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User__1__0__2.html">User_1_0_2</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">User interface <a href="interfaceusermgmt_1_1User__1__0__2.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structusermgmt_1_1UserCapabilities.html">UserCapabilities</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">User Capabilities Describe if certain operations can be performed for user. <a href="structusermgmt_1_1UserCapabilities.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structusermgmt_1_1UserInfo.html">UserInfo</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">User information <a href="structusermgmt_1_1UserInfo.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">interface  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html">UserManager_1_0_4</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">User manager interface <a href="interfaceusermgmt_1_1UserManager__1__0__4.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ab66d685f013e7ef2f71c37e8767bd4ab"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceusermgmt.html#ab66d685f013e7ef2f71c37e8767bd4ab">TemperatureEnum</a> { <a class="el" href="namespaceusermgmt.html#ab66d685f013e7ef2f71c37e8767bd4abad2de83462cce75d1124a41432ef0ebeb">DEG_C</a>,
<a class="el" href="namespaceusermgmt.html#ab66d685f013e7ef2f71c37e8767bd4abac71266398aa0227ce49b733da57d0ac6">DEG_F</a>
}</td></tr>
<tr class="memdesc:ab66d685f013e7ef2f71c37e8767bd4ab"><td class="mdescLeft"> </td><td class="mdescRight">Preferred display unit for temperature sensors. <a href="namespaceusermgmt.html#ab66d685f013e7ef2f71c37e8767bd4ab">More...</a><br /></td></tr>
<tr class="separator:ab66d685f013e7ef2f71c37e8767bd4ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aecbd81d7d63597af453ac7777452bbf7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceusermgmt.html#aecbd81d7d63597af453ac7777452bbf7">LengthEnum</a> { <a class="el" href="namespaceusermgmt.html#aecbd81d7d63597af453ac7777452bbf7aef936c6458a810334e99f98247d18d23">METER</a>,
<a class="el" href="namespaceusermgmt.html#aecbd81d7d63597af453ac7777452bbf7a5cd77f41da1fb856662d1536c2235ce6">FEET</a>
}</td></tr>
<tr class="memdesc:aecbd81d7d63597af453ac7777452bbf7"><td class="mdescLeft"> </td><td class="mdescRight">Preferred display unit for length measurements, e.g. <a href="namespaceusermgmt.html#aecbd81d7d63597af453ac7777452bbf7">More...</a><br /></td></tr>
<tr class="separator:aecbd81d7d63597af453ac7777452bbf7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a45712c6641f4245634b47af1824628fb"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceusermgmt.html#a45712c6641f4245634b47af1824628fb">PressureEnum</a> { <a class="el" href="namespaceusermgmt.html#a45712c6641f4245634b47af1824628fba94273561847ebe124a512aa247127076">PASCAL</a>,
<a class="el" href="namespaceusermgmt.html#a45712c6641f4245634b47af1824628fbae664c63e21ae34f69772301bddaa1c5a">PSI</a>
}</td></tr>
<tr class="memdesc:a45712c6641f4245634b47af1824628fb"><td class="mdescLeft"> </td><td class="mdescRight">Preferred display unit for (air) pressure sensors. <a href="namespaceusermgmt.html#a45712c6641f4245634b47af1824628fb">More...</a><br /></td></tr>
<tr class="separator:a45712c6641f4245634b47af1824628fb"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a933db2a13a08fef5271b7074607f71be"><td class="memItemLeft" align="right" valign="top"><a id="a933db2a13a08fef5271b7074607f71be"></a>
valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceusermgmt.html#a933db2a13a08fef5271b7074607f71be">RoleEvent</a></td></tr>
<tr class="memdesc:a933db2a13a08fef5271b7074607f71be"><td class="mdescLeft"> </td><td class="mdescRight">Base type of all account event. <br /></td></tr>
<tr class="separator:a933db2a13a08fef5271b7074607f71be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5eccaf0f1c52a8d5b07407c5e3a06bc5"><td class="memItemLeft" align="right" valign="top"><a id="a5eccaf0f1c52a8d5b07407c5e3a06bc5"></a>
valueobject </td><td class="memItemRight" valign="bottom"><b>RoleAdded</b></td></tr>
<tr class="separator:a5eccaf0f1c52a8d5b07407c5e3a06bc5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ab826efe3b1e2ce17fdba7c7e53e1d1"><td class="memItemLeft" align="right" valign="top"><a id="a9ab826efe3b1e2ce17fdba7c7e53e1d1"></a>
valueobject </td><td class="memItemRight" valign="bottom"><b>RoleRemoved</b></td></tr>
<tr class="separator:a9ab826efe3b1e2ce17fdba7c7e53e1d1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e12de6317c3a57c476c122ec6da3af9"><td class="memItemLeft" align="right" valign="top"><a id="a2e12de6317c3a57c476c122ec6da3af9"></a>
valueobject </td><td class="memItemRight" valign="bottom"><b>RoleChanged</b></td></tr>
<tr class="separator:a2e12de6317c3a57c476c122ec6da3af9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9c43b7ffd3ea4edd8ca78876e141207c"><td class="memItemLeft" align="right" valign="top"><a id="a9c43b7ffd3ea4edd8ca78876e141207c"></a>
<a class="el" href="structusermgmt_1_1Role_1_1Info.html">Role::Info</a> </td><td class="memItemRight" valign="bottom"><b>newSettings</b></td></tr>
<tr class="separator:a9c43b7ffd3ea4edd8ca78876e141207c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aadf14b9377aaa40a2b2159033f6eec98"><td class="memItemLeft" align="right" valign="top">valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceusermgmt.html#aadf14b9377aaa40a2b2159033f6eec98">AccountEvent</a></td></tr>
<tr class="memdesc:aadf14b9377aaa40a2b2159033f6eec98"><td class="mdescLeft"> </td><td class="mdescRight">Base type of all account event. <a href="#aadf14b9377aaa40a2b2159033f6eec98">More...</a><br /></td></tr>
<tr class="separator:aadf14b9377aaa40a2b2159033f6eec98"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0953f4fb7914365f7c61aa133ea034e6"><td class="memItemLeft" align="right" valign="top"><a id="a0953f4fb7914365f7c61aa133ea034e6"></a>
valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceusermgmt.html#a0953f4fb7914365f7c61aa133ea034e6">AccountAdded</a></td></tr>
<tr class="memdesc:a0953f4fb7914365f7c61aa133ea034e6"><td class="mdescLeft"> </td><td class="mdescRight">This event is emitted after a new account with the provided username was added. <br /></td></tr>
<tr class="separator:a0953f4fb7914365f7c61aa133ea034e6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aba87af9a4e3876e61cf14ad3a836f1e4"><td class="memItemLeft" align="right" valign="top"><a id="aba87af9a4e3876e61cf14ad3a836f1e4"></a>
valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceusermgmt.html#aba87af9a4e3876e61cf14ad3a836f1e4">AccountRemoved</a></td></tr>
<tr class="memdesc:aba87af9a4e3876e61cf14ad3a836f1e4"><td class="mdescLeft"> </td><td class="mdescRight">This event is emitted after the account with the provided username has been removed. <br /></td></tr>
<tr class="separator:aba87af9a4e3876e61cf14ad3a836f1e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0dd3bdd4628c5b4c834327530421372"><td class="memItemLeft" align="right" valign="top"><a id="af0dd3bdd4628c5b4c834327530421372"></a>
valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceusermgmt.html#af0dd3bdd4628c5b4c834327530421372">PasswordChanged</a></td></tr>
<tr class="memdesc:af0dd3bdd4628c5b4c834327530421372"><td class="mdescLeft"> </td><td class="mdescRight">This event is emitted after the password for an account was changed. <br /></td></tr>
<tr class="separator:af0dd3bdd4628c5b4c834327530421372"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a689e0f385429eeb7f5071b57510b20f7"><td class="memItemLeft" align="right" valign="top"><a id="a689e0f385429eeb7f5071b57510b20f7"></a>
valueobject </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceusermgmt.html#a689e0f385429eeb7f5071b57510b20f7">AccountChanged</a></td></tr>
<tr class="memdesc:a689e0f385429eeb7f5071b57510b20f7"><td class="mdescLeft"> </td><td class="mdescRight">This event is emitted if the settings of an account as defined in <a class="el" href="structusermgmt_1_1UserInfo.html" title="User information ">usermgmt::UserInfo</a> have changed (Note: we may add an indication what in the structure has changed or even split the event, if handling is difficult) <br /></td></tr>
<tr class="separator:a689e0f385429eeb7f5071b57510b20f7"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>User Management </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="aecbd81d7d63597af453ac7777452bbf7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aecbd81d7d63597af453ac7777452bbf7">◆ </a></span>LengthEnum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceusermgmt.html#aecbd81d7d63597af453ac7777452bbf7">usermgmt::LengthEnum</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Preferred display unit for length measurements, e.g. </p>
<p>device altitude </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aecbd81d7d63597af453ac7777452bbf7aef936c6458a810334e99f98247d18d23"></a>METER </td><td class="fielddoc"><p>Meters. </p>
</td></tr>
<tr><td class="fieldname"><a id="aecbd81d7d63597af453ac7777452bbf7a5cd77f41da1fb856662d1536c2235ce6"></a>FEET </td><td class="fielddoc"><p>Feet. </p>
</td></tr>
</table>
</div>
</div>
<a id="a45712c6641f4245634b47af1824628fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a45712c6641f4245634b47af1824628fb">◆ </a></span>PressureEnum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceusermgmt.html#a45712c6641f4245634b47af1824628fb">usermgmt::PressureEnum</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Preferred display unit for (air) pressure sensors. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a45712c6641f4245634b47af1824628fba94273561847ebe124a512aa247127076"></a>PASCAL </td><td class="fielddoc"><p>Pascal. </p>
</td></tr>
<tr><td class="fieldname"><a id="a45712c6641f4245634b47af1824628fbae664c63e21ae34f69772301bddaa1c5a"></a>PSI </td><td class="fielddoc"><p>pound-force per square inch </p>
</td></tr>
</table>
</div>
</div>
<a id="ab66d685f013e7ef2f71c37e8767bd4ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab66d685f013e7ef2f71c37e8767bd4ab">◆ </a></span>TemperatureEnum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="namespaceusermgmt.html#ab66d685f013e7ef2f71c37e8767bd4ab">usermgmt::TemperatureEnum</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Preferred display unit for temperature sensors. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ab66d685f013e7ef2f71c37e8767bd4abad2de83462cce75d1124a41432ef0ebeb"></a>DEG_C </td><td class="fielddoc"><p>Degrees Celsius. </p>
</td></tr>
<tr><td class="fieldname"><a id="ab66d685f013e7ef2f71c37e8767bd4abac71266398aa0227ce49b733da57d0ac6"></a>DEG_F </td><td class="fielddoc"><p>Degrees Fahrenheit. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a id="aadf14b9377aaa40a2b2159033f6eec98"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadf14b9377aaa40a2b2159033f6eec98">◆ </a></span>AccountEvent</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">valueobject usermgmt::AccountEvent</td>
</tr>
</table>
</div><div class="memdoc">
<p>Base type of all account event. </p>
<p>id of user which was affected </p>
</div>
</div>
</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>
|
