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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
|
<!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::UserManager_1_0_4 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="namespaceusermgmt.html">usermgmt</a></li><li class="navelem"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html">UserManager_1_0_4</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="interfaceusermgmt_1_1UserManager__1__0__4-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">usermgmt::UserManager_1_0_4 Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>User manager interface
<a href="interfaceusermgmt_1_1UserManager__1__0__4.html#details">More...</a></p>
<p><code>import"<a class="el" href="UserManager_8idl_source.html">UserManager.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:af9789cb9d0c45d72e4415aa3366b982e"><td class="memItemLeft" align="right" valign="top">vector< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#af9789cb9d0c45d72e4415aa3366b982e">getAccountNames</a> ()</td></tr>
<tr class="memdesc:af9789cb9d0c45d72e4415aa3366b982e"><td class="mdescLeft"> </td><td class="mdescRight">Get a list of account names available on the system. <a href="#af9789cb9d0c45d72e4415aa3366b982e">More...</a><br /></td></tr>
<tr class="separator:af9789cb9d0c45d72e4415aa3366b982e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a01b20d33c40a104b2a5cf093f270e77f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a01b20d33c40a104b2a5cf093f270e77f">createAccount</a> (in string username, in string password)</td></tr>
<tr class="memdesc:a01b20d33c40a104b2a5cf093f270e77f"><td class="mdescLeft"> </td><td class="mdescRight">Create a new account. <a href="#a01b20d33c40a104b2a5cf093f270e77f">More...</a><br /></td></tr>
<tr class="separator:a01b20d33c40a104b2a5cf093f270e77f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8c407dcdc806c8d0b3f702974c5e58b1"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a8c407dcdc806c8d0b3f702974c5e58b1">deleteAccount</a> (in string username)</td></tr>
<tr class="memdesc:a8c407dcdc806c8d0b3f702974c5e58b1"><td class="mdescLeft"> </td><td class="mdescRight">Deletes an account. <a href="#a8c407dcdc806c8d0b3f702974c5e58b1">More...</a><br /></td></tr>
<tr class="separator:a8c407dcdc806c8d0b3f702974c5e58b1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4d41742eb69edae5362777cd7c04ccd1"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structusermgmt_1_1Account.html">Account</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a4d41742eb69edae5362777cd7c04ccd1">getAllAccounts</a> ()</td></tr>
<tr class="memdesc:a4d41742eb69edae5362777cd7c04ccd1"><td class="mdescLeft"> </td><td class="mdescRight">Get information about all available user accounts. <a href="#a4d41742eb69edae5362777cd7c04ccd1">More...</a><br /></td></tr>
<tr class="separator:a4d41742eb69edae5362777cd7c04ccd1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a69e12c8c547023b1bec8e5b6b5ee37da"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a69e12c8c547023b1bec8e5b6b5ee37da">createAccountFull</a> (in string username, in string password, in <a class="el" href="structusermgmt_1_1UserInfo.html">UserInfo</a> info)</td></tr>
<tr class="memdesc:a69e12c8c547023b1bec8e5b6b5ee37da"><td class="mdescLeft"> </td><td class="mdescRight">Create a new account with defined settings. <a href="#a69e12c8c547023b1bec8e5b6b5ee37da">More...</a><br /></td></tr>
<tr class="separator:a69e12c8c547023b1bec8e5b6b5ee37da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0cff20a6db32c899e7d87a8a91e698ed"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structusermgmt_1_1Account.html">Account</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a0cff20a6db32c899e7d87a8a91e698ed">getAccountsByRole</a> (in string roleName)</td></tr>
<tr class="memdesc:a0cff20a6db32c899e7d87a8a91e698ed"><td class="mdescLeft"> </td><td class="mdescRight">Get a list of accounts that have a given role. <a href="#a0cff20a6db32c899e7d87a8a91e698ed">More...</a><br /></td></tr>
<tr class="separator:a0cff20a6db32c899e7d87a8a91e698ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae04c34b212fdec88a50b3e672b7cc6f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structusermgmt_1_1Preferences.html">Preferences</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#ae04c34b212fdec88a50b3e672b7cc6f7">getDefaultPreferences</a> ()</td></tr>
<tr class="memdesc:ae04c34b212fdec88a50b3e672b7cc6f7"><td class="mdescLeft"> </td><td class="mdescRight">Get default user preferences. <a href="#ae04c34b212fdec88a50b3e672b7cc6f7">More...</a><br /></td></tr>
<tr class="separator:ae04c34b212fdec88a50b3e672b7cc6f7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a245238e24c5bdfefb749b3ddb4e436dc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a245238e24c5bdfefb749b3ddb4e436dc">setDefaultPreferences</a> (in <a class="el" href="structusermgmt_1_1Preferences.html">Preferences</a> prefs)</td></tr>
<tr class="memdesc:a245238e24c5bdfefb749b3ddb4e436dc"><td class="mdescLeft"> </td><td class="mdescRight">Set default user preferences. <a href="#a245238e24c5bdfefb749b3ddb4e436dc">More...</a><br /></td></tr>
<tr class="separator:a245238e24c5bdfefb749b3ddb4e436dc"><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:af2ce52105d094cd837648c8d7bf8e14c"><td class="memItemLeft" align="right" valign="top"><a id="af2ce52105d094cd837648c8d7bf8e14c"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#af2ce52105d094cd837648c8d7bf8e14c">ERR_USER_DOESNT_EXIST</a> = 1</td></tr>
<tr class="memdesc:af2ce52105d094cd837648c8d7bf8e14c"><td class="mdescLeft"> </td><td class="mdescRight">A user with the given name does not exist. <br /></td></tr>
<tr class="separator:af2ce52105d094cd837648c8d7bf8e14c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ffc3f31a150c6c4715848ca5fbfea49"><td class="memItemLeft" align="right" valign="top"><a id="a2ffc3f31a150c6c4715848ca5fbfea49"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a2ffc3f31a150c6c4715848ca5fbfea49">ERR_USER_NOT_DELETABLE</a> = 2</td></tr>
<tr class="memdesc:a2ffc3f31a150c6c4715848ca5fbfea49"><td class="mdescLeft"> </td><td class="mdescRight">The user is not deletable. <br /></td></tr>
<tr class="separator:a2ffc3f31a150c6c4715848ca5fbfea49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a822a66ff1c5db4a8fa21421b9f88b001"><td class="memItemLeft" align="right" valign="top"><a id="a822a66ff1c5db4a8fa21421b9f88b001"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a822a66ff1c5db4a8fa21421b9f88b001">ERR_USER_ALREADY_EXISTS</a> = 1</td></tr>
<tr class="memdesc:a822a66ff1c5db4a8fa21421b9f88b001"><td class="mdescLeft"> </td><td class="mdescRight">A user with the given name already exists. <br /></td></tr>
<tr class="separator:a822a66ff1c5db4a8fa21421b9f88b001"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa8f3bf30daf0cfffea9998a1a128d30"><td class="memItemLeft" align="right" valign="top"><a id="aaa8f3bf30daf0cfffea9998a1a128d30"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#aaa8f3bf30daf0cfffea9998a1a128d30">ERR_MAX_USERS_REACHED</a> = 2</td></tr>
<tr class="memdesc:aaa8f3bf30daf0cfffea9998a1a128d30"><td class="mdescLeft"> </td><td class="mdescRight">Maximum number of users reached. <br /></td></tr>
<tr class="separator:aaa8f3bf30daf0cfffea9998a1a128d30"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68bd46a7b37de5bdd64e5d5e43b32541"><td class="memItemLeft" align="right" valign="top"><a id="a68bd46a7b37de5bdd64e5d5e43b32541"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a68bd46a7b37de5bdd64e5d5e43b32541">ERR_PASSWORD_TOO_SHORT_FOR_SNMP</a> = 3</td></tr>
<tr class="memdesc:a68bd46a7b37de5bdd64e5d5e43b32541"><td class="mdescLeft"> </td><td class="mdescRight">The password is too short to be used as SNMPv3 passphrase. <br /></td></tr>
<tr class="separator:a68bd46a7b37de5bdd64e5d5e43b32541"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a52490a82fd04d497d52b1766876617bd"><td class="memItemLeft" align="right" valign="top"><a id="a52490a82fd04d497d52b1766876617bd"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a52490a82fd04d497d52b1766876617bd">ERR_INVALID_VALUE</a> = 4</td></tr>
<tr class="memdesc:a52490a82fd04d497d52b1766876617bd"><td class="mdescLeft"> </td><td class="mdescRight">Invalid arguments. <br /></td></tr>
<tr class="separator:a52490a82fd04d497d52b1766876617bd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1edbdc0c590c47874d737d6218774b86"><td class="memItemLeft" align="right" valign="top"><a id="a1edbdc0c590c47874d737d6218774b86"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a1edbdc0c590c47874d737d6218774b86">ERR_PASSWORD_EMPTY</a> = 5</td></tr>
<tr class="memdesc:a1edbdc0c590c47874d737d6218774b86"><td class="mdescLeft"> </td><td class="mdescRight">The password must not be empty. <br /></td></tr>
<tr class="separator:a1edbdc0c590c47874d737d6218774b86"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe7c41f206a9c3437357968dca78b34b"><td class="memItemLeft" align="right" valign="top"><a id="abe7c41f206a9c3437357968dca78b34b"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#abe7c41f206a9c3437357968dca78b34b">ERR_PASSWORD_TOO_SHORT</a> = 6</td></tr>
<tr class="memdesc:abe7c41f206a9c3437357968dca78b34b"><td class="mdescLeft"> </td><td class="mdescRight">The password is too short. <br /></td></tr>
<tr class="separator:abe7c41f206a9c3437357968dca78b34b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa4839f9de60621092416e105a370179f"><td class="memItemLeft" align="right" valign="top"><a id="aa4839f9de60621092416e105a370179f"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#aa4839f9de60621092416e105a370179f">ERR_PASSWORD_TOO_LONG</a> = 7</td></tr>
<tr class="memdesc:aa4839f9de60621092416e105a370179f"><td class="mdescLeft"> </td><td class="mdescRight">The password is too long. <br /></td></tr>
<tr class="separator:aa4839f9de60621092416e105a370179f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2e5f07c55810fc5c57d3213d291f0f5"><td class="memItemLeft" align="right" valign="top"><a id="ad2e5f07c55810fc5c57d3213d291f0f5"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#ad2e5f07c55810fc5c57d3213d291f0f5">ERR_PASSWORD_CTRL_CHARS</a> = 8</td></tr>
<tr class="memdesc:ad2e5f07c55810fc5c57d3213d291f0f5"><td class="mdescLeft"> </td><td class="mdescRight">The password must not contain control characters. <br /></td></tr>
<tr class="separator:ad2e5f07c55810fc5c57d3213d291f0f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09a4f32209d9e0dfac5c78e51cbe4fd7"><td class="memItemLeft" align="right" valign="top"><a id="a09a4f32209d9e0dfac5c78e51cbe4fd7"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a09a4f32209d9e0dfac5c78e51cbe4fd7">ERR_PASSWORD_NEED_LOWER</a> = 9</td></tr>
<tr class="memdesc:a09a4f32209d9e0dfac5c78e51cbe4fd7"><td class="mdescLeft"> </td><td class="mdescRight">The password must contain at least one lower-case character. <br /></td></tr>
<tr class="separator:a09a4f32209d9e0dfac5c78e51cbe4fd7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abb9ed0425c3e23a8719ea8d6f22a2780"><td class="memItemLeft" align="right" valign="top"><a id="abb9ed0425c3e23a8719ea8d6f22a2780"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#abb9ed0425c3e23a8719ea8d6f22a2780">ERR_PASSWORD_NEED_UPPER</a> = 10</td></tr>
<tr class="memdesc:abb9ed0425c3e23a8719ea8d6f22a2780"><td class="mdescLeft"> </td><td class="mdescRight">The password must contain at least one upper-case character. <br /></td></tr>
<tr class="separator:abb9ed0425c3e23a8719ea8d6f22a2780"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa1e87fc39f74521c1f3e74f5bef32f4a"><td class="memItemLeft" align="right" valign="top"><a id="aa1e87fc39f74521c1f3e74f5bef32f4a"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#aa1e87fc39f74521c1f3e74f5bef32f4a">ERR_PASSWORD_NEED_NUMERIC</a> = 11</td></tr>
<tr class="memdesc:aa1e87fc39f74521c1f3e74f5bef32f4a"><td class="mdescLeft"> </td><td class="mdescRight">The password must contain at least one numeric character. <br /></td></tr>
<tr class="separator:aa1e87fc39f74521c1f3e74f5bef32f4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af0129459e267ae2c3e7a76b43e522ce0"><td class="memItemLeft" align="right" valign="top"><a id="af0129459e267ae2c3e7a76b43e522ce0"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#af0129459e267ae2c3e7a76b43e522ce0">ERR_PASSWORD_NEED_SPECIAL</a> = 12</td></tr>
<tr class="memdesc:af0129459e267ae2c3e7a76b43e522ce0"><td class="mdescLeft"> </td><td class="mdescRight">The password must contain at least one special character. <br /></td></tr>
<tr class="separator:af0129459e267ae2c3e7a76b43e522ce0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa671e223b9fddf80f3e41c95184195aa"><td class="memItemLeft" align="right" valign="top"><a id="aa671e223b9fddf80f3e41c95184195aa"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#aa671e223b9fddf80f3e41c95184195aa">ERR_SSH_PUBKEY_DATA_TOO_LARGE</a> = 14</td></tr>
<tr class="memdesc:aa671e223b9fddf80f3e41c95184195aa"><td class="mdescLeft"> </td><td class="mdescRight">The ssh public key data is too large. <br /></td></tr>
<tr class="separator:aa671e223b9fddf80f3e41c95184195aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6c31bdb1e3d17be6fc7a304826016950"><td class="memItemLeft" align="right" valign="top"><a id="a6c31bdb1e3d17be6fc7a304826016950"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a6c31bdb1e3d17be6fc7a304826016950">ERR_SSH_PUBKEY_INVALID</a> = 15</td></tr>
<tr class="memdesc:a6c31bdb1e3d17be6fc7a304826016950"><td class="mdescLeft"> </td><td class="mdescRight">The ssh public key is invalid. <br /></td></tr>
<tr class="separator:a6c31bdb1e3d17be6fc7a304826016950"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad15c89121ad7b6b800662b0cc6b033b3"><td class="memItemLeft" align="right" valign="top"><a id="ad15c89121ad7b6b800662b0cc6b033b3"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#ad15c89121ad7b6b800662b0cc6b033b3">ERR_SSH_PUBKEY_NOT_SUPPORTED</a> = 16</td></tr>
<tr class="memdesc:ad15c89121ad7b6b800662b0cc6b033b3"><td class="mdescLeft"> </td><td class="mdescRight">The ssh public key is not supported. <br /></td></tr>
<tr class="separator:ad15c89121ad7b6b800662b0cc6b033b3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a09f7970359091ada8bca0ba156efd9b4"><td class="memItemLeft" align="right" valign="top"><a id="a09f7970359091ada8bca0ba156efd9b4"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a09f7970359091ada8bca0ba156efd9b4">ERR_SSH_RSA_PUBKEY_TOO_SHORT</a> = 17</td></tr>
<tr class="memdesc:a09f7970359091ada8bca0ba156efd9b4"><td class="mdescLeft"> </td><td class="mdescRight">The ssh RSA public key is too short. <br /></td></tr>
<tr class="separator:a09f7970359091ada8bca0ba156efd9b4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebb345fa47714df09916a9cf99fa8a06"><td class="memItemLeft" align="right" valign="top"><a id="aebb345fa47714df09916a9cf99fa8a06"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1UserManager__1__0__4.html#aebb345fa47714df09916a9cf99fa8a06">ERR_USERNAME_INVALID</a> = 18</td></tr>
<tr class="memdesc:aebb345fa47714df09916a9cf99fa8a06"><td class="mdescLeft"> </td><td class="mdescRight">The user name contains one or more invalid character(s). <br /></td></tr>
<tr class="separator:aebb345fa47714df09916a9cf99fa8a06"><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 manager interface </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a01b20d33c40a104b2a5cf093f270e77f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a01b20d33c40a104b2a5cf093f270e77f">◆ </a></span>createAccount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usermgmt::UserManager_1_0_4::createAccount </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>username</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"><em>password</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new account. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">username</td><td>New user name </td></tr>
<tr><td class="paramname">password</td><td>New password</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if a user with the given name already exists </dd>
<dd>
2 if the maximum number of users is reached </dd>
<dd>
3 SNMPv3 USM is activated for the user and the password shall be used as auth passphrase. For this case, the password is too short (must be at least 8 characters). </dd>
<dd>
5 The password must not be empty. </dd>
<dd>
6 The password is too short. </dd>
<dd>
7 The password is too long. </dd>
<dd>
8 The password must not contain control characters. </dd>
<dd>
9 The password has to contain at least one lower case character. </dd>
<dd>
10 The password has to contain at least one upper case character. </dd>
<dd>
11 The password has to contain at least one numeric character. </dd>
<dd>
12 The password has to contain at least one printable special character. </dd>
<dd>
18 if the user name is invalid. </dd></dl>
</div>
</div>
<a id="a69e12c8c547023b1bec8e5b6b5ee37da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a69e12c8c547023b1bec8e5b6b5ee37da">◆ </a></span>createAccountFull()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usermgmt::UserManager_1_0_4::createAccountFull </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>username</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in string </td>
<td class="paramname"><em>password</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">in <a class="el" href="structusermgmt_1_1UserInfo.html">UserInfo</a> </td>
<td class="paramname"><em>info</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a new account with defined settings. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">username</td><td>New user name </td></tr>
<tr><td class="paramname">password</td><td>New password </td></tr>
<tr><td class="paramname">info</td><td>New user information</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if a user with the given name already exists </dd>
<dd>
2 if the maximum number of users is reached </dd>
<dd>
3 SNMPv3 USM is activated for the user and the password shall be used as auth passphrase. For this case, the password is too short (must be at least 8 characters). </dd>
<dd>
4 if any value in the user info is invalid. </dd>
<dd>
5 The password must not be empty. </dd>
<dd>
6 The password is too short. </dd>
<dd>
7 The password is too long. </dd>
<dd>
8 The password must not contain control characters. </dd>
<dd>
9 The password has to contain at least one lower case character. </dd>
<dd>
10 The password has to contain at least one upper case character. </dd>
<dd>
11 The password has to contain at least one numeric character. </dd>
<dd>
12 The password has to contain at least one printable special character. </dd>
<dd>
14 The ssh public key data is too large. </dd>
<dd>
15 The ssh public key is invalid. </dd>
<dd>
16 The ssh public key is not supported. </dd>
<dd>
17 The ssh RSA public key is too short. </dd>
<dd>
18 if the user name is invalid. </dd></dl>
</div>
</div>
<a id="a8c407dcdc806c8d0b3f702974c5e58b1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c407dcdc806c8d0b3f702974c5e58b1">◆ </a></span>deleteAccount()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usermgmt::UserManager_1_0_4::deleteAccount </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>username</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Deletes an account. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">username</td><td>Name of user to delete</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </dd>
<dd>
1 if a user with the given name does not exist </dd>
<dd>
2 if the user cannot be deleted </dd></dl>
</div>
</div>
<a id="af9789cb9d0c45d72e4415aa3366b982e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af9789cb9d0c45d72e4415aa3366b982e">◆ </a></span>getAccountNames()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<string> usermgmt::UserManager_1_0_4::getAccountNames </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list of account names available on the system. </p>
<dl class="section return"><dt>Returns</dt><dd>List of account names </dd></dl>
</div>
</div>
<a id="a0cff20a6db32c899e7d87a8a91e698ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cff20a6db32c899e7d87a8a91e698ed">◆ </a></span>getAccountsByRole()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structusermgmt_1_1Account.html">Account</a>> usermgmt::UserManager_1_0_4::getAccountsByRole </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>roleName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list of accounts that have a given role. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">roleName</td><td><a class="el" href="interfaceusermgmt_1_1Role.html" title="Role management interface ">Role</a> name</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>List of accounts </dd></dl>
</div>
</div>
<a id="a4d41742eb69edae5362777cd7c04ccd1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d41742eb69edae5362777cd7c04ccd1">◆ </a></span>getAllAccounts()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structusermgmt_1_1Account.html">Account</a>> usermgmt::UserManager_1_0_4::getAllAccounts </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get information about all available user accounts. </p>
<dl class="section return"><dt>Returns</dt><dd>List of accounts </dd></dl>
</div>
</div>
<a id="ae04c34b212fdec88a50b3e672b7cc6f7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae04c34b212fdec88a50b3e672b7cc6f7">◆ </a></span>getDefaultPreferences()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structusermgmt_1_1Preferences.html">Preferences</a> usermgmt::UserManager_1_0_4::getDefaultPreferences </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get default user preferences. </p>
<dl class="section return"><dt>Returns</dt><dd>Default user preferences. </dd></dl>
</div>
</div>
<a id="a245238e24c5bdfefb749b3ddb4e436dc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a245238e24c5bdfefb749b3ddb4e436dc">◆ </a></span>setDefaultPreferences()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usermgmt::UserManager_1_0_4::setDefaultPreferences </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structusermgmt_1_1Preferences.html">Preferences</a> </td>
<td class="paramname"><em>prefs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set default user preferences. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">prefs</td><td>Default user preferences.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 if OK </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="UserManager_8idl_source.html">UserManager.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Aug 21 2020 10:20:38 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>
|
