UNPKG

10.2 kBHTMLView Raw
1<!DOCTYPE html>
2<html lang="en">
3<head>
4 <meta charset="utf-8">
5 <title>JSDoc: Class: DnsProvider</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: DnsProvider</h1>
21
22
23
24
25
26
27<section>
28
29<header>
30
31 <h2><span class="attribs"><span class="type-signature"></span></span>DnsProvider<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
32
33 <div class="class-description"><p>Abstract DNS provider implementation.</p>
34<p>This class should be inherited from to implement DNS
35specific implementations. Any method in this class that throws
36must be overridded. Methods that do not throw may be optionally
37overridden.</p></div>
38
39
40</header>
41
42<article>
43 <div class="container-overview">
44
45
46
47
48 <h2>Constructor</h2>
49
50
51
52 <h4 class="name" id="DnsProvider"><span class="type-signature"></span>new DnsProvider<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
53
54
55
56
57
58
59<div class="description">
60 <p>Constructor.</p>
61</div>
62
63
64
65
66
67
68
69
70
71 <h5>Parameters:</h5>
72
73
74<table class="params">
75 <thead>
76 <tr>
77
78 <th>Name</th>
79
80
81 <th>Type</th>
82
83
84 <th>Attributes</th>
85
86
87
88
89 <th class="last">Description</th>
90 </tr>
91 </thead>
92
93 <tbody>
94
95
96 <tr>
97
98 <td class="name"><code>options</code></td>
99
100
101 <td class="type">
102
103
104<span class="param-type">Ojbect</span>
105
106
107
108 </td>
109
110
111 <td class="attributes">
112
113 &lt;optional><br>
114
115
116
117
118
119 </td>
120
121
122
123
124 <td class="description last"><p>Options for the instance.</p>
125 <h6>Properties</h6>
126
127
128<table class="params">
129 <thead>
130 <tr>
131
132 <th>Name</th>
133
134
135 <th>Type</th>
136
137
138 <th>Attributes</th>
139
140
141
142
143 <th class="last">Description</th>
144 </tr>
145 </thead>
146
147 <tbody>
148
149
150 <tr>
151
152 <td class="name"><code>clOptions</code></td>
153
154
155 <td class="type">
156
157
158<span class="param-type">Object</span>
159
160
161
162 </td>
163
164
165 <td class="attributes">
166
167 &lt;optional><br>
168
169
170
171
172
173 </td>
174
175
176
177
178 <td class="description last"><p>Command line options if called from a script.</p></td>
179 </tr>
180
181
182
183 <tr>
184
185 <td class="name"><code>logger</code></td>
186
187
188 <td class="type">
189
190
191<span class="param-type">Object</span>
192
193
194
195 </td>
196
197
198 <td class="attributes">
199
200 &lt;optional><br>
201
202
203
204
205
206 </td>
207
208
209
210
211 <td class="description last"><p>Logger to use. Or, pass loggerOptions to get your own logger.</p></td>
212 </tr>
213
214
215
216 <tr>
217
218 <td class="name"><code>loggerOptions</code></td>
219
220
221 <td class="type">
222
223
224<span class="param-type">Object</span>
225
226
227
228 </td>
229
230
231 <td class="attributes">
232
233 &lt;optional><br>
234
235
236
237
238
239 </td>
240
241
242
243
244 <td class="description last"><p>Options for the logger.
245 See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
246 </tr>
247
248
249 </tbody>
250</table>
251
252 </td>
253 </tr>
254
255
256 </tbody>
257</table>
258
259
260
261
262
263
264<dl class="details">
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297</dl>
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317 </div>
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334 <h3 class="subsection-title">Methods</h3>
335
336
337
338
339
340
341
342 <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(providerOptions)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
343
344
345
346
347
348
349<div class="description">
350 <p>Initialize class</p>
351<p>Override for implementation specific initialization needs (read info
352from cloud provider, read database, etc.). Called at the start of
353processing.</p>
354</div>
355
356
357
358
359
360
361
362
363
364 <h5>Parameters:</h5>
365
366
367<table class="params">
368 <thead>
369 <tr>
370
371 <th>Name</th>
372
373
374 <th>Type</th>
375
376
377
378
379
380 <th class="last">Description</th>
381 </tr>
382 </thead>
383
384 <tbody>
385
386
387 <tr>
388
389 <td class="name"><code>providerOptions</code></td>
390
391
392 <td class="type">
393
394
395<span class="param-type">Object</span>
396
397
398
399 </td>
400
401
402
403
404
405 <td class="description last"><p>Provider specific options.</p></td>
406 </tr>
407
408
409 </tbody>
410</table>
411
412
413
414
415
416
417<dl class="details">
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450</dl>
451
452
453
454
455
456
457
458
459
460
461
462
463
464<h5>Returns:</h5>
465
466
467<div class="param-desc">
468 <p>A promise which will be resolved when init is complete.</p>
469</div>
470
471
472
473<dl>
474 <dt>
475 Type
476 </dt>
477 <dd>
478
479<span class="param-type">Promise</span>
480
481
482 </dd>
483</dl>
484
485
486
487
488
489
490
491
492
493
494
495
496
497 <h4 class="name" id="update"><span class="type-signature">(abstract) </span>update<span class="signature">(instances)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
498
499
500
501
502
503
504<div class="description">
505 <p>Updates DNS records with the given instances</p>
506</div>
507
508
509
510
511
512
513
514
515
516 <h5>Parameters:</h5>
517
518
519<table class="params">
520 <thead>
521 <tr>
522
523 <th>Name</th>
524
525
526 <th>Type</th>
527
528
529
530
531
532 <th class="last">Description</th>
533 </tr>
534 </thead>
535
536 <tbody>
537
538
539 <tr>
540
541 <td class="name"><code>instances</code></td>
542
543
544 <td class="type">
545
546
547<span class="param-type">Object</span>
548
549
550
551 </td>
552
553
554
555
556
557 <td class="description last"><p>Array of instances, each having the form</p>
558<pre class="prettyprint source"><code>{
559 name: name for instance,
560 ip: ip address,
561 port: port
562}</code></pre></td>
563 </tr>
564
565
566 </tbody>
567</table>
568
569
570
571
572
573
574<dl class="details">
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607</dl>
608
609
610
611
612
613
614
615
616
617
618
619
620
621<h5>Returns:</h5>
622
623
624<div class="param-desc">
625 <p>A promise which will be resolved with the instance ID of the
626 elected primary.</p>
627</div>
628
629
630
631<dl>
632 <dt>
633 Type
634 </dt>
635 <dd>
636
637<span class="param-type">Promise</span>
638
639
640 </dd>
641</dl>
642
643
644
645
646
647
648
649
650
651
652
653
654
655</article>
656
657</section>
658
659
660
661
662</div>
663
664<nav>
665 <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>
666</nav>
667
668<br class="clear">
669
670<footer>
671 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
672</footer>
673
674<script> prettyPrint(); </script>
675<script src="scripts/linenumber.js"> </script>
676</body>
677</html>
\No newline at end of file