UNPKG

11.9 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Module: bigIqLicenseProviderFactory</title>
6
7 <script src="scripts/prettify/prettify.js"> </script>
8 <script src="scripts/prettify/lang-css.js"> </script>
9 <!--[if lt IE 9]>
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
11 <![endif]-->
12 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
13 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
14</head>
15
16<body>
17
18<div id="main">
19
20 <h1 class="page-title">Module: bigIqLicenseProviderFactory</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31
32
33</header>
34
35<article>
36 <div class="container-overview">
37
38
39
40
41
42 </div>
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59 <h3 class="subsection-title">Methods</h3>
60
61
62
63
64
65
66
67 <h4 class="name" id=".getLicenseProviderByType"><span class="type-signature">(static) </span>getLicenseProviderByType<span class="signature">(poolType, {BigIp}, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
68
69
70
71
72
73
74<div class="description">
75 <p>Creates a BIG-IQ license provider for the given API type</p>
76</div>
77
78
79
80
81
82
83
84
85
86 <h5>Parameters:</h5>
87
88
89<table class="params">
90 <thead>
91 <tr>
92
93 <th>Name</th>
94
95
96 <th>Type</th>
97
98
99 <th>Attributes</th>
100
101
102
103
104 <th class="last">Description</th>
105 </tr>
106 </thead>
107
108 <tbody>
109
110
111 <tr>
112
113 <td class="name"><code>poolType</code></td>
114
115
116 <td class="type">
117
118
119<span class="param-type">String</span>
120
121
122
123 </td>
124
125
126 <td class="attributes">
127
128
129
130
131
132 </td>
133
134
135
136
137 <td class="description last"><p>Type of the API to use
138 <a href="module-sharedConstants.html#.LICENSE_API_TYPES">module:sharedConstants.LICENSE_API_TYPES</a></p></td>
139 </tr>
140
141
142
143 <tr>
144
145 <td class="name"><code>{BigIp}</code></td>
146
147
148 <td class="type">
149
150
151<span class="param-type">Object</span>
152
153
154
155 </td>
156
157
158 <td class="attributes">
159
160
161
162
163
164 </td>
165
166
167
168
169 <td class="description last"><p>See <a href="BigIp.html">BigIp</a>.</p></td>
170 </tr>
171
172
173
174 <tr>
175
176 <td class="name"><code>options</code></td>
177
178
179 <td class="type">
180
181
182<span class="param-type">Ojbect</span>
183
184
185
186 </td>
187
188
189 <td class="attributes">
190
191 &lt;optional><br>
192
193
194
195
196
197 </td>
198
199
200
201
202 <td class="description last"><p>Options for the instance.</p>
203 <h6>Properties</h6>
204
205
206<table class="params">
207 <thead>
208 <tr>
209
210 <th>Name</th>
211
212
213 <th>Type</th>
214
215
216 <th>Attributes</th>
217
218
219
220
221 <th class="last">Description</th>
222 </tr>
223 </thead>
224
225 <tbody>
226
227
228 <tr>
229
230 <td class="name"><code>logger</code></td>
231
232
233 <td class="type">
234
235
236<span class="param-type">Object</span>
237
238
239
240 </td>
241
242
243 <td class="attributes">
244
245 &lt;optional><br>
246
247
248
249
250
251 </td>
252
253
254
255
256 <td class="description last"><p>Logger to use. Or, pass loggerOptions to get your own logger.</p></td>
257 </tr>
258
259
260
261 <tr>
262
263 <td class="name"><code>loggerOptions</code></td>
264
265
266 <td class="type">
267
268
269<span class="param-type">Object</span>
270
271
272
273 </td>
274
275
276 <td class="attributes">
277
278 &lt;optional><br>
279
280
281
282
283
284 </td>
285
286
287
288
289 <td class="description last"><p>Options for the logger.
290 See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
291 </tr>
292
293
294
295 <tr>
296
297 <td class="name"><code>version</code></td>
298
299
300 <td class="type">
301
302
303<span class="param-type">String</span>
304
305
306
307 </td>
308
309
310 <td class="attributes">
311
312 &lt;optional><br>
313
314
315
316
317
318 </td>
319
320
321
322
323 <td class="description last"><p>The version of BIG-IQ.</p></td>
324 </tr>
325
326
327 </tbody>
328</table>
329
330 </td>
331 </tr>
332
333
334 </tbody>
335</table>
336
337
338
339
340
341
342<dl class="details">
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</dl>
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 <h4 class="name" id=".getLicenseProviderByVersion"><span class="type-signature">(static) </span>getLicenseProviderByVersion<span class="signature">(bigIqVersion, {BigIp}, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
401
402
403
404
405
406
407<div class="description">
408 <p>Creates a BIG-IQ license provider for the given version</p>
409</div>
410
411
412
413
414
415
416
417
418
419 <h5>Parameters:</h5>
420
421
422<table class="params">
423 <thead>
424 <tr>
425
426 <th>Name</th>
427
428
429 <th>Type</th>
430
431
432 <th>Attributes</th>
433
434
435
436
437 <th class="last">Description</th>
438 </tr>
439 </thead>
440
441 <tbody>
442
443
444 <tr>
445
446 <td class="name"><code>bigIqVersion</code></td>
447
448
449 <td class="type">
450
451
452<span class="param-type">String</span>
453
454
455
456 </td>
457
458
459 <td class="attributes">
460
461
462
463
464
465 </td>
466
467
468
469
470 <td class="description last"><p>Version of BIG-IQ.</p></td>
471 </tr>
472
473
474
475 <tr>
476
477 <td class="name"><code>{BigIp}</code></td>
478
479
480 <td class="type">
481
482
483<span class="param-type">Object</span>
484
485
486
487 </td>
488
489
490 <td class="attributes">
491
492
493
494
495
496 </td>
497
498
499
500
501 <td class="description last"><p>See <a href="BigIp.html">BigIp</a>.</p></td>
502 </tr>
503
504
505
506 <tr>
507
508 <td class="name"><code>options</code></td>
509
510
511 <td class="type">
512
513
514<span class="param-type">Ojbect</span>
515
516
517
518 </td>
519
520
521 <td class="attributes">
522
523 &lt;optional><br>
524
525
526
527
528
529 </td>
530
531
532
533
534 <td class="description last"><p>Options for the instance.</p>
535 <h6>Properties</h6>
536
537
538<table class="params">
539 <thead>
540 <tr>
541
542 <th>Name</th>
543
544
545 <th>Type</th>
546
547
548 <th>Attributes</th>
549
550
551
552
553 <th class="last">Description</th>
554 </tr>
555 </thead>
556
557 <tbody>
558
559
560 <tr>
561
562 <td class="name"><code>logger</code></td>
563
564
565 <td class="type">
566
567
568<span class="param-type">Object</span>
569
570
571
572 </td>
573
574
575 <td class="attributes">
576
577 &lt;optional><br>
578
579
580
581
582
583 </td>
584
585
586
587
588 <td class="description last"><p>Logger to use. Or, pass loggerOptions to get your own logger.</p></td>
589 </tr>
590
591
592
593 <tr>
594
595 <td class="name"><code>loggerOptions</code></td>
596
597
598 <td class="type">
599
600
601<span class="param-type">Object</span>
602
603
604
605 </td>
606
607
608 <td class="attributes">
609
610 &lt;optional><br>
611
612
613
614
615
616 </td>
617
618
619
620
621 <td class="description last"><p>Options for the logger.
622 See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
623 </tr>
624
625
626 </tbody>
627</table>
628
629 </td>
630 </tr>
631
632
633 </tbody>
634</table>
635
636
637
638
639
640
641<dl class="details">
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674</dl>
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699</article>
700
701</section>
702
703
704
705
706</div>
707
708<nav>
709 <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-authn.html">authn</a></li><li><a href="module-bigIqLicenseProviderFactory.html">bigIqLicenseProviderFactory</a></li><li><a href="module-cryptoUtil.html">cryptoUtil</a></li><li><a href="module-httpUtil.html">httpUtil</a></li><li><a href="module-ipc.html">ipc</a></li><li><a href="module-localCryptoUtil.html">localCryptoUtil</a></li><li><a href="module-localKeyUtil.html">localKeyUtil</a></li><li><a href="module-logger.html">logger</a></li><li><a href="module-metricsCollector.html">metricsCollector</a></li><li><a href="module-sharedConstants.html">sharedConstants</a></li><li><a href="module-signals.html">signals</a></li><li><a href="module-util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="BigIp.html">BigIp</a></li><li><a href="BigIpCluster.html">BigIpCluster</a></li><li><a href="BigIpGtm.html">BigIpGtm</a></li><li><a href="BigIpOnboard.html">BigIpOnboard</a></li><li><a href="BigIq.html">BigIq</a></li><li><a href="BigIq50LicenseProvider.html">BigIq50LicenseProvider</a></li><li><a href="BigIq52LicenseProvider.html">BigIq52LicenseProvider</a></li><li><a href="BigIq53LicenseProvider.html">BigIq53LicenseProvider</a></li><li><a href="BigIq54LicenseProvider.html">BigIq54LicenseProvider</a></li><li><a href="CloudProvider.html">CloudProvider</a></li><li><a href="DnsProvider.html">DnsProvider</a></li><li><a href="GenericNodeProvider.html">GenericNodeProvider</a></li><li><a href="GtmDnsProvider.html">GtmDnsProvider</a></li><li><a href="IControl.html">IControl</a></li></ul><h3>Mixins</h3><ul><li><a href="bigIqClusterMixins.html">bigIqClusterMixins</a></li><li><a href="bigIqOnboardMixins.html">bigIqOnboardMixins</a></li></ul><h3>Global</h3><ul><li><a href="global.html#checkTask">checkTask</a></li><li><a href="global.html#forceResetUserPassword">forceResetUserPassword</a></li><li><a href="global.html#getDataFromPropPath">getDataFromPropPath</a></li><li><a href="global.html#getLicenseProvider">getLicenseProvider</a></li></ul>
710</nav>
711
712<br class="clear">
713
714<footer>
715 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
716</footer>
717
718<script> prettyPrint(); </script>
719<script src="scripts/linenumber.js"> </script>
720</body>
721</html>
\No newline at end of file