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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Raritan / Server Technology Xerus™ PDU JSON-RPC API: usermgmt::User 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 / Server Technology Xerus™ PDU JSON-RPC API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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_1User.html">User</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_1User-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">usermgmt::User Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>User interface
<a href="interfaceusermgmt_1_1User.html#details">More...</a></p>
<p><code>import"<a class="el" href="User_8idl_source.html">User.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:a161c8cd43ac1de21c98fae2d06b18a5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structusermgmt_1_1UserInfo.html">UserInfo</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a161c8cd43ac1de21c98fae2d06b18a5c">getInfo</a> ()</td></tr>
<tr class="memdesc:a161c8cd43ac1de21c98fae2d06b18a5c"><td class="mdescLeft"> </td><td class="mdescRight">Get user information. <a href="interfaceusermgmt_1_1User.html#a161c8cd43ac1de21c98fae2d06b18a5c">More...</a><br /></td></tr>
<tr class="separator:a161c8cd43ac1de21c98fae2d06b18a5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac62fc4b43e055c40de945ba59c5d781a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#ac62fc4b43e055c40de945ba59c5d781a">setAccountPassword</a> (in string password)</td></tr>
<tr class="memdesc:ac62fc4b43e055c40de945ba59c5d781a"><td class="mdescLeft"> </td><td class="mdescRight">Set the account password. <a href="interfaceusermgmt_1_1User.html#ac62fc4b43e055c40de945ba59c5d781a">More...</a><br /></td></tr>
<tr class="separator:ac62fc4b43e055c40de945ba59c5d781a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe20e4d1623a3cab25de0977dda4fbfe"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#abe20e4d1623a3cab25de0977dda4fbfe">updateAccountFull</a> (in string password, in <a class="el" href="structusermgmt_1_1UserInfo.html">UserInfo</a> info)</td></tr>
<tr class="memdesc:abe20e4d1623a3cab25de0977dda4fbfe"><td class="mdescLeft"> </td><td class="mdescRight">Update user information. <a href="interfaceusermgmt_1_1User.html#abe20e4d1623a3cab25de0977dda4fbfe">More...</a><br /></td></tr>
<tr class="separator:abe20e4d1623a3cab25de0977dda4fbfe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5474a32c43389540290febf93dc64800"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a5474a32c43389540290febf93dc64800">getInfoAndPrivileges</a> (out <a class="el" href="structusermgmt_1_1UserInfo.html">UserInfo</a> info, out vector< <a class="el" href="structusermgmt_1_1Role_1_1Privilege.html">Role::Privilege</a> > privileges)</td></tr>
<tr class="memdesc:a5474a32c43389540290febf93dc64800"><td class="mdescLeft"> </td><td class="mdescRight">Get information and a list of granted privileges for a user. <a href="interfaceusermgmt_1_1User.html#a5474a32c43389540290febf93dc64800">More...</a><br /></td></tr>
<tr class="separator:a5474a32c43389540290febf93dc64800"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8710ec1b392caf7a42cad5882a26013"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#ae8710ec1b392caf7a42cad5882a26013">setPreferences</a> (in <a class="el" href="structusermgmt_1_1Preferences.html">Preferences</a> prefs)</td></tr>
<tr class="memdesc:ae8710ec1b392caf7a42cad5882a26013"><td class="mdescLeft"> </td><td class="mdescRight">Sets the user preferences. <a href="interfaceusermgmt_1_1User.html#ae8710ec1b392caf7a42cad5882a26013">More...</a><br /></td></tr>
<tr class="separator:ae8710ec1b392caf7a42cad5882a26013"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae8dba3683be9df4acc8534d175f3f0a7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structusermgmt_1_1UserCapabilities.html">UserCapabilities</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#ae8dba3683be9df4acc8534d175f3f0a7">getCapabilities</a> ()</td></tr>
<tr class="memdesc:ae8dba3683be9df4acc8534d175f3f0a7"><td class="mdescLeft"> </td><td class="mdescRight">Gets the user capabilities. <a href="interfaceusermgmt_1_1User.html#ae8dba3683be9df4acc8534d175f3f0a7">More...</a><br /></td></tr>
<tr class="separator:ae8dba3683be9df4acc8534d175f3f0a7"><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:a5433945858999dd20417b89ec3c98cbf"><td class="memItemLeft" align="right" valign="top"><a id="a5433945858999dd20417b89ec3c98cbf"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a5433945858999dd20417b89ec3c98cbf">ERR_PASSWORD_UNCHANGED</a> = 1</td></tr>
<tr class="memdesc:a5433945858999dd20417b89ec3c98cbf"><td class="mdescLeft"> </td><td class="mdescRight">The new password must differ from the old password. <br /></td></tr>
<tr class="separator:a5433945858999dd20417b89ec3c98cbf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7638dddf62af11011b27796790d558c6"><td class="memItemLeft" align="right" valign="top"><a id="a7638dddf62af11011b27796790d558c6"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a7638dddf62af11011b27796790d558c6">ERR_PASSWORD_EMPTY</a> = 2</td></tr>
<tr class="memdesc:a7638dddf62af11011b27796790d558c6"><td class="mdescLeft"> </td><td class="mdescRight">The password must not be empty. <br /></td></tr>
<tr class="separator:a7638dddf62af11011b27796790d558c6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33c0b6c4a171a283ad546019173e3e62"><td class="memItemLeft" align="right" valign="top"><a id="a33c0b6c4a171a283ad546019173e3e62"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a33c0b6c4a171a283ad546019173e3e62">ERR_PASSWORD_TOO_SHORT</a> = 3</td></tr>
<tr class="memdesc:a33c0b6c4a171a283ad546019173e3e62"><td class="mdescLeft"> </td><td class="mdescRight">The password is too short. <br /></td></tr>
<tr class="separator:a33c0b6c4a171a283ad546019173e3e62"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a67d7d49d922621fe1750bbe5c9096d39"><td class="memItemLeft" align="right" valign="top"><a id="a67d7d49d922621fe1750bbe5c9096d39"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a67d7d49d922621fe1750bbe5c9096d39">ERR_PASSWORD_TOO_LONG</a> = 4</td></tr>
<tr class="memdesc:a67d7d49d922621fe1750bbe5c9096d39"><td class="mdescLeft"> </td><td class="mdescRight">The password is too long. <br /></td></tr>
<tr class="separator:a67d7d49d922621fe1750bbe5c9096d39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab88d78e8a974f39aa4ac3a0042ca2985"><td class="memItemLeft" align="right" valign="top"><a id="ab88d78e8a974f39aa4ac3a0042ca2985"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#ab88d78e8a974f39aa4ac3a0042ca2985">ERR_PASSWORD_CTRL_CHARS</a> = 5</td></tr>
<tr class="memdesc:ab88d78e8a974f39aa4ac3a0042ca2985"><td class="mdescLeft"> </td><td class="mdescRight">The password must not contain control characters. <br /></td></tr>
<tr class="separator:ab88d78e8a974f39aa4ac3a0042ca2985"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a66b43c30c03916e0e53decf717bfc440"><td class="memItemLeft" align="right" valign="top"><a id="a66b43c30c03916e0e53decf717bfc440"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a66b43c30c03916e0e53decf717bfc440">ERR_PASSWORD_NEED_LOWER</a> = 6</td></tr>
<tr class="memdesc:a66b43c30c03916e0e53decf717bfc440"><td class="mdescLeft"> </td><td class="mdescRight">The password must contain at least one lower-case character. <br /></td></tr>
<tr class="separator:a66b43c30c03916e0e53decf717bfc440"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9964919ccd37b882a325d8d2f12e465c"><td class="memItemLeft" align="right" valign="top"><a id="a9964919ccd37b882a325d8d2f12e465c"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a9964919ccd37b882a325d8d2f12e465c">ERR_PASSWORD_NEED_UPPER</a> = 7</td></tr>
<tr class="memdesc:a9964919ccd37b882a325d8d2f12e465c"><td class="mdescLeft"> </td><td class="mdescRight">The password must contain at least one upper-case character. <br /></td></tr>
<tr class="separator:a9964919ccd37b882a325d8d2f12e465c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1cd6e92cf0a28096bd34f5d117bb7b34"><td class="memItemLeft" align="right" valign="top"><a id="a1cd6e92cf0a28096bd34f5d117bb7b34"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a1cd6e92cf0a28096bd34f5d117bb7b34">ERR_PASSWORD_NEED_NUMERIC</a> = 8</td></tr>
<tr class="memdesc:a1cd6e92cf0a28096bd34f5d117bb7b34"><td class="mdescLeft"> </td><td class="mdescRight">The password must contain at least one numeric character. <br /></td></tr>
<tr class="separator:a1cd6e92cf0a28096bd34f5d117bb7b34"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad58ab98d3e54f7b48dedf4629a999a5c"><td class="memItemLeft" align="right" valign="top"><a id="ad58ab98d3e54f7b48dedf4629a999a5c"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#ad58ab98d3e54f7b48dedf4629a999a5c">ERR_PASSWORD_NEED_SPECIAL</a> = 9</td></tr>
<tr class="memdesc:ad58ab98d3e54f7b48dedf4629a999a5c"><td class="mdescLeft"> </td><td class="mdescRight">The password must contain at least one special character. <br /></td></tr>
<tr class="separator:ad58ab98d3e54f7b48dedf4629a999a5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6f3e77a4ca3fdd4c146c35dab5b03a5c"><td class="memItemLeft" align="right" valign="top"><a id="a6f3e77a4ca3fdd4c146c35dab5b03a5c"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a6f3e77a4ca3fdd4c146c35dab5b03a5c">ERR_PASSWORD_IN_HISTORY</a> = 10</td></tr>
<tr class="memdesc:a6f3e77a4ca3fdd4c146c35dab5b03a5c"><td class="mdescLeft"> </td><td class="mdescRight">The password is already in the password history. <br /></td></tr>
<tr class="separator:a6f3e77a4ca3fdd4c146c35dab5b03a5c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a408e45257c4f31c19bfe4f120e82400c"><td class="memItemLeft" align="right" valign="top"><a id="a408e45257c4f31c19bfe4f120e82400c"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a408e45257c4f31c19bfe4f120e82400c">ERR_PASSWORD_TOO_SHORT_FOR_SNMP</a> = 11</td></tr>
<tr class="memdesc:a408e45257c4f31c19bfe4f120e82400c"><td class="mdescLeft"> </td><td class="mdescRight">The password is too short to be used as SNMPv3 passphrase. <br /></td></tr>
<tr class="separator:a408e45257c4f31c19bfe4f120e82400c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae349167375feaf5bcfe2543ad454cad7"><td class="memItemLeft" align="right" valign="top"><a id="ae349167375feaf5bcfe2543ad454cad7"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#ae349167375feaf5bcfe2543ad454cad7">ERR_INVALID_ARGUMENT</a> = 12</td></tr>
<tr class="memdesc:ae349167375feaf5bcfe2543ad454cad7"><td class="mdescLeft"> </td><td class="mdescRight">Invalid arguments. <br /></td></tr>
<tr class="separator:ae349167375feaf5bcfe2543ad454cad7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a21cd9608006dbc82fd2765c07f65c32d"><td class="memItemLeft" align="right" valign="top"><a id="a21cd9608006dbc82fd2765c07f65c32d"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a21cd9608006dbc82fd2765c07f65c32d">ERR_WRONG_PASSWORD</a> = 13</td></tr>
<tr class="memdesc:a21cd9608006dbc82fd2765c07f65c32d"><td class="mdescLeft"> </td><td class="mdescRight">The passed-in password was wrong. <br /></td></tr>
<tr class="separator:a21cd9608006dbc82fd2765c07f65c32d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a98c5dedf2f89e5af6d88283c676a22"><td class="memItemLeft" align="right" valign="top"><a id="a1a98c5dedf2f89e5af6d88283c676a22"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a1a98c5dedf2f89e5af6d88283c676a22">ERR_SSH_PUBKEY_DATA_TOO_LARGE</a> = 14</td></tr>
<tr class="memdesc:a1a98c5dedf2f89e5af6d88283c676a22"><td class="mdescLeft"> </td><td class="mdescRight">The ssh public key data is too large. <br /></td></tr>
<tr class="separator:a1a98c5dedf2f89e5af6d88283c676a22"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab77d932ed9facd2bfa5fa1fe7f9421b6"><td class="memItemLeft" align="right" valign="top"><a id="ab77d932ed9facd2bfa5fa1fe7f9421b6"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#ab77d932ed9facd2bfa5fa1fe7f9421b6">ERR_SSH_PUBKEY_INVALID</a> = 15</td></tr>
<tr class="memdesc:ab77d932ed9facd2bfa5fa1fe7f9421b6"><td class="mdescLeft"> </td><td class="mdescRight">The ssh public key is invalid. <br /></td></tr>
<tr class="separator:ab77d932ed9facd2bfa5fa1fe7f9421b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a201cddabba7545d0d1828ee949de9bc4"><td class="memItemLeft" align="right" valign="top"><a id="a201cddabba7545d0d1828ee949de9bc4"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#a201cddabba7545d0d1828ee949de9bc4">ERR_SSH_PUBKEY_NOT_SUPPORTED</a> = 16</td></tr>
<tr class="memdesc:a201cddabba7545d0d1828ee949de9bc4"><td class="mdescLeft"> </td><td class="mdescRight">The ssh public key is not supported. <br /></td></tr>
<tr class="separator:a201cddabba7545d0d1828ee949de9bc4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa610533877dd0629443fd6ddf2102d9e"><td class="memItemLeft" align="right" valign="top"><a id="aa610533877dd0629443fd6ddf2102d9e"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceusermgmt_1_1User.html#aa610533877dd0629443fd6ddf2102d9e">ERR_SSH_RSA_PUBKEY_TOO_SHORT</a> = 17</td></tr>
<tr class="memdesc:aa610533877dd0629443fd6ddf2102d9e"><td class="mdescLeft"> </td><td class="mdescRight">The ssh RSA public key is too short. <br /></td></tr>
<tr class="separator:aa610533877dd0629443fd6ddf2102d9e"><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 interface </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="ae8dba3683be9df4acc8534d175f3f0a7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8dba3683be9df4acc8534d175f3f0a7">◆ </a></span>getCapabilities()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structusermgmt_1_1UserCapabilities.html">UserCapabilities</a> usermgmt::User::getCapabilities </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the user capabilities. </p>
<dl class="section return"><dt>Returns</dt><dd>capabilities </dd></dl>
</div>
</div>
<a id="a161c8cd43ac1de21c98fae2d06b18a5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a161c8cd43ac1de21c98fae2d06b18a5c">◆ </a></span>getInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structusermgmt_1_1UserInfo.html">UserInfo</a> usermgmt::User::getInfo </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get user information. </p>
<dl class="section return"><dt>Returns</dt><dd>User information </dd></dl>
</div>
</div>
<a id="a5474a32c43389540290febf93dc64800"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5474a32c43389540290febf93dc64800">◆ </a></span>getInfoAndPrivileges()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void usermgmt::User::getInfoAndPrivileges </td>
<td>(</td>
<td class="paramtype">out <a class="el" href="structusermgmt_1_1UserInfo.html">UserInfo</a> </td>
<td class="paramname"><em>info</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out vector< <a class="el" href="structusermgmt_1_1Role_1_1Privilege.html">Role::Privilege</a> > </td>
<td class="paramname"><em>privileges</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get information and a list of granted privileges for a user. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">info</td><td>User information </td></tr>
<tr><td class="paramname">privileges</td><td>List of granted privileges </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac62fc4b43e055c40de945ba59c5d781a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac62fc4b43e055c40de945ba59c5d781a">◆ </a></span>setAccountPassword()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usermgmt::User::setAccountPassword </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>password</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the account password. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">password</td><td>The new password</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 OK </dd>
<dd>
1 The new password has to differ from old password. </dd>
<dd>
2 The password must not be empty. </dd>
<dd>
3 The password is too short. </dd>
<dd>
4 The password is too long. </dd>
<dd>
5 The password must not contain control characters. </dd>
<dd>
6 The password has to contain at least one lower case character. </dd>
<dd>
7 The password has to contain at least one upper case character. </dd>
<dd>
8 The password has to contain at least one numeric character. </dd>
<dd>
9 The password has to contain at least one printable special character. </dd>
<dd>
10 The password already is in history. </dd>
<dd>
11 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></dl>
</div>
</div>
<a id="ae8710ec1b392caf7a42cad5882a26013"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae8710ec1b392caf7a42cad5882a26013">◆ </a></span>setPreferences()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usermgmt::User::setPreferences </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>Sets the user preferences. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">prefs</td><td><a class="el" href="interfaceusermgmt_1_1User.html" title="User interface">User</a> <a class="el" href="structusermgmt_1_1Preferences.html" title="User preferences">Preferences</a></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 OK </dd>
<dd>
ERR_INVALID_ARGUMENT An argument is invalid or out of range </dd></dl>
</div>
</div>
<a id="abe20e4d1623a3cab25de0977dda4fbfe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abe20e4d1623a3cab25de0977dda4fbfe">◆ </a></span>updateAccountFull()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int usermgmt::User::updateAccountFull </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>Update user information. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">password</td><td>The new password; empty to leave unchanged </td></tr>
<tr><td class="paramname">info</td><td>The new user information</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 OK </dd>
<dd>
1 The new password has to differ from old password. </dd>
<dd>
3 The password is too short. </dd>
<dd>
4 The password is too long. </dd>
<dd>
5 The password must not contain control characters. </dd>
<dd>
6 The password has to contain at least one lower case character. </dd>
<dd>
7 The password has to contain at least one upper case character. </dd>
<dd>
8 The password has to contain at least one numeric character. </dd>
<dd>
9 The password has to contain at least one printable special character. </dd>
<dd>
10 The password already is in history. </dd>
<dd>
11 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>
12 An argument is invalid or out of range </dd>
<dd>
13 The password passed in as SNMPv3 authentication pass phrase was wrong. </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></dl>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="User_8idl_source.html">User.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 17 2022 00:25:44 for Raritan / Server Technology Xerus™ PDU JSON-RPC API by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
|
