UNPKG

13 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Class: BigIq52LicenseProvider</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: BigIq52LicenseProvider</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2><span class="attribs"><span class="type-signature"></span></span>BigIq52LicenseProvider<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.2 (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="BigIq52LicenseProvider"><span class="type-signature"></span>new BigIq52LicenseProvider<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.2 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
244 <tr>
245
246 <td class="name"><code>version</code></td>
247
248
249 <td class="type">
250
251
252<span class="param-type">String</span>
253
254
255
256 </td>
257
258
259 <td class="attributes">
260
261 &lt;optional><br>
262
263
264
265
266
267 </td>
268
269
270
271
272 <td class="description last"><p>The version of BIG-IQ.</p></td>
273 </tr>
274
275
276 </tbody>
277</table>
278
279 </td>
280 </tr>
281
282
283 </tbody>
284</table>
285
286
287
288
289
290
291<dl class="details">
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</dl>
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344 </div>
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361 <h3 class="subsection-title">Methods</h3>
362
363
364
365
366
367
368
369 <h4 class="name" id="getLicenseTimeout"><span class="type-signature"></span>getLicenseTimeout<span class="signature">()</span><span class="type-signature"></span></h4>
370
371
372
373
374
375
376<div class="description">
377 <p>Gets the license timeout to use</p>
378<p>This is here so that it can be overridden by test code</p>
379</div>
380
381
382
383
384
385
386
387
388
389
390
391
392
393<dl class="details">
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</dl>
427
428
429
430
431
432
433
434
435
436
437
438
439
440<h5>Returns:</h5>
441
442
443<div class="param-desc">
444 <p>the license timeout</p>
445</div>
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461 <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>
462
463
464
465
466
467
468<div class="description">
469 <p>Gets a license from BIG-IQ for an unmanaged BIG-IP</p>
470</div>
471
472
473
474
475
476
477
478
479
480 <h5>Parameters:</h5>
481
482
483<table class="params">
484 <thead>
485 <tr>
486
487 <th>Name</th>
488
489
490 <th>Type</th>
491
492
493
494
495
496 <th class="last">Description</th>
497 </tr>
498 </thead>
499
500 <tbody>
501
502
503 <tr>
504
505 <td class="name"><code>bigIqControl</code></td>
506
507
508 <td class="type">
509
510
511<span class="param-type">Object</span>
512
513
514
515 </td>
516
517
518
519
520
521 <td class="description last"><p>iControl object for BIG-IQ</p></td>
522 </tr>
523
524
525
526 <tr>
527
528 <td class="name"><code>poolName</code></td>
529
530
531 <td class="type">
532
533
534<span class="param-type">String</span>
535
536
537
538 </td>
539
540
541
542
543
544 <td class="description last"><p>Name of the BIG-IQ license pool to use</p></td>
545 </tr>
546
547
548
549 <tr>
550
551 <td class="name"><code>bigIpMgmtAddress</code></td>
552
553
554 <td class="type">
555
556
557<span class="param-type">String</span>
558
559
560
561 </td>
562
563
564
565
566
567 <td class="description last"><p>IP address of BIG-IP management port.</p></td>
568 </tr>
569
570
571
572 <tr>
573
574 <td class="name"><code>bigIpMgmtPort</code></td>
575
576
577 <td class="type">
578
579
580<span class="param-type">String</span>
581
582
583
584 </td>
585
586
587
588
589
590 <td class="description last"><p>IP port of BIG-IP management port.</p></td>
591 </tr>
592
593
594 </tbody>
595</table>
596
597
598
599
600
601
602<dl class="details">
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635</dl>
636
637
638
639
640
641
642
643
644
645
646
647
648
649<h5>Returns:</h5>
650
651
652<div class="param-desc">
653 <p>A promise which is resolved when the BIG-IP has been licensed
654 or rejected if an error occurs.</p>
655</div>
656
657
658
659<dl>
660 <dt>
661 Type
662 </dt>
663 <dd>
664
665<span class="param-type">Promise</span>
666
667
668 </dd>
669</dl>
670
671
672
673
674
675
676
677
678
679
680
681
682
683 <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>
684
685
686
687
688
689
690<div class="description">
691 <p>Revokes a license from a BIG-IP</p>
692</div>
693
694
695
696
697
698
699
700
701
702 <h5>Parameters:</h5>
703
704
705<table class="params">
706 <thead>
707 <tr>
708
709 <th>Name</th>
710
711
712 <th>Type</th>
713
714
715
716
717
718 <th class="last">Description</th>
719 </tr>
720 </thead>
721
722 <tbody>
723
724
725 <tr>
726
727 <td class="name"><code>bigIqControl</code></td>
728
729
730 <td class="type">
731
732
733<span class="param-type">Object</span>
734
735
736
737 </td>
738
739
740
741
742
743 <td class="description last"><p>iControl object for BIG-IQ</p></td>
744 </tr>
745
746
747
748 <tr>
749
750 <td class="name"><code>poolName</code></td>
751
752
753 <td class="type">
754
755
756<span class="param-type">String</span>
757
758
759
760 </td>
761
762
763
764
765
766 <td class="description last"><p>Name of the BIG-IQ license pool to use</p></td>
767 </tr>
768
769
770
771 <tr>
772
773 <td class="name"><code>instance</code></td>
774
775
776 <td class="type">
777
778
779<span class="param-type">String</span>
780
781
782
783 </td>
784
785
786
787
788
789 <td class="description last"><p>AutoscaleInstance to revoke license for</p></td>
790 </tr>
791
792
793 </tbody>
794</table>
795
796
797
798
799
800
801<dl class="details">
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834</dl>
835
836
837
838
839
840
841
842
843
844
845
846
847
848<h5>Returns:</h5>
849
850
851<div class="param-desc">
852 <p>A promise which is resolved when the BIG-IP license has
853 been revoked, or rejected if an error occurs.</p>
854</div>
855
856
857
858<dl>
859 <dt>
860 Type
861 </dt>
862 <dd>
863
864<span class="param-type">Promise</span>
865
866
867 </dd>
868</dl>
869
870
871
872
873
874
875
876
877
878
879
880
881
882</article>
883
884</section>
885
886
887
888
889</div>
890
891<nav>
892 <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>
893</nav>
894
895<br class="clear">
896
897<footer>
898 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
899</footer>
900
901<script> prettyPrint(); </script>
902<script src="scripts/linenumber.js"> </script>
903</body>
904</html>
\No newline at end of file