UNPKG

13.3 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Global</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">Global</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2></h2>
32
33
34</header>
35
36<article>
37 <div class="container-overview">
38
39
40
41
42
43
44<dl class="details">
45
46
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</dl>
78
79
80
81
82 </div>
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99 <h3 class="subsection-title">Methods</h3>
100
101
102
103
104
105
106
107 <h4 class="name" id="checkTask"><span class="type-signature"></span>checkTask<span class="signature">(taskPath, taskIdToCheck, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
108
109
110
111
112
113
114<div class="description">
115 <p>Checks status of iControl REST task</p>
116</div>
117
118
119
120
121
122
123
124
125
126 <h5>Parameters:</h5>
127
128
129<table class="params">
130 <thead>
131 <tr>
132
133 <th>Name</th>
134
135
136 <th>Type</th>
137
138
139 <th>Attributes</th>
140
141
142
143
144 <th class="last">Description</th>
145 </tr>
146 </thead>
147
148 <tbody>
149
150
151 <tr>
152
153 <td class="name"><code>taskPath</code></td>
154
155
156 <td class="type">
157
158
159<span class="param-type">String</span>
160
161
162
163 </td>
164
165
166 <td class="attributes">
167
168
169
170
171
172 </td>
173
174
175
176
177 <td class="description last"><p>URL that created the task</p></td>
178 </tr>
179
180
181
182 <tr>
183
184 <td class="name"><code>taskIdToCheck</code></td>
185
186
187 <td class="type">
188
189
190<span class="param-type">String</span>
191
192
193
194 </td>
195
196
197 <td class="attributes">
198
199
200
201
202
203 </td>
204
205
206
207
208 <td class="description last"><p>ID of task as returned by create</p></td>
209 </tr>
210
211
212
213 <tr>
214
215 <td class="name"><code>options</code></td>
216
217
218 <td class="type">
219
220
221<span class="param-type">Object</span>
222
223
224
225 </td>
226
227
228 <td class="attributes">
229
230 &lt;optional><br>
231
232
233
234
235
236 </td>
237
238
239
240
241 <td class="description last"><p>Options for parsing task response</p>
242 <h6>Properties</h6>
243
244
245<table class="params">
246 <thead>
247 <tr>
248
249 <th>Name</th>
250
251
252 <th>Type</th>
253
254
255 <th>Attributes</th>
256
257
258
259
260 <th class="last">Description</th>
261 </tr>
262 </thead>
263
264 <tbody>
265
266
267 <tr>
268
269 <td class="name"><code>statusAttribute</code></td>
270
271
272 <td class="type">
273
274
275<span class="param-type">String</span>
276
277
278
279 </td>
280
281
282 <td class="attributes">
283
284 &lt;optional><br>
285
286
287
288
289
290 </td>
291
292
293
294
295 <td class="description last"><p>Name of the Task Status attribute in the result response.
296 Default: '_taskState'</p></td>
297 </tr>
298
299
300 </tbody>
301</table>
302
303 </td>
304 </tr>
305
306
307 </tbody>
308</table>
309
310
311
312
313
314
315<dl class="details">
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348</dl>
349
350
351
352
353
354
355
356
357
358
359
360
361
362<h5>Returns:</h5>
363
364
365<div class="param-desc">
366 <p>A promise which is resolved with true if the task completes
367 successfully, resolved with false if task goes to error state
368 or rejected if some other error occurs.</p>
369</div>
370
371
372
373<dl>
374 <dt>
375 Type
376 </dt>
377 <dd>
378
379<span class="param-type">Promise</span>
380
381
382 </dd>
383</dl>
384
385
386
387
388
389
390
391
392
393
394
395
396
397 <h4 class="name" id="forceResetUserPassword"><span class="type-signature"></span>forceResetUserPassword<span class="signature">(user)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
398
399
400
401
402
403
404<div class="description">
405 <p>Force resets a user's password, even if the oldPassword is not known.</p>
406</div>
407
408
409
410
411
412
413
414
415
416 <h5>Parameters:</h5>
417
418
419<table class="params">
420 <thead>
421 <tr>
422
423 <th>Name</th>
424
425
426 <th>Type</th>
427
428
429
430
431
432 <th class="last">Description</th>
433 </tr>
434 </thead>
435
436 <tbody>
437
438
439 <tr>
440
441 <td class="name"><code>user</code></td>
442
443
444 <td class="type">
445
446
447<span class="param-type">String</span>
448
449
450
451 </td>
452
453
454
455
456
457 <td class="description last"><p>user to reset</p></td>
458 </tr>
459
460
461 </tbody>
462</table>
463
464
465
466
467
468
469<dl class="details">
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502</dl>
503
504
505
506
507
508
509
510
511
512
513
514
515
516<h5>Returns:</h5>
517
518
519<div class="param-desc">
520 <p>A promise which is resolved when the operation is complete
521 or rejected if an error occurs.</p>
522</div>
523
524
525
526<dl>
527 <dt>
528 Type
529 </dt>
530 <dd>
531
532<span class="param-type">Promise</span>
533
534
535 </dd>
536</dl>
537
538
539
540
541
542
543
544
545
546
547
548
549
550 <h4 class="name" id="getDataFromPropPath"><span class="type-signature"></span>getDataFromPropPath<span class="signature">(pathArray, obj)</span><span class="type-signature"> &rarr; {*}</span></h4>
551
552
553
554
555
556
557<div class="description">
558 <p>Gets the value from an Object's property using a provided Object property path. An empty
559property name in the path fetches all keys in the current Object.</p>
560</div>
561
562
563
564
565
566
567
568
569
570 <h5>Parameters:</h5>
571
572
573<table class="params">
574 <thead>
575 <tr>
576
577 <th>Name</th>
578
579
580 <th>Type</th>
581
582
583
584
585
586 <th class="last">Description</th>
587 </tr>
588 </thead>
589
590 <tbody>
591
592
593 <tr>
594
595 <td class="name"><code>pathArray</code></td>
596
597
598 <td class="type">
599
600
601<span class="param-type">Array.&lt;String></span>
602
603
604
605 </td>
606
607
608
609
610
611 <td class="description last"><p>Array of properties to traverse through.</p></td>
612 </tr>
613
614
615
616 <tr>
617
618 <td class="name"><code>obj</code></td>
619
620
621 <td class="type">
622
623
624<span class="param-type">Object</span>
625
626
627
628 </td>
629
630
631
632
633
634 <td class="description last"><p>Object to traverse.</p></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>Data that was fetched from the property.</p>
698</div>
699
700
701
702<dl>
703 <dt>
704 Type
705 </dt>
706 <dd>
707
708<span class="param-type">*</span>
709
710
711 </dd>
712</dl>
713
714
715
716
717
718
719
720
721
722
723
724
725
726 <h4 class="name" id="getLicenseProvider"><span class="type-signature"></span>getLicenseProvider<span class="signature">(poolName, options)</span><span class="type-signature"></span></h4>
727
728
729
730
731
732
733<div class="description">
734 <p>Gets a license provider based on api type or version</p>
735</div>
736
737
738
739
740
741
742
743
744
745 <h5>Parameters:</h5>
746
747
748<table class="params">
749 <thead>
750 <tr>
751
752 <th>Name</th>
753
754
755 <th>Type</th>
756
757
758
759
760
761 <th class="last">Description</th>
762 </tr>
763 </thead>
764
765 <tbody>
766
767
768 <tr>
769
770 <td class="name"><code>poolName</code></td>
771
772
773 <td class="type">
774
775
776<span class="param-type">String</span>
777
778
779
780 </td>
781
782
783
784
785
786 <td class="description last"><p>The name of the license pool</p></td>
787 </tr>
788
789
790
791 <tr>
792
793 <td class="name"><code>options</code></td>
794
795
796 <td class="type">
797
798
799<span class="param-type">Object</span>
800
801
802
803 </td>
804
805
806
807
808
809 <td class="description last"><p>Options</p>
810 <h6>Properties</h6>
811
812
813<table class="params">
814 <thead>
815 <tr>
816
817 <th>Name</th>
818
819
820 <th>Type</th>
821
822
823 <th>Attributes</th>
824
825
826
827
828 <th class="last">Description</th>
829 </tr>
830 </thead>
831
832 <tbody>
833
834
835 <tr>
836
837 <td class="name"><code>autoApiType</code></td>
838
839
840 <td class="type">
841
842
843<span class="param-type">Boolean</span>
844
845
846
847 </td>
848
849
850 <td class="attributes">
851
852
853
854
855
856 </td>
857
858
859
860
861 <td class="description last"><p>Automatically determine API type rather
862 than basing on BIG-IQ version.</p></td>
863 </tr>
864
865
866
867 <tr>
868
869 <td class="name"><code>noUnreachable</code></td>
870
871
872 <td class="type">
873
874
875<span class="param-type">Boolean</span>
876
877
878
879 </td>
880
881
882 <td class="attributes">
883
884 &lt;optional><br>
885
886
887
888
889
890 </td>
891
892
893
894
895 <td class="description last"><p>Do not use the unreachable API even on BIG-IQs that support it.</p></td>
896 </tr>
897
898
899 </tbody>
900</table>
901
902 </td>
903 </tr>
904
905
906 </tbody>
907</table>
908
909
910
911
912
913
914<dl class="details">
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947</dl>
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972</article>
973
974</section>
975
976
977
978
979</div>
980
981<nav>
982 <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>
983</nav>
984
985<br class="clear">
986
987<footer>
988 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
989</footer>
990
991<script> prettyPrint(); </script>
992<script src="scripts/linenumber.js"> </script>
993</body>
994</html>
\No newline at end of file