UNPKG

15.7 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Class: BigIq53LicenseProvider</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: BigIq53LicenseProvider</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2><span class="attribs"><span class="type-signature"></span></span>BigIq53LicenseProvider<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.3 (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="BigIq53LicenseProvider"><span class="type-signature"></span>new BigIq53LicenseProvider<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.3 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, options<span class="signature-attributes">opt</span>)</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 <th>Attributes</th>
461
462
463
464
465 <th class="last">Description</th>
466 </tr>
467 </thead>
468
469 <tbody>
470
471
472 <tr>
473
474 <td class="name"><code>bigIqControl</code></td>
475
476
477 <td class="type">
478
479
480<span class="param-type">Object</span>
481
482
483
484 </td>
485
486
487 <td class="attributes">
488
489
490
491
492
493 </td>
494
495
496
497
498 <td class="description last"><p>iControl object for BIG-IQ</p></td>
499 </tr>
500
501
502
503 <tr>
504
505 <td class="name"><code>poolName</code></td>
506
507
508 <td class="type">
509
510
511<span class="param-type">String</span>
512
513
514
515 </td>
516
517
518 <td class="attributes">
519
520
521
522
523
524 </td>
525
526
527
528
529 <td class="description last"><p>Name of the BIG-IQ license pool to use</p></td>
530 </tr>
531
532
533
534 <tr>
535
536 <td class="name"><code>bigIpMgmtAddress</code></td>
537
538
539 <td class="type">
540
541
542<span class="param-type">String</span>
543
544
545
546 </td>
547
548
549 <td class="attributes">
550
551
552
553
554
555 </td>
556
557
558
559
560 <td class="description last"><p>IP address of BIG-IP management port.</p></td>
561 </tr>
562
563
564
565 <tr>
566
567 <td class="name"><code>bigIpMgmtPort</code></td>
568
569
570 <td class="type">
571
572
573<span class="param-type">String</span>
574
575
576
577 </td>
578
579
580 <td class="attributes">
581
582
583
584
585
586 </td>
587
588
589
590
591 <td class="description last"><p>IP port of BIG-IP management port.</p></td>
592 </tr>
593
594
595
596 <tr>
597
598 <td class="name"><code>options</code></td>
599
600
601 <td class="type">
602
603
604<span class="param-type">Object</span>
605
606
607
608 </td>
609
610
611 <td class="attributes">
612
613 &lt;optional><br>
614
615
616
617
618
619 </td>
620
621
622
623
624 <td class="description last"><p>Optional parameters</p>
625 <h6>Properties</h6>
626
627
628<table class="params">
629 <thead>
630 <tr>
631
632 <th>Name</th>
633
634
635 <th>Type</th>
636
637
638 <th>Attributes</th>
639
640
641
642
643 <th class="last">Description</th>
644 </tr>
645 </thead>
646
647 <tbody>
648
649
650 <tr>
651
652 <td class="name"><code>skuKeyword1</code></td>
653
654
655 <td class="type">
656
657
658<span class="param-type">String</span>
659
660
661
662 </td>
663
664
665 <td class="attributes">
666
667 &lt;optional><br>
668
669
670
671
672
673 </td>
674
675
676
677
678 <td class="description last"><p>skuKeyword1 parameter for CLPv2 licensing. Default none.</p></td>
679 </tr>
680
681
682
683 <tr>
684
685 <td class="name"><code>skuKeyword2</code></td>
686
687
688 <td class="type">
689
690
691<span class="param-type">String</span>
692
693
694
695 </td>
696
697
698 <td class="attributes">
699
700 &lt;optional><br>
701
702
703
704
705
706 </td>
707
708
709
710
711 <td class="description last"><p>skuKeyword2 parameter for CLPv2 licensing. Default none.</p></td>
712 </tr>
713
714
715
716 <tr>
717
718 <td class="name"><code>unitOfMeasure</code></td>
719
720
721 <td class="type">
722
723
724<span class="param-type">String</span>
725
726
727
728 </td>
729
730
731 <td class="attributes">
732
733 &lt;optional><br>
734
735
736
737
738
739 </td>
740
741
742
743
744 <td class="description last"><p>unitOfMeasure parameter for CLPv2 licensing. Default none.</p></td>
745 </tr>
746
747
748 </tbody>
749</table>
750
751 </td>
752 </tr>
753
754
755 </tbody>
756</table>
757
758
759
760
761
762
763<dl class="details">
764
765
766
767
768
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</dl>
797
798
799
800
801
802
803
804
805
806
807
808
809
810<h5>Returns:</h5>
811
812
813<div class="param-desc">
814 <p>A promise which is resolved when the BIG-IP has been licensed
815 or rejected if an error occurs.</p>
816</div>
817
818
819
820<dl>
821 <dt>
822 Type
823 </dt>
824 <dd>
825
826<span class="param-type">Promise</span>
827
828
829 </dd>
830</dl>
831
832
833
834
835
836
837
838
839
840
841
842
843
844 <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>
845
846
847
848
849
850
851<div class="description">
852 <p>Revokes a license from a BIG-IP</p>
853</div>
854
855
856
857
858
859
860
861
862
863 <h5>Parameters:</h5>
864
865
866<table class="params">
867 <thead>
868 <tr>
869
870 <th>Name</th>
871
872
873 <th>Type</th>
874
875
876
877
878
879 <th class="last">Description</th>
880 </tr>
881 </thead>
882
883 <tbody>
884
885
886 <tr>
887
888 <td class="name"><code>bigIqControl</code></td>
889
890
891 <td class="type">
892
893
894<span class="param-type">Object</span>
895
896
897
898 </td>
899
900
901
902
903
904 <td class="description last"><p>iControl object for BIG-IQ</p></td>
905 </tr>
906
907
908
909 <tr>
910
911 <td class="name"><code>poolName</code></td>
912
913
914 <td class="type">
915
916
917<span class="param-type">String</span>
918
919
920
921 </td>
922
923
924
925
926
927 <td class="description last"><p>Name of the BIG-IQ license pool to use. Not used in this
928 API. Here for consistency.</p></td>
929 </tr>
930
931
932
933 <tr>
934
935 <td class="name"><code>instance</code></td>
936
937
938 <td class="type">
939
940
941<span class="param-type">String</span>
942
943
944
945 </td>
946
947
948
949
950
951 <td class="description last"><p>AutoscaleInstance to revoke license for</p></td>
952 </tr>
953
954
955 </tbody>
956</table>
957
958
959
960
961
962
963<dl class="details">
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996</dl>
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010<h5>Returns:</h5>
1011
1012
1013<div class="param-desc">
1014 <p>A promise which is resolved when the BIG-IP license has
1015 been revoked, or rejected if an error occurs.</p>
1016</div>
1017
1018
1019
1020<dl>
1021 <dt>
1022 Type
1023 </dt>
1024 <dd>
1025
1026<span class="param-type">Promise</span>
1027
1028
1029 </dd>
1030</dl>
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044</article>
1045
1046</section>
1047
1048
1049
1050
1051</div>
1052
1053<nav>
1054 <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>
1055</nav>
1056
1057<br class="clear">
1058
1059<footer>
1060 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
1061</footer>
1062
1063<script> prettyPrint(); </script>
1064<script src="scripts/linenumber.js"> </script>
1065</body>
1066</html>
\No newline at end of file