| 1 | <!DOCTYPE html>
|
| 2 | <html lang="en">
|
| 3 | <head>
|
| 4 | <meta charset="utf-8">
|
| 5 | <title>JSDoc: Class: GtmDnsProvider</title>
|
| 6 |
|
| 7 | <script src="scripts/prettify/prettify.js"> </script>
|
| 8 | <script src="scripts/prettify/lang-css.js"> </script>
|
| 9 | |
| 10 | |
| 11 |
|
| 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: GtmDnsProvider</h1>
|
| 21 |
|
| 22 |
|
| 23 |
|
| 24 |
|
| 25 |
|
| 26 |
|
| 27 | <section>
|
| 28 |
|
| 29 | <header>
|
| 30 |
|
| 31 | <h2><span class="attribs"><span class="type-signature"></span></span>GtmDnsProvider<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="GtmDnsProvider"><span class="type-signature"></span>new GtmDnsProvider<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>Constructor.</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">Ojbect</span>
|
| 97 |
|
| 98 |
|
| 99 |
|
| 100 | </td>
|
| 101 |
|
| 102 |
|
| 103 | <td class="attributes">
|
| 104 |
|
| 105 | <optional><br>
|
| 106 |
|
| 107 |
|
| 108 |
|
| 109 |
|
| 110 |
|
| 111 | </td>
|
| 112 |
|
| 113 |
|
| 114 |
|
| 115 |
|
| 116 | <td class="description last"><p>Options for the instance.</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>clOptions</code></td>
|
| 145 |
|
| 146 |
|
| 147 | <td class="type">
|
| 148 |
|
| 149 |
|
| 150 | <span class="param-type">Object</span>
|
| 151 |
|
| 152 |
|
| 153 |
|
| 154 | </td>
|
| 155 |
|
| 156 |
|
| 157 | <td class="attributes">
|
| 158 |
|
| 159 | <optional><br>
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 |
|
| 164 |
|
| 165 | </td>
|
| 166 |
|
| 167 |
|
| 168 |
|
| 169 |
|
| 170 | <td class="description last"><p>Command line options if called from a script.</p></td>
|
| 171 | </tr>
|
| 172 |
|
| 173 |
|
| 174 |
|
| 175 | <tr>
|
| 176 |
|
| 177 | <td class="name"><code>logger</code></td>
|
| 178 |
|
| 179 |
|
| 180 | <td class="type">
|
| 181 |
|
| 182 |
|
| 183 | <span class="param-type">Object</span>
|
| 184 |
|
| 185 |
|
| 186 |
|
| 187 | </td>
|
| 188 |
|
| 189 |
|
| 190 | <td class="attributes">
|
| 191 |
|
| 192 | <optional><br>
|
| 193 |
|
| 194 |
|
| 195 |
|
| 196 |
|
| 197 |
|
| 198 | </td>
|
| 199 |
|
| 200 |
|
| 201 |
|
| 202 |
|
| 203 | <td class="description last"><p>Logger to use. Or, pass loggerOptions to get your own logger.</p></td>
|
| 204 | </tr>
|
| 205 |
|
| 206 |
|
| 207 |
|
| 208 | <tr>
|
| 209 |
|
| 210 | <td class="name"><code>loggerOptions</code></td>
|
| 211 |
|
| 212 |
|
| 213 | <td class="type">
|
| 214 |
|
| 215 |
|
| 216 | <span class="param-type">Object</span>
|
| 217 |
|
| 218 |
|
| 219 |
|
| 220 | </td>
|
| 221 |
|
| 222 |
|
| 223 | <td class="attributes">
|
| 224 |
|
| 225 | <optional><br>
|
| 226 |
|
| 227 |
|
| 228 |
|
| 229 |
|
| 230 |
|
| 231 | </td>
|
| 232 |
|
| 233 |
|
| 234 |
|
| 235 |
|
| 236 | <td class="description last"><p>Options for the logger.
|
| 237 | See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
|
| 238 | </tr>
|
| 239 |
|
| 240 |
|
| 241 | </tbody>
|
| 242 | </table>
|
| 243 |
|
| 244 | </td>
|
| 245 | </tr>
|
| 246 |
|
| 247 |
|
| 248 | </tbody>
|
| 249 | </table>
|
| 250 |
|
| 251 |
|
| 252 |
|
| 253 |
|
| 254 |
|
| 255 |
|
| 256 | <dl class="details">
|
| 257 |
|
| 258 |
|
| 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 | </dl>
|
| 290 |
|
| 291 |
|
| 292 |
|
| 293 |
|
| 294 |
|
| 295 |
|
| 296 |
|
| 297 |
|
| 298 |
|
| 299 |
|
| 300 |
|
| 301 |
|
| 302 |
|
| 303 |
|
| 304 |
|
| 305 |
|
| 306 |
|
| 307 |
|
| 308 |
|
| 309 | </div>
|
| 310 |
|
| 311 |
|
| 312 |
|
| 313 |
|
| 314 |
|
| 315 |
|
| 316 |
|
| 317 |
|
| 318 |
|
| 319 |
|
| 320 |
|
| 321 |
|
| 322 |
|
| 323 |
|
| 324 |
|
| 325 |
|
| 326 | <h3 class="subsection-title">Methods</h3>
|
| 327 |
|
| 328 |
|
| 329 |
|
| 330 |
|
| 331 |
|
| 332 |
|
| 333 |
|
| 334 | <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(providerOptions)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 335 |
|
| 336 |
|
| 337 |
|
| 338 |
|
| 339 |
|
| 340 |
|
| 341 | <div class="description">
|
| 342 | <p>Initialize class</p>
|
| 343 | <p>Override for implementation specific initialization needs (read info
|
| 344 | from cloud provider, read database, etc.). Called at the start of
|
| 345 | processing.</p>
|
| 346 | </div>
|
| 347 |
|
| 348 |
|
| 349 |
|
| 350 |
|
| 351 |
|
| 352 |
|
| 353 |
|
| 354 |
|
| 355 |
|
| 356 | <h5>Parameters:</h5>
|
| 357 |
|
| 358 |
|
| 359 | <table class="params">
|
| 360 | <thead>
|
| 361 | <tr>
|
| 362 |
|
| 363 | <th>Name</th>
|
| 364 |
|
| 365 |
|
| 366 | <th>Type</th>
|
| 367 |
|
| 368 |
|
| 369 |
|
| 370 |
|
| 371 |
|
| 372 | <th class="last">Description</th>
|
| 373 | </tr>
|
| 374 | </thead>
|
| 375 |
|
| 376 | <tbody>
|
| 377 |
|
| 378 |
|
| 379 | <tr>
|
| 380 |
|
| 381 | <td class="name"><code>providerOptions</code></td>
|
| 382 |
|
| 383 |
|
| 384 | <td class="type">
|
| 385 |
|
| 386 |
|
| 387 | <span class="param-type">Object</span>
|
| 388 |
|
| 389 |
|
| 390 |
|
| 391 | </td>
|
| 392 |
|
| 393 |
|
| 394 |
|
| 395 |
|
| 396 |
|
| 397 | <td class="description last"><p>Provider specific options.</p>
|
| 398 | <h6>Properties</h6>
|
| 399 |
|
| 400 |
|
| 401 | <table class="params">
|
| 402 | <thead>
|
| 403 | <tr>
|
| 404 |
|
| 405 | <th>Name</th>
|
| 406 |
|
| 407 |
|
| 408 | <th>Type</th>
|
| 409 |
|
| 410 |
|
| 411 | <th>Attributes</th>
|
| 412 |
|
| 413 |
|
| 414 |
|
| 415 |
|
| 416 | <th class="last">Description</th>
|
| 417 | </tr>
|
| 418 | </thead>
|
| 419 |
|
| 420 | <tbody>
|
| 421 |
|
| 422 |
|
| 423 | <tr>
|
| 424 |
|
| 425 | <td class="name"><code>host</code></td>
|
| 426 |
|
| 427 |
|
| 428 | <td class="type">
|
| 429 |
|
| 430 |
|
| 431 | <span class="param-type">String</span>
|
| 432 |
|
| 433 |
|
| 434 |
|
| 435 | </td>
|
| 436 |
|
| 437 |
|
| 438 | <td class="attributes">
|
| 439 |
|
| 440 |
|
| 441 |
|
| 442 |
|
| 443 |
|
| 444 | </td>
|
| 445 |
|
| 446 |
|
| 447 |
|
| 448 |
|
| 449 | <td class="description last"><p>BIG-IP GTM management IP or hostname
|
| 450 | to which to send commands.</p></td>
|
| 451 | </tr>
|
| 452 |
|
| 453 |
|
| 454 |
|
| 455 | <tr>
|
| 456 |
|
| 457 | <td class="name"><code>user</code></td>
|
| 458 |
|
| 459 |
|
| 460 | <td class="type">
|
| 461 |
|
| 462 |
|
| 463 | <span class="param-type">String</span>
|
| 464 |
|
| 465 |
|
| 466 |
|
| 467 | </td>
|
| 468 |
|
| 469 |
|
| 470 | <td class="attributes">
|
| 471 |
|
| 472 |
|
| 473 |
|
| 474 |
|
| 475 |
|
| 476 | </td>
|
| 477 |
|
| 478 |
|
| 479 |
|
| 480 |
|
| 481 | <td class="description last"><p>BIG-IP GTM admin user name.</p></td>
|
| 482 | </tr>
|
| 483 |
|
| 484 |
|
| 485 |
|
| 486 | <tr>
|
| 487 |
|
| 488 | <td class="name"><code>port</code></td>
|
| 489 |
|
| 490 |
|
| 491 | <td class="type">
|
| 492 |
|
| 493 |
|
| 494 | <span class="param-type">String</span>
|
| 495 |
|
| 496 |
|
| 497 |
|
| 498 | </td>
|
| 499 |
|
| 500 |
|
| 501 | <td class="attributes">
|
| 502 |
|
| 503 |
|
| 504 |
|
| 505 |
|
| 506 |
|
| 507 | </td>
|
| 508 |
|
| 509 |
|
| 510 |
|
| 511 |
|
| 512 | <td class="description last"><p>BIG-IP GTM management SSL port to connect to.
|
| 513 | Default 443.</p></td>
|
| 514 | </tr>
|
| 515 |
|
| 516 |
|
| 517 |
|
| 518 | <tr>
|
| 519 |
|
| 520 | <td class="name"><code>password</code></td>
|
| 521 |
|
| 522 |
|
| 523 | <td class="type">
|
| 524 |
|
| 525 |
|
| 526 | <span class="param-type">String</span>
|
| 527 |
|
| 528 |
|
| 529 |
|
| 530 | </td>
|
| 531 |
|
| 532 |
|
| 533 | <td class="attributes">
|
| 534 |
|
| 535 |
|
| 536 |
|
| 537 |
|
| 538 |
|
| 539 | </td>
|
| 540 |
|
| 541 |
|
| 542 |
|
| 543 |
|
| 544 | <td class="description last"><p>BIG-IP GTM admin user password.
|
| 545 | Use this or passwordUrl.</p></td>
|
| 546 | </tr>
|
| 547 |
|
| 548 |
|
| 549 |
|
| 550 | <tr>
|
| 551 |
|
| 552 | <td class="name"><code>passwordUrl</code></td>
|
| 553 |
|
| 554 |
|
| 555 | <td class="type">
|
| 556 |
|
| 557 |
|
| 558 | <span class="param-type">String</span>
|
| 559 |
|
| 560 |
|
| 561 |
|
| 562 | </td>
|
| 563 |
|
| 564 |
|
| 565 | <td class="attributes">
|
| 566 |
|
| 567 |
|
| 568 |
|
| 569 |
|
| 570 |
|
| 571 | </td>
|
| 572 |
|
| 573 |
|
| 574 |
|
| 575 |
|
| 576 | <td class="description last"><p>URL (file, http(s), arn) to location that contains
|
| 577 | BIG-IP GTM admin user password. Use this or password.</p></td>
|
| 578 | </tr>
|
| 579 |
|
| 580 |
|
| 581 |
|
| 582 | <tr>
|
| 583 |
|
| 584 | <td class="name"><code>passwordEncrypted</code></td>
|
| 585 |
|
| 586 |
|
| 587 | <td class="type">
|
| 588 |
|
| 589 |
|
| 590 | <span class="param-type">String</span>
|
| 591 |
|
| 592 |
|
| 593 |
|
| 594 | </td>
|
| 595 |
|
| 596 |
|
| 597 | <td class="attributes">
|
| 598 |
|
| 599 | <optional><br>
|
| 600 |
|
| 601 |
|
| 602 |
|
| 603 |
|
| 604 |
|
| 605 | </td>
|
| 606 |
|
| 607 |
|
| 608 |
|
| 609 |
|
| 610 | <td class="description last"><p>Indicates that the BIG-IP GTM password is encrypted
|
| 611 | (either with encryptDataToFile or generatePassword).</p></td>
|
| 612 | </tr>
|
| 613 |
|
| 614 |
|
| 615 |
|
| 616 | <tr>
|
| 617 |
|
| 618 | <td class="name"><code>serverName</code></td>
|
| 619 |
|
| 620 |
|
| 621 | <td class="type">
|
| 622 |
|
| 623 |
|
| 624 | <span class="param-type">String</span>
|
| 625 |
|
| 626 |
|
| 627 |
|
| 628 | </td>
|
| 629 |
|
| 630 |
|
| 631 | <td class="attributes">
|
| 632 |
|
| 633 |
|
| 634 |
|
| 635 |
|
| 636 |
|
| 637 | </td>
|
| 638 |
|
| 639 |
|
| 640 |
|
| 641 |
|
| 642 | <td class="description last"><p>GSLB server name.</p></td>
|
| 643 | </tr>
|
| 644 |
|
| 645 |
|
| 646 |
|
| 647 | <tr>
|
| 648 |
|
| 649 | <td class="name"><code>poolName</code></td>
|
| 650 |
|
| 651 |
|
| 652 | <td class="type">
|
| 653 |
|
| 654 |
|
| 655 | <span class="param-type">String</span>
|
| 656 |
|
| 657 |
|
| 658 |
|
| 659 | </td>
|
| 660 |
|
| 661 |
|
| 662 | <td class="attributes">
|
| 663 |
|
| 664 |
|
| 665 |
|
| 666 |
|
| 667 |
|
| 668 | </td>
|
| 669 |
|
| 670 |
|
| 671 |
|
| 672 |
|
| 673 | <td class="description last"><p>GSLB pool name.</p></td>
|
| 674 | </tr>
|
| 675 |
|
| 676 |
|
| 677 |
|
| 678 | <tr>
|
| 679 |
|
| 680 | <td class="name"><code>datacenter</code></td>
|
| 681 |
|
| 682 |
|
| 683 | <td class="type">
|
| 684 |
|
| 685 |
|
| 686 | <span class="param-type">String</span>
|
| 687 |
|
| 688 |
|
| 689 |
|
| 690 | </td>
|
| 691 |
|
| 692 |
|
| 693 | <td class="attributes">
|
| 694 |
|
| 695 | <optional><br>
|
| 696 |
|
| 697 |
|
| 698 |
|
| 699 |
|
| 700 |
|
| 701 | </td>
|
| 702 |
|
| 703 |
|
| 704 |
|
| 705 |
|
| 706 | <td class="description last"><p>GSLB data center. Required if creating the
|
| 707 | GTM server.</p></td>
|
| 708 | </tr>
|
| 709 |
|
| 710 |
|
| 711 |
|
| 712 | <tr>
|
| 713 |
|
| 714 | <td class="name"><code>vsMonitor</code></td>
|
| 715 |
|
| 716 |
|
| 717 | <td class="type">
|
| 718 |
|
| 719 |
|
| 720 | <span class="param-type">String</span>
|
| 721 |
|
| 722 |
|
| 723 |
|
| 724 | </td>
|
| 725 |
|
| 726 |
|
| 727 | <td class="attributes">
|
| 728 |
|
| 729 | <optional><br>
|
| 730 |
|
| 731 |
|
| 732 |
|
| 733 |
|
| 734 |
|
| 735 | </td>
|
| 736 |
|
| 737 |
|
| 738 |
|
| 739 |
|
| 740 | <td class="description last"><p>Full path to monitor for the virtual server.
|
| 741 | Default is existing monitor.</p></td>
|
| 742 | </tr>
|
| 743 |
|
| 744 |
|
| 745 |
|
| 746 | <tr>
|
| 747 |
|
| 748 | <td class="name"><code>poolMonitor</code></td>
|
| 749 |
|
| 750 |
|
| 751 | <td class="type">
|
| 752 |
|
| 753 |
|
| 754 | <span class="param-type">String</span>
|
| 755 |
|
| 756 |
|
| 757 |
|
| 758 | </td>
|
| 759 |
|
| 760 |
|
| 761 | <td class="attributes">
|
| 762 |
|
| 763 | <optional><br>
|
| 764 |
|
| 765 |
|
| 766 |
|
| 767 |
|
| 768 |
|
| 769 | </td>
|
| 770 |
|
| 771 |
|
| 772 |
|
| 773 |
|
| 774 | <td class="description last"><p>Full path to monitor for the pool.
|
| 775 | Default is existing monitor.</p></td>
|
| 776 | </tr>
|
| 777 |
|
| 778 |
|
| 779 |
|
| 780 | <tr>
|
| 781 |
|
| 782 | <td class="name"><code>loadBalancingMode</code></td>
|
| 783 |
|
| 784 |
|
| 785 | <td class="type">
|
| 786 |
|
| 787 |
|
| 788 | <span class="param-type">String</span>
|
| 789 |
|
| 790 |
|
| 791 |
|
| 792 | </td>
|
| 793 |
|
| 794 |
|
| 795 | <td class="attributes">
|
| 796 |
|
| 797 | <optional><br>
|
| 798 |
|
| 799 |
|
| 800 |
|
| 801 |
|
| 802 |
|
| 803 | </td>
|
| 804 |
|
| 805 |
|
| 806 |
|
| 807 |
|
| 808 | <td class="description last"><p>Load balancing mode for the pool.
|
| 809 | Default is existing load balancing mode.</p></td>
|
| 810 | </tr>
|
| 811 |
|
| 812 |
|
| 813 |
|
| 814 | <tr>
|
| 815 |
|
| 816 | <td class="name"><code>partition</code></td>
|
| 817 |
|
| 818 |
|
| 819 | <td class="type">
|
| 820 |
|
| 821 |
|
| 822 | <span class="param-type">String</span>
|
| 823 |
|
| 824 |
|
| 825 |
|
| 826 | </td>
|
| 827 |
|
| 828 |
|
| 829 | <td class="attributes">
|
| 830 |
|
| 831 | <optional><br>
|
| 832 |
|
| 833 |
|
| 834 |
|
| 835 |
|
| 836 |
|
| 837 | </td>
|
| 838 |
|
| 839 |
|
| 840 |
|
| 841 |
|
| 842 | <td class="description last"><p>Partition of pool and server. Default is Common.</p></td>
|
| 843 | </tr>
|
| 844 |
|
| 845 |
|
| 846 | </tbody>
|
| 847 | </table>
|
| 848 |
|
| 849 | </td>
|
| 850 | </tr>
|
| 851 |
|
| 852 |
|
| 853 | </tbody>
|
| 854 | </table>
|
| 855 |
|
| 856 |
|
| 857 |
|
| 858 |
|
| 859 |
|
| 860 |
|
| 861 | <dl class="details">
|
| 862 |
|
| 863 |
|
| 864 |
|
| 865 |
|
| 866 |
|
| 867 |
|
| 868 |
|
| 869 |
|
| 870 |
|
| 871 |
|
| 872 |
|
| 873 |
|
| 874 |
|
| 875 |
|
| 876 |
|
| 877 |
|
| 878 |
|
| 879 |
|
| 880 |
|
| 881 |
|
| 882 |
|
| 883 |
|
| 884 |
|
| 885 |
|
| 886 |
|
| 887 |
|
| 888 |
|
| 889 |
|
| 890 |
|
| 891 |
|
| 892 |
|
| 893 |
|
| 894 | </dl>
|
| 895 |
|
| 896 |
|
| 897 |
|
| 898 |
|
| 899 |
|
| 900 |
|
| 901 |
|
| 902 |
|
| 903 |
|
| 904 |
|
| 905 |
|
| 906 |
|
| 907 |
|
| 908 | <h5>Returns:</h5>
|
| 909 |
|
| 910 |
|
| 911 | <div class="param-desc">
|
| 912 | <p>A promise which will be resolved when init is complete.</p>
|
| 913 | </div>
|
| 914 |
|
| 915 |
|
| 916 |
|
| 917 | <dl>
|
| 918 | <dt>
|
| 919 | Type
|
| 920 | </dt>
|
| 921 | <dd>
|
| 922 |
|
| 923 | <span class="param-type">Promise</span>
|
| 924 |
|
| 925 |
|
| 926 | </dd>
|
| 927 | </dl>
|
| 928 |
|
| 929 |
|
| 930 |
|
| 931 |
|
| 932 |
|
| 933 |
|
| 934 |
|
| 935 |
|
| 936 |
|
| 937 |
|
| 938 |
|
| 939 |
|
| 940 |
|
| 941 | <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">(instances)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 942 |
|
| 943 |
|
| 944 |
|
| 945 |
|
| 946 |
|
| 947 |
|
| 948 | <div class="description">
|
| 949 | <p>Updates DNS records with the given instances</p>
|
| 950 | </div>
|
| 951 |
|
| 952 |
|
| 953 |
|
| 954 |
|
| 955 |
|
| 956 |
|
| 957 |
|
| 958 |
|
| 959 |
|
| 960 | <h5>Parameters:</h5>
|
| 961 |
|
| 962 |
|
| 963 | <table class="params">
|
| 964 | <thead>
|
| 965 | <tr>
|
| 966 |
|
| 967 | <th>Name</th>
|
| 968 |
|
| 969 |
|
| 970 | <th>Type</th>
|
| 971 |
|
| 972 |
|
| 973 |
|
| 974 |
|
| 975 |
|
| 976 | <th class="last">Description</th>
|
| 977 | </tr>
|
| 978 | </thead>
|
| 979 |
|
| 980 | <tbody>
|
| 981 |
|
| 982 |
|
| 983 | <tr>
|
| 984 |
|
| 985 | <td class="name"><code>instances</code></td>
|
| 986 |
|
| 987 |
|
| 988 | <td class="type">
|
| 989 |
|
| 990 |
|
| 991 | <span class="param-type">Object</span>
|
| 992 |
|
| 993 |
|
| 994 |
|
| 995 | </td>
|
| 996 |
|
| 997 |
|
| 998 |
|
| 999 |
|
| 1000 |
|
| 1001 | <td class="description last"><p>Array of instances, each having the form</p>
|
| 1002 | <pre class="prettyprint source"><code>{
|
| 1003 | name: name for instance,
|
| 1004 | ip: ip address,
|
| 1005 | port: port
|
| 1006 | }</code></pre></td>
|
| 1007 | </tr>
|
| 1008 |
|
| 1009 |
|
| 1010 | </tbody>
|
| 1011 | </table>
|
| 1012 |
|
| 1013 |
|
| 1014 |
|
| 1015 |
|
| 1016 |
|
| 1017 |
|
| 1018 | <dl class="details">
|
| 1019 |
|
| 1020 |
|
| 1021 |
|
| 1022 |
|
| 1023 |
|
| 1024 |
|
| 1025 |
|
| 1026 |
|
| 1027 |
|
| 1028 |
|
| 1029 |
|
| 1030 |
|
| 1031 |
|
| 1032 |
|
| 1033 |
|
| 1034 |
|
| 1035 |
|
| 1036 |
|
| 1037 |
|
| 1038 |
|
| 1039 |
|
| 1040 |
|
| 1041 |
|
| 1042 |
|
| 1043 |
|
| 1044 |
|
| 1045 |
|
| 1046 |
|
| 1047 |
|
| 1048 |
|
| 1049 |
|
| 1050 |
|
| 1051 | </dl>
|
| 1052 |
|
| 1053 |
|
| 1054 |
|
| 1055 |
|
| 1056 |
|
| 1057 |
|
| 1058 |
|
| 1059 |
|
| 1060 |
|
| 1061 |
|
| 1062 |
|
| 1063 |
|
| 1064 |
|
| 1065 | <h5>Returns:</h5>
|
| 1066 |
|
| 1067 |
|
| 1068 | <div class="param-desc">
|
| 1069 | <p>A promise which will be resolved with the instance ID of the
|
| 1070 | elected primary.</p>
|
| 1071 | </div>
|
| 1072 |
|
| 1073 |
|
| 1074 |
|
| 1075 | <dl>
|
| 1076 | <dt>
|
| 1077 | Type
|
| 1078 | </dt>
|
| 1079 | <dd>
|
| 1080 |
|
| 1081 | <span class="param-type">Promise</span>
|
| 1082 |
|
| 1083 |
|
| 1084 | </dd>
|
| 1085 | </dl>
|
| 1086 |
|
| 1087 |
|
| 1088 |
|
| 1089 |
|
| 1090 |
|
| 1091 |
|
| 1092 |
|
| 1093 |
|
| 1094 |
|
| 1095 |
|
| 1096 |
|
| 1097 |
|
| 1098 |
|
| 1099 | </article>
|
| 1100 |
|
| 1101 | </section>
|
| 1102 |
|
| 1103 |
|
| 1104 |
|
| 1105 |
|
| 1106 | </div>
|
| 1107 |
|
| 1108 | <nav>
|
| 1109 | <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>
|
| 1110 | </nav>
|
| 1111 |
|
| 1112 | <br class="clear">
|
| 1113 |
|
| 1114 | <footer>
|
| 1115 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
| 1116 | </footer>
|
| 1117 |
|
| 1118 | <script> prettyPrint(); </script>
|
| 1119 | <script src="scripts/linenumber.js"> </script>
|
| 1120 | </body>
|
| 1121 | </html> |
| \ | No newline at end of file |