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
|
<!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/UserManager.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">UserManager.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 <User.idl></span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <UserEvent.idl></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">/**</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * %User Management</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> */</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> module <a class="code" href="namespaceusermgmt.html">usermgmt</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> /** %Account information */</span></div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="structusermgmt_1_1Account.html"> 15</a></span>  structure <a class="code" href="structusermgmt_1_1Account.html">Account</a> {</div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structusermgmt_1_1Account.html#a39e7a4495e4729ae93587d9b36d435c3"> 16</a></span>  <span class="keywordtype">string</span> <a class="code" href="structusermgmt_1_1Account.html#a39e7a4495e4729ae93587d9b36d435c3">name</a>; <span class="comment">///< %Account name</span></div><div class="line"><a name="l00017"></a><span class="lineno"><a class="line" href="structusermgmt_1_1Account.html#a667c5d0ade889bf465c0e88571930bc0"> 17</a></span> <span class="comment"></span> <a class="code" href="structusermgmt_1_1UserInfo.html">UserInfo</a> <a class="code" href="structusermgmt_1_1Account.html#a667c5d0ade889bf465c0e88571930bc0">info</a>; <span class="comment">///< %User information</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"></span> };</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> </div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  <span class="comment">/* event definitions */</span><span class="comment"></span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> /**</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * Base type of all account event</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  valueobject <a class="code" href="namespaceusermgmt.html#aadf14b9377aaa40a2b2159033f6eec98">AccountEvent</a> extends <span class="keyword">event</span>.UserEvent {</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="namespaceusermgmt.html#aadf14b9377aaa40a2b2159033f6eec98"> 25</a></span>  <span class="keywordtype">string</span> username; <span class="comment">///< id of user which was affected</span></div><div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="namespaceusermgmt.html#a0953f4fb7914365f7c61aa133ea034e6"> 26</a></span> <span class="comment"></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> <span class="comment"> /**</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * This event is emitted after a new account with the </span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * provided username was added </span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> */</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  valueobject AccountAdded extends AccountEvent {};</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></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"> * This event is emitted after the account with</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> * the provided username has been removed</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> */</span></div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="namespaceusermgmt.html#aba87af9a4e3876e61cf14ad3a836f1e4"> 38</a></span>  valueobject <a class="code" href="namespaceusermgmt.html#aba87af9a4e3876e61cf14ad3a836f1e4">AccountRemoved</a> extends <a class="code" href="namespaceusermgmt.html#aadf14b9377aaa40a2b2159033f6eec98">AccountEvent</a> {};</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"></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> <span class="comment"> * This event is emitted after the password for</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> * an account was changed</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"><a class="line" href="namespaceusermgmt.html#af0dd3bdd4628c5b4c834327530421372"> 44</a></span>  valueobject <a class="code" href="namespaceusermgmt.html#af0dd3bdd4628c5b4c834327530421372">PasswordChanged</a> extends <a class="code" href="namespaceusermgmt.html#aadf14b9377aaa40a2b2159033f6eec98">AccountEvent</a> {};</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"> /**</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> * This event is emitted if the settings of an account</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * as defined in usermgmt.UserInfo have changed</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * (Note: we may add an indication what in the structure</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * has changed or even split the event, if handling is difficult)</span></div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> */</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  valueobject AccountChanged extends AccountEvent {</div><div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="namespaceusermgmt.html#a689e0f385429eeb7f5071b57510b20f7"> 53</a></span>  <a class="code" href="namespaceusermgmt.html">usermgmt</a>.<a class="code" href="structusermgmt_1_1UserInfo.html">UserInfo</a> oldSettings;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="namespaceusermgmt.html">usermgmt</a>.<a class="code" href="structusermgmt_1_1UserInfo.html">UserInfo</a> newSettings;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  };</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</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="comment"> /** %User manager interface */</span></div><div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html"> 59</a></span>  <span class="keyword">interface </span><a class="code" href="interfaceusermgmt_1_1UserManager__1__0__4.html">UserManager_1_0_4</a> {</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#af2ce52105d094cd837648c8d7bf8e14c"> 61</a></span>  constant <span class="keywordtype">int</span> ERR_USER_DOESNT_EXIST = 1; <span class="comment">///< A user with the given name does not exist</span></div><div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a2ffc3f31a150c6c4715848ca5fbfea49"> 62</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_USER_NOT_DELETABLE = 2; <span class="comment">///< The user is not deletable</span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span></div><div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a822a66ff1c5db4a8fa21421b9f88b001"> 64</a></span>  constant <span class="keywordtype">int</span> ERR_USER_ALREADY_EXISTS = 1; <span class="comment">///< A user with the given name already exists</span></div><div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#aaa8f3bf30daf0cfffea9998a1a128d30"> 65</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_MAX_USERS_REACHED = 2; <span class="comment">///< Maximum number of users reached</span></div><div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a68bd46a7b37de5bdd64e5d5e43b32541"> 66</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_PASSWORD_TOO_SHORT_FOR_SNMP = 3; <span class="comment">///< The password is too short to be used as SNMPv3 passphrase</span></div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a52490a82fd04d497d52b1766876617bd"> 67</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_INVALID_VALUE = 4; <span class="comment">///< Invalid arguments</span></div><div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a1edbdc0c590c47874d737d6218774b86"> 68</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_PASSWORD_EMPTY = 5; <span class="comment">///< The password must not be empty</span></div><div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#abe7c41f206a9c3437357968dca78b34b"> 69</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_PASSWORD_TOO_SHORT = 6; <span class="comment">///< The password is too short</span></div><div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#aa4839f9de60621092416e105a370179f"> 70</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_PASSWORD_TOO_LONG = 7; <span class="comment">///< The password is too long</span></div><div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#ad2e5f07c55810fc5c57d3213d291f0f5"> 71</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_PASSWORD_CTRL_CHARS = 8; <span class="comment">///< The password must not contain control characters</span></div><div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a09a4f32209d9e0dfac5c78e51cbe4fd7"> 72</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_PASSWORD_NEED_LOWER = 9; <span class="comment">///< The password must contain at least one lower-case character</span></div><div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#abb9ed0425c3e23a8719ea8d6f22a2780"> 73</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_PASSWORD_NEED_UPPER = 10; <span class="comment">///< The password must contain at least one upper-case character</span></div><div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#aa1e87fc39f74521c1f3e74f5bef32f4a"> 74</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_PASSWORD_NEED_NUMERIC = 11; <span class="comment">///< The password must contain at least one numeric character</span></div><div class="line"><a name="l00075"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#af0129459e267ae2c3e7a76b43e522ce0"> 75</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_PASSWORD_NEED_SPECIAL = 12; <span class="comment">///< The password must contain at least one special character</span></div><div class="line"><a name="l00076"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#aa671e223b9fddf80f3e41c95184195aa"> 76</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_SSH_PUBKEY_DATA_TOO_LARGE = 14; <span class="comment">///< The ssh public key data is too large.</span></div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a6c31bdb1e3d17be6fc7a304826016950"> 77</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_SSH_PUBKEY_INVALID = 15; <span class="comment">///< The ssh public key is invalid.</span></div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#ad15c89121ad7b6b800662b0cc6b033b3"> 78</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_SSH_PUBKEY_NOT_SUPPORTED = 16; <span class="comment">///< The ssh public key is not supported.</span></div><div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#a09f7970359091ada8bca0ba156efd9b4"> 79</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_SSH_RSA_PUBKEY_TOO_SHORT = 17; <span class="comment">///< The ssh RSA public key is too short.</span></div><div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="interfaceusermgmt_1_1UserManager__1__0__4.html#aebb345fa47714df09916a9cf99fa8a06"> 80</a></span> <span class="comment"></span> constant <span class="keywordtype">int</span> ERR_USERNAME_INVALID = 18; <span class="comment">///< The user name contains one or more invalid character(s).</span></div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span><span class="comment"></span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> /**</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * Get a list of account names available on the system.</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> *</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> * @return List of account names</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> */</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  vector<string> getAccountNames();</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"></span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> /**</span></div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> * Create a new account.</span></div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> *</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> * @param username New user name</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> * @param password New password</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> *</span></div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> * @return 1 if a user with the given name already exists</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @return 2 if the maximum number of users is reached</span></div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * @return 3 SNMPv3 USM is activated for the user and the</span></div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> * password shall be used as auth passphrase. For this</span></div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> * case, the password is too short (must be at least 8</span></div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> * characters).</span></div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment"> * @return 5 The password must not be empty.</span></div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @return 6 The password is too short.</span></div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @return 7 The password is too long.</span></div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> * @return 8 The password must not contain control characters.</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> * @return 9 The password has to contain at least one lower case</span></div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> * character.</span></div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> * @return 10 The password has to contain at least one upper case</span></div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * character.</span></div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * @return 11 The password has to contain at least one numeric</span></div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * character.</span></div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * @return 12 The password has to contain at least one printable</span></div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> * special character.</span></div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="comment"> * @return 18 if the user name is invalid.</span></div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> */</span></div><div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  <span class="keywordtype">int</span> createAccount(in <span class="keywordtype">string</span> username, in <span class="keywordtype">string</span> password);</div><div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"></span></div><div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> /**</span></div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * Deletes an account.</span></div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> *</span></div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> * @param username Name of user to delete</span></div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment"> *</span></div><div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @return 1 if a user with the given name does not exist</span></div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * @return 2 if the user cannot be deleted</span></div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> */</span></div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="keywordtype">int</span> deleteAccount(in <span class="keywordtype">string</span> username);</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"></span></div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment"> /**</span></div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * Get information about all available user accounts.</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> *</span></div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * @return List of accounts</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> */</span></div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  vector<Account> getAllAccounts();</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"></span></div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> /**</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * Create a new account with defined settings.</span></div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> *</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * @param username New user name</span></div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> * @param password New password</span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> * @param info New user information</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> *</span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> * @return 1 if a user with the given name already exists</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> * @return 2 if the maximum number of users is reached</span></div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> * @return 3 SNMPv3 USM is activated for the user and the</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment"> * password shall be used as auth passphrase. For this</span></div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * case, the password is too short (must be at least 8</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * characters).</span></div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * @return 4 if any value in the user info is invalid.</span></div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> * @return 5 The password must not be empty.</span></div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span> <span class="comment"> * @return 6 The password is too short.</span></div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"> * @return 7 The password is too long.</span></div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment"> * @return 8 The password must not contain control characters.</span></div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * @return 9 The password has to contain at least one lower case</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * character.</span></div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * @return 10 The password has to contain at least one upper case</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * character.</span></div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * @return 11 The password has to contain at least one numeric</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> * character.</span></div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="comment"> * @return 12 The password has to contain at least one printable</span></div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"> * special character.</span></div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment"> * @return 14 The ssh public key data is too large.</span></div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * @return 15 The ssh public key is invalid.</span></div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * @return 16 The ssh public key is not supported.</span></div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * @return 17 The ssh RSA public key is too short.</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * @return 18 if the user name is invalid.</span></div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> */</span></div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  <span class="keywordtype">int</span> createAccountFull(in <span class="keywordtype">string</span> username, in <span class="keywordtype">string</span> password,</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>  in <a class="code" href="structusermgmt_1_1UserInfo.html">UserInfo</a> info);</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment"></span></div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> /**</span></div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * Get a list of accounts that have a given role.</span></div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> *</span></div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @param roleName Role name</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> *</span></div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="comment"> * @return List of accounts</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"> */</span></div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  vector<Account> getAccountsByRole(in <span class="keywordtype">string</span> roleName);</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"></span></div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> /**</span></div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * Get default user preferences.</span></div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> *</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> * @return Default user preferences.</span></div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="comment"> */</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <a class="code" href="structusermgmt_1_1Preferences.html">Preferences</a> getDefaultPreferences();</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment"></span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> /**</span></div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * Set default user preferences.</span></div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> *</span></div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * @param prefs Default user preferences.</span></div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> *</span></div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span> <span class="comment"> * @return 0 if OK</span></div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"> */</span></div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="keywordtype">int</span> setDefaultPreferences(in <a class="code" href="structusermgmt_1_1Preferences.html">Preferences</a> prefs);</div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  };</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> </div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> }</div><div class="ttc" id="interfaceusermgmt_1_1UserManager__1__0__4_html"><div class="ttname"><a href="interfaceusermgmt_1_1UserManager__1__0__4.html">usermgmt::UserManager_1_0_4</a></div><div class="ttdoc">User manager interface </div><div class="ttdef"><b>Definition:</b> UserManager.idl:59</div></div>
<div class="ttc" id="structusermgmt_1_1Account_html_a667c5d0ade889bf465c0e88571930bc0"><div class="ttname"><a href="structusermgmt_1_1Account.html#a667c5d0ade889bf465c0e88571930bc0">usermgmt::Account::info</a></div><div class="ttdeci">UserInfo info</div><div class="ttdoc">User information </div><div class="ttdef"><b>Definition:</b> UserManager.idl:17</div></div>
<div class="ttc" id="namespaceusermgmt_html_aadf14b9377aaa40a2b2159033f6eec98"><div class="ttname"><a href="namespaceusermgmt.html#aadf14b9377aaa40a2b2159033f6eec98">usermgmt::AccountEvent</a></div><div class="ttdeci">valueobject AccountEvent</div><div class="ttdoc">Base type of all account event. </div><div class="ttdef"><b>Definition:</b> UserManager.idl:25</div></div>
<div class="ttc" id="structusermgmt_1_1UserInfo_html"><div class="ttname"><a href="structusermgmt_1_1UserInfo.html">usermgmt::UserInfo</a></div><div class="ttdoc">User information </div><div class="ttdef"><b>Definition:</b> User.idl:63</div></div>
<div class="ttc" id="structusermgmt_1_1Preferences_html"><div class="ttname"><a href="structusermgmt_1_1Preferences.html">usermgmt::Preferences</a></div><div class="ttdoc">User preferences </div><div class="ttdef"><b>Definition:</b> User.idl:56</div></div>
<div class="ttc" id="namespaceusermgmt_html_af0dd3bdd4628c5b4c834327530421372"><div class="ttname"><a href="namespaceusermgmt.html#af0dd3bdd4628c5b4c834327530421372">usermgmt::PasswordChanged</a></div><div class="ttdeci">valueobject PasswordChanged</div><div class="ttdoc">This event is emitted after the password for an account was changed. </div><div class="ttdef"><b>Definition:</b> UserManager.idl:44</div></div>
<div class="ttc" id="namespaceusermgmt_html"><div class="ttname"><a href="namespaceusermgmt.html">usermgmt</a></div><div class="ttdoc">User Management </div><div class="ttdef"><b>Definition:</b> Role.idl:12</div></div>
<div class="ttc" id="structusermgmt_1_1Account_html"><div class="ttname"><a href="structusermgmt_1_1Account.html">usermgmt::Account</a></div><div class="ttdoc">Account information </div><div class="ttdef"><b>Definition:</b> UserManager.idl:15</div></div>
<div class="ttc" id="namespaceusermgmt_html_aba87af9a4e3876e61cf14ad3a836f1e4"><div class="ttname"><a href="namespaceusermgmt.html#aba87af9a4e3876e61cf14ad3a836f1e4">usermgmt::AccountRemoved</a></div><div class="ttdeci">valueobject AccountRemoved</div><div class="ttdoc">This event is emitted after the account with the provided username has been removed. </div><div class="ttdef"><b>Definition:</b> UserManager.idl:38</div></div>
<div class="ttc" id="structusermgmt_1_1Account_html_a39e7a4495e4729ae93587d9b36d435c3"><div class="ttname"><a href="structusermgmt_1_1Account.html#a39e7a4495e4729ae93587d9b36d435c3">usermgmt::Account::name</a></div><div class="ttdeci">string name</div><div class="ttdoc">Account name </div><div class="ttdef"><b>Definition:</b> UserManager.idl:16</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>
|
