| 1 | <!DOCTYPE html>
|
| 2 | <html lang="en">
|
| 3 | <head>
|
| 4 | <meta charset="utf-8">
|
| 5 | <title>JSDoc: Mixin: bigIqOnboardMixins</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">Mixin: bigIqOnboardMixins</h1>
|
| 21 |
|
| 22 |
|
| 23 |
|
| 24 |
|
| 25 |
|
| 26 |
|
| 27 | <section>
|
| 28 |
|
| 29 | <header>
|
| 30 |
|
| 31 | <h2>bigIqOnboardMixins</h2>
|
| 32 |
|
| 33 |
|
| 34 | </header>
|
| 35 |
|
| 36 | <article>
|
| 37 | <div class="container-overview">
|
| 38 |
|
| 39 |
|
| 40 | <div class="description"><p>Functions that only pertain to BIG-IQ onboarding, not BIG-IP</p></div>
|
| 41 |
|
| 42 |
|
| 43 |
|
| 44 |
|
| 45 |
|
| 46 | <dl class="details">
|
| 47 |
|
| 48 |
|
| 49 |
|
| 50 |
|
| 51 |
|
| 52 |
|
| 53 |
|
| 54 |
|
| 55 |
|
| 56 |
|
| 57 |
|
| 58 |
|
| 59 |
|
| 60 |
|
| 61 |
|
| 62 |
|
| 63 |
|
| 64 |
|
| 65 |
|
| 66 |
|
| 67 |
|
| 68 |
|
| 69 |
|
| 70 |
|
| 71 |
|
| 72 |
|
| 73 |
|
| 74 |
|
| 75 |
|
| 76 |
|
| 77 |
|
| 78 |
|
| 79 | </dl>
|
| 80 |
|
| 81 |
|
| 82 |
|
| 83 |
|
| 84 | </div>
|
| 85 |
|
| 86 |
|
| 87 |
|
| 88 |
|
| 89 |
|
| 90 |
|
| 91 |
|
| 92 |
|
| 93 |
|
| 94 |
|
| 95 |
|
| 96 |
|
| 97 |
|
| 98 |
|
| 99 |
|
| 100 |
|
| 101 | <h3 class="subsection-title">Methods</h3>
|
| 102 |
|
| 103 |
|
| 104 |
|
| 105 |
|
| 106 |
|
| 107 |
|
| 108 |
|
| 109 | <h4 class="name" id=".createLicensePool"><span class="type-signature">(static) </span>createLicensePool<span class="signature">(name, regKey)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 110 |
|
| 111 |
|
| 112 |
|
| 113 |
|
| 114 |
|
| 115 |
|
| 116 | <div class="description">
|
| 117 | <p>Creates a license pool</p>
|
| 118 | </div>
|
| 119 |
|
| 120 |
|
| 121 |
|
| 122 |
|
| 123 |
|
| 124 |
|
| 125 |
|
| 126 |
|
| 127 |
|
| 128 | <h5>Parameters:</h5>
|
| 129 |
|
| 130 |
|
| 131 | <table class="params">
|
| 132 | <thead>
|
| 133 | <tr>
|
| 134 |
|
| 135 | <th>Name</th>
|
| 136 |
|
| 137 |
|
| 138 | <th>Type</th>
|
| 139 |
|
| 140 |
|
| 141 |
|
| 142 |
|
| 143 |
|
| 144 | <th class="last">Description</th>
|
| 145 | </tr>
|
| 146 | </thead>
|
| 147 |
|
| 148 | <tbody>
|
| 149 |
|
| 150 |
|
| 151 | <tr>
|
| 152 |
|
| 153 | <td class="name"><code>name</code></td>
|
| 154 |
|
| 155 |
|
| 156 | <td class="type">
|
| 157 |
|
| 158 |
|
| 159 | <span class="param-type">String</span>
|
| 160 |
|
| 161 |
|
| 162 |
|
| 163 | </td>
|
| 164 |
|
| 165 |
|
| 166 |
|
| 167 |
|
| 168 |
|
| 169 | <td class="description last"><p>The name to use for the pool</p></td>
|
| 170 | </tr>
|
| 171 |
|
| 172 |
|
| 173 |
|
| 174 | <tr>
|
| 175 |
|
| 176 | <td class="name"><code>regKey</code></td>
|
| 177 |
|
| 178 |
|
| 179 | <td class="type">
|
| 180 |
|
| 181 |
|
| 182 | <span class="param-type">String</span>
|
| 183 |
|
| 184 |
|
| 185 |
|
| 186 | </td>
|
| 187 |
|
| 188 |
|
| 189 |
|
| 190 |
|
| 191 |
|
| 192 | <td class="description last"><p>The reg key to use for the pool</p></td>
|
| 193 | </tr>
|
| 194 |
|
| 195 |
|
| 196 | </tbody>
|
| 197 | </table>
|
| 198 |
|
| 199 |
|
| 200 |
|
| 201 |
|
| 202 |
|
| 203 |
|
| 204 | <dl class="details">
|
| 205 |
|
| 206 |
|
| 207 |
|
| 208 |
|
| 209 |
|
| 210 |
|
| 211 |
|
| 212 |
|
| 213 |
|
| 214 |
|
| 215 |
|
| 216 |
|
| 217 |
|
| 218 |
|
| 219 |
|
| 220 |
|
| 221 |
|
| 222 |
|
| 223 |
|
| 224 |
|
| 225 |
|
| 226 |
|
| 227 |
|
| 228 |
|
| 229 |
|
| 230 |
|
| 231 |
|
| 232 |
|
| 233 |
|
| 234 |
|
| 235 |
|
| 236 |
|
| 237 | </dl>
|
| 238 |
|
| 239 |
|
| 240 |
|
| 241 |
|
| 242 |
|
| 243 |
|
| 244 |
|
| 245 |
|
| 246 |
|
| 247 |
|
| 248 |
|
| 249 |
|
| 250 |
|
| 251 | <h5>Returns:</h5>
|
| 252 |
|
| 253 |
|
| 254 | <div class="param-desc">
|
| 255 | <p>A promise which is resolved when the pool is created and
|
| 256 | all licenses are activated.</p>
|
| 257 | </div>
|
| 258 |
|
| 259 |
|
| 260 |
|
| 261 | <dl>
|
| 262 | <dt>
|
| 263 | Type
|
| 264 | </dt>
|
| 265 | <dd>
|
| 266 |
|
| 267 | <span class="param-type">Promise</span>
|
| 268 |
|
| 269 |
|
| 270 | </dd>
|
| 271 | </dl>
|
| 272 |
|
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
|
| 277 |
|
| 278 |
|
| 279 |
|
| 280 |
|
| 281 |
|
| 282 |
|
| 283 |
|
| 284 |
|
| 285 | <h4 class="name" id=".createRegKeyPool"><span class="type-signature">(static) </span>createRegKeyPool<span class="signature">(name, regKeyList)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 286 |
|
| 287 |
|
| 288 |
|
| 289 |
|
| 290 |
|
| 291 |
|
| 292 | <div class="description">
|
| 293 | <p>Creates a license pool</p>
|
| 294 | </div>
|
| 295 |
|
| 296 |
|
| 297 |
|
| 298 |
|
| 299 |
|
| 300 |
|
| 301 |
|
| 302 |
|
| 303 |
|
| 304 | <h5>Parameters:</h5>
|
| 305 |
|
| 306 |
|
| 307 | <table class="params">
|
| 308 | <thead>
|
| 309 | <tr>
|
| 310 |
|
| 311 | <th>Name</th>
|
| 312 |
|
| 313 |
|
| 314 | <th>Type</th>
|
| 315 |
|
| 316 |
|
| 317 |
|
| 318 |
|
| 319 |
|
| 320 | <th class="last">Description</th>
|
| 321 | </tr>
|
| 322 | </thead>
|
| 323 |
|
| 324 | <tbody>
|
| 325 |
|
| 326 |
|
| 327 | <tr>
|
| 328 |
|
| 329 | <td class="name"><code>name</code></td>
|
| 330 |
|
| 331 |
|
| 332 | <td class="type">
|
| 333 |
|
| 334 |
|
| 335 | <span class="param-type">String</span>
|
| 336 |
|
| 337 |
|
| 338 |
|
| 339 | </td>
|
| 340 |
|
| 341 |
|
| 342 |
|
| 343 |
|
| 344 |
|
| 345 | <td class="description last"><p>The name to use for the pool</p></td>
|
| 346 | </tr>
|
| 347 |
|
| 348 |
|
| 349 |
|
| 350 | <tr>
|
| 351 |
|
| 352 | <td class="name"><code>regKeyList</code></td>
|
| 353 |
|
| 354 |
|
| 355 | <td class="type">
|
| 356 |
|
| 357 |
|
| 358 | <span class="param-type">Array.<String></span>
|
| 359 |
|
| 360 |
|
| 361 |
|
| 362 | </td>
|
| 363 |
|
| 364 |
|
| 365 |
|
| 366 |
|
| 367 |
|
| 368 | <td class="description last"><p>A list of reg keys to add to the pool</p></td>
|
| 369 | </tr>
|
| 370 |
|
| 371 |
|
| 372 | </tbody>
|
| 373 | </table>
|
| 374 |
|
| 375 |
|
| 376 |
|
| 377 |
|
| 378 |
|
| 379 |
|
| 380 | <dl class="details">
|
| 381 |
|
| 382 |
|
| 383 |
|
| 384 |
|
| 385 |
|
| 386 |
|
| 387 |
|
| 388 |
|
| 389 |
|
| 390 |
|
| 391 |
|
| 392 |
|
| 393 |
|
| 394 |
|
| 395 |
|
| 396 |
|
| 397 |
|
| 398 |
|
| 399 |
|
| 400 |
|
| 401 |
|
| 402 |
|
| 403 |
|
| 404 |
|
| 405 |
|
| 406 |
|
| 407 |
|
| 408 |
|
| 409 |
|
| 410 |
|
| 411 |
|
| 412 |
|
| 413 | </dl>
|
| 414 |
|
| 415 |
|
| 416 |
|
| 417 |
|
| 418 |
|
| 419 |
|
| 420 |
|
| 421 |
|
| 422 |
|
| 423 |
|
| 424 |
|
| 425 |
|
| 426 |
|
| 427 | <h5>Returns:</h5>
|
| 428 |
|
| 429 |
|
| 430 | <div class="param-desc">
|
| 431 | <p>A promise which is resolved when the pool is created and
|
| 432 | all licenses are activated.</p>
|
| 433 | </div>
|
| 434 |
|
| 435 |
|
| 436 |
|
| 437 | <dl>
|
| 438 | <dt>
|
| 439 | Type
|
| 440 | </dt>
|
| 441 | <dd>
|
| 442 |
|
| 443 | <span class="param-type">Promise</span>
|
| 444 |
|
| 445 |
|
| 446 | </dd>
|
| 447 | </dl>
|
| 448 |
|
| 449 |
|
| 450 |
|
| 451 |
|
| 452 |
|
| 453 |
|
| 454 |
|
| 455 |
|
| 456 |
|
| 457 |
|
| 458 |
|
| 459 |
|
| 460 |
|
| 461 | <h4 class="name" id=".isPrimaryKeySet"><span class="type-signature">(static) </span>isPrimaryKeySet<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
| 462 |
|
| 463 |
|
| 464 |
|
| 465 |
|
| 466 |
|
| 467 |
|
| 468 | <div class="description">
|
| 469 | <p>Determines if primary key is already set</p>
|
| 470 | </div>
|
| 471 |
|
| 472 |
|
| 473 |
|
| 474 |
|
| 475 |
|
| 476 |
|
| 477 |
|
| 478 |
|
| 479 |
|
| 480 |
|
| 481 |
|
| 482 |
|
| 483 |
|
| 484 | <dl class="details">
|
| 485 |
|
| 486 |
|
| 487 |
|
| 488 |
|
| 489 |
|
| 490 |
|
| 491 |
|
| 492 |
|
| 493 |
|
| 494 |
|
| 495 |
|
| 496 |
|
| 497 |
|
| 498 |
|
| 499 |
|
| 500 |
|
| 501 |
|
| 502 |
|
| 503 |
|
| 504 |
|
| 505 |
|
| 506 |
|
| 507 |
|
| 508 |
|
| 509 |
|
| 510 |
|
| 511 |
|
| 512 |
|
| 513 |
|
| 514 |
|
| 515 |
|
| 516 |
|
| 517 | </dl>
|
| 518 |
|
| 519 |
|
| 520 |
|
| 521 |
|
| 522 |
|
| 523 |
|
| 524 |
|
| 525 |
|
| 526 |
|
| 527 |
|
| 528 |
|
| 529 |
|
| 530 |
|
| 531 | <h5>Returns:</h5>
|
| 532 |
|
| 533 |
|
| 534 | <div class="param-desc">
|
| 535 | <p>A Promise which is resolved with true or false
|
| 536 | based on whether or not the primary key is set</p>
|
| 537 | </div>
|
| 538 |
|
| 539 |
|
| 540 |
|
| 541 | <dl>
|
| 542 | <dt>
|
| 543 | Type
|
| 544 | </dt>
|
| 545 | <dd>
|
| 546 |
|
| 547 | <span class="param-type">Promise</span>
|
| 548 |
|
| 549 |
|
| 550 | </dd>
|
| 551 | </dl>
|
| 552 |
|
| 553 |
|
| 554 |
|
| 555 |
|
| 556 |
|
| 557 |
|
| 558 |
|
| 559 |
|
| 560 |
|
| 561 |
|
| 562 |
|
| 563 |
|
| 564 |
|
| 565 | <h4 class="name" id=".setPrimaryPassphrase"><span class="type-signature">(static) </span>setPrimaryPassphrase<span class="signature">(passphrase)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 566 |
|
| 567 |
|
| 568 |
|
| 569 |
|
| 570 |
|
| 571 |
|
| 572 | <div class="description">
|
| 573 | <p>Sets the passphrase for the primary key (which, in turn, generates a new primary key)</p>
|
| 574 | </div>
|
| 575 |
|
| 576 |
|
| 577 |
|
| 578 |
|
| 579 |
|
| 580 |
|
| 581 |
|
| 582 |
|
| 583 |
|
| 584 | <h5>Parameters:</h5>
|
| 585 |
|
| 586 |
|
| 587 | <table class="params">
|
| 588 | <thead>
|
| 589 | <tr>
|
| 590 |
|
| 591 | <th>Name</th>
|
| 592 |
|
| 593 |
|
| 594 | <th>Type</th>
|
| 595 |
|
| 596 |
|
| 597 |
|
| 598 |
|
| 599 |
|
| 600 | <th class="last">Description</th>
|
| 601 | </tr>
|
| 602 | </thead>
|
| 603 |
|
| 604 | <tbody>
|
| 605 |
|
| 606 |
|
| 607 | <tr>
|
| 608 |
|
| 609 | <td class="name"><code>passphrase</code></td>
|
| 610 |
|
| 611 |
|
| 612 | <td class="type">
|
| 613 |
|
| 614 |
|
| 615 | <span class="param-type">String</span>
|
| 616 |
|
| 617 |
|
| 618 |
|
| 619 | </td>
|
| 620 |
|
| 621 |
|
| 622 |
|
| 623 |
|
| 624 |
|
| 625 | <td class="description last"><p>Passphrase for primary key</p></td>
|
| 626 | </tr>
|
| 627 |
|
| 628 |
|
| 629 | </tbody>
|
| 630 | </table>
|
| 631 |
|
| 632 |
|
| 633 |
|
| 634 |
|
| 635 |
|
| 636 |
|
| 637 | <dl class="details">
|
| 638 |
|
| 639 |
|
| 640 |
|
| 641 |
|
| 642 |
|
| 643 |
|
| 644 |
|
| 645 |
|
| 646 |
|
| 647 |
|
| 648 |
|
| 649 |
|
| 650 |
|
| 651 |
|
| 652 |
|
| 653 |
|
| 654 |
|
| 655 |
|
| 656 |
|
| 657 |
|
| 658 |
|
| 659 |
|
| 660 |
|
| 661 |
|
| 662 |
|
| 663 |
|
| 664 |
|
| 665 |
|
| 666 |
|
| 667 |
|
| 668 |
|
| 669 |
|
| 670 | </dl>
|
| 671 |
|
| 672 |
|
| 673 |
|
| 674 |
|
| 675 |
|
| 676 |
|
| 677 |
|
| 678 |
|
| 679 |
|
| 680 |
|
| 681 |
|
| 682 |
|
| 683 |
|
| 684 | <h5>Returns:</h5>
|
| 685 |
|
| 686 |
|
| 687 | <div class="param-desc">
|
| 688 | <p>A promise which is resolved when the operation is complete
|
| 689 | or rejected if an error occurs.</p>
|
| 690 | </div>
|
| 691 |
|
| 692 |
|
| 693 |
|
| 694 | <dl>
|
| 695 | <dt>
|
| 696 | Type
|
| 697 | </dt>
|
| 698 | <dd>
|
| 699 |
|
| 700 | <span class="param-type">Promise</span>
|
| 701 |
|
| 702 |
|
| 703 | </dd>
|
| 704 | </dl>
|
| 705 |
|
| 706 |
|
| 707 |
|
| 708 |
|
| 709 |
|
| 710 |
|
| 711 |
|
| 712 |
|
| 713 |
|
| 714 |
|
| 715 |
|
| 716 |
|
| 717 |
|
| 718 | <h4 class="name" id=".setRandomPrimaryPassphrase"><span class="type-signature">(static) </span>setRandomPrimaryPassphrase<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
| 719 |
|
| 720 |
|
| 721 |
|
| 722 |
|
| 723 |
|
| 724 |
|
| 725 | <div class="description">
|
| 726 | <p>Sets the passphrase for the primary key to a random value</p>
|
| 727 | </div>
|
| 728 |
|
| 729 |
|
| 730 |
|
| 731 |
|
| 732 |
|
| 733 |
|
| 734 |
|
| 735 |
|
| 736 |
|
| 737 |
|
| 738 |
|
| 739 |
|
| 740 |
|
| 741 | <dl class="details">
|
| 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 |
|
| 774 | </dl>
|
| 775 |
|
| 776 |
|
| 777 |
|
| 778 |
|
| 779 |
|
| 780 |
|
| 781 |
|
| 782 |
|
| 783 |
|
| 784 |
|
| 785 |
|
| 786 |
|
| 787 |
|
| 788 | <h5>Returns:</h5>
|
| 789 |
|
| 790 |
|
| 791 | <div class="param-desc">
|
| 792 | <p>A promise which is resolved when the operation is complete
|
| 793 | or rejected if an error occurs.</p>
|
| 794 | </div>
|
| 795 |
|
| 796 |
|
| 797 |
|
| 798 | <dl>
|
| 799 | <dt>
|
| 800 | Type
|
| 801 | </dt>
|
| 802 | <dd>
|
| 803 |
|
| 804 | <span class="param-type">Promise</span>
|
| 805 |
|
| 806 |
|
| 807 | </dd>
|
| 808 | </dl>
|
| 809 |
|
| 810 |
|
| 811 |
|
| 812 |
|
| 813 |
|
| 814 |
|
| 815 |
|
| 816 |
|
| 817 |
|
| 818 |
|
| 819 |
|
| 820 |
|
| 821 |
|
| 822 | </article>
|
| 823 |
|
| 824 | </section>
|
| 825 |
|
| 826 |
|
| 827 |
|
| 828 |
|
| 829 | </div>
|
| 830 |
|
| 831 | <nav>
|
| 832 | <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>
|
| 833 | </nav>
|
| 834 |
|
| 835 | <br class="clear">
|
| 836 |
|
| 837 | <footer>
|
| 838 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
| 839 | </footer>
|
| 840 |
|
| 841 | <script> prettyPrint(); </script>
|
| 842 | <script src="scripts/linenumber.js"> </script>
|
| 843 | </body>
|
| 844 | </html> |
| \ | No newline at end of file |