UNPKG

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