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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
|
<!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: bulkcfg::BulkConfiguration 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="namespacebulkcfg.html">bulkcfg</a></li><li class="navelem"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html">BulkConfiguration</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="interfacebulkcfg_1_1BulkConfiguration-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">bulkcfg::BulkConfiguration Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Bulk Configuration Interface.
<a href="interfacebulkcfg_1_1BulkConfiguration.html#details">More...</a></p>
<p><code>import"<a class="el" href="BulkConfiguration_8idl_source.html">BulkConfiguration.idl</a>";</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1Filter.html">Filter</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">This structure defines a filter. <a href="structbulkcfg_1_1BulkConfiguration_1_1Filter.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1FilterProfile.html">FilterProfile</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1Filter.html" title="This structure defines a filter.">Filter</a> profiles are named collections of filters. <a href="structbulkcfg_1_1BulkConfiguration_1_1FilterProfile.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1RestoredEvent.html">RestoredEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event: Bulk configuration restored (also used for restoring config backup) <a href="structbulkcfg_1_1BulkConfiguration_1_1RestoredEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1SavedEvent.html">SavedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event: Bulk configuration saved (also used for saving config backup) <a href="structbulkcfg_1_1BulkConfiguration_1_1SavedEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1Settings.html">Settings</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1Settings.html" title="Settings.">Settings</a>. <a href="structbulkcfg_1_1BulkConfiguration_1_1Settings.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1SettingsChangedEvent.html">SettingsChangedEvent</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Event: Bulk configuration settings changed. <a href="structbulkcfg_1_1BulkConfiguration_1_1SettingsChangedEvent.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a673bbbeab03f4cc6b81c38577919ad5d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a673bbbeab03f4cc6b81c38577919ad5d">Status</a> { <br />
  <a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a673bbbeab03f4cc6b81c38577919ad5da829ca765d8874af1703cf765a6039eaa">UNKNOWN</a>
, <a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a673bbbeab03f4cc6b81c38577919ad5da8a01e4f4b9715f5908ddd7ab0e67186d">UPLOAD_FAILED</a>
, <a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a673bbbeab03f4cc6b81c38577919ad5dae7ceddcf8d76e3ab286cba7ecb126bea">RESTORE_PENDING</a>
, <a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a673bbbeab03f4cc6b81c38577919ad5da7377f6c1e89e957597b625742beb7f83">RESTORE_OK</a>
, <br />
  <a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a673bbbeab03f4cc6b81c38577919ad5dadaa65b6a58833077d713ad8a7276ab56">RESTORE_FAILED</a>
<br />
}</td></tr>
<tr class="memdesc:a673bbbeab03f4cc6b81c38577919ad5d"><td class="mdescLeft"> </td><td class="mdescRight">Status of the last bulk configuration restore operation. <a href="interfacebulkcfg_1_1BulkConfiguration.html#a673bbbeab03f4cc6b81c38577919ad5d">More...</a><br /></td></tr>
<tr class="separator:a673bbbeab03f4cc6b81c38577919ad5d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aad46457f219282af6f54349365f1be55"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#aad46457f219282af6f54349365f1be55">FilterType</a> { <a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#aad46457f219282af6f54349365f1be55af1ec82b95aa387aac5e07eee410adac1">WHITELIST</a>
, <a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#aad46457f219282af6f54349365f1be55a7677c26772a22ad594bc342ec0d04894">BLACKLIST</a>
}</td></tr>
<tr class="memdesc:aad46457f219282af6f54349365f1be55"><td class="mdescLeft"> </td><td class="mdescRight">These are the supported supported filter types. <a href="interfacebulkcfg_1_1BulkConfiguration.html#aad46457f219282af6f54349365f1be55">More...</a><br /></td></tr>
<tr class="separator:aad46457f219282af6f54349365f1be55"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a8a7ef84928639decd9670a956d49a407"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a8a7ef84928639decd9670a956d49a407">getStatus</a> (out <a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a673bbbeab03f4cc6b81c38577919ad5d">Status</a> status, out time timeStamp)</td></tr>
<tr class="memdesc:a8a7ef84928639decd9670a956d49a407"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the status of the last bulk configuration restore operation. <a href="interfacebulkcfg_1_1BulkConfiguration.html#a8a7ef84928639decd9670a956d49a407">More...</a><br /></td></tr>
<tr class="separator:a8a7ef84928639decd9670a956d49a407"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac086ad42379f53b15fcab21e0f02991d"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1Filter.html">Filter</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#ac086ad42379f53b15fcab21e0f02991d">getFilters</a> ()</td></tr>
<tr class="memdesc:ac086ad42379f53b15fcab21e0f02991d"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the list of supported filters. <a href="interfacebulkcfg_1_1BulkConfiguration.html#ac086ad42379f53b15fcab21e0f02991d">More...</a><br /></td></tr>
<tr class="separator:ac086ad42379f53b15fcab21e0f02991d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ddb94486f0856d2ddebb3054e8413e4"><td class="memItemLeft" align="right" valign="top">vector< <a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1FilterProfile.html">FilterProfile</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a3ddb94486f0856d2ddebb3054e8413e4">getFilterProfiles</a> ()</td></tr>
<tr class="memdesc:a3ddb94486f0856d2ddebb3054e8413e4"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the configured filter profiles. <a href="interfacebulkcfg_1_1BulkConfiguration.html#a3ddb94486f0856d2ddebb3054e8413e4">More...</a><br /></td></tr>
<tr class="separator:a3ddb94486f0856d2ddebb3054e8413e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e0c0d9804a51b631e3c949a94716953"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a7e0c0d9804a51b631e3c949a94716953">addFilterProfile</a> (in <a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1FilterProfile.html">FilterProfile</a> profile)</td></tr>
<tr class="memdesc:a7e0c0d9804a51b631e3c949a94716953"><td class="mdescLeft"> </td><td class="mdescRight">Add a new filter profile. <a href="interfacebulkcfg_1_1BulkConfiguration.html#a7e0c0d9804a51b631e3c949a94716953">More...</a><br /></td></tr>
<tr class="separator:a7e0c0d9804a51b631e3c949a94716953"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aadecd65ff4429b09f57ff0b8c4efb4a8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#aadecd65ff4429b09f57ff0b8c4efb4a8">modifyFilterProfile</a> (in <a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1FilterProfile.html">FilterProfile</a> profile)</td></tr>
<tr class="memdesc:aadecd65ff4429b09f57ff0b8c4efb4a8"><td class="mdescLeft"> </td><td class="mdescRight">Modify an existing filter profile. <a href="interfacebulkcfg_1_1BulkConfiguration.html#aadecd65ff4429b09f57ff0b8c4efb4a8">More...</a><br /></td></tr>
<tr class="separator:aadecd65ff4429b09f57ff0b8c4efb4a8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9cf3140e619618b0d47a9dbdb601c587"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a9cf3140e619618b0d47a9dbdb601c587">deleteFilterProfile</a> (in string profileName)</td></tr>
<tr class="memdesc:a9cf3140e619618b0d47a9dbdb601c587"><td class="mdescLeft"> </td><td class="mdescRight">Delete an existing filter profile. <a href="interfacebulkcfg_1_1BulkConfiguration.html#a9cf3140e619618b0d47a9dbdb601c587">More...</a><br /></td></tr>
<tr class="separator:a9cf3140e619618b0d47a9dbdb601c587"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1501cefabb6962685128eaa0f6bd49f8"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a1501cefabb6962685128eaa0f6bd49f8">getDefaultFilterProfileName</a> ()</td></tr>
<tr class="memdesc:a1501cefabb6962685128eaa0f6bd49f8"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve the name of the currently selected default profile. <a href="interfacebulkcfg_1_1BulkConfiguration.html#a1501cefabb6962685128eaa0f6bd49f8">More...</a><br /></td></tr>
<tr class="separator:a1501cefabb6962685128eaa0f6bd49f8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeeb953c79090e72df06922685f464803"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#aeeb953c79090e72df06922685f464803">selectDefaultFilterProfile</a> (in string profileName)</td></tr>
<tr class="memdesc:aeeb953c79090e72df06922685f464803"><td class="mdescLeft"> </td><td class="mdescRight">Select a new default filter profile. <a href="interfacebulkcfg_1_1BulkConfiguration.html#aeeb953c79090e72df06922685f464803">More...</a><br /></td></tr>
<tr class="separator:aeeb953c79090e72df06922685f464803"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a212dc286f8d4261c3b066eb34d8427c1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1Settings.html">Settings</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a212dc286f8d4261c3b066eb34d8427c1">getSettings</a> ()</td></tr>
<tr class="memdesc:a212dc286f8d4261c3b066eb34d8427c1"><td class="mdescLeft"> </td><td class="mdescRight">Get settings. <a href="interfacebulkcfg_1_1BulkConfiguration.html#a212dc286f8d4261c3b066eb34d8427c1">More...</a><br /></td></tr>
<tr class="separator:a212dc286f8d4261c3b066eb34d8427c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a339c1f8b9c9657545e5eb6c74f75e6db"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a339c1f8b9c9657545e5eb6c74f75e6db">setSettings</a> (in <a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1Settings.html">Settings</a> settings)</td></tr>
<tr class="memdesc:a339c1f8b9c9657545e5eb6c74f75e6db"><td class="mdescLeft"> </td><td class="mdescRight">Set settings. <a href="interfacebulkcfg_1_1BulkConfiguration.html#a339c1f8b9c9657545e5eb6c74f75e6db">More...</a><br /></td></tr>
<tr class="separator:a339c1f8b9c9657545e5eb6c74f75e6db"><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:ad5d2b273af29822657c596f1b6d36bde"><td class="memItemLeft" align="right" valign="top">constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#ad5d2b273af29822657c596f1b6d36bde">SUCCESS</a> = 0</td></tr>
<tr class="memdesc:ad5d2b273af29822657c596f1b6d36bde"><td class="mdescLeft"> </td><td class="mdescRight">Error codes. <a href="interfacebulkcfg_1_1BulkConfiguration.html#ad5d2b273af29822657c596f1b6d36bde">More...</a><br /></td></tr>
<tr class="separator:ad5d2b273af29822657c596f1b6d36bde"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa3cd3d50b6a2cd1b712ccc1b4855607"><td class="memItemLeft" align="right" valign="top"><a id="afa3cd3d50b6a2cd1b712ccc1b4855607"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#afa3cd3d50b6a2cd1b712ccc1b4855607">ERR_FILTER_NAME_UNKNOWN</a> = 1</td></tr>
<tr class="memdesc:afa3cd3d50b6a2cd1b712ccc1b4855607"><td class="mdescLeft"> </td><td class="mdescRight">A referenced filter name is unknown. <br /></td></tr>
<tr class="separator:afa3cd3d50b6a2cd1b712ccc1b4855607"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6b664182dd359227791638a4c0ac8049"><td class="memItemLeft" align="right" valign="top"><a id="a6b664182dd359227791638a4c0ac8049"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a6b664182dd359227791638a4c0ac8049">ERR_FILTER_TYPE_READONLY</a> = 2</td></tr>
<tr class="memdesc:a6b664182dd359227791638a4c0ac8049"><td class="mdescLeft"> </td><td class="mdescRight">A referenced filter can't be overridden. <br /></td></tr>
<tr class="separator:a6b664182dd359227791638a4c0ac8049"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad478eb53ab23634a92d051e7c5fc24b6"><td class="memItemLeft" align="right" valign="top"><a id="ad478eb53ab23634a92d051e7c5fc24b6"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#ad478eb53ab23634a92d051e7c5fc24b6">ERR_PROFILE_ALREADY_EXISTS</a> = 3</td></tr>
<tr class="memdesc:ad478eb53ab23634a92d051e7c5fc24b6"><td class="mdescLeft"> </td><td class="mdescRight">A profile with the given name already exists. <br /></td></tr>
<tr class="separator:ad478eb53ab23634a92d051e7c5fc24b6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2834e75b4358648e63558355298faaca"><td class="memItemLeft" align="right" valign="top"><a id="a2834e75b4358648e63558355298faaca"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a2834e75b4358648e63558355298faaca">ERR_PROFILE_DOES_NOT_EXIST</a> = 4</td></tr>
<tr class="memdesc:a2834e75b4358648e63558355298faaca"><td class="mdescLeft"> </td><td class="mdescRight">A profile with the given name does not exist. <br /></td></tr>
<tr class="separator:a2834e75b4358648e63558355298faaca"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adb2b16a26ca41595528b7a701e7f7ae5"><td class="memItemLeft" align="right" valign="top"><a id="adb2b16a26ca41595528b7a701e7f7ae5"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#adb2b16a26ca41595528b7a701e7f7ae5">ERR_PROFILE_IS_DEFAULT</a> = 5</td></tr>
<tr class="memdesc:adb2b16a26ca41595528b7a701e7f7ae5"><td class="mdescLeft"> </td><td class="mdescRight">The selected profile is the current default profile. <br /></td></tr>
<tr class="separator:adb2b16a26ca41595528b7a701e7f7ae5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aea513d23bd9bce2cad2ba35e6b934182"><td class="memItemLeft" align="right" valign="top"><a id="aea513d23bd9bce2cad2ba35e6b934182"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#aea513d23bd9bce2cad2ba35e6b934182">ERR_PROFILE_IS_BUILTIN</a> = 6</td></tr>
<tr class="memdesc:aea513d23bd9bce2cad2ba35e6b934182"><td class="mdescLeft"> </td><td class="mdescRight">The selected profile is the builtin profile. <br /></td></tr>
<tr class="separator:aea513d23bd9bce2cad2ba35e6b934182"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e44b42bd0bdf13fbd5685eef17c1330"><td class="memItemLeft" align="right" valign="top"><a id="a0e44b42bd0bdf13fbd5685eef17c1330"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a0e44b42bd0bdf13fbd5685eef17c1330">ERR_PROFILE_NAME_TOO_LONG</a> = 7</td></tr>
<tr class="memdesc:a0e44b42bd0bdf13fbd5685eef17c1330"><td class="mdescLeft"> </td><td class="mdescRight">The profile name is too long. <br /></td></tr>
<tr class="separator:a0e44b42bd0bdf13fbd5685eef17c1330"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afbfd875bf302e0e90d4844a9be3ed887"><td class="memItemLeft" align="right" valign="top"><a id="afbfd875bf302e0e90d4844a9be3ed887"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#afbfd875bf302e0e90d4844a9be3ed887">ERR_PROFILE_NAME_INVALID</a> = 8</td></tr>
<tr class="memdesc:afbfd875bf302e0e90d4844a9be3ed887"><td class="mdescLeft"> </td><td class="mdescRight">The profile name contains invalid characters. <br /></td></tr>
<tr class="separator:afbfd875bf302e0e90d4844a9be3ed887"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aec615e0aebf21668361d9351b1097181"><td class="memItemLeft" align="right" valign="top"><a id="aec615e0aebf21668361d9351b1097181"></a>
constant int </td><td class="memItemRight" valign="bottom"><a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#aec615e0aebf21668361d9351b1097181">ERR_PROFILE_TOO_MANY</a> = 9</td></tr>
<tr class="memdesc:aec615e0aebf21668361d9351b1097181"><td class="mdescLeft"> </td><td class="mdescRight">The maximum number of profiles already exist. <br /></td></tr>
<tr class="separator:aec615e0aebf21668361d9351b1097181"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Bulk Configuration Interface. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="aad46457f219282af6f54349365f1be55"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad46457f219282af6f54349365f1be55">◆ </a></span>FilterType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#aad46457f219282af6f54349365f1be55">bulkcfg::BulkConfiguration::FilterType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>These are the supported supported filter types. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aad46457f219282af6f54349365f1be55af1ec82b95aa387aac5e07eee410adac1"></a>WHITELIST </td><td class="fielddoc"><p>Whitelist filter (value is part of the bulk configuration) </p>
</td></tr>
<tr><td class="fieldname"><a id="aad46457f219282af6f54349365f1be55a7677c26772a22ad594bc342ec0d04894"></a>BLACKLIST </td><td class="fielddoc"><p>Blacklist filter (value is not part of the bulk configuration) </p>
</td></tr>
</table>
</div>
</div>
<a id="a673bbbeab03f4cc6b81c38577919ad5d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a673bbbeab03f4cc6b81c38577919ad5d">◆ </a></span>Status</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a673bbbeab03f4cc6b81c38577919ad5d">bulkcfg::BulkConfiguration::Status</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Status of the last bulk configuration restore operation. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a673bbbeab03f4cc6b81c38577919ad5da829ca765d8874af1703cf765a6039eaa"></a>UNKNOWN </td><td class="fielddoc"><p>No bulk configuration was done yet. </p>
</td></tr>
<tr><td class="fieldname"><a id="a673bbbeab03f4cc6b81c38577919ad5da8a01e4f4b9715f5908ddd7ab0e67186d"></a>UPLOAD_FAILED </td><td class="fielddoc"><p>Uploading a bulk configuration failed. </p>
</td></tr>
<tr><td class="fieldname"><a id="a673bbbeab03f4cc6b81c38577919ad5dae7ceddcf8d76e3ab286cba7ecb126bea"></a>RESTORE_PENDING </td><td class="fielddoc"><p>Restore is pending. </p>
</td></tr>
<tr><td class="fieldname"><a id="a673bbbeab03f4cc6b81c38577919ad5da7377f6c1e89e957597b625742beb7f83"></a>RESTORE_OK </td><td class="fielddoc"><p>Restoring bulk configuration successful. </p>
</td></tr>
<tr><td class="fieldname"><a id="a673bbbeab03f4cc6b81c38577919ad5dadaa65b6a58833077d713ad8a7276ab56"></a>RESTORE_FAILED </td><td class="fielddoc"><p>Restoring bulk configuration failed. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a7e0c0d9804a51b631e3c949a94716953"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7e0c0d9804a51b631e3c949a94716953">◆ </a></span>addFilterProfile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int bulkcfg::BulkConfiguration::addFilterProfile </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1FilterProfile.html">FilterProfile</a> </td>
<td class="paramname"><em>profile</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Add a new filter profile. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>The new filter profile</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS if OK </dd>
<dd>
ERR_FILTER_NAME_UNKNOWN if a referenced filter name is unknown </dd>
<dd>
ERR_FILTER_TYPE_READONLY if a referenced filter can't be overridden </dd>
<dd>
ERR_PROFILE_ALREADY_EXISTS if a profile with the given name already exists </dd>
<dd>
ERR_PROFILE_IS_BUILTIN if the selected profile is the builtin profile </dd>
<dd>
ERR_PROFILE_NAME_TOO_LONG if the profile name is too long </dd>
<dd>
ERR_PROFILE_NAME_INVALID if the profile name contains invalid characters </dd>
<dd>
ERR_PROFILE_TOO_MANY if the maximum number of profiles already exist </dd></dl>
</div>
</div>
<a id="a9cf3140e619618b0d47a9dbdb601c587"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9cf3140e619618b0d47a9dbdb601c587">◆ </a></span>deleteFilterProfile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int bulkcfg::BulkConfiguration::deleteFilterProfile </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>profileName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Delete an existing filter profile. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profileName</td><td>The name of the profile to be deleted</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS if OK </dd>
<dd>
ERR_PROFILE_DOES_NOT_EXIST if a profile with the given name does not exist </dd>
<dd>
ERR_PROFILE_IS_DEFAULT if the selected profile is the current default profile </dd>
<dd>
ERR_PROFILE_IS_BUILTIN if the selected profile is the builtin profile </dd></dl>
</div>
</div>
<a id="a1501cefabb6962685128eaa0f6bd49f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1501cefabb6962685128eaa0f6bd49f8">◆ </a></span>getDefaultFilterProfileName()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">string bulkcfg::BulkConfiguration::getDefaultFilterProfileName </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the name of the currently selected default profile. </p>
<dl class="section return"><dt>Returns</dt><dd>The name of the current default profile </dd></dl>
</div>
</div>
<a id="a3ddb94486f0856d2ddebb3054e8413e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3ddb94486f0856d2ddebb3054e8413e4">◆ </a></span>getFilterProfiles()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1FilterProfile.html">FilterProfile</a>> bulkcfg::BulkConfiguration::getFilterProfiles </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the configured filter profiles. </p>
<dl class="section return"><dt>Returns</dt><dd>List of filter profiles </dd></dl>
</div>
</div>
<a id="ac086ad42379f53b15fcab21e0f02991d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac086ad42379f53b15fcab21e0f02991d">◆ </a></span>getFilters()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector<<a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1Filter.html">Filter</a>> bulkcfg::BulkConfiguration::getFilters </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the list of supported filters. </p>
<dl class="section return"><dt>Returns</dt><dd>List of supported filters </dd></dl>
</div>
</div>
<a id="a212dc286f8d4261c3b066eb34d8427c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a212dc286f8d4261c3b066eb34d8427c1">◆ </a></span>getSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1Settings.html">Settings</a> bulkcfg::BulkConfiguration::getSettings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get settings. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1Settings.html" title="Settings.">Settings</a> </dd></dl>
</div>
</div>
<a id="a8a7ef84928639decd9670a956d49a407"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8a7ef84928639decd9670a956d49a407">◆ </a></span>getStatus()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void bulkcfg::BulkConfiguration::getStatus </td>
<td>(</td>
<td class="paramtype">out <a class="el" href="interfacebulkcfg_1_1BulkConfiguration.html#a673bbbeab03f4cc6b81c38577919ad5d">Status</a> </td>
<td class="paramname"><em>status</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out time </td>
<td class="paramname"><em>timeStamp</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the status of the last bulk configuration restore operation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">status</td><td>Result: Bulk configuration restore status </td></tr>
<tr><td class="paramname">timeStamp</td><td>Result: Time of last restore operation (UNIX timestamp, UTC) </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aadecd65ff4429b09f57ff0b8c4efb4a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aadecd65ff4429b09f57ff0b8c4efb4a8">◆ </a></span>modifyFilterProfile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int bulkcfg::BulkConfiguration::modifyFilterProfile </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1FilterProfile.html">FilterProfile</a> </td>
<td class="paramname"><em>profile</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Modify an existing filter profile. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profile</td><td>The updated filter profile</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS if OK </dd>
<dd>
ERR_FILTER_NAME_UNKNOWN if a referenced filter name is unknown </dd>
<dd>
ERR_FILTER_TYPE_READONLY if a referenced filter can't be overridden </dd>
<dd>
ERR_PROFILE_DOES_NOT_EXIST if a profile with the given name does not exist </dd>
<dd>
ERR_PROFILE_IS_BUILTIN if the selected profile is the builtin profile </dd></dl>
</div>
</div>
<a id="aeeb953c79090e72df06922685f464803"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeeb953c79090e72df06922685f464803">◆ </a></span>selectDefaultFilterProfile()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int bulkcfg::BulkConfiguration::selectDefaultFilterProfile </td>
<td>(</td>
<td class="paramtype">in string </td>
<td class="paramname"><em>profileName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Select a new default filter profile. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">profileName</td><td>The name of the new default profile</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS if OK </dd>
<dd>
ERR_PROFILE_DOES_NOT_EXIST if a profile with the given name does not exist </dd></dl>
</div>
</div>
<a id="a339c1f8b9c9657545e5eb6c74f75e6db"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a339c1f8b9c9657545e5eb6c74f75e6db">◆ </a></span>setSettings()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int bulkcfg::BulkConfiguration::setSettings </td>
<td>(</td>
<td class="paramtype">in <a class="el" href="structbulkcfg_1_1BulkConfiguration_1_1Settings.html">Settings</a> </td>
<td class="paramname"><em>settings</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set settings. </p>
<p>NOTE: The builtin profile will be ignored when present in the list of filter profiles.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">settings</td><td>The settings to set</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SUCCESS if OK </dd>
<dd>
ERR_FILTER_NAME_UNKNOWN if a referenced filter name is unknown </dd>
<dd>
ERR_FILTER_TYPE_READONLY if a referenced filter can't be overridden </dd>
<dd>
ERR_PROFILE_ALREADY_EXISTS if the settings contain multiple profiles with the same name </dd>
<dd>
ERR_PROFILE_NAME_TOO_LONG if the profile name is too long </dd>
<dd>
ERR_PROFILE_NAME_INVALID if the profile name contains invalid characters </dd>
<dd>
ERR_PROFILE_TOO_MANY if the settings contain too many profiles </dd>
<dd>
ERR_PROFILE_DOES_NOT_EXIST if a profile with the given name does not exist </dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ad5d2b273af29822657c596f1b6d36bde"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad5d2b273af29822657c596f1b6d36bde">◆ </a></span>SUCCESS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">constant int bulkcfg::BulkConfiguration::SUCCESS = 0</td>
</tr>
</table>
</div><div class="memdoc">
<p>Error codes. </p>
<p>The operation was successful </p>
</div>
</div>
<hr/>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="BulkConfiguration_8idl_source.html">BulkConfiguration.idl</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Oct 17 2022 00:25:43 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>
|
