| 1 | <!DOCTYPE html>
|
| 2 | <html lang="en">
|
| 3 | <head>
|
| 4 | <meta charset="utf-8">
|
| 5 | <title>JSDoc: Class: BigIp</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: BigIp</h1>
|
| 21 |
|
| 22 |
|
| 23 |
|
| 24 |
|
| 25 |
|
| 26 |
|
| 27 | <section>
|
| 28 |
|
| 29 | <header>
|
| 30 |
|
| 31 | <h2><span class="attribs"><span class="type-signature"></span></span>BigIp<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
|
| 32 |
|
| 33 | <div class="class-description"><p>Provides core functionality (CRUD operations, ready, etc) and maintains
|
| 34 | references to other modules in f5-cloud-libs.</p>
|
| 35 | <p>After createing a BigIp with this constructor, you must call the
|
| 36 | async init() method.</p></div>
|
| 37 |
|
| 38 |
|
| 39 | </header>
|
| 40 |
|
| 41 | <article>
|
| 42 | <div class="container-overview">
|
| 43 |
|
| 44 |
|
| 45 |
|
| 46 |
|
| 47 | <h2>Constructor</h2>
|
| 48 |
|
| 49 |
|
| 50 |
|
| 51 | <h4 class="name" id="BigIp"><span class="type-signature"></span>new BigIp<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
|
| 52 |
|
| 53 |
|
| 54 |
|
| 55 |
|
| 56 |
|
| 57 |
|
| 58 | <div class="description">
|
| 59 | <p>BigIp constructor</p>
|
| 60 | </div>
|
| 61 |
|
| 62 |
|
| 63 |
|
| 64 |
|
| 65 |
|
| 66 |
|
| 67 |
|
| 68 |
|
| 69 |
|
| 70 | <h5>Parameters:</h5>
|
| 71 |
|
| 72 |
|
| 73 | <table class="params">
|
| 74 | <thead>
|
| 75 | <tr>
|
| 76 |
|
| 77 | <th>Name</th>
|
| 78 |
|
| 79 |
|
| 80 | <th>Type</th>
|
| 81 |
|
| 82 |
|
| 83 | <th>Attributes</th>
|
| 84 |
|
| 85 |
|
| 86 |
|
| 87 |
|
| 88 | <th class="last">Description</th>
|
| 89 | </tr>
|
| 90 | </thead>
|
| 91 |
|
| 92 | <tbody>
|
| 93 |
|
| 94 |
|
| 95 | <tr>
|
| 96 |
|
| 97 | <td class="name"><code>options</code></td>
|
| 98 |
|
| 99 |
|
| 100 | <td class="type">
|
| 101 |
|
| 102 |
|
| 103 | <span class="param-type">Object</span>
|
| 104 |
|
| 105 |
|
| 106 |
|
| 107 | </td>
|
| 108 |
|
| 109 |
|
| 110 | <td class="attributes">
|
| 111 |
|
| 112 | <optional><br>
|
| 113 |
|
| 114 |
|
| 115 |
|
| 116 |
|
| 117 |
|
| 118 | </td>
|
| 119 |
|
| 120 |
|
| 121 |
|
| 122 |
|
| 123 | <td class="description last"><p>Optional parameters.</p>
|
| 124 | <h6>Properties</h6>
|
| 125 |
|
| 126 |
|
| 127 | <table class="params">
|
| 128 | <thead>
|
| 129 | <tr>
|
| 130 |
|
| 131 | <th>Name</th>
|
| 132 |
|
| 133 |
|
| 134 | <th>Type</th>
|
| 135 |
|
| 136 |
|
| 137 | <th>Attributes</th>
|
| 138 |
|
| 139 |
|
| 140 |
|
| 141 |
|
| 142 | <th class="last">Description</th>
|
| 143 | </tr>
|
| 144 | </thead>
|
| 145 |
|
| 146 | <tbody>
|
| 147 |
|
| 148 |
|
| 149 | <tr>
|
| 150 |
|
| 151 | <td class="name"><code>logger</code></td>
|
| 152 |
|
| 153 |
|
| 154 | <td class="type">
|
| 155 |
|
| 156 |
|
| 157 | <span class="param-type">Object</span>
|
| 158 |
|
| 159 |
|
| 160 |
|
| 161 | </td>
|
| 162 |
|
| 163 |
|
| 164 | <td class="attributes">
|
| 165 |
|
| 166 | <optional><br>
|
| 167 |
|
| 168 |
|
| 169 |
|
| 170 |
|
| 171 |
|
| 172 | </td>
|
| 173 |
|
| 174 |
|
| 175 |
|
| 176 |
|
| 177 | <td class="description last"><p>Logger to use. Or, pass loggerOptions to
|
| 178 | get your own logger.</p></td>
|
| 179 | </tr>
|
| 180 |
|
| 181 |
|
| 182 |
|
| 183 | <tr>
|
| 184 |
|
| 185 | <td class="name"><code>loggerOptions</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 | <optional><br>
|
| 201 |
|
| 202 |
|
| 203 |
|
| 204 |
|
| 205 |
|
| 206 | </td>
|
| 207 |
|
| 208 |
|
| 209 |
|
| 210 |
|
| 211 | <td class="description last"><p>Options for the logger.
|
| 212 | See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
|
| 213 | </tr>
|
| 214 |
|
| 215 |
|
| 216 | </tbody>
|
| 217 | </table>
|
| 218 |
|
| 219 | </td>
|
| 220 | </tr>
|
| 221 |
|
| 222 |
|
| 223 | </tbody>
|
| 224 | </table>
|
| 225 |
|
| 226 |
|
| 227 |
|
| 228 |
|
| 229 |
|
| 230 |
|
| 231 | <dl class="details">
|
| 232 |
|
| 233 |
|
| 234 |
|
| 235 |
|
| 236 |
|
| 237 |
|
| 238 |
|
| 239 |
|
| 240 |
|
| 241 |
|
| 242 |
|
| 243 |
|
| 244 |
|
| 245 |
|
| 246 |
|
| 247 |
|
| 248 |
|
| 249 |
|
| 250 |
|
| 251 |
|
| 252 |
|
| 253 |
|
| 254 |
|
| 255 |
|
| 256 |
|
| 257 |
|
| 258 |
|
| 259 |
|
| 260 |
|
| 261 |
|
| 262 |
|
| 263 |
|
| 264 | </dl>
|
| 265 |
|
| 266 |
|
| 267 |
|
| 268 |
|
| 269 |
|
| 270 |
|
| 271 |
|
| 272 |
|
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
|
| 277 |
|
| 278 |
|
| 279 |
|
| 280 |
|
| 281 |
|
| 282 |
|
| 283 |
|
| 284 | </div>
|
| 285 |
|
| 286 |
|
| 287 |
|
| 288 |
|
| 289 |
|
| 290 |
|
| 291 |
|
| 292 |
|
| 293 |
|
| 294 |
|
| 295 |
|
| 296 |
|
| 297 |
|
| 298 |
|
| 299 |
|
| 300 |
|
| 301 | <h3 class="subsection-title">Methods</h3>
|
| 302 |
|
| 303 |
|
| 304 |
|
| 305 |
|
| 306 |
|
| 307 |
|
| 308 |
|
| 309 | <h4 class="name" id="active"><span class="type-signature"></span>active<span class="signature">(retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 310 |
|
| 311 |
|
| 312 |
|
| 313 |
|
| 314 |
|
| 315 |
|
| 316 | <div class="description">
|
| 317 | <p>Determines if the device status is either active or standby</p>
|
| 318 | </div>
|
| 319 |
|
| 320 |
|
| 321 |
|
| 322 |
|
| 323 |
|
| 324 |
|
| 325 |
|
| 326 |
|
| 327 |
|
| 328 | <h5>Parameters:</h5>
|
| 329 |
|
| 330 |
|
| 331 | <table class="params">
|
| 332 | <thead>
|
| 333 | <tr>
|
| 334 |
|
| 335 | <th>Name</th>
|
| 336 |
|
| 337 |
|
| 338 | <th>Type</th>
|
| 339 |
|
| 340 |
|
| 341 | <th>Attributes</th>
|
| 342 |
|
| 343 |
|
| 344 |
|
| 345 |
|
| 346 | <th class="last">Description</th>
|
| 347 | </tr>
|
| 348 | </thead>
|
| 349 |
|
| 350 | <tbody>
|
| 351 |
|
| 352 |
|
| 353 | <tr>
|
| 354 |
|
| 355 | <td class="name"><code>retryOptions</code></td>
|
| 356 |
|
| 357 |
|
| 358 | <td class="type">
|
| 359 |
|
| 360 |
|
| 361 | <span class="param-type">Object</span>
|
| 362 |
|
| 363 |
|
| 364 |
|
| 365 | </td>
|
| 366 |
|
| 367 |
|
| 368 | <td class="attributes">
|
| 369 |
|
| 370 | <optional><br>
|
| 371 |
|
| 372 |
|
| 373 |
|
| 374 |
|
| 375 |
|
| 376 | </td>
|
| 377 |
|
| 378 |
|
| 379 |
|
| 380 |
|
| 381 | <td class="description last"><p>Options for retrying the request.</p>
|
| 382 | <h6>Properties</h6>
|
| 383 |
|
| 384 |
|
| 385 | <table class="params">
|
| 386 | <thead>
|
| 387 | <tr>
|
| 388 |
|
| 389 | <th>Name</th>
|
| 390 |
|
| 391 |
|
| 392 | <th>Type</th>
|
| 393 |
|
| 394 |
|
| 395 | <th>Attributes</th>
|
| 396 |
|
| 397 |
|
| 398 |
|
| 399 |
|
| 400 | <th class="last">Description</th>
|
| 401 | </tr>
|
| 402 | </thead>
|
| 403 |
|
| 404 | <tbody>
|
| 405 |
|
| 406 |
|
| 407 | <tr>
|
| 408 |
|
| 409 | <td class="name"><code>maxRetries</code></td>
|
| 410 |
|
| 411 |
|
| 412 | <td class="type">
|
| 413 |
|
| 414 |
|
| 415 | <span class="param-type">Integer</span>
|
| 416 |
|
| 417 |
|
| 418 |
|
| 419 | </td>
|
| 420 |
|
| 421 |
|
| 422 | <td class="attributes">
|
| 423 |
|
| 424 | <optional><br>
|
| 425 |
|
| 426 |
|
| 427 |
|
| 428 |
|
| 429 |
|
| 430 | </td>
|
| 431 |
|
| 432 |
|
| 433 |
|
| 434 |
|
| 435 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 436 | 0 to not retry. Default 60.</p></td>
|
| 437 | </tr>
|
| 438 |
|
| 439 |
|
| 440 |
|
| 441 | <tr>
|
| 442 |
|
| 443 | <td class="name"><code>retryIntervalMs</code></td>
|
| 444 |
|
| 445 |
|
| 446 | <td class="type">
|
| 447 |
|
| 448 |
|
| 449 | <span class="param-type">Integer</span>
|
| 450 |
|
| 451 |
|
| 452 |
|
| 453 | </td>
|
| 454 |
|
| 455 |
|
| 456 | <td class="attributes">
|
| 457 |
|
| 458 | <optional><br>
|
| 459 |
|
| 460 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 464 | </td>
|
| 465 |
|
| 466 |
|
| 467 |
|
| 468 |
|
| 469 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 470 | </tr>
|
| 471 |
|
| 472 |
|
| 473 | </tbody>
|
| 474 | </table>
|
| 475 |
|
| 476 | </td>
|
| 477 | </tr>
|
| 478 |
|
| 479 |
|
| 480 | </tbody>
|
| 481 | </table>
|
| 482 |
|
| 483 |
|
| 484 |
|
| 485 |
|
| 486 |
|
| 487 |
|
| 488 | <dl class="details">
|
| 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 |
|
| 518 |
|
| 519 |
|
| 520 |
|
| 521 | </dl>
|
| 522 |
|
| 523 |
|
| 524 |
|
| 525 |
|
| 526 |
|
| 527 |
|
| 528 |
|
| 529 |
|
| 530 |
|
| 531 |
|
| 532 |
|
| 533 |
|
| 534 |
|
| 535 | <h5>Returns:</h5>
|
| 536 |
|
| 537 |
|
| 538 | <div class="param-desc">
|
| 539 | <p>A promise which is resolved when the status is either active or standby.</p>
|
| 540 | </div>
|
| 541 |
|
| 542 |
|
| 543 |
|
| 544 | <dl>
|
| 545 | <dt>
|
| 546 | Type
|
| 547 | </dt>
|
| 548 | <dd>
|
| 549 |
|
| 550 | <span class="param-type">Promise</span>
|
| 551 |
|
| 552 |
|
| 553 | </dd>
|
| 554 | </dl>
|
| 555 |
|
| 556 |
|
| 557 |
|
| 558 |
|
| 559 |
|
| 560 |
|
| 561 |
|
| 562 |
|
| 563 |
|
| 564 |
|
| 565 |
|
| 566 |
|
| 567 |
|
| 568 | <h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(path, body, iControlOptions<span class="signature-attributes">opt</span>, retryOptions<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 569 |
|
| 570 |
|
| 571 |
|
| 572 |
|
| 573 |
|
| 574 |
|
| 575 | <div class="description">
|
| 576 | <p>Submits a create (POST) request</p>
|
| 577 | </div>
|
| 578 |
|
| 579 |
|
| 580 |
|
| 581 |
|
| 582 |
|
| 583 |
|
| 584 |
|
| 585 |
|
| 586 |
|
| 587 | <h5>Parameters:</h5>
|
| 588 |
|
| 589 |
|
| 590 | <table class="params">
|
| 591 | <thead>
|
| 592 | <tr>
|
| 593 |
|
| 594 | <th>Name</th>
|
| 595 |
|
| 596 |
|
| 597 | <th>Type</th>
|
| 598 |
|
| 599 |
|
| 600 | <th>Attributes</th>
|
| 601 |
|
| 602 |
|
| 603 |
|
| 604 |
|
| 605 | <th class="last">Description</th>
|
| 606 | </tr>
|
| 607 | </thead>
|
| 608 |
|
| 609 | <tbody>
|
| 610 |
|
| 611 |
|
| 612 | <tr>
|
| 613 |
|
| 614 | <td class="name"><code>path</code></td>
|
| 615 |
|
| 616 |
|
| 617 | <td class="type">
|
| 618 |
|
| 619 |
|
| 620 | <span class="param-type">String</span>
|
| 621 |
|
| 622 |
|
| 623 |
|
| 624 | </td>
|
| 625 |
|
| 626 |
|
| 627 | <td class="attributes">
|
| 628 |
|
| 629 |
|
| 630 |
|
| 631 |
|
| 632 |
|
| 633 | </td>
|
| 634 |
|
| 635 |
|
| 636 |
|
| 637 |
|
| 638 | <td class="description last"><p>The path to post.</p></td>
|
| 639 | </tr>
|
| 640 |
|
| 641 |
|
| 642 |
|
| 643 | <tr>
|
| 644 |
|
| 645 | <td class="name"><code>body</code></td>
|
| 646 |
|
| 647 |
|
| 648 | <td class="type">
|
| 649 |
|
| 650 |
|
| 651 | <span class="param-type">Object</span>
|
| 652 |
|
| 653 |
|
| 654 |
|
| 655 | </td>
|
| 656 |
|
| 657 |
|
| 658 | <td class="attributes">
|
| 659 |
|
| 660 |
|
| 661 |
|
| 662 |
|
| 663 |
|
| 664 | </td>
|
| 665 |
|
| 666 |
|
| 667 |
|
| 668 |
|
| 669 | <td class="description last"><p>The body for the POST request.</p></td>
|
| 670 | </tr>
|
| 671 |
|
| 672 |
|
| 673 |
|
| 674 | <tr>
|
| 675 |
|
| 676 | <td class="name"><code>iControlOptions</code></td>
|
| 677 |
|
| 678 |
|
| 679 | <td class="type">
|
| 680 |
|
| 681 |
|
| 682 | <span class="param-type">Object</span>
|
| 683 |
|
| 684 |
|
| 685 |
|
| 686 | </td>
|
| 687 |
|
| 688 |
|
| 689 | <td class="attributes">
|
| 690 |
|
| 691 | <optional><br>
|
| 692 |
|
| 693 |
|
| 694 |
|
| 695 |
|
| 696 |
|
| 697 | </td>
|
| 698 |
|
| 699 |
|
| 700 |
|
| 701 |
|
| 702 | <td class="description last"><p>Options for IControl.</p></td>
|
| 703 | </tr>
|
| 704 |
|
| 705 |
|
| 706 |
|
| 707 | <tr>
|
| 708 |
|
| 709 | <td class="name"><code>retryOptions</code></td>
|
| 710 |
|
| 711 |
|
| 712 | <td class="type">
|
| 713 |
|
| 714 |
|
| 715 | <span class="param-type">Object</span>
|
| 716 |
|
| 717 |
|
| 718 |
|
| 719 | </td>
|
| 720 |
|
| 721 |
|
| 722 | <td class="attributes">
|
| 723 |
|
| 724 | <optional><br>
|
| 725 |
|
| 726 |
|
| 727 |
|
| 728 |
|
| 729 |
|
| 730 | </td>
|
| 731 |
|
| 732 |
|
| 733 |
|
| 734 |
|
| 735 | <td class="description last"><p>Options for retrying the request.</p>
|
| 736 | <h6>Properties</h6>
|
| 737 |
|
| 738 |
|
| 739 | <table class="params">
|
| 740 | <thead>
|
| 741 | <tr>
|
| 742 |
|
| 743 | <th>Name</th>
|
| 744 |
|
| 745 |
|
| 746 | <th>Type</th>
|
| 747 |
|
| 748 |
|
| 749 | <th>Attributes</th>
|
| 750 |
|
| 751 |
|
| 752 |
|
| 753 |
|
| 754 | <th class="last">Description</th>
|
| 755 | </tr>
|
| 756 | </thead>
|
| 757 |
|
| 758 | <tbody>
|
| 759 |
|
| 760 |
|
| 761 | <tr>
|
| 762 |
|
| 763 | <td class="name"><code>maxRetries</code></td>
|
| 764 |
|
| 765 |
|
| 766 | <td class="type">
|
| 767 |
|
| 768 |
|
| 769 | <span class="param-type">Integer</span>
|
| 770 |
|
| 771 |
|
| 772 |
|
| 773 | </td>
|
| 774 |
|
| 775 |
|
| 776 | <td class="attributes">
|
| 777 |
|
| 778 | <optional><br>
|
| 779 |
|
| 780 |
|
| 781 |
|
| 782 |
|
| 783 |
|
| 784 | </td>
|
| 785 |
|
| 786 |
|
| 787 |
|
| 788 |
|
| 789 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 790 | 0 to not retry. Default 60.</p></td>
|
| 791 | </tr>
|
| 792 |
|
| 793 |
|
| 794 |
|
| 795 | <tr>
|
| 796 |
|
| 797 | <td class="name"><code>retryIntervalMs</code></td>
|
| 798 |
|
| 799 |
|
| 800 | <td class="type">
|
| 801 |
|
| 802 |
|
| 803 | <span class="param-type">Integer</span>
|
| 804 |
|
| 805 |
|
| 806 |
|
| 807 | </td>
|
| 808 |
|
| 809 |
|
| 810 | <td class="attributes">
|
| 811 |
|
| 812 | <optional><br>
|
| 813 |
|
| 814 |
|
| 815 |
|
| 816 |
|
| 817 |
|
| 818 | </td>
|
| 819 |
|
| 820 |
|
| 821 |
|
| 822 |
|
| 823 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 824 | </tr>
|
| 825 |
|
| 826 |
|
| 827 | </tbody>
|
| 828 | </table>
|
| 829 |
|
| 830 | </td>
|
| 831 | </tr>
|
| 832 |
|
| 833 |
|
| 834 |
|
| 835 | <tr>
|
| 836 |
|
| 837 | <td class="name"><code>options</code></td>
|
| 838 |
|
| 839 |
|
| 840 | <td class="type">
|
| 841 |
|
| 842 |
|
| 843 | <span class="param-type">Object</span>
|
| 844 |
|
| 845 |
|
| 846 |
|
| 847 | </td>
|
| 848 |
|
| 849 |
|
| 850 | <td class="attributes">
|
| 851 |
|
| 852 | <optional><br>
|
| 853 |
|
| 854 |
|
| 855 |
|
| 856 |
|
| 857 |
|
| 858 | </td>
|
| 859 |
|
| 860 |
|
| 861 |
|
| 862 |
|
| 863 | <td class="description last"><p>Options for this method.</p>
|
| 864 | <h6>Properties</h6>
|
| 865 |
|
| 866 |
|
| 867 | <table class="params">
|
| 868 | <thead>
|
| 869 | <tr>
|
| 870 |
|
| 871 | <th>Name</th>
|
| 872 |
|
| 873 |
|
| 874 | <th>Type</th>
|
| 875 |
|
| 876 |
|
| 877 | <th>Attributes</th>
|
| 878 |
|
| 879 |
|
| 880 |
|
| 881 |
|
| 882 | <th class="last">Description</th>
|
| 883 | </tr>
|
| 884 | </thead>
|
| 885 |
|
| 886 | <tbody>
|
| 887 |
|
| 888 |
|
| 889 | <tr>
|
| 890 |
|
| 891 | <td class="name"><code>silent</code></td>
|
| 892 |
|
| 893 |
|
| 894 | <td class="type">
|
| 895 |
|
| 896 |
|
| 897 | <span class="param-type">Boolen</span>
|
| 898 |
|
| 899 |
|
| 900 |
|
| 901 | </td>
|
| 902 |
|
| 903 |
|
| 904 | <td class="attributes">
|
| 905 |
|
| 906 | <optional><br>
|
| 907 |
|
| 908 |
|
| 909 |
|
| 910 |
|
| 911 |
|
| 912 | </td>
|
| 913 |
|
| 914 |
|
| 915 |
|
| 916 |
|
| 917 | <td class="description last"><p>Do not log any info (for requests/repsonses that
|
| 918 | may contain sensitive information).</p></td>
|
| 919 | </tr>
|
| 920 |
|
| 921 |
|
| 922 | </tbody>
|
| 923 | </table>
|
| 924 |
|
| 925 | </td>
|
| 926 | </tr>
|
| 927 |
|
| 928 |
|
| 929 | </tbody>
|
| 930 | </table>
|
| 931 |
|
| 932 |
|
| 933 |
|
| 934 |
|
| 935 |
|
| 936 |
|
| 937 | <dl class="details">
|
| 938 |
|
| 939 |
|
| 940 |
|
| 941 |
|
| 942 |
|
| 943 |
|
| 944 |
|
| 945 |
|
| 946 |
|
| 947 |
|
| 948 |
|
| 949 |
|
| 950 |
|
| 951 |
|
| 952 |
|
| 953 |
|
| 954 |
|
| 955 |
|
| 956 |
|
| 957 |
|
| 958 |
|
| 959 |
|
| 960 |
|
| 961 |
|
| 962 |
|
| 963 |
|
| 964 |
|
| 965 |
|
| 966 |
|
| 967 |
|
| 968 |
|
| 969 |
|
| 970 | </dl>
|
| 971 |
|
| 972 |
|
| 973 |
|
| 974 |
|
| 975 |
|
| 976 |
|
| 977 |
|
| 978 |
|
| 979 |
|
| 980 |
|
| 981 |
|
| 982 |
|
| 983 |
|
| 984 | <h5>Returns:</h5>
|
| 985 |
|
| 986 |
|
| 987 | <div class="param-desc">
|
| 988 | <p>A promise which is resolved when the request is complete
|
| 989 | or rejected if an error occurs.</p>
|
| 990 | </div>
|
| 991 |
|
| 992 |
|
| 993 |
|
| 994 | <dl>
|
| 995 | <dt>
|
| 996 | Type
|
| 997 | </dt>
|
| 998 | <dd>
|
| 999 |
|
| 1000 | <span class="param-type">Promise</span>
|
| 1001 |
|
| 1002 |
|
| 1003 | </dd>
|
| 1004 | </dl>
|
| 1005 |
|
| 1006 |
|
| 1007 |
|
| 1008 |
|
| 1009 |
|
| 1010 |
|
| 1011 |
|
| 1012 |
|
| 1013 |
|
| 1014 |
|
| 1015 |
|
| 1016 |
|
| 1017 |
|
| 1018 | <h4 class="name" id="createFolder"><span class="type-signature"></span>createFolder<span class="signature">(folder, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 1019 |
|
| 1020 |
|
| 1021 |
|
| 1022 |
|
| 1023 |
|
| 1024 |
|
| 1025 | <div class="description">
|
| 1026 | <p>Creates a folder if it does not exists</p>
|
| 1027 | </div>
|
| 1028 |
|
| 1029 |
|
| 1030 |
|
| 1031 |
|
| 1032 |
|
| 1033 |
|
| 1034 |
|
| 1035 |
|
| 1036 |
|
| 1037 | <h5>Parameters:</h5>
|
| 1038 |
|
| 1039 |
|
| 1040 | <table class="params">
|
| 1041 | <thead>
|
| 1042 | <tr>
|
| 1043 |
|
| 1044 | <th>Name</th>
|
| 1045 |
|
| 1046 |
|
| 1047 | <th>Type</th>
|
| 1048 |
|
| 1049 |
|
| 1050 | <th>Attributes</th>
|
| 1051 |
|
| 1052 |
|
| 1053 |
|
| 1054 |
|
| 1055 | <th class="last">Description</th>
|
| 1056 | </tr>
|
| 1057 | </thead>
|
| 1058 |
|
| 1059 | <tbody>
|
| 1060 |
|
| 1061 |
|
| 1062 | <tr>
|
| 1063 |
|
| 1064 | <td class="name"><code>folder</code></td>
|
| 1065 |
|
| 1066 |
|
| 1067 | <td class="type">
|
| 1068 |
|
| 1069 |
|
| 1070 | <span class="param-type">String</span>
|
| 1071 |
|
| 1072 |
|
| 1073 |
|
| 1074 | </td>
|
| 1075 |
|
| 1076 |
|
| 1077 | <td class="attributes">
|
| 1078 |
|
| 1079 |
|
| 1080 |
|
| 1081 |
|
| 1082 |
|
| 1083 | </td>
|
| 1084 |
|
| 1085 |
|
| 1086 |
|
| 1087 |
|
| 1088 | <td class="description last"><p>Name of folder</p></td>
|
| 1089 | </tr>
|
| 1090 |
|
| 1091 |
|
| 1092 |
|
| 1093 | <tr>
|
| 1094 |
|
| 1095 | <td class="name"><code>options</code></td>
|
| 1096 |
|
| 1097 |
|
| 1098 | <td class="type">
|
| 1099 |
|
| 1100 |
|
| 1101 | <span class="param-type">Object</span>
|
| 1102 |
|
| 1103 |
|
| 1104 |
|
| 1105 | </td>
|
| 1106 |
|
| 1107 |
|
| 1108 | <td class="attributes">
|
| 1109 |
|
| 1110 | <optional><br>
|
| 1111 |
|
| 1112 |
|
| 1113 |
|
| 1114 |
|
| 1115 |
|
| 1116 | </td>
|
| 1117 |
|
| 1118 |
|
| 1119 |
|
| 1120 |
|
| 1121 | <td class="description last"><p>Optional parameters</p>
|
| 1122 | <h6>Properties</h6>
|
| 1123 |
|
| 1124 |
|
| 1125 | <table class="params">
|
| 1126 | <thead>
|
| 1127 | <tr>
|
| 1128 |
|
| 1129 | <th>Name</th>
|
| 1130 |
|
| 1131 |
|
| 1132 | <th>Type</th>
|
| 1133 |
|
| 1134 |
|
| 1135 | <th>Attributes</th>
|
| 1136 |
|
| 1137 |
|
| 1138 |
|
| 1139 |
|
| 1140 | <th class="last">Description</th>
|
| 1141 | </tr>
|
| 1142 | </thead>
|
| 1143 |
|
| 1144 | <tbody>
|
| 1145 |
|
| 1146 |
|
| 1147 | <tr>
|
| 1148 |
|
| 1149 | <td class="name"><code>subPath</code></td>
|
| 1150 |
|
| 1151 |
|
| 1152 | <td class="type">
|
| 1153 |
|
| 1154 |
|
| 1155 | <span class="param-type">String</span>
|
| 1156 |
|
| 1157 |
|
| 1158 |
|
| 1159 | </td>
|
| 1160 |
|
| 1161 |
|
| 1162 | <td class="attributes">
|
| 1163 |
|
| 1164 | <optional><br>
|
| 1165 |
|
| 1166 |
|
| 1167 |
|
| 1168 |
|
| 1169 |
|
| 1170 | </td>
|
| 1171 |
|
| 1172 |
|
| 1173 |
|
| 1174 |
|
| 1175 | <td class="description last"><p>The folder subPath. Use '/' for top level folders.
|
| 1176 | Default '/Common'</p></td>
|
| 1177 | </tr>
|
| 1178 |
|
| 1179 |
|
| 1180 |
|
| 1181 | <tr>
|
| 1182 |
|
| 1183 | <td class="name"><code>deviceGroup</code></td>
|
| 1184 |
|
| 1185 |
|
| 1186 | <td class="type">
|
| 1187 |
|
| 1188 |
|
| 1189 | <span class="param-type">String</span>
|
| 1190 |
|
| 1191 |
|
| 1192 |
|
| 1193 | </td>
|
| 1194 |
|
| 1195 |
|
| 1196 | <td class="attributes">
|
| 1197 |
|
| 1198 | <optional><br>
|
| 1199 |
|
| 1200 |
|
| 1201 |
|
| 1202 |
|
| 1203 |
|
| 1204 | </td>
|
| 1205 |
|
| 1206 |
|
| 1207 |
|
| 1208 |
|
| 1209 | <td class="description last"><p>Device group for folder. Default 'none'</p></td>
|
| 1210 | </tr>
|
| 1211 |
|
| 1212 |
|
| 1213 |
|
| 1214 | <tr>
|
| 1215 |
|
| 1216 | <td class="name"><code>trafficGroup</code></td>
|
| 1217 |
|
| 1218 |
|
| 1219 | <td class="type">
|
| 1220 |
|
| 1221 |
|
| 1222 | <span class="param-type">String</span>
|
| 1223 |
|
| 1224 |
|
| 1225 |
|
| 1226 | </td>
|
| 1227 |
|
| 1228 |
|
| 1229 | <td class="attributes">
|
| 1230 |
|
| 1231 | <optional><br>
|
| 1232 |
|
| 1233 |
|
| 1234 |
|
| 1235 |
|
| 1236 |
|
| 1237 | </td>
|
| 1238 |
|
| 1239 |
|
| 1240 |
|
| 1241 |
|
| 1242 | <td class="description last"><p>Traffic group for folder. Default 'none'</p></td>
|
| 1243 | </tr>
|
| 1244 |
|
| 1245 |
|
| 1246 | </tbody>
|
| 1247 | </table>
|
| 1248 |
|
| 1249 | </td>
|
| 1250 | </tr>
|
| 1251 |
|
| 1252 |
|
| 1253 | </tbody>
|
| 1254 | </table>
|
| 1255 |
|
| 1256 |
|
| 1257 |
|
| 1258 |
|
| 1259 |
|
| 1260 |
|
| 1261 | <dl class="details">
|
| 1262 |
|
| 1263 |
|
| 1264 |
|
| 1265 |
|
| 1266 |
|
| 1267 |
|
| 1268 |
|
| 1269 |
|
| 1270 |
|
| 1271 |
|
| 1272 |
|
| 1273 |
|
| 1274 |
|
| 1275 |
|
| 1276 |
|
| 1277 |
|
| 1278 |
|
| 1279 |
|
| 1280 |
|
| 1281 |
|
| 1282 |
|
| 1283 |
|
| 1284 |
|
| 1285 |
|
| 1286 |
|
| 1287 |
|
| 1288 |
|
| 1289 |
|
| 1290 |
|
| 1291 |
|
| 1292 |
|
| 1293 |
|
| 1294 | </dl>
|
| 1295 |
|
| 1296 |
|
| 1297 |
|
| 1298 |
|
| 1299 |
|
| 1300 |
|
| 1301 |
|
| 1302 |
|
| 1303 |
|
| 1304 |
|
| 1305 |
|
| 1306 |
|
| 1307 |
|
| 1308 | <h5>Returns:</h5>
|
| 1309 |
|
| 1310 |
|
| 1311 | <div class="param-desc">
|
| 1312 | <p>A promise which is resolved when the request is complete
|
| 1313 | or rejected if an error occurs.</p>
|
| 1314 | </div>
|
| 1315 |
|
| 1316 |
|
| 1317 |
|
| 1318 | <dl>
|
| 1319 | <dt>
|
| 1320 | Type
|
| 1321 | </dt>
|
| 1322 | <dd>
|
| 1323 |
|
| 1324 | <span class="param-type">Promise</span>
|
| 1325 |
|
| 1326 |
|
| 1327 | </dd>
|
| 1328 | </dl>
|
| 1329 |
|
| 1330 |
|
| 1331 |
|
| 1332 |
|
| 1333 |
|
| 1334 |
|
| 1335 |
|
| 1336 |
|
| 1337 |
|
| 1338 |
|
| 1339 |
|
| 1340 |
|
| 1341 |
|
| 1342 | <h4 class="name" id="createOrModify"><span class="type-signature"></span>createOrModify<span class="signature">(path, body, iControlOptions<span class="signature-attributes">opt</span>, retryOptions<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 1343 |
|
| 1344 |
|
| 1345 |
|
| 1346 |
|
| 1347 |
|
| 1348 |
|
| 1349 | <div class="description">
|
| 1350 | <p>Creates or modifies an object</p>
|
| 1351 | </div>
|
| 1352 |
|
| 1353 |
|
| 1354 |
|
| 1355 |
|
| 1356 |
|
| 1357 |
|
| 1358 |
|
| 1359 |
|
| 1360 |
|
| 1361 | <h5>Parameters:</h5>
|
| 1362 |
|
| 1363 |
|
| 1364 | <table class="params">
|
| 1365 | <thead>
|
| 1366 | <tr>
|
| 1367 |
|
| 1368 | <th>Name</th>
|
| 1369 |
|
| 1370 |
|
| 1371 | <th>Type</th>
|
| 1372 |
|
| 1373 |
|
| 1374 | <th>Attributes</th>
|
| 1375 |
|
| 1376 |
|
| 1377 |
|
| 1378 |
|
| 1379 | <th class="last">Description</th>
|
| 1380 | </tr>
|
| 1381 | </thead>
|
| 1382 |
|
| 1383 | <tbody>
|
| 1384 |
|
| 1385 |
|
| 1386 | <tr>
|
| 1387 |
|
| 1388 | <td class="name"><code>path</code></td>
|
| 1389 |
|
| 1390 |
|
| 1391 | <td class="type">
|
| 1392 |
|
| 1393 |
|
| 1394 | <span class="param-type">String</span>
|
| 1395 |
|
| 1396 |
|
| 1397 |
|
| 1398 | </td>
|
| 1399 |
|
| 1400 |
|
| 1401 | <td class="attributes">
|
| 1402 |
|
| 1403 |
|
| 1404 |
|
| 1405 |
|
| 1406 |
|
| 1407 | </td>
|
| 1408 |
|
| 1409 |
|
| 1410 |
|
| 1411 |
|
| 1412 | <td class="description last"><p>The path to patch.</p></td>
|
| 1413 | </tr>
|
| 1414 |
|
| 1415 |
|
| 1416 |
|
| 1417 | <tr>
|
| 1418 |
|
| 1419 | <td class="name"><code>body</code></td>
|
| 1420 |
|
| 1421 |
|
| 1422 | <td class="type">
|
| 1423 |
|
| 1424 |
|
| 1425 | <span class="param-type">Object</span>
|
| 1426 |
|
| 1427 |
|
| 1428 |
|
| 1429 | </td>
|
| 1430 |
|
| 1431 |
|
| 1432 | <td class="attributes">
|
| 1433 |
|
| 1434 |
|
| 1435 |
|
| 1436 |
|
| 1437 |
|
| 1438 | </td>
|
| 1439 |
|
| 1440 |
|
| 1441 |
|
| 1442 |
|
| 1443 | <td class="description last"><p>The body for the patch request.</p>
|
| 1444 | <h6>Properties</h6>
|
| 1445 |
|
| 1446 |
|
| 1447 | <table class="params">
|
| 1448 | <thead>
|
| 1449 | <tr>
|
| 1450 |
|
| 1451 | <th>Name</th>
|
| 1452 |
|
| 1453 |
|
| 1454 | <th>Type</th>
|
| 1455 |
|
| 1456 |
|
| 1457 |
|
| 1458 |
|
| 1459 |
|
| 1460 | <th class="last">Description</th>
|
| 1461 | </tr>
|
| 1462 | </thead>
|
| 1463 |
|
| 1464 | <tbody>
|
| 1465 |
|
| 1466 |
|
| 1467 | <tr>
|
| 1468 |
|
| 1469 | <td class="name"><code>name</code></td>
|
| 1470 |
|
| 1471 |
|
| 1472 | <td class="type">
|
| 1473 |
|
| 1474 |
|
| 1475 | <span class="param-type">String</span>
|
| 1476 |
|
| 1477 |
|
| 1478 |
|
| 1479 | </td>
|
| 1480 |
|
| 1481 |
|
| 1482 |
|
| 1483 |
|
| 1484 |
|
| 1485 | <td class="description last"><p>The name used to determine if the object exists.</p></td>
|
| 1486 | </tr>
|
| 1487 |
|
| 1488 |
|
| 1489 | </tbody>
|
| 1490 | </table>
|
| 1491 |
|
| 1492 | </td>
|
| 1493 | </tr>
|
| 1494 |
|
| 1495 |
|
| 1496 |
|
| 1497 | <tr>
|
| 1498 |
|
| 1499 | <td class="name"><code>iControlOptions</code></td>
|
| 1500 |
|
| 1501 |
|
| 1502 | <td class="type">
|
| 1503 |
|
| 1504 |
|
| 1505 | <span class="param-type">Object</span>
|
| 1506 |
|
| 1507 |
|
| 1508 |
|
| 1509 | </td>
|
| 1510 |
|
| 1511 |
|
| 1512 | <td class="attributes">
|
| 1513 |
|
| 1514 | <optional><br>
|
| 1515 |
|
| 1516 |
|
| 1517 |
|
| 1518 |
|
| 1519 |
|
| 1520 | </td>
|
| 1521 |
|
| 1522 |
|
| 1523 |
|
| 1524 |
|
| 1525 | <td class="description last"><p>Options for IControl.</p></td>
|
| 1526 | </tr>
|
| 1527 |
|
| 1528 |
|
| 1529 |
|
| 1530 | <tr>
|
| 1531 |
|
| 1532 | <td class="name"><code>retryOptions</code></td>
|
| 1533 |
|
| 1534 |
|
| 1535 | <td class="type">
|
| 1536 |
|
| 1537 |
|
| 1538 | <span class="param-type">Object</span>
|
| 1539 |
|
| 1540 |
|
| 1541 |
|
| 1542 | </td>
|
| 1543 |
|
| 1544 |
|
| 1545 | <td class="attributes">
|
| 1546 |
|
| 1547 | <optional><br>
|
| 1548 |
|
| 1549 |
|
| 1550 |
|
| 1551 |
|
| 1552 |
|
| 1553 | </td>
|
| 1554 |
|
| 1555 |
|
| 1556 |
|
| 1557 |
|
| 1558 | <td class="description last"><p>Options for retrying the request.</p>
|
| 1559 | <h6>Properties</h6>
|
| 1560 |
|
| 1561 |
|
| 1562 | <table class="params">
|
| 1563 | <thead>
|
| 1564 | <tr>
|
| 1565 |
|
| 1566 | <th>Name</th>
|
| 1567 |
|
| 1568 |
|
| 1569 | <th>Type</th>
|
| 1570 |
|
| 1571 |
|
| 1572 | <th>Attributes</th>
|
| 1573 |
|
| 1574 |
|
| 1575 |
|
| 1576 |
|
| 1577 | <th class="last">Description</th>
|
| 1578 | </tr>
|
| 1579 | </thead>
|
| 1580 |
|
| 1581 | <tbody>
|
| 1582 |
|
| 1583 |
|
| 1584 | <tr>
|
| 1585 |
|
| 1586 | <td class="name"><code>maxRetries</code></td>
|
| 1587 |
|
| 1588 |
|
| 1589 | <td class="type">
|
| 1590 |
|
| 1591 |
|
| 1592 | <span class="param-type">Integer</span>
|
| 1593 |
|
| 1594 |
|
| 1595 |
|
| 1596 | </td>
|
| 1597 |
|
| 1598 |
|
| 1599 | <td class="attributes">
|
| 1600 |
|
| 1601 | <optional><br>
|
| 1602 |
|
| 1603 |
|
| 1604 |
|
| 1605 |
|
| 1606 |
|
| 1607 | </td>
|
| 1608 |
|
| 1609 |
|
| 1610 |
|
| 1611 |
|
| 1612 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 1613 | 0 to not retry. Default 60.</p></td>
|
| 1614 | </tr>
|
| 1615 |
|
| 1616 |
|
| 1617 |
|
| 1618 | <tr>
|
| 1619 |
|
| 1620 | <td class="name"><code>retryIntervalMs</code></td>
|
| 1621 |
|
| 1622 |
|
| 1623 | <td class="type">
|
| 1624 |
|
| 1625 |
|
| 1626 | <span class="param-type">Integer</span>
|
| 1627 |
|
| 1628 |
|
| 1629 |
|
| 1630 | </td>
|
| 1631 |
|
| 1632 |
|
| 1633 | <td class="attributes">
|
| 1634 |
|
| 1635 | <optional><br>
|
| 1636 |
|
| 1637 |
|
| 1638 |
|
| 1639 |
|
| 1640 |
|
| 1641 | </td>
|
| 1642 |
|
| 1643 |
|
| 1644 |
|
| 1645 |
|
| 1646 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 1647 | </tr>
|
| 1648 |
|
| 1649 |
|
| 1650 | </tbody>
|
| 1651 | </table>
|
| 1652 |
|
| 1653 | </td>
|
| 1654 | </tr>
|
| 1655 |
|
| 1656 |
|
| 1657 |
|
| 1658 | <tr>
|
| 1659 |
|
| 1660 | <td class="name"><code>options</code></td>
|
| 1661 |
|
| 1662 |
|
| 1663 | <td class="type">
|
| 1664 |
|
| 1665 |
|
| 1666 | <span class="param-type">Object</span>
|
| 1667 |
|
| 1668 |
|
| 1669 |
|
| 1670 | </td>
|
| 1671 |
|
| 1672 |
|
| 1673 | <td class="attributes">
|
| 1674 |
|
| 1675 | <optional><br>
|
| 1676 |
|
| 1677 |
|
| 1678 |
|
| 1679 |
|
| 1680 |
|
| 1681 | </td>
|
| 1682 |
|
| 1683 |
|
| 1684 |
|
| 1685 |
|
| 1686 | <td class="description last"><p>Options for this method.</p>
|
| 1687 | <h6>Properties</h6>
|
| 1688 |
|
| 1689 |
|
| 1690 | <table class="params">
|
| 1691 | <thead>
|
| 1692 | <tr>
|
| 1693 |
|
| 1694 | <th>Name</th>
|
| 1695 |
|
| 1696 |
|
| 1697 | <th>Type</th>
|
| 1698 |
|
| 1699 |
|
| 1700 | <th>Attributes</th>
|
| 1701 |
|
| 1702 |
|
| 1703 |
|
| 1704 |
|
| 1705 | <th class="last">Description</th>
|
| 1706 | </tr>
|
| 1707 | </thead>
|
| 1708 |
|
| 1709 | <tbody>
|
| 1710 |
|
| 1711 |
|
| 1712 | <tr>
|
| 1713 |
|
| 1714 | <td class="name"><code>silent</code></td>
|
| 1715 |
|
| 1716 |
|
| 1717 | <td class="type">
|
| 1718 |
|
| 1719 |
|
| 1720 | <span class="param-type">Boolen</span>
|
| 1721 |
|
| 1722 |
|
| 1723 |
|
| 1724 | </td>
|
| 1725 |
|
| 1726 |
|
| 1727 | <td class="attributes">
|
| 1728 |
|
| 1729 | <optional><br>
|
| 1730 |
|
| 1731 |
|
| 1732 |
|
| 1733 |
|
| 1734 |
|
| 1735 | </td>
|
| 1736 |
|
| 1737 |
|
| 1738 |
|
| 1739 |
|
| 1740 | <td class="description last"><p>Do not log any info (for requests/repsonses that
|
| 1741 | may contain sensitive information).</p></td>
|
| 1742 | </tr>
|
| 1743 |
|
| 1744 |
|
| 1745 | </tbody>
|
| 1746 | </table>
|
| 1747 |
|
| 1748 | </td>
|
| 1749 | </tr>
|
| 1750 |
|
| 1751 |
|
| 1752 | </tbody>
|
| 1753 | </table>
|
| 1754 |
|
| 1755 |
|
| 1756 |
|
| 1757 |
|
| 1758 |
|
| 1759 |
|
| 1760 | <dl class="details">
|
| 1761 |
|
| 1762 |
|
| 1763 |
|
| 1764 |
|
| 1765 |
|
| 1766 |
|
| 1767 |
|
| 1768 |
|
| 1769 |
|
| 1770 |
|
| 1771 |
|
| 1772 |
|
| 1773 |
|
| 1774 |
|
| 1775 |
|
| 1776 |
|
| 1777 |
|
| 1778 |
|
| 1779 |
|
| 1780 |
|
| 1781 |
|
| 1782 |
|
| 1783 |
|
| 1784 |
|
| 1785 |
|
| 1786 |
|
| 1787 |
|
| 1788 |
|
| 1789 |
|
| 1790 |
|
| 1791 |
|
| 1792 |
|
| 1793 | </dl>
|
| 1794 |
|
| 1795 |
|
| 1796 |
|
| 1797 |
|
| 1798 |
|
| 1799 |
|
| 1800 |
|
| 1801 |
|
| 1802 |
|
| 1803 |
|
| 1804 |
|
| 1805 |
|
| 1806 |
|
| 1807 | <h5>Returns:</h5>
|
| 1808 |
|
| 1809 |
|
| 1810 | <div class="param-desc">
|
| 1811 | <p>A promise which is resolved when the request is complete
|
| 1812 | or rejected if an error occurs.</p>
|
| 1813 | </div>
|
| 1814 |
|
| 1815 |
|
| 1816 |
|
| 1817 | <dl>
|
| 1818 | <dt>
|
| 1819 | Type
|
| 1820 | </dt>
|
| 1821 | <dd>
|
| 1822 |
|
| 1823 | <span class="param-type">Promise</span>
|
| 1824 |
|
| 1825 |
|
| 1826 | </dd>
|
| 1827 | </dl>
|
| 1828 |
|
| 1829 |
|
| 1830 |
|
| 1831 |
|
| 1832 |
|
| 1833 |
|
| 1834 |
|
| 1835 |
|
| 1836 |
|
| 1837 |
|
| 1838 |
|
| 1839 |
|
| 1840 |
|
| 1841 | <h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(path, body, iControlOptions<span class="signature-attributes">opt</span>, retryOptions<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 1842 |
|
| 1843 |
|
| 1844 |
|
| 1845 |
|
| 1846 |
|
| 1847 |
|
| 1848 | <div class="description">
|
| 1849 | <p>Submits a delete (DELETE) request</p>
|
| 1850 | </div>
|
| 1851 |
|
| 1852 |
|
| 1853 |
|
| 1854 |
|
| 1855 |
|
| 1856 |
|
| 1857 |
|
| 1858 |
|
| 1859 |
|
| 1860 | <h5>Parameters:</h5>
|
| 1861 |
|
| 1862 |
|
| 1863 | <table class="params">
|
| 1864 | <thead>
|
| 1865 | <tr>
|
| 1866 |
|
| 1867 | <th>Name</th>
|
| 1868 |
|
| 1869 |
|
| 1870 | <th>Type</th>
|
| 1871 |
|
| 1872 |
|
| 1873 | <th>Attributes</th>
|
| 1874 |
|
| 1875 |
|
| 1876 |
|
| 1877 |
|
| 1878 | <th class="last">Description</th>
|
| 1879 | </tr>
|
| 1880 | </thead>
|
| 1881 |
|
| 1882 | <tbody>
|
| 1883 |
|
| 1884 |
|
| 1885 | <tr>
|
| 1886 |
|
| 1887 | <td class="name"><code>path</code></td>
|
| 1888 |
|
| 1889 |
|
| 1890 | <td class="type">
|
| 1891 |
|
| 1892 |
|
| 1893 | <span class="param-type">String</span>
|
| 1894 |
|
| 1895 |
|
| 1896 |
|
| 1897 | </td>
|
| 1898 |
|
| 1899 |
|
| 1900 | <td class="attributes">
|
| 1901 |
|
| 1902 |
|
| 1903 |
|
| 1904 |
|
| 1905 |
|
| 1906 | </td>
|
| 1907 |
|
| 1908 |
|
| 1909 |
|
| 1910 |
|
| 1911 | <td class="description last"><p>The path to delete.</p></td>
|
| 1912 | </tr>
|
| 1913 |
|
| 1914 |
|
| 1915 |
|
| 1916 | <tr>
|
| 1917 |
|
| 1918 | <td class="name"><code>body</code></td>
|
| 1919 |
|
| 1920 |
|
| 1921 | <td class="type">
|
| 1922 |
|
| 1923 |
|
| 1924 | <span class="param-type">Object</span>
|
| 1925 |
|
| 1926 |
|
| 1927 |
|
| 1928 | </td>
|
| 1929 |
|
| 1930 |
|
| 1931 | <td class="attributes">
|
| 1932 |
|
| 1933 |
|
| 1934 |
|
| 1935 |
|
| 1936 |
|
| 1937 | </td>
|
| 1938 |
|
| 1939 |
|
| 1940 |
|
| 1941 |
|
| 1942 | <td class="description last"><p>The body for the delete request.</p></td>
|
| 1943 | </tr>
|
| 1944 |
|
| 1945 |
|
| 1946 |
|
| 1947 | <tr>
|
| 1948 |
|
| 1949 | <td class="name"><code>iControlOptions</code></td>
|
| 1950 |
|
| 1951 |
|
| 1952 | <td class="type">
|
| 1953 |
|
| 1954 |
|
| 1955 | <span class="param-type">Object</span>
|
| 1956 |
|
| 1957 |
|
| 1958 |
|
| 1959 | </td>
|
| 1960 |
|
| 1961 |
|
| 1962 | <td class="attributes">
|
| 1963 |
|
| 1964 | <optional><br>
|
| 1965 |
|
| 1966 |
|
| 1967 |
|
| 1968 |
|
| 1969 |
|
| 1970 | </td>
|
| 1971 |
|
| 1972 |
|
| 1973 |
|
| 1974 |
|
| 1975 | <td class="description last"><p>Options for IControl.</p></td>
|
| 1976 | </tr>
|
| 1977 |
|
| 1978 |
|
| 1979 |
|
| 1980 | <tr>
|
| 1981 |
|
| 1982 | <td class="name"><code>retryOptions</code></td>
|
| 1983 |
|
| 1984 |
|
| 1985 | <td class="type">
|
| 1986 |
|
| 1987 |
|
| 1988 | <span class="param-type">Object</span>
|
| 1989 |
|
| 1990 |
|
| 1991 |
|
| 1992 | </td>
|
| 1993 |
|
| 1994 |
|
| 1995 | <td class="attributes">
|
| 1996 |
|
| 1997 | <optional><br>
|
| 1998 |
|
| 1999 |
|
| 2000 |
|
| 2001 |
|
| 2002 |
|
| 2003 | </td>
|
| 2004 |
|
| 2005 |
|
| 2006 |
|
| 2007 |
|
| 2008 | <td class="description last"><p>Options for retrying the request.</p>
|
| 2009 | <h6>Properties</h6>
|
| 2010 |
|
| 2011 |
|
| 2012 | <table class="params">
|
| 2013 | <thead>
|
| 2014 | <tr>
|
| 2015 |
|
| 2016 | <th>Name</th>
|
| 2017 |
|
| 2018 |
|
| 2019 | <th>Type</th>
|
| 2020 |
|
| 2021 |
|
| 2022 | <th>Attributes</th>
|
| 2023 |
|
| 2024 |
|
| 2025 |
|
| 2026 |
|
| 2027 | <th class="last">Description</th>
|
| 2028 | </tr>
|
| 2029 | </thead>
|
| 2030 |
|
| 2031 | <tbody>
|
| 2032 |
|
| 2033 |
|
| 2034 | <tr>
|
| 2035 |
|
| 2036 | <td class="name"><code>maxRetries</code></td>
|
| 2037 |
|
| 2038 |
|
| 2039 | <td class="type">
|
| 2040 |
|
| 2041 |
|
| 2042 | <span class="param-type">Integer</span>
|
| 2043 |
|
| 2044 |
|
| 2045 |
|
| 2046 | </td>
|
| 2047 |
|
| 2048 |
|
| 2049 | <td class="attributes">
|
| 2050 |
|
| 2051 | <optional><br>
|
| 2052 |
|
| 2053 |
|
| 2054 |
|
| 2055 |
|
| 2056 |
|
| 2057 | </td>
|
| 2058 |
|
| 2059 |
|
| 2060 |
|
| 2061 |
|
| 2062 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 2063 | 0 to not retry. Default 60.</p></td>
|
| 2064 | </tr>
|
| 2065 |
|
| 2066 |
|
| 2067 |
|
| 2068 | <tr>
|
| 2069 |
|
| 2070 | <td class="name"><code>retryIntervalMs</code></td>
|
| 2071 |
|
| 2072 |
|
| 2073 | <td class="type">
|
| 2074 |
|
| 2075 |
|
| 2076 | <span class="param-type">Integer</span>
|
| 2077 |
|
| 2078 |
|
| 2079 |
|
| 2080 | </td>
|
| 2081 |
|
| 2082 |
|
| 2083 | <td class="attributes">
|
| 2084 |
|
| 2085 | <optional><br>
|
| 2086 |
|
| 2087 |
|
| 2088 |
|
| 2089 |
|
| 2090 |
|
| 2091 | </td>
|
| 2092 |
|
| 2093 |
|
| 2094 |
|
| 2095 |
|
| 2096 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 2097 | </tr>
|
| 2098 |
|
| 2099 |
|
| 2100 | </tbody>
|
| 2101 | </table>
|
| 2102 |
|
| 2103 | </td>
|
| 2104 | </tr>
|
| 2105 |
|
| 2106 |
|
| 2107 |
|
| 2108 | <tr>
|
| 2109 |
|
| 2110 | <td class="name"><code>options</code></td>
|
| 2111 |
|
| 2112 |
|
| 2113 | <td class="type">
|
| 2114 |
|
| 2115 |
|
| 2116 | <span class="param-type">Object</span>
|
| 2117 |
|
| 2118 |
|
| 2119 |
|
| 2120 | </td>
|
| 2121 |
|
| 2122 |
|
| 2123 | <td class="attributes">
|
| 2124 |
|
| 2125 | <optional><br>
|
| 2126 |
|
| 2127 |
|
| 2128 |
|
| 2129 |
|
| 2130 |
|
| 2131 | </td>
|
| 2132 |
|
| 2133 |
|
| 2134 |
|
| 2135 |
|
| 2136 | <td class="description last"><p>Options for this method.</p>
|
| 2137 | <h6>Properties</h6>
|
| 2138 |
|
| 2139 |
|
| 2140 | <table class="params">
|
| 2141 | <thead>
|
| 2142 | <tr>
|
| 2143 |
|
| 2144 | <th>Name</th>
|
| 2145 |
|
| 2146 |
|
| 2147 | <th>Type</th>
|
| 2148 |
|
| 2149 |
|
| 2150 | <th>Attributes</th>
|
| 2151 |
|
| 2152 |
|
| 2153 |
|
| 2154 |
|
| 2155 | <th class="last">Description</th>
|
| 2156 | </tr>
|
| 2157 | </thead>
|
| 2158 |
|
| 2159 | <tbody>
|
| 2160 |
|
| 2161 |
|
| 2162 | <tr>
|
| 2163 |
|
| 2164 | <td class="name"><code>silent</code></td>
|
| 2165 |
|
| 2166 |
|
| 2167 | <td class="type">
|
| 2168 |
|
| 2169 |
|
| 2170 | <span class="param-type">Boolen</span>
|
| 2171 |
|
| 2172 |
|
| 2173 |
|
| 2174 | </td>
|
| 2175 |
|
| 2176 |
|
| 2177 | <td class="attributes">
|
| 2178 |
|
| 2179 | <optional><br>
|
| 2180 |
|
| 2181 |
|
| 2182 |
|
| 2183 |
|
| 2184 |
|
| 2185 | </td>
|
| 2186 |
|
| 2187 |
|
| 2188 |
|
| 2189 |
|
| 2190 | <td class="description last"><p>Do not log any info (for requests/repsonses that
|
| 2191 | may contain sensitive information).</p></td>
|
| 2192 | </tr>
|
| 2193 |
|
| 2194 |
|
| 2195 | </tbody>
|
| 2196 | </table>
|
| 2197 |
|
| 2198 | </td>
|
| 2199 | </tr>
|
| 2200 |
|
| 2201 |
|
| 2202 | </tbody>
|
| 2203 | </table>
|
| 2204 |
|
| 2205 |
|
| 2206 |
|
| 2207 |
|
| 2208 |
|
| 2209 |
|
| 2210 | <dl class="details">
|
| 2211 |
|
| 2212 |
|
| 2213 |
|
| 2214 |
|
| 2215 |
|
| 2216 |
|
| 2217 |
|
| 2218 |
|
| 2219 |
|
| 2220 |
|
| 2221 |
|
| 2222 |
|
| 2223 |
|
| 2224 |
|
| 2225 |
|
| 2226 |
|
| 2227 |
|
| 2228 |
|
| 2229 |
|
| 2230 |
|
| 2231 |
|
| 2232 |
|
| 2233 |
|
| 2234 |
|
| 2235 |
|
| 2236 |
|
| 2237 |
|
| 2238 |
|
| 2239 |
|
| 2240 |
|
| 2241 |
|
| 2242 |
|
| 2243 | </dl>
|
| 2244 |
|
| 2245 |
|
| 2246 |
|
| 2247 |
|
| 2248 |
|
| 2249 |
|
| 2250 |
|
| 2251 |
|
| 2252 |
|
| 2253 |
|
| 2254 |
|
| 2255 |
|
| 2256 |
|
| 2257 | <h5>Returns:</h5>
|
| 2258 |
|
| 2259 |
|
| 2260 | <div class="param-desc">
|
| 2261 | <p>A promise which is resolved when the request is complete
|
| 2262 | or rejected if an error occurs.</p>
|
| 2263 | </div>
|
| 2264 |
|
| 2265 |
|
| 2266 |
|
| 2267 | <dl>
|
| 2268 | <dt>
|
| 2269 | Type
|
| 2270 | </dt>
|
| 2271 | <dd>
|
| 2272 |
|
| 2273 | <span class="param-type">Promise</span>
|
| 2274 |
|
| 2275 |
|
| 2276 | </dd>
|
| 2277 | </dl>
|
| 2278 |
|
| 2279 |
|
| 2280 |
|
| 2281 |
|
| 2282 |
|
| 2283 |
|
| 2284 |
|
| 2285 |
|
| 2286 |
|
| 2287 |
|
| 2288 |
|
| 2289 |
|
| 2290 |
|
| 2291 | <h4 class="name" id="deviceInfo"><span class="type-signature"></span>deviceInfo<span class="signature">(retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2292 |
|
| 2293 |
|
| 2294 |
|
| 2295 |
|
| 2296 |
|
| 2297 |
|
| 2298 | <div class="description">
|
| 2299 | <p>Gets the => device info</p>
|
| 2300 | </div>
|
| 2301 |
|
| 2302 |
|
| 2303 |
|
| 2304 |
|
| 2305 |
|
| 2306 |
|
| 2307 |
|
| 2308 |
|
| 2309 |
|
| 2310 | <h5>Parameters:</h5>
|
| 2311 |
|
| 2312 |
|
| 2313 | <table class="params">
|
| 2314 | <thead>
|
| 2315 | <tr>
|
| 2316 |
|
| 2317 | <th>Name</th>
|
| 2318 |
|
| 2319 |
|
| 2320 | <th>Type</th>
|
| 2321 |
|
| 2322 |
|
| 2323 | <th>Attributes</th>
|
| 2324 |
|
| 2325 |
|
| 2326 |
|
| 2327 |
|
| 2328 | <th class="last">Description</th>
|
| 2329 | </tr>
|
| 2330 | </thead>
|
| 2331 |
|
| 2332 | <tbody>
|
| 2333 |
|
| 2334 |
|
| 2335 | <tr>
|
| 2336 |
|
| 2337 | <td class="name"><code>retryOptions</code></td>
|
| 2338 |
|
| 2339 |
|
| 2340 | <td class="type">
|
| 2341 |
|
| 2342 |
|
| 2343 | <span class="param-type">Object</span>
|
| 2344 |
|
| 2345 |
|
| 2346 |
|
| 2347 | </td>
|
| 2348 |
|
| 2349 |
|
| 2350 | <td class="attributes">
|
| 2351 |
|
| 2352 | <optional><br>
|
| 2353 |
|
| 2354 |
|
| 2355 |
|
| 2356 |
|
| 2357 |
|
| 2358 | </td>
|
| 2359 |
|
| 2360 |
|
| 2361 |
|
| 2362 |
|
| 2363 | <td class="description last"><p>Options for retrying the request.</p>
|
| 2364 | <h6>Properties</h6>
|
| 2365 |
|
| 2366 |
|
| 2367 | <table class="params">
|
| 2368 | <thead>
|
| 2369 | <tr>
|
| 2370 |
|
| 2371 | <th>Name</th>
|
| 2372 |
|
| 2373 |
|
| 2374 | <th>Type</th>
|
| 2375 |
|
| 2376 |
|
| 2377 | <th>Attributes</th>
|
| 2378 |
|
| 2379 |
|
| 2380 |
|
| 2381 |
|
| 2382 | <th class="last">Description</th>
|
| 2383 | </tr>
|
| 2384 | </thead>
|
| 2385 |
|
| 2386 | <tbody>
|
| 2387 |
|
| 2388 |
|
| 2389 | <tr>
|
| 2390 |
|
| 2391 | <td class="name"><code>maxRetries</code></td>
|
| 2392 |
|
| 2393 |
|
| 2394 | <td class="type">
|
| 2395 |
|
| 2396 |
|
| 2397 | <span class="param-type">Integer</span>
|
| 2398 |
|
| 2399 |
|
| 2400 |
|
| 2401 | </td>
|
| 2402 |
|
| 2403 |
|
| 2404 | <td class="attributes">
|
| 2405 |
|
| 2406 | <optional><br>
|
| 2407 |
|
| 2408 |
|
| 2409 |
|
| 2410 |
|
| 2411 |
|
| 2412 | </td>
|
| 2413 |
|
| 2414 |
|
| 2415 |
|
| 2416 |
|
| 2417 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 2418 | 0 to not retry. Default 60.</p></td>
|
| 2419 | </tr>
|
| 2420 |
|
| 2421 |
|
| 2422 |
|
| 2423 | <tr>
|
| 2424 |
|
| 2425 | <td class="name"><code>retryIntervalMs</code></td>
|
| 2426 |
|
| 2427 |
|
| 2428 | <td class="type">
|
| 2429 |
|
| 2430 |
|
| 2431 | <span class="param-type">Integer</span>
|
| 2432 |
|
| 2433 |
|
| 2434 |
|
| 2435 | </td>
|
| 2436 |
|
| 2437 |
|
| 2438 | <td class="attributes">
|
| 2439 |
|
| 2440 | <optional><br>
|
| 2441 |
|
| 2442 |
|
| 2443 |
|
| 2444 |
|
| 2445 |
|
| 2446 | </td>
|
| 2447 |
|
| 2448 |
|
| 2449 |
|
| 2450 |
|
| 2451 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 2452 | </tr>
|
| 2453 |
|
| 2454 |
|
| 2455 | </tbody>
|
| 2456 | </table>
|
| 2457 |
|
| 2458 | </td>
|
| 2459 | </tr>
|
| 2460 |
|
| 2461 |
|
| 2462 | </tbody>
|
| 2463 | </table>
|
| 2464 |
|
| 2465 |
|
| 2466 |
|
| 2467 |
|
| 2468 |
|
| 2469 |
|
| 2470 | <dl class="details">
|
| 2471 |
|
| 2472 |
|
| 2473 |
|
| 2474 |
|
| 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 | </dl>
|
| 2504 |
|
| 2505 |
|
| 2506 |
|
| 2507 |
|
| 2508 |
|
| 2509 |
|
| 2510 |
|
| 2511 |
|
| 2512 |
|
| 2513 |
|
| 2514 |
|
| 2515 |
|
| 2516 |
|
| 2517 | <h5>Returns:</h5>
|
| 2518 |
|
| 2519 |
|
| 2520 | <div class="param-desc">
|
| 2521 | <p>A promise which is resolved when the request is complete
|
| 2522 | or rejected if an error occurs.</p>
|
| 2523 | </div>
|
| 2524 |
|
| 2525 |
|
| 2526 |
|
| 2527 | <dl>
|
| 2528 | <dt>
|
| 2529 | Type
|
| 2530 | </dt>
|
| 2531 | <dd>
|
| 2532 |
|
| 2533 | <span class="param-type">Promise</span>
|
| 2534 |
|
| 2535 |
|
| 2536 | </dd>
|
| 2537 | </dl>
|
| 2538 |
|
| 2539 |
|
| 2540 |
|
| 2541 |
|
| 2542 |
|
| 2543 |
|
| 2544 |
|
| 2545 |
|
| 2546 |
|
| 2547 |
|
| 2548 |
|
| 2549 |
|
| 2550 |
|
| 2551 | <h4 class="name" id="deviceState"><span class="type-signature"></span>deviceState<span class="signature">(hostname, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2552 |
|
| 2553 |
|
| 2554 |
|
| 2555 |
|
| 2556 |
|
| 2557 |
|
| 2558 | <div class="description">
|
| 2559 | <p>Gets the Device State for a BIG-IP device by hostname</p>
|
| 2560 | </div>
|
| 2561 |
|
| 2562 |
|
| 2563 |
|
| 2564 |
|
| 2565 |
|
| 2566 |
|
| 2567 |
|
| 2568 |
|
| 2569 |
|
| 2570 | <h5>Parameters:</h5>
|
| 2571 |
|
| 2572 |
|
| 2573 | <table class="params">
|
| 2574 | <thead>
|
| 2575 | <tr>
|
| 2576 |
|
| 2577 | <th>Name</th>
|
| 2578 |
|
| 2579 |
|
| 2580 | <th>Type</th>
|
| 2581 |
|
| 2582 |
|
| 2583 | <th>Attributes</th>
|
| 2584 |
|
| 2585 |
|
| 2586 |
|
| 2587 |
|
| 2588 | <th class="last">Description</th>
|
| 2589 | </tr>
|
| 2590 | </thead>
|
| 2591 |
|
| 2592 | <tbody>
|
| 2593 |
|
| 2594 |
|
| 2595 | <tr>
|
| 2596 |
|
| 2597 | <td class="name"><code>hostname</code></td>
|
| 2598 |
|
| 2599 |
|
| 2600 | <td class="type">
|
| 2601 |
|
| 2602 |
|
| 2603 | <span class="param-type">String</span>
|
| 2604 |
|
| 2605 |
|
| 2606 |
|
| 2607 | </td>
|
| 2608 |
|
| 2609 |
|
| 2610 | <td class="attributes">
|
| 2611 |
|
| 2612 |
|
| 2613 |
|
| 2614 |
|
| 2615 |
|
| 2616 | </td>
|
| 2617 |
|
| 2618 |
|
| 2619 |
|
| 2620 |
|
| 2621 | <td class="description last"><p>Hostname of device</p></td>
|
| 2622 | </tr>
|
| 2623 |
|
| 2624 |
|
| 2625 |
|
| 2626 | <tr>
|
| 2627 |
|
| 2628 | <td class="name"><code>retryOptions</code></td>
|
| 2629 |
|
| 2630 |
|
| 2631 | <td class="type">
|
| 2632 |
|
| 2633 |
|
| 2634 | <span class="param-type">Object</span>
|
| 2635 |
|
| 2636 |
|
| 2637 |
|
| 2638 | </td>
|
| 2639 |
|
| 2640 |
|
| 2641 | <td class="attributes">
|
| 2642 |
|
| 2643 | <optional><br>
|
| 2644 |
|
| 2645 |
|
| 2646 |
|
| 2647 |
|
| 2648 |
|
| 2649 | </td>
|
| 2650 |
|
| 2651 |
|
| 2652 |
|
| 2653 |
|
| 2654 | <td class="description last"><p>Options for retrying the request.</p>
|
| 2655 | <h6>Properties</h6>
|
| 2656 |
|
| 2657 |
|
| 2658 | <table class="params">
|
| 2659 | <thead>
|
| 2660 | <tr>
|
| 2661 |
|
| 2662 | <th>Name</th>
|
| 2663 |
|
| 2664 |
|
| 2665 | <th>Type</th>
|
| 2666 |
|
| 2667 |
|
| 2668 | <th>Attributes</th>
|
| 2669 |
|
| 2670 |
|
| 2671 |
|
| 2672 |
|
| 2673 | <th class="last">Description</th>
|
| 2674 | </tr>
|
| 2675 | </thead>
|
| 2676 |
|
| 2677 | <tbody>
|
| 2678 |
|
| 2679 |
|
| 2680 | <tr>
|
| 2681 |
|
| 2682 | <td class="name"><code>maxRetries</code></td>
|
| 2683 |
|
| 2684 |
|
| 2685 | <td class="type">
|
| 2686 |
|
| 2687 |
|
| 2688 | <span class="param-type">Integer</span>
|
| 2689 |
|
| 2690 |
|
| 2691 |
|
| 2692 | </td>
|
| 2693 |
|
| 2694 |
|
| 2695 | <td class="attributes">
|
| 2696 |
|
| 2697 | <optional><br>
|
| 2698 |
|
| 2699 |
|
| 2700 |
|
| 2701 |
|
| 2702 |
|
| 2703 | </td>
|
| 2704 |
|
| 2705 |
|
| 2706 |
|
| 2707 |
|
| 2708 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 2709 | 0 to not retry. Default 60.</p></td>
|
| 2710 | </tr>
|
| 2711 |
|
| 2712 |
|
| 2713 |
|
| 2714 | <tr>
|
| 2715 |
|
| 2716 | <td class="name"><code>retryIntervalMs</code></td>
|
| 2717 |
|
| 2718 |
|
| 2719 | <td class="type">
|
| 2720 |
|
| 2721 |
|
| 2722 | <span class="param-type">Integer</span>
|
| 2723 |
|
| 2724 |
|
| 2725 |
|
| 2726 | </td>
|
| 2727 |
|
| 2728 |
|
| 2729 | <td class="attributes">
|
| 2730 |
|
| 2731 | <optional><br>
|
| 2732 |
|
| 2733 |
|
| 2734 |
|
| 2735 |
|
| 2736 |
|
| 2737 | </td>
|
| 2738 |
|
| 2739 |
|
| 2740 |
|
| 2741 |
|
| 2742 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 2743 | </tr>
|
| 2744 |
|
| 2745 |
|
| 2746 | </tbody>
|
| 2747 | </table>
|
| 2748 |
|
| 2749 | </td>
|
| 2750 | </tr>
|
| 2751 |
|
| 2752 |
|
| 2753 | </tbody>
|
| 2754 | </table>
|
| 2755 |
|
| 2756 |
|
| 2757 |
|
| 2758 |
|
| 2759 |
|
| 2760 |
|
| 2761 | <dl class="details">
|
| 2762 |
|
| 2763 |
|
| 2764 |
|
| 2765 |
|
| 2766 |
|
| 2767 |
|
| 2768 |
|
| 2769 |
|
| 2770 |
|
| 2771 |
|
| 2772 |
|
| 2773 |
|
| 2774 |
|
| 2775 |
|
| 2776 |
|
| 2777 |
|
| 2778 |
|
| 2779 |
|
| 2780 |
|
| 2781 |
|
| 2782 |
|
| 2783 |
|
| 2784 |
|
| 2785 |
|
| 2786 |
|
| 2787 |
|
| 2788 |
|
| 2789 |
|
| 2790 |
|
| 2791 |
|
| 2792 |
|
| 2793 |
|
| 2794 | </dl>
|
| 2795 |
|
| 2796 |
|
| 2797 |
|
| 2798 |
|
| 2799 |
|
| 2800 |
|
| 2801 |
|
| 2802 |
|
| 2803 |
|
| 2804 |
|
| 2805 |
|
| 2806 |
|
| 2807 |
|
| 2808 | <h5>Returns:</h5>
|
| 2809 |
|
| 2810 |
|
| 2811 | <div class="param-desc">
|
| 2812 | <p>A promise which is resolved when the request is complete
|
| 2813 | or rejected if an error occurs.</p>
|
| 2814 | </div>
|
| 2815 |
|
| 2816 |
|
| 2817 |
|
| 2818 | <dl>
|
| 2819 | <dt>
|
| 2820 | Type
|
| 2821 | </dt>
|
| 2822 | <dd>
|
| 2823 |
|
| 2824 | <span class="param-type">Promise</span>
|
| 2825 |
|
| 2826 |
|
| 2827 | </dd>
|
| 2828 | </dl>
|
| 2829 |
|
| 2830 |
|
| 2831 |
|
| 2832 |
|
| 2833 |
|
| 2834 |
|
| 2835 |
|
| 2836 |
|
| 2837 |
|
| 2838 |
|
| 2839 |
|
| 2840 |
|
| 2841 |
|
| 2842 | <h4 class="name" id="getPassword"><span class="type-signature"></span>getPassword<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2843 |
|
| 2844 |
|
| 2845 |
|
| 2846 |
|
| 2847 |
|
| 2848 |
|
| 2849 | <div class="description">
|
| 2850 | <p>Returns this intance's password</p>
|
| 2851 | </div>
|
| 2852 |
|
| 2853 |
|
| 2854 |
|
| 2855 |
|
| 2856 |
|
| 2857 |
|
| 2858 |
|
| 2859 |
|
| 2860 |
|
| 2861 |
|
| 2862 |
|
| 2863 |
|
| 2864 |
|
| 2865 | <dl class="details">
|
| 2866 |
|
| 2867 |
|
| 2868 |
|
| 2869 |
|
| 2870 |
|
| 2871 |
|
| 2872 |
|
| 2873 |
|
| 2874 |
|
| 2875 |
|
| 2876 |
|
| 2877 |
|
| 2878 |
|
| 2879 |
|
| 2880 |
|
| 2881 |
|
| 2882 |
|
| 2883 |
|
| 2884 |
|
| 2885 |
|
| 2886 |
|
| 2887 |
|
| 2888 |
|
| 2889 |
|
| 2890 |
|
| 2891 |
|
| 2892 |
|
| 2893 |
|
| 2894 |
|
| 2895 |
|
| 2896 |
|
| 2897 |
|
| 2898 | </dl>
|
| 2899 |
|
| 2900 |
|
| 2901 |
|
| 2902 |
|
| 2903 |
|
| 2904 |
|
| 2905 |
|
| 2906 |
|
| 2907 |
|
| 2908 |
|
| 2909 |
|
| 2910 |
|
| 2911 |
|
| 2912 | <h5>Returns:</h5>
|
| 2913 |
|
| 2914 |
|
| 2915 | <div class="param-desc">
|
| 2916 | <p>A promise that is resolved with this instances password
|
| 2917 | or rejected if an error occurs</p>
|
| 2918 | </div>
|
| 2919 |
|
| 2920 |
|
| 2921 |
|
| 2922 | <dl>
|
| 2923 | <dt>
|
| 2924 | Type
|
| 2925 | </dt>
|
| 2926 | <dd>
|
| 2927 |
|
| 2928 | <span class="param-type">Promise</span>
|
| 2929 |
|
| 2930 |
|
| 2931 | </dd>
|
| 2932 | </dl>
|
| 2933 |
|
| 2934 |
|
| 2935 |
|
| 2936 |
|
| 2937 |
|
| 2938 |
|
| 2939 |
|
| 2940 |
|
| 2941 |
|
| 2942 |
|
| 2943 |
|
| 2944 |
|
| 2945 |
|
| 2946 | <h4 class="name" id="getPrivateKeyFilePath"><span class="type-signature"></span>getPrivateKeyFilePath<span class="signature">(folder, name)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2947 |
|
| 2948 |
|
| 2949 |
|
| 2950 |
|
| 2951 |
|
| 2952 |
|
| 2953 | <div class="description">
|
| 2954 | <p>Gets the path to the latest private key</p>
|
| 2955 | </div>
|
| 2956 |
|
| 2957 |
|
| 2958 |
|
| 2959 |
|
| 2960 |
|
| 2961 |
|
| 2962 |
|
| 2963 |
|
| 2964 |
|
| 2965 | <h5>Parameters:</h5>
|
| 2966 |
|
| 2967 |
|
| 2968 | <table class="params">
|
| 2969 | <thead>
|
| 2970 | <tr>
|
| 2971 |
|
| 2972 | <th>Name</th>
|
| 2973 |
|
| 2974 |
|
| 2975 | <th>Type</th>
|
| 2976 |
|
| 2977 |
|
| 2978 |
|
| 2979 |
|
| 2980 |
|
| 2981 | <th class="last">Description</th>
|
| 2982 | </tr>
|
| 2983 | </thead>
|
| 2984 |
|
| 2985 | <tbody>
|
| 2986 |
|
| 2987 |
|
| 2988 | <tr>
|
| 2989 |
|
| 2990 | <td class="name"><code>folder</code></td>
|
| 2991 |
|
| 2992 |
|
| 2993 | <td class="type">
|
| 2994 |
|
| 2995 |
|
| 2996 | <span class="param-type">String</span>
|
| 2997 |
|
| 2998 |
|
| 2999 |
|
| 3000 | </td>
|
| 3001 |
|
| 3002 |
|
| 3003 |
|
| 3004 |
|
| 3005 |
|
| 3006 | <td class="description last"><p>Folder in which to search for the key</p></td>
|
| 3007 | </tr>
|
| 3008 |
|
| 3009 |
|
| 3010 |
|
| 3011 | <tr>
|
| 3012 |
|
| 3013 | <td class="name"><code>name</code></td>
|
| 3014 |
|
| 3015 |
|
| 3016 | <td class="type">
|
| 3017 |
|
| 3018 |
|
| 3019 | <span class="param-type">String</span>
|
| 3020 |
|
| 3021 |
|
| 3022 |
|
| 3023 | </td>
|
| 3024 |
|
| 3025 |
|
| 3026 |
|
| 3027 |
|
| 3028 |
|
| 3029 | <td class="description last"><p>Name of the key</p></td>
|
| 3030 | </tr>
|
| 3031 |
|
| 3032 |
|
| 3033 | </tbody>
|
| 3034 | </table>
|
| 3035 |
|
| 3036 |
|
| 3037 |
|
| 3038 |
|
| 3039 |
|
| 3040 |
|
| 3041 | <dl class="details">
|
| 3042 |
|
| 3043 |
|
| 3044 |
|
| 3045 |
|
| 3046 |
|
| 3047 |
|
| 3048 |
|
| 3049 |
|
| 3050 |
|
| 3051 |
|
| 3052 |
|
| 3053 |
|
| 3054 |
|
| 3055 |
|
| 3056 |
|
| 3057 |
|
| 3058 |
|
| 3059 |
|
| 3060 |
|
| 3061 |
|
| 3062 |
|
| 3063 |
|
| 3064 |
|
| 3065 |
|
| 3066 |
|
| 3067 |
|
| 3068 |
|
| 3069 |
|
| 3070 |
|
| 3071 |
|
| 3072 |
|
| 3073 |
|
| 3074 | </dl>
|
| 3075 |
|
| 3076 |
|
| 3077 |
|
| 3078 |
|
| 3079 |
|
| 3080 |
|
| 3081 |
|
| 3082 |
|
| 3083 |
|
| 3084 |
|
| 3085 |
|
| 3086 |
|
| 3087 |
|
| 3088 | <h5>Returns:</h5>
|
| 3089 |
|
| 3090 |
|
| 3091 | <div class="param-desc">
|
| 3092 | <p>A promise which is resolved when the request is complete
|
| 3093 | or rejected if an error occurs.</p>
|
| 3094 | </div>
|
| 3095 |
|
| 3096 |
|
| 3097 |
|
| 3098 | <dl>
|
| 3099 | <dt>
|
| 3100 | Type
|
| 3101 | </dt>
|
| 3102 | <dd>
|
| 3103 |
|
| 3104 | <span class="param-type">Promise</span>
|
| 3105 |
|
| 3106 |
|
| 3107 | </dd>
|
| 3108 | </dl>
|
| 3109 |
|
| 3110 |
|
| 3111 |
|
| 3112 |
|
| 3113 |
|
| 3114 |
|
| 3115 |
|
| 3116 |
|
| 3117 |
|
| 3118 |
|
| 3119 |
|
| 3120 |
|
| 3121 |
|
| 3122 | <h4 class="name" id="getPrivateKeyMetadata"><span class="type-signature"></span>getPrivateKeyMetadata<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
| 3123 |
|
| 3124 |
|
| 3125 |
|
| 3126 |
|
| 3127 |
|
| 3128 |
|
| 3129 | <div class="description">
|
| 3130 | <p>Get the metadata for the cloud libs private key</p>
|
| 3131 | </div>
|
| 3132 |
|
| 3133 |
|
| 3134 |
|
| 3135 |
|
| 3136 |
|
| 3137 |
|
| 3138 |
|
| 3139 |
|
| 3140 |
|
| 3141 |
|
| 3142 |
|
| 3143 |
|
| 3144 |
|
| 3145 | <dl class="details">
|
| 3146 |
|
| 3147 |
|
| 3148 |
|
| 3149 |
|
| 3150 |
|
| 3151 |
|
| 3152 |
|
| 3153 |
|
| 3154 |
|
| 3155 |
|
| 3156 |
|
| 3157 |
|
| 3158 |
|
| 3159 |
|
| 3160 |
|
| 3161 |
|
| 3162 |
|
| 3163 |
|
| 3164 |
|
| 3165 |
|
| 3166 |
|
| 3167 |
|
| 3168 |
|
| 3169 |
|
| 3170 |
|
| 3171 |
|
| 3172 |
|
| 3173 |
|
| 3174 |
|
| 3175 |
|
| 3176 |
|
| 3177 |
|
| 3178 | </dl>
|
| 3179 |
|
| 3180 |
|
| 3181 |
|
| 3182 |
|
| 3183 |
|
| 3184 |
|
| 3185 |
|
| 3186 |
|
| 3187 |
|
| 3188 |
|
| 3189 |
|
| 3190 |
|
| 3191 |
|
| 3192 | <h5>Returns:</h5>
|
| 3193 |
|
| 3194 |
|
| 3195 | <div class="param-desc">
|
| 3196 | <p>A promise which is resolved when the request is complete
|
| 3197 | or rejected if an error occurs.</p>
|
| 3198 | </div>
|
| 3199 |
|
| 3200 |
|
| 3201 |
|
| 3202 | <dl>
|
| 3203 | <dt>
|
| 3204 | Type
|
| 3205 | </dt>
|
| 3206 | <dd>
|
| 3207 |
|
| 3208 | <span class="param-type">Promise</span>
|
| 3209 |
|
| 3210 |
|
| 3211 | </dd>
|
| 3212 | </dl>
|
| 3213 |
|
| 3214 |
|
| 3215 |
|
| 3216 |
|
| 3217 |
|
| 3218 |
|
| 3219 |
|
| 3220 |
|
| 3221 |
|
| 3222 |
|
| 3223 |
|
| 3224 |
|
| 3225 |
|
| 3226 | <h4 class="name" id="init"><span class="type-signature"></span>init<span class="signature">(host, user, password, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 3227 |
|
| 3228 |
|
| 3229 |
|
| 3230 |
|
| 3231 |
|
| 3232 |
|
| 3233 | <div class="description">
|
| 3234 | <p>Initialize this instance w/ host user password</p>
|
| 3235 | </div>
|
| 3236 |
|
| 3237 |
|
| 3238 |
|
| 3239 |
|
| 3240 |
|
| 3241 |
|
| 3242 |
|
| 3243 |
|
| 3244 |
|
| 3245 | <h5>Parameters:</h5>
|
| 3246 |
|
| 3247 |
|
| 3248 | <table class="params">
|
| 3249 | <thead>
|
| 3250 | <tr>
|
| 3251 |
|
| 3252 | <th>Name</th>
|
| 3253 |
|
| 3254 |
|
| 3255 | <th>Type</th>
|
| 3256 |
|
| 3257 |
|
| 3258 | <th>Attributes</th>
|
| 3259 |
|
| 3260 |
|
| 3261 |
|
| 3262 |
|
| 3263 | <th class="last">Description</th>
|
| 3264 | </tr>
|
| 3265 | </thead>
|
| 3266 |
|
| 3267 | <tbody>
|
| 3268 |
|
| 3269 |
|
| 3270 | <tr>
|
| 3271 |
|
| 3272 | <td class="name"><code>host</code></td>
|
| 3273 |
|
| 3274 |
|
| 3275 | <td class="type">
|
| 3276 |
|
| 3277 |
|
| 3278 | <span class="param-type">String</span>
|
| 3279 |
|
| 3280 |
|
| 3281 |
|
| 3282 | </td>
|
| 3283 |
|
| 3284 |
|
| 3285 | <td class="attributes">
|
| 3286 |
|
| 3287 |
|
| 3288 |
|
| 3289 |
|
| 3290 |
|
| 3291 | </td>
|
| 3292 |
|
| 3293 |
|
| 3294 |
|
| 3295 |
|
| 3296 | <td class="description last"><p>Host to connect to.</p></td>
|
| 3297 | </tr>
|
| 3298 |
|
| 3299 |
|
| 3300 |
|
| 3301 | <tr>
|
| 3302 |
|
| 3303 | <td class="name"><code>user</code></td>
|
| 3304 |
|
| 3305 |
|
| 3306 | <td class="type">
|
| 3307 |
|
| 3308 |
|
| 3309 | <span class="param-type">String</span>
|
| 3310 |
|
| 3311 |
|
| 3312 |
|
| 3313 | </td>
|
| 3314 |
|
| 3315 |
|
| 3316 | <td class="attributes">
|
| 3317 |
|
| 3318 |
|
| 3319 |
|
| 3320 |
|
| 3321 |
|
| 3322 | </td>
|
| 3323 |
|
| 3324 |
|
| 3325 |
|
| 3326 |
|
| 3327 | <td class="description last"><p>User (with admin rights).</p></td>
|
| 3328 | </tr>
|
| 3329 |
|
| 3330 |
|
| 3331 |
|
| 3332 | <tr>
|
| 3333 |
|
| 3334 | <td class="name"><code>password</code></td>
|
| 3335 |
|
| 3336 |
|
| 3337 | <td class="type">
|
| 3338 |
|
| 3339 |
|
| 3340 | <span class="param-type">String</span>
|
| 3341 |
|
| 3342 |
|
| 3343 |
|
| 3344 | </td>
|
| 3345 |
|
| 3346 |
|
| 3347 | <td class="attributes">
|
| 3348 |
|
| 3349 |
|
| 3350 |
|
| 3351 |
|
| 3352 |
|
| 3353 | </td>
|
| 3354 |
|
| 3355 |
|
| 3356 |
|
| 3357 |
|
| 3358 | <td class="description last"><p>Password for user or URI (file, http, https, ARN, etc.)
|
| 3359 | to location containing password.</p></td>
|
| 3360 | </tr>
|
| 3361 |
|
| 3362 |
|
| 3363 |
|
| 3364 | <tr>
|
| 3365 |
|
| 3366 | <td class="name"><code>options</code></td>
|
| 3367 |
|
| 3368 |
|
| 3369 | <td class="type">
|
| 3370 |
|
| 3371 |
|
| 3372 | <span class="param-type">Object</span>
|
| 3373 |
|
| 3374 |
|
| 3375 |
|
| 3376 | </td>
|
| 3377 |
|
| 3378 |
|
| 3379 | <td class="attributes">
|
| 3380 |
|
| 3381 | <optional><br>
|
| 3382 |
|
| 3383 |
|
| 3384 |
|
| 3385 |
|
| 3386 |
|
| 3387 | </td>
|
| 3388 |
|
| 3389 |
|
| 3390 |
|
| 3391 |
|
| 3392 | <td class="description last"><p>Optional parameters.</p>
|
| 3393 | <h6>Properties</h6>
|
| 3394 |
|
| 3395 |
|
| 3396 | <table class="params">
|
| 3397 | <thead>
|
| 3398 | <tr>
|
| 3399 |
|
| 3400 | <th>Name</th>
|
| 3401 |
|
| 3402 |
|
| 3403 | <th>Type</th>
|
| 3404 |
|
| 3405 |
|
| 3406 | <th>Attributes</th>
|
| 3407 |
|
| 3408 |
|
| 3409 |
|
| 3410 |
|
| 3411 | <th class="last">Description</th>
|
| 3412 | </tr>
|
| 3413 | </thead>
|
| 3414 |
|
| 3415 | <tbody>
|
| 3416 |
|
| 3417 |
|
| 3418 | <tr>
|
| 3419 |
|
| 3420 | <td class="name"><code>port</code></td>
|
| 3421 |
|
| 3422 |
|
| 3423 | <td class="type">
|
| 3424 |
|
| 3425 |
|
| 3426 | <span class="param-type">Number</span>
|
| 3427 |
|
| 3428 |
|
| 3429 |
|
| 3430 | </td>
|
| 3431 |
|
| 3432 |
|
| 3433 | <td class="attributes">
|
| 3434 |
|
| 3435 | <optional><br>
|
| 3436 |
|
| 3437 |
|
| 3438 |
|
| 3439 |
|
| 3440 |
|
| 3441 | </td>
|
| 3442 |
|
| 3443 |
|
| 3444 |
|
| 3445 |
|
| 3446 | <td class="description last"><p>Port to connect to. Default 443.</p></td>
|
| 3447 | </tr>
|
| 3448 |
|
| 3449 |
|
| 3450 |
|
| 3451 | <tr>
|
| 3452 |
|
| 3453 | <td class="name"><code>passwordIsUrl</code></td>
|
| 3454 |
|
| 3455 |
|
| 3456 | <td class="type">
|
| 3457 |
|
| 3458 |
|
| 3459 | <span class="param-type">Boolean</span>
|
| 3460 |
|
| 3461 |
|
| 3462 |
|
| 3463 | </td>
|
| 3464 |
|
| 3465 |
|
| 3466 | <td class="attributes">
|
| 3467 |
|
| 3468 | <optional><br>
|
| 3469 |
|
| 3470 |
|
| 3471 |
|
| 3472 |
|
| 3473 |
|
| 3474 | </td>
|
| 3475 |
|
| 3476 |
|
| 3477 |
|
| 3478 |
|
| 3479 | <td class="description last"><p>Indicates that password is a URL for the password</p></td>
|
| 3480 | </tr>
|
| 3481 |
|
| 3482 |
|
| 3483 |
|
| 3484 | <tr>
|
| 3485 |
|
| 3486 | <td class="name"><code>passwordIsToken</code></td>
|
| 3487 |
|
| 3488 |
|
| 3489 | <td class="type">
|
| 3490 |
|
| 3491 |
|
| 3492 | <span class="param-type">Boolean</span>
|
| 3493 |
|
| 3494 |
|
| 3495 |
|
| 3496 | </td>
|
| 3497 |
|
| 3498 |
|
| 3499 | <td class="attributes">
|
| 3500 |
|
| 3501 | <optional><br>
|
| 3502 |
|
| 3503 |
|
| 3504 |
|
| 3505 |
|
| 3506 |
|
| 3507 | </td>
|
| 3508 |
|
| 3509 |
|
| 3510 |
|
| 3511 |
|
| 3512 | <td class="description last"><p>Indicates that the password is an auth token.</p></td>
|
| 3513 | </tr>
|
| 3514 |
|
| 3515 |
|
| 3516 |
|
| 3517 | <tr>
|
| 3518 |
|
| 3519 | <td class="name"><code>passwordEncrypted</code></td>
|
| 3520 |
|
| 3521 |
|
| 3522 | <td class="type">
|
| 3523 |
|
| 3524 |
|
| 3525 | <span class="param-type">Boolean</span>
|
| 3526 |
|
| 3527 |
|
| 3528 |
|
| 3529 | </td>
|
| 3530 |
|
| 3531 |
|
| 3532 | <td class="attributes">
|
| 3533 |
|
| 3534 | <optional><br>
|
| 3535 |
|
| 3536 |
|
| 3537 |
|
| 3538 |
|
| 3539 |
|
| 3540 | </td>
|
| 3541 |
|
| 3542 |
|
| 3543 |
|
| 3544 |
|
| 3545 | <td class="description last"><p>Indicates that the password is encrypted (with
|
| 3546 | the local cloud public key)</p></td>
|
| 3547 | </tr>
|
| 3548 |
|
| 3549 |
|
| 3550 |
|
| 3551 | <tr>
|
| 3552 |
|
| 3553 | <td class="name"><code>product</code></td>
|
| 3554 |
|
| 3555 |
|
| 3556 | <td class="type">
|
| 3557 |
|
| 3558 |
|
| 3559 | <span class="param-type">String</span>
|
| 3560 |
|
| 3561 |
|
| 3562 |
|
| 3563 | </td>
|
| 3564 |
|
| 3565 |
|
| 3566 | <td class="attributes">
|
| 3567 |
|
| 3568 | <optional><br>
|
| 3569 |
|
| 3570 |
|
| 3571 |
|
| 3572 |
|
| 3573 |
|
| 3574 | </td>
|
| 3575 |
|
| 3576 |
|
| 3577 |
|
| 3578 |
|
| 3579 | <td class="description last"><p>The product we are running on (BIG-IP | BIG-IQ). Default
|
| 3580 | is to determine the product programmatically.</p></td>
|
| 3581 | </tr>
|
| 3582 |
|
| 3583 |
|
| 3584 |
|
| 3585 | <tr>
|
| 3586 |
|
| 3587 | <td class="name"><code>clOptions</code></td>
|
| 3588 |
|
| 3589 |
|
| 3590 | <td class="type">
|
| 3591 |
|
| 3592 |
|
| 3593 | <span class="param-type">Object</span>
|
| 3594 |
|
| 3595 |
|
| 3596 |
|
| 3597 | </td>
|
| 3598 |
|
| 3599 |
|
| 3600 | <td class="attributes">
|
| 3601 |
|
| 3602 | <optional><br>
|
| 3603 |
|
| 3604 |
|
| 3605 |
|
| 3606 |
|
| 3607 |
|
| 3608 | </td>
|
| 3609 |
|
| 3610 |
|
| 3611 |
|
| 3612 |
|
| 3613 | <td class="description last"><p>Command line options</p></td>
|
| 3614 | </tr>
|
| 3615 |
|
| 3616 |
|
| 3617 | </tbody>
|
| 3618 | </table>
|
| 3619 |
|
| 3620 | </td>
|
| 3621 | </tr>
|
| 3622 |
|
| 3623 |
|
| 3624 | </tbody>
|
| 3625 | </table>
|
| 3626 |
|
| 3627 |
|
| 3628 |
|
| 3629 |
|
| 3630 |
|
| 3631 |
|
| 3632 | <dl class="details">
|
| 3633 |
|
| 3634 |
|
| 3635 |
|
| 3636 |
|
| 3637 |
|
| 3638 |
|
| 3639 |
|
| 3640 |
|
| 3641 |
|
| 3642 |
|
| 3643 |
|
| 3644 |
|
| 3645 |
|
| 3646 |
|
| 3647 |
|
| 3648 |
|
| 3649 |
|
| 3650 |
|
| 3651 |
|
| 3652 |
|
| 3653 |
|
| 3654 |
|
| 3655 |
|
| 3656 |
|
| 3657 |
|
| 3658 |
|
| 3659 |
|
| 3660 |
|
| 3661 |
|
| 3662 |
|
| 3663 |
|
| 3664 |
|
| 3665 | </dl>
|
| 3666 |
|
| 3667 |
|
| 3668 |
|
| 3669 |
|
| 3670 |
|
| 3671 |
|
| 3672 |
|
| 3673 |
|
| 3674 |
|
| 3675 |
|
| 3676 |
|
| 3677 |
|
| 3678 |
|
| 3679 | <h5>Returns:</h5>
|
| 3680 |
|
| 3681 |
|
| 3682 | <div class="param-desc">
|
| 3683 | <p>A promise which is resolved when initialization is complete
|
| 3684 | or rejected if an error occurs.</p>
|
| 3685 | </div>
|
| 3686 |
|
| 3687 |
|
| 3688 |
|
| 3689 | <dl>
|
| 3690 | <dt>
|
| 3691 | Type
|
| 3692 | </dt>
|
| 3693 | <dd>
|
| 3694 |
|
| 3695 | <span class="param-type">Promise</span>
|
| 3696 |
|
| 3697 |
|
| 3698 | </dd>
|
| 3699 | </dl>
|
| 3700 |
|
| 3701 |
|
| 3702 |
|
| 3703 |
|
| 3704 |
|
| 3705 |
|
| 3706 |
|
| 3707 |
|
| 3708 |
|
| 3709 |
|
| 3710 |
|
| 3711 |
|
| 3712 |
|
| 3713 | <h4 class="name" id="installPrivateKey"><span class="type-signature"></span>installPrivateKey<span class="signature">(privateKeyFile, folder, name, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 3714 |
|
| 3715 |
|
| 3716 |
|
| 3717 |
|
| 3718 |
|
| 3719 |
|
| 3720 | <div class="description">
|
| 3721 | <p>Installs a private key and then deletes the original private key file.</p>
|
| 3722 | </div>
|
| 3723 |
|
| 3724 |
|
| 3725 |
|
| 3726 |
|
| 3727 |
|
| 3728 |
|
| 3729 |
|
| 3730 |
|
| 3731 |
|
| 3732 | <h5>Parameters:</h5>
|
| 3733 |
|
| 3734 |
|
| 3735 | <table class="params">
|
| 3736 | <thead>
|
| 3737 | <tr>
|
| 3738 |
|
| 3739 | <th>Name</th>
|
| 3740 |
|
| 3741 |
|
| 3742 | <th>Type</th>
|
| 3743 |
|
| 3744 |
|
| 3745 | <th>Attributes</th>
|
| 3746 |
|
| 3747 |
|
| 3748 |
|
| 3749 |
|
| 3750 | <th class="last">Description</th>
|
| 3751 | </tr>
|
| 3752 | </thead>
|
| 3753 |
|
| 3754 | <tbody>
|
| 3755 |
|
| 3756 |
|
| 3757 | <tr>
|
| 3758 |
|
| 3759 | <td class="name"><code>privateKeyFile</code></td>
|
| 3760 |
|
| 3761 |
|
| 3762 | <td class="type">
|
| 3763 |
|
| 3764 |
|
| 3765 | <span class="param-type">String</span>
|
| 3766 |
|
| 3767 |
|
| 3768 |
|
| 3769 | </td>
|
| 3770 |
|
| 3771 |
|
| 3772 | <td class="attributes">
|
| 3773 |
|
| 3774 |
|
| 3775 |
|
| 3776 |
|
| 3777 |
|
| 3778 | </td>
|
| 3779 |
|
| 3780 |
|
| 3781 |
|
| 3782 |
|
| 3783 | <td class="description last"><p>Full path to private key file. This file
|
| 3784 | must be on the BIG-IP disk and will be deleted
|
| 3785 | upon successful installation to MCP</p></td>
|
| 3786 | </tr>
|
| 3787 |
|
| 3788 |
|
| 3789 |
|
| 3790 | <tr>
|
| 3791 |
|
| 3792 | <td class="name"><code>folder</code></td>
|
| 3793 |
|
| 3794 |
|
| 3795 | <td class="type">
|
| 3796 |
|
| 3797 |
|
| 3798 | <span class="param-type">String</span>
|
| 3799 |
|
| 3800 |
|
| 3801 |
|
| 3802 | </td>
|
| 3803 |
|
| 3804 |
|
| 3805 | <td class="attributes">
|
| 3806 |
|
| 3807 |
|
| 3808 |
|
| 3809 |
|
| 3810 |
|
| 3811 | </td>
|
| 3812 |
|
| 3813 |
|
| 3814 |
|
| 3815 |
|
| 3816 | <td class="description last"><p>Folder in which to put key</p></td>
|
| 3817 | </tr>
|
| 3818 |
|
| 3819 |
|
| 3820 |
|
| 3821 | <tr>
|
| 3822 |
|
| 3823 | <td class="name"><code>name</code></td>
|
| 3824 |
|
| 3825 |
|
| 3826 | <td class="type">
|
| 3827 |
|
| 3828 |
|
| 3829 | <span class="param-type">String</span>
|
| 3830 |
|
| 3831 |
|
| 3832 |
|
| 3833 | </td>
|
| 3834 |
|
| 3835 |
|
| 3836 | <td class="attributes">
|
| 3837 |
|
| 3838 |
|
| 3839 |
|
| 3840 |
|
| 3841 |
|
| 3842 | </td>
|
| 3843 |
|
| 3844 |
|
| 3845 |
|
| 3846 |
|
| 3847 | <td class="description last"><p>Name for key</p></td>
|
| 3848 | </tr>
|
| 3849 |
|
| 3850 |
|
| 3851 |
|
| 3852 | <tr>
|
| 3853 |
|
| 3854 | <td class="name"><code>options</code></td>
|
| 3855 |
|
| 3856 |
|
| 3857 | <td class="type">
|
| 3858 |
|
| 3859 |
|
| 3860 | <span class="param-type">Object</span>
|
| 3861 |
|
| 3862 |
|
| 3863 |
|
| 3864 | </td>
|
| 3865 |
|
| 3866 |
|
| 3867 | <td class="attributes">
|
| 3868 |
|
| 3869 | <optional><br>
|
| 3870 |
|
| 3871 |
|
| 3872 |
|
| 3873 |
|
| 3874 |
|
| 3875 | </td>
|
| 3876 |
|
| 3877 |
|
| 3878 |
|
| 3879 |
|
| 3880 | <td class="description last"><p>Optional parameters</p>
|
| 3881 | <h6>Properties</h6>
|
| 3882 |
|
| 3883 |
|
| 3884 | <table class="params">
|
| 3885 | <thead>
|
| 3886 | <tr>
|
| 3887 |
|
| 3888 | <th>Name</th>
|
| 3889 |
|
| 3890 |
|
| 3891 | <th>Type</th>
|
| 3892 |
|
| 3893 |
|
| 3894 | <th>Attributes</th>
|
| 3895 |
|
| 3896 |
|
| 3897 |
|
| 3898 |
|
| 3899 | <th class="last">Description</th>
|
| 3900 | </tr>
|
| 3901 | </thead>
|
| 3902 |
|
| 3903 | <tbody>
|
| 3904 |
|
| 3905 |
|
| 3906 | <tr>
|
| 3907 |
|
| 3908 | <td class="name"><code>passphrase</code></td>
|
| 3909 |
|
| 3910 |
|
| 3911 | <td class="type">
|
| 3912 |
|
| 3913 |
|
| 3914 | <span class="param-type">String</span>
|
| 3915 |
|
| 3916 |
|
| 3917 |
|
| 3918 | </td>
|
| 3919 |
|
| 3920 |
|
| 3921 | <td class="attributes">
|
| 3922 |
|
| 3923 | <optional><br>
|
| 3924 |
|
| 3925 |
|
| 3926 |
|
| 3927 |
|
| 3928 |
|
| 3929 | </td>
|
| 3930 |
|
| 3931 |
|
| 3932 |
|
| 3933 |
|
| 3934 | <td class="description last"><p>Optional passphrase for key</p></td>
|
| 3935 | </tr>
|
| 3936 |
|
| 3937 |
|
| 3938 | </tbody>
|
| 3939 | </table>
|
| 3940 |
|
| 3941 | </td>
|
| 3942 | </tr>
|
| 3943 |
|
| 3944 |
|
| 3945 | </tbody>
|
| 3946 | </table>
|
| 3947 |
|
| 3948 |
|
| 3949 |
|
| 3950 |
|
| 3951 |
|
| 3952 |
|
| 3953 | <dl class="details">
|
| 3954 |
|
| 3955 |
|
| 3956 |
|
| 3957 |
|
| 3958 |
|
| 3959 |
|
| 3960 |
|
| 3961 |
|
| 3962 |
|
| 3963 |
|
| 3964 |
|
| 3965 |
|
| 3966 |
|
| 3967 |
|
| 3968 |
|
| 3969 |
|
| 3970 |
|
| 3971 |
|
| 3972 |
|
| 3973 |
|
| 3974 |
|
| 3975 |
|
| 3976 |
|
| 3977 |
|
| 3978 |
|
| 3979 |
|
| 3980 |
|
| 3981 |
|
| 3982 |
|
| 3983 |
|
| 3984 |
|
| 3985 |
|
| 3986 | </dl>
|
| 3987 |
|
| 3988 |
|
| 3989 |
|
| 3990 |
|
| 3991 |
|
| 3992 |
|
| 3993 |
|
| 3994 |
|
| 3995 |
|
| 3996 |
|
| 3997 |
|
| 3998 |
|
| 3999 |
|
| 4000 | <h5>Returns:</h5>
|
| 4001 |
|
| 4002 |
|
| 4003 | <div class="param-desc">
|
| 4004 | <p>A promise which is resolved when the request is complete
|
| 4005 | or rejected if an error occurs.</p>
|
| 4006 | </div>
|
| 4007 |
|
| 4008 |
|
| 4009 |
|
| 4010 | <dl>
|
| 4011 | <dt>
|
| 4012 | Type
|
| 4013 | </dt>
|
| 4014 | <dd>
|
| 4015 |
|
| 4016 | <span class="param-type">Promise</span>
|
| 4017 |
|
| 4018 |
|
| 4019 | </dd>
|
| 4020 | </dl>
|
| 4021 |
|
| 4022 |
|
| 4023 |
|
| 4024 |
|
| 4025 |
|
| 4026 |
|
| 4027 |
|
| 4028 |
|
| 4029 |
|
| 4030 |
|
| 4031 |
|
| 4032 |
|
| 4033 |
|
| 4034 | <h4 class="name" id="isBigIp"><span class="type-signature"></span>isBigIp<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
|
| 4035 |
|
| 4036 |
|
| 4037 |
|
| 4038 |
|
| 4039 |
|
| 4040 |
|
| 4041 | <div class="description">
|
| 4042 | <p>Returns whether or not the device is a BIG-IP</p>
|
| 4043 | </div>
|
| 4044 |
|
| 4045 |
|
| 4046 |
|
| 4047 |
|
| 4048 |
|
| 4049 |
|
| 4050 |
|
| 4051 |
|
| 4052 |
|
| 4053 |
|
| 4054 |
|
| 4055 |
|
| 4056 |
|
| 4057 | <dl class="details">
|
| 4058 |
|
| 4059 |
|
| 4060 |
|
| 4061 |
|
| 4062 |
|
| 4063 |
|
| 4064 |
|
| 4065 |
|
| 4066 |
|
| 4067 |
|
| 4068 |
|
| 4069 |
|
| 4070 |
|
| 4071 |
|
| 4072 |
|
| 4073 |
|
| 4074 |
|
| 4075 |
|
| 4076 |
|
| 4077 |
|
| 4078 |
|
| 4079 |
|
| 4080 |
|
| 4081 |
|
| 4082 |
|
| 4083 |
|
| 4084 |
|
| 4085 |
|
| 4086 |
|
| 4087 |
|
| 4088 |
|
| 4089 |
|
| 4090 | </dl>
|
| 4091 |
|
| 4092 |
|
| 4093 |
|
| 4094 |
|
| 4095 |
|
| 4096 |
|
| 4097 |
|
| 4098 |
|
| 4099 |
|
| 4100 |
|
| 4101 |
|
| 4102 |
|
| 4103 |
|
| 4104 | <h5>Returns:</h5>
|
| 4105 |
|
| 4106 |
|
| 4107 | <div class="param-desc">
|
| 4108 | <p>Whether or not this device is a BIG-IP</p>
|
| 4109 | </div>
|
| 4110 |
|
| 4111 |
|
| 4112 |
|
| 4113 | <dl>
|
| 4114 | <dt>
|
| 4115 | Type
|
| 4116 | </dt>
|
| 4117 | <dd>
|
| 4118 |
|
| 4119 | <span class="param-type">Boolean</span>
|
| 4120 |
|
| 4121 |
|
| 4122 | </dd>
|
| 4123 | </dl>
|
| 4124 |
|
| 4125 |
|
| 4126 |
|
| 4127 |
|
| 4128 |
|
| 4129 |
|
| 4130 |
|
| 4131 |
|
| 4132 |
|
| 4133 |
|
| 4134 |
|
| 4135 |
|
| 4136 |
|
| 4137 | <h4 class="name" id="isBigIq"><span class="type-signature"></span>isBigIq<span class="signature">()</span><span class="type-signature"> → {Boolean}</span></h4>
|
| 4138 |
|
| 4139 |
|
| 4140 |
|
| 4141 |
|
| 4142 |
|
| 4143 |
|
| 4144 | <div class="description">
|
| 4145 | <p>Returns whether or not the device is a BIG-IQ</p>
|
| 4146 | </div>
|
| 4147 |
|
| 4148 |
|
| 4149 |
|
| 4150 |
|
| 4151 |
|
| 4152 |
|
| 4153 |
|
| 4154 |
|
| 4155 |
|
| 4156 |
|
| 4157 |
|
| 4158 |
|
| 4159 |
|
| 4160 | <dl class="details">
|
| 4161 |
|
| 4162 |
|
| 4163 |
|
| 4164 |
|
| 4165 |
|
| 4166 |
|
| 4167 |
|
| 4168 |
|
| 4169 |
|
| 4170 |
|
| 4171 |
|
| 4172 |
|
| 4173 |
|
| 4174 |
|
| 4175 |
|
| 4176 |
|
| 4177 |
|
| 4178 |
|
| 4179 |
|
| 4180 |
|
| 4181 |
|
| 4182 |
|
| 4183 |
|
| 4184 |
|
| 4185 |
|
| 4186 |
|
| 4187 |
|
| 4188 |
|
| 4189 |
|
| 4190 |
|
| 4191 |
|
| 4192 |
|
| 4193 | </dl>
|
| 4194 |
|
| 4195 |
|
| 4196 |
|
| 4197 |
|
| 4198 |
|
| 4199 |
|
| 4200 |
|
| 4201 |
|
| 4202 |
|
| 4203 |
|
| 4204 |
|
| 4205 |
|
| 4206 |
|
| 4207 | <h5>Returns:</h5>
|
| 4208 |
|
| 4209 |
|
| 4210 | <div class="param-desc">
|
| 4211 | <p>Whether or not this device is a BIG-IQ</p>
|
| 4212 | </div>
|
| 4213 |
|
| 4214 |
|
| 4215 |
|
| 4216 | <dl>
|
| 4217 | <dt>
|
| 4218 | Type
|
| 4219 | </dt>
|
| 4220 | <dd>
|
| 4221 |
|
| 4222 | <span class="param-type">Boolean</span>
|
| 4223 |
|
| 4224 |
|
| 4225 | </dd>
|
| 4226 | </dl>
|
| 4227 |
|
| 4228 |
|
| 4229 |
|
| 4230 |
|
| 4231 |
|
| 4232 |
|
| 4233 |
|
| 4234 |
|
| 4235 |
|
| 4236 |
|
| 4237 |
|
| 4238 |
|
| 4239 |
|
| 4240 | <h4 class="name" id="list"><span class="type-signature"></span>list<span class="signature">(path, iControlOptions<span class="signature-attributes">opt</span>, retryOptions<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 4241 |
|
| 4242 |
|
| 4243 |
|
| 4244 |
|
| 4245 |
|
| 4246 |
|
| 4247 | <div class="description">
|
| 4248 | <p>Submits a list (GET) request</p>
|
| 4249 | </div>
|
| 4250 |
|
| 4251 |
|
| 4252 |
|
| 4253 |
|
| 4254 |
|
| 4255 |
|
| 4256 |
|
| 4257 |
|
| 4258 |
|
| 4259 | <h5>Parameters:</h5>
|
| 4260 |
|
| 4261 |
|
| 4262 | <table class="params">
|
| 4263 | <thead>
|
| 4264 | <tr>
|
| 4265 |
|
| 4266 | <th>Name</th>
|
| 4267 |
|
| 4268 |
|
| 4269 | <th>Type</th>
|
| 4270 |
|
| 4271 |
|
| 4272 | <th>Attributes</th>
|
| 4273 |
|
| 4274 |
|
| 4275 |
|
| 4276 |
|
| 4277 | <th class="last">Description</th>
|
| 4278 | </tr>
|
| 4279 | </thead>
|
| 4280 |
|
| 4281 | <tbody>
|
| 4282 |
|
| 4283 |
|
| 4284 | <tr>
|
| 4285 |
|
| 4286 | <td class="name"><code>path</code></td>
|
| 4287 |
|
| 4288 |
|
| 4289 | <td class="type">
|
| 4290 |
|
| 4291 |
|
| 4292 | <span class="param-type">String</span>
|
| 4293 |
|
| 4294 |
|
| 4295 |
|
| 4296 | </td>
|
| 4297 |
|
| 4298 |
|
| 4299 | <td class="attributes">
|
| 4300 |
|
| 4301 |
|
| 4302 |
|
| 4303 |
|
| 4304 |
|
| 4305 | </td>
|
| 4306 |
|
| 4307 |
|
| 4308 |
|
| 4309 |
|
| 4310 | <td class="description last"><p>The path to get.</p></td>
|
| 4311 | </tr>
|
| 4312 |
|
| 4313 |
|
| 4314 |
|
| 4315 | <tr>
|
| 4316 |
|
| 4317 | <td class="name"><code>iControlOptions</code></td>
|
| 4318 |
|
| 4319 |
|
| 4320 | <td class="type">
|
| 4321 |
|
| 4322 |
|
| 4323 | <span class="param-type">Object</span>
|
| 4324 |
|
| 4325 |
|
| 4326 |
|
| 4327 | </td>
|
| 4328 |
|
| 4329 |
|
| 4330 | <td class="attributes">
|
| 4331 |
|
| 4332 | <optional><br>
|
| 4333 |
|
| 4334 |
|
| 4335 |
|
| 4336 |
|
| 4337 |
|
| 4338 | </td>
|
| 4339 |
|
| 4340 |
|
| 4341 |
|
| 4342 |
|
| 4343 | <td class="description last"><p>Options for IControl.</p></td>
|
| 4344 | </tr>
|
| 4345 |
|
| 4346 |
|
| 4347 |
|
| 4348 | <tr>
|
| 4349 |
|
| 4350 | <td class="name"><code>retryOptions</code></td>
|
| 4351 |
|
| 4352 |
|
| 4353 | <td class="type">
|
| 4354 |
|
| 4355 |
|
| 4356 | <span class="param-type">Object</span>
|
| 4357 |
|
| 4358 |
|
| 4359 |
|
| 4360 | </td>
|
| 4361 |
|
| 4362 |
|
| 4363 | <td class="attributes">
|
| 4364 |
|
| 4365 | <optional><br>
|
| 4366 |
|
| 4367 |
|
| 4368 |
|
| 4369 |
|
| 4370 |
|
| 4371 | </td>
|
| 4372 |
|
| 4373 |
|
| 4374 |
|
| 4375 |
|
| 4376 | <td class="description last"><p>Options for retrying the request.</p>
|
| 4377 | <h6>Properties</h6>
|
| 4378 |
|
| 4379 |
|
| 4380 | <table class="params">
|
| 4381 | <thead>
|
| 4382 | <tr>
|
| 4383 |
|
| 4384 | <th>Name</th>
|
| 4385 |
|
| 4386 |
|
| 4387 | <th>Type</th>
|
| 4388 |
|
| 4389 |
|
| 4390 | <th>Attributes</th>
|
| 4391 |
|
| 4392 |
|
| 4393 |
|
| 4394 |
|
| 4395 | <th class="last">Description</th>
|
| 4396 | </tr>
|
| 4397 | </thead>
|
| 4398 |
|
| 4399 | <tbody>
|
| 4400 |
|
| 4401 |
|
| 4402 | <tr>
|
| 4403 |
|
| 4404 | <td class="name"><code>maxRetries</code></td>
|
| 4405 |
|
| 4406 |
|
| 4407 | <td class="type">
|
| 4408 |
|
| 4409 |
|
| 4410 | <span class="param-type">Integer</span>
|
| 4411 |
|
| 4412 |
|
| 4413 |
|
| 4414 | </td>
|
| 4415 |
|
| 4416 |
|
| 4417 | <td class="attributes">
|
| 4418 |
|
| 4419 | <optional><br>
|
| 4420 |
|
| 4421 |
|
| 4422 |
|
| 4423 |
|
| 4424 |
|
| 4425 | </td>
|
| 4426 |
|
| 4427 |
|
| 4428 |
|
| 4429 |
|
| 4430 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 4431 | 0 to not retry. Default 60.</p></td>
|
| 4432 | </tr>
|
| 4433 |
|
| 4434 |
|
| 4435 |
|
| 4436 | <tr>
|
| 4437 |
|
| 4438 | <td class="name"><code>retryIntervalMs</code></td>
|
| 4439 |
|
| 4440 |
|
| 4441 | <td class="type">
|
| 4442 |
|
| 4443 |
|
| 4444 | <span class="param-type">Integer</span>
|
| 4445 |
|
| 4446 |
|
| 4447 |
|
| 4448 | </td>
|
| 4449 |
|
| 4450 |
|
| 4451 | <td class="attributes">
|
| 4452 |
|
| 4453 | <optional><br>
|
| 4454 |
|
| 4455 |
|
| 4456 |
|
| 4457 |
|
| 4458 |
|
| 4459 | </td>
|
| 4460 |
|
| 4461 |
|
| 4462 |
|
| 4463 |
|
| 4464 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 4465 | </tr>
|
| 4466 |
|
| 4467 |
|
| 4468 | </tbody>
|
| 4469 | </table>
|
| 4470 |
|
| 4471 | </td>
|
| 4472 | </tr>
|
| 4473 |
|
| 4474 |
|
| 4475 |
|
| 4476 | <tr>
|
| 4477 |
|
| 4478 | <td class="name"><code>options</code></td>
|
| 4479 |
|
| 4480 |
|
| 4481 | <td class="type">
|
| 4482 |
|
| 4483 |
|
| 4484 | <span class="param-type">Object</span>
|
| 4485 |
|
| 4486 |
|
| 4487 |
|
| 4488 | </td>
|
| 4489 |
|
| 4490 |
|
| 4491 | <td class="attributes">
|
| 4492 |
|
| 4493 | <optional><br>
|
| 4494 |
|
| 4495 |
|
| 4496 |
|
| 4497 |
|
| 4498 |
|
| 4499 | </td>
|
| 4500 |
|
| 4501 |
|
| 4502 |
|
| 4503 |
|
| 4504 | <td class="description last"><p>Options for this method.</p>
|
| 4505 | <h6>Properties</h6>
|
| 4506 |
|
| 4507 |
|
| 4508 | <table class="params">
|
| 4509 | <thead>
|
| 4510 | <tr>
|
| 4511 |
|
| 4512 | <th>Name</th>
|
| 4513 |
|
| 4514 |
|
| 4515 | <th>Type</th>
|
| 4516 |
|
| 4517 |
|
| 4518 | <th>Attributes</th>
|
| 4519 |
|
| 4520 |
|
| 4521 |
|
| 4522 |
|
| 4523 | <th class="last">Description</th>
|
| 4524 | </tr>
|
| 4525 | </thead>
|
| 4526 |
|
| 4527 | <tbody>
|
| 4528 |
|
| 4529 |
|
| 4530 | <tr>
|
| 4531 |
|
| 4532 | <td class="name"><code>silent</code></td>
|
| 4533 |
|
| 4534 |
|
| 4535 | <td class="type">
|
| 4536 |
|
| 4537 |
|
| 4538 | <span class="param-type">Boolen</span>
|
| 4539 |
|
| 4540 |
|
| 4541 |
|
| 4542 | </td>
|
| 4543 |
|
| 4544 |
|
| 4545 | <td class="attributes">
|
| 4546 |
|
| 4547 | <optional><br>
|
| 4548 |
|
| 4549 |
|
| 4550 |
|
| 4551 |
|
| 4552 |
|
| 4553 | </td>
|
| 4554 |
|
| 4555 |
|
| 4556 |
|
| 4557 |
|
| 4558 | <td class="description last"><p>Do not log any info (for requests/repsonses that
|
| 4559 | may contain sensitive information).</p></td>
|
| 4560 | </tr>
|
| 4561 |
|
| 4562 |
|
| 4563 | </tbody>
|
| 4564 | </table>
|
| 4565 |
|
| 4566 | </td>
|
| 4567 | </tr>
|
| 4568 |
|
| 4569 |
|
| 4570 | </tbody>
|
| 4571 | </table>
|
| 4572 |
|
| 4573 |
|
| 4574 |
|
| 4575 |
|
| 4576 |
|
| 4577 |
|
| 4578 | <dl class="details">
|
| 4579 |
|
| 4580 |
|
| 4581 |
|
| 4582 |
|
| 4583 |
|
| 4584 |
|
| 4585 |
|
| 4586 |
|
| 4587 |
|
| 4588 |
|
| 4589 |
|
| 4590 |
|
| 4591 |
|
| 4592 |
|
| 4593 |
|
| 4594 |
|
| 4595 |
|
| 4596 |
|
| 4597 |
|
| 4598 |
|
| 4599 |
|
| 4600 |
|
| 4601 |
|
| 4602 |
|
| 4603 |
|
| 4604 |
|
| 4605 |
|
| 4606 |
|
| 4607 |
|
| 4608 |
|
| 4609 |
|
| 4610 |
|
| 4611 | </dl>
|
| 4612 |
|
| 4613 |
|
| 4614 |
|
| 4615 |
|
| 4616 |
|
| 4617 |
|
| 4618 |
|
| 4619 |
|
| 4620 |
|
| 4621 |
|
| 4622 |
|
| 4623 |
|
| 4624 |
|
| 4625 | <h5>Returns:</h5>
|
| 4626 |
|
| 4627 |
|
| 4628 | <div class="param-desc">
|
| 4629 | <p>A promise which is resolved when the request is complete
|
| 4630 | or rejected if an error occurs.</p>
|
| 4631 | </div>
|
| 4632 |
|
| 4633 |
|
| 4634 |
|
| 4635 | <dl>
|
| 4636 | <dt>
|
| 4637 | Type
|
| 4638 | </dt>
|
| 4639 | <dd>
|
| 4640 |
|
| 4641 | <span class="param-type">Promise</span>
|
| 4642 |
|
| 4643 |
|
| 4644 | </dd>
|
| 4645 | </dl>
|
| 4646 |
|
| 4647 |
|
| 4648 |
|
| 4649 |
|
| 4650 |
|
| 4651 |
|
| 4652 |
|
| 4653 |
|
| 4654 |
|
| 4655 |
|
| 4656 |
|
| 4657 |
|
| 4658 |
|
| 4659 | <h4 class="name" id="loadConfig"><span class="type-signature"></span>loadConfig<span class="signature">(file<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 4660 |
|
| 4661 |
|
| 4662 |
|
| 4663 |
|
| 4664 |
|
| 4665 |
|
| 4666 | <div class="description">
|
| 4667 | <p>Loads sys config</p>
|
| 4668 | </div>
|
| 4669 |
|
| 4670 |
|
| 4671 |
|
| 4672 |
|
| 4673 |
|
| 4674 |
|
| 4675 |
|
| 4676 |
|
| 4677 |
|
| 4678 | <h5>Parameters:</h5>
|
| 4679 |
|
| 4680 |
|
| 4681 | <table class="params">
|
| 4682 | <thead>
|
| 4683 | <tr>
|
| 4684 |
|
| 4685 | <th>Name</th>
|
| 4686 |
|
| 4687 |
|
| 4688 | <th>Type</th>
|
| 4689 |
|
| 4690 |
|
| 4691 | <th>Attributes</th>
|
| 4692 |
|
| 4693 |
|
| 4694 |
|
| 4695 |
|
| 4696 | <th class="last">Description</th>
|
| 4697 | </tr>
|
| 4698 | </thead>
|
| 4699 |
|
| 4700 | <tbody>
|
| 4701 |
|
| 4702 |
|
| 4703 | <tr>
|
| 4704 |
|
| 4705 | <td class="name"><code>file</code></td>
|
| 4706 |
|
| 4707 |
|
| 4708 | <td class="type">
|
| 4709 |
|
| 4710 |
|
| 4711 | <span class="param-type">String</span>
|
| 4712 |
|
| 4713 |
|
| 4714 |
|
| 4715 | </td>
|
| 4716 |
|
| 4717 |
|
| 4718 | <td class="attributes">
|
| 4719 |
|
| 4720 | <optional><br>
|
| 4721 |
|
| 4722 |
|
| 4723 |
|
| 4724 |
|
| 4725 |
|
| 4726 | </td>
|
| 4727 |
|
| 4728 |
|
| 4729 |
|
| 4730 |
|
| 4731 | <td class="description last"><p>Full path on device of file to load. Default is
|
| 4732 | to load the default config.</p></td>
|
| 4733 | </tr>
|
| 4734 |
|
| 4735 |
|
| 4736 |
|
| 4737 | <tr>
|
| 4738 |
|
| 4739 | <td class="name"><code>options</code></td>
|
| 4740 |
|
| 4741 |
|
| 4742 | <td class="type">
|
| 4743 |
|
| 4744 |
|
| 4745 | <span class="param-type">Object</span>
|
| 4746 |
|
| 4747 |
|
| 4748 |
|
| 4749 | </td>
|
| 4750 |
|
| 4751 |
|
| 4752 | <td class="attributes">
|
| 4753 |
|
| 4754 | <optional><br>
|
| 4755 |
|
| 4756 |
|
| 4757 |
|
| 4758 |
|
| 4759 |
|
| 4760 | </td>
|
| 4761 |
|
| 4762 |
|
| 4763 |
|
| 4764 |
|
| 4765 | <td class="description last"><p>Object map of load options
|
| 4766 | (for example, {merge: true})</p></td>
|
| 4767 | </tr>
|
| 4768 |
|
| 4769 |
|
| 4770 |
|
| 4771 | <tr>
|
| 4772 |
|
| 4773 | <td class="name"><code>retryOptions</code></td>
|
| 4774 |
|
| 4775 |
|
| 4776 | <td class="type">
|
| 4777 |
|
| 4778 |
|
| 4779 | <span class="param-type">Object</span>
|
| 4780 |
|
| 4781 |
|
| 4782 |
|
| 4783 | </td>
|
| 4784 |
|
| 4785 |
|
| 4786 | <td class="attributes">
|
| 4787 |
|
| 4788 | <optional><br>
|
| 4789 |
|
| 4790 |
|
| 4791 |
|
| 4792 |
|
| 4793 |
|
| 4794 | </td>
|
| 4795 |
|
| 4796 |
|
| 4797 |
|
| 4798 |
|
| 4799 | <td class="description last"><p>Options for retrying the request.</p>
|
| 4800 | <h6>Properties</h6>
|
| 4801 |
|
| 4802 |
|
| 4803 | <table class="params">
|
| 4804 | <thead>
|
| 4805 | <tr>
|
| 4806 |
|
| 4807 | <th>Name</th>
|
| 4808 |
|
| 4809 |
|
| 4810 | <th>Type</th>
|
| 4811 |
|
| 4812 |
|
| 4813 | <th>Attributes</th>
|
| 4814 |
|
| 4815 |
|
| 4816 |
|
| 4817 |
|
| 4818 | <th class="last">Description</th>
|
| 4819 | </tr>
|
| 4820 | </thead>
|
| 4821 |
|
| 4822 | <tbody>
|
| 4823 |
|
| 4824 |
|
| 4825 | <tr>
|
| 4826 |
|
| 4827 | <td class="name"><code>maxRetries</code></td>
|
| 4828 |
|
| 4829 |
|
| 4830 | <td class="type">
|
| 4831 |
|
| 4832 |
|
| 4833 | <span class="param-type">Integer</span>
|
| 4834 |
|
| 4835 |
|
| 4836 |
|
| 4837 | </td>
|
| 4838 |
|
| 4839 |
|
| 4840 | <td class="attributes">
|
| 4841 |
|
| 4842 | <optional><br>
|
| 4843 |
|
| 4844 |
|
| 4845 |
|
| 4846 |
|
| 4847 |
|
| 4848 | </td>
|
| 4849 |
|
| 4850 |
|
| 4851 |
|
| 4852 |
|
| 4853 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 4854 | 0 to not retry. Default 60.</p></td>
|
| 4855 | </tr>
|
| 4856 |
|
| 4857 |
|
| 4858 |
|
| 4859 | <tr>
|
| 4860 |
|
| 4861 | <td class="name"><code>retryIntervalMs</code></td>
|
| 4862 |
|
| 4863 |
|
| 4864 | <td class="type">
|
| 4865 |
|
| 4866 |
|
| 4867 | <span class="param-type">Integer</span>
|
| 4868 |
|
| 4869 |
|
| 4870 |
|
| 4871 | </td>
|
| 4872 |
|
| 4873 |
|
| 4874 | <td class="attributes">
|
| 4875 |
|
| 4876 | <optional><br>
|
| 4877 |
|
| 4878 |
|
| 4879 |
|
| 4880 |
|
| 4881 |
|
| 4882 | </td>
|
| 4883 |
|
| 4884 |
|
| 4885 |
|
| 4886 |
|
| 4887 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 4888 | </tr>
|
| 4889 |
|
| 4890 |
|
| 4891 | </tbody>
|
| 4892 | </table>
|
| 4893 |
|
| 4894 | </td>
|
| 4895 | </tr>
|
| 4896 |
|
| 4897 |
|
| 4898 | </tbody>
|
| 4899 | </table>
|
| 4900 |
|
| 4901 |
|
| 4902 |
|
| 4903 |
|
| 4904 |
|
| 4905 |
|
| 4906 | <dl class="details">
|
| 4907 |
|
| 4908 |
|
| 4909 |
|
| 4910 |
|
| 4911 |
|
| 4912 |
|
| 4913 |
|
| 4914 |
|
| 4915 |
|
| 4916 |
|
| 4917 |
|
| 4918 |
|
| 4919 |
|
| 4920 |
|
| 4921 |
|
| 4922 |
|
| 4923 |
|
| 4924 |
|
| 4925 |
|
| 4926 |
|
| 4927 |
|
| 4928 |
|
| 4929 |
|
| 4930 |
|
| 4931 |
|
| 4932 |
|
| 4933 |
|
| 4934 |
|
| 4935 |
|
| 4936 |
|
| 4937 |
|
| 4938 |
|
| 4939 | </dl>
|
| 4940 |
|
| 4941 |
|
| 4942 |
|
| 4943 |
|
| 4944 |
|
| 4945 |
|
| 4946 |
|
| 4947 |
|
| 4948 |
|
| 4949 |
|
| 4950 |
|
| 4951 |
|
| 4952 |
|
| 4953 | <h5>Returns:</h5>
|
| 4954 |
|
| 4955 |
|
| 4956 | <div class="param-desc">
|
| 4957 | <p>A promise which is resolved when the config has been
|
| 4958 | loaded or rejected if an error occurs.</p>
|
| 4959 | </div>
|
| 4960 |
|
| 4961 |
|
| 4962 |
|
| 4963 | <dl>
|
| 4964 | <dt>
|
| 4965 | Type
|
| 4966 | </dt>
|
| 4967 | <dd>
|
| 4968 |
|
| 4969 | <span class="param-type">Promise</span>
|
| 4970 |
|
| 4971 |
|
| 4972 | </dd>
|
| 4973 | </dl>
|
| 4974 |
|
| 4975 |
|
| 4976 |
|
| 4977 |
|
| 4978 |
|
| 4979 |
|
| 4980 |
|
| 4981 |
|
| 4982 |
|
| 4983 |
|
| 4984 |
|
| 4985 |
|
| 4986 |
|
| 4987 | <h4 class="name" id="loadUcs"><span class="type-signature"></span>loadUcs<span class="signature">(file, loadOptions<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 4988 |
|
| 4989 |
|
| 4990 |
|
| 4991 |
|
| 4992 |
|
| 4993 |
|
| 4994 | <div class="description">
|
| 4995 | <p>Loads sys UCS</p>
|
| 4996 | </div>
|
| 4997 |
|
| 4998 |
|
| 4999 |
|
| 5000 |
|
| 5001 |
|
| 5002 |
|
| 5003 |
|
| 5004 |
|
| 5005 |
|
| 5006 | <h5>Parameters:</h5>
|
| 5007 |
|
| 5008 |
|
| 5009 | <table class="params">
|
| 5010 | <thead>
|
| 5011 | <tr>
|
| 5012 |
|
| 5013 | <th>Name</th>
|
| 5014 |
|
| 5015 |
|
| 5016 | <th>Type</th>
|
| 5017 |
|
| 5018 |
|
| 5019 | <th>Attributes</th>
|
| 5020 |
|
| 5021 |
|
| 5022 |
|
| 5023 |
|
| 5024 | <th class="last">Description</th>
|
| 5025 | </tr>
|
| 5026 | </thead>
|
| 5027 |
|
| 5028 | <tbody>
|
| 5029 |
|
| 5030 |
|
| 5031 | <tr>
|
| 5032 |
|
| 5033 | <td class="name"><code>file</code></td>
|
| 5034 |
|
| 5035 |
|
| 5036 | <td class="type">
|
| 5037 |
|
| 5038 |
|
| 5039 | <span class="param-type">String</span>
|
| 5040 |
|
| 5041 |
|
| 5042 |
|
| 5043 | </td>
|
| 5044 |
|
| 5045 |
|
| 5046 | <td class="attributes">
|
| 5047 |
|
| 5048 |
|
| 5049 |
|
| 5050 |
|
| 5051 |
|
| 5052 | </td>
|
| 5053 |
|
| 5054 |
|
| 5055 |
|
| 5056 |
|
| 5057 | <td class="description last"><p>Full path on device of file to load.</p></td>
|
| 5058 | </tr>
|
| 5059 |
|
| 5060 |
|
| 5061 |
|
| 5062 | <tr>
|
| 5063 |
|
| 5064 | <td class="name"><code>loadOptions</code></td>
|
| 5065 |
|
| 5066 |
|
| 5067 | <td class="type">
|
| 5068 |
|
| 5069 |
|
| 5070 | <span class="param-type">Object</span>
|
| 5071 |
|
| 5072 |
|
| 5073 |
|
| 5074 | </td>
|
| 5075 |
|
| 5076 |
|
| 5077 | <td class="attributes">
|
| 5078 |
|
| 5079 | <optional><br>
|
| 5080 |
|
| 5081 |
|
| 5082 |
|
| 5083 |
|
| 5084 |
|
| 5085 | </td>
|
| 5086 |
|
| 5087 |
|
| 5088 |
|
| 5089 |
|
| 5090 | <td class="description last"><p>Options for the load ucs task
|
| 5091 | (for example, {noLicense: true, resetTrust: true})</p></td>
|
| 5092 | </tr>
|
| 5093 |
|
| 5094 |
|
| 5095 |
|
| 5096 | <tr>
|
| 5097 |
|
| 5098 | <td class="name"><code>options</code></td>
|
| 5099 |
|
| 5100 |
|
| 5101 | <td class="type">
|
| 5102 |
|
| 5103 |
|
| 5104 | <span class="param-type">Object</span>
|
| 5105 |
|
| 5106 |
|
| 5107 |
|
| 5108 | </td>
|
| 5109 |
|
| 5110 |
|
| 5111 | <td class="attributes">
|
| 5112 |
|
| 5113 | <optional><br>
|
| 5114 |
|
| 5115 |
|
| 5116 |
|
| 5117 |
|
| 5118 |
|
| 5119 | </td>
|
| 5120 |
|
| 5121 |
|
| 5122 |
|
| 5123 |
|
| 5124 | <td class="description last"><p>Options for this command (not the load task itself)</p>
|
| 5125 | <h6>Properties</h6>
|
| 5126 |
|
| 5127 |
|
| 5128 | <table class="params">
|
| 5129 | <thead>
|
| 5130 | <tr>
|
| 5131 |
|
| 5132 | <th>Name</th>
|
| 5133 |
|
| 5134 |
|
| 5135 | <th>Type</th>
|
| 5136 |
|
| 5137 |
|
| 5138 | <th>Attributes</th>
|
| 5139 |
|
| 5140 |
|
| 5141 |
|
| 5142 |
|
| 5143 | <th class="last">Description</th>
|
| 5144 | </tr>
|
| 5145 | </thead>
|
| 5146 |
|
| 5147 | <tbody>
|
| 5148 |
|
| 5149 |
|
| 5150 | <tr>
|
| 5151 |
|
| 5152 | <td class="name"><code>initLocalKeys</code></td>
|
| 5153 |
|
| 5154 |
|
| 5155 | <td class="type">
|
| 5156 |
|
| 5157 |
|
| 5158 | <span class="param-type">Boolean</span>
|
| 5159 |
|
| 5160 |
|
| 5161 |
|
| 5162 | </td>
|
| 5163 |
|
| 5164 |
|
| 5165 | <td class="attributes">
|
| 5166 |
|
| 5167 | <optional><br>
|
| 5168 |
|
| 5169 |
|
| 5170 |
|
| 5171 |
|
| 5172 |
|
| 5173 | </td>
|
| 5174 |
|
| 5175 |
|
| 5176 |
|
| 5177 |
|
| 5178 | <td class="description last"><p>Re-create and install local public/private key pair
|
| 5179 | used for password encryption</p></td>
|
| 5180 | </tr>
|
| 5181 |
|
| 5182 |
|
| 5183 |
|
| 5184 | <tr>
|
| 5185 |
|
| 5186 | <td class="name"><code>restoreUser</code></td>
|
| 5187 |
|
| 5188 |
|
| 5189 | <td class="type">
|
| 5190 |
|
| 5191 |
|
| 5192 | <span class="param-type">Boolean</span>
|
| 5193 |
|
| 5194 |
|
| 5195 |
|
| 5196 | </td>
|
| 5197 |
|
| 5198 |
|
| 5199 | <td class="attributes">
|
| 5200 |
|
| 5201 | <optional><br>
|
| 5202 |
|
| 5203 |
|
| 5204 |
|
| 5205 |
|
| 5206 |
|
| 5207 | </td>
|
| 5208 |
|
| 5209 |
|
| 5210 |
|
| 5211 |
|
| 5212 | <td class="description last"><p>Restore the current user after loading</p></td>
|
| 5213 | </tr>
|
| 5214 |
|
| 5215 |
|
| 5216 | </tbody>
|
| 5217 | </table>
|
| 5218 |
|
| 5219 | </td>
|
| 5220 | </tr>
|
| 5221 |
|
| 5222 |
|
| 5223 |
|
| 5224 | <tr>
|
| 5225 |
|
| 5226 | <td class="name"><code>retryOptions</code></td>
|
| 5227 |
|
| 5228 |
|
| 5229 | <td class="type">
|
| 5230 |
|
| 5231 |
|
| 5232 | <span class="param-type">Object</span>
|
| 5233 |
|
| 5234 |
|
| 5235 |
|
| 5236 | </td>
|
| 5237 |
|
| 5238 |
|
| 5239 | <td class="attributes">
|
| 5240 |
|
| 5241 | <optional><br>
|
| 5242 |
|
| 5243 |
|
| 5244 |
|
| 5245 |
|
| 5246 |
|
| 5247 | </td>
|
| 5248 |
|
| 5249 |
|
| 5250 |
|
| 5251 |
|
| 5252 | <td class="description last"><p>Options for retrying the request.</p>
|
| 5253 | <h6>Properties</h6>
|
| 5254 |
|
| 5255 |
|
| 5256 | <table class="params">
|
| 5257 | <thead>
|
| 5258 | <tr>
|
| 5259 |
|
| 5260 | <th>Name</th>
|
| 5261 |
|
| 5262 |
|
| 5263 | <th>Type</th>
|
| 5264 |
|
| 5265 |
|
| 5266 | <th>Attributes</th>
|
| 5267 |
|
| 5268 |
|
| 5269 |
|
| 5270 |
|
| 5271 | <th class="last">Description</th>
|
| 5272 | </tr>
|
| 5273 | </thead>
|
| 5274 |
|
| 5275 | <tbody>
|
| 5276 |
|
| 5277 |
|
| 5278 | <tr>
|
| 5279 |
|
| 5280 | <td class="name"><code>maxRetries</code></td>
|
| 5281 |
|
| 5282 |
|
| 5283 | <td class="type">
|
| 5284 |
|
| 5285 |
|
| 5286 | <span class="param-type">Integer</span>
|
| 5287 |
|
| 5288 |
|
| 5289 |
|
| 5290 | </td>
|
| 5291 |
|
| 5292 |
|
| 5293 | <td class="attributes">
|
| 5294 |
|
| 5295 | <optional><br>
|
| 5296 |
|
| 5297 |
|
| 5298 |
|
| 5299 |
|
| 5300 |
|
| 5301 | </td>
|
| 5302 |
|
| 5303 |
|
| 5304 |
|
| 5305 |
|
| 5306 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 5307 | 0 to not retry. Default 60.</p></td>
|
| 5308 | </tr>
|
| 5309 |
|
| 5310 |
|
| 5311 |
|
| 5312 | <tr>
|
| 5313 |
|
| 5314 | <td class="name"><code>retryIntervalMs</code></td>
|
| 5315 |
|
| 5316 |
|
| 5317 | <td class="type">
|
| 5318 |
|
| 5319 |
|
| 5320 | <span class="param-type">Integer</span>
|
| 5321 |
|
| 5322 |
|
| 5323 |
|
| 5324 | </td>
|
| 5325 |
|
| 5326 |
|
| 5327 | <td class="attributes">
|
| 5328 |
|
| 5329 | <optional><br>
|
| 5330 |
|
| 5331 |
|
| 5332 |
|
| 5333 |
|
| 5334 |
|
| 5335 | </td>
|
| 5336 |
|
| 5337 |
|
| 5338 |
|
| 5339 |
|
| 5340 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 5341 | </tr>
|
| 5342 |
|
| 5343 |
|
| 5344 | </tbody>
|
| 5345 | </table>
|
| 5346 |
|
| 5347 | </td>
|
| 5348 | </tr>
|
| 5349 |
|
| 5350 |
|
| 5351 | </tbody>
|
| 5352 | </table>
|
| 5353 |
|
| 5354 |
|
| 5355 |
|
| 5356 |
|
| 5357 |
|
| 5358 |
|
| 5359 | <dl class="details">
|
| 5360 |
|
| 5361 |
|
| 5362 |
|
| 5363 |
|
| 5364 |
|
| 5365 |
|
| 5366 |
|
| 5367 |
|
| 5368 |
|
| 5369 |
|
| 5370 |
|
| 5371 |
|
| 5372 |
|
| 5373 |
|
| 5374 |
|
| 5375 |
|
| 5376 |
|
| 5377 |
|
| 5378 |
|
| 5379 |
|
| 5380 |
|
| 5381 |
|
| 5382 |
|
| 5383 |
|
| 5384 |
|
| 5385 |
|
| 5386 |
|
| 5387 |
|
| 5388 |
|
| 5389 |
|
| 5390 |
|
| 5391 |
|
| 5392 | </dl>
|
| 5393 |
|
| 5394 |
|
| 5395 |
|
| 5396 |
|
| 5397 |
|
| 5398 |
|
| 5399 |
|
| 5400 |
|
| 5401 |
|
| 5402 |
|
| 5403 |
|
| 5404 |
|
| 5405 |
|
| 5406 | <h5>Returns:</h5>
|
| 5407 |
|
| 5408 |
|
| 5409 | <div class="param-desc">
|
| 5410 | <p>A promise which is resolved when the config has been
|
| 5411 | loaded or rejected if an error occurs.</p>
|
| 5412 | </div>
|
| 5413 |
|
| 5414 |
|
| 5415 |
|
| 5416 | <dl>
|
| 5417 | <dt>
|
| 5418 | Type
|
| 5419 | </dt>
|
| 5420 | <dd>
|
| 5421 |
|
| 5422 | <span class="param-type">Promise</span>
|
| 5423 |
|
| 5424 |
|
| 5425 | </dd>
|
| 5426 | </dl>
|
| 5427 |
|
| 5428 |
|
| 5429 |
|
| 5430 |
|
| 5431 |
|
| 5432 |
|
| 5433 |
|
| 5434 |
|
| 5435 |
|
| 5436 |
|
| 5437 |
|
| 5438 |
|
| 5439 |
|
| 5440 | <h4 class="name" id="modify"><span class="type-signature"></span>modify<span class="signature">(path, body, iControlOptions<span class="signature-attributes">opt</span>, retryOptions<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 5441 |
|
| 5442 |
|
| 5443 |
|
| 5444 |
|
| 5445 |
|
| 5446 |
|
| 5447 | <div class="description">
|
| 5448 | <p>Submits a modify (PATCH) request</p>
|
| 5449 | </div>
|
| 5450 |
|
| 5451 |
|
| 5452 |
|
| 5453 |
|
| 5454 |
|
| 5455 |
|
| 5456 |
|
| 5457 |
|
| 5458 |
|
| 5459 | <h5>Parameters:</h5>
|
| 5460 |
|
| 5461 |
|
| 5462 | <table class="params">
|
| 5463 | <thead>
|
| 5464 | <tr>
|
| 5465 |
|
| 5466 | <th>Name</th>
|
| 5467 |
|
| 5468 |
|
| 5469 | <th>Type</th>
|
| 5470 |
|
| 5471 |
|
| 5472 | <th>Attributes</th>
|
| 5473 |
|
| 5474 |
|
| 5475 |
|
| 5476 |
|
| 5477 | <th class="last">Description</th>
|
| 5478 | </tr>
|
| 5479 | </thead>
|
| 5480 |
|
| 5481 | <tbody>
|
| 5482 |
|
| 5483 |
|
| 5484 | <tr>
|
| 5485 |
|
| 5486 | <td class="name"><code>path</code></td>
|
| 5487 |
|
| 5488 |
|
| 5489 | <td class="type">
|
| 5490 |
|
| 5491 |
|
| 5492 | <span class="param-type">String</span>
|
| 5493 |
|
| 5494 |
|
| 5495 |
|
| 5496 | </td>
|
| 5497 |
|
| 5498 |
|
| 5499 | <td class="attributes">
|
| 5500 |
|
| 5501 |
|
| 5502 |
|
| 5503 |
|
| 5504 |
|
| 5505 | </td>
|
| 5506 |
|
| 5507 |
|
| 5508 |
|
| 5509 |
|
| 5510 | <td class="description last"><p>The path to patch.</p></td>
|
| 5511 | </tr>
|
| 5512 |
|
| 5513 |
|
| 5514 |
|
| 5515 | <tr>
|
| 5516 |
|
| 5517 | <td class="name"><code>body</code></td>
|
| 5518 |
|
| 5519 |
|
| 5520 | <td class="type">
|
| 5521 |
|
| 5522 |
|
| 5523 | <span class="param-type">Object</span>
|
| 5524 |
|
| 5525 |
|
| 5526 |
|
| 5527 | </td>
|
| 5528 |
|
| 5529 |
|
| 5530 | <td class="attributes">
|
| 5531 |
|
| 5532 |
|
| 5533 |
|
| 5534 |
|
| 5535 |
|
| 5536 | </td>
|
| 5537 |
|
| 5538 |
|
| 5539 |
|
| 5540 |
|
| 5541 | <td class="description last"><p>The body for the patch request.</p></td>
|
| 5542 | </tr>
|
| 5543 |
|
| 5544 |
|
| 5545 |
|
| 5546 | <tr>
|
| 5547 |
|
| 5548 | <td class="name"><code>iControlOptions</code></td>
|
| 5549 |
|
| 5550 |
|
| 5551 | <td class="type">
|
| 5552 |
|
| 5553 |
|
| 5554 | <span class="param-type">Object</span>
|
| 5555 |
|
| 5556 |
|
| 5557 |
|
| 5558 | </td>
|
| 5559 |
|
| 5560 |
|
| 5561 | <td class="attributes">
|
| 5562 |
|
| 5563 | <optional><br>
|
| 5564 |
|
| 5565 |
|
| 5566 |
|
| 5567 |
|
| 5568 |
|
| 5569 | </td>
|
| 5570 |
|
| 5571 |
|
| 5572 |
|
| 5573 |
|
| 5574 | <td class="description last"><p>Options for IControl.</p></td>
|
| 5575 | </tr>
|
| 5576 |
|
| 5577 |
|
| 5578 |
|
| 5579 | <tr>
|
| 5580 |
|
| 5581 | <td class="name"><code>retryOptions</code></td>
|
| 5582 |
|
| 5583 |
|
| 5584 | <td class="type">
|
| 5585 |
|
| 5586 |
|
| 5587 | <span class="param-type">Object</span>
|
| 5588 |
|
| 5589 |
|
| 5590 |
|
| 5591 | </td>
|
| 5592 |
|
| 5593 |
|
| 5594 | <td class="attributes">
|
| 5595 |
|
| 5596 | <optional><br>
|
| 5597 |
|
| 5598 |
|
| 5599 |
|
| 5600 |
|
| 5601 |
|
| 5602 | </td>
|
| 5603 |
|
| 5604 |
|
| 5605 |
|
| 5606 |
|
| 5607 | <td class="description last"><p>Options for retrying the request.</p>
|
| 5608 | <h6>Properties</h6>
|
| 5609 |
|
| 5610 |
|
| 5611 | <table class="params">
|
| 5612 | <thead>
|
| 5613 | <tr>
|
| 5614 |
|
| 5615 | <th>Name</th>
|
| 5616 |
|
| 5617 |
|
| 5618 | <th>Type</th>
|
| 5619 |
|
| 5620 |
|
| 5621 | <th>Attributes</th>
|
| 5622 |
|
| 5623 |
|
| 5624 |
|
| 5625 |
|
| 5626 | <th class="last">Description</th>
|
| 5627 | </tr>
|
| 5628 | </thead>
|
| 5629 |
|
| 5630 | <tbody>
|
| 5631 |
|
| 5632 |
|
| 5633 | <tr>
|
| 5634 |
|
| 5635 | <td class="name"><code>maxRetries</code></td>
|
| 5636 |
|
| 5637 |
|
| 5638 | <td class="type">
|
| 5639 |
|
| 5640 |
|
| 5641 | <span class="param-type">Integer</span>
|
| 5642 |
|
| 5643 |
|
| 5644 |
|
| 5645 | </td>
|
| 5646 |
|
| 5647 |
|
| 5648 | <td class="attributes">
|
| 5649 |
|
| 5650 | <optional><br>
|
| 5651 |
|
| 5652 |
|
| 5653 |
|
| 5654 |
|
| 5655 |
|
| 5656 | </td>
|
| 5657 |
|
| 5658 |
|
| 5659 |
|
| 5660 |
|
| 5661 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 5662 | 0 to not retry. Default 60.</p></td>
|
| 5663 | </tr>
|
| 5664 |
|
| 5665 |
|
| 5666 |
|
| 5667 | <tr>
|
| 5668 |
|
| 5669 | <td class="name"><code>retryIntervalMs</code></td>
|
| 5670 |
|
| 5671 |
|
| 5672 | <td class="type">
|
| 5673 |
|
| 5674 |
|
| 5675 | <span class="param-type">Integer</span>
|
| 5676 |
|
| 5677 |
|
| 5678 |
|
| 5679 | </td>
|
| 5680 |
|
| 5681 |
|
| 5682 | <td class="attributes">
|
| 5683 |
|
| 5684 | <optional><br>
|
| 5685 |
|
| 5686 |
|
| 5687 |
|
| 5688 |
|
| 5689 |
|
| 5690 | </td>
|
| 5691 |
|
| 5692 |
|
| 5693 |
|
| 5694 |
|
| 5695 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 5696 | </tr>
|
| 5697 |
|
| 5698 |
|
| 5699 | </tbody>
|
| 5700 | </table>
|
| 5701 |
|
| 5702 | </td>
|
| 5703 | </tr>
|
| 5704 |
|
| 5705 |
|
| 5706 |
|
| 5707 | <tr>
|
| 5708 |
|
| 5709 | <td class="name"><code>options</code></td>
|
| 5710 |
|
| 5711 |
|
| 5712 | <td class="type">
|
| 5713 |
|
| 5714 |
|
| 5715 | <span class="param-type">Object</span>
|
| 5716 |
|
| 5717 |
|
| 5718 |
|
| 5719 | </td>
|
| 5720 |
|
| 5721 |
|
| 5722 | <td class="attributes">
|
| 5723 |
|
| 5724 | <optional><br>
|
| 5725 |
|
| 5726 |
|
| 5727 |
|
| 5728 |
|
| 5729 |
|
| 5730 | </td>
|
| 5731 |
|
| 5732 |
|
| 5733 |
|
| 5734 |
|
| 5735 | <td class="description last"><p>Options for this method.</p>
|
| 5736 | <h6>Properties</h6>
|
| 5737 |
|
| 5738 |
|
| 5739 | <table class="params">
|
| 5740 | <thead>
|
| 5741 | <tr>
|
| 5742 |
|
| 5743 | <th>Name</th>
|
| 5744 |
|
| 5745 |
|
| 5746 | <th>Type</th>
|
| 5747 |
|
| 5748 |
|
| 5749 | <th>Attributes</th>
|
| 5750 |
|
| 5751 |
|
| 5752 |
|
| 5753 |
|
| 5754 | <th class="last">Description</th>
|
| 5755 | </tr>
|
| 5756 | </thead>
|
| 5757 |
|
| 5758 | <tbody>
|
| 5759 |
|
| 5760 |
|
| 5761 | <tr>
|
| 5762 |
|
| 5763 | <td class="name"><code>silent</code></td>
|
| 5764 |
|
| 5765 |
|
| 5766 | <td class="type">
|
| 5767 |
|
| 5768 |
|
| 5769 | <span class="param-type">Boolen</span>
|
| 5770 |
|
| 5771 |
|
| 5772 |
|
| 5773 | </td>
|
| 5774 |
|
| 5775 |
|
| 5776 | <td class="attributes">
|
| 5777 |
|
| 5778 | <optional><br>
|
| 5779 |
|
| 5780 |
|
| 5781 |
|
| 5782 |
|
| 5783 |
|
| 5784 | </td>
|
| 5785 |
|
| 5786 |
|
| 5787 |
|
| 5788 |
|
| 5789 | <td class="description last"><p>Do not log any info (for requests/repsonses that
|
| 5790 | may contain sensitive information).</p></td>
|
| 5791 | </tr>
|
| 5792 |
|
| 5793 |
|
| 5794 | </tbody>
|
| 5795 | </table>
|
| 5796 |
|
| 5797 | </td>
|
| 5798 | </tr>
|
| 5799 |
|
| 5800 |
|
| 5801 | </tbody>
|
| 5802 | </table>
|
| 5803 |
|
| 5804 |
|
| 5805 |
|
| 5806 |
|
| 5807 |
|
| 5808 |
|
| 5809 | <dl class="details">
|
| 5810 |
|
| 5811 |
|
| 5812 |
|
| 5813 |
|
| 5814 |
|
| 5815 |
|
| 5816 |
|
| 5817 |
|
| 5818 |
|
| 5819 |
|
| 5820 |
|
| 5821 |
|
| 5822 |
|
| 5823 |
|
| 5824 |
|
| 5825 |
|
| 5826 |
|
| 5827 |
|
| 5828 |
|
| 5829 |
|
| 5830 |
|
| 5831 |
|
| 5832 |
|
| 5833 |
|
| 5834 |
|
| 5835 |
|
| 5836 |
|
| 5837 |
|
| 5838 |
|
| 5839 |
|
| 5840 |
|
| 5841 |
|
| 5842 | </dl>
|
| 5843 |
|
| 5844 |
|
| 5845 |
|
| 5846 |
|
| 5847 |
|
| 5848 |
|
| 5849 |
|
| 5850 |
|
| 5851 |
|
| 5852 |
|
| 5853 |
|
| 5854 |
|
| 5855 |
|
| 5856 | <h5>Returns:</h5>
|
| 5857 |
|
| 5858 |
|
| 5859 | <div class="param-desc">
|
| 5860 | <p>A promise which is resolved when the request is complete
|
| 5861 | or rejected if an error occurs.</p>
|
| 5862 | </div>
|
| 5863 |
|
| 5864 |
|
| 5865 |
|
| 5866 | <dl>
|
| 5867 | <dt>
|
| 5868 | Type
|
| 5869 | </dt>
|
| 5870 | <dd>
|
| 5871 |
|
| 5872 | <span class="param-type">Promise</span>
|
| 5873 |
|
| 5874 |
|
| 5875 | </dd>
|
| 5876 | </dl>
|
| 5877 |
|
| 5878 |
|
| 5879 |
|
| 5880 |
|
| 5881 |
|
| 5882 |
|
| 5883 |
|
| 5884 |
|
| 5885 |
|
| 5886 |
|
| 5887 |
|
| 5888 |
|
| 5889 |
|
| 5890 | <h4 class="name" id="ping"><span class="type-signature"></span>ping<span class="signature">(address, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 5891 |
|
| 5892 |
|
| 5893 |
|
| 5894 |
|
| 5895 |
|
| 5896 |
|
| 5897 | <div class="description">
|
| 5898 | <p>Pings a given address once</p>
|
| 5899 | </div>
|
| 5900 |
|
| 5901 |
|
| 5902 |
|
| 5903 |
|
| 5904 |
|
| 5905 |
|
| 5906 |
|
| 5907 |
|
| 5908 |
|
| 5909 | <h5>Parameters:</h5>
|
| 5910 |
|
| 5911 |
|
| 5912 | <table class="params">
|
| 5913 | <thead>
|
| 5914 | <tr>
|
| 5915 |
|
| 5916 | <th>Name</th>
|
| 5917 |
|
| 5918 |
|
| 5919 | <th>Type</th>
|
| 5920 |
|
| 5921 |
|
| 5922 | <th>Attributes</th>
|
| 5923 |
|
| 5924 |
|
| 5925 |
|
| 5926 |
|
| 5927 | <th class="last">Description</th>
|
| 5928 | </tr>
|
| 5929 | </thead>
|
| 5930 |
|
| 5931 | <tbody>
|
| 5932 |
|
| 5933 |
|
| 5934 | <tr>
|
| 5935 |
|
| 5936 | <td class="name"><code>address</code></td>
|
| 5937 |
|
| 5938 |
|
| 5939 | <td class="type">
|
| 5940 |
|
| 5941 |
|
| 5942 | <span class="param-type">String</span>
|
| 5943 |
|
| 5944 |
|
| 5945 |
|
| 5946 | </td>
|
| 5947 |
|
| 5948 |
|
| 5949 | <td class="attributes">
|
| 5950 |
|
| 5951 |
|
| 5952 |
|
| 5953 |
|
| 5954 |
|
| 5955 | </td>
|
| 5956 |
|
| 5957 |
|
| 5958 |
|
| 5959 |
|
| 5960 | <td class="description last"><p>IP address or hostname to ping.</p></td>
|
| 5961 | </tr>
|
| 5962 |
|
| 5963 |
|
| 5964 |
|
| 5965 | <tr>
|
| 5966 |
|
| 5967 | <td class="name"><code>retryOptions</code></td>
|
| 5968 |
|
| 5969 |
|
| 5970 | <td class="type">
|
| 5971 |
|
| 5972 |
|
| 5973 | <span class="param-type">Object</span>
|
| 5974 |
|
| 5975 |
|
| 5976 |
|
| 5977 | </td>
|
| 5978 |
|
| 5979 |
|
| 5980 | <td class="attributes">
|
| 5981 |
|
| 5982 | <optional><br>
|
| 5983 |
|
| 5984 |
|
| 5985 |
|
| 5986 |
|
| 5987 |
|
| 5988 | </td>
|
| 5989 |
|
| 5990 |
|
| 5991 |
|
| 5992 |
|
| 5993 | <td class="description last"><p>Options for retrying the request.</p>
|
| 5994 | <h6>Properties</h6>
|
| 5995 |
|
| 5996 |
|
| 5997 | <table class="params">
|
| 5998 | <thead>
|
| 5999 | <tr>
|
| 6000 |
|
| 6001 | <th>Name</th>
|
| 6002 |
|
| 6003 |
|
| 6004 | <th>Type</th>
|
| 6005 |
|
| 6006 |
|
| 6007 | <th>Attributes</th>
|
| 6008 |
|
| 6009 |
|
| 6010 |
|
| 6011 |
|
| 6012 | <th class="last">Description</th>
|
| 6013 | </tr>
|
| 6014 | </thead>
|
| 6015 |
|
| 6016 | <tbody>
|
| 6017 |
|
| 6018 |
|
| 6019 | <tr>
|
| 6020 |
|
| 6021 | <td class="name"><code>maxRetries</code></td>
|
| 6022 |
|
| 6023 |
|
| 6024 | <td class="type">
|
| 6025 |
|
| 6026 |
|
| 6027 | <span class="param-type">Integer</span>
|
| 6028 |
|
| 6029 |
|
| 6030 |
|
| 6031 | </td>
|
| 6032 |
|
| 6033 |
|
| 6034 | <td class="attributes">
|
| 6035 |
|
| 6036 | <optional><br>
|
| 6037 |
|
| 6038 |
|
| 6039 |
|
| 6040 |
|
| 6041 |
|
| 6042 | </td>
|
| 6043 |
|
| 6044 |
|
| 6045 |
|
| 6046 |
|
| 6047 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 6048 | 0 to not retry. Default 60.</p></td>
|
| 6049 | </tr>
|
| 6050 |
|
| 6051 |
|
| 6052 |
|
| 6053 | <tr>
|
| 6054 |
|
| 6055 | <td class="name"><code>retryIntervalMs</code></td>
|
| 6056 |
|
| 6057 |
|
| 6058 | <td class="type">
|
| 6059 |
|
| 6060 |
|
| 6061 | <span class="param-type">Integer</span>
|
| 6062 |
|
| 6063 |
|
| 6064 |
|
| 6065 | </td>
|
| 6066 |
|
| 6067 |
|
| 6068 | <td class="attributes">
|
| 6069 |
|
| 6070 | <optional><br>
|
| 6071 |
|
| 6072 |
|
| 6073 |
|
| 6074 |
|
| 6075 |
|
| 6076 | </td>
|
| 6077 |
|
| 6078 |
|
| 6079 |
|
| 6080 |
|
| 6081 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 6082 | </tr>
|
| 6083 |
|
| 6084 |
|
| 6085 | </tbody>
|
| 6086 | </table>
|
| 6087 |
|
| 6088 | </td>
|
| 6089 | </tr>
|
| 6090 |
|
| 6091 |
|
| 6092 | </tbody>
|
| 6093 | </table>
|
| 6094 |
|
| 6095 |
|
| 6096 |
|
| 6097 |
|
| 6098 |
|
| 6099 |
|
| 6100 | <dl class="details">
|
| 6101 |
|
| 6102 |
|
| 6103 |
|
| 6104 |
|
| 6105 |
|
| 6106 |
|
| 6107 |
|
| 6108 |
|
| 6109 |
|
| 6110 |
|
| 6111 |
|
| 6112 |
|
| 6113 |
|
| 6114 |
|
| 6115 |
|
| 6116 |
|
| 6117 |
|
| 6118 |
|
| 6119 |
|
| 6120 |
|
| 6121 |
|
| 6122 |
|
| 6123 |
|
| 6124 |
|
| 6125 |
|
| 6126 |
|
| 6127 |
|
| 6128 |
|
| 6129 |
|
| 6130 |
|
| 6131 |
|
| 6132 |
|
| 6133 | </dl>
|
| 6134 |
|
| 6135 |
|
| 6136 |
|
| 6137 |
|
| 6138 |
|
| 6139 |
|
| 6140 |
|
| 6141 |
|
| 6142 |
|
| 6143 |
|
| 6144 |
|
| 6145 |
|
| 6146 |
|
| 6147 | <h5>Returns:</h5>
|
| 6148 |
|
| 6149 |
|
| 6150 | <div class="param-desc">
|
| 6151 | <p>A promise which is resolved if the ping succeeds
|
| 6152 | or rejected if an error occurs.</p>
|
| 6153 | </div>
|
| 6154 |
|
| 6155 |
|
| 6156 |
|
| 6157 | <dl>
|
| 6158 | <dt>
|
| 6159 | Type
|
| 6160 | </dt>
|
| 6161 | <dd>
|
| 6162 |
|
| 6163 | <span class="param-type">Promise</span>
|
| 6164 |
|
| 6165 |
|
| 6166 | </dd>
|
| 6167 | </dl>
|
| 6168 |
|
| 6169 |
|
| 6170 |
|
| 6171 |
|
| 6172 |
|
| 6173 |
|
| 6174 |
|
| 6175 |
|
| 6176 |
|
| 6177 |
|
| 6178 |
|
| 6179 |
|
| 6180 |
|
| 6181 | <h4 class="name" id="ready"><span class="type-signature"></span>ready<span class="signature">(retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 6182 |
|
| 6183 |
|
| 6184 |
|
| 6185 |
|
| 6186 |
|
| 6187 |
|
| 6188 | <div class="description">
|
| 6189 | <p>Resolves when device is ready.</p>
|
| 6190 | <p>Device is determined to be ready when the nodejs echo-js worker
|
| 6191 | is ready.</p>
|
| 6192 | </div>
|
| 6193 |
|
| 6194 |
|
| 6195 |
|
| 6196 |
|
| 6197 |
|
| 6198 |
|
| 6199 |
|
| 6200 |
|
| 6201 |
|
| 6202 | <h5>Parameters:</h5>
|
| 6203 |
|
| 6204 |
|
| 6205 | <table class="params">
|
| 6206 | <thead>
|
| 6207 | <tr>
|
| 6208 |
|
| 6209 | <th>Name</th>
|
| 6210 |
|
| 6211 |
|
| 6212 | <th>Type</th>
|
| 6213 |
|
| 6214 |
|
| 6215 | <th>Attributes</th>
|
| 6216 |
|
| 6217 |
|
| 6218 |
|
| 6219 |
|
| 6220 | <th class="last">Description</th>
|
| 6221 | </tr>
|
| 6222 | </thead>
|
| 6223 |
|
| 6224 | <tbody>
|
| 6225 |
|
| 6226 |
|
| 6227 | <tr>
|
| 6228 |
|
| 6229 | <td class="name"><code>retryOptions</code></td>
|
| 6230 |
|
| 6231 |
|
| 6232 | <td class="type">
|
| 6233 |
|
| 6234 |
|
| 6235 | <span class="param-type">Object</span>
|
| 6236 |
|
| 6237 |
|
| 6238 |
|
| 6239 | </td>
|
| 6240 |
|
| 6241 |
|
| 6242 | <td class="attributes">
|
| 6243 |
|
| 6244 | <optional><br>
|
| 6245 |
|
| 6246 |
|
| 6247 |
|
| 6248 |
|
| 6249 |
|
| 6250 | </td>
|
| 6251 |
|
| 6252 |
|
| 6253 |
|
| 6254 |
|
| 6255 | <td class="description last"><p>Options for retrying the request.</p>
|
| 6256 | <h6>Properties</h6>
|
| 6257 |
|
| 6258 |
|
| 6259 | <table class="params">
|
| 6260 | <thead>
|
| 6261 | <tr>
|
| 6262 |
|
| 6263 | <th>Name</th>
|
| 6264 |
|
| 6265 |
|
| 6266 | <th>Type</th>
|
| 6267 |
|
| 6268 |
|
| 6269 | <th>Attributes</th>
|
| 6270 |
|
| 6271 |
|
| 6272 |
|
| 6273 |
|
| 6274 | <th class="last">Description</th>
|
| 6275 | </tr>
|
| 6276 | </thead>
|
| 6277 |
|
| 6278 | <tbody>
|
| 6279 |
|
| 6280 |
|
| 6281 | <tr>
|
| 6282 |
|
| 6283 | <td class="name"><code>maxRetries</code></td>
|
| 6284 |
|
| 6285 |
|
| 6286 | <td class="type">
|
| 6287 |
|
| 6288 |
|
| 6289 | <span class="param-type">Integer</span>
|
| 6290 |
|
| 6291 |
|
| 6292 |
|
| 6293 | </td>
|
| 6294 |
|
| 6295 |
|
| 6296 | <td class="attributes">
|
| 6297 |
|
| 6298 | <optional><br>
|
| 6299 |
|
| 6300 |
|
| 6301 |
|
| 6302 |
|
| 6303 |
|
| 6304 | </td>
|
| 6305 |
|
| 6306 |
|
| 6307 |
|
| 6308 |
|
| 6309 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 6310 | 0 to not retry. Default 60.</p></td>
|
| 6311 | </tr>
|
| 6312 |
|
| 6313 |
|
| 6314 |
|
| 6315 | <tr>
|
| 6316 |
|
| 6317 | <td class="name"><code>retryIntervalMs</code></td>
|
| 6318 |
|
| 6319 |
|
| 6320 | <td class="type">
|
| 6321 |
|
| 6322 |
|
| 6323 | <span class="param-type">Integer</span>
|
| 6324 |
|
| 6325 |
|
| 6326 |
|
| 6327 | </td>
|
| 6328 |
|
| 6329 |
|
| 6330 | <td class="attributes">
|
| 6331 |
|
| 6332 | <optional><br>
|
| 6333 |
|
| 6334 |
|
| 6335 |
|
| 6336 |
|
| 6337 |
|
| 6338 | </td>
|
| 6339 |
|
| 6340 |
|
| 6341 |
|
| 6342 |
|
| 6343 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 6344 | </tr>
|
| 6345 |
|
| 6346 |
|
| 6347 | </tbody>
|
| 6348 | </table>
|
| 6349 |
|
| 6350 | </td>
|
| 6351 | </tr>
|
| 6352 |
|
| 6353 |
|
| 6354 | </tbody>
|
| 6355 | </table>
|
| 6356 |
|
| 6357 |
|
| 6358 |
|
| 6359 |
|
| 6360 |
|
| 6361 |
|
| 6362 | <dl class="details">
|
| 6363 |
|
| 6364 |
|
| 6365 |
|
| 6366 |
|
| 6367 |
|
| 6368 |
|
| 6369 |
|
| 6370 |
|
| 6371 |
|
| 6372 |
|
| 6373 |
|
| 6374 |
|
| 6375 |
|
| 6376 |
|
| 6377 |
|
| 6378 |
|
| 6379 |
|
| 6380 |
|
| 6381 |
|
| 6382 |
|
| 6383 |
|
| 6384 |
|
| 6385 |
|
| 6386 |
|
| 6387 |
|
| 6388 |
|
| 6389 |
|
| 6390 |
|
| 6391 |
|
| 6392 |
|
| 6393 |
|
| 6394 |
|
| 6395 | </dl>
|
| 6396 |
|
| 6397 |
|
| 6398 |
|
| 6399 |
|
| 6400 |
|
| 6401 |
|
| 6402 |
|
| 6403 |
|
| 6404 |
|
| 6405 |
|
| 6406 |
|
| 6407 |
|
| 6408 |
|
| 6409 | <h5>Returns:</h5>
|
| 6410 |
|
| 6411 |
|
| 6412 | <div class="param-desc">
|
| 6413 | <p>A Promise which is resolved when device is ready
|
| 6414 | or rejected after trying a fixed number of times.</p>
|
| 6415 | </div>
|
| 6416 |
|
| 6417 |
|
| 6418 |
|
| 6419 | <dl>
|
| 6420 | <dt>
|
| 6421 | Type
|
| 6422 | </dt>
|
| 6423 | <dd>
|
| 6424 |
|
| 6425 | <span class="param-type">Promise</span>
|
| 6426 |
|
| 6427 |
|
| 6428 | </dd>
|
| 6429 | </dl>
|
| 6430 |
|
| 6431 |
|
| 6432 |
|
| 6433 |
|
| 6434 |
|
| 6435 |
|
| 6436 |
|
| 6437 |
|
| 6438 |
|
| 6439 |
|
| 6440 |
|
| 6441 |
|
| 6442 |
|
| 6443 | <h4 class="name" id="reboot"><span class="type-signature"></span>reboot<span class="signature">()</span><span class="type-signature"></span></h4>
|
| 6444 |
|
| 6445 |
|
| 6446 |
|
| 6447 |
|
| 6448 |
|
| 6449 |
|
| 6450 | <div class="description">
|
| 6451 | <p>Reboots the device</p>
|
| 6452 | </div>
|
| 6453 |
|
| 6454 |
|
| 6455 |
|
| 6456 |
|
| 6457 |
|
| 6458 |
|
| 6459 |
|
| 6460 |
|
| 6461 |
|
| 6462 |
|
| 6463 |
|
| 6464 |
|
| 6465 |
|
| 6466 | <dl class="details">
|
| 6467 |
|
| 6468 |
|
| 6469 |
|
| 6470 |
|
| 6471 |
|
| 6472 |
|
| 6473 |
|
| 6474 |
|
| 6475 |
|
| 6476 |
|
| 6477 |
|
| 6478 |
|
| 6479 |
|
| 6480 |
|
| 6481 |
|
| 6482 |
|
| 6483 |
|
| 6484 |
|
| 6485 |
|
| 6486 |
|
| 6487 |
|
| 6488 |
|
| 6489 |
|
| 6490 |
|
| 6491 |
|
| 6492 |
|
| 6493 |
|
| 6494 |
|
| 6495 |
|
| 6496 |
|
| 6497 |
|
| 6498 |
|
| 6499 | </dl>
|
| 6500 |
|
| 6501 |
|
| 6502 |
|
| 6503 |
|
| 6504 |
|
| 6505 |
|
| 6506 |
|
| 6507 |
|
| 6508 |
|
| 6509 |
|
| 6510 |
|
| 6511 |
|
| 6512 |
|
| 6513 |
|
| 6514 |
|
| 6515 |
|
| 6516 |
|
| 6517 |
|
| 6518 |
|
| 6519 |
|
| 6520 |
|
| 6521 |
|
| 6522 |
|
| 6523 |
|
| 6524 | <h4 class="name" id="rebootRequired"><span class="type-signature"></span>rebootRequired<span class="signature">(retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 6525 |
|
| 6526 |
|
| 6527 |
|
| 6528 |
|
| 6529 |
|
| 6530 |
|
| 6531 | <div class="description">
|
| 6532 | <p>Checks to see if the device needs to be rebooted</p>
|
| 6533 | </div>
|
| 6534 |
|
| 6535 |
|
| 6536 |
|
| 6537 |
|
| 6538 |
|
| 6539 |
|
| 6540 |
|
| 6541 |
|
| 6542 |
|
| 6543 | <h5>Parameters:</h5>
|
| 6544 |
|
| 6545 |
|
| 6546 | <table class="params">
|
| 6547 | <thead>
|
| 6548 | <tr>
|
| 6549 |
|
| 6550 | <th>Name</th>
|
| 6551 |
|
| 6552 |
|
| 6553 | <th>Type</th>
|
| 6554 |
|
| 6555 |
|
| 6556 | <th>Attributes</th>
|
| 6557 |
|
| 6558 |
|
| 6559 |
|
| 6560 |
|
| 6561 | <th class="last">Description</th>
|
| 6562 | </tr>
|
| 6563 | </thead>
|
| 6564 |
|
| 6565 | <tbody>
|
| 6566 |
|
| 6567 |
|
| 6568 | <tr>
|
| 6569 |
|
| 6570 | <td class="name"><code>retryOptions</code></td>
|
| 6571 |
|
| 6572 |
|
| 6573 | <td class="type">
|
| 6574 |
|
| 6575 |
|
| 6576 | <span class="param-type">Object</span>
|
| 6577 |
|
| 6578 |
|
| 6579 |
|
| 6580 | </td>
|
| 6581 |
|
| 6582 |
|
| 6583 | <td class="attributes">
|
| 6584 |
|
| 6585 | <optional><br>
|
| 6586 |
|
| 6587 |
|
| 6588 |
|
| 6589 |
|
| 6590 |
|
| 6591 | </td>
|
| 6592 |
|
| 6593 |
|
| 6594 |
|
| 6595 |
|
| 6596 | <td class="description last"><p>Options for retrying the request.</p>
|
| 6597 | <h6>Properties</h6>
|
| 6598 |
|
| 6599 |
|
| 6600 | <table class="params">
|
| 6601 | <thead>
|
| 6602 | <tr>
|
| 6603 |
|
| 6604 | <th>Name</th>
|
| 6605 |
|
| 6606 |
|
| 6607 | <th>Type</th>
|
| 6608 |
|
| 6609 |
|
| 6610 | <th>Attributes</th>
|
| 6611 |
|
| 6612 |
|
| 6613 |
|
| 6614 |
|
| 6615 | <th class="last">Description</th>
|
| 6616 | </tr>
|
| 6617 | </thead>
|
| 6618 |
|
| 6619 | <tbody>
|
| 6620 |
|
| 6621 |
|
| 6622 | <tr>
|
| 6623 |
|
| 6624 | <td class="name"><code>maxRetries</code></td>
|
| 6625 |
|
| 6626 |
|
| 6627 | <td class="type">
|
| 6628 |
|
| 6629 |
|
| 6630 | <span class="param-type">Integer</span>
|
| 6631 |
|
| 6632 |
|
| 6633 |
|
| 6634 | </td>
|
| 6635 |
|
| 6636 |
|
| 6637 | <td class="attributes">
|
| 6638 |
|
| 6639 | <optional><br>
|
| 6640 |
|
| 6641 |
|
| 6642 |
|
| 6643 |
|
| 6644 |
|
| 6645 | </td>
|
| 6646 |
|
| 6647 |
|
| 6648 |
|
| 6649 |
|
| 6650 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 6651 | 0 to not retry. Default 60.</p></td>
|
| 6652 | </tr>
|
| 6653 |
|
| 6654 |
|
| 6655 |
|
| 6656 | <tr>
|
| 6657 |
|
| 6658 | <td class="name"><code>retryIntervalMs</code></td>
|
| 6659 |
|
| 6660 |
|
| 6661 | <td class="type">
|
| 6662 |
|
| 6663 |
|
| 6664 | <span class="param-type">Integer</span>
|
| 6665 |
|
| 6666 |
|
| 6667 |
|
| 6668 | </td>
|
| 6669 |
|
| 6670 |
|
| 6671 | <td class="attributes">
|
| 6672 |
|
| 6673 | <optional><br>
|
| 6674 |
|
| 6675 |
|
| 6676 |
|
| 6677 |
|
| 6678 |
|
| 6679 | </td>
|
| 6680 |
|
| 6681 |
|
| 6682 |
|
| 6683 |
|
| 6684 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 6685 | </tr>
|
| 6686 |
|
| 6687 |
|
| 6688 | </tbody>
|
| 6689 | </table>
|
| 6690 |
|
| 6691 | </td>
|
| 6692 | </tr>
|
| 6693 |
|
| 6694 |
|
| 6695 | </tbody>
|
| 6696 | </table>
|
| 6697 |
|
| 6698 |
|
| 6699 |
|
| 6700 |
|
| 6701 |
|
| 6702 |
|
| 6703 | <dl class="details">
|
| 6704 |
|
| 6705 |
|
| 6706 |
|
| 6707 |
|
| 6708 |
|
| 6709 |
|
| 6710 |
|
| 6711 |
|
| 6712 |
|
| 6713 |
|
| 6714 |
|
| 6715 |
|
| 6716 |
|
| 6717 |
|
| 6718 |
|
| 6719 |
|
| 6720 |
|
| 6721 |
|
| 6722 |
|
| 6723 |
|
| 6724 |
|
| 6725 |
|
| 6726 |
|
| 6727 |
|
| 6728 |
|
| 6729 |
|
| 6730 |
|
| 6731 |
|
| 6732 |
|
| 6733 |
|
| 6734 |
|
| 6735 |
|
| 6736 | </dl>
|
| 6737 |
|
| 6738 |
|
| 6739 |
|
| 6740 |
|
| 6741 |
|
| 6742 |
|
| 6743 |
|
| 6744 |
|
| 6745 |
|
| 6746 |
|
| 6747 |
|
| 6748 |
|
| 6749 |
|
| 6750 | <h5>Returns:</h5>
|
| 6751 |
|
| 6752 |
|
| 6753 | <div class="param-desc">
|
| 6754 | <p>A promise which is resolved with 'true' if reboot is
|
| 6755 | required and resolved with 'false' otherwise.</p>
|
| 6756 | </div>
|
| 6757 |
|
| 6758 |
|
| 6759 |
|
| 6760 | <dl>
|
| 6761 | <dt>
|
| 6762 | Type
|
| 6763 | </dt>
|
| 6764 | <dd>
|
| 6765 |
|
| 6766 | <span class="param-type">Promise</span>
|
| 6767 |
|
| 6768 |
|
| 6769 | </dd>
|
| 6770 | </dl>
|
| 6771 |
|
| 6772 |
|
| 6773 |
|
| 6774 |
|
| 6775 |
|
| 6776 |
|
| 6777 |
|
| 6778 |
|
| 6779 |
|
| 6780 |
|
| 6781 |
|
| 6782 |
|
| 6783 |
|
| 6784 | <h4 class="name" id="replace"><span class="type-signature"></span>replace<span class="signature">(path, body, iControlOptions<span class="signature-attributes">opt</span>, retryOptions<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 6785 |
|
| 6786 |
|
| 6787 |
|
| 6788 |
|
| 6789 |
|
| 6790 |
|
| 6791 | <div class="description">
|
| 6792 | <p>Submits a replace (PUT) request</p>
|
| 6793 | </div>
|
| 6794 |
|
| 6795 |
|
| 6796 |
|
| 6797 |
|
| 6798 |
|
| 6799 |
|
| 6800 |
|
| 6801 |
|
| 6802 |
|
| 6803 | <h5>Parameters:</h5>
|
| 6804 |
|
| 6805 |
|
| 6806 | <table class="params">
|
| 6807 | <thead>
|
| 6808 | <tr>
|
| 6809 |
|
| 6810 | <th>Name</th>
|
| 6811 |
|
| 6812 |
|
| 6813 | <th>Type</th>
|
| 6814 |
|
| 6815 |
|
| 6816 | <th>Attributes</th>
|
| 6817 |
|
| 6818 |
|
| 6819 |
|
| 6820 |
|
| 6821 | <th class="last">Description</th>
|
| 6822 | </tr>
|
| 6823 | </thead>
|
| 6824 |
|
| 6825 | <tbody>
|
| 6826 |
|
| 6827 |
|
| 6828 | <tr>
|
| 6829 |
|
| 6830 | <td class="name"><code>path</code></td>
|
| 6831 |
|
| 6832 |
|
| 6833 | <td class="type">
|
| 6834 |
|
| 6835 |
|
| 6836 | <span class="param-type">String</span>
|
| 6837 |
|
| 6838 |
|
| 6839 |
|
| 6840 | </td>
|
| 6841 |
|
| 6842 |
|
| 6843 | <td class="attributes">
|
| 6844 |
|
| 6845 |
|
| 6846 |
|
| 6847 |
|
| 6848 |
|
| 6849 | </td>
|
| 6850 |
|
| 6851 |
|
| 6852 |
|
| 6853 |
|
| 6854 | <td class="description last"><p>The path to put.</p></td>
|
| 6855 | </tr>
|
| 6856 |
|
| 6857 |
|
| 6858 |
|
| 6859 | <tr>
|
| 6860 |
|
| 6861 | <td class="name"><code>body</code></td>
|
| 6862 |
|
| 6863 |
|
| 6864 | <td class="type">
|
| 6865 |
|
| 6866 |
|
| 6867 | <span class="param-type">Object</span>
|
| 6868 |
|
| 6869 |
|
| 6870 |
|
| 6871 | </td>
|
| 6872 |
|
| 6873 |
|
| 6874 | <td class="attributes">
|
| 6875 |
|
| 6876 |
|
| 6877 |
|
| 6878 |
|
| 6879 |
|
| 6880 | </td>
|
| 6881 |
|
| 6882 |
|
| 6883 |
|
| 6884 |
|
| 6885 | <td class="description last"><p>The body for the patch request.</p></td>
|
| 6886 | </tr>
|
| 6887 |
|
| 6888 |
|
| 6889 |
|
| 6890 | <tr>
|
| 6891 |
|
| 6892 | <td class="name"><code>iControlOptions</code></td>
|
| 6893 |
|
| 6894 |
|
| 6895 | <td class="type">
|
| 6896 |
|
| 6897 |
|
| 6898 | <span class="param-type">Object</span>
|
| 6899 |
|
| 6900 |
|
| 6901 |
|
| 6902 | </td>
|
| 6903 |
|
| 6904 |
|
| 6905 | <td class="attributes">
|
| 6906 |
|
| 6907 | <optional><br>
|
| 6908 |
|
| 6909 |
|
| 6910 |
|
| 6911 |
|
| 6912 |
|
| 6913 | </td>
|
| 6914 |
|
| 6915 |
|
| 6916 |
|
| 6917 |
|
| 6918 | <td class="description last"><p>Options for IControl.</p></td>
|
| 6919 | </tr>
|
| 6920 |
|
| 6921 |
|
| 6922 |
|
| 6923 | <tr>
|
| 6924 |
|
| 6925 | <td class="name"><code>retryOptions</code></td>
|
| 6926 |
|
| 6927 |
|
| 6928 | <td class="type">
|
| 6929 |
|
| 6930 |
|
| 6931 | <span class="param-type">Object</span>
|
| 6932 |
|
| 6933 |
|
| 6934 |
|
| 6935 | </td>
|
| 6936 |
|
| 6937 |
|
| 6938 | <td class="attributes">
|
| 6939 |
|
| 6940 | <optional><br>
|
| 6941 |
|
| 6942 |
|
| 6943 |
|
| 6944 |
|
| 6945 |
|
| 6946 | </td>
|
| 6947 |
|
| 6948 |
|
| 6949 |
|
| 6950 |
|
| 6951 | <td class="description last"><p>Options for retrying the request.</p>
|
| 6952 | <h6>Properties</h6>
|
| 6953 |
|
| 6954 |
|
| 6955 | <table class="params">
|
| 6956 | <thead>
|
| 6957 | <tr>
|
| 6958 |
|
| 6959 | <th>Name</th>
|
| 6960 |
|
| 6961 |
|
| 6962 | <th>Type</th>
|
| 6963 |
|
| 6964 |
|
| 6965 | <th>Attributes</th>
|
| 6966 |
|
| 6967 |
|
| 6968 |
|
| 6969 |
|
| 6970 | <th class="last">Description</th>
|
| 6971 | </tr>
|
| 6972 | </thead>
|
| 6973 |
|
| 6974 | <tbody>
|
| 6975 |
|
| 6976 |
|
| 6977 | <tr>
|
| 6978 |
|
| 6979 | <td class="name"><code>maxRetries</code></td>
|
| 6980 |
|
| 6981 |
|
| 6982 | <td class="type">
|
| 6983 |
|
| 6984 |
|
| 6985 | <span class="param-type">Integer</span>
|
| 6986 |
|
| 6987 |
|
| 6988 |
|
| 6989 | </td>
|
| 6990 |
|
| 6991 |
|
| 6992 | <td class="attributes">
|
| 6993 |
|
| 6994 | <optional><br>
|
| 6995 |
|
| 6996 |
|
| 6997 |
|
| 6998 |
|
| 6999 |
|
| 7000 | </td>
|
| 7001 |
|
| 7002 |
|
| 7003 |
|
| 7004 |
|
| 7005 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 7006 | 0 to not retry. Default 60.</p></td>
|
| 7007 | </tr>
|
| 7008 |
|
| 7009 |
|
| 7010 |
|
| 7011 | <tr>
|
| 7012 |
|
| 7013 | <td class="name"><code>retryIntervalMs</code></td>
|
| 7014 |
|
| 7015 |
|
| 7016 | <td class="type">
|
| 7017 |
|
| 7018 |
|
| 7019 | <span class="param-type">Integer</span>
|
| 7020 |
|
| 7021 |
|
| 7022 |
|
| 7023 | </td>
|
| 7024 |
|
| 7025 |
|
| 7026 | <td class="attributes">
|
| 7027 |
|
| 7028 | <optional><br>
|
| 7029 |
|
| 7030 |
|
| 7031 |
|
| 7032 |
|
| 7033 |
|
| 7034 | </td>
|
| 7035 |
|
| 7036 |
|
| 7037 |
|
| 7038 |
|
| 7039 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 7040 | </tr>
|
| 7041 |
|
| 7042 |
|
| 7043 | </tbody>
|
| 7044 | </table>
|
| 7045 |
|
| 7046 | </td>
|
| 7047 | </tr>
|
| 7048 |
|
| 7049 |
|
| 7050 |
|
| 7051 | <tr>
|
| 7052 |
|
| 7053 | <td class="name"><code>options</code></td>
|
| 7054 |
|
| 7055 |
|
| 7056 | <td class="type">
|
| 7057 |
|
| 7058 |
|
| 7059 | <span class="param-type">Object</span>
|
| 7060 |
|
| 7061 |
|
| 7062 |
|
| 7063 | </td>
|
| 7064 |
|
| 7065 |
|
| 7066 | <td class="attributes">
|
| 7067 |
|
| 7068 | <optional><br>
|
| 7069 |
|
| 7070 |
|
| 7071 |
|
| 7072 |
|
| 7073 |
|
| 7074 | </td>
|
| 7075 |
|
| 7076 |
|
| 7077 |
|
| 7078 |
|
| 7079 | <td class="description last"><p>Options for this method.</p>
|
| 7080 | <h6>Properties</h6>
|
| 7081 |
|
| 7082 |
|
| 7083 | <table class="params">
|
| 7084 | <thead>
|
| 7085 | <tr>
|
| 7086 |
|
| 7087 | <th>Name</th>
|
| 7088 |
|
| 7089 |
|
| 7090 | <th>Type</th>
|
| 7091 |
|
| 7092 |
|
| 7093 | <th>Attributes</th>
|
| 7094 |
|
| 7095 |
|
| 7096 |
|
| 7097 |
|
| 7098 | <th class="last">Description</th>
|
| 7099 | </tr>
|
| 7100 | </thead>
|
| 7101 |
|
| 7102 | <tbody>
|
| 7103 |
|
| 7104 |
|
| 7105 | <tr>
|
| 7106 |
|
| 7107 | <td class="name"><code>silent</code></td>
|
| 7108 |
|
| 7109 |
|
| 7110 | <td class="type">
|
| 7111 |
|
| 7112 |
|
| 7113 | <span class="param-type">Boolen</span>
|
| 7114 |
|
| 7115 |
|
| 7116 |
|
| 7117 | </td>
|
| 7118 |
|
| 7119 |
|
| 7120 | <td class="attributes">
|
| 7121 |
|
| 7122 | <optional><br>
|
| 7123 |
|
| 7124 |
|
| 7125 |
|
| 7126 |
|
| 7127 |
|
| 7128 | </td>
|
| 7129 |
|
| 7130 |
|
| 7131 |
|
| 7132 |
|
| 7133 | <td class="description last"><p>Do not log any info (for requests/repsonses that
|
| 7134 | may contain sensitive information).</p></td>
|
| 7135 | </tr>
|
| 7136 |
|
| 7137 |
|
| 7138 | </tbody>
|
| 7139 | </table>
|
| 7140 |
|
| 7141 | </td>
|
| 7142 | </tr>
|
| 7143 |
|
| 7144 |
|
| 7145 | </tbody>
|
| 7146 | </table>
|
| 7147 |
|
| 7148 |
|
| 7149 |
|
| 7150 |
|
| 7151 |
|
| 7152 |
|
| 7153 | <dl class="details">
|
| 7154 |
|
| 7155 |
|
| 7156 |
|
| 7157 |
|
| 7158 |
|
| 7159 |
|
| 7160 |
|
| 7161 |
|
| 7162 |
|
| 7163 |
|
| 7164 |
|
| 7165 |
|
| 7166 |
|
| 7167 |
|
| 7168 |
|
| 7169 |
|
| 7170 |
|
| 7171 |
|
| 7172 |
|
| 7173 |
|
| 7174 |
|
| 7175 |
|
| 7176 |
|
| 7177 |
|
| 7178 |
|
| 7179 |
|
| 7180 |
|
| 7181 |
|
| 7182 |
|
| 7183 |
|
| 7184 |
|
| 7185 |
|
| 7186 | </dl>
|
| 7187 |
|
| 7188 |
|
| 7189 |
|
| 7190 |
|
| 7191 |
|
| 7192 |
|
| 7193 |
|
| 7194 |
|
| 7195 |
|
| 7196 |
|
| 7197 |
|
| 7198 |
|
| 7199 |
|
| 7200 | <h5>Returns:</h5>
|
| 7201 |
|
| 7202 |
|
| 7203 | <div class="param-desc">
|
| 7204 | <p>A promise which is resolved when the request is complete
|
| 7205 | or rejected if an error occurs.</p>
|
| 7206 | </div>
|
| 7207 |
|
| 7208 |
|
| 7209 |
|
| 7210 | <dl>
|
| 7211 | <dt>
|
| 7212 | Type
|
| 7213 | </dt>
|
| 7214 | <dd>
|
| 7215 |
|
| 7216 | <span class="param-type">Promise</span>
|
| 7217 |
|
| 7218 |
|
| 7219 | </dd>
|
| 7220 | </dl>
|
| 7221 |
|
| 7222 |
|
| 7223 |
|
| 7224 |
|
| 7225 |
|
| 7226 |
|
| 7227 |
|
| 7228 |
|
| 7229 |
|
| 7230 |
|
| 7231 |
|
| 7232 |
|
| 7233 |
|
| 7234 | <h4 class="name" id="runTask"><span class="type-signature"></span>runTask<span class="signature">(taskPath, taskConfig, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 7235 |
|
| 7236 |
|
| 7237 |
|
| 7238 |
|
| 7239 |
|
| 7240 |
|
| 7241 | <div class="description">
|
| 7242 | <p>Executes an iControl REST task</p>
|
| 7243 | </div>
|
| 7244 |
|
| 7245 |
|
| 7246 |
|
| 7247 |
|
| 7248 |
|
| 7249 |
|
| 7250 |
|
| 7251 |
|
| 7252 |
|
| 7253 | <h5>Parameters:</h5>
|
| 7254 |
|
| 7255 |
|
| 7256 | <table class="params">
|
| 7257 | <thead>
|
| 7258 | <tr>
|
| 7259 |
|
| 7260 | <th>Name</th>
|
| 7261 |
|
| 7262 |
|
| 7263 | <th>Type</th>
|
| 7264 |
|
| 7265 |
|
| 7266 | <th>Attributes</th>
|
| 7267 |
|
| 7268 |
|
| 7269 |
|
| 7270 |
|
| 7271 | <th class="last">Description</th>
|
| 7272 | </tr>
|
| 7273 | </thead>
|
| 7274 |
|
| 7275 | <tbody>
|
| 7276 |
|
| 7277 |
|
| 7278 | <tr>
|
| 7279 |
|
| 7280 | <td class="name"><code>taskPath</code></td>
|
| 7281 |
|
| 7282 |
|
| 7283 | <td class="type">
|
| 7284 |
|
| 7285 |
|
| 7286 | <span class="param-type">String</span>
|
| 7287 |
|
| 7288 |
|
| 7289 |
|
| 7290 | </td>
|
| 7291 |
|
| 7292 |
|
| 7293 | <td class="attributes">
|
| 7294 |
|
| 7295 |
|
| 7296 |
|
| 7297 |
|
| 7298 |
|
| 7299 | </td>
|
| 7300 |
|
| 7301 |
|
| 7302 |
|
| 7303 |
|
| 7304 | <td class="description last"><p>URL that created the task.</p></td>
|
| 7305 | </tr>
|
| 7306 |
|
| 7307 |
|
| 7308 |
|
| 7309 | <tr>
|
| 7310 |
|
| 7311 | <td class="name"><code>taskConfig</code></td>
|
| 7312 |
|
| 7313 |
|
| 7314 | <td class="type">
|
| 7315 |
|
| 7316 |
|
| 7317 | <span class="param-type">String</span>
|
| 7318 |
|
| 7319 |
|
| 7320 |
|
| 7321 | </td>
|
| 7322 |
|
| 7323 |
|
| 7324 | <td class="attributes">
|
| 7325 |
|
| 7326 |
|
| 7327 |
|
| 7328 |
|
| 7329 |
|
| 7330 | </td>
|
| 7331 |
|
| 7332 |
|
| 7333 |
|
| 7334 |
|
| 7335 | <td class="description last"><p>Body of the task request, typically JSON.</p></td>
|
| 7336 | </tr>
|
| 7337 |
|
| 7338 |
|
| 7339 |
|
| 7340 | <tr>
|
| 7341 |
|
| 7342 | <td class="name"><code>options</code></td>
|
| 7343 |
|
| 7344 |
|
| 7345 | <td class="type">
|
| 7346 |
|
| 7347 |
|
| 7348 | <span class="param-type">Object</span>
|
| 7349 |
|
| 7350 |
|
| 7351 |
|
| 7352 | </td>
|
| 7353 |
|
| 7354 |
|
| 7355 | <td class="attributes">
|
| 7356 |
|
| 7357 | <optional><br>
|
| 7358 |
|
| 7359 |
|
| 7360 |
|
| 7361 |
|
| 7362 |
|
| 7363 | </td>
|
| 7364 |
|
| 7365 |
|
| 7366 |
|
| 7367 |
|
| 7368 | <td class="description last"><p>Options controlling the task request.</p>
|
| 7369 | <h6>Properties</h6>
|
| 7370 |
|
| 7371 |
|
| 7372 | <table class="params">
|
| 7373 | <thead>
|
| 7374 | <tr>
|
| 7375 |
|
| 7376 | <th>Name</th>
|
| 7377 |
|
| 7378 |
|
| 7379 | <th>Type</th>
|
| 7380 |
|
| 7381 |
|
| 7382 | <th>Attributes</th>
|
| 7383 |
|
| 7384 |
|
| 7385 |
|
| 7386 |
|
| 7387 | <th class="last">Description</th>
|
| 7388 | </tr>
|
| 7389 | </thead>
|
| 7390 |
|
| 7391 | <tbody>
|
| 7392 |
|
| 7393 |
|
| 7394 | <tr>
|
| 7395 |
|
| 7396 | <td class="name"><code>idAttribute</code></td>
|
| 7397 |
|
| 7398 |
|
| 7399 | <td class="type">
|
| 7400 |
|
| 7401 |
|
| 7402 | <span class="param-type">String</span>
|
| 7403 |
|
| 7404 |
|
| 7405 |
|
| 7406 | </td>
|
| 7407 |
|
| 7408 |
|
| 7409 | <td class="attributes">
|
| 7410 |
|
| 7411 | <optional><br>
|
| 7412 |
|
| 7413 |
|
| 7414 |
|
| 7415 |
|
| 7416 |
|
| 7417 | </td>
|
| 7418 |
|
| 7419 |
|
| 7420 |
|
| 7421 |
|
| 7422 | <td class="description last"><p>Name of the Task ID attribute in the task create response.
|
| 7423 | Default: '_taskId'</p></td>
|
| 7424 | </tr>
|
| 7425 |
|
| 7426 |
|
| 7427 |
|
| 7428 | <tr>
|
| 7429 |
|
| 7430 | <td class="name"><code>validate</code></td>
|
| 7431 |
|
| 7432 |
|
| 7433 | <td class="type">
|
| 7434 |
|
| 7435 |
|
| 7436 | <span class="param-type">Boolean</span>
|
| 7437 |
|
| 7438 |
|
| 7439 |
|
| 7440 | </td>
|
| 7441 |
|
| 7442 |
|
| 7443 | <td class="attributes">
|
| 7444 |
|
| 7445 | <optional><br>
|
| 7446 |
|
| 7447 |
|
| 7448 |
|
| 7449 |
|
| 7450 |
|
| 7451 | </td>
|
| 7452 |
|
| 7453 |
|
| 7454 |
|
| 7455 |
|
| 7456 | <td class="description last"><p>Whether to send a VALIDATING task request. Default: true.</p></td>
|
| 7457 | </tr>
|
| 7458 |
|
| 7459 |
|
| 7460 |
|
| 7461 | <tr>
|
| 7462 |
|
| 7463 | <td class="name"><code>statusAttribute</code></td>
|
| 7464 |
|
| 7465 |
|
| 7466 | <td class="type">
|
| 7467 |
|
| 7468 |
|
| 7469 | <span class="param-type">String</span>
|
| 7470 |
|
| 7471 |
|
| 7472 |
|
| 7473 | </td>
|
| 7474 |
|
| 7475 |
|
| 7476 | <td class="attributes">
|
| 7477 |
|
| 7478 | <optional><br>
|
| 7479 |
|
| 7480 |
|
| 7481 |
|
| 7482 |
|
| 7483 |
|
| 7484 | </td>
|
| 7485 |
|
| 7486 |
|
| 7487 |
|
| 7488 |
|
| 7489 | <td class="description last"><p>Name of the Task Status attribute in the result response.
|
| 7490 | Default: '_taskState'</p></td>
|
| 7491 | </tr>
|
| 7492 |
|
| 7493 |
|
| 7494 | </tbody>
|
| 7495 | </table>
|
| 7496 |
|
| 7497 | </td>
|
| 7498 | </tr>
|
| 7499 |
|
| 7500 |
|
| 7501 | </tbody>
|
| 7502 | </table>
|
| 7503 |
|
| 7504 |
|
| 7505 |
|
| 7506 |
|
| 7507 |
|
| 7508 |
|
| 7509 | <dl class="details">
|
| 7510 |
|
| 7511 |
|
| 7512 |
|
| 7513 |
|
| 7514 |
|
| 7515 |
|
| 7516 |
|
| 7517 |
|
| 7518 |
|
| 7519 |
|
| 7520 |
|
| 7521 |
|
| 7522 |
|
| 7523 |
|
| 7524 |
|
| 7525 |
|
| 7526 |
|
| 7527 |
|
| 7528 |
|
| 7529 |
|
| 7530 |
|
| 7531 |
|
| 7532 |
|
| 7533 |
|
| 7534 |
|
| 7535 |
|
| 7536 |
|
| 7537 |
|
| 7538 |
|
| 7539 |
|
| 7540 |
|
| 7541 |
|
| 7542 | </dl>
|
| 7543 |
|
| 7544 |
|
| 7545 |
|
| 7546 |
|
| 7547 |
|
| 7548 |
|
| 7549 |
|
| 7550 |
|
| 7551 |
|
| 7552 |
|
| 7553 |
|
| 7554 |
|
| 7555 |
|
| 7556 | <h5>Returns:</h5>
|
| 7557 |
|
| 7558 |
|
| 7559 | <div class="param-desc">
|
| 7560 | <p>A promise which is resolved with true if the task completes
|
| 7561 | successfully, resolved with false if task goes to error state
|
| 7562 | or rejected if some other error occurs.</p>
|
| 7563 | </div>
|
| 7564 |
|
| 7565 |
|
| 7566 |
|
| 7567 | <dl>
|
| 7568 | <dt>
|
| 7569 | Type
|
| 7570 | </dt>
|
| 7571 | <dd>
|
| 7572 |
|
| 7573 | <span class="param-type">Promise</span>
|
| 7574 |
|
| 7575 |
|
| 7576 | </dd>
|
| 7577 | </dl>
|
| 7578 |
|
| 7579 |
|
| 7580 |
|
| 7581 |
|
| 7582 |
|
| 7583 |
|
| 7584 |
|
| 7585 |
|
| 7586 |
|
| 7587 |
|
| 7588 |
|
| 7589 |
|
| 7590 |
|
| 7591 | <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">(file<span class="signature-attributes">opt</span>, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 7592 |
|
| 7593 |
|
| 7594 |
|
| 7595 |
|
| 7596 |
|
| 7597 |
|
| 7598 | <div class="description">
|
| 7599 | <p>Saves sys config</p>
|
| 7600 | </div>
|
| 7601 |
|
| 7602 |
|
| 7603 |
|
| 7604 |
|
| 7605 |
|
| 7606 |
|
| 7607 |
|
| 7608 |
|
| 7609 |
|
| 7610 | <h5>Parameters:</h5>
|
| 7611 |
|
| 7612 |
|
| 7613 | <table class="params">
|
| 7614 | <thead>
|
| 7615 | <tr>
|
| 7616 |
|
| 7617 | <th>Name</th>
|
| 7618 |
|
| 7619 |
|
| 7620 | <th>Type</th>
|
| 7621 |
|
| 7622 |
|
| 7623 | <th>Attributes</th>
|
| 7624 |
|
| 7625 |
|
| 7626 |
|
| 7627 |
|
| 7628 | <th class="last">Description</th>
|
| 7629 | </tr>
|
| 7630 | </thead>
|
| 7631 |
|
| 7632 | <tbody>
|
| 7633 |
|
| 7634 |
|
| 7635 | <tr>
|
| 7636 |
|
| 7637 | <td class="name"><code>file</code></td>
|
| 7638 |
|
| 7639 |
|
| 7640 | <td class="type">
|
| 7641 |
|
| 7642 |
|
| 7643 | <span class="param-type">String</span>
|
| 7644 |
|
| 7645 |
|
| 7646 |
|
| 7647 | </td>
|
| 7648 |
|
| 7649 |
|
| 7650 | <td class="attributes">
|
| 7651 |
|
| 7652 | <optional><br>
|
| 7653 |
|
| 7654 |
|
| 7655 |
|
| 7656 |
|
| 7657 |
|
| 7658 | </td>
|
| 7659 |
|
| 7660 |
|
| 7661 |
|
| 7662 |
|
| 7663 | <td class="description last"><p>File to save to. Default is bigip.conf</p></td>
|
| 7664 | </tr>
|
| 7665 |
|
| 7666 |
|
| 7667 |
|
| 7668 | <tr>
|
| 7669 |
|
| 7670 | <td class="name"><code>retryOptions</code></td>
|
| 7671 |
|
| 7672 |
|
| 7673 | <td class="type">
|
| 7674 |
|
| 7675 |
|
| 7676 | <span class="param-type">Object</span>
|
| 7677 |
|
| 7678 |
|
| 7679 |
|
| 7680 | </td>
|
| 7681 |
|
| 7682 |
|
| 7683 | <td class="attributes">
|
| 7684 |
|
| 7685 | <optional><br>
|
| 7686 |
|
| 7687 |
|
| 7688 |
|
| 7689 |
|
| 7690 |
|
| 7691 | </td>
|
| 7692 |
|
| 7693 |
|
| 7694 |
|
| 7695 |
|
| 7696 | <td class="description last"><p>Options for retrying the request.</p>
|
| 7697 | <h6>Properties</h6>
|
| 7698 |
|
| 7699 |
|
| 7700 | <table class="params">
|
| 7701 | <thead>
|
| 7702 | <tr>
|
| 7703 |
|
| 7704 | <th>Name</th>
|
| 7705 |
|
| 7706 |
|
| 7707 | <th>Type</th>
|
| 7708 |
|
| 7709 |
|
| 7710 | <th>Attributes</th>
|
| 7711 |
|
| 7712 |
|
| 7713 |
|
| 7714 |
|
| 7715 | <th class="last">Description</th>
|
| 7716 | </tr>
|
| 7717 | </thead>
|
| 7718 |
|
| 7719 | <tbody>
|
| 7720 |
|
| 7721 |
|
| 7722 | <tr>
|
| 7723 |
|
| 7724 | <td class="name"><code>maxRetries</code></td>
|
| 7725 |
|
| 7726 |
|
| 7727 | <td class="type">
|
| 7728 |
|
| 7729 |
|
| 7730 | <span class="param-type">Integer</span>
|
| 7731 |
|
| 7732 |
|
| 7733 |
|
| 7734 | </td>
|
| 7735 |
|
| 7736 |
|
| 7737 | <td class="attributes">
|
| 7738 |
|
| 7739 | <optional><br>
|
| 7740 |
|
| 7741 |
|
| 7742 |
|
| 7743 |
|
| 7744 |
|
| 7745 | </td>
|
| 7746 |
|
| 7747 |
|
| 7748 |
|
| 7749 |
|
| 7750 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 7751 | 0 to not retry. Default 60.</p></td>
|
| 7752 | </tr>
|
| 7753 |
|
| 7754 |
|
| 7755 |
|
| 7756 | <tr>
|
| 7757 |
|
| 7758 | <td class="name"><code>retryIntervalMs</code></td>
|
| 7759 |
|
| 7760 |
|
| 7761 | <td class="type">
|
| 7762 |
|
| 7763 |
|
| 7764 | <span class="param-type">Integer</span>
|
| 7765 |
|
| 7766 |
|
| 7767 |
|
| 7768 | </td>
|
| 7769 |
|
| 7770 |
|
| 7771 | <td class="attributes">
|
| 7772 |
|
| 7773 | <optional><br>
|
| 7774 |
|
| 7775 |
|
| 7776 |
|
| 7777 |
|
| 7778 |
|
| 7779 | </td>
|
| 7780 |
|
| 7781 |
|
| 7782 |
|
| 7783 |
|
| 7784 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 7785 | </tr>
|
| 7786 |
|
| 7787 |
|
| 7788 | </tbody>
|
| 7789 | </table>
|
| 7790 |
|
| 7791 | </td>
|
| 7792 | </tr>
|
| 7793 |
|
| 7794 |
|
| 7795 | </tbody>
|
| 7796 | </table>
|
| 7797 |
|
| 7798 |
|
| 7799 |
|
| 7800 |
|
| 7801 |
|
| 7802 |
|
| 7803 | <dl class="details">
|
| 7804 |
|
| 7805 |
|
| 7806 |
|
| 7807 |
|
| 7808 |
|
| 7809 |
|
| 7810 |
|
| 7811 |
|
| 7812 |
|
| 7813 |
|
| 7814 |
|
| 7815 |
|
| 7816 |
|
| 7817 |
|
| 7818 |
|
| 7819 |
|
| 7820 |
|
| 7821 |
|
| 7822 |
|
| 7823 |
|
| 7824 |
|
| 7825 |
|
| 7826 |
|
| 7827 |
|
| 7828 |
|
| 7829 |
|
| 7830 |
|
| 7831 |
|
| 7832 |
|
| 7833 |
|
| 7834 |
|
| 7835 |
|
| 7836 | </dl>
|
| 7837 |
|
| 7838 |
|
| 7839 |
|
| 7840 |
|
| 7841 |
|
| 7842 |
|
| 7843 |
|
| 7844 |
|
| 7845 |
|
| 7846 |
|
| 7847 |
|
| 7848 |
|
| 7849 |
|
| 7850 | <h5>Returns:</h5>
|
| 7851 |
|
| 7852 |
|
| 7853 | <div class="param-desc">
|
| 7854 | <p>A promise which is resolved when the licensing
|
| 7855 | is complete or rejected if an error occurs.</p>
|
| 7856 | </div>
|
| 7857 |
|
| 7858 |
|
| 7859 |
|
| 7860 | <dl>
|
| 7861 | <dt>
|
| 7862 | Type
|
| 7863 | </dt>
|
| 7864 | <dd>
|
| 7865 |
|
| 7866 | <span class="param-type">Promise</span>
|
| 7867 |
|
| 7868 |
|
| 7869 | </dd>
|
| 7870 | </dl>
|
| 7871 |
|
| 7872 |
|
| 7873 |
|
| 7874 |
|
| 7875 |
|
| 7876 |
|
| 7877 |
|
| 7878 |
|
| 7879 |
|
| 7880 |
|
| 7881 |
|
| 7882 |
|
| 7883 |
|
| 7884 | <h4 class="name" id="saveUcs"><span class="type-signature"></span>saveUcs<span class="signature">(file)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 7885 |
|
| 7886 |
|
| 7887 |
|
| 7888 |
|
| 7889 |
|
| 7890 |
|
| 7891 | <div class="description">
|
| 7892 | <p>Save a ucs file in /var/local/ucs</p>
|
| 7893 | </div>
|
| 7894 |
|
| 7895 |
|
| 7896 |
|
| 7897 |
|
| 7898 |
|
| 7899 |
|
| 7900 |
|
| 7901 |
|
| 7902 |
|
| 7903 | <h5>Parameters:</h5>
|
| 7904 |
|
| 7905 |
|
| 7906 | <table class="params">
|
| 7907 | <thead>
|
| 7908 | <tr>
|
| 7909 |
|
| 7910 | <th>Name</th>
|
| 7911 |
|
| 7912 |
|
| 7913 | <th>Type</th>
|
| 7914 |
|
| 7915 |
|
| 7916 |
|
| 7917 |
|
| 7918 |
|
| 7919 | <th class="last">Description</th>
|
| 7920 | </tr>
|
| 7921 | </thead>
|
| 7922 |
|
| 7923 | <tbody>
|
| 7924 |
|
| 7925 |
|
| 7926 | <tr>
|
| 7927 |
|
| 7928 | <td class="name"><code>file</code></td>
|
| 7929 |
|
| 7930 |
|
| 7931 | <td class="type">
|
| 7932 |
|
| 7933 |
|
| 7934 | <span class="param-type">String</span>
|
| 7935 |
|
| 7936 |
|
| 7937 |
|
| 7938 | </td>
|
| 7939 |
|
| 7940 |
|
| 7941 |
|
| 7942 |
|
| 7943 |
|
| 7944 | <td class="description last"><p>Base name of ucs file</p></td>
|
| 7945 | </tr>
|
| 7946 |
|
| 7947 |
|
| 7948 | </tbody>
|
| 7949 | </table>
|
| 7950 |
|
| 7951 |
|
| 7952 |
|
| 7953 |
|
| 7954 |
|
| 7955 |
|
| 7956 | <dl class="details">
|
| 7957 |
|
| 7958 |
|
| 7959 |
|
| 7960 |
|
| 7961 |
|
| 7962 |
|
| 7963 |
|
| 7964 |
|
| 7965 |
|
| 7966 |
|
| 7967 |
|
| 7968 |
|
| 7969 |
|
| 7970 |
|
| 7971 |
|
| 7972 |
|
| 7973 |
|
| 7974 |
|
| 7975 |
|
| 7976 |
|
| 7977 |
|
| 7978 |
|
| 7979 |
|
| 7980 |
|
| 7981 |
|
| 7982 |
|
| 7983 |
|
| 7984 |
|
| 7985 |
|
| 7986 |
|
| 7987 |
|
| 7988 |
|
| 7989 | </dl>
|
| 7990 |
|
| 7991 |
|
| 7992 |
|
| 7993 |
|
| 7994 |
|
| 7995 |
|
| 7996 |
|
| 7997 |
|
| 7998 |
|
| 7999 |
|
| 8000 |
|
| 8001 |
|
| 8002 |
|
| 8003 | <h5>Returns:</h5>
|
| 8004 |
|
| 8005 |
|
| 8006 | <div class="param-desc">
|
| 8007 | <ul>
|
| 8008 | <li>A promise which is resolve when the ucs is saved<pre class="prettyprint source"><code> or rejected if an error occurs</code></pre></li>
|
| 8009 | </ul>
|
| 8010 | </div>
|
| 8011 |
|
| 8012 |
|
| 8013 |
|
| 8014 | <dl>
|
| 8015 | <dt>
|
| 8016 | Type
|
| 8017 | </dt>
|
| 8018 | <dd>
|
| 8019 |
|
| 8020 | <span class="param-type">Promise</span>
|
| 8021 |
|
| 8022 |
|
| 8023 | </dd>
|
| 8024 | </dl>
|
| 8025 |
|
| 8026 |
|
| 8027 |
|
| 8028 |
|
| 8029 |
|
| 8030 |
|
| 8031 |
|
| 8032 |
|
| 8033 |
|
| 8034 |
|
| 8035 |
|
| 8036 |
|
| 8037 |
|
| 8038 | <h4 class="name" id="setPort"><span class="type-signature"></span>setPort<span class="signature">(port)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 8039 |
|
| 8040 |
|
| 8041 |
|
| 8042 |
|
| 8043 |
|
| 8044 |
|
| 8045 | <div class="description">
|
| 8046 | <p>Sets the management ip port</p>
|
| 8047 | </div>
|
| 8048 |
|
| 8049 |
|
| 8050 |
|
| 8051 |
|
| 8052 |
|
| 8053 |
|
| 8054 |
|
| 8055 |
|
| 8056 |
|
| 8057 | <h5>Parameters:</h5>
|
| 8058 |
|
| 8059 |
|
| 8060 | <table class="params">
|
| 8061 | <thead>
|
| 8062 | <tr>
|
| 8063 |
|
| 8064 | <th>Name</th>
|
| 8065 |
|
| 8066 |
|
| 8067 | <th>Type</th>
|
| 8068 |
|
| 8069 |
|
| 8070 |
|
| 8071 |
|
| 8072 |
|
| 8073 | <th class="last">Description</th>
|
| 8074 | </tr>
|
| 8075 | </thead>
|
| 8076 |
|
| 8077 | <tbody>
|
| 8078 |
|
| 8079 |
|
| 8080 | <tr>
|
| 8081 |
|
| 8082 | <td class="name"><code>port</code></td>
|
| 8083 |
|
| 8084 |
|
| 8085 | <td class="type">
|
| 8086 |
|
| 8087 |
|
| 8088 | <span class="param-type">Number</span>
|
| 8089 |
|
| 8090 |
|
| 8091 |
|
| 8092 | </td>
|
| 8093 |
|
| 8094 |
|
| 8095 |
|
| 8096 |
|
| 8097 |
|
| 8098 | <td class="description last"><p>port to use for management IP</p></td>
|
| 8099 | </tr>
|
| 8100 |
|
| 8101 |
|
| 8102 | </tbody>
|
| 8103 | </table>
|
| 8104 |
|
| 8105 |
|
| 8106 |
|
| 8107 |
|
| 8108 |
|
| 8109 |
|
| 8110 | <dl class="details">
|
| 8111 |
|
| 8112 |
|
| 8113 |
|
| 8114 |
|
| 8115 |
|
| 8116 |
|
| 8117 |
|
| 8118 |
|
| 8119 |
|
| 8120 |
|
| 8121 |
|
| 8122 |
|
| 8123 |
|
| 8124 |
|
| 8125 |
|
| 8126 |
|
| 8127 |
|
| 8128 |
|
| 8129 |
|
| 8130 |
|
| 8131 |
|
| 8132 |
|
| 8133 |
|
| 8134 |
|
| 8135 |
|
| 8136 |
|
| 8137 |
|
| 8138 |
|
| 8139 |
|
| 8140 |
|
| 8141 |
|
| 8142 |
|
| 8143 | </dl>
|
| 8144 |
|
| 8145 |
|
| 8146 |
|
| 8147 |
|
| 8148 |
|
| 8149 |
|
| 8150 |
|
| 8151 |
|
| 8152 |
|
| 8153 |
|
| 8154 |
|
| 8155 |
|
| 8156 |
|
| 8157 | <h5>Returns:</h5>
|
| 8158 |
|
| 8159 |
|
| 8160 | <div class="param-desc">
|
| 8161 | <p>A promise which is resolved when the operation is complete
|
| 8162 | or rejected if an error occurs.</p>
|
| 8163 | </div>
|
| 8164 |
|
| 8165 |
|
| 8166 |
|
| 8167 | <dl>
|
| 8168 | <dt>
|
| 8169 | Type
|
| 8170 | </dt>
|
| 8171 | <dd>
|
| 8172 |
|
| 8173 | <span class="param-type">Promise</span>
|
| 8174 |
|
| 8175 |
|
| 8176 | </dd>
|
| 8177 | </dl>
|
| 8178 |
|
| 8179 |
|
| 8180 |
|
| 8181 |
|
| 8182 |
|
| 8183 |
|
| 8184 |
|
| 8185 |
|
| 8186 |
|
| 8187 |
|
| 8188 |
|
| 8189 |
|
| 8190 |
|
| 8191 | <h4 class="name" id="transaction"><span class="type-signature"></span>transaction<span class="signature">(commands)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 8192 |
|
| 8193 |
|
| 8194 |
|
| 8195 |
|
| 8196 |
|
| 8197 |
|
| 8198 | <div class="description">
|
| 8199 | <p>Submits commands in a transaction</p>
|
| 8200 | </div>
|
| 8201 |
|
| 8202 |
|
| 8203 |
|
| 8204 |
|
| 8205 |
|
| 8206 |
|
| 8207 |
|
| 8208 |
|
| 8209 |
|
| 8210 | <h5>Parameters:</h5>
|
| 8211 |
|
| 8212 |
|
| 8213 | <table class="params">
|
| 8214 | <thead>
|
| 8215 | <tr>
|
| 8216 |
|
| 8217 | <th>Name</th>
|
| 8218 |
|
| 8219 |
|
| 8220 | <th>Type</th>
|
| 8221 |
|
| 8222 |
|
| 8223 |
|
| 8224 |
|
| 8225 |
|
| 8226 | <th class="last">Description</th>
|
| 8227 | </tr>
|
| 8228 | </thead>
|
| 8229 |
|
| 8230 | <tbody>
|
| 8231 |
|
| 8232 |
|
| 8233 | <tr>
|
| 8234 |
|
| 8235 | <td class="name"><code>commands</code></td>
|
| 8236 |
|
| 8237 |
|
| 8238 | <td class="type">
|
| 8239 |
|
| 8240 |
|
| 8241 | <span class="param-type">Array.<Object></span>
|
| 8242 |
|
| 8243 |
|
| 8244 |
|
| 8245 | </td>
|
| 8246 |
|
| 8247 |
|
| 8248 |
|
| 8249 |
|
| 8250 |
|
| 8251 | <td class="description last"><p>Array of command definitions. Each command should be:
|
| 8252 | {
|
| 8253 | method: 'list' | 'create' | 'modify' | 'delete',
|
| 8254 | path: path for command,
|
| 8255 | body: optional body for command
|
| 8256 | }</p></td>
|
| 8257 | </tr>
|
| 8258 |
|
| 8259 |
|
| 8260 | </tbody>
|
| 8261 | </table>
|
| 8262 |
|
| 8263 |
|
| 8264 |
|
| 8265 |
|
| 8266 |
|
| 8267 |
|
| 8268 | <dl class="details">
|
| 8269 |
|
| 8270 |
|
| 8271 |
|
| 8272 |
|
| 8273 |
|
| 8274 |
|
| 8275 |
|
| 8276 |
|
| 8277 |
|
| 8278 |
|
| 8279 |
|
| 8280 |
|
| 8281 |
|
| 8282 |
|
| 8283 |
|
| 8284 |
|
| 8285 |
|
| 8286 |
|
| 8287 |
|
| 8288 |
|
| 8289 |
|
| 8290 |
|
| 8291 |
|
| 8292 |
|
| 8293 |
|
| 8294 |
|
| 8295 |
|
| 8296 |
|
| 8297 |
|
| 8298 |
|
| 8299 |
|
| 8300 |
|
| 8301 | </dl>
|
| 8302 |
|
| 8303 |
|
| 8304 |
|
| 8305 |
|
| 8306 |
|
| 8307 |
|
| 8308 |
|
| 8309 |
|
| 8310 |
|
| 8311 |
|
| 8312 |
|
| 8313 |
|
| 8314 |
|
| 8315 | <h5>Returns:</h5>
|
| 8316 |
|
| 8317 |
|
| 8318 | <div class="param-desc">
|
| 8319 | <p>A promise which is resolved when the transaction is complete
|
| 8320 | or rejected if an error occurs.</p>
|
| 8321 | </div>
|
| 8322 |
|
| 8323 |
|
| 8324 |
|
| 8325 | <dl>
|
| 8326 | <dt>
|
| 8327 | Type
|
| 8328 | </dt>
|
| 8329 | <dd>
|
| 8330 |
|
| 8331 | <span class="param-type">Promise</span>
|
| 8332 |
|
| 8333 |
|
| 8334 | </dd>
|
| 8335 | </dl>
|
| 8336 |
|
| 8337 |
|
| 8338 |
|
| 8339 |
|
| 8340 |
|
| 8341 |
|
| 8342 |
|
| 8343 |
|
| 8344 |
|
| 8345 |
|
| 8346 |
|
| 8347 |
|
| 8348 |
|
| 8349 | </article>
|
| 8350 |
|
| 8351 | </section>
|
| 8352 |
|
| 8353 |
|
| 8354 |
|
| 8355 |
|
| 8356 | </div>
|
| 8357 |
|
| 8358 | <nav>
|
| 8359 | <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>
|
| 8360 | </nav>
|
| 8361 |
|
| 8362 | <br class="clear">
|
| 8363 |
|
| 8364 | <footer>
|
| 8365 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
| 8366 | </footer>
|
| 8367 |
|
| 8368 | <script> prettyPrint(); </script>
|
| 8369 | <script src="scripts/linenumber.js"> </script>
|
| 8370 | </body>
|
| 8371 | </html> |
| \ | No newline at end of file |