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
|
<!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: auth::LdapManager_2_0_0 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="namespaceauth.html">auth</a></li><li class="navelem"><a class="el" href="interfaceauth_1_1LdapManager__2__0__0.html">LdapManager_2_0_0</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="interfaceauth_1_1LdapManager__2__0__0-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">auth::LdapManager_2_0_0 Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>LDAP server configuration interface.
<a href="interfaceauth_1_1LdapManager__2__0__0.html#details">More...</a></p>
<p><code>import"<a class="el" href="LdapManager_8idl_source.html">LdapManager.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:a67d6cf232360d8f3b806325f4aa3c957"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structauth_1_1ldapsrv_1_1ServerSettings__2__0__0.html">ldapsrv::ServerSettings_2_0_0</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceauth_1_1LdapManager__2__0__0.html#a67d6cf232360d8f3b806325f4aa3c957">getLdapServers</a> ()</td></tr>
<tr class="memdesc:a67d6cf232360d8f3b806325f4aa3c957"><td class="mdescLeft"> </td><td class="mdescRight">Get a list of LDAP server settings. <a href="#a67d6cf232360d8f3b806325f4aa3c957">More...</a><br /></td></tr>
<tr class="separator:a67d6cf232360d8f3b806325f4aa3c957"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1a12e8722c5b54b81d8e8916d4186ffe"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceauth_1_1LdapManager__2__0__0.html#a1a12e8722c5b54b81d8e8916d4186ffe">setLdapServers</a> (in vector< <a class="el" href="structauth_1_1ldapsrv_1_1ServerSettings__2__0__0.html">ldapsrv::ServerSettings_2_0_0</a> > serverList)</td></tr>
<tr class="memdesc:a1a12e8722c5b54b81d8e8916d4186ffe"><td class="mdescLeft"> </td><td class="mdescRight">Sets a list of LDAP servers. <a href="#a1a12e8722c5b54b81d8e8916d4186ffe">More...</a><br /></td></tr>
<tr class="separator:a1a12e8722c5b54b81d8e8916d4186ffe"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2888035184eaea546f4fc19cdac61b9"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceauth_1_1LdapManager__2__0__0.html#ad2888035184eaea546f4fc19cdac61b9">testLdapServer</a> (in string username, in string password, in <a class="el" href="structauth_1_1ldapsrv_1_1ServerSettings__2__0__0.html">ldapsrv::ServerSettings_2_0_0</a> settings, out string diagMsg)</td></tr>
<tr class="memdesc:ad2888035184eaea546f4fc19cdac61b9"><td class="mdescLeft"> </td><td class="mdescRight">Tests an LDAP server configuration. <a href="#ad2888035184eaea546f4fc19cdac61b9">More...</a><br /></td></tr>
<tr class="separator:ad2888035184eaea546f4fc19cdac61b9"><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:afecbc49d73240a1225b40db1c31a2197"><td class="memItemLeft" align="right" valign="top"><a id="afecbc49d73240a1225b40db1c31a2197"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceauth_1_1LdapManager__2__0__0.html#afecbc49d73240a1225b40db1c31a2197">ERR_CYCLIC_DEP</a> = 1</td></tr>
<tr class="memdesc:afecbc49d73240a1225b40db1c31a2197"><td class="mdescLeft"> </td><td class="mdescRight">Cyclic dependency in server list. <br /></td></tr>
<tr class="separator:afecbc49d73240a1225b40db1c31a2197"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78b1aa9f7af9b1d6cf3b0fe3229fc86e"><td class="memItemLeft" align="right" valign="top"><a id="a78b1aa9f7af9b1d6cf3b0fe3229fc86e"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceauth_1_1LdapManager__2__0__0.html#a78b1aa9f7af9b1d6cf3b0fe3229fc86e">ERR_INVALID_CFG</a> = 2</td></tr>
<tr class="memdesc:a78b1aa9f7af9b1d6cf3b0fe3229fc86e"><td class="mdescLeft"> </td><td class="mdescRight">The server configuration is invalid. <br /></td></tr>
<tr class="separator:a78b1aa9f7af9b1d6cf3b0fe3229fc86e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aae11e98f48ae8a5f5e660c1fa524d26e"><td class="memItemLeft" align="right" valign="top"><a id="aae11e98f48ae8a5f5e660c1fa524d26e"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceauth_1_1LdapManager__2__0__0.html#aae11e98f48ae8a5f5e660c1fa524d26e">ERR_SERVER_UNSPECIFIED</a> = 1</td></tr>
<tr class="memdesc:aae11e98f48ae8a5f5e660c1fa524d26e"><td class="mdescLeft"> </td><td class="mdescRight">Unspecified error. <br /></td></tr>
<tr class="separator:aae11e98f48ae8a5f5e660c1fa524d26e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af896cce595bd66002244eb2bcbe87704"><td class="memItemLeft" align="right" valign="top"><a id="af896cce595bd66002244eb2bcbe87704"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceauth_1_1LdapManager__2__0__0.html#af896cce595bd66002244eb2bcbe87704">ERR_SERVER_UNREACHABLE</a> = 3</td></tr>
<tr class="memdesc:af896cce595bd66002244eb2bcbe87704"><td class="mdescLeft"> </td><td class="mdescRight">LDAP server could not be contacted. <br /></td></tr>
<tr class="separator:af896cce595bd66002244eb2bcbe87704"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad3cbe0ea4a16bd33b3e3d0cfc72b8cc6"><td class="memItemLeft" align="right" valign="top"><a id="ad3cbe0ea4a16bd33b3e3d0cfc72b8cc6"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceauth_1_1LdapManager__2__0__0.html#ad3cbe0ea4a16bd33b3e3d0cfc72b8cc6">ERR_AUTHENTICATION_FAILED</a> = 4</td></tr>
<tr class="memdesc:ad3cbe0ea4a16bd33b3e3d0cfc72b8cc6"><td class="mdescLeft"> </td><td class="mdescRight">User could not be authenticated. <br /></td></tr>
<tr class="separator:ad3cbe0ea4a16bd33b3e3d0cfc72b8cc6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9ab60695ae182bfa0c93d4558e8d19a4"><td class="memItemLeft" align="right" valign="top"><a id="a9ab60695ae182bfa0c93d4558e8d19a4"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceauth_1_1LdapManager__2__0__0.html#a9ab60695ae182bfa0c93d4558e8d19a4">ERR_NO_ROLES</a> = 5</td></tr>
<tr class="memdesc:a9ab60695ae182bfa0c93d4558e8d19a4"><td class="mdescLeft"> </td><td class="mdescRight">No roles are defined for the user. <br /></td></tr>
<tr class="separator:a9ab60695ae182bfa0c93d4558e8d19a4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b1d753fa2d49dd235959602d3d5f81f"><td class="memItemLeft" align="right" valign="top"><a id="a6b1d753fa2d49dd235959602d3d5f81f"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfaceauth_1_1LdapManager__2__0__0.html#a6b1d753fa2d49dd235959602d3d5f81f">ERR_NO_KNOWN_ROLES</a> = 6</td></tr>
<tr class="memdesc:a6b1d753fa2d49dd235959602d3d5f81f"><td class="mdescLeft"> </td><td class="mdescRight">No known rules are defined for the user. <br /></td></tr>
<tr class="separator:a6b1d753fa2d49dd235959602d3d5f81f"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>LDAP server configuration interface. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a67d6cf232360d8f3b806325f4aa3c957"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67d6cf232360d8f3b806325f4aa3c957">◆ </a></span>getLdapServers()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structauth_1_1ldapsrv_1_1ServerSettings__2__0__0.html">ldapsrv::ServerSettings_2_0_0</a>> auth::LdapManager_2_0_0::getLdapServers </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a list of LDAP server settings. </p>
<dl class="section return"><dt>Returns</dt><dd>list of ldapsrv::ServerSettings </dd></dl>
</div>
</div>
<a id="a1a12e8722c5b54b81d8e8916d4186ffe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1a12e8722c5b54b81d8e8916d4186ffe">◆ </a></span>setLdapServers()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int auth::LdapManager_2_0_0::setLdapServers </td>
<td>(</td>
<td class="paramtype">in vector< <a class="el" href="structauth_1_1ldapsrv_1_1ServerSettings__2__0__0.html">ldapsrv::ServerSettings_2_0_0</a> > </td>
<td class="paramname"><em>serverList</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets a list of LDAP servers. </p>
<p>Any existing LDAP Server configuration will be cleared / overwritten.</p>
<dl class="section return"><dt>Returns</dt><dd>0 on success </dd>
<dd>
<code>ERR_CYCLIC_DEP</code> in case of cyclic dependency </dd>
<dd>
<code>ERR_INVALID_CFG</code> in case of invalid configuration </dd></dl>
</div>
</div>
<a id="ad2888035184eaea546f4fc19cdac61b9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2888035184eaea546f4fc19cdac61b9">◆ </a></span>testLdapServer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int auth::LdapManager_2_0_0::testLdapServer </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="structauth_1_1ldapsrv_1_1ServerSettings__2__0__0.html">ldapsrv::ServerSettings_2_0_0</a> </td>
<td class="paramname"><em>settings</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out string </td>
<td class="paramname"><em>diagMsg</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Tests an LDAP server configuration. </p>
<dl class="section return"><dt>Returns</dt><dd>0 on success </dd>
<dd>
<code>ERR_SERVER_UNSPECIFIED</code> an unspecified error occurred </dd>
<dd>
<code>ERR_INVALID_CFG</code> LDAP server configuration is invalid (reused from setLdapServers) </dd>
<dd>
<code>ERR_SERVER_UNREACHABLE</code> LDAP server could not be contacted </dd>
<dd>
<code>ERR_AUTHENTICATION_FAILED</code> user could not be authenticated </dd>
<dd>
<code>ERR_NO_ROLES</code> no roles are defined for the user </dd>
<dd>
<code>ERR_NO_KNOWN_ROLES</code> no known roles are defined for the user </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="LdapManager_8idl_source.html">LdapManager.idl</a></li>
</ul>
</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>
|
