UNPKG

12.4 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Class: BigIq50LicenseProvider</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">Class: BigIq50LicenseProvider</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2><span class="attribs"><span class="type-signature"></span></span>BigIq50LicenseProvider<span class="signature">(bigIp, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
32
33 <div class="class-description"><p>Provides ability to get licenses from BIG-IQ 5.0 (and compatible versions).</p></div>
34
35
36</header>
37
38<article>
39 <div class="container-overview">
40
41
42
43
44 <h2>Constructor</h2>
45
46
47
48 <h4 class="name" id="BigIq50LicenseProvider"><span class="type-signature"></span>new BigIq50LicenseProvider<span class="signature">(bigIp, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
49
50
51
52
53
54
55<div class="description">
56 <p>BigIq 5.0 license provider constructor</p>
57</div>
58
59
60
61
62
63
64
65
66
67 <h5>Parameters:</h5>
68
69
70<table class="params">
71 <thead>
72 <tr>
73
74 <th>Name</th>
75
76
77 <th>Type</th>
78
79
80 <th>Attributes</th>
81
82
83
84
85 <th class="last">Description</th>
86 </tr>
87 </thead>
88
89 <tbody>
90
91
92 <tr>
93
94 <td class="name"><code>bigIp</code></td>
95
96
97 <td class="type">
98
99
100<span class="param-type">Object</span>
101
102
103
104 </td>
105
106
107 <td class="attributes">
108
109
110
111
112
113 </td>
114
115
116
117
118 <td class="description last"><p>Base <a href="BigIp.html">BigIp</a> object.</p></td>
119 </tr>
120
121
122
123 <tr>
124
125 <td class="name"><code>options</code></td>
126
127
128 <td class="type">
129
130
131<span class="param-type">Object</span>
132
133
134
135 </td>
136
137
138 <td class="attributes">
139
140 &lt;optional><br>
141
142
143
144
145
146 </td>
147
148
149
150
151 <td class="description last"><p>Optional parameters.</p>
152 <h6>Properties</h6>
153
154
155<table class="params">
156 <thead>
157 <tr>
158
159 <th>Name</th>
160
161
162 <th>Type</th>
163
164
165 <th>Attributes</th>
166
167
168
169
170 <th class="last">Description</th>
171 </tr>
172 </thead>
173
174 <tbody>
175
176
177 <tr>
178
179 <td class="name"><code>logger</code></td>
180
181
182 <td class="type">
183
184
185<span class="param-type">Object</span>
186
187
188
189 </td>
190
191
192 <td class="attributes">
193
194 &lt;optional><br>
195
196
197
198
199
200 </td>
201
202
203
204
205 <td class="description last"><p>Logger to use. Or, pass loggerOptions to get your own logger.</p></td>
206 </tr>
207
208
209
210 <tr>
211
212 <td class="name"><code>loggerOptions</code></td>
213
214
215 <td class="type">
216
217
218<span class="param-type">Object</span>
219
220
221
222 </td>
223
224
225 <td class="attributes">
226
227 &lt;optional><br>
228
229
230
231
232
233 </td>
234
235
236
237
238 <td class="description last"><p>Options for the logger.
239 See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
240 </tr>
241
242
243 </tbody>
244</table>
245
246 </td>
247 </tr>
248
249
250 </tbody>
251</table>
252
253
254
255
256
257
258<dl class="details">
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</dl>
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311 </div>
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328 <h3 class="subsection-title">Methods</h3>
329
330
331
332
333
334
335
336 <h4 class="name" id="getLicenseTimeout"><span class="type-signature"></span>getLicenseTimeout<span class="signature">()</span><span class="type-signature"></span></h4>
337
338
339
340
341
342
343<div class="description">
344 <p>Gets the license timeout to use</p>
345<p>This is here so that it can be overridden by test code</p>
346</div>
347
348
349
350
351
352
353
354
355
356
357
358
359
360<dl class="details">
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</dl>
394
395
396
397
398
399
400
401
402
403
404
405
406
407<h5>Returns:</h5>
408
409
410<div class="param-desc">
411 <p>the license timeout</p>
412</div>
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428 <h4 class="name" id="getUnmanagedDeviceLicense"><span class="type-signature"></span>getUnmanagedDeviceLicense<span class="signature">(bigIqControl, poolName, bigIpMgmtAddress, bigIpMgmtPort)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
429
430
431
432
433
434
435<div class="description">
436 <p>Gets a license from BIG-IQ for an unmanaged BIG-IP</p>
437</div>
438
439
440
441
442
443
444
445
446
447 <h5>Parameters:</h5>
448
449
450<table class="params">
451 <thead>
452 <tr>
453
454 <th>Name</th>
455
456
457 <th>Type</th>
458
459
460
461
462
463 <th class="last">Description</th>
464 </tr>
465 </thead>
466
467 <tbody>
468
469
470 <tr>
471
472 <td class="name"><code>bigIqControl</code></td>
473
474
475 <td class="type">
476
477
478<span class="param-type">Object</span>
479
480
481
482 </td>
483
484
485
486
487
488 <td class="description last"><p>iControl object for BIG-IQ</p></td>
489 </tr>
490
491
492
493 <tr>
494
495 <td class="name"><code>poolName</code></td>
496
497
498 <td class="type">
499
500
501<span class="param-type">String</span>
502
503
504
505 </td>
506
507
508
509
510
511 <td class="description last"><p>Name of the BIG-IQ license pool to use</p></td>
512 </tr>
513
514
515
516 <tr>
517
518 <td class="name"><code>bigIpMgmtAddress</code></td>
519
520
521 <td class="type">
522
523
524<span class="param-type">String</span>
525
526
527
528 </td>
529
530
531
532
533
534 <td class="description last"><p>IP address of BIG-IP management port.</p></td>
535 </tr>
536
537
538
539 <tr>
540
541 <td class="name"><code>bigIpMgmtPort</code></td>
542
543
544 <td class="type">
545
546
547<span class="param-type">String</span>
548
549
550
551 </td>
552
553
554
555
556
557 <td class="description last"><p>IP port of BIG-IP management port.</p></td>
558 </tr>
559
560
561 </tbody>
562</table>
563
564
565
566
567
568
569<dl class="details">
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602</dl>
603
604
605
606
607
608
609
610
611
612
613
614
615
616<h5>Returns:</h5>
617
618
619<div class="param-desc">
620 <p>A promise which is resolved when the BIG-IP has been licensed
621 or rejected if an error occurs.</p>
622</div>
623
624
625
626<dl>
627 <dt>
628 Type
629 </dt>
630 <dd>
631
632<span class="param-type">Promise</span>
633
634
635 </dd>
636</dl>
637
638
639
640
641
642
643
644
645
646
647
648
649
650 <h4 class="name" id="revoke"><span class="type-signature"></span>revoke<span class="signature">(bigIqControl, poolName, instance)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
651
652
653
654
655
656
657<div class="description">
658 <p>Revokes a license from a BIG-IP</p>
659</div>
660
661
662
663
664
665
666
667
668
669 <h5>Parameters:</h5>
670
671
672<table class="params">
673 <thead>
674 <tr>
675
676 <th>Name</th>
677
678
679 <th>Type</th>
680
681
682
683
684
685 <th class="last">Description</th>
686 </tr>
687 </thead>
688
689 <tbody>
690
691
692 <tr>
693
694 <td class="name"><code>bigIqControl</code></td>
695
696
697 <td class="type">
698
699
700<span class="param-type">Object</span>
701
702
703
704 </td>
705
706
707
708
709
710 <td class="description last"><p>iControl object for BIG-IQ</p></td>
711 </tr>
712
713
714
715 <tr>
716
717 <td class="name"><code>poolName</code></td>
718
719
720 <td class="type">
721
722
723<span class="param-type">String</span>
724
725
726
727 </td>
728
729
730
731
732
733 <td class="description last"><p>Name of the BIG-IQ license pool to use</p></td>
734 </tr>
735
736
737
738 <tr>
739
740 <td class="name"><code>instance</code></td>
741
742
743 <td class="type">
744
745
746<span class="param-type">String</span>
747
748
749
750 </td>
751
752
753
754
755
756 <td class="description last"><p>AutoscaleInstance to revoke license for</p></td>
757 </tr>
758
759
760 </tbody>
761</table>
762
763
764
765
766
767
768<dl class="details">
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801</dl>
802
803
804
805
806
807
808
809
810
811
812
813
814
815<h5>Returns:</h5>
816
817
818<div class="param-desc">
819 <p>A promise which is resolved when the BIG-IP license has
820 been revoked, or rejected if an error occurs.</p>
821</div>
822
823
824
825<dl>
826 <dt>
827 Type
828 </dt>
829 <dd>
830
831<span class="param-type">Promise</span>
832
833
834 </dd>
835</dl>
836
837
838
839
840
841
842
843
844
845
846
847
848
849</article>
850
851</section>
852
853
854
855
856</div>
857
858<nav>
859 <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>
860</nav>
861
862<br class="clear">
863
864<footer>
865 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
866</footer>
867
868<script> prettyPrint(); </script>
869<script src="scripts/linenumber.js"> </script>
870</body>
871</html>
\No newline at end of file