UNPKG

37.6 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Class: IControl</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: IControl</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2><span class="attribs"><span class="type-signature"></span></span>IControl<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
32
33
34</header>
35
36<article>
37 <div class="container-overview">
38
39
40
41
42
43
44 <h4 class="name" id="IControl"><span class="type-signature"></span>new IControl<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
45
46
47
48
49
50
51<div class="description">
52 <p>Creates an IControl object</p>
53</div>
54
55
56
57
58
59
60
61
62
63 <h5>Parameters:</h5>
64
65
66<table class="params">
67 <thead>
68 <tr>
69
70 <th>Name</th>
71
72
73 <th>Type</th>
74
75
76 <th>Attributes</th>
77
78
79
80
81 <th class="last">Description</th>
82 </tr>
83 </thead>
84
85 <tbody>
86
87
88 <tr>
89
90 <td class="name"><code>options</code></td>
91
92
93 <td class="type">
94
95
96<span class="param-type">Object</span>
97
98
99
100 </td>
101
102
103 <td class="attributes">
104
105 &lt;optional><br>
106
107
108
109
110
111 </td>
112
113
114
115
116 <td class="description last"><p>Options for the creation.</p>
117 <h6>Properties</h6>
118
119
120<table class="params">
121 <thead>
122 <tr>
123
124 <th>Name</th>
125
126
127 <th>Type</th>
128
129
130 <th>Attributes</th>
131
132
133
134
135 <th class="last">Description</th>
136 </tr>
137 </thead>
138
139 <tbody>
140
141
142 <tr>
143
144 <td class="name"><code>host</code></td>
145
146
147 <td class="type">
148
149
150<span class="param-type">String</span>
151
152
153
154 </td>
155
156
157 <td class="attributes">
158
159 &lt;optional><br>
160
161
162
163
164
165 </td>
166
167
168
169
170 <td class="description last"><p>IP Address to connect to. Default 127.0.0.1</p></td>
171 </tr>
172
173
174
175 <tr>
176
177 <td class="name"><code>port</code></td>
178
179
180 <td class="type">
181
182
183<span class="param-type">Number</span>
184
185
186
187 </td>
188
189
190 <td class="attributes">
191
192 &lt;optional><br>
193
194
195
196
197
198 </td>
199
200
201
202
203 <td class="description last"><p>Port to use. Default 443.</p></td>
204 </tr>
205
206
207
208 <tr>
209
210 <td class="name"><code>user</code></td>
211
212
213 <td class="type">
214
215
216<span class="param-type">String</span>
217
218
219
220 </td>
221
222
223 <td class="attributes">
224
225 &lt;optional><br>
226
227
228
229
230
231 </td>
232
233
234
235
236 <td class="description last"><p>User to use for auth. Default admin.</p></td>
237 </tr>
238
239
240
241 <tr>
242
243 <td class="name"><code>password</code></td>
244
245
246 <td class="type">
247
248
249<span class="param-type">String</span>
250
251
252
253 </td>
254
255
256 <td class="attributes">
257
258 &lt;optional><br>
259
260
261
262
263
264 </td>
265
266
267
268
269 <td class="description last"><p>Password to use for auth. Default admin.</p></td>
270 </tr>
271
272
273
274 <tr>
275
276 <td class="name"><code>authToken</code></td>
277
278
279 <td class="type">
280
281
282<span class="param-type">String</span>
283
284
285
286 </td>
287
288
289 <td class="attributes">
290
291 &lt;optional><br>
292
293
294
295
296
297 </td>
298
299
300
301
302 <td class="description last"><p>Auth token to use rather than user and password.</p></td>
303 </tr>
304
305
306
307 <tr>
308
309 <td class="name"><code>basePath</code></td>
310
311
312 <td class="type">
313
314
315<span class="param-type">String</span>
316
317
318
319 </td>
320
321
322 <td class="attributes">
323
324 &lt;optional><br>
325
326
327
328
329
330 </td>
331
332
333
334
335 <td class="description last"><p>Base path to prepend to paths for all requests. Default /mgmt</p></td>
336 </tr>
337
338
339
340 <tr>
341
342 <td class="name"><code>strict</code></td>
343
344
345 <td class="type">
346
347
348<span class="param-type">Boolean</span>
349
350
351
352 </td>
353
354
355 <td class="attributes">
356
357 &lt;optional><br>
358
359
360
361
362
363 </td>
364
365
366
367
368 <td class="description last"><p>Whether or not to validate SSL certificates.</p></td>
369 </tr>
370
371
372
373 <tr>
374
375 <td class="name"><code>logger</code></td>
376
377
378 <td class="type">
379
380
381<span class="param-type">Object</span>
382
383
384
385 </td>
386
387
388 <td class="attributes">
389
390 &lt;optional><br>
391
392
393
394
395
396 </td>
397
398
399
400
401 <td class="description last"><p>Logger to use. Or, pass loggerOptions to get your own logger.</p></td>
402 </tr>
403
404
405
406 <tr>
407
408 <td class="name"><code>loggerOptions</code></td>
409
410
411 <td class="type">
412
413
414<span class="param-type">Object</span>
415
416
417
418 </td>
419
420
421 <td class="attributes">
422
423 &lt;optional><br>
424
425
426
427
428
429 </td>
430
431
432
433
434 <td class="description last"><p>Options for the logger.
435 See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
436 </tr>
437
438
439 </tbody>
440</table>
441
442 </td>
443 </tr>
444
445
446 </tbody>
447</table>
448
449
450
451
452
453
454<dl class="details">
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
481
482
483
484
485
486
487</dl>
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507 </div>
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524 <h3 class="subsection-title">Methods</h3>
525
526
527
528
529
530
531
532 <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(path, body<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
533
534
535
536
537
538
539<div class="description">
540 <p>Executes a create (POST) request</p>
541</div>
542
543
544
545
546
547
548
549
550
551 <h5>Parameters:</h5>
552
553
554<table class="params">
555 <thead>
556 <tr>
557
558 <th>Name</th>
559
560
561 <th>Type</th>
562
563
564 <th>Attributes</th>
565
566
567
568
569 <th class="last">Description</th>
570 </tr>
571 </thead>
572
573 <tbody>
574
575
576 <tr>
577
578 <td class="name"><code>path</code></td>
579
580
581 <td class="type">
582
583
584<span class="param-type">String</span>
585
586
587
588 </td>
589
590
591 <td class="attributes">
592
593
594
595
596
597 </td>
598
599
600
601
602 <td class="description last"><p>Path for the request.</p></td>
603 </tr>
604
605
606
607 <tr>
608
609 <td class="name"><code>body</code></td>
610
611
612 <td class="type">
613
614
615<span class="param-type">Object</span>
616
617
618
619 </td>
620
621
622 <td class="attributes">
623
624 &lt;optional><br>
625
626
627
628
629
630 </td>
631
632
633
634
635 <td class="description last"><p>Body of the request.</p></td>
636 </tr>
637
638
639
640 <tr>
641
642 <td class="name"><code>options</code></td>
643
644
645 <td class="type">
646
647
648<span class="param-type">Object</span>
649
650
651
652 </td>
653
654
655 <td class="attributes">
656
657 &lt;optional><br>
658
659
660
661
662
663 </td>
664
665
666
667
668 <td class="description last"><p>Options for the request.</p>
669 <h6>Properties</h6>
670
671
672<table class="params">
673 <thead>
674 <tr>
675
676 <th>Name</th>
677
678
679 <th>Type</th>
680
681
682 <th>Attributes</th>
683
684
685
686
687 <th class="last">Description</th>
688 </tr>
689 </thead>
690
691 <tbody>
692
693
694 <tr>
695
696 <td class="name"><code>noWait</code></td>
697
698
699 <td class="type">
700
701
702<span class="param-type">Boolean</span>
703
704
705
706 </td>
707
708
709 <td class="attributes">
710
711 &lt;optional><br>
712
713
714
715
716
717 </td>
718
719
720
721
722 <td class="description last"><p>Don't wait for a response. Default false (wait for a response).</p></td>
723 </tr>
724
725
726
727 <tr>
728
729 <td class="name"><code>headers</code></td>
730
731
732 <td class="type">
733
734
735<span class="param-type">Object</span>
736
737
738
739 </td>
740
741
742 <td class="attributes">
743
744 &lt;optional><br>
745
746
747
748
749
750 </td>
751
752
753
754
755 <td class="description last"><p>Headers to use in the request. Default
756 {
757 'Content-Type': 'application/json'
758 }</p></td>
759 </tr>
760
761
762 </tbody>
763</table>
764
765 </td>
766 </tr>
767
768
769 </tbody>
770</table>
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 is resolved with the results of the request
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="delete"><span class="type-signature"></span>delete<span class="signature">(path, body<span class="signature-attributes">opt</span>, 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>Executes a delete (DELETE) request</p>
867</div>
868
869
870
871
872
873
874
875
876
877 <h5>Parameters:</h5>
878
879
880<table class="params">
881 <thead>
882 <tr>
883
884 <th>Name</th>
885
886
887 <th>Type</th>
888
889
890 <th>Attributes</th>
891
892
893
894
895 <th class="last">Description</th>
896 </tr>
897 </thead>
898
899 <tbody>
900
901
902 <tr>
903
904 <td class="name"><code>path</code></td>
905
906
907 <td class="type">
908
909
910<span class="param-type">String</span>
911
912
913
914 </td>
915
916
917 <td class="attributes">
918
919
920
921
922
923 </td>
924
925
926
927
928 <td class="description last"><p>Path for the request.</p></td>
929 </tr>
930
931
932
933 <tr>
934
935 <td class="name"><code>body</code></td>
936
937
938 <td class="type">
939
940
941<span class="param-type">Object</span>
942
943
944
945 </td>
946
947
948 <td class="attributes">
949
950 &lt;optional><br>
951
952
953
954
955
956 </td>
957
958
959
960
961 <td class="description last"><p>Body of the request.</p></td>
962 </tr>
963
964
965
966 <tr>
967
968 <td class="name"><code>options</code></td>
969
970
971 <td class="type">
972
973
974<span class="param-type">Object</span>
975
976
977
978 </td>
979
980
981 <td class="attributes">
982
983 &lt;optional><br>
984
985
986
987
988
989 </td>
990
991
992
993
994 <td class="description last"><p>Options for the request.</p>
995 <h6>Properties</h6>
996
997
998<table class="params">
999 <thead>
1000 <tr>
1001
1002 <th>Name</th>
1003
1004
1005 <th>Type</th>
1006
1007
1008 <th>Attributes</th>
1009
1010
1011
1012
1013 <th class="last">Description</th>
1014 </tr>
1015 </thead>
1016
1017 <tbody>
1018
1019
1020 <tr>
1021
1022 <td class="name"><code>noWait</code></td>
1023
1024
1025 <td class="type">
1026
1027
1028<span class="param-type">Boolean</span>
1029
1030
1031
1032 </td>
1033
1034
1035 <td class="attributes">
1036
1037 &lt;optional><br>
1038
1039
1040
1041
1042
1043 </td>
1044
1045
1046
1047
1048 <td class="description last"><p>Don't wait for a response. Default false (wait for a response).</p></td>
1049 </tr>
1050
1051
1052
1053 <tr>
1054
1055 <td class="name"><code>headers</code></td>
1056
1057
1058 <td class="type">
1059
1060
1061<span class="param-type">Object</span>
1062
1063
1064
1065 </td>
1066
1067
1068 <td class="attributes">
1069
1070 &lt;optional><br>
1071
1072
1073
1074
1075
1076 </td>
1077
1078
1079
1080
1081 <td class="description last"><p>Headers to use in the request. Default
1082 {
1083 'Content-Type': 'application/json'
1084 }</p></td>
1085 </tr>
1086
1087
1088 </tbody>
1089</table>
1090
1091 </td>
1092 </tr>
1093
1094
1095 </tbody>
1096</table>
1097
1098
1099
1100
1101
1102
1103<dl class="details">
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136</dl>
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150<h5>Returns:</h5>
1151
1152
1153<div class="param-desc">
1154 <p>A promise which is resolved with the results of the request
1155 or rejected if an error occurs. If the response is JSON that
1156 has 'items' in it, only the items are returned.</p>
1157</div>
1158
1159
1160
1161<dl>
1162 <dt>
1163 Type
1164 </dt>
1165 <dd>
1166
1167<span class="param-type">Promise</span>
1168
1169
1170 </dd>
1171</dl>
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185 <h4 class="name" id="list"><span class="type-signature"></span>list<span class="signature">(path, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1186
1187
1188
1189
1190
1191
1192<div class="description">
1193 <p>Executes a list (GET) request</p>
1194</div>
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204 <h5>Parameters:</h5>
1205
1206
1207<table class="params">
1208 <thead>
1209 <tr>
1210
1211 <th>Name</th>
1212
1213
1214 <th>Type</th>
1215
1216
1217 <th>Attributes</th>
1218
1219
1220
1221
1222 <th class="last">Description</th>
1223 </tr>
1224 </thead>
1225
1226 <tbody>
1227
1228
1229 <tr>
1230
1231 <td class="name"><code>path</code></td>
1232
1233
1234 <td class="type">
1235
1236
1237<span class="param-type">String</span>
1238
1239
1240
1241 </td>
1242
1243
1244 <td class="attributes">
1245
1246
1247
1248
1249
1250 </td>
1251
1252
1253
1254
1255 <td class="description last"><p>Path for the request.</p></td>
1256 </tr>
1257
1258
1259
1260 <tr>
1261
1262 <td class="name"><code>options</code></td>
1263
1264
1265 <td class="type">
1266
1267
1268<span class="param-type">Object</span>
1269
1270
1271
1272 </td>
1273
1274
1275 <td class="attributes">
1276
1277 &lt;optional><br>
1278
1279
1280
1281
1282
1283 </td>
1284
1285
1286
1287
1288 <td class="description last"><p>Options for the request.</p>
1289 <h6>Properties</h6>
1290
1291
1292<table class="params">
1293 <thead>
1294 <tr>
1295
1296 <th>Name</th>
1297
1298
1299 <th>Type</th>
1300
1301
1302 <th>Attributes</th>
1303
1304
1305
1306
1307 <th class="last">Description</th>
1308 </tr>
1309 </thead>
1310
1311 <tbody>
1312
1313
1314 <tr>
1315
1316 <td class="name"><code>noWait</code></td>
1317
1318
1319 <td class="type">
1320
1321
1322<span class="param-type">Boolean</span>
1323
1324
1325
1326 </td>
1327
1328
1329 <td class="attributes">
1330
1331 &lt;optional><br>
1332
1333
1334
1335
1336
1337 </td>
1338
1339
1340
1341
1342 <td class="description last"><p>Don't wait for a response. Default false (wait for a response).</p></td>
1343 </tr>
1344
1345
1346
1347 <tr>
1348
1349 <td class="name"><code>headers</code></td>
1350
1351
1352 <td class="type">
1353
1354
1355<span class="param-type">Object</span>
1356
1357
1358
1359 </td>
1360
1361
1362 <td class="attributes">
1363
1364 &lt;optional><br>
1365
1366
1367
1368
1369
1370 </td>
1371
1372
1373
1374
1375 <td class="description last"><p>Headers to use in the request. Default
1376 {
1377 'Content-Type': 'application/json'
1378 }</p></td>
1379 </tr>
1380
1381
1382 </tbody>
1383</table>
1384
1385 </td>
1386 </tr>
1387
1388
1389 </tbody>
1390</table>
1391
1392
1393
1394
1395
1396
1397<dl class="details">
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430</dl>
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444<h5>Returns:</h5>
1445
1446
1447<div class="param-desc">
1448 <p>A promise which is resolved with the results of the request
1449 or rejected if an error occurs. If the response is JSON that
1450 has 'items' in it, only the items are returned.</p>
1451</div>
1452
1453
1454
1455<dl>
1456 <dt>
1457 Type
1458 </dt>
1459 <dd>
1460
1461<span class="param-type">Promise</span>
1462
1463
1464 </dd>
1465</dl>
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479 <h4 class="name" id="modify"><span class="type-signature"></span>modify<span class="signature">(path, body<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1480
1481
1482
1483
1484
1485
1486<div class="description">
1487 <p>Executes a modify (PATCH) request</p>
1488</div>
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498 <h5>Parameters:</h5>
1499
1500
1501<table class="params">
1502 <thead>
1503 <tr>
1504
1505 <th>Name</th>
1506
1507
1508 <th>Type</th>
1509
1510
1511 <th>Attributes</th>
1512
1513
1514
1515
1516 <th class="last">Description</th>
1517 </tr>
1518 </thead>
1519
1520 <tbody>
1521
1522
1523 <tr>
1524
1525 <td class="name"><code>path</code></td>
1526
1527
1528 <td class="type">
1529
1530
1531<span class="param-type">String</span>
1532
1533
1534
1535 </td>
1536
1537
1538 <td class="attributes">
1539
1540
1541
1542
1543
1544 </td>
1545
1546
1547
1548
1549 <td class="description last"><p>Path for the request.</p></td>
1550 </tr>
1551
1552
1553
1554 <tr>
1555
1556 <td class="name"><code>body</code></td>
1557
1558
1559 <td class="type">
1560
1561
1562<span class="param-type">Object</span>
1563
1564
1565
1566 </td>
1567
1568
1569 <td class="attributes">
1570
1571 &lt;optional><br>
1572
1573
1574
1575
1576
1577 </td>
1578
1579
1580
1581
1582 <td class="description last"><p>Body of the request.</p></td>
1583 </tr>
1584
1585
1586
1587 <tr>
1588
1589 <td class="name"><code>options</code></td>
1590
1591
1592 <td class="type">
1593
1594
1595<span class="param-type">Object</span>
1596
1597
1598
1599 </td>
1600
1601
1602 <td class="attributes">
1603
1604 &lt;optional><br>
1605
1606
1607
1608
1609
1610 </td>
1611
1612
1613
1614
1615 <td class="description last"><p>Options for the request.</p>
1616 <h6>Properties</h6>
1617
1618
1619<table class="params">
1620 <thead>
1621 <tr>
1622
1623 <th>Name</th>
1624
1625
1626 <th>Type</th>
1627
1628
1629 <th>Attributes</th>
1630
1631
1632
1633
1634 <th class="last">Description</th>
1635 </tr>
1636 </thead>
1637
1638 <tbody>
1639
1640
1641 <tr>
1642
1643 <td class="name"><code>noWait</code></td>
1644
1645
1646 <td class="type">
1647
1648
1649<span class="param-type">Boolean</span>
1650
1651
1652
1653 </td>
1654
1655
1656 <td class="attributes">
1657
1658 &lt;optional><br>
1659
1660
1661
1662
1663
1664 </td>
1665
1666
1667
1668
1669 <td class="description last"><p>Don't wait for a response. Default false (wait for a response).</p></td>
1670 </tr>
1671
1672
1673
1674 <tr>
1675
1676 <td class="name"><code>headers</code></td>
1677
1678
1679 <td class="type">
1680
1681
1682<span class="param-type">Object</span>
1683
1684
1685
1686 </td>
1687
1688
1689 <td class="attributes">
1690
1691 &lt;optional><br>
1692
1693
1694
1695
1696
1697 </td>
1698
1699
1700
1701
1702 <td class="description last"><p>Headers to use in the request. Default
1703 {
1704 'Content-Type': 'application/json'
1705 }</p></td>
1706 </tr>
1707
1708
1709 </tbody>
1710</table>
1711
1712 </td>
1713 </tr>
1714
1715
1716 </tbody>
1717</table>
1718
1719
1720
1721
1722
1723
1724<dl class="details">
1725
1726
1727
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
1753
1754
1755
1756
1757</dl>
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771<h5>Returns:</h5>
1772
1773
1774<div class="param-desc">
1775 <p>A promise which is resolved with the results of the request
1776 or rejected if an error occurs.</p>
1777</div>
1778
1779
1780
1781<dl>
1782 <dt>
1783 Type
1784 </dt>
1785 <dd>
1786
1787<span class="param-type">Promise</span>
1788
1789
1790 </dd>
1791</dl>
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805 <h4 class="name" id="replace"><span class="type-signature"></span>replace<span class="signature">(path, body<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
1806
1807
1808
1809
1810
1811
1812<div class="description">
1813 <p>Executes a replace (PUT) request</p>
1814</div>
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824 <h5>Parameters:</h5>
1825
1826
1827<table class="params">
1828 <thead>
1829 <tr>
1830
1831 <th>Name</th>
1832
1833
1834 <th>Type</th>
1835
1836
1837 <th>Attributes</th>
1838
1839
1840
1841
1842 <th class="last">Description</th>
1843 </tr>
1844 </thead>
1845
1846 <tbody>
1847
1848
1849 <tr>
1850
1851 <td class="name"><code>path</code></td>
1852
1853
1854 <td class="type">
1855
1856
1857<span class="param-type">String</span>
1858
1859
1860
1861 </td>
1862
1863
1864 <td class="attributes">
1865
1866
1867
1868
1869
1870 </td>
1871
1872
1873
1874
1875 <td class="description last"><p>Path for the request.</p></td>
1876 </tr>
1877
1878
1879
1880 <tr>
1881
1882 <td class="name"><code>body</code></td>
1883
1884
1885 <td class="type">
1886
1887
1888<span class="param-type">Object</span>
1889
1890
1891
1892 </td>
1893
1894
1895 <td class="attributes">
1896
1897 &lt;optional><br>
1898
1899
1900
1901
1902
1903 </td>
1904
1905
1906
1907
1908 <td class="description last"><p>Body of the request.</p></td>
1909 </tr>
1910
1911
1912
1913 <tr>
1914
1915 <td class="name"><code>options</code></td>
1916
1917
1918 <td class="type">
1919
1920
1921<span class="param-type">Object</span>
1922
1923
1924
1925 </td>
1926
1927
1928 <td class="attributes">
1929
1930 &lt;optional><br>
1931
1932
1933
1934
1935
1936 </td>
1937
1938
1939
1940
1941 <td class="description last"><p>Options for the request.</p>
1942 <h6>Properties</h6>
1943
1944
1945<table class="params">
1946 <thead>
1947 <tr>
1948
1949 <th>Name</th>
1950
1951
1952 <th>Type</th>
1953
1954
1955 <th>Attributes</th>
1956
1957
1958
1959
1960 <th class="last">Description</th>
1961 </tr>
1962 </thead>
1963
1964 <tbody>
1965
1966
1967 <tr>
1968
1969 <td class="name"><code>noWait</code></td>
1970
1971
1972 <td class="type">
1973
1974
1975<span class="param-type">Boolean</span>
1976
1977
1978
1979 </td>
1980
1981
1982 <td class="attributes">
1983
1984 &lt;optional><br>
1985
1986
1987
1988
1989
1990 </td>
1991
1992
1993
1994
1995 <td class="description last"><p>Don't wait for a response. Default false (wait for a response).</p></td>
1996 </tr>
1997
1998
1999
2000 <tr>
2001
2002 <td class="name"><code>headers</code></td>
2003
2004
2005 <td class="type">
2006
2007
2008<span class="param-type">Object</span>
2009
2010
2011
2012 </td>
2013
2014
2015 <td class="attributes">
2016
2017 &lt;optional><br>
2018
2019
2020
2021
2022
2023 </td>
2024
2025
2026
2027
2028 <td class="description last"><p>Headers to use in the request. Default
2029 {
2030 'Content-Type': 'application/json'
2031 }</p></td>
2032 </tr>
2033
2034
2035 </tbody>
2036</table>
2037
2038 </td>
2039 </tr>
2040
2041
2042 </tbody>
2043</table>
2044
2045
2046
2047
2048
2049
2050<dl class="details">
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083</dl>
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097<h5>Returns:</h5>
2098
2099
2100<div class="param-desc">
2101 <p>A promise which is resolved with the results of the request
2102 or rejected if an error occurs.</p>
2103</div>
2104
2105
2106
2107<dl>
2108 <dt>
2109 Type
2110 </dt>
2111 <dd>
2112
2113<span class="param-type">Promise</span>
2114
2115
2116 </dd>
2117</dl>
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131 <h4 class="name" id="request"><span class="type-signature"></span>request<span class="signature">(method, path, body<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>, existingDeferred<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
2132
2133
2134
2135
2136
2137
2138<div class="description">
2139 <p>Executes a request</p>
2140</div>
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150 <h5>Parameters:</h5>
2151
2152
2153<table class="params">
2154 <thead>
2155 <tr>
2156
2157 <th>Name</th>
2158
2159
2160 <th>Type</th>
2161
2162
2163 <th>Attributes</th>
2164
2165
2166
2167
2168 <th class="last">Description</th>
2169 </tr>
2170 </thead>
2171
2172 <tbody>
2173
2174
2175 <tr>
2176
2177 <td class="name"><code>method</code></td>
2178
2179
2180 <td class="type">
2181
2182
2183<span class="param-type">String</span>
2184
2185
2186
2187 </td>
2188
2189
2190 <td class="attributes">
2191
2192
2193
2194
2195
2196 </td>
2197
2198
2199
2200
2201 <td class="description last"><p>HTTP method for the request.</p></td>
2202 </tr>
2203
2204
2205
2206 <tr>
2207
2208 <td class="name"><code>path</code></td>
2209
2210
2211 <td class="type">
2212
2213
2214<span class="param-type">String</span>
2215
2216
2217
2218 </td>
2219
2220
2221 <td class="attributes">
2222
2223
2224
2225
2226
2227 </td>
2228
2229
2230
2231
2232 <td class="description last"><p>Path for the request.</p></td>
2233 </tr>
2234
2235
2236
2237 <tr>
2238
2239 <td class="name"><code>body</code></td>
2240
2241
2242 <td class="type">
2243
2244
2245<span class="param-type">Object</span>
2246
2247
2248
2249 </td>
2250
2251
2252 <td class="attributes">
2253
2254 &lt;optional><br>
2255
2256
2257
2258
2259
2260 </td>
2261
2262
2263
2264
2265 <td class="description last"><p>Body of the request.</p></td>
2266 </tr>
2267
2268
2269
2270 <tr>
2271
2272 <td class="name"><code>options</code></td>
2273
2274
2275 <td class="type">
2276
2277
2278<span class="param-type">Object</span>
2279
2280
2281
2282 </td>
2283
2284
2285 <td class="attributes">
2286
2287 &lt;optional><br>
2288
2289
2290
2291
2292
2293 </td>
2294
2295
2296
2297
2298 <td class="description last"><p>Options for the request.</p>
2299 <h6>Properties</h6>
2300
2301
2302<table class="params">
2303 <thead>
2304 <tr>
2305
2306 <th>Name</th>
2307
2308
2309 <th>Type</th>
2310
2311
2312 <th>Attributes</th>
2313
2314
2315
2316
2317 <th class="last">Description</th>
2318 </tr>
2319 </thead>
2320
2321 <tbody>
2322
2323
2324 <tr>
2325
2326 <td class="name"><code>noWait</code></td>
2327
2328
2329 <td class="type">
2330
2331
2332<span class="param-type">Boolean</span>
2333
2334
2335
2336 </td>
2337
2338
2339 <td class="attributes">
2340
2341 &lt;optional><br>
2342
2343
2344
2345
2346
2347 </td>
2348
2349
2350
2351
2352 <td class="description last"><p>Don't wait for a response. Default false (wait for a response).</p></td>
2353 </tr>
2354
2355
2356
2357 <tr>
2358
2359 <td class="name"><code>headers</code></td>
2360
2361
2362 <td class="type">
2363
2364
2365<span class="param-type">Object</span>
2366
2367
2368
2369 </td>
2370
2371
2372 <td class="attributes">
2373
2374 &lt;optional><br>
2375
2376
2377
2378
2379
2380 </td>
2381
2382
2383
2384
2385 <td class="description last"><p>Headers to use in the request.</p>
2386<pre class="prettyprint source"><code>{
2387 'Content-Type': 'application/json'
2388}</code></pre></td>
2389 </tr>
2390
2391
2392 </tbody>
2393</table>
2394
2395 </td>
2396 </tr>
2397
2398
2399
2400 <tr>
2401
2402 <td class="name"><code>existingDeferred</code></td>
2403
2404
2405 <td class="type">
2406
2407
2408<span class="param-type">Object</span>
2409
2410
2411
2412 </td>
2413
2414
2415 <td class="attributes">
2416
2417 &lt;optional><br>
2418
2419
2420
2421
2422
2423 </td>
2424
2425
2426
2427
2428 <td class="description last"><p>An existing deferred to use instead of creating a new one. Used
2429 for recursion (for retrying the request).</p></td>
2430 </tr>
2431
2432
2433
2434 <tr>
2435
2436 <td class="name"><code>options.noRefresh</code></td>
2437
2438
2439 <td class="type">
2440
2441
2442<span class="param-type">Boolean</span>
2443
2444
2445
2446 </td>
2447
2448
2449 <td class="attributes">
2450
2451 &lt;optional><br>
2452
2453
2454
2455
2456
2457 </td>
2458
2459
2460
2461
2462 <td class="description last"><p>Do not try to refresh the auth token if the request gets a 401</p></td>
2463 </tr>
2464
2465
2466 </tbody>
2467</table>
2468
2469
2470
2471
2472
2473
2474<dl class="details">
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
2505
2506
2507</dl>
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521<h5>Returns:</h5>
2522
2523
2524<div class="param-desc">
2525 <p>A promise which is resolved with the results of the request
2526 or rejected if an error occurs.</p>
2527</div>
2528
2529
2530
2531<dl>
2532 <dt>
2533 Type
2534 </dt>
2535 <dd>
2536
2537<span class="param-type">Promise</span>
2538
2539
2540 </dd>
2541</dl>
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555</article>
2556
2557</section>
2558
2559
2560
2561
2562</div>
2563
2564<nav>
2565 <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>
2566</nav>
2567
2568<br class="clear">
2569
2570<footer>
2571 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
2572</footer>
2573
2574<script> prettyPrint(); </script>
2575<script src="scripts/linenumber.js"> </script>
2576</body>
2577</html>
\No newline at end of file