UNPKG

@f5devcentral/f5-cloud-libs/public/module-util.html

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