UNPKG

63.3 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Class: CloudProvider</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: CloudProvider</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2><span class="attribs"><span class="type-signature"></span></span>CloudProvider<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
32
33 <div class="class-description"><p>Abstract cloud provider implementation.</p>
34<p>This class should be inherited from to implement cloud-provider
35specific implementations. Any method in this class that throws
36must be overridded. Methods that do not throw may be optionally
37overridden.</p></div>
38
39
40</header>
41
42<article>
43 <div class="container-overview">
44
45
46
47
48 <h2>Constructor</h2>
49
50
51
52 <h4 class="name" id="CloudProvider"><span class="type-signature"></span>new CloudProvider<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
53
54
55
56
57
58
59<div class="description">
60 <p>Constructor.</p>
61</div>
62
63
64
65
66
67
68
69
70
71 <h5>Parameters:</h5>
72
73
74<table class="params">
75 <thead>
76 <tr>
77
78 <th>Name</th>
79
80
81 <th>Type</th>
82
83
84 <th>Attributes</th>
85
86
87
88
89 <th class="last">Description</th>
90 </tr>
91 </thead>
92
93 <tbody>
94
95
96 <tr>
97
98 <td class="name"><code>options</code></td>
99
100
101 <td class="type">
102
103
104<span class="param-type">Ojbect</span>
105
106
107
108 </td>
109
110
111 <td class="attributes">
112
113 &lt;optional><br>
114
115
116
117
118
119 </td>
120
121
122
123
124 <td class="description last"><p>Options for the instance.</p>
125 <h6>Properties</h6>
126
127
128<table class="params">
129 <thead>
130 <tr>
131
132 <th>Name</th>
133
134
135 <th>Type</th>
136
137
138 <th>Attributes</th>
139
140
141
142
143 <th class="last">Description</th>
144 </tr>
145 </thead>
146
147 <tbody>
148
149
150 <tr>
151
152 <td class="name"><code>clOptions</code></td>
153
154
155 <td class="type">
156
157
158<span class="param-type">Object</span>
159
160
161
162 </td>
163
164
165 <td class="attributes">
166
167 &lt;optional><br>
168
169
170
171
172
173 </td>
174
175
176
177
178 <td class="description last"><p>Command line options if called from a script.</p></td>
179 </tr>
180
181
182
183 <tr>
184
185 <td class="name"><code>logger</code></td>
186
187
188 <td class="type">
189
190
191<span class="param-type">Object</span>
192
193
194
195 </td>
196
197
198 <td class="attributes">
199
200 &lt;optional><br>
201
202
203
204
205
206 </td>
207
208
209
210
211 <td class="description last"><p>Logger to use. Or, pass loggerOptions to get your own logger.</p></td>
212 </tr>
213
214
215
216 <tr>
217
218 <td class="name"><code>loggerOptions</code></td>
219
220
221 <td class="type">
222
223
224<span class="param-type">Object</span>
225
226
227
228 </td>
229
230
231 <td class="attributes">
232
233 &lt;optional><br>
234
235
236
237
238
239 </td>
240
241
242
243
244 <td class="description last"><p>Options for the logger.
245 See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
246 </tr>
247
248
249 </tbody>
250</table>
251
252 </td>
253 </tr>
254
255
256 </tbody>
257</table>
258
259
260
261
262
263
264<dl class="details">
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
292
293
294
295
296
297</dl>
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317 </div>
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334 <h3 class="subsection-title">Methods</h3>
335
336
337
338
339
340
341
342 <h4 class="name" id="bigIpReady"><span class="type-signature"></span>bigIpReady<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
343
344
345
346
347
348
349<div class="description">
350 <p>BIG-IP is now ready and providers can run BIG-IP functions
351if necessary</p>
352</div>
353
354
355
356
357
358
359
360
361
362
363
364
365
366<dl class="details">
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
394
395
396
397
398
399</dl>
400
401
402
403
404
405
406
407
408
409
410
411
412
413<h5>Returns:</h5>
414
415
416<div class="param-desc">
417 <p>A promise which will be resolved when init is complete.</p>
418</div>
419
420
421
422<dl>
423 <dt>
424 Type
425 </dt>
426 <dd>
427
428<span class="param-type">Promise</span>
429
430
431 </dd>
432</dl>
433
434
435
436
437
438
439
440
441
442
443
444
445
446 <h4 class="name" id="electPrimary"><span class="type-signature">(abstract) </span>electPrimary<span class="signature">(instances)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
447
448
449
450
451
452
453<div class="description">
454 <p>Elects a new primary instance from the available instances</p>
455</div>
456
457
458
459
460
461
462
463
464
465 <h5>Parameters:</h5>
466
467
468<table class="params">
469 <thead>
470 <tr>
471
472 <th>Name</th>
473
474
475 <th>Type</th>
476
477
478
479
480
481 <th class="last">Description</th>
482 </tr>
483 </thead>
484
485 <tbody>
486
487
488 <tr>
489
490 <td class="name"><code>instances</code></td>
491
492
493 <td class="type">
494
495
496<span class="param-type">Object</span>
497
498
499
500 </td>
501
502
503
504
505
506 <td class="description last"><p>Dictionary of instances as returned by getInstances.</p></td>
507 </tr>
508
509
510 </tbody>
511</table>
512
513
514
515
516
517
518<dl class="details">
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551</dl>
552
553
554
555
556
557
558
559
560
561
562
563
564
565<h5>Returns:</h5>
566
567
568<div class="param-desc">
569 <p>A promise which will be resolved with the instance ID of the
570 elected primary.</p>
571</div>
572
573
574
575<dl>
576 <dt>
577 Type
578 </dt>
579 <dd>
580
581<span class="param-type">Promise</span>
582
583
584 </dd>
585</dl>
586
587
588
589
590
591
592
593
594
595
596
597
598
599 <h4 class="name" id="getDataFromUri"><span class="type-signature">(abstract) </span>getDataFromUri<span class="signature">(uri)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
600
601
602
603
604
605
606<div class="description">
607 <p>Gets data from a provider specific URI</p>
608<p>Override for implementations that wish to allow retrieval of data from a
609provider specific URI (for example, an ARN to an S3 bucket).</p>
610</div>
611
612
613
614
615
616
617
618
619
620 <h5>Parameters:</h5>
621
622
623<table class="params">
624 <thead>
625 <tr>
626
627 <th>Name</th>
628
629
630 <th>Type</th>
631
632
633
634
635
636 <th class="last">Description</th>
637 </tr>
638 </thead>
639
640 <tbody>
641
642
643 <tr>
644
645 <td class="name"><code>uri</code></td>
646
647
648 <td class="type">
649
650
651<span class="param-type">String</span>
652
653
654
655 </td>
656
657
658
659
660
661 <td class="description last"><p>The cloud-specific URI of the resource.</p></td>
662 </tr>
663
664
665 </tbody>
666</table>
667
668
669
670
671
672
673<dl class="details">
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706</dl>
707
708
709
710
711
712
713
714
715
716
717
718
719
720<h5>Returns:</h5>
721
722
723<div class="param-desc">
724 <p>A promise which will be resolved with the data from the URI
725 or rejected if an error occurs.</p>
726</div>
727
728
729
730<dl>
731 <dt>
732 Type
733 </dt>
734 <dd>
735
736<span class="param-type">Promise</span>
737
738
739 </dd>
740</dl>
741
742
743
744
745
746
747
748
749
750
751
752
753
754 <h4 class="name" id="getInstanceId"><span class="type-signature">(abstract) </span>getInstanceId<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
755
756
757
758
759
760
761<div class="description">
762 <p>Gets the instance ID of this instance</p>
763</div>
764
765
766
767
768
769
770
771
772
773
774
775
776
777<dl class="details">
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810</dl>
811
812
813
814
815
816
817
818
819
820
821
822
823
824<h5>Returns:</h5>
825
826
827<div class="param-desc">
828 <p>A promise which will be resolved with the instance ID of this instance
829 or rejected if an error occurs;</p>
830</div>
831
832
833
834<dl>
835 <dt>
836 Type
837 </dt>
838 <dd>
839
840<span class="param-type">Promise</span>
841
842
843 </dd>
844</dl>
845
846
847
848
849
850
851
852
853
854
855
856
857
858 <h4 class="name" id="getInstances"><span class="type-signature">(abstract) </span>getInstances<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
859
860
861
862
863
864
865<div class="description">
866 <p>Gets info for each instance</p>
867<p>Retrieval is cloud specific. Likely either from the cloud infrastructure
868itself, stored info that we have in a database, or both.</p>
869</div>
870
871
872
873
874
875
876
877
878
879 <h5>Parameters:</h5>
880
881
882<table class="params">
883 <thead>
884 <tr>
885
886 <th>Name</th>
887
888
889 <th>Type</th>
890
891
892 <th>Attributes</th>
893
894
895
896
897 <th class="last">Description</th>
898 </tr>
899 </thead>
900
901 <tbody>
902
903
904 <tr>
905
906 <td class="name"><code>options</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 &lt;optional><br>
922
923
924
925
926
927 </td>
928
929
930
931
932 <td class="description last"><p>Optional parameters</p>
933 <h6>Properties</h6>
934
935
936<table class="params">
937 <thead>
938 <tr>
939
940 <th>Name</th>
941
942
943 <th>Type</th>
944
945
946 <th>Attributes</th>
947
948
949
950
951 <th class="last">Description</th>
952 </tr>
953 </thead>
954
955 <tbody>
956
957
958 <tr>
959
960 <td class="name"><code>externalTag</code></td>
961
962
963 <td class="type">
964
965
966<span class="param-type">String</span>
967
968
969
970 </td>
971
972
973 <td class="attributes">
974
975 &lt;optional><br>
976
977
978
979
980
981 </td>
982
983
984
985
986 <td class="description last"><p>Also look for instances with this
987 tag (outside of the autoscale group/set)</p></td>
988 </tr>
989
990
991 </tbody>
992</table>
993
994 </td>
995 </tr>
996
997
998 </tbody>
999</table>
1000
1001
1002
1003
1004
1005
1006<dl class="details">
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039</dl>
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053<h5>Returns:</h5>
1054
1055
1056<div class="param-desc">
1057 <p>A promise which will be resolved with a dictionary of instances
1058 keyed by instance ID. Each instance value should be:</p>
1059<pre class="prettyprint source"><code> {
1060 isPrimary: &lt;Boolean>,
1061 hostname: &lt;String>,
1062 mgmtIp: &lt;String>,
1063 privateIp: &lt;String>,
1064 publicIp: &lt;String>,
1065 providerVisible: &lt;Boolean> (does the cloud provider know about this instance),
1066 external: &lt;Boolean> (true if this instance is external to the autoscale group/set)
1067 }</code></pre>
1068</div>
1069
1070
1071
1072<dl>
1073 <dt>
1074 Type
1075 </dt>
1076 <dd>
1077
1078<span class="param-type">Promise</span>
1079
1080
1081 </dd>
1082</dl>
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096 <h4 class="name" id="getPrimaryCredentials"><span class="type-signature">(abstract) </span>getPrimaryCredentials<span class="signature">(mgmtIp, port)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1097
1098
1099
1100
1101
1102
1103<div class="description">
1104 <p>Called to retrieve primary instance credentials</p>
1105<p>Must be implemented if FEATURE_MESSAGING is not supported.</p>
1106<p>If FEATURE_MESSAGING is not supported, when joining a cluster we need the
1107username and password for the primary instance.</p>
1108<p>If FEATURE_MESSAGING is supported, the primary will be sent a message to
1109add an instance.</p>
1110<p>Management IP and port are passed in so that credentials can be
1111validated desired.</p>
1112</div>
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122 <h5>Parameters:</h5>
1123
1124
1125<table class="params">
1126 <thead>
1127 <tr>
1128
1129 <th>Name</th>
1130
1131
1132 <th>Type</th>
1133
1134
1135
1136
1137
1138 <th class="last">Description</th>
1139 </tr>
1140 </thead>
1141
1142 <tbody>
1143
1144
1145 <tr>
1146
1147 <td class="name"><code>mgmtIp</code></td>
1148
1149
1150 <td class="type">
1151
1152
1153<span class="param-type">String</span>
1154
1155
1156
1157 </td>
1158
1159
1160
1161
1162
1163 <td class="description last"><p>Management IP of primary.</p></td>
1164 </tr>
1165
1166
1167
1168 <tr>
1169
1170 <td class="name"><code>port</code></td>
1171
1172
1173 <td class="type">
1174
1175
1176<span class="param-type">String</span>
1177
1178
1179
1180 </td>
1181
1182
1183
1184
1185
1186 <td class="description last"><p>Management port of primary.</p></td>
1187 </tr>
1188
1189
1190 </tbody>
1191</table>
1192
1193
1194
1195
1196
1197
1198<dl class="details">
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231</dl>
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245<h5>Returns:</h5>
1246
1247
1248<div class="param-desc">
1249 <p>A promise which will be resolved with:</p>
1250<pre class="prettyprint source"><code> {
1251 username: &lt;admin_user>,
1252 password: &lt;admin_password>
1253 }</code></pre>
1254</div>
1255
1256
1257
1258<dl>
1259 <dt>
1260 Type
1261 </dt>
1262 <dd>
1263
1264<span class="param-type">Promise</span>
1265
1266
1267 </dd>
1268</dl>
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282 <h4 class="name" id="getPrimaryStatus"><span class="type-signature"></span>getPrimaryStatus<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1283
1284
1285
1286
1287
1288
1289<div class="description">
1290 <p>Gets info on what this instance thinks the primary status is</p>
1291<p>Info is retrieval is cloud specific. Likely either from the cloud infrastructure
1292itself, stored info that we have in a database, or both.</p>
1293</div>
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307<dl class="details">
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340</dl>
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354<h5>Returns:</h5>
1355
1356
1357<div class="param-desc">
1358 <p>A promise which will be resolved with a dictionary of primary
1359 status:</p>
1360<pre class="prettyprint source"><code> {
1361 &quot;instanceId&quot;: primaryInstanceId
1362 &quot;status&quot;: CloudProvider.STATUS_*
1363 &quot;lastUpdate&quot;: Date,
1364 &quot;lastStatusChange&quot;: Date
1365 }</code></pre>
1366</div>
1367
1368
1369
1370<dl>
1371 <dt>
1372 Type
1373 </dt>
1374 <dd>
1375
1376<span class="param-type">Promise</span>
1377
1378
1379 </dd>
1380</dl>
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394 <h4 class="name" id="getMessages"><span class="type-signature"></span>getMessages<span class="signature">(actions, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1395
1396
1397
1398
1399
1400
1401<div class="description">
1402 <p>Gets messages from other instances in the scale set</p>
1403</div>
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413 <h5>Parameters:</h5>
1414
1415
1416<table class="params">
1417 <thead>
1418 <tr>
1419
1420 <th>Name</th>
1421
1422
1423 <th>Type</th>
1424
1425
1426 <th>Attributes</th>
1427
1428
1429
1430
1431 <th class="last">Description</th>
1432 </tr>
1433 </thead>
1434
1435 <tbody>
1436
1437
1438 <tr>
1439
1440 <td class="name"><code>actions</code></td>
1441
1442
1443 <td class="type">
1444
1445
1446<span class="param-type">Array.&lt;String></span>
1447
1448
1449
1450 </td>
1451
1452
1453 <td class="attributes">
1454
1455
1456
1457
1458
1459 </td>
1460
1461
1462
1463
1464 <td class="description last"><p>Array of actions to get. Other messages will be ignored.
1465 Default (empty or undefined) is all actions.</p></td>
1466 </tr>
1467
1468
1469
1470 <tr>
1471
1472 <td class="name"><code>options</code></td>
1473
1474
1475 <td class="type">
1476
1477
1478<span class="param-type">Object</span>
1479
1480
1481
1482 </td>
1483
1484
1485 <td class="attributes">
1486
1487 &lt;optional><br>
1488
1489
1490
1491
1492
1493 </td>
1494
1495
1496
1497
1498 <td class="description last"><p>Optional parameters</p>
1499 <h6>Properties</h6>
1500
1501
1502<table class="params">
1503 <thead>
1504 <tr>
1505
1506 <th>Name</th>
1507
1508
1509 <th>Type</th>
1510
1511
1512 <th>Attributes</th>
1513
1514
1515
1516
1517 <th class="last">Description</th>
1518 </tr>
1519 </thead>
1520
1521 <tbody>
1522
1523
1524 <tr>
1525
1526 <td class="name"><code>toInstanceId</code></td>
1527
1528
1529 <td class="type">
1530
1531
1532<span class="param-type">String</span>
1533
1534
1535
1536 </td>
1537
1538
1539 <td class="attributes">
1540
1541 &lt;optional><br>
1542
1543
1544
1545
1546
1547 </td>
1548
1549
1550
1551
1552 <td class="description last"><p>toInstanceId of messsages we are interested in</p></td>
1553 </tr>
1554
1555
1556 </tbody>
1557</table>
1558
1559 </td>
1560 </tr>
1561
1562
1563 </tbody>
1564</table>
1565
1566
1567
1568
1569
1570
1571<dl class="details">
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604</dl>
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618<h5>Returns:</h5>
1619
1620
1621<div class="param-desc">
1622 <p>A promise which will be resolved when the messages
1623 have been received and processed. Promise should be
1624 resolved with an array of messages of the form</p>
1625<pre class="prettyprint source"><code> {
1626 action: message action id,
1627 toInstanceId: instanceId,
1628 fromInstanceId: instanceId,
1629 data: message specific data used in sendMessage,
1630 completionHandler: optional completionHandler to call wnen done processing
1631 {
1632 this: this arg for callback context,
1633 callback: function to call,
1634 data: data to send to function
1635 }
1636 }</code></pre>
1637</div>
1638
1639
1640
1641<dl>
1642 <dt>
1643 Type
1644 </dt>
1645 <dd>
1646
1647<span class="param-type">Promise</span>
1648
1649
1650 </dd>
1651</dl>
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665 <h4 class="name" id="getNicsByTag"><span class="type-signature"></span>getNicsByTag<span class="signature">(tag)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1666
1667
1668
1669
1670
1671
1672<div class="description">
1673 <p>Searches for NICs that have a given tag.</p>
1674</div>
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684 <h5>Parameters:</h5>
1685
1686
1687<table class="params">
1688 <thead>
1689 <tr>
1690
1691 <th>Name</th>
1692
1693
1694 <th>Type</th>
1695
1696
1697
1698
1699
1700 <th class="last">Description</th>
1701 </tr>
1702 </thead>
1703
1704 <tbody>
1705
1706
1707 <tr>
1708
1709 <td class="name"><code>tag</code></td>
1710
1711
1712 <td class="type">
1713
1714
1715<span class="param-type">Object</span>
1716
1717
1718
1719 </td>
1720
1721
1722
1723
1724
1725 <td class="description last"><p>Tag to search for. Tag is of the format:</p>
1726<pre class="prettyprint source"><code> {
1727 key: optional key
1728 value: value to search for
1729 }</code></pre></td>
1730 </tr>
1731
1732
1733 </tbody>
1734</table>
1735
1736
1737
1738
1739
1740
1741<dl class="details">
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774</dl>
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788<h5>Returns:</h5>
1789
1790
1791<div class="param-desc">
1792 <p>A promise which will be resolved with an array of instances.
1793 Each instance value should be:</p>
1794<pre class="prettyprint source"><code> {
1795 id: NIC ID,
1796 ip: {
1797 public: public IP (or first public IP on the NIC),
1798 private: private IP (or first private IP on the NIC)
1799 }
1800 }</code></pre>
1801</div>
1802
1803
1804
1805<dl>
1806 <dt>
1807 Type
1808 </dt>
1809 <dd>
1810
1811<span class="param-type">Promise</span>
1812
1813
1814 </dd>
1815</dl>
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829 <h4 class="name" id="getNodesFromUri"><span class="type-signature"></span>getNodesFromUri<span class="signature">(uri, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1830
1831
1832
1833
1834
1835
1836<div class="description">
1837 <p>Gets nodes from the provided URI. The resource should be in JSON
1838format as an array of objects. JSON strings that parse to an array
1839of objects are also supported.</p>
1840</div>
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850 <h5>Parameters:</h5>
1851
1852
1853<table class="params">
1854 <thead>
1855 <tr>
1856
1857 <th>Name</th>
1858
1859
1860 <th>Type</th>
1861
1862
1863 <th>Attributes</th>
1864
1865
1866
1867
1868 <th class="last">Description</th>
1869 </tr>
1870 </thead>
1871
1872 <tbody>
1873
1874
1875 <tr>
1876
1877 <td class="name"><code>uri</code></td>
1878
1879
1880 <td class="type">
1881
1882
1883<span class="param-type">String</span>
1884
1885
1886
1887 </td>
1888
1889
1890 <td class="attributes">
1891
1892
1893
1894
1895
1896 </td>
1897
1898
1899
1900
1901 <td class="description last"><p>The URI of the resource.</p></td>
1902 </tr>
1903
1904
1905
1906 <tr>
1907
1908 <td class="name"><code>options</code></td>
1909
1910
1911 <td class="type">
1912
1913
1914<span class="param-type">Object</span>
1915
1916
1917
1918 </td>
1919
1920
1921 <td class="attributes">
1922
1923 &lt;optional><br>
1924
1925
1926
1927
1928
1929 </td>
1930
1931
1932
1933
1934 <td class="description last"><p>Optional parameters</p>
1935 <h6>Properties</h6>
1936
1937
1938<table class="params">
1939 <thead>
1940 <tr>
1941
1942 <th>Name</th>
1943
1944
1945 <th>Type</th>
1946
1947
1948 <th>Attributes</th>
1949
1950
1951
1952
1953 <th class="last">Description</th>
1954 </tr>
1955 </thead>
1956
1957 <tbody>
1958
1959
1960 <tr>
1961
1962 <td class="name"><code>headers</code></td>
1963
1964
1965 <td class="type">
1966
1967
1968<span class="param-type">Object</span>
1969
1970
1971
1972 </td>
1973
1974
1975 <td class="attributes">
1976
1977 &lt;optional><br>
1978
1979
1980
1981
1982
1983 </td>
1984
1985
1986
1987
1988 <td class="description last"><p>Map of headers to add to the request. Format:</p>
1989<pre class="prettyprint source"><code>{
1990 &lt;header1_name>: &lt;header1_value>,
1991 &lt;header2_name>: &lt;header2_value>
1992}</code></pre></td>
1993 </tr>
1994
1995
1996 </tbody>
1997</table>
1998
1999 </td>
2000 </tr>
2001
2002
2003 </tbody>
2004</table>
2005
2006
2007
2008
2009
2010
2011<dl class="details">
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044</dl>
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058<h5>Returns:</h5>
2059
2060
2061<div class="param-desc">
2062 <p>A promise which will be resolved with an array of instances.
2063 Each instance value should be:</p>
2064<pre class="prettyprint source"><code>{
2065 id: Node ID,
2066 ip: {
2067 public: public IP,
2068 private: private IP
2069 }
2070}</code></pre>
2071</div>
2072
2073
2074
2075<dl>
2076 <dt>
2077 Type
2078 </dt>
2079 <dd>
2080
2081<span class="param-type">Promise</span>
2082
2083
2084 </dd>
2085</dl>
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099 <h4 class="name" id="getPublicKey"><span class="type-signature"></span>getPublicKey<span class="signature">(instanceId)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
2100
2101
2102
2103
2104
2105
2106<div class="description">
2107 <p>Gets the public key for an instanceId.</p>
2108</div>
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118 <h5>Parameters:</h5>
2119
2120
2121<table class="params">
2122 <thead>
2123 <tr>
2124
2125 <th>Name</th>
2126
2127
2128 <th>Type</th>
2129
2130
2131
2132
2133
2134 <th class="last">Description</th>
2135 </tr>
2136 </thead>
2137
2138 <tbody>
2139
2140
2141 <tr>
2142
2143 <td class="name"><code>instanceId</code></td>
2144
2145
2146 <td class="type">
2147
2148
2149<span class="param-type">String</span>
2150
2151
2152
2153 </td>
2154
2155
2156
2157
2158
2159 <td class="description last"><p>Instance ID to validate as a valid primary.</p></td>
2160 </tr>
2161
2162
2163 </tbody>
2164</table>
2165
2166
2167
2168
2169
2170
2171<dl class="details">
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204</dl>
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218<h5>Returns:</h5>
2219
2220
2221<div class="param-desc">
2222 <p>A promise which will be resolved when the operation
2223 is complete</p>
2224</div>
2225
2226
2227
2228<dl>
2229 <dt>
2230 Type
2231 </dt>
2232 <dd>
2233
2234<span class="param-type">Promise</span>
2235
2236
2237 </dd>
2238</dl>
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252 <h4 class="name" id="getStoredUcs"><span class="type-signature"></span>getStoredUcs<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
2253
2254
2255
2256
2257
2258
2259<div class="description">
2260 <p>Called to get check for and retrieve a stored UCS file</p>
2261<p>Provider implementations can optionally store a UCS to be
2262used to restore a primary instance to a last known good state</p>
2263</div>
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277<dl class="details">
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310</dl>
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324<h5>Returns:</h5>
2325
2326
2327<div class="param-desc">
2328 <p>A promise which will be resolved with a Buffer containing
2329 the UCS data if it is present, resolved with undefined if not
2330 found, or rejected if an error occurs.</p>
2331</div>
2332
2333
2334
2335<dl>
2336 <dt>
2337 Type
2338 </dt>
2339 <dd>
2340
2341<span class="param-type">Promise</span>
2342
2343
2344 </dd>
2345</dl>
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359 <h4 class="name" id="getVmsByTag"><span class="type-signature"></span>getVmsByTag<span class="signature">(tag)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
2360
2361
2362
2363
2364
2365
2366<div class="description">
2367 <p>Searches for VMs that have a given tag.</p>
2368</div>
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378 <h5>Parameters:</h5>
2379
2380
2381<table class="params">
2382 <thead>
2383 <tr>
2384
2385 <th>Name</th>
2386
2387
2388 <th>Type</th>
2389
2390
2391
2392
2393
2394 <th class="last">Description</th>
2395 </tr>
2396 </thead>
2397
2398 <tbody>
2399
2400
2401 <tr>
2402
2403 <td class="name"><code>tag</code></td>
2404
2405
2406 <td class="type">
2407
2408
2409<span class="param-type">Object</span>
2410
2411
2412
2413 </td>
2414
2415
2416
2417
2418
2419 <td class="description last"><p>Tag to search for. Tag is of the format:</p>
2420<pre class="prettyprint source"><code> {
2421 key: optional key
2422 value: value to search for
2423 }</code></pre></td>
2424 </tr>
2425
2426
2427 </tbody>
2428</table>
2429
2430
2431
2432
2433
2434
2435<dl class="details">
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468</dl>
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482<h5>Returns:</h5>
2483
2484
2485<div class="param-desc">
2486 <p>A promise which will be resolved with an array of instances.
2487 Each instance value should be:</p>
2488<pre class="prettyprint source"><code> {
2489 id: instance ID,
2490 ip: {
2491 public: public IP (or first public IP on the first NIC),
2492 private: private IP (or first private IP on the first NIC)
2493 }
2494 }</code></pre>
2495</div>
2496
2497
2498
2499<dl>
2500 <dt>
2501 Type
2502 </dt>
2503 <dd>
2504
2505<span class="param-type">Promise</span>
2506
2507
2508 </dd>
2509</dl>
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523 <h4 class="name" id="hasFeature"><span class="type-signature"></span>hasFeature<span class="signature">(feature)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
2524
2525
2526
2527
2528
2529
2530<div class="description">
2531 <p>Determines if the provider supports a feature.</p>
2532</div>
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542 <h5>Parameters:</h5>
2543
2544
2545<table class="params">
2546 <thead>
2547 <tr>
2548
2549 <th>Name</th>
2550
2551
2552 <th>Type</th>
2553
2554
2555
2556
2557
2558 <th class="last">Description</th>
2559 </tr>
2560 </thead>
2561
2562 <tbody>
2563
2564
2565 <tr>
2566
2567 <td class="name"><code>feature</code></td>
2568
2569
2570 <td class="type">
2571
2572
2573<span class="param-type">String</span>
2574
2575
2576
2577 </td>
2578
2579
2580
2581
2582
2583 <td class="description last"><p>Feature to check for</p></td>
2584 </tr>
2585
2586
2587 </tbody>
2588</table>
2589
2590
2591
2592
2593
2594
2595<dl class="details">
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628</dl>
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642<h5>Returns:</h5>
2643
2644
2645<div class="param-desc">
2646 <p>Whether or not the provider supports the feature</p>
2647</div>
2648
2649
2650
2651<dl>
2652 <dt>
2653 Type
2654 </dt>
2655 <dd>
2656
2657<span class="param-type">Boolean</span>
2658
2659
2660 </dd>
2661</dl>
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675 <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(providerOptions, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
2676
2677
2678
2679
2680
2681
2682<div class="description">
2683 <p>Initialize class</p>
2684<p>Override for implementation specific initialization needs (read info
2685from cloud provider, read database, etc.). Called at the start of
2686processing.</p>
2687</div>
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697 <h5>Parameters:</h5>
2698
2699
2700<table class="params">
2701 <thead>
2702 <tr>
2703
2704 <th>Name</th>
2705
2706
2707 <th>Type</th>
2708
2709
2710 <th>Attributes</th>
2711
2712
2713
2714
2715 <th class="last">Description</th>
2716 </tr>
2717 </thead>
2718
2719 <tbody>
2720
2721
2722 <tr>
2723
2724 <td class="name"><code>providerOptions</code></td>
2725
2726
2727 <td class="type">
2728
2729
2730<span class="param-type">Object</span>
2731
2732
2733
2734 </td>
2735
2736
2737 <td class="attributes">
2738
2739
2740
2741
2742
2743 </td>
2744
2745
2746
2747
2748 <td class="description last"><p>Provider specific options.</p></td>
2749 </tr>
2750
2751
2752
2753 <tr>
2754
2755 <td class="name"><code>options</code></td>
2756
2757
2758 <td class="type">
2759
2760
2761<span class="param-type">Object</span>
2762
2763
2764
2765 </td>
2766
2767
2768 <td class="attributes">
2769
2770 &lt;optional><br>
2771
2772
2773
2774
2775
2776 </td>
2777
2778
2779
2780
2781 <td class="description last"><p>Options for this instance.</p>
2782 <h6>Properties</h6>
2783
2784
2785<table class="params">
2786 <thead>
2787 <tr>
2788
2789 <th>Name</th>
2790
2791
2792 <th>Type</th>
2793
2794
2795 <th>Attributes</th>
2796
2797
2798
2799
2800 <th class="last">Description</th>
2801 </tr>
2802 </thead>
2803
2804 <tbody>
2805
2806
2807 <tr>
2808
2809 <td class="name"><code>autoscale</code></td>
2810
2811
2812 <td class="type">
2813
2814
2815<span class="param-type">Boolean</span>
2816
2817
2818
2819 </td>
2820
2821
2822 <td class="attributes">
2823
2824 &lt;optional><br>
2825
2826
2827
2828
2829
2830 </td>
2831
2832
2833
2834
2835 <td class="description last"><p>Whether or not this instance will be used for autoscaling.</p></td>
2836 </tr>
2837
2838
2839 </tbody>
2840</table>
2841
2842 </td>
2843 </tr>
2844
2845
2846 </tbody>
2847</table>
2848
2849
2850
2851
2852
2853
2854<dl class="details">
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887</dl>
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901<h5>Returns:</h5>
2902
2903
2904<div class="param-desc">
2905 <p>A promise which will be resolved when init is complete.</p>
2906</div>
2907
2908
2909
2910<dl>
2911 <dt>
2912 Type
2913 </dt>
2914 <dd>
2915
2916<span class="param-type">Promise</span>
2917
2918
2919 </dd>
2920</dl>
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934 <h4 class="name" id="isInstanceExpired"><span class="type-signature"></span>isInstanceExpired<span class="signature">(instance)</span><span class="type-signature"> &rarr; {Boolean}</span></h4>
2935
2936
2937
2938
2939
2940
2941<div class="description">
2942 <p>Determines whether a stored instance is so old it should not be considered</p>
2943</div>
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953 <h5>Parameters:</h5>
2954
2955
2956<table class="params">
2957 <thead>
2958 <tr>
2959
2960 <th>Name</th>
2961
2962
2963 <th>Type</th>
2964
2965
2966
2967
2968
2969 <th class="last">Description</th>
2970 </tr>
2971 </thead>
2972
2973 <tbody>
2974
2975
2976 <tr>
2977
2978 <td class="name"><code>instance</code></td>
2979
2980
2981 <td class="type">
2982
2983
2984<span class="param-type">Object</span>
2985
2986
2987
2988 </td>
2989
2990
2991
2992
2993
2994 <td class="description last"><p>Instance data</p></td>
2995 </tr>
2996
2997
2998 </tbody>
2999</table>
3000
3001
3002
3003
3004
3005
3006<dl class="details">
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039</dl>
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053<h5>Returns:</h5>
3054
3055
3056<div class="param-desc">
3057 <p>Whether or not the instance is expired</p>
3058</div>
3059
3060
3061
3062<dl>
3063 <dt>
3064 Type
3065 </dt>
3066 <dd>
3067
3068<span class="param-type">Boolean</span>
3069
3070
3071 </dd>
3072</dl>
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086 <h4 class="name" id="isValidPrimary"><span class="type-signature"></span>isValidPrimary<span class="signature">(instanceId, instances)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
3087
3088
3089
3090
3091
3092
3093<div class="description">
3094 <p>Determines if a given instanceId is a valid primary</p>
3095<p>In some cloud environments, the primary may change unexpectedly.
3096Override this method if implementing such a cloud provider.</p>
3097</div>
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107 <h5>Parameters:</h5>
3108
3109
3110<table class="params">
3111 <thead>
3112 <tr>
3113
3114 <th>Name</th>
3115
3116
3117 <th>Type</th>
3118
3119
3120
3121
3122
3123 <th class="last">Description</th>
3124 </tr>
3125 </thead>
3126
3127 <tbody>
3128
3129
3130 <tr>
3131
3132 <td class="name"><code>instanceId</code></td>
3133
3134
3135 <td class="type">
3136
3137
3138<span class="param-type">String</span>
3139
3140
3141
3142 </td>
3143
3144
3145
3146
3147
3148 <td class="description last"><p>Instance ID to validate as a valid primary.</p></td>
3149 </tr>
3150
3151
3152
3153 <tr>
3154
3155 <td class="name"><code>instances</code></td>
3156
3157
3158 <td class="type">
3159
3160
3161<span class="param-type">Object</span>
3162
3163
3164
3165 </td>
3166
3167
3168
3169
3170
3171 <td class="description last"><p>Dictionary of instances as returned by getInstances.</p></td>
3172 </tr>
3173
3174
3175 </tbody>
3176</table>
3177
3178
3179
3180
3181
3182
3183<dl class="details">
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216</dl>
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230<h5>Returns:</h5>
3231
3232
3233<div class="param-desc">
3234 <p>A promise which will be resolved with a boolean indicating
3235 wether or not the given instanceId is a valid primary.</p>
3236</div>
3237
3238
3239
3240<dl>
3241 <dt>
3242 Type
3243 </dt>
3244 <dd>
3245
3246<span class="param-type">Promise</span>
3247
3248
3249 </dd>
3250</dl>
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264 <h4 class="name" id="primaryElected"><span class="type-signature"></span>primaryElected<span class="signature">(instancId)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
3265
3266
3267
3268
3269
3270
3271<div class="description">
3272 <p>Called when a primary has been elected</p>
3273<p>In some cloud environments, information about the primary needs to be
3274stored in persistent storage. Override this method if implementing
3275such a cloud provider.</p>
3276</div>
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286 <h5>Parameters:</h5>
3287
3288
3289<table class="params">
3290 <thead>
3291 <tr>
3292
3293 <th>Name</th>
3294
3295
3296 <th>Type</th>
3297
3298
3299
3300
3301
3302 <th class="last">Description</th>
3303 </tr>
3304 </thead>
3305
3306 <tbody>
3307
3308
3309 <tr>
3310
3311 <td class="name"><code>instancId</code></td>
3312
3313
3314 <td class="type">
3315
3316
3317<span class="param-type">String</span>
3318
3319
3320
3321 </td>
3322
3323
3324
3325
3326
3327 <td class="description last"><p>Instance ID that was elected primary.</p></td>
3328 </tr>
3329
3330
3331 </tbody>
3332</table>
3333
3334
3335
3336
3337
3338
3339<dl class="details">
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372</dl>
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386<h5>Returns:</h5>
3387
3388
3389<div class="param-desc">
3390 <p>A promise which will be resolved when processing is complete.</p>
3391</div>
3392
3393
3394
3395<dl>
3396 <dt>
3397 Type
3398 </dt>
3399 <dd>
3400
3401<span class="param-type">Promise</span>
3402
3403
3404 </dd>
3405</dl>
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419 <h4 class="name" id="primaryInvalidated"><span class="type-signature"></span>primaryInvalidated<span class="signature">(instanceId, instances)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
3420
3421
3422
3423
3424
3425
3426<div class="description">
3427 <p>Indicates that an instance that was primary is now invalid</p>
3428<p>Override for cloud providers that need to take some action when a primary
3429becomes invalid.</p>
3430</div>
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440 <h5>Parameters:</h5>
3441
3442
3443<table class="params">
3444 <thead>
3445 <tr>
3446
3447 <th>Name</th>
3448
3449
3450 <th>Type</th>
3451
3452
3453
3454
3455
3456 <th class="last">Description</th>
3457 </tr>
3458 </thead>
3459
3460 <tbody>
3461
3462
3463 <tr>
3464
3465 <td class="name"><code>instanceId</code></td>
3466
3467
3468 <td class="type">
3469
3470
3471<span class="param-type">String</span>
3472
3473
3474
3475 </td>
3476
3477
3478
3479
3480
3481 <td class="description last"><p>Instance ID of instnace that is no longer a valid
3482 primary.</p></td>
3483 </tr>
3484
3485
3486
3487 <tr>
3488
3489 <td class="name"><code>instances</code></td>
3490
3491
3492 <td class="type">
3493
3494
3495<span class="param-type">Object</span>
3496
3497
3498
3499 </td>
3500
3501
3502
3503
3504
3505 <td class="description last"><p>Dictionary of instances as returned by getInstances.</p></td>
3506 </tr>
3507
3508
3509 </tbody>
3510</table>
3511
3512
3513
3514
3515
3516
3517<dl class="details">
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550</dl>
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564<h5>Returns:</h5>
3565
3566
3567<div class="param-desc">
3568 <p>A promise which will be resolved when processing is complete.</p>
3569</div>
3570
3571
3572
3573<dl>
3574 <dt>
3575 Type
3576 </dt>
3577 <dd>
3578
3579<span class="param-type">Promise</span>
3580
3581
3582 </dd>
3583</dl>
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597 <h4 class="name" id="putInstance"><span class="type-signature"></span>putInstance<span class="signature">(instanceId, instance)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
3598
3599
3600
3601
3602
3603
3604<div class="description">
3605 <p>Saves instance info</p>
3606<p>Override for cloud implementations which store instance information.</p>
3607</div>
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617 <h5>Parameters:</h5>
3618
3619
3620<table class="params">
3621 <thead>
3622 <tr>
3623
3624 <th>Name</th>
3625
3626
3627 <th>Type</th>
3628
3629
3630
3631
3632
3633 <th class="last">Description</th>
3634 </tr>
3635 </thead>
3636
3637 <tbody>
3638
3639
3640 <tr>
3641
3642 <td class="name"><code>instanceId</code></td>
3643
3644
3645 <td class="type">
3646
3647
3648<span class="param-type">String</span>
3649
3650
3651
3652 </td>
3653
3654
3655
3656
3657
3658 <td class="description last"><p>ID of instance</p></td>
3659 </tr>
3660
3661
3662
3663 <tr>
3664
3665 <td class="name"><code>instance</code></td>
3666
3667
3668 <td class="type">
3669
3670
3671<span class="param-type">Object</span>
3672
3673
3674
3675 </td>
3676
3677
3678
3679
3680
3681 <td class="description last"><p>Instance information as returned by getInstances.</p></td>
3682 </tr>
3683
3684
3685 </tbody>
3686</table>
3687
3688
3689
3690
3691
3692
3693<dl class="details">
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726</dl>
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740<h5>Returns:</h5>
3741
3742
3743<div class="param-desc">
3744 <p>A promise which will be resolved with instance info.</p>
3745</div>
3746
3747
3748
3749<dl>
3750 <dt>
3751 Type
3752 </dt>
3753 <dd>
3754
3755<span class="param-type">Promise</span>
3756
3757
3758 </dd>
3759</dl>
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773 <h4 class="name" id="putPrimaryCredentials"><span class="type-signature"></span>putPrimaryCredentials<span class="signature">()</span><span class="type-signature"> &rarr; {Promise}</span></h4>
3774
3775
3776
3777
3778
3779
3780<div class="description">
3781 <p>Called to store primary credentials</p>
3782<p>When joining a cluster we need the username and password for the
3783primary instance. This method is called to tell us that we are
3784the primary and we should store our credentials if we need to store
3785them for later retrieval in getPrimaryCredentials.</p>
3786</div>
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800<dl class="details">
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833</dl>
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847<h5>Returns:</h5>
3848
3849
3850<div class="param-desc">
3851 <p>A promise which will be resolved when the operation
3852 is complete</p>
3853</div>
3854
3855
3856
3857<dl>
3858 <dt>
3859 Type
3860 </dt>
3861 <dd>
3862
3863<span class="param-type">Promise</span>
3864
3865
3866 </dd>
3867</dl>
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881 <h4 class="name" id="putPublicKey"><span class="type-signature"></span>putPublicKey<span class="signature">(instanceId, publicKey)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
3882
3883
3884
3885
3886
3887
3888<div class="description">
3889 <p>Stores the public key for an instanceId.</p>
3890<p>The public key should later be able to retrieved given the instanceId.
3891Must be implemented if provider supports FEATURE_ENCRYPTION.</p>
3892</div>
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902 <h5>Parameters:</h5>
3903
3904
3905<table class="params">
3906 <thead>
3907 <tr>
3908
3909 <th>Name</th>
3910
3911
3912 <th>Type</th>
3913
3914
3915
3916
3917
3918 <th class="last">Description</th>
3919 </tr>
3920 </thead>
3921
3922 <tbody>
3923
3924
3925 <tr>
3926
3927 <td class="name"><code>instanceId</code></td>
3928
3929
3930 <td class="type">
3931
3932
3933<span class="param-type">String</span>
3934
3935
3936
3937 </td>
3938
3939
3940
3941
3942
3943 <td class="description last"><p>Instance ID to validate as a valid primary.</p></td>
3944 </tr>
3945
3946
3947
3948 <tr>
3949
3950 <td class="name"><code>publicKey</code></td>
3951
3952
3953 <td class="type">
3954
3955
3956<span class="param-type">String</span>
3957
3958
3959
3960 </td>
3961
3962
3963
3964
3965
3966 <td class="description last"><p>The public key</p></td>
3967 </tr>
3968
3969
3970 </tbody>
3971</table>
3972
3973
3974
3975
3976
3977
3978<dl class="details">
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011</dl>
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025<h5>Returns:</h5>
4026
4027
4028<div class="param-desc">
4029 <p>A promise which will be resolved when the operation
4030 is complete</p>
4031</div>
4032
4033
4034
4035<dl>
4036 <dt>
4037 Type
4038 </dt>
4039 <dd>
4040
4041<span class="param-type">Promise</span>
4042
4043
4044 </dd>
4045</dl>
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059 <h4 class="name" id="revokeLicenses"><span class="type-signature"></span>revokeLicenses<span class="signature">(instances, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
4060
4061
4062
4063
4064
4065
4066<div class="description">
4067 <p>Revokes licenses for instances licensed from BIG-IQ</p>
4068<p>We only make a best effort here. If revoke fails, this still succeeds. This allows
4069us not to care if the license even can be revoked (perhaps it is not issued by BIG-IQ).</p>
4070</div>
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080 <h5>Parameters:</h5>
4081
4082
4083<table class="params">
4084 <thead>
4085 <tr>
4086
4087 <th>Name</th>
4088
4089
4090 <th>Type</th>
4091
4092
4093 <th>Attributes</th>
4094
4095
4096
4097
4098 <th class="last">Description</th>
4099 </tr>
4100 </thead>
4101
4102 <tbody>
4103
4104
4105 <tr>
4106
4107 <td class="name"><code>instances</code></td>
4108
4109
4110 <td class="type">
4111
4112
4113<span class="param-type">Array.&lt;Object></span>
4114
4115
4116
4117 </td>
4118
4119
4120 <td class="attributes">
4121
4122
4123
4124
4125
4126 </td>
4127
4128
4129
4130
4131 <td class="description last"><p>Instances for which to revoke licenses. Instances
4132 should be as returned by getInstances</p></td>
4133 </tr>
4134
4135
4136
4137 <tr>
4138
4139 <td class="name"><code>options</code></td>
4140
4141
4142 <td class="type">
4143
4144
4145<span class="param-type">Object</span>
4146
4147
4148
4149 </td>
4150
4151
4152 <td class="attributes">
4153
4154 &lt;optional><br>
4155
4156
4157
4158
4159
4160 </td>
4161
4162
4163
4164
4165 <td class="description last"><p>Original command line options</p>
4166 <h6>Properties</h6>
4167
4168
4169<table class="params">
4170 <thead>
4171 <tr>
4172
4173 <th>Name</th>
4174
4175
4176 <th>Type</th>
4177
4178
4179 <th>Attributes</th>
4180
4181
4182
4183
4184 <th class="last">Description</th>
4185 </tr>
4186 </thead>
4187
4188 <tbody>
4189
4190
4191 <tr>
4192
4193 <td class="name"><code>bigIp</code></td>
4194
4195
4196 <td class="type">
4197
4198
4199<span class="param-type">Object</span>
4200
4201
4202
4203 </td>
4204
4205
4206 <td class="attributes">
4207
4208 &lt;optional><br>
4209
4210
4211
4212
4213
4214 </td>
4215
4216
4217
4218
4219 <td class="description last"><p>Base <a href="BigIp.html">BigIp</a> object.</p></td>
4220 </tr>
4221
4222
4223 </tbody>
4224</table>
4225
4226 </td>
4227 </tr>
4228
4229
4230 </tbody>
4231</table>
4232
4233
4234
4235
4236
4237
4238<dl class="details">
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271</dl>
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285<h5>Returns:</h5>
4286
4287
4288<div class="param-desc">
4289 <p>A promise which will be resolved when processing is complete.</p>
4290</div>
4291
4292
4293
4294<dl>
4295 <dt>
4296 Type
4297 </dt>
4298 <dd>
4299
4300<span class="param-type">Promise</span>
4301
4302
4303 </dd>
4304</dl>
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318 <h4 class="name" id="sendMessage"><span class="type-signature">(abstract) </span>sendMessage<span class="signature">(action, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
4319
4320
4321
4322
4323
4324
4325<div class="description">
4326 <p>Sends a message to other instances in the scale set</p>
4327<p>Must be implemented if FEATURE_MESSAGING is supported</p>
4328</div>
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338 <h5>Parameters:</h5>
4339
4340
4341<table class="params">
4342 <thead>
4343 <tr>
4344
4345 <th>Name</th>
4346
4347
4348 <th>Type</th>
4349
4350
4351 <th>Attributes</th>
4352
4353
4354
4355
4356 <th class="last">Description</th>
4357 </tr>
4358 </thead>
4359
4360 <tbody>
4361
4362
4363 <tr>
4364
4365 <td class="name"><code>action</code></td>
4366
4367
4368 <td class="type">
4369
4370
4371<span class="param-type">String</span>
4372
4373
4374
4375 </td>
4376
4377
4378 <td class="attributes">
4379
4380
4381
4382
4383
4384 </td>
4385
4386
4387
4388
4389 <td class="description last"><p>Action id of message to send</p></td>
4390 </tr>
4391
4392
4393
4394 <tr>
4395
4396 <td class="name"><code>options</code></td>
4397
4398
4399 <td class="type">
4400
4401
4402<span class="param-type">Object</span>
4403
4404
4405
4406 </td>
4407
4408
4409 <td class="attributes">
4410
4411 &lt;optional><br>
4412
4413
4414
4415
4416
4417 </td>
4418
4419
4420
4421
4422 <td class="description last"><p>Optional parameters</p>
4423 <h6>Properties</h6>
4424
4425
4426<table class="params">
4427 <thead>
4428 <tr>
4429
4430 <th>Name</th>
4431
4432
4433 <th>Type</th>
4434
4435
4436 <th>Attributes</th>
4437
4438
4439
4440
4441 <th class="last">Description</th>
4442 </tr>
4443 </thead>
4444
4445 <tbody>
4446
4447
4448 <tr>
4449
4450 <td class="name"><code>toInstanceId</code></td>
4451
4452
4453 <td class="type">
4454
4455
4456<span class="param-type">String</span>
4457
4458
4459
4460 </td>
4461
4462
4463 <td class="attributes">
4464
4465 &lt;optional><br>
4466
4467
4468
4469
4470
4471 </td>
4472
4473
4474
4475
4476 <td class="description last"><p>Instance ID that message is for</p></td>
4477 </tr>
4478
4479
4480
4481 <tr>
4482
4483 <td class="name"><code>fromInstanceId</code></td>
4484
4485
4486 <td class="type">
4487
4488
4489<span class="param-type">String</span>
4490
4491
4492
4493 </td>
4494
4495
4496 <td class="attributes">
4497
4498 &lt;optional><br>
4499
4500
4501
4502
4503
4504 </td>
4505
4506
4507
4508
4509 <td class="description last"><p>Instance ID that message is from</p></td>
4510 </tr>
4511
4512
4513
4514 <tr>
4515
4516 <td class="name"><code>data</code></td>
4517
4518
4519 <td class="type">
4520
4521
4522<span class="param-type">Object</span>
4523
4524
4525
4526 </td>
4527
4528
4529 <td class="attributes">
4530
4531 &lt;optional><br>
4532
4533
4534
4535
4536
4537 </td>
4538
4539
4540
4541
4542 <td class="description last"><p>Message specific data</p></td>
4543 </tr>
4544
4545
4546 </tbody>
4547</table>
4548
4549 </td>
4550 </tr>
4551
4552
4553 </tbody>
4554</table>
4555
4556
4557
4558
4559
4560
4561<dl class="details">
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594</dl>
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608<h5>Returns:</h5>
4609
4610
4611<div class="param-desc">
4612 <p>A promise which will be resolved when the message
4613 has been sent or rejected if an error occurs</p>
4614</div>
4615
4616
4617
4618<dl>
4619 <dt>
4620 Type
4621 </dt>
4622 <dd>
4623
4624<span class="param-type">Promise</span>
4625
4626
4627 </dd>
4628</dl>
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642 <h4 class="name" id="signalInstanceProvisioned"><span class="type-signature"></span>signalInstanceProvisioned<span class="signature">(instanceId)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
4643
4644
4645
4646
4647
4648
4649<div class="description">
4650 <p>Informs the provider that the instance has been provisioned</p>
4651</div>
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661 <h5>Parameters:</h5>
4662
4663
4664<table class="params">
4665 <thead>
4666 <tr>
4667
4668 <th>Name</th>
4669
4670
4671 <th>Type</th>
4672
4673
4674
4675
4676
4677 <th class="last">Description</th>
4678 </tr>
4679 </thead>
4680
4681 <tbody>
4682
4683
4684 <tr>
4685
4686 <td class="name"><code>instanceId</code></td>
4687
4688
4689 <td class="type">
4690
4691
4692<span class="param-type">String</span>
4693
4694
4695
4696 </td>
4697
4698
4699
4700
4701
4702 <td class="description last"><p>Instance ID of instance to mark as provisioned. If not provided,
4703 instanceId will be instanceId as set by init().</p></td>
4704 </tr>
4705
4706
4707 </tbody>
4708</table>
4709
4710
4711
4712
4713
4714
4715<dl class="details">
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748</dl>
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762<h5>Returns:</h5>
4763
4764
4765<div class="param-desc">
4766 <p>A promise which will be resolved when the instance has been signalled to the
4767 provider as provisioned</p>
4768</div>
4769
4770
4771
4772<dl>
4773 <dt>
4774 Type
4775 </dt>
4776 <dd>
4777
4778<span class="param-type">Promise</span>
4779
4780
4781 </dd>
4782</dl>
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796 <h4 class="name" id="storeUcs"><span class="type-signature"></span>storeUcs<span class="signature">(file, maxCopies, prefix)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
4797
4798
4799
4800
4801
4802
4803<div class="description">
4804 <p>Stores a UCS file in cloud storage</p>
4805</div>
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815 <h5>Parameters:</h5>
4816
4817
4818<table class="params">
4819 <thead>
4820 <tr>
4821
4822 <th>Name</th>
4823
4824
4825 <th>Type</th>
4826
4827
4828
4829
4830
4831 <th class="last">Description</th>
4832 </tr>
4833 </thead>
4834
4835 <tbody>
4836
4837
4838 <tr>
4839
4840 <td class="name"><code>file</code></td>
4841
4842
4843 <td class="type">
4844
4845
4846<span class="param-type">String</span>
4847
4848
4849
4850 </td>
4851
4852
4853
4854
4855
4856 <td class="description last"><p>Full path to file to store.</p></td>
4857 </tr>
4858
4859
4860
4861 <tr>
4862
4863 <td class="name"><code>maxCopies</code></td>
4864
4865
4866 <td class="type">
4867
4868
4869<span class="param-type">Number</span>
4870
4871
4872
4873 </td>
4874
4875
4876
4877
4878
4879 <td class="description last"><p>Number of files to store. Oldest files over
4880 this number should be deleted.</p></td>
4881 </tr>
4882
4883
4884
4885 <tr>
4886
4887 <td class="name"><code>prefix</code></td>
4888
4889
4890 <td class="type">
4891
4892
4893<span class="param-type">String</span>
4894
4895
4896
4897 </td>
4898
4899
4900
4901
4902
4903 <td class="description last"><p>The common prefix for autosaved UCS files</p></td>
4904 </tr>
4905
4906
4907 </tbody>
4908</table>
4909
4910
4911
4912
4913
4914
4915<dl class="details">
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948</dl>
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962<h5>Returns:</h5>
4963
4964
4965<div class="param-desc">
4966 <p>A promise which is resolved when processing is complete.</p>
4967</div>
4968
4969
4970
4971<dl>
4972 <dt>
4973 Type
4974 </dt>
4975 <dd>
4976
4977<span class="param-type">Promise</span>
4978
4979
4980 </dd>
4981</dl>
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995 <h4 class="name" id="syncComplete"><span class="type-signature"></span>syncComplete<span class="signature">(fromUser, fromPassword)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
4996
4997
4998
4999
5000
5001
5002<div class="description">
5003 <p>Informs the provider that a sync has completed in case the
5004password needs to be updated</p>
5005<p>When a sync is complete, the user and password will exist on
5006the synced to device.</p>
5007</div>
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017 <h5>Parameters:</h5>
5018
5019
5020<table class="params">
5021 <thead>
5022 <tr>
5023
5024 <th>Name</th>
5025
5026
5027 <th>Type</th>
5028
5029
5030
5031
5032
5033 <th class="last">Description</th>
5034 </tr>
5035 </thead>
5036
5037 <tbody>
5038
5039
5040 <tr>
5041
5042 <td class="name"><code>fromUser</code></td>
5043
5044
5045 <td class="type">
5046
5047
5048<span class="param-type">String</span>
5049
5050
5051
5052 </td>
5053
5054
5055
5056
5057
5058 <td class="description last"><p>User that was synced from</p></td>
5059 </tr>
5060
5061
5062
5063 <tr>
5064
5065 <td class="name"><code>fromPassword</code></td>
5066
5067
5068 <td class="type">
5069
5070
5071<span class="param-type">String</span>
5072
5073
5074
5075 </td>
5076
5077
5078
5079
5080
5081 <td class="description last"><p>Password that was synced from</p></td>
5082 </tr>
5083
5084
5085 </tbody>
5086</table>
5087
5088
5089
5090
5091
5092
5093<dl class="details">
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126</dl>
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140<h5>Returns:</h5>
5141
5142
5143<div class="param-desc">
5144 <p>A promise which will be resolved when the messages
5145 have been received and processed</p>
5146</div>
5147
5148
5149
5150<dl>
5151 <dt>
5152 Type
5153 </dt>
5154 <dd>
5155
5156<span class="param-type">Promise</span>
5157
5158
5159 </dd>
5160</dl>
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174 <h4 class="name" id="tagPrimaryInstance"><span class="type-signature"></span>tagPrimaryInstance<span class="signature">(instanceId, instances)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
5175
5176
5177
5178
5179
5180
5181<div class="description">
5182 <p>Called after a primary has been elected.</p>
5183<p>In some cloud environments, instances running a primary should be tagged through
5184cloud provider specific tagging. Override this method for cloud providers that support
5185instance tagging for instances running primarys.</p>
5186</div>
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196 <h5>Parameters:</h5>
5197
5198
5199<table class="params">
5200 <thead>
5201 <tr>
5202
5203 <th>Name</th>
5204
5205
5206 <th>Type</th>
5207
5208
5209
5210
5211
5212 <th class="last">Description</th>
5213 </tr>
5214 </thead>
5215
5216 <tbody>
5217
5218
5219 <tr>
5220
5221 <td class="name"><code>instanceId</code></td>
5222
5223
5224 <td class="type">
5225
5226
5227<span class="param-type">String</span>
5228
5229
5230
5231 </td>
5232
5233
5234
5235
5236
5237 <td class="description last"><p>Instance ID that was elected primary.</p></td>
5238 </tr>
5239
5240
5241
5242 <tr>
5243
5244 <td class="name"><code>instances</code></td>
5245
5246
5247 <td class="type">
5248
5249
5250<span class="param-type">Object</span>
5251
5252
5253
5254 </td>
5255
5256
5257
5258
5259
5260 <td class="description last"><p>Dictionary of instances as returned by getInstances</p></td>
5261 </tr>
5262
5263
5264 </tbody>
5265</table>
5266
5267
5268
5269
5270
5271
5272<dl class="details">
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305</dl>
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319<h5>Returns:</h5>
5320
5321
5322<div class="param-desc">
5323 <p>A promise which will be resolved when processing is complete.</p>
5324</div>
5325
5326
5327
5328<dl>
5329 <dt>
5330 Type
5331 </dt>
5332 <dd>
5333
5334<span class="param-type">Promise</span>
5335
5336
5337 </dd>
5338</dl>
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352</article>
5353
5354</section>
5355
5356
5357
5358
5359</div>
5360
5361<nav>
5362 <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>
5363</nav>
5364
5365<br class="clear">
5366
5367<footer>
5368 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
5369</footer>
5370
5371<script> prettyPrint(); </script>
5372<script src="scripts/linenumber.js"> </script>
5373</body>
5374</html>
\No newline at end of file