1 | <!DOCTYPE html>
|
2 | <html lang="en">
|
3 | <head>
|
4 | <meta charset="utf-8">
|
5 | <title>JSDoc: Mixin: exports</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">Mixin: exports</h1>
|
21 |
|
22 |
|
23 |
|
24 |
|
25 |
|
26 |
|
27 | <section>
|
28 |
|
29 | <header>
|
30 |
|
31 | <h2>exports</h2>
|
32 |
|
33 |
|
34 | </header>
|
35 |
|
36 | <article>
|
37 | <div class="container-overview">
|
38 |
|
39 |
|
40 | <div class="description"><p>Functions that only pertain to BIG-IQ onboarding, not BIG-IP</p></div>
|
41 |
|
42 |
|
43 |
|
44 |
|
45 |
|
46 | <dl class="details">
|
47 |
|
48 |
|
49 |
|
50 |
|
51 |
|
52 |
|
53 |
|
54 |
|
55 |
|
56 |
|
57 |
|
58 |
|
59 |
|
60 |
|
61 |
|
62 |
|
63 |
|
64 |
|
65 |
|
66 |
|
67 |
|
68 |
|
69 |
|
70 |
|
71 |
|
72 |
|
73 |
|
74 |
|
75 |
|
76 |
|
77 |
|
78 |
|
79 | </dl>
|
80 |
|
81 |
|
82 |
|
83 |
|
84 | </div>
|
85 |
|
86 |
|
87 |
|
88 |
|
89 |
|
90 |
|
91 |
|
92 |
|
93 |
|
94 |
|
95 |
|
96 |
|
97 |
|
98 |
|
99 |
|
100 |
|
101 | <h3 class="subsection-title">Methods</h3>
|
102 |
|
103 |
|
104 |
|
105 |
|
106 |
|
107 |
|
108 |
|
109 | <h4 class="name" id=".getCloudProvider"><span class="type-signature">(static) </span>getCloudProvider<span class="signature">(name, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
|
110 |
|
111 |
|
112 |
|
113 |
|
114 |
|
115 |
|
116 | <div class="description">
|
117 | <p>Creates a cloud provider for the given name</p>
|
118 | </div>
|
119 |
|
120 |
|
121 |
|
122 |
|
123 |
|
124 |
|
125 |
|
126 |
|
127 |
|
128 | <h5>Parameters:</h5>
|
129 |
|
130 |
|
131 | <table class="params">
|
132 | <thead>
|
133 | <tr>
|
134 |
|
135 | <th>Name</th>
|
136 |
|
137 |
|
138 | <th>Type</th>
|
139 |
|
140 |
|
141 | <th>Attributes</th>
|
142 |
|
143 |
|
144 |
|
145 |
|
146 | <th class="last">Description</th>
|
147 | </tr>
|
148 | </thead>
|
149 |
|
150 | <tbody>
|
151 |
|
152 |
|
153 | <tr>
|
154 |
|
155 | <td class="name"><code>name</code></td>
|
156 |
|
157 |
|
158 | <td class="type">
|
159 |
|
160 |
|
161 | <span class="param-type">String</span>
|
162 |
|
163 |
|
164 |
|
165 | </td>
|
166 |
|
167 |
|
168 | <td class="attributes">
|
169 |
|
170 |
|
171 |
|
172 |
|
173 |
|
174 | </td>
|
175 |
|
176 |
|
177 |
|
178 |
|
179 | <td class="description last"><p>Name of the provider</p></td>
|
180 | </tr>
|
181 |
|
182 |
|
183 |
|
184 | <tr>
|
185 |
|
186 | <td class="name"><code>options</code></td>
|
187 |
|
188 |
|
189 | <td class="type">
|
190 |
|
191 |
|
192 | <span class="param-type">Ojbect</span>
|
193 |
|
194 |
|
195 |
|
196 | </td>
|
197 |
|
198 |
|
199 | <td class="attributes">
|
200 |
|
201 | <optional><br>
|
202 |
|
203 |
|
204 |
|
205 |
|
206 |
|
207 | </td>
|
208 |
|
209 |
|
210 |
|
211 |
|
212 | <td class="description last"><p>Options for the instance.</p>
|
213 | <h6>Properties</h6>
|
214 |
|
215 |
|
216 | <table class="params">
|
217 | <thead>
|
218 | <tr>
|
219 |
|
220 | <th>Name</th>
|
221 |
|
222 |
|
223 | <th>Type</th>
|
224 |
|
225 |
|
226 | <th>Attributes</th>
|
227 |
|
228 |
|
229 |
|
230 |
|
231 | <th class="last">Description</th>
|
232 | </tr>
|
233 | </thead>
|
234 |
|
235 | <tbody>
|
236 |
|
237 |
|
238 | <tr>
|
239 |
|
240 | <td class="name"><code>clOptions</code></td>
|
241 |
|
242 |
|
243 | <td class="type">
|
244 |
|
245 |
|
246 | <span class="param-type">Object</span>
|
247 |
|
248 |
|
249 |
|
250 | </td>
|
251 |
|
252 |
|
253 | <td class="attributes">
|
254 |
|
255 | <optional><br>
|
256 |
|
257 |
|
258 |
|
259 |
|
260 |
|
261 | </td>
|
262 |
|
263 |
|
264 |
|
265 |
|
266 | <td class="description last"><p>Command line options if called from a script.</p></td>
|
267 | </tr>
|
268 |
|
269 |
|
270 |
|
271 | <tr>
|
272 |
|
273 | <td class="name"><code>logger</code></td>
|
274 |
|
275 |
|
276 | <td class="type">
|
277 |
|
278 |
|
279 | <span class="param-type">Object</span>
|
280 |
|
281 |
|
282 |
|
283 | </td>
|
284 |
|
285 |
|
286 | <td class="attributes">
|
287 |
|
288 | <optional><br>
|
289 |
|
290 |
|
291 |
|
292 |
|
293 |
|
294 | </td>
|
295 |
|
296 |
|
297 |
|
298 |
|
299 | <td class="description last"><p>Logger to use. Or, pass loggerOptions to get your own logger.</p></td>
|
300 | </tr>
|
301 |
|
302 |
|
303 |
|
304 | <tr>
|
305 |
|
306 | <td class="name"><code>loggerOptions</code></td>
|
307 |
|
308 |
|
309 | <td class="type">
|
310 |
|
311 |
|
312 | <span class="param-type">Object</span>
|
313 |
|
314 |
|
315 |
|
316 | </td>
|
317 |
|
318 |
|
319 | <td class="attributes">
|
320 |
|
321 | <optional><br>
|
322 |
|
323 |
|
324 |
|
325 |
|
326 |
|
327 | </td>
|
328 |
|
329 |
|
330 |
|
331 |
|
332 | <td class="description last"><p>Options for the logger.
|
333 | See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
|
334 | </tr>
|
335 |
|
336 |
|
337 | </tbody>
|
338 | </table>
|
339 |
|
340 | </td>
|
341 | </tr>
|
342 |
|
343 |
|
344 | </tbody>
|
345 | </table>
|
346 |
|
347 |
|
348 |
|
349 |
|
350 |
|
351 |
|
352 | <dl class="details">
|
353 |
|
354 |
|
355 |
|
356 |
|
357 |
|
358 |
|
359 |
|
360 |
|
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 | </dl>
|
386 |
|
387 |
|
388 |
|
389 |
|
390 |
|
391 |
|
392 |
|
393 |
|
394 |
|
395 |
|
396 |
|
397 |
|
398 |
|
399 |
|
400 |
|
401 |
|
402 |
|
403 |
|
404 |
|
405 |
|
406 |
|
407 |
|
408 |
|
409 |
|
410 | <h4 class="name" id=".getDnsProvider"><span class="type-signature">(static) </span>getDnsProvider<span class="signature">(name, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
|
411 |
|
412 |
|
413 |
|
414 |
|
415 |
|
416 |
|
417 | <div class="description">
|
418 | <p>Creates a DNS provider for the given name</p>
|
419 | </div>
|
420 |
|
421 |
|
422 |
|
423 |
|
424 |
|
425 |
|
426 |
|
427 |
|
428 |
|
429 | <h5>Parameters:</h5>
|
430 |
|
431 |
|
432 | <table class="params">
|
433 | <thead>
|
434 | <tr>
|
435 |
|
436 | <th>Name</th>
|
437 |
|
438 |
|
439 | <th>Type</th>
|
440 |
|
441 |
|
442 | <th>Attributes</th>
|
443 |
|
444 |
|
445 |
|
446 |
|
447 | <th class="last">Description</th>
|
448 | </tr>
|
449 | </thead>
|
450 |
|
451 | <tbody>
|
452 |
|
453 |
|
454 | <tr>
|
455 |
|
456 | <td class="name"><code>name</code></td>
|
457 |
|
458 |
|
459 | <td class="type">
|
460 |
|
461 |
|
462 | <span class="param-type">String</span>
|
463 |
|
464 |
|
465 |
|
466 | </td>
|
467 |
|
468 |
|
469 | <td class="attributes">
|
470 |
|
471 |
|
472 |
|
473 |
|
474 |
|
475 | </td>
|
476 |
|
477 |
|
478 |
|
479 |
|
480 | <td class="description last"><p>Name of the provider</p></td>
|
481 | </tr>
|
482 |
|
483 |
|
484 |
|
485 | <tr>
|
486 |
|
487 | <td class="name"><code>options</code></td>
|
488 |
|
489 |
|
490 | <td class="type">
|
491 |
|
492 |
|
493 | <span class="param-type">Ojbect</span>
|
494 |
|
495 |
|
496 |
|
497 | </td>
|
498 |
|
499 |
|
500 | <td class="attributes">
|
501 |
|
502 | <optional><br>
|
503 |
|
504 |
|
505 |
|
506 |
|
507 |
|
508 | </td>
|
509 |
|
510 |
|
511 |
|
512 |
|
513 | <td class="description last"><p>Options for the instance.</p>
|
514 | <h6>Properties</h6>
|
515 |
|
516 |
|
517 | <table class="params">
|
518 | <thead>
|
519 | <tr>
|
520 |
|
521 | <th>Name</th>
|
522 |
|
523 |
|
524 | <th>Type</th>
|
525 |
|
526 |
|
527 | <th>Attributes</th>
|
528 |
|
529 |
|
530 |
|
531 |
|
532 | <th class="last">Description</th>
|
533 | </tr>
|
534 | </thead>
|
535 |
|
536 | <tbody>
|
537 |
|
538 |
|
539 | <tr>
|
540 |
|
541 | <td class="name"><code>clOptions</code></td>
|
542 |
|
543 |
|
544 | <td class="type">
|
545 |
|
546 |
|
547 | <span class="param-type">Object</span>
|
548 |
|
549 |
|
550 |
|
551 | </td>
|
552 |
|
553 |
|
554 | <td class="attributes">
|
555 |
|
556 | <optional><br>
|
557 |
|
558 |
|
559 |
|
560 |
|
561 |
|
562 | </td>
|
563 |
|
564 |
|
565 |
|
566 |
|
567 | <td class="description last"><p>Command line options if called from a script.</p></td>
|
568 | </tr>
|
569 |
|
570 |
|
571 |
|
572 | <tr>
|
573 |
|
574 | <td class="name"><code>logger</code></td>
|
575 |
|
576 |
|
577 | <td class="type">
|
578 |
|
579 |
|
580 | <span class="param-type">Object</span>
|
581 |
|
582 |
|
583 |
|
584 | </td>
|
585 |
|
586 |
|
587 | <td class="attributes">
|
588 |
|
589 | <optional><br>
|
590 |
|
591 |
|
592 |
|
593 |
|
594 |
|
595 | </td>
|
596 |
|
597 |
|
598 |
|
599 |
|
600 | <td class="description last"><p>Logger to use. Or, pass loggerOptions to get your own logger.</p></td>
|
601 | </tr>
|
602 |
|
603 |
|
604 |
|
605 | <tr>
|
606 |
|
607 | <td class="name"><code>loggerOptions</code></td>
|
608 |
|
609 |
|
610 | <td class="type">
|
611 |
|
612 |
|
613 | <span class="param-type">Object</span>
|
614 |
|
615 |
|
616 |
|
617 | </td>
|
618 |
|
619 |
|
620 | <td class="attributes">
|
621 |
|
622 | <optional><br>
|
623 |
|
624 |
|
625 |
|
626 |
|
627 |
|
628 | </td>
|
629 |
|
630 |
|
631 |
|
632 |
|
633 | <td class="description last"><p>Options for the logger.
|
634 | See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
|
635 | </tr>
|
636 |
|
637 |
|
638 | </tbody>
|
639 | </table>
|
640 |
|
641 | </td>
|
642 | </tr>
|
643 |
|
644 |
|
645 | </tbody>
|
646 | </table>
|
647 |
|
648 |
|
649 |
|
650 |
|
651 |
|
652 |
|
653 | <dl class="details">
|
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 |
|
680 |
|
681 |
|
682 |
|
683 |
|
684 |
|
685 |
|
686 | </dl>
|
687 |
|
688 |
|
689 |
|
690 |
|
691 |
|
692 |
|
693 |
|
694 |
|
695 |
|
696 |
|
697 |
|
698 |
|
699 |
|
700 |
|
701 |
|
702 |
|
703 |
|
704 |
|
705 |
|
706 |
|
707 |
|
708 |
|
709 |
|
710 |
|
711 | <h4 class="name" id=".getLicenseProvider"><span class="type-signature">(static) </span>getLicenseProvider<span class="signature">(bigIqVersion, {BigIp}, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
|
712 |
|
713 |
|
714 |
|
715 |
|
716 |
|
717 |
|
718 | <div class="description">
|
719 | <p>Creates a BIG-IQ license provider for the given version</p>
|
720 | </div>
|
721 |
|
722 |
|
723 |
|
724 |
|
725 |
|
726 |
|
727 |
|
728 |
|
729 |
|
730 | <h5>Parameters:</h5>
|
731 |
|
732 |
|
733 | <table class="params">
|
734 | <thead>
|
735 | <tr>
|
736 |
|
737 | <th>Name</th>
|
738 |
|
739 |
|
740 | <th>Type</th>
|
741 |
|
742 |
|
743 | <th>Attributes</th>
|
744 |
|
745 |
|
746 |
|
747 |
|
748 | <th class="last">Description</th>
|
749 | </tr>
|
750 | </thead>
|
751 |
|
752 | <tbody>
|
753 |
|
754 |
|
755 | <tr>
|
756 |
|
757 | <td class="name"><code>bigIqVersion</code></td>
|
758 |
|
759 |
|
760 | <td class="type">
|
761 |
|
762 |
|
763 | <span class="param-type">String</span>
|
764 |
|
765 |
|
766 |
|
767 | </td>
|
768 |
|
769 |
|
770 | <td class="attributes">
|
771 |
|
772 |
|
773 |
|
774 |
|
775 |
|
776 | </td>
|
777 |
|
778 |
|
779 |
|
780 |
|
781 | <td class="description last"><p>Version of BIG-IQ.</p></td>
|
782 | </tr>
|
783 |
|
784 |
|
785 |
|
786 | <tr>
|
787 |
|
788 | <td class="name"><code>{BigIp}</code></td>
|
789 |
|
790 |
|
791 | <td class="type">
|
792 |
|
793 |
|
794 | <span class="param-type">Object</span>
|
795 |
|
796 |
|
797 |
|
798 | </td>
|
799 |
|
800 |
|
801 | <td class="attributes">
|
802 |
|
803 |
|
804 |
|
805 |
|
806 |
|
807 | </td>
|
808 |
|
809 |
|
810 |
|
811 |
|
812 | <td class="description last"><p>See <a href="BigIp.html">BigIp</a>.</p></td>
|
813 | </tr>
|
814 |
|
815 |
|
816 |
|
817 | <tr>
|
818 |
|
819 | <td class="name"><code>options</code></td>
|
820 |
|
821 |
|
822 | <td class="type">
|
823 |
|
824 |
|
825 | <span class="param-type">Ojbect</span>
|
826 |
|
827 |
|
828 |
|
829 | </td>
|
830 |
|
831 |
|
832 | <td class="attributes">
|
833 |
|
834 | <optional><br>
|
835 |
|
836 |
|
837 |
|
838 |
|
839 |
|
840 | </td>
|
841 |
|
842 |
|
843 |
|
844 |
|
845 | <td class="description last"><p>Options for the instance.</p>
|
846 | <h6>Properties</h6>
|
847 |
|
848 |
|
849 | <table class="params">
|
850 | <thead>
|
851 | <tr>
|
852 |
|
853 | <th>Name</th>
|
854 |
|
855 |
|
856 | <th>Type</th>
|
857 |
|
858 |
|
859 | <th>Attributes</th>
|
860 |
|
861 |
|
862 |
|
863 |
|
864 | <th class="last">Description</th>
|
865 | </tr>
|
866 | </thead>
|
867 |
|
868 | <tbody>
|
869 |
|
870 |
|
871 | <tr>
|
872 |
|
873 | <td class="name"><code>logger</code></td>
|
874 |
|
875 |
|
876 | <td class="type">
|
877 |
|
878 |
|
879 | <span class="param-type">Object</span>
|
880 |
|
881 |
|
882 |
|
883 | </td>
|
884 |
|
885 |
|
886 | <td class="attributes">
|
887 |
|
888 | <optional><br>
|
889 |
|
890 |
|
891 |
|
892 |
|
893 |
|
894 | </td>
|
895 |
|
896 |
|
897 |
|
898 |
|
899 | <td class="description last"><p>Logger to use. Or, pass loggerOptions to get your own logger.</p></td>
|
900 | </tr>
|
901 |
|
902 |
|
903 |
|
904 | <tr>
|
905 |
|
906 | <td class="name"><code>loggerOptions</code></td>
|
907 |
|
908 |
|
909 | <td class="type">
|
910 |
|
911 |
|
912 | <span class="param-type">Object</span>
|
913 |
|
914 |
|
915 |
|
916 | </td>
|
917 |
|
918 |
|
919 | <td class="attributes">
|
920 |
|
921 | <optional><br>
|
922 |
|
923 |
|
924 |
|
925 |
|
926 |
|
927 | </td>
|
928 |
|
929 |
|
930 |
|
931 |
|
932 | <td class="description last"><p>Options for the logger.
|
933 | See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
|
934 | </tr>
|
935 |
|
936 |
|
937 | </tbody>
|
938 | </table>
|
939 |
|
940 | </td>
|
941 | </tr>
|
942 |
|
943 |
|
944 | </tbody>
|
945 | </table>
|
946 |
|
947 |
|
948 |
|
949 |
|
950 |
|
951 |
|
952 | <dl class="details">
|
953 |
|
954 |
|
955 |
|
956 |
|
957 |
|
958 |
|
959 |
|
960 |
|
961 |
|
962 |
|
963 |
|
964 |
|
965 |
|
966 |
|
967 |
|
968 |
|
969 |
|
970 |
|
971 |
|
972 |
|
973 |
|
974 |
|
975 |
|
976 |
|
977 |
|
978 |
|
979 |
|
980 |
|
981 |
|
982 |
|
983 |
|
984 |
|
985 | </dl>
|
986 |
|
987 |
|
988 |
|
989 |
|
990 |
|
991 |
|
992 |
|
993 |
|
994 |
|
995 |
|
996 |
|
997 |
|
998 |
|
999 |
|
1000 |
|
1001 |
|
1002 |
|
1003 |
|
1004 |
|
1005 |
|
1006 |
|
1007 |
|
1008 |
|
1009 |
|
1010 | </article>
|
1011 |
|
1012 | </section>
|
1013 |
|
1014 |
|
1015 |
|
1016 |
|
1017 | </div>
|
1018 |
|
1019 | <nav>
|
1020 | <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-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-signals.html">signals</a></li><li><a href="module-util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="CloudProvider.html">CloudProvider</a></li><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="DnsProvider.html">DnsProvider</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="module.exports.html">exports</a></li></ul><h3>Global</h3><ul><li><a href="global.html#checkTask">checkTask</a></li></ul>
|
1021 | </nav>
|
1022 |
|
1023 | <br class="clear">
|
1024 |
|
1025 | <footer>
|
1026 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
1027 | </footer>
|
1028 |
|
1029 | <script> prettyPrint(); </script>
|
1030 | <script src="scripts/linenumber.js"> </script>
|
1031 | </body>
|
1032 | </html> |
\ | No newline at end of file |