1 | <!DOCTYPE html>
|
2 | <html lang="en">
|
3 | <head>
|
4 | <meta charset="utf-8">
|
5 | <title>JSDoc: Class: BigIq</title>
|
6 |
|
7 | <script src="scripts/prettify/prettify.js"> </script>
|
8 | <script src="scripts/prettify/lang-css.js"> </script>
|
9 | |
10 |
|
11 |
|
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: BigIq</h1>
|
21 |
|
22 |
|
23 |
|
24 |
|
25 |
|
26 |
|
27 | <section>
|
28 |
|
29 | <header>
|
30 |
|
31 | <h2><span class="attribs"><span class="type-signature"></span></span>BigIq<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
|
32 |
|
33 | <div class="class-description"><p>Provides core functionality (CRUD operations, ready, etc) and maintains
|
34 | references to other modules in f5-cloud-libs.</p>
|
35 | <p>After creating a BigIq with this constructor, you must call the
|
36 | async init() method.</p></div>
|
37 |
|
38 |
|
39 | </header>
|
40 |
|
41 | <article>
|
42 | <div class="container-overview">
|
43 |
|
44 |
|
45 |
|
46 |
|
47 | <h2>Constructor</h2>
|
48 |
|
49 |
|
50 |
|
51 | <h4 class="name" id="BigIq"><span class="type-signature"></span>new BigIq<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
|
52 |
|
53 |
|
54 |
|
55 |
|
56 |
|
57 |
|
58 | <div class="description">
|
59 | <p>BigIq constructor</p>
|
60 | </div>
|
61 |
|
62 |
|
63 |
|
64 |
|
65 |
|
66 |
|
67 |
|
68 |
|
69 |
|
70 | <h5>Parameters:</h5>
|
71 |
|
72 |
|
73 | <table class="params">
|
74 | <thead>
|
75 | <tr>
|
76 |
|
77 | <th>Name</th>
|
78 |
|
79 |
|
80 | <th>Type</th>
|
81 |
|
82 |
|
83 | <th>Attributes</th>
|
84 |
|
85 |
|
86 |
|
87 |
|
88 | <th class="last">Description</th>
|
89 | </tr>
|
90 | </thead>
|
91 |
|
92 | <tbody>
|
93 |
|
94 |
|
95 | <tr>
|
96 |
|
97 | <td class="name"><code>options</code></td>
|
98 |
|
99 |
|
100 | <td class="type">
|
101 |
|
102 |
|
103 | <span class="param-type">Object</span>
|
104 |
|
105 |
|
106 |
|
107 | </td>
|
108 |
|
109 |
|
110 | <td class="attributes">
|
111 |
|
112 | <optional><br>
|
113 |
|
114 |
|
115 |
|
116 |
|
117 |
|
118 | </td>
|
119 |
|
120 |
|
121 |
|
122 |
|
123 | <td class="description last"><p>Optional parameters.</p>
|
124 | <h6>Properties</h6>
|
125 |
|
126 |
|
127 | <table class="params">
|
128 | <thead>
|
129 | <tr>
|
130 |
|
131 | <th>Name</th>
|
132 |
|
133 |
|
134 | <th>Type</th>
|
135 |
|
136 |
|
137 | <th>Attributes</th>
|
138 |
|
139 |
|
140 |
|
141 |
|
142 | <th class="last">Description</th>
|
143 | </tr>
|
144 | </thead>
|
145 |
|
146 | <tbody>
|
147 |
|
148 |
|
149 | <tr>
|
150 |
|
151 | <td class="name"><code>logger</code></td>
|
152 |
|
153 |
|
154 | <td class="type">
|
155 |
|
156 |
|
157 | <span class="param-type">Object</span>
|
158 |
|
159 |
|
160 |
|
161 | </td>
|
162 |
|
163 |
|
164 | <td class="attributes">
|
165 |
|
166 | <optional><br>
|
167 |
|
168 |
|
169 |
|
170 |
|
171 |
|
172 | </td>
|
173 |
|
174 |
|
175 |
|
176 |
|
177 | <td class="description last"><p>Logger to use. Or, pass loggerOptions to get your own logger.</p></td>
|
178 | </tr>
|
179 |
|
180 |
|
181 |
|
182 | <tr>
|
183 |
|
184 | <td class="name"><code>loggerOptions</code></td>
|
185 |
|
186 |
|
187 | <td class="type">
|
188 |
|
189 |
|
190 | <span class="param-type">Object</span>
|
191 |
|
192 |
|
193 |
|
194 | </td>
|
195 |
|
196 |
|
197 | <td class="attributes">
|
198 |
|
199 | <optional><br>
|
200 |
|
201 |
|
202 |
|
203 |
|
204 |
|
205 | </td>
|
206 |
|
207 |
|
208 |
|
209 |
|
210 | <td class="description last"><p>Options for the logger.
|
211 | See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
|
212 | </tr>
|
213 |
|
214 |
|
215 | </tbody>
|
216 | </table>
|
217 |
|
218 | </td>
|
219 | </tr>
|
220 |
|
221 |
|
222 | </tbody>
|
223 | </table>
|
224 |
|
225 |
|
226 |
|
227 |
|
228 |
|
229 |
|
230 | <dl class="details">
|
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 | </dl>
|
264 |
|
265 |
|
266 |
|
267 |
|
268 |
|
269 |
|
270 |
|
271 |
|
272 |
|
273 |
|
274 |
|
275 |
|
276 |
|
277 |
|
278 |
|
279 |
|
280 |
|
281 |
|
282 |
|
283 | </div>
|
284 |
|
285 |
|
286 |
|
287 |
|
288 |
|
289 |
|
290 |
|
291 |
|
292 |
|
293 |
|
294 |
|
295 |
|
296 |
|
297 |
|
298 |
|
299 |
|
300 | <h3 class="subsection-title">Methods</h3>
|
301 |
|
302 |
|
303 |
|
304 |
|
305 |
|
306 |
|
307 |
|
308 | <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(host, user, passwordOrUri, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
309 |
|
310 |
|
311 |
|
312 |
|
313 |
|
314 |
|
315 | <div class="description">
|
316 | <p>Initialize this instance w/ host user password</p>
|
317 | </div>
|
318 |
|
319 |
|
320 |
|
321 |
|
322 |
|
323 |
|
324 |
|
325 |
|
326 |
|
327 | <h5>Parameters:</h5>
|
328 |
|
329 |
|
330 | <table class="params">
|
331 | <thead>
|
332 | <tr>
|
333 |
|
334 | <th>Name</th>
|
335 |
|
336 |
|
337 | <th>Type</th>
|
338 |
|
339 |
|
340 | <th>Attributes</th>
|
341 |
|
342 |
|
343 |
|
344 |
|
345 | <th class="last">Description</th>
|
346 | </tr>
|
347 | </thead>
|
348 |
|
349 | <tbody>
|
350 |
|
351 |
|
352 | <tr>
|
353 |
|
354 | <td class="name"><code>host</code></td>
|
355 |
|
356 |
|
357 | <td class="type">
|
358 |
|
359 |
|
360 | <span class="param-type">String</span>
|
361 |
|
362 |
|
363 |
|
364 | </td>
|
365 |
|
366 |
|
367 | <td class="attributes">
|
368 |
|
369 |
|
370 |
|
371 |
|
372 |
|
373 | </td>
|
374 |
|
375 |
|
376 |
|
377 |
|
378 | <td class="description last"><p>Host to connect to.</p></td>
|
379 | </tr>
|
380 |
|
381 |
|
382 |
|
383 | <tr>
|
384 |
|
385 | <td class="name"><code>user</code></td>
|
386 |
|
387 |
|
388 | <td class="type">
|
389 |
|
390 |
|
391 | <span class="param-type">String</span>
|
392 |
|
393 |
|
394 |
|
395 | </td>
|
396 |
|
397 |
|
398 | <td class="attributes">
|
399 |
|
400 |
|
401 |
|
402 |
|
403 |
|
404 | </td>
|
405 |
|
406 |
|
407 |
|
408 |
|
409 | <td class="description last"><p>User (with admin rights).</p></td>
|
410 | </tr>
|
411 |
|
412 |
|
413 |
|
414 | <tr>
|
415 |
|
416 | <td class="name"><code>passwordOrUri</code></td>
|
417 |
|
418 |
|
419 | <td class="type">
|
420 |
|
421 |
|
422 | <span class="param-type">String</span>
|
423 |
|
424 |
|
425 |
|
426 | </td>
|
427 |
|
428 |
|
429 | <td class="attributes">
|
430 |
|
431 |
|
432 |
|
433 |
|
434 |
|
435 | </td>
|
436 |
|
437 |
|
438 |
|
439 |
|
440 | <td class="description last"><p>Password for user or URL (file, http, https, arn) to
|
441 | location containing password.</p></td>
|
442 | </tr>
|
443 |
|
444 |
|
445 |
|
446 | <tr>
|
447 |
|
448 | <td class="name"><code>options</code></td>
|
449 |
|
450 |
|
451 | <td class="type">
|
452 |
|
453 |
|
454 | <span class="param-type">Object</span>
|
455 |
|
456 |
|
457 |
|
458 | </td>
|
459 |
|
460 |
|
461 | <td class="attributes">
|
462 |
|
463 | <optional><br>
|
464 |
|
465 |
|
466 |
|
467 |
|
468 |
|
469 | </td>
|
470 |
|
471 |
|
472 |
|
473 |
|
474 | <td class="description last"><p>Optional parameters.</p>
|
475 | <h6>Properties</h6>
|
476 |
|
477 |
|
478 | <table class="params">
|
479 | <thead>
|
480 | <tr>
|
481 |
|
482 | <th>Name</th>
|
483 |
|
484 |
|
485 | <th>Type</th>
|
486 |
|
487 |
|
488 | <th>Attributes</th>
|
489 |
|
490 |
|
491 |
|
492 |
|
493 | <th class="last">Description</th>
|
494 | </tr>
|
495 | </thead>
|
496 |
|
497 | <tbody>
|
498 |
|
499 |
|
500 | <tr>
|
501 |
|
502 | <td class="name"><code>passwordIsUri</code></td>
|
503 |
|
504 |
|
505 | <td class="type">
|
506 |
|
507 |
|
508 | <span class="param-type">Boolean</span>
|
509 |
|
510 |
|
511 |
|
512 | </td>
|
513 |
|
514 |
|
515 | <td class="attributes">
|
516 |
|
517 | <optional><br>
|
518 |
|
519 |
|
520 |
|
521 |
|
522 |
|
523 | </td>
|
524 |
|
525 |
|
526 |
|
527 |
|
528 | <td class="description last"><p>Indicates that password is a URI for the password</p></td>
|
529 | </tr>
|
530 |
|
531 |
|
532 |
|
533 | <tr>
|
534 |
|
535 | <td class="name"><code>passwordEncrypted</code></td>
|
536 |
|
537 |
|
538 | <td class="type">
|
539 |
|
540 |
|
541 | <span class="param-type">Boolean</span>
|
542 |
|
543 |
|
544 |
|
545 | </td>
|
546 |
|
547 |
|
548 | <td class="attributes">
|
549 |
|
550 | <optional><br>
|
551 |
|
552 |
|
553 |
|
554 |
|
555 |
|
556 | </td>
|
557 |
|
558 |
|
559 |
|
560 |
|
561 | <td class="description last"><p>Indicates that the password is encrypted</p></td>
|
562 | </tr>
|
563 |
|
564 |
|
565 |
|
566 | <tr>
|
567 |
|
568 | <td class="name"><code>port</code></td>
|
569 |
|
570 |
|
571 | <td class="type">
|
572 |
|
573 |
|
574 | <span class="param-type">Number</span>
|
575 |
|
576 |
|
577 |
|
578 | </td>
|
579 |
|
580 |
|
581 | <td class="attributes">
|
582 |
|
583 | <optional><br>
|
584 |
|
585 |
|
586 |
|
587 |
|
588 |
|
589 | </td>
|
590 |
|
591 |
|
592 |
|
593 |
|
594 | <td class="description last"><p>Port of management port. Default 443.</p></td>
|
595 | </tr>
|
596 |
|
597 |
|
598 |
|
599 | <tr>
|
600 |
|
601 | <td class="name"><code>bigIp</code></td>
|
602 |
|
603 |
|
604 | <td class="type">
|
605 |
|
606 |
|
607 | <span class="param-type">Object</span>
|
608 |
|
609 |
|
610 |
|
611 | </td>
|
612 |
|
613 |
|
614 | <td class="attributes">
|
615 |
|
616 | <optional><br>
|
617 |
|
618 |
|
619 |
|
620 |
|
621 |
|
622 | </td>
|
623 |
|
624 |
|
625 |
|
626 |
|
627 | <td class="description last"><p><a href="BigIp.html">BigIp</a> object. BigIp to control.</p></td>
|
628 | </tr>
|
629 |
|
630 |
|
631 | </tbody>
|
632 | </table>
|
633 |
|
634 | </td>
|
635 | </tr>
|
636 |
|
637 |
|
638 | </tbody>
|
639 | </table>
|
640 |
|
641 |
|
642 |
|
643 |
|
644 |
|
645 |
|
646 | <dl class="details">
|
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 |
|
675 |
|
676 |
|
677 |
|
678 |
|
679 | </dl>
|
680 |
|
681 |
|
682 |
|
683 |
|
684 |
|
685 |
|
686 |
|
687 |
|
688 |
|
689 |
|
690 |
|
691 |
|
692 |
|
693 | <h5>Returns:</h5>
|
694 |
|
695 |
|
696 | <div class="param-desc">
|
697 | <p>A promise which is resolved when initialization is complete
|
698 | or rejected if an error occurs.</p>
|
699 | </div>
|
700 |
|
701 |
|
702 |
|
703 | <dl>
|
704 | <dt>
|
705 | Type
|
706 | </dt>
|
707 | <dd>
|
708 |
|
709 | <span class="param-type">Promise</span>
|
710 |
|
711 |
|
712 | </dd>
|
713 | </dl>
|
714 |
|
715 |
|
716 |
|
717 |
|
718 |
|
719 |
|
720 |
|
721 |
|
722 |
|
723 |
|
724 |
|
725 |
|
726 |
|
727 | <h4 class="name" id="licenseBigIp"><span class="type-signature"></span>licenseBigIp<span class="signature">(poolName, bigIpMgmtAddress, bigIpMgmtPort, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
728 |
|
729 |
|
730 |
|
731 |
|
732 |
|
733 |
|
734 | <div class="description">
|
735 | <p>Licenses a BIG-IP from a license pool</p>
|
736 | </div>
|
737 |
|
738 |
|
739 |
|
740 |
|
741 |
|
742 |
|
743 |
|
744 |
|
745 |
|
746 | <h5>Parameters:</h5>
|
747 |
|
748 |
|
749 | <table class="params">
|
750 | <thead>
|
751 | <tr>
|
752 |
|
753 | <th>Name</th>
|
754 |
|
755 |
|
756 | <th>Type</th>
|
757 |
|
758 |
|
759 | <th>Attributes</th>
|
760 |
|
761 |
|
762 |
|
763 |
|
764 | <th class="last">Description</th>
|
765 | </tr>
|
766 | </thead>
|
767 |
|
768 | <tbody>
|
769 |
|
770 |
|
771 | <tr>
|
772 |
|
773 | <td class="name"><code>poolName</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 | <td class="attributes">
|
787 |
|
788 |
|
789 |
|
790 |
|
791 |
|
792 | </td>
|
793 |
|
794 |
|
795 |
|
796 |
|
797 | <td class="description last"><p>Name of the BIG-IQ pool to license from.</p></td>
|
798 | </tr>
|
799 |
|
800 |
|
801 |
|
802 | <tr>
|
803 |
|
804 | <td class="name"><code>bigIpMgmtAddress</code></td>
|
805 |
|
806 |
|
807 | <td class="type">
|
808 |
|
809 |
|
810 | <span class="param-type">String</span>
|
811 |
|
812 |
|
813 |
|
814 | </td>
|
815 |
|
816 |
|
817 | <td class="attributes">
|
818 |
|
819 |
|
820 |
|
821 |
|
822 |
|
823 | </td>
|
824 |
|
825 |
|
826 |
|
827 |
|
828 | <td class="description last"><p>Management address of BIG-IP</p></td>
|
829 | </tr>
|
830 |
|
831 |
|
832 |
|
833 | <tr>
|
834 |
|
835 | <td class="name"><code>bigIpMgmtPort</code></td>
|
836 |
|
837 |
|
838 | <td class="type">
|
839 |
|
840 |
|
841 | <span class="param-type">String</span>
|
842 |
|
843 |
|
844 |
|
845 | </td>
|
846 |
|
847 |
|
848 | <td class="attributes">
|
849 |
|
850 |
|
851 |
|
852 |
|
853 |
|
854 | </td>
|
855 |
|
856 |
|
857 |
|
858 |
|
859 | <td class="description last"><p>Management port of BIG-IP</p></td>
|
860 | </tr>
|
861 |
|
862 |
|
863 |
|
864 | <tr>
|
865 |
|
866 | <td class="name"><code>options</code></td>
|
867 |
|
868 |
|
869 | <td class="type">
|
870 |
|
871 |
|
872 | <span class="param-type">Object</span>
|
873 |
|
874 |
|
875 |
|
876 | </td>
|
877 |
|
878 |
|
879 | <td class="attributes">
|
880 |
|
881 | <optional><br>
|
882 |
|
883 |
|
884 |
|
885 |
|
886 |
|
887 | </td>
|
888 |
|
889 |
|
890 |
|
891 |
|
892 | <td class="description last"><p>Optional parameters</p>
|
893 | <h6>Properties</h6>
|
894 |
|
895 |
|
896 | <table class="params">
|
897 | <thead>
|
898 | <tr>
|
899 |
|
900 | <th>Name</th>
|
901 |
|
902 |
|
903 | <th>Type</th>
|
904 |
|
905 |
|
906 | <th>Attributes</th>
|
907 |
|
908 |
|
909 |
|
910 |
|
911 | <th class="last">Description</th>
|
912 | </tr>
|
913 | </thead>
|
914 |
|
915 | <tbody>
|
916 |
|
917 |
|
918 | <tr>
|
919 |
|
920 | <td class="name"><code>cloud</code></td>
|
921 |
|
922 |
|
923 | <td class="type">
|
924 |
|
925 |
|
926 | <span class="param-type">String</span>
|
927 |
|
928 |
|
929 |
|
930 | </td>
|
931 |
|
932 |
|
933 | <td class="attributes">
|
934 |
|
935 | <optional><br>
|
936 |
|
937 |
|
938 |
|
939 |
|
940 |
|
941 | </td>
|
942 |
|
943 |
|
944 |
|
945 |
|
946 | <td class="description last"><p>Name of cloud. Only BIG-IQ 5.4+ needs this.
|
947 | Supported values are:
|
948 | aws, azure, gce, vmware, hyperv, kvm, xen</p></td>
|
949 | </tr>
|
950 |
|
951 |
|
952 |
|
953 | <tr>
|
954 |
|
955 | <td class="name"><code>skuKeyword1</code></td>
|
956 |
|
957 |
|
958 | <td class="type">
|
959 |
|
960 |
|
961 | <span class="param-type">String</span>
|
962 |
|
963 |
|
964 |
|
965 | </td>
|
966 |
|
967 |
|
968 | <td class="attributes">
|
969 |
|
970 | <optional><br>
|
971 |
|
972 |
|
973 |
|
974 |
|
975 |
|
976 | </td>
|
977 |
|
978 |
|
979 |
|
980 |
|
981 | <td class="description last"><p>skuKeyword1 parameter for CLPv2 licensing. Default none.</p></td>
|
982 | </tr>
|
983 |
|
984 |
|
985 |
|
986 | <tr>
|
987 |
|
988 | <td class="name"><code>skuKeyword2</code></td>
|
989 |
|
990 |
|
991 | <td class="type">
|
992 |
|
993 |
|
994 | <span class="param-type">String</span>
|
995 |
|
996 |
|
997 |
|
998 | </td>
|
999 |
|
1000 |
|
1001 | <td class="attributes">
|
1002 |
|
1003 | <optional><br>
|
1004 |
|
1005 |
|
1006 |
|
1007 |
|
1008 |
|
1009 | </td>
|
1010 |
|
1011 |
|
1012 |
|
1013 |
|
1014 | <td class="description last"><p>skuKeyword2 parameter for CLPv2 licensing. Default none.</p></td>
|
1015 | </tr>
|
1016 |
|
1017 |
|
1018 |
|
1019 | <tr>
|
1020 |
|
1021 | <td class="name"><code>unitOfMeasure</code></td>
|
1022 |
|
1023 |
|
1024 | <td class="type">
|
1025 |
|
1026 |
|
1027 | <span class="param-type">String</span>
|
1028 |
|
1029 |
|
1030 |
|
1031 | </td>
|
1032 |
|
1033 |
|
1034 | <td class="attributes">
|
1035 |
|
1036 | <optional><br>
|
1037 |
|
1038 |
|
1039 |
|
1040 |
|
1041 |
|
1042 | </td>
|
1043 |
|
1044 |
|
1045 |
|
1046 |
|
1047 | <td class="description last"><p>unitOfMeasure parameter for CLPv2 licensing. Default none.</p></td>
|
1048 | </tr>
|
1049 |
|
1050 |
|
1051 |
|
1052 | <tr>
|
1053 |
|
1054 | <td class="name"><code>noUnreachable</code></td>
|
1055 |
|
1056 |
|
1057 | <td class="type">
|
1058 |
|
1059 |
|
1060 | <span class="param-type">Boolean</span>
|
1061 |
|
1062 |
|
1063 |
|
1064 | </td>
|
1065 |
|
1066 |
|
1067 | <td class="attributes">
|
1068 |
|
1069 | <optional><br>
|
1070 |
|
1071 |
|
1072 |
|
1073 |
|
1074 |
|
1075 | </td>
|
1076 |
|
1077 |
|
1078 |
|
1079 |
|
1080 | <td class="description last"><p>Do not use the unreachable API even on BIG-IQs that support it.</p></td>
|
1081 | </tr>
|
1082 |
|
1083 |
|
1084 |
|
1085 | <tr>
|
1086 |
|
1087 | <td class="name"><code>autoApiType</code></td>
|
1088 |
|
1089 |
|
1090 | <td class="type">
|
1091 |
|
1092 |
|
1093 | <span class="param-type">Boolean</span>
|
1094 |
|
1095 |
|
1096 |
|
1097 | </td>
|
1098 |
|
1099 |
|
1100 | <td class="attributes">
|
1101 |
|
1102 | <optional><br>
|
1103 |
|
1104 |
|
1105 |
|
1106 |
|
1107 |
|
1108 | </td>
|
1109 |
|
1110 |
|
1111 |
|
1112 |
|
1113 | <td class="description last"><p>Automatically determine API type rather than basing on BIG-IQ
|
1114 | version.</p></td>
|
1115 | </tr>
|
1116 |
|
1117 |
|
1118 | </tbody>
|
1119 | </table>
|
1120 |
|
1121 | </td>
|
1122 | </tr>
|
1123 |
|
1124 |
|
1125 | </tbody>
|
1126 | </table>
|
1127 |
|
1128 |
|
1129 |
|
1130 |
|
1131 |
|
1132 |
|
1133 | <dl class="details">
|
1134 |
|
1135 |
|
1136 |
|
1137 |
|
1138 |
|
1139 |
|
1140 |
|
1141 |
|
1142 |
|
1143 |
|
1144 |
|
1145 |
|
1146 |
|
1147 |
|
1148 |
|
1149 |
|
1150 |
|
1151 |
|
1152 |
|
1153 |
|
1154 |
|
1155 |
|
1156 |
|
1157 |
|
1158 |
|
1159 |
|
1160 |
|
1161 |
|
1162 |
|
1163 |
|
1164 |
|
1165 |
|
1166 | </dl>
|
1167 |
|
1168 |
|
1169 |
|
1170 |
|
1171 |
|
1172 |
|
1173 |
|
1174 |
|
1175 |
|
1176 |
|
1177 |
|
1178 |
|
1179 |
|
1180 | <h5>Returns:</h5>
|
1181 |
|
1182 |
|
1183 | <div class="param-desc">
|
1184 | <p>A promise which is resolved when the licensing
|
1185 | is complete or rejected if an error occurs.</p>
|
1186 | </div>
|
1187 |
|
1188 |
|
1189 |
|
1190 | <dl>
|
1191 | <dt>
|
1192 | Type
|
1193 | </dt>
|
1194 | <dd>
|
1195 |
|
1196 | <span class="param-type">Promise</span>
|
1197 |
|
1198 |
|
1199 | </dd>
|
1200 | </dl>
|
1201 |
|
1202 |
|
1203 |
|
1204 |
|
1205 |
|
1206 |
|
1207 |
|
1208 |
|
1209 |
|
1210 |
|
1211 |
|
1212 |
|
1213 |
|
1214 | <h4 class="name" id="revokeLicense"><span class="type-signature"></span>revokeLicense<span class="signature">(poolName, instance, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
|
1215 |
|
1216 |
|
1217 |
|
1218 |
|
1219 |
|
1220 |
|
1221 | <div class="description">
|
1222 | <p>Revokes a license for a BIG-IP</p>
|
1223 | </div>
|
1224 |
|
1225 |
|
1226 |
|
1227 |
|
1228 |
|
1229 |
|
1230 |
|
1231 |
|
1232 |
|
1233 | <h5>Parameters:</h5>
|
1234 |
|
1235 |
|
1236 | <table class="params">
|
1237 | <thead>
|
1238 | <tr>
|
1239 |
|
1240 | <th>Name</th>
|
1241 |
|
1242 |
|
1243 | <th>Type</th>
|
1244 |
|
1245 |
|
1246 | <th>Attributes</th>
|
1247 |
|
1248 |
|
1249 |
|
1250 |
|
1251 | <th class="last">Description</th>
|
1252 | </tr>
|
1253 | </thead>
|
1254 |
|
1255 | <tbody>
|
1256 |
|
1257 |
|
1258 | <tr>
|
1259 |
|
1260 | <td class="name"><code>poolName</code></td>
|
1261 |
|
1262 |
|
1263 | <td class="type">
|
1264 |
|
1265 |
|
1266 | <span class="param-type">String</span>
|
1267 |
|
1268 |
|
1269 |
|
1270 | </td>
|
1271 |
|
1272 |
|
1273 | <td class="attributes">
|
1274 |
|
1275 |
|
1276 |
|
1277 |
|
1278 |
|
1279 | </td>
|
1280 |
|
1281 |
|
1282 |
|
1283 |
|
1284 | <td class="description last"><p>The name of the license pool to revoke from</p></td>
|
1285 | </tr>
|
1286 |
|
1287 |
|
1288 |
|
1289 | <tr>
|
1290 |
|
1291 | <td class="name"><code>instance</code></td>
|
1292 |
|
1293 |
|
1294 | <td class="type">
|
1295 |
|
1296 |
|
1297 | <span class="param-type">String</span>
|
1298 |
|
1299 |
|
1300 |
|
1301 | </td>
|
1302 |
|
1303 |
|
1304 | <td class="attributes">
|
1305 |
|
1306 |
|
1307 |
|
1308 |
|
1309 |
|
1310 | </td>
|
1311 |
|
1312 |
|
1313 |
|
1314 |
|
1315 | <td class="description last"><p>AutoscaleInstance to revoke license for</p></td>
|
1316 | </tr>
|
1317 |
|
1318 |
|
1319 |
|
1320 | <tr>
|
1321 |
|
1322 | <td class="name"><code>options</code></td>
|
1323 |
|
1324 |
|
1325 | <td class="type">
|
1326 |
|
1327 |
|
1328 | <span class="param-type">Object</span>
|
1329 |
|
1330 |
|
1331 |
|
1332 | </td>
|
1333 |
|
1334 |
|
1335 | <td class="attributes">
|
1336 |
|
1337 | <optional><br>
|
1338 |
|
1339 |
|
1340 |
|
1341 |
|
1342 |
|
1343 | </td>
|
1344 |
|
1345 |
|
1346 |
|
1347 |
|
1348 | <td class="description last"><p>Optional parameters</p>
|
1349 | <h6>Properties</h6>
|
1350 |
|
1351 |
|
1352 | <table class="params">
|
1353 | <thead>
|
1354 | <tr>
|
1355 |
|
1356 | <th>Name</th>
|
1357 |
|
1358 |
|
1359 | <th>Type</th>
|
1360 |
|
1361 |
|
1362 | <th>Attributes</th>
|
1363 |
|
1364 |
|
1365 |
|
1366 |
|
1367 | <th class="last">Description</th>
|
1368 | </tr>
|
1369 | </thead>
|
1370 |
|
1371 | <tbody>
|
1372 |
|
1373 |
|
1374 | <tr>
|
1375 |
|
1376 | <td class="name"><code>noUnreachable</code></td>
|
1377 |
|
1378 |
|
1379 | <td class="type">
|
1380 |
|
1381 |
|
1382 | <span class="param-type">Boolean</span>
|
1383 |
|
1384 |
|
1385 |
|
1386 | </td>
|
1387 |
|
1388 |
|
1389 | <td class="attributes">
|
1390 |
|
1391 | <optional><br>
|
1392 |
|
1393 |
|
1394 |
|
1395 |
|
1396 |
|
1397 | </td>
|
1398 |
|
1399 |
|
1400 |
|
1401 |
|
1402 | <td class="description last"><p>Do not use the unreachable API even on BIG-IQs that support it.</p></td>
|
1403 | </tr>
|
1404 |
|
1405 |
|
1406 | </tbody>
|
1407 | </table>
|
1408 |
|
1409 | </td>
|
1410 | </tr>
|
1411 |
|
1412 |
|
1413 | </tbody>
|
1414 | </table>
|
1415 |
|
1416 |
|
1417 |
|
1418 |
|
1419 |
|
1420 |
|
1421 | <dl class="details">
|
1422 |
|
1423 |
|
1424 |
|
1425 |
|
1426 |
|
1427 |
|
1428 |
|
1429 |
|
1430 |
|
1431 |
|
1432 |
|
1433 |
|
1434 |
|
1435 |
|
1436 |
|
1437 |
|
1438 |
|
1439 |
|
1440 |
|
1441 |
|
1442 |
|
1443 |
|
1444 |
|
1445 |
|
1446 |
|
1447 |
|
1448 |
|
1449 |
|
1450 |
|
1451 |
|
1452 |
|
1453 |
|
1454 | </dl>
|
1455 |
|
1456 |
|
1457 |
|
1458 |
|
1459 |
|
1460 |
|
1461 |
|
1462 |
|
1463 |
|
1464 |
|
1465 |
|
1466 |
|
1467 |
|
1468 |
|
1469 |
|
1470 |
|
1471 |
|
1472 |
|
1473 |
|
1474 |
|
1475 |
|
1476 |
|
1477 |
|
1478 |
|
1479 | </article>
|
1480 |
|
1481 | </section>
|
1482 |
|
1483 |
|
1484 |
|
1485 |
|
1486 | </div>
|
1487 |
|
1488 | <nav>
|
1489 | <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>
|
1490 | </nav>
|
1491 |
|
1492 | <br class="clear">
|
1493 |
|
1494 | <footer>
|
1495 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
1496 | </footer>
|
1497 |
|
1498 | <script> prettyPrint(); </script>
|
1499 | <script src="scripts/linenumber.js"> </script>
|
1500 | </body>
|
1501 | </html> |
\ | No newline at end of file |