| 1 | <!DOCTYPE html>
|
| 2 | <html lang="en">
|
| 3 | <head>
|
| 4 | <meta charset="utf-8">
|
| 5 | <title>JSDoc: Class: BigIpCluster</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: BigIpCluster</h1>
|
| 21 |
|
| 22 |
|
| 23 |
|
| 24 |
|
| 25 |
|
| 26 |
|
| 27 | <section>
|
| 28 |
|
| 29 | <header>
|
| 30 |
|
| 31 | <h2><span class="attribs"><span class="type-signature"></span></span>BigIpCluster<span class="signature">(bigIpCore, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2>
|
| 32 |
|
| 33 | <div class="class-description"><p>Provides clustering functionality to a base BigIp object</p></div>
|
| 34 |
|
| 35 |
|
| 36 | </header>
|
| 37 |
|
| 38 | <article>
|
| 39 | <div class="container-overview">
|
| 40 |
|
| 41 |
|
| 42 |
|
| 43 |
|
| 44 | <h2>Constructor</h2>
|
| 45 |
|
| 46 |
|
| 47 |
|
| 48 | <h4 class="name" id="BigIpCluster"><span class="type-signature"></span>new BigIpCluster<span class="signature">(bigIpCore, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
|
| 49 |
|
| 50 |
|
| 51 |
|
| 52 |
|
| 53 |
|
| 54 |
|
| 55 | <div class="description">
|
| 56 | <p>Cluster constructor</p>
|
| 57 | </div>
|
| 58 |
|
| 59 |
|
| 60 |
|
| 61 |
|
| 62 |
|
| 63 |
|
| 64 |
|
| 65 |
|
| 66 |
|
| 67 | <h5>Parameters:</h5>
|
| 68 |
|
| 69 |
|
| 70 | <table class="params">
|
| 71 | <thead>
|
| 72 | <tr>
|
| 73 |
|
| 74 | <th>Name</th>
|
| 75 |
|
| 76 |
|
| 77 | <th>Type</th>
|
| 78 |
|
| 79 |
|
| 80 | <th>Attributes</th>
|
| 81 |
|
| 82 |
|
| 83 |
|
| 84 |
|
| 85 | <th class="last">Description</th>
|
| 86 | </tr>
|
| 87 | </thead>
|
| 88 |
|
| 89 | <tbody>
|
| 90 |
|
| 91 |
|
| 92 | <tr>
|
| 93 |
|
| 94 | <td class="name"><code>bigIpCore</code></td>
|
| 95 |
|
| 96 |
|
| 97 | <td class="type">
|
| 98 |
|
| 99 |
|
| 100 | <span class="param-type">Object</span>
|
| 101 |
|
| 102 |
|
| 103 |
|
| 104 | </td>
|
| 105 |
|
| 106 |
|
| 107 | <td class="attributes">
|
| 108 |
|
| 109 |
|
| 110 |
|
| 111 |
|
| 112 |
|
| 113 | </td>
|
| 114 |
|
| 115 |
|
| 116 |
|
| 117 |
|
| 118 | <td class="description last"><p>Base BigIp object.</p></td>
|
| 119 | </tr>
|
| 120 |
|
| 121 |
|
| 122 |
|
| 123 | <tr>
|
| 124 |
|
| 125 | <td class="name"><code>options</code></td>
|
| 126 |
|
| 127 |
|
| 128 | <td class="type">
|
| 129 |
|
| 130 |
|
| 131 | <span class="param-type">Object</span>
|
| 132 |
|
| 133 |
|
| 134 |
|
| 135 | </td>
|
| 136 |
|
| 137 |
|
| 138 | <td class="attributes">
|
| 139 |
|
| 140 | <optional><br>
|
| 141 |
|
| 142 |
|
| 143 |
|
| 144 |
|
| 145 |
|
| 146 | </td>
|
| 147 |
|
| 148 |
|
| 149 |
|
| 150 |
|
| 151 | <td class="description last"><p>Optional parameters.</p>
|
| 152 | <h6>Properties</h6>
|
| 153 |
|
| 154 |
|
| 155 | <table class="params">
|
| 156 | <thead>
|
| 157 | <tr>
|
| 158 |
|
| 159 | <th>Name</th>
|
| 160 |
|
| 161 |
|
| 162 | <th>Type</th>
|
| 163 |
|
| 164 |
|
| 165 | <th>Attributes</th>
|
| 166 |
|
| 167 |
|
| 168 |
|
| 169 |
|
| 170 | <th class="last">Description</th>
|
| 171 | </tr>
|
| 172 | </thead>
|
| 173 |
|
| 174 | <tbody>
|
| 175 |
|
| 176 |
|
| 177 | <tr>
|
| 178 |
|
| 179 | <td class="name"><code>logger</code></td>
|
| 180 |
|
| 181 |
|
| 182 | <td class="type">
|
| 183 |
|
| 184 |
|
| 185 | <span class="param-type">Object</span>
|
| 186 |
|
| 187 |
|
| 188 |
|
| 189 | </td>
|
| 190 |
|
| 191 |
|
| 192 | <td class="attributes">
|
| 193 |
|
| 194 | <optional><br>
|
| 195 |
|
| 196 |
|
| 197 |
|
| 198 |
|
| 199 |
|
| 200 | </td>
|
| 201 |
|
| 202 |
|
| 203 |
|
| 204 |
|
| 205 | <td class="description last"><p>Logger to use. Or, pass loggerOptions to get your own logger.</p></td>
|
| 206 | </tr>
|
| 207 |
|
| 208 |
|
| 209 |
|
| 210 | <tr>
|
| 211 |
|
| 212 | <td class="name"><code>loggerOptions</code></td>
|
| 213 |
|
| 214 |
|
| 215 | <td class="type">
|
| 216 |
|
| 217 |
|
| 218 | <span class="param-type">Object</span>
|
| 219 |
|
| 220 |
|
| 221 |
|
| 222 | </td>
|
| 223 |
|
| 224 |
|
| 225 | <td class="attributes">
|
| 226 |
|
| 227 | <optional><br>
|
| 228 |
|
| 229 |
|
| 230 |
|
| 231 |
|
| 232 |
|
| 233 | </td>
|
| 234 |
|
| 235 |
|
| 236 |
|
| 237 |
|
| 238 | <td class="description last"><p>Options for the logger.
|
| 239 | See <a href="module-logger.html#.getLogger">module:logger.getLogger</a> for details.</p></td>
|
| 240 | </tr>
|
| 241 |
|
| 242 |
|
| 243 | </tbody>
|
| 244 | </table>
|
| 245 |
|
| 246 | </td>
|
| 247 | </tr>
|
| 248 |
|
| 249 |
|
| 250 | </tbody>
|
| 251 | </table>
|
| 252 |
|
| 253 |
|
| 254 |
|
| 255 |
|
| 256 |
|
| 257 |
|
| 258 | <dl class="details">
|
| 259 |
|
| 260 |
|
| 261 |
|
| 262 |
|
| 263 |
|
| 264 |
|
| 265 |
|
| 266 |
|
| 267 |
|
| 268 |
|
| 269 |
|
| 270 |
|
| 271 |
|
| 272 |
|
| 273 |
|
| 274 |
|
| 275 |
|
| 276 |
|
| 277 |
|
| 278 |
|
| 279 |
|
| 280 |
|
| 281 |
|
| 282 |
|
| 283 |
|
| 284 |
|
| 285 |
|
| 286 |
|
| 287 |
|
| 288 |
|
| 289 |
|
| 290 |
|
| 291 | </dl>
|
| 292 |
|
| 293 |
|
| 294 |
|
| 295 |
|
| 296 |
|
| 297 |
|
| 298 |
|
| 299 |
|
| 300 |
|
| 301 |
|
| 302 |
|
| 303 |
|
| 304 |
|
| 305 |
|
| 306 |
|
| 307 |
|
| 308 |
|
| 309 |
|
| 310 |
|
| 311 | </div>
|
| 312 |
|
| 313 |
|
| 314 |
|
| 315 |
|
| 316 |
|
| 317 |
|
| 318 |
|
| 319 |
|
| 320 |
|
| 321 |
|
| 322 |
|
| 323 |
|
| 324 |
|
| 325 |
|
| 326 |
|
| 327 |
|
| 328 | <h3 class="subsection-title">Methods</h3>
|
| 329 |
|
| 330 |
|
| 331 |
|
| 332 |
|
| 333 |
|
| 334 |
|
| 335 |
|
| 336 | <h4 class="name" id="addToDeviceGroup"><span class="type-signature"></span>addToDeviceGroup<span class="signature">(deviceName, deviceGroup, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 337 |
|
| 338 |
|
| 339 |
|
| 340 |
|
| 341 |
|
| 342 |
|
| 343 | <div class="description">
|
| 344 | <p>Adds a device to a device group.</p>
|
| 345 | </div>
|
| 346 |
|
| 347 |
|
| 348 |
|
| 349 |
|
| 350 |
|
| 351 |
|
| 352 |
|
| 353 |
|
| 354 |
|
| 355 | <h5>Parameters:</h5>
|
| 356 |
|
| 357 |
|
| 358 | <table class="params">
|
| 359 | <thead>
|
| 360 | <tr>
|
| 361 |
|
| 362 | <th>Name</th>
|
| 363 |
|
| 364 |
|
| 365 | <th>Type</th>
|
| 366 |
|
| 367 |
|
| 368 | <th>Attributes</th>
|
| 369 |
|
| 370 |
|
| 371 |
|
| 372 |
|
| 373 | <th class="last">Description</th>
|
| 374 | </tr>
|
| 375 | </thead>
|
| 376 |
|
| 377 | <tbody>
|
| 378 |
|
| 379 |
|
| 380 | <tr>
|
| 381 |
|
| 382 | <td class="name"><code>deviceName</code></td>
|
| 383 |
|
| 384 |
|
| 385 | <td class="type">
|
| 386 |
|
| 387 |
|
| 388 | <span class="param-type">String</span>
|
| 389 |
|
| 390 |
|
| 391 |
|
| 392 | </td>
|
| 393 |
|
| 394 |
|
| 395 | <td class="attributes">
|
| 396 |
|
| 397 |
|
| 398 |
|
| 399 |
|
| 400 |
|
| 401 | </td>
|
| 402 |
|
| 403 |
|
| 404 |
|
| 405 |
|
| 406 | <td class="description last"><p>Device name to add.</p></td>
|
| 407 | </tr>
|
| 408 |
|
| 409 |
|
| 410 |
|
| 411 | <tr>
|
| 412 |
|
| 413 | <td class="name"><code>deviceGroup</code></td>
|
| 414 |
|
| 415 |
|
| 416 | <td class="type">
|
| 417 |
|
| 418 |
|
| 419 | <span class="param-type">String</span>
|
| 420 |
|
| 421 |
|
| 422 |
|
| 423 | </td>
|
| 424 |
|
| 425 |
|
| 426 | <td class="attributes">
|
| 427 |
|
| 428 |
|
| 429 |
|
| 430 |
|
| 431 |
|
| 432 | </td>
|
| 433 |
|
| 434 |
|
| 435 |
|
| 436 |
|
| 437 | <td class="description last"><p>Name of the device group to add device to.</p></td>
|
| 438 | </tr>
|
| 439 |
|
| 440 |
|
| 441 |
|
| 442 | <tr>
|
| 443 |
|
| 444 | <td class="name"><code>retryOptions</code></td>
|
| 445 |
|
| 446 |
|
| 447 | <td class="type">
|
| 448 |
|
| 449 |
|
| 450 | <span class="param-type">Object</span>
|
| 451 |
|
| 452 |
|
| 453 |
|
| 454 | </td>
|
| 455 |
|
| 456 |
|
| 457 | <td class="attributes">
|
| 458 |
|
| 459 | <optional><br>
|
| 460 |
|
| 461 |
|
| 462 |
|
| 463 |
|
| 464 |
|
| 465 | </td>
|
| 466 |
|
| 467 |
|
| 468 |
|
| 469 |
|
| 470 | <td class="description last"><p>Options for retrying the request.</p>
|
| 471 | <h6>Properties</h6>
|
| 472 |
|
| 473 |
|
| 474 | <table class="params">
|
| 475 | <thead>
|
| 476 | <tr>
|
| 477 |
|
| 478 | <th>Name</th>
|
| 479 |
|
| 480 |
|
| 481 | <th>Type</th>
|
| 482 |
|
| 483 |
|
| 484 | <th>Attributes</th>
|
| 485 |
|
| 486 |
|
| 487 |
|
| 488 |
|
| 489 | <th class="last">Description</th>
|
| 490 | </tr>
|
| 491 | </thead>
|
| 492 |
|
| 493 | <tbody>
|
| 494 |
|
| 495 |
|
| 496 | <tr>
|
| 497 |
|
| 498 | <td class="name"><code>maxRetries</code></td>
|
| 499 |
|
| 500 |
|
| 501 | <td class="type">
|
| 502 |
|
| 503 |
|
| 504 | <span class="param-type">Integer</span>
|
| 505 |
|
| 506 |
|
| 507 |
|
| 508 | </td>
|
| 509 |
|
| 510 |
|
| 511 | <td class="attributes">
|
| 512 |
|
| 513 | <optional><br>
|
| 514 |
|
| 515 |
|
| 516 |
|
| 517 |
|
| 518 |
|
| 519 | </td>
|
| 520 |
|
| 521 |
|
| 522 |
|
| 523 |
|
| 524 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 525 | 0 to not retry. Default 60.</p></td>
|
| 526 | </tr>
|
| 527 |
|
| 528 |
|
| 529 |
|
| 530 | <tr>
|
| 531 |
|
| 532 | <td class="name"><code>retryIntervalMs</code></td>
|
| 533 |
|
| 534 |
|
| 535 | <td class="type">
|
| 536 |
|
| 537 |
|
| 538 | <span class="param-type">Integer</span>
|
| 539 |
|
| 540 |
|
| 541 |
|
| 542 | </td>
|
| 543 |
|
| 544 |
|
| 545 | <td class="attributes">
|
| 546 |
|
| 547 | <optional><br>
|
| 548 |
|
| 549 |
|
| 550 |
|
| 551 |
|
| 552 |
|
| 553 | </td>
|
| 554 |
|
| 555 |
|
| 556 |
|
| 557 |
|
| 558 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 559 | </tr>
|
| 560 |
|
| 561 |
|
| 562 | </tbody>
|
| 563 | </table>
|
| 564 |
|
| 565 | </td>
|
| 566 | </tr>
|
| 567 |
|
| 568 |
|
| 569 | </tbody>
|
| 570 | </table>
|
| 571 |
|
| 572 |
|
| 573 |
|
| 574 |
|
| 575 |
|
| 576 |
|
| 577 | <dl class="details">
|
| 578 |
|
| 579 |
|
| 580 |
|
| 581 |
|
| 582 |
|
| 583 |
|
| 584 |
|
| 585 |
|
| 586 |
|
| 587 |
|
| 588 |
|
| 589 |
|
| 590 |
|
| 591 |
|
| 592 |
|
| 593 |
|
| 594 |
|
| 595 |
|
| 596 |
|
| 597 |
|
| 598 |
|
| 599 |
|
| 600 |
|
| 601 |
|
| 602 |
|
| 603 |
|
| 604 |
|
| 605 |
|
| 606 |
|
| 607 |
|
| 608 |
|
| 609 |
|
| 610 | </dl>
|
| 611 |
|
| 612 |
|
| 613 |
|
| 614 |
|
| 615 |
|
| 616 |
|
| 617 |
|
| 618 |
|
| 619 |
|
| 620 |
|
| 621 |
|
| 622 |
|
| 623 |
|
| 624 | <h5>Returns:</h5>
|
| 625 |
|
| 626 |
|
| 627 | <div class="param-desc">
|
| 628 | <p>A promise which is resolved when the request is complete
|
| 629 | or rejected if an error occurs.</p>
|
| 630 | </div>
|
| 631 |
|
| 632 |
|
| 633 |
|
| 634 | <dl>
|
| 635 | <dt>
|
| 636 | Type
|
| 637 | </dt>
|
| 638 | <dd>
|
| 639 |
|
| 640 | <span class="param-type">Promise</span>
|
| 641 |
|
| 642 |
|
| 643 | </dd>
|
| 644 | </dl>
|
| 645 |
|
| 646 |
|
| 647 |
|
| 648 |
|
| 649 |
|
| 650 |
|
| 651 |
|
| 652 |
|
| 653 |
|
| 654 |
|
| 655 |
|
| 656 |
|
| 657 |
|
| 658 | <h4 class="name" id="addToTrust"><span class="type-signature"></span>addToTrust<span class="signature">(deviceName, remoteHost, remoteUser, remotePassword, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 659 |
|
| 660 |
|
| 661 |
|
| 662 |
|
| 663 |
|
| 664 |
|
| 665 | <div class="description">
|
| 666 | <p>Adds a device to the trust group.</p>
|
| 667 | </div>
|
| 668 |
|
| 669 |
|
| 670 |
|
| 671 |
|
| 672 |
|
| 673 |
|
| 674 |
|
| 675 |
|
| 676 |
|
| 677 | <h5>Parameters:</h5>
|
| 678 |
|
| 679 |
|
| 680 | <table class="params">
|
| 681 | <thead>
|
| 682 | <tr>
|
| 683 |
|
| 684 | <th>Name</th>
|
| 685 |
|
| 686 |
|
| 687 | <th>Type</th>
|
| 688 |
|
| 689 |
|
| 690 | <th>Attributes</th>
|
| 691 |
|
| 692 |
|
| 693 |
|
| 694 |
|
| 695 | <th class="last">Description</th>
|
| 696 | </tr>
|
| 697 | </thead>
|
| 698 |
|
| 699 | <tbody>
|
| 700 |
|
| 701 |
|
| 702 | <tr>
|
| 703 |
|
| 704 | <td class="name"><code>deviceName</code></td>
|
| 705 |
|
| 706 |
|
| 707 | <td class="type">
|
| 708 |
|
| 709 |
|
| 710 | <span class="param-type">String</span>
|
| 711 |
|
| 712 |
|
| 713 |
|
| 714 | </td>
|
| 715 |
|
| 716 |
|
| 717 | <td class="attributes">
|
| 718 |
|
| 719 |
|
| 720 |
|
| 721 |
|
| 722 |
|
| 723 | </td>
|
| 724 |
|
| 725 |
|
| 726 |
|
| 727 |
|
| 728 | <td class="description last"><p>Device name to add.</p></td>
|
| 729 | </tr>
|
| 730 |
|
| 731 |
|
| 732 |
|
| 733 | <tr>
|
| 734 |
|
| 735 | <td class="name"><code>remoteHost</code></td>
|
| 736 |
|
| 737 |
|
| 738 | <td class="type">
|
| 739 |
|
| 740 |
|
| 741 | <span class="param-type">String</span>
|
| 742 |
|
| 743 |
|
| 744 |
|
| 745 | </td>
|
| 746 |
|
| 747 |
|
| 748 | <td class="attributes">
|
| 749 |
|
| 750 |
|
| 751 |
|
| 752 |
|
| 753 |
|
| 754 | </td>
|
| 755 |
|
| 756 |
|
| 757 |
|
| 758 |
|
| 759 | <td class="description last"><p>IP address of remote host to add</p></td>
|
| 760 | </tr>
|
| 761 |
|
| 762 |
|
| 763 |
|
| 764 | <tr>
|
| 765 |
|
| 766 | <td class="name"><code>remoteUser</code></td>
|
| 767 |
|
| 768 |
|
| 769 | <td class="type">
|
| 770 |
|
| 771 |
|
| 772 | <span class="param-type">String</span>
|
| 773 |
|
| 774 |
|
| 775 |
|
| 776 | </td>
|
| 777 |
|
| 778 |
|
| 779 | <td class="attributes">
|
| 780 |
|
| 781 |
|
| 782 |
|
| 783 |
|
| 784 |
|
| 785 | </td>
|
| 786 |
|
| 787 |
|
| 788 |
|
| 789 |
|
| 790 | <td class="description last"><p>Admin user name on remote host</p></td>
|
| 791 | </tr>
|
| 792 |
|
| 793 |
|
| 794 |
|
| 795 | <tr>
|
| 796 |
|
| 797 | <td class="name"><code>remotePassword</code></td>
|
| 798 |
|
| 799 |
|
| 800 | <td class="type">
|
| 801 |
|
| 802 |
|
| 803 | <span class="param-type">String</span>
|
| 804 |
|
| 805 |
|
| 806 |
|
| 807 | </td>
|
| 808 |
|
| 809 |
|
| 810 | <td class="attributes">
|
| 811 |
|
| 812 |
|
| 813 |
|
| 814 |
|
| 815 |
|
| 816 | </td>
|
| 817 |
|
| 818 |
|
| 819 |
|
| 820 |
|
| 821 | <td class="description last"><p>Admin user password on remote host</p></td>
|
| 822 | </tr>
|
| 823 |
|
| 824 |
|
| 825 |
|
| 826 | <tr>
|
| 827 |
|
| 828 | <td class="name"><code>retryOptions</code></td>
|
| 829 |
|
| 830 |
|
| 831 | <td class="type">
|
| 832 |
|
| 833 |
|
| 834 | <span class="param-type">Object</span>
|
| 835 |
|
| 836 |
|
| 837 |
|
| 838 | </td>
|
| 839 |
|
| 840 |
|
| 841 | <td class="attributes">
|
| 842 |
|
| 843 | <optional><br>
|
| 844 |
|
| 845 |
|
| 846 |
|
| 847 |
|
| 848 |
|
| 849 | </td>
|
| 850 |
|
| 851 |
|
| 852 |
|
| 853 |
|
| 854 | <td class="description last"><p>Options for retrying the request.</p>
|
| 855 | <h6>Properties</h6>
|
| 856 |
|
| 857 |
|
| 858 | <table class="params">
|
| 859 | <thead>
|
| 860 | <tr>
|
| 861 |
|
| 862 | <th>Name</th>
|
| 863 |
|
| 864 |
|
| 865 | <th>Type</th>
|
| 866 |
|
| 867 |
|
| 868 | <th>Attributes</th>
|
| 869 |
|
| 870 |
|
| 871 |
|
| 872 |
|
| 873 | <th class="last">Description</th>
|
| 874 | </tr>
|
| 875 | </thead>
|
| 876 |
|
| 877 | <tbody>
|
| 878 |
|
| 879 |
|
| 880 | <tr>
|
| 881 |
|
| 882 | <td class="name"><code>maxRetries</code></td>
|
| 883 |
|
| 884 |
|
| 885 | <td class="type">
|
| 886 |
|
| 887 |
|
| 888 | <span class="param-type">Integer</span>
|
| 889 |
|
| 890 |
|
| 891 |
|
| 892 | </td>
|
| 893 |
|
| 894 |
|
| 895 | <td class="attributes">
|
| 896 |
|
| 897 | <optional><br>
|
| 898 |
|
| 899 |
|
| 900 |
|
| 901 |
|
| 902 |
|
| 903 | </td>
|
| 904 |
|
| 905 |
|
| 906 |
|
| 907 |
|
| 908 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 909 | 0 to not retry. Default 60.</p></td>
|
| 910 | </tr>
|
| 911 |
|
| 912 |
|
| 913 |
|
| 914 | <tr>
|
| 915 |
|
| 916 | <td class="name"><code>retryIntervalMs</code></td>
|
| 917 |
|
| 918 |
|
| 919 | <td class="type">
|
| 920 |
|
| 921 |
|
| 922 | <span class="param-type">Integer</span>
|
| 923 |
|
| 924 |
|
| 925 |
|
| 926 | </td>
|
| 927 |
|
| 928 |
|
| 929 | <td class="attributes">
|
| 930 |
|
| 931 | <optional><br>
|
| 932 |
|
| 933 |
|
| 934 |
|
| 935 |
|
| 936 |
|
| 937 | </td>
|
| 938 |
|
| 939 |
|
| 940 |
|
| 941 |
|
| 942 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 943 | </tr>
|
| 944 |
|
| 945 |
|
| 946 | </tbody>
|
| 947 | </table>
|
| 948 |
|
| 949 | </td>
|
| 950 | </tr>
|
| 951 |
|
| 952 |
|
| 953 | </tbody>
|
| 954 | </table>
|
| 955 |
|
| 956 |
|
| 957 |
|
| 958 |
|
| 959 |
|
| 960 |
|
| 961 | <dl class="details">
|
| 962 |
|
| 963 |
|
| 964 |
|
| 965 |
|
| 966 |
|
| 967 |
|
| 968 |
|
| 969 |
|
| 970 |
|
| 971 |
|
| 972 |
|
| 973 |
|
| 974 |
|
| 975 |
|
| 976 |
|
| 977 |
|
| 978 |
|
| 979 |
|
| 980 |
|
| 981 |
|
| 982 |
|
| 983 |
|
| 984 |
|
| 985 |
|
| 986 |
|
| 987 |
|
| 988 |
|
| 989 |
|
| 990 |
|
| 991 |
|
| 992 |
|
| 993 |
|
| 994 | </dl>
|
| 995 |
|
| 996 |
|
| 997 |
|
| 998 |
|
| 999 |
|
| 1000 |
|
| 1001 |
|
| 1002 |
|
| 1003 |
|
| 1004 |
|
| 1005 |
|
| 1006 |
|
| 1007 |
|
| 1008 | <h5>Returns:</h5>
|
| 1009 |
|
| 1010 |
|
| 1011 | <div class="param-desc">
|
| 1012 | <p>A promise which is resolved when the request is complete
|
| 1013 | or rejected if an error occurs.</p>
|
| 1014 | </div>
|
| 1015 |
|
| 1016 |
|
| 1017 |
|
| 1018 | <dl>
|
| 1019 | <dt>
|
| 1020 | Type
|
| 1021 | </dt>
|
| 1022 | <dd>
|
| 1023 |
|
| 1024 | <span class="param-type">Promise</span>
|
| 1025 |
|
| 1026 |
|
| 1027 | </dd>
|
| 1028 | </dl>
|
| 1029 |
|
| 1030 |
|
| 1031 |
|
| 1032 |
|
| 1033 |
|
| 1034 |
|
| 1035 |
|
| 1036 |
|
| 1037 |
|
| 1038 |
|
| 1039 |
|
| 1040 |
|
| 1041 |
|
| 1042 | <h4 class="name" id="areInDeviceGroup"><span class="type-signature"></span>areInDeviceGroup<span class="signature">(deviceNames, deviceGroup, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 1043 |
|
| 1044 |
|
| 1045 |
|
| 1046 |
|
| 1047 |
|
| 1048 |
|
| 1049 | <div class="description">
|
| 1050 | <p>Checks to see if a device is in a device group</p>
|
| 1051 | </div>
|
| 1052 |
|
| 1053 |
|
| 1054 |
|
| 1055 |
|
| 1056 |
|
| 1057 |
|
| 1058 |
|
| 1059 |
|
| 1060 |
|
| 1061 | <h5>Parameters:</h5>
|
| 1062 |
|
| 1063 |
|
| 1064 | <table class="params">
|
| 1065 | <thead>
|
| 1066 | <tr>
|
| 1067 |
|
| 1068 | <th>Name</th>
|
| 1069 |
|
| 1070 |
|
| 1071 | <th>Type</th>
|
| 1072 |
|
| 1073 |
|
| 1074 | <th>Attributes</th>
|
| 1075 |
|
| 1076 |
|
| 1077 |
|
| 1078 |
|
| 1079 | <th class="last">Description</th>
|
| 1080 | </tr>
|
| 1081 | </thead>
|
| 1082 |
|
| 1083 | <tbody>
|
| 1084 |
|
| 1085 |
|
| 1086 | <tr>
|
| 1087 |
|
| 1088 | <td class="name"><code>deviceNames</code></td>
|
| 1089 |
|
| 1090 |
|
| 1091 | <td class="type">
|
| 1092 |
|
| 1093 |
|
| 1094 | <span class="param-type">Array.<String></span>
|
| 1095 |
|
| 1096 |
|
| 1097 |
|
| 1098 | </td>
|
| 1099 |
|
| 1100 |
|
| 1101 | <td class="attributes">
|
| 1102 |
|
| 1103 |
|
| 1104 |
|
| 1105 |
|
| 1106 |
|
| 1107 | </td>
|
| 1108 |
|
| 1109 |
|
| 1110 |
|
| 1111 |
|
| 1112 | <td class="description last"><p>Device names to check for.</p></td>
|
| 1113 | </tr>
|
| 1114 |
|
| 1115 |
|
| 1116 |
|
| 1117 | <tr>
|
| 1118 |
|
| 1119 | <td class="name"><code>deviceGroup</code></td>
|
| 1120 |
|
| 1121 |
|
| 1122 | <td class="type">
|
| 1123 |
|
| 1124 |
|
| 1125 | <span class="param-type">String</span>
|
| 1126 |
|
| 1127 |
|
| 1128 |
|
| 1129 | </td>
|
| 1130 |
|
| 1131 |
|
| 1132 | <td class="attributes">
|
| 1133 |
|
| 1134 |
|
| 1135 |
|
| 1136 |
|
| 1137 |
|
| 1138 | </td>
|
| 1139 |
|
| 1140 |
|
| 1141 |
|
| 1142 |
|
| 1143 | <td class="description last"><p>Device group to look in.</p></td>
|
| 1144 | </tr>
|
| 1145 |
|
| 1146 |
|
| 1147 |
|
| 1148 | <tr>
|
| 1149 |
|
| 1150 | <td class="name"><code>retryOptions</code></td>
|
| 1151 |
|
| 1152 |
|
| 1153 | <td class="type">
|
| 1154 |
|
| 1155 |
|
| 1156 | <span class="param-type">Object</span>
|
| 1157 |
|
| 1158 |
|
| 1159 |
|
| 1160 | </td>
|
| 1161 |
|
| 1162 |
|
| 1163 | <td class="attributes">
|
| 1164 |
|
| 1165 | <optional><br>
|
| 1166 |
|
| 1167 |
|
| 1168 |
|
| 1169 |
|
| 1170 |
|
| 1171 | </td>
|
| 1172 |
|
| 1173 |
|
| 1174 |
|
| 1175 |
|
| 1176 | <td class="description last"><p>Options for retrying the request.</p>
|
| 1177 | <h6>Properties</h6>
|
| 1178 |
|
| 1179 |
|
| 1180 | <table class="params">
|
| 1181 | <thead>
|
| 1182 | <tr>
|
| 1183 |
|
| 1184 | <th>Name</th>
|
| 1185 |
|
| 1186 |
|
| 1187 | <th>Type</th>
|
| 1188 |
|
| 1189 |
|
| 1190 | <th>Attributes</th>
|
| 1191 |
|
| 1192 |
|
| 1193 |
|
| 1194 |
|
| 1195 | <th class="last">Description</th>
|
| 1196 | </tr>
|
| 1197 | </thead>
|
| 1198 |
|
| 1199 | <tbody>
|
| 1200 |
|
| 1201 |
|
| 1202 | <tr>
|
| 1203 |
|
| 1204 | <td class="name"><code>maxRetries</code></td>
|
| 1205 |
|
| 1206 |
|
| 1207 | <td class="type">
|
| 1208 |
|
| 1209 |
|
| 1210 | <span class="param-type">Integer</span>
|
| 1211 |
|
| 1212 |
|
| 1213 |
|
| 1214 | </td>
|
| 1215 |
|
| 1216 |
|
| 1217 | <td class="attributes">
|
| 1218 |
|
| 1219 | <optional><br>
|
| 1220 |
|
| 1221 |
|
| 1222 |
|
| 1223 |
|
| 1224 |
|
| 1225 | </td>
|
| 1226 |
|
| 1227 |
|
| 1228 |
|
| 1229 |
|
| 1230 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 1231 | 0 to not retry. Default 60.</p></td>
|
| 1232 | </tr>
|
| 1233 |
|
| 1234 |
|
| 1235 |
|
| 1236 | <tr>
|
| 1237 |
|
| 1238 | <td class="name"><code>retryIntervalMs</code></td>
|
| 1239 |
|
| 1240 |
|
| 1241 | <td class="type">
|
| 1242 |
|
| 1243 |
|
| 1244 | <span class="param-type">Integer</span>
|
| 1245 |
|
| 1246 |
|
| 1247 |
|
| 1248 | </td>
|
| 1249 |
|
| 1250 |
|
| 1251 | <td class="attributes">
|
| 1252 |
|
| 1253 | <optional><br>
|
| 1254 |
|
| 1255 |
|
| 1256 |
|
| 1257 |
|
| 1258 |
|
| 1259 | </td>
|
| 1260 |
|
| 1261 |
|
| 1262 |
|
| 1263 |
|
| 1264 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 1265 | </tr>
|
| 1266 |
|
| 1267 |
|
| 1268 | </tbody>
|
| 1269 | </table>
|
| 1270 |
|
| 1271 | </td>
|
| 1272 | </tr>
|
| 1273 |
|
| 1274 |
|
| 1275 | </tbody>
|
| 1276 | </table>
|
| 1277 |
|
| 1278 |
|
| 1279 |
|
| 1280 |
|
| 1281 |
|
| 1282 |
|
| 1283 | <dl class="details">
|
| 1284 |
|
| 1285 |
|
| 1286 |
|
| 1287 |
|
| 1288 |
|
| 1289 |
|
| 1290 |
|
| 1291 |
|
| 1292 |
|
| 1293 |
|
| 1294 |
|
| 1295 |
|
| 1296 |
|
| 1297 |
|
| 1298 |
|
| 1299 |
|
| 1300 |
|
| 1301 |
|
| 1302 |
|
| 1303 |
|
| 1304 |
|
| 1305 |
|
| 1306 |
|
| 1307 |
|
| 1308 |
|
| 1309 |
|
| 1310 |
|
| 1311 |
|
| 1312 |
|
| 1313 |
|
| 1314 |
|
| 1315 |
|
| 1316 | </dl>
|
| 1317 |
|
| 1318 |
|
| 1319 |
|
| 1320 |
|
| 1321 |
|
| 1322 |
|
| 1323 |
|
| 1324 |
|
| 1325 |
|
| 1326 |
|
| 1327 |
|
| 1328 |
|
| 1329 |
|
| 1330 | <h5>Returns:</h5>
|
| 1331 |
|
| 1332 |
|
| 1333 | <div class="param-desc">
|
| 1334 | <p>A promise which is resolved with an array of names that are in the device group
|
| 1335 | and in deviceNames, or rejected if an error occurs.</p>
|
| 1336 | </div>
|
| 1337 |
|
| 1338 |
|
| 1339 |
|
| 1340 | <dl>
|
| 1341 | <dt>
|
| 1342 | Type
|
| 1343 | </dt>
|
| 1344 | <dd>
|
| 1345 |
|
| 1346 | <span class="param-type">Promise</span>
|
| 1347 |
|
| 1348 |
|
| 1349 | </dd>
|
| 1350 | </dl>
|
| 1351 |
|
| 1352 |
|
| 1353 |
|
| 1354 |
|
| 1355 |
|
| 1356 |
|
| 1357 |
|
| 1358 |
|
| 1359 |
|
| 1360 |
|
| 1361 |
|
| 1362 |
|
| 1363 |
|
| 1364 | <h4 class="name" id="areInTrustGroup"><span class="type-signature"></span>areInTrustGroup<span class="signature">(deviceNames, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 1365 |
|
| 1366 |
|
| 1367 |
|
| 1368 |
|
| 1369 |
|
| 1370 |
|
| 1371 | <div class="description">
|
| 1372 | <p>Checks to see if a device is in the trust group</p>
|
| 1373 | </div>
|
| 1374 |
|
| 1375 |
|
| 1376 |
|
| 1377 |
|
| 1378 |
|
| 1379 |
|
| 1380 |
|
| 1381 |
|
| 1382 |
|
| 1383 | <h5>Parameters:</h5>
|
| 1384 |
|
| 1385 |
|
| 1386 | <table class="params">
|
| 1387 | <thead>
|
| 1388 | <tr>
|
| 1389 |
|
| 1390 | <th>Name</th>
|
| 1391 |
|
| 1392 |
|
| 1393 | <th>Type</th>
|
| 1394 |
|
| 1395 |
|
| 1396 | <th>Attributes</th>
|
| 1397 |
|
| 1398 |
|
| 1399 |
|
| 1400 |
|
| 1401 | <th class="last">Description</th>
|
| 1402 | </tr>
|
| 1403 | </thead>
|
| 1404 |
|
| 1405 | <tbody>
|
| 1406 |
|
| 1407 |
|
| 1408 | <tr>
|
| 1409 |
|
| 1410 | <td class="name"><code>deviceNames</code></td>
|
| 1411 |
|
| 1412 |
|
| 1413 | <td class="type">
|
| 1414 |
|
| 1415 |
|
| 1416 | <span class="param-type">Array.<String></span>
|
| 1417 |
|
| 1418 |
|
| 1419 |
|
| 1420 | </td>
|
| 1421 |
|
| 1422 |
|
| 1423 | <td class="attributes">
|
| 1424 |
|
| 1425 |
|
| 1426 |
|
| 1427 |
|
| 1428 |
|
| 1429 | </td>
|
| 1430 |
|
| 1431 |
|
| 1432 |
|
| 1433 |
|
| 1434 | <td class="description last"><p>Device names to check for.</p></td>
|
| 1435 | </tr>
|
| 1436 |
|
| 1437 |
|
| 1438 |
|
| 1439 | <tr>
|
| 1440 |
|
| 1441 | <td class="name"><code>retryOptions</code></td>
|
| 1442 |
|
| 1443 |
|
| 1444 | <td class="type">
|
| 1445 |
|
| 1446 |
|
| 1447 | <span class="param-type">Object</span>
|
| 1448 |
|
| 1449 |
|
| 1450 |
|
| 1451 | </td>
|
| 1452 |
|
| 1453 |
|
| 1454 | <td class="attributes">
|
| 1455 |
|
| 1456 | <optional><br>
|
| 1457 |
|
| 1458 |
|
| 1459 |
|
| 1460 |
|
| 1461 |
|
| 1462 | </td>
|
| 1463 |
|
| 1464 |
|
| 1465 |
|
| 1466 |
|
| 1467 | <td class="description last"><p>Options for retrying the request.</p>
|
| 1468 | <h6>Properties</h6>
|
| 1469 |
|
| 1470 |
|
| 1471 | <table class="params">
|
| 1472 | <thead>
|
| 1473 | <tr>
|
| 1474 |
|
| 1475 | <th>Name</th>
|
| 1476 |
|
| 1477 |
|
| 1478 | <th>Type</th>
|
| 1479 |
|
| 1480 |
|
| 1481 | <th>Attributes</th>
|
| 1482 |
|
| 1483 |
|
| 1484 |
|
| 1485 |
|
| 1486 | <th class="last">Description</th>
|
| 1487 | </tr>
|
| 1488 | </thead>
|
| 1489 |
|
| 1490 | <tbody>
|
| 1491 |
|
| 1492 |
|
| 1493 | <tr>
|
| 1494 |
|
| 1495 | <td class="name"><code>maxRetries</code></td>
|
| 1496 |
|
| 1497 |
|
| 1498 | <td class="type">
|
| 1499 |
|
| 1500 |
|
| 1501 | <span class="param-type">Integer</span>
|
| 1502 |
|
| 1503 |
|
| 1504 |
|
| 1505 | </td>
|
| 1506 |
|
| 1507 |
|
| 1508 | <td class="attributes">
|
| 1509 |
|
| 1510 | <optional><br>
|
| 1511 |
|
| 1512 |
|
| 1513 |
|
| 1514 |
|
| 1515 |
|
| 1516 | </td>
|
| 1517 |
|
| 1518 |
|
| 1519 |
|
| 1520 |
|
| 1521 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 1522 | 0 to not retry. Default 60.</p></td>
|
| 1523 | </tr>
|
| 1524 |
|
| 1525 |
|
| 1526 |
|
| 1527 | <tr>
|
| 1528 |
|
| 1529 | <td class="name"><code>retryIntervalMs</code></td>
|
| 1530 |
|
| 1531 |
|
| 1532 | <td class="type">
|
| 1533 |
|
| 1534 |
|
| 1535 | <span class="param-type">Integer</span>
|
| 1536 |
|
| 1537 |
|
| 1538 |
|
| 1539 | </td>
|
| 1540 |
|
| 1541 |
|
| 1542 | <td class="attributes">
|
| 1543 |
|
| 1544 | <optional><br>
|
| 1545 |
|
| 1546 |
|
| 1547 |
|
| 1548 |
|
| 1549 |
|
| 1550 | </td>
|
| 1551 |
|
| 1552 |
|
| 1553 |
|
| 1554 |
|
| 1555 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 1556 | </tr>
|
| 1557 |
|
| 1558 |
|
| 1559 | </tbody>
|
| 1560 | </table>
|
| 1561 |
|
| 1562 | </td>
|
| 1563 | </tr>
|
| 1564 |
|
| 1565 |
|
| 1566 | </tbody>
|
| 1567 | </table>
|
| 1568 |
|
| 1569 |
|
| 1570 |
|
| 1571 |
|
| 1572 |
|
| 1573 |
|
| 1574 | <dl class="details">
|
| 1575 |
|
| 1576 |
|
| 1577 |
|
| 1578 |
|
| 1579 |
|
| 1580 |
|
| 1581 |
|
| 1582 |
|
| 1583 |
|
| 1584 |
|
| 1585 |
|
| 1586 |
|
| 1587 |
|
| 1588 |
|
| 1589 |
|
| 1590 |
|
| 1591 |
|
| 1592 |
|
| 1593 |
|
| 1594 |
|
| 1595 |
|
| 1596 |
|
| 1597 |
|
| 1598 |
|
| 1599 |
|
| 1600 |
|
| 1601 |
|
| 1602 |
|
| 1603 |
|
| 1604 |
|
| 1605 |
|
| 1606 |
|
| 1607 | </dl>
|
| 1608 |
|
| 1609 |
|
| 1610 |
|
| 1611 |
|
| 1612 |
|
| 1613 |
|
| 1614 |
|
| 1615 |
|
| 1616 |
|
| 1617 |
|
| 1618 |
|
| 1619 |
|
| 1620 |
|
| 1621 | <h5>Returns:</h5>
|
| 1622 |
|
| 1623 |
|
| 1624 | <div class="param-desc">
|
| 1625 | <p>A promise which is resolved with an array of names that are in the trust group
|
| 1626 | and in deviceNames, or rejected if an error occurs.</p>
|
| 1627 | </div>
|
| 1628 |
|
| 1629 |
|
| 1630 |
|
| 1631 | <dl>
|
| 1632 | <dt>
|
| 1633 | Type
|
| 1634 | </dt>
|
| 1635 | <dd>
|
| 1636 |
|
| 1637 | <span class="param-type">Promise</span>
|
| 1638 |
|
| 1639 |
|
| 1640 | </dd>
|
| 1641 | </dl>
|
| 1642 |
|
| 1643 |
|
| 1644 |
|
| 1645 |
|
| 1646 |
|
| 1647 |
|
| 1648 |
|
| 1649 |
|
| 1650 |
|
| 1651 |
|
| 1652 |
|
| 1653 |
|
| 1654 |
|
| 1655 | <h4 class="name" id="configSyncIp"><span class="type-signature"></span>configSyncIp<span class="signature">(syncIp, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 1656 |
|
| 1657 |
|
| 1658 |
|
| 1659 |
|
| 1660 |
|
| 1661 |
|
| 1662 | <div class="description">
|
| 1663 | <p>Sets the config sync ip</p>
|
| 1664 | </div>
|
| 1665 |
|
| 1666 |
|
| 1667 |
|
| 1668 |
|
| 1669 |
|
| 1670 |
|
| 1671 |
|
| 1672 |
|
| 1673 |
|
| 1674 | <h5>Parameters:</h5>
|
| 1675 |
|
| 1676 |
|
| 1677 | <table class="params">
|
| 1678 | <thead>
|
| 1679 | <tr>
|
| 1680 |
|
| 1681 | <th>Name</th>
|
| 1682 |
|
| 1683 |
|
| 1684 | <th>Type</th>
|
| 1685 |
|
| 1686 |
|
| 1687 | <th>Attributes</th>
|
| 1688 |
|
| 1689 |
|
| 1690 |
|
| 1691 |
|
| 1692 | <th class="last">Description</th>
|
| 1693 | </tr>
|
| 1694 | </thead>
|
| 1695 |
|
| 1696 | <tbody>
|
| 1697 |
|
| 1698 |
|
| 1699 | <tr>
|
| 1700 |
|
| 1701 | <td class="name"><code>syncIp</code></td>
|
| 1702 |
|
| 1703 |
|
| 1704 | <td class="type">
|
| 1705 |
|
| 1706 |
|
| 1707 | <span class="param-type">String</span>
|
| 1708 |
|
| 1709 |
|
| 1710 |
|
| 1711 | </td>
|
| 1712 |
|
| 1713 |
|
| 1714 | <td class="attributes">
|
| 1715 |
|
| 1716 |
|
| 1717 |
|
| 1718 |
|
| 1719 |
|
| 1720 | </td>
|
| 1721 |
|
| 1722 |
|
| 1723 |
|
| 1724 |
|
| 1725 | <td class="description last"><p>The IP address to use for config sync.</p></td>
|
| 1726 | </tr>
|
| 1727 |
|
| 1728 |
|
| 1729 |
|
| 1730 | <tr>
|
| 1731 |
|
| 1732 | <td class="name"><code>retryOptions</code></td>
|
| 1733 |
|
| 1734 |
|
| 1735 | <td class="type">
|
| 1736 |
|
| 1737 |
|
| 1738 | <span class="param-type">Object</span>
|
| 1739 |
|
| 1740 |
|
| 1741 |
|
| 1742 | </td>
|
| 1743 |
|
| 1744 |
|
| 1745 | <td class="attributes">
|
| 1746 |
|
| 1747 | <optional><br>
|
| 1748 |
|
| 1749 |
|
| 1750 |
|
| 1751 |
|
| 1752 |
|
| 1753 | </td>
|
| 1754 |
|
| 1755 |
|
| 1756 |
|
| 1757 |
|
| 1758 | <td class="description last"><p>Options for retrying the request.</p>
|
| 1759 | <h6>Properties</h6>
|
| 1760 |
|
| 1761 |
|
| 1762 | <table class="params">
|
| 1763 | <thead>
|
| 1764 | <tr>
|
| 1765 |
|
| 1766 | <th>Name</th>
|
| 1767 |
|
| 1768 |
|
| 1769 | <th>Type</th>
|
| 1770 |
|
| 1771 |
|
| 1772 | <th>Attributes</th>
|
| 1773 |
|
| 1774 |
|
| 1775 |
|
| 1776 |
|
| 1777 | <th class="last">Description</th>
|
| 1778 | </tr>
|
| 1779 | </thead>
|
| 1780 |
|
| 1781 | <tbody>
|
| 1782 |
|
| 1783 |
|
| 1784 | <tr>
|
| 1785 |
|
| 1786 | <td class="name"><code>maxRetries</code></td>
|
| 1787 |
|
| 1788 |
|
| 1789 | <td class="type">
|
| 1790 |
|
| 1791 |
|
| 1792 | <span class="param-type">Integer</span>
|
| 1793 |
|
| 1794 |
|
| 1795 |
|
| 1796 | </td>
|
| 1797 |
|
| 1798 |
|
| 1799 | <td class="attributes">
|
| 1800 |
|
| 1801 | <optional><br>
|
| 1802 |
|
| 1803 |
|
| 1804 |
|
| 1805 |
|
| 1806 |
|
| 1807 | </td>
|
| 1808 |
|
| 1809 |
|
| 1810 |
|
| 1811 |
|
| 1812 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 1813 | 0 to not retry. Default 60.</p></td>
|
| 1814 | </tr>
|
| 1815 |
|
| 1816 |
|
| 1817 |
|
| 1818 | <tr>
|
| 1819 |
|
| 1820 | <td class="name"><code>retryIntervalMs</code></td>
|
| 1821 |
|
| 1822 |
|
| 1823 | <td class="type">
|
| 1824 |
|
| 1825 |
|
| 1826 | <span class="param-type">Integer</span>
|
| 1827 |
|
| 1828 |
|
| 1829 |
|
| 1830 | </td>
|
| 1831 |
|
| 1832 |
|
| 1833 | <td class="attributes">
|
| 1834 |
|
| 1835 | <optional><br>
|
| 1836 |
|
| 1837 |
|
| 1838 |
|
| 1839 |
|
| 1840 |
|
| 1841 | </td>
|
| 1842 |
|
| 1843 |
|
| 1844 |
|
| 1845 |
|
| 1846 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 1847 | </tr>
|
| 1848 |
|
| 1849 |
|
| 1850 | </tbody>
|
| 1851 | </table>
|
| 1852 |
|
| 1853 | </td>
|
| 1854 | </tr>
|
| 1855 |
|
| 1856 |
|
| 1857 | </tbody>
|
| 1858 | </table>
|
| 1859 |
|
| 1860 |
|
| 1861 |
|
| 1862 |
|
| 1863 |
|
| 1864 |
|
| 1865 | <dl class="details">
|
| 1866 |
|
| 1867 |
|
| 1868 |
|
| 1869 |
|
| 1870 |
|
| 1871 |
|
| 1872 |
|
| 1873 |
|
| 1874 |
|
| 1875 |
|
| 1876 |
|
| 1877 |
|
| 1878 |
|
| 1879 |
|
| 1880 |
|
| 1881 |
|
| 1882 |
|
| 1883 |
|
| 1884 |
|
| 1885 |
|
| 1886 |
|
| 1887 |
|
| 1888 |
|
| 1889 |
|
| 1890 |
|
| 1891 |
|
| 1892 |
|
| 1893 |
|
| 1894 |
|
| 1895 |
|
| 1896 |
|
| 1897 |
|
| 1898 | </dl>
|
| 1899 |
|
| 1900 |
|
| 1901 |
|
| 1902 |
|
| 1903 |
|
| 1904 |
|
| 1905 |
|
| 1906 |
|
| 1907 |
|
| 1908 |
|
| 1909 |
|
| 1910 |
|
| 1911 |
|
| 1912 | <h5>Returns:</h5>
|
| 1913 |
|
| 1914 |
|
| 1915 | <div class="param-desc">
|
| 1916 | <p>A promise which is resolved when the request is complete
|
| 1917 | or rejected if an error occurs.</p>
|
| 1918 | </div>
|
| 1919 |
|
| 1920 |
|
| 1921 |
|
| 1922 | <dl>
|
| 1923 | <dt>
|
| 1924 | Type
|
| 1925 | </dt>
|
| 1926 | <dd>
|
| 1927 |
|
| 1928 | <span class="param-type">Promise</span>
|
| 1929 |
|
| 1930 |
|
| 1931 | </dd>
|
| 1932 | </dl>
|
| 1933 |
|
| 1934 |
|
| 1935 |
|
| 1936 |
|
| 1937 |
|
| 1938 |
|
| 1939 |
|
| 1940 |
|
| 1941 |
|
| 1942 |
|
| 1943 |
|
| 1944 |
|
| 1945 |
|
| 1946 | <h4 class="name" id="createDeviceGroup"><span class="type-signature"></span>createDeviceGroup<span class="signature">(deviceGroup, type, deviceNames<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>
|
| 1947 |
|
| 1948 |
|
| 1949 |
|
| 1950 |
|
| 1951 |
|
| 1952 |
|
| 1953 | <div class="description">
|
| 1954 | <p>Creates a device group</p>
|
| 1955 | </div>
|
| 1956 |
|
| 1957 |
|
| 1958 |
|
| 1959 |
|
| 1960 |
|
| 1961 |
|
| 1962 |
|
| 1963 |
|
| 1964 |
|
| 1965 | <h5>Parameters:</h5>
|
| 1966 |
|
| 1967 |
|
| 1968 | <table class="params">
|
| 1969 | <thead>
|
| 1970 | <tr>
|
| 1971 |
|
| 1972 | <th>Name</th>
|
| 1973 |
|
| 1974 |
|
| 1975 | <th>Type</th>
|
| 1976 |
|
| 1977 |
|
| 1978 | <th>Attributes</th>
|
| 1979 |
|
| 1980 |
|
| 1981 |
|
| 1982 |
|
| 1983 | <th class="last">Description</th>
|
| 1984 | </tr>
|
| 1985 | </thead>
|
| 1986 |
|
| 1987 | <tbody>
|
| 1988 |
|
| 1989 |
|
| 1990 | <tr>
|
| 1991 |
|
| 1992 | <td class="name"><code>deviceGroup</code></td>
|
| 1993 |
|
| 1994 |
|
| 1995 | <td class="type">
|
| 1996 |
|
| 1997 |
|
| 1998 | <span class="param-type">String</span>
|
| 1999 |
|
| 2000 |
|
| 2001 |
|
| 2002 | </td>
|
| 2003 |
|
| 2004 |
|
| 2005 | <td class="attributes">
|
| 2006 |
|
| 2007 |
|
| 2008 |
|
| 2009 |
|
| 2010 |
|
| 2011 | </td>
|
| 2012 |
|
| 2013 |
|
| 2014 |
|
| 2015 |
|
| 2016 | <td class="description last"><p>Name for device group.</p></td>
|
| 2017 | </tr>
|
| 2018 |
|
| 2019 |
|
| 2020 |
|
| 2021 | <tr>
|
| 2022 |
|
| 2023 | <td class="name"><code>type</code></td>
|
| 2024 |
|
| 2025 |
|
| 2026 | <td class="type">
|
| 2027 |
|
| 2028 |
|
| 2029 | <span class="param-type">String</span>
|
| 2030 |
|
| 2031 |
|
| 2032 |
|
| 2033 | </td>
|
| 2034 |
|
| 2035 |
|
| 2036 | <td class="attributes">
|
| 2037 |
|
| 2038 |
|
| 2039 |
|
| 2040 |
|
| 2041 |
|
| 2042 | </td>
|
| 2043 |
|
| 2044 |
|
| 2045 |
|
| 2046 |
|
| 2047 | <td class="description last"><p>Type of device group. Must be
|
| 2048 | 'sync-only' || 'sync-failover'.</p></td>
|
| 2049 | </tr>
|
| 2050 |
|
| 2051 |
|
| 2052 |
|
| 2053 | <tr>
|
| 2054 |
|
| 2055 | <td class="name"><code>deviceNames</code></td>
|
| 2056 |
|
| 2057 |
|
| 2058 | <td class="type">
|
| 2059 |
|
| 2060 |
|
| 2061 | <span class="param-type">String</span>
|
| 2062 | |
|
| 2063 |
|
| 2064 | <span class="param-type">Array.<String></span>
|
| 2065 |
|
| 2066 |
|
| 2067 |
|
| 2068 | </td>
|
| 2069 |
|
| 2070 |
|
| 2071 | <td class="attributes">
|
| 2072 |
|
| 2073 | <optional><br>
|
| 2074 |
|
| 2075 |
|
| 2076 |
|
| 2077 |
|
| 2078 |
|
| 2079 | </td>
|
| 2080 |
|
| 2081 |
|
| 2082 |
|
| 2083 |
|
| 2084 | <td class="description last"><p>Device name or array of names to
|
| 2085 | add to the group.</p></td>
|
| 2086 | </tr>
|
| 2087 |
|
| 2088 |
|
| 2089 |
|
| 2090 | <tr>
|
| 2091 |
|
| 2092 | <td class="name"><code>options</code></td>
|
| 2093 |
|
| 2094 |
|
| 2095 | <td class="type">
|
| 2096 |
|
| 2097 |
|
| 2098 | <span class="param-type">Object</span>
|
| 2099 |
|
| 2100 |
|
| 2101 |
|
| 2102 | </td>
|
| 2103 |
|
| 2104 |
|
| 2105 | <td class="attributes">
|
| 2106 |
|
| 2107 | <optional><br>
|
| 2108 |
|
| 2109 |
|
| 2110 |
|
| 2111 |
|
| 2112 |
|
| 2113 | </td>
|
| 2114 |
|
| 2115 |
|
| 2116 |
|
| 2117 |
|
| 2118 | <td class="description last"><p>Object containg device group options.</p>
|
| 2119 | <h6>Properties</h6>
|
| 2120 |
|
| 2121 |
|
| 2122 | <table class="params">
|
| 2123 | <thead>
|
| 2124 | <tr>
|
| 2125 |
|
| 2126 | <th>Name</th>
|
| 2127 |
|
| 2128 |
|
| 2129 | <th>Type</th>
|
| 2130 |
|
| 2131 |
|
| 2132 | <th>Attributes</th>
|
| 2133 |
|
| 2134 |
|
| 2135 |
|
| 2136 |
|
| 2137 | <th class="last">Description</th>
|
| 2138 | </tr>
|
| 2139 | </thead>
|
| 2140 |
|
| 2141 | <tbody>
|
| 2142 |
|
| 2143 |
|
| 2144 | <tr>
|
| 2145 |
|
| 2146 | <td class="name"><code>autoSync</code></td>
|
| 2147 |
|
| 2148 |
|
| 2149 | <td class="type">
|
| 2150 |
|
| 2151 |
|
| 2152 | <span class="param-type">Boolean</span>
|
| 2153 |
|
| 2154 |
|
| 2155 |
|
| 2156 | </td>
|
| 2157 |
|
| 2158 |
|
| 2159 | <td class="attributes">
|
| 2160 |
|
| 2161 | <optional><br>
|
| 2162 |
|
| 2163 |
|
| 2164 |
|
| 2165 |
|
| 2166 |
|
| 2167 | </td>
|
| 2168 |
|
| 2169 |
|
| 2170 |
|
| 2171 |
|
| 2172 | <td class="description last"><p>Whether or not to autoSync. Default false.</p></td>
|
| 2173 | </tr>
|
| 2174 |
|
| 2175 |
|
| 2176 |
|
| 2177 | <tr>
|
| 2178 |
|
| 2179 | <td class="name"><code>saveOnAutoSync</code></td>
|
| 2180 |
|
| 2181 |
|
| 2182 | <td class="type">
|
| 2183 |
|
| 2184 |
|
| 2185 | <span class="param-type">Boolean</span>
|
| 2186 |
|
| 2187 |
|
| 2188 |
|
| 2189 | </td>
|
| 2190 |
|
| 2191 |
|
| 2192 | <td class="attributes">
|
| 2193 |
|
| 2194 | <optional><br>
|
| 2195 |
|
| 2196 |
|
| 2197 |
|
| 2198 |
|
| 2199 |
|
| 2200 | </td>
|
| 2201 |
|
| 2202 |
|
| 2203 |
|
| 2204 |
|
| 2205 | <td class="description last"><p>If autoSync is eanbled, whether or not to save on
|
| 2206 | autoSync. Default false.</p></td>
|
| 2207 | </tr>
|
| 2208 |
|
| 2209 |
|
| 2210 |
|
| 2211 | <tr>
|
| 2212 |
|
| 2213 | <td class="name"><code>networkFailover</code></td>
|
| 2214 |
|
| 2215 |
|
| 2216 | <td class="type">
|
| 2217 |
|
| 2218 |
|
| 2219 | <span class="param-type">Boolean</span>
|
| 2220 |
|
| 2221 |
|
| 2222 |
|
| 2223 | </td>
|
| 2224 |
|
| 2225 |
|
| 2226 | <td class="attributes">
|
| 2227 |
|
| 2228 | <optional><br>
|
| 2229 |
|
| 2230 |
|
| 2231 |
|
| 2232 |
|
| 2233 |
|
| 2234 | </td>
|
| 2235 |
|
| 2236 |
|
| 2237 |
|
| 2238 |
|
| 2239 | <td class="description last"><p>Whether or not to use network fail-over.
|
| 2240 | Default false.</p></td>
|
| 2241 | </tr>
|
| 2242 |
|
| 2243 |
|
| 2244 |
|
| 2245 | <tr>
|
| 2246 |
|
| 2247 | <td class="name"><code>fullLoadOnSync</code></td>
|
| 2248 |
|
| 2249 |
|
| 2250 | <td class="type">
|
| 2251 |
|
| 2252 |
|
| 2253 | <span class="param-type">Boolean</span>
|
| 2254 |
|
| 2255 |
|
| 2256 |
|
| 2257 | </td>
|
| 2258 |
|
| 2259 |
|
| 2260 | <td class="attributes">
|
| 2261 |
|
| 2262 | <optional><br>
|
| 2263 |
|
| 2264 |
|
| 2265 |
|
| 2266 |
|
| 2267 |
|
| 2268 | </td>
|
| 2269 |
|
| 2270 |
|
| 2271 |
|
| 2272 |
|
| 2273 | <td class="description last"><p>Whether or not to do a full sync. Default false.</p></td>
|
| 2274 | </tr>
|
| 2275 |
|
| 2276 |
|
| 2277 |
|
| 2278 | <tr>
|
| 2279 |
|
| 2280 | <td class="name"><code>asmSync</code></td>
|
| 2281 |
|
| 2282 |
|
| 2283 | <td class="type">
|
| 2284 |
|
| 2285 |
|
| 2286 | <span class="param-type">Boolean</span>
|
| 2287 |
|
| 2288 |
|
| 2289 |
|
| 2290 | </td>
|
| 2291 |
|
| 2292 |
|
| 2293 | <td class="attributes">
|
| 2294 |
|
| 2295 | <optional><br>
|
| 2296 |
|
| 2297 |
|
| 2298 |
|
| 2299 |
|
| 2300 |
|
| 2301 | </td>
|
| 2302 |
|
| 2303 |
|
| 2304 |
|
| 2305 |
|
| 2306 | <td class="description last"><p>Whether or not do to ASM sync. Default false.</p></td>
|
| 2307 | </tr>
|
| 2308 |
|
| 2309 |
|
| 2310 | </tbody>
|
| 2311 | </table>
|
| 2312 |
|
| 2313 | </td>
|
| 2314 | </tr>
|
| 2315 |
|
| 2316 |
|
| 2317 |
|
| 2318 | <tr>
|
| 2319 |
|
| 2320 | <td class="name"><code>retryOptions</code></td>
|
| 2321 |
|
| 2322 |
|
| 2323 | <td class="type">
|
| 2324 |
|
| 2325 |
|
| 2326 | <span class="param-type">Object</span>
|
| 2327 |
|
| 2328 |
|
| 2329 |
|
| 2330 | </td>
|
| 2331 |
|
| 2332 |
|
| 2333 | <td class="attributes">
|
| 2334 |
|
| 2335 | <optional><br>
|
| 2336 |
|
| 2337 |
|
| 2338 |
|
| 2339 |
|
| 2340 |
|
| 2341 | </td>
|
| 2342 |
|
| 2343 |
|
| 2344 |
|
| 2345 |
|
| 2346 | <td class="description last"><p>Options for retrying the request.</p>
|
| 2347 | <h6>Properties</h6>
|
| 2348 |
|
| 2349 |
|
| 2350 | <table class="params">
|
| 2351 | <thead>
|
| 2352 | <tr>
|
| 2353 |
|
| 2354 | <th>Name</th>
|
| 2355 |
|
| 2356 |
|
| 2357 | <th>Type</th>
|
| 2358 |
|
| 2359 |
|
| 2360 | <th>Attributes</th>
|
| 2361 |
|
| 2362 |
|
| 2363 |
|
| 2364 |
|
| 2365 | <th class="last">Description</th>
|
| 2366 | </tr>
|
| 2367 | </thead>
|
| 2368 |
|
| 2369 | <tbody>
|
| 2370 |
|
| 2371 |
|
| 2372 | <tr>
|
| 2373 |
|
| 2374 | <td class="name"><code>maxRetries</code></td>
|
| 2375 |
|
| 2376 |
|
| 2377 | <td class="type">
|
| 2378 |
|
| 2379 |
|
| 2380 | <span class="param-type">Integer</span>
|
| 2381 |
|
| 2382 |
|
| 2383 |
|
| 2384 | </td>
|
| 2385 |
|
| 2386 |
|
| 2387 | <td class="attributes">
|
| 2388 |
|
| 2389 | <optional><br>
|
| 2390 |
|
| 2391 |
|
| 2392 |
|
| 2393 |
|
| 2394 |
|
| 2395 | </td>
|
| 2396 |
|
| 2397 |
|
| 2398 |
|
| 2399 |
|
| 2400 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 2401 | 0 to not retry. Default 60.</p></td>
|
| 2402 | </tr>
|
| 2403 |
|
| 2404 |
|
| 2405 |
|
| 2406 | <tr>
|
| 2407 |
|
| 2408 | <td class="name"><code>retryIntervalMs</code></td>
|
| 2409 |
|
| 2410 |
|
| 2411 | <td class="type">
|
| 2412 |
|
| 2413 |
|
| 2414 | <span class="param-type">Integer</span>
|
| 2415 |
|
| 2416 |
|
| 2417 |
|
| 2418 | </td>
|
| 2419 |
|
| 2420 |
|
| 2421 | <td class="attributes">
|
| 2422 |
|
| 2423 | <optional><br>
|
| 2424 |
|
| 2425 |
|
| 2426 |
|
| 2427 |
|
| 2428 |
|
| 2429 | </td>
|
| 2430 |
|
| 2431 |
|
| 2432 |
|
| 2433 |
|
| 2434 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 2435 | </tr>
|
| 2436 |
|
| 2437 |
|
| 2438 | </tbody>
|
| 2439 | </table>
|
| 2440 |
|
| 2441 | </td>
|
| 2442 | </tr>
|
| 2443 |
|
| 2444 |
|
| 2445 | </tbody>
|
| 2446 | </table>
|
| 2447 |
|
| 2448 |
|
| 2449 |
|
| 2450 |
|
| 2451 |
|
| 2452 |
|
| 2453 | <dl class="details">
|
| 2454 |
|
| 2455 |
|
| 2456 |
|
| 2457 |
|
| 2458 |
|
| 2459 |
|
| 2460 |
|
| 2461 |
|
| 2462 |
|
| 2463 |
|
| 2464 |
|
| 2465 |
|
| 2466 |
|
| 2467 |
|
| 2468 |
|
| 2469 |
|
| 2470 |
|
| 2471 |
|
| 2472 |
|
| 2473 |
|
| 2474 |
|
| 2475 |
|
| 2476 |
|
| 2477 |
|
| 2478 |
|
| 2479 |
|
| 2480 |
|
| 2481 |
|
| 2482 |
|
| 2483 |
|
| 2484 |
|
| 2485 |
|
| 2486 | </dl>
|
| 2487 |
|
| 2488 |
|
| 2489 |
|
| 2490 |
|
| 2491 |
|
| 2492 |
|
| 2493 |
|
| 2494 |
|
| 2495 |
|
| 2496 |
|
| 2497 |
|
| 2498 |
|
| 2499 |
|
| 2500 | <h5>Returns:</h5>
|
| 2501 |
|
| 2502 |
|
| 2503 | <div class="param-desc">
|
| 2504 | <p>A promise which is resolved when the request is complete
|
| 2505 | or rejected if an error occurs.</p>
|
| 2506 | </div>
|
| 2507 |
|
| 2508 |
|
| 2509 |
|
| 2510 | <dl>
|
| 2511 | <dt>
|
| 2512 | Type
|
| 2513 | </dt>
|
| 2514 | <dd>
|
| 2515 |
|
| 2516 | <span class="param-type">Promise</span>
|
| 2517 |
|
| 2518 |
|
| 2519 | </dd>
|
| 2520 | </dl>
|
| 2521 |
|
| 2522 |
|
| 2523 |
|
| 2524 |
|
| 2525 |
|
| 2526 |
|
| 2527 |
|
| 2528 |
|
| 2529 |
|
| 2530 |
|
| 2531 |
|
| 2532 |
|
| 2533 |
|
| 2534 | <h4 class="name" id="deleteDeviceGroup"><span class="type-signature"></span>deleteDeviceGroup<span class="signature">(deviceGroup)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2535 |
|
| 2536 |
|
| 2537 |
|
| 2538 |
|
| 2539 |
|
| 2540 |
|
| 2541 | <div class="description">
|
| 2542 | <p>Deletes a device group</p>
|
| 2543 | </div>
|
| 2544 |
|
| 2545 |
|
| 2546 |
|
| 2547 |
|
| 2548 |
|
| 2549 |
|
| 2550 |
|
| 2551 |
|
| 2552 |
|
| 2553 | <h5>Parameters:</h5>
|
| 2554 |
|
| 2555 |
|
| 2556 | <table class="params">
|
| 2557 | <thead>
|
| 2558 | <tr>
|
| 2559 |
|
| 2560 | <th>Name</th>
|
| 2561 |
|
| 2562 |
|
| 2563 | <th>Type</th>
|
| 2564 |
|
| 2565 |
|
| 2566 |
|
| 2567 |
|
| 2568 |
|
| 2569 | <th class="last">Description</th>
|
| 2570 | </tr>
|
| 2571 | </thead>
|
| 2572 |
|
| 2573 | <tbody>
|
| 2574 |
|
| 2575 |
|
| 2576 | <tr>
|
| 2577 |
|
| 2578 | <td class="name"><code>deviceGroup</code></td>
|
| 2579 |
|
| 2580 |
|
| 2581 | <td class="type">
|
| 2582 |
|
| 2583 |
|
| 2584 | <span class="param-type">String</span>
|
| 2585 |
|
| 2586 |
|
| 2587 |
|
| 2588 | </td>
|
| 2589 |
|
| 2590 |
|
| 2591 |
|
| 2592 |
|
| 2593 |
|
| 2594 | <td class="description last"><p>Name of device group.</p></td>
|
| 2595 | </tr>
|
| 2596 |
|
| 2597 |
|
| 2598 | </tbody>
|
| 2599 | </table>
|
| 2600 |
|
| 2601 |
|
| 2602 |
|
| 2603 |
|
| 2604 |
|
| 2605 |
|
| 2606 | <dl class="details">
|
| 2607 |
|
| 2608 |
|
| 2609 |
|
| 2610 |
|
| 2611 |
|
| 2612 |
|
| 2613 |
|
| 2614 |
|
| 2615 |
|
| 2616 |
|
| 2617 |
|
| 2618 |
|
| 2619 |
|
| 2620 |
|
| 2621 |
|
| 2622 |
|
| 2623 |
|
| 2624 |
|
| 2625 |
|
| 2626 |
|
| 2627 |
|
| 2628 |
|
| 2629 |
|
| 2630 |
|
| 2631 |
|
| 2632 |
|
| 2633 |
|
| 2634 |
|
| 2635 |
|
| 2636 |
|
| 2637 |
|
| 2638 |
|
| 2639 | </dl>
|
| 2640 |
|
| 2641 |
|
| 2642 |
|
| 2643 |
|
| 2644 |
|
| 2645 |
|
| 2646 |
|
| 2647 |
|
| 2648 |
|
| 2649 |
|
| 2650 |
|
| 2651 |
|
| 2652 |
|
| 2653 | <h5>Returns:</h5>
|
| 2654 |
|
| 2655 |
|
| 2656 | <div class="param-desc">
|
| 2657 | <p>A promise which is resolved when the request is complete
|
| 2658 | or rejected if an error occurs.</p>
|
| 2659 | </div>
|
| 2660 |
|
| 2661 |
|
| 2662 |
|
| 2663 | <dl>
|
| 2664 | <dt>
|
| 2665 | Type
|
| 2666 | </dt>
|
| 2667 | <dd>
|
| 2668 |
|
| 2669 | <span class="param-type">Promise</span>
|
| 2670 |
|
| 2671 |
|
| 2672 | </dd>
|
| 2673 | </dl>
|
| 2674 |
|
| 2675 |
|
| 2676 |
|
| 2677 |
|
| 2678 |
|
| 2679 |
|
| 2680 |
|
| 2681 |
|
| 2682 |
|
| 2683 |
|
| 2684 |
|
| 2685 |
|
| 2686 |
|
| 2687 | <h4 class="name" id="getCmSyncStatus"><span class="type-signature"></span>getCmSyncStatus<span class="signature">()</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2688 |
|
| 2689 |
|
| 2690 |
|
| 2691 |
|
| 2692 |
|
| 2693 |
|
| 2694 | <div class="description">
|
| 2695 | <p>Gets cm sync status</p>
|
| 2696 | </div>
|
| 2697 |
|
| 2698 |
|
| 2699 |
|
| 2700 |
|
| 2701 |
|
| 2702 |
|
| 2703 |
|
| 2704 |
|
| 2705 |
|
| 2706 |
|
| 2707 |
|
| 2708 |
|
| 2709 |
|
| 2710 | <dl class="details">
|
| 2711 |
|
| 2712 |
|
| 2713 |
|
| 2714 |
|
| 2715 |
|
| 2716 |
|
| 2717 |
|
| 2718 |
|
| 2719 |
|
| 2720 |
|
| 2721 |
|
| 2722 |
|
| 2723 |
|
| 2724 |
|
| 2725 |
|
| 2726 |
|
| 2727 |
|
| 2728 |
|
| 2729 |
|
| 2730 |
|
| 2731 |
|
| 2732 |
|
| 2733 |
|
| 2734 |
|
| 2735 |
|
| 2736 |
|
| 2737 |
|
| 2738 |
|
| 2739 |
|
| 2740 |
|
| 2741 |
|
| 2742 |
|
| 2743 | </dl>
|
| 2744 |
|
| 2745 |
|
| 2746 |
|
| 2747 |
|
| 2748 |
|
| 2749 |
|
| 2750 |
|
| 2751 |
|
| 2752 |
|
| 2753 |
|
| 2754 |
|
| 2755 |
|
| 2756 |
|
| 2757 | <h5>Returns:</h5>
|
| 2758 |
|
| 2759 |
|
| 2760 | <div class="param-desc">
|
| 2761 | <p>Promise which is resolved with a list of connected and
|
| 2762 | disconnected host names</p>
|
| 2763 | </div>
|
| 2764 |
|
| 2765 |
|
| 2766 |
|
| 2767 | <dl>
|
| 2768 | <dt>
|
| 2769 | Type
|
| 2770 | </dt>
|
| 2771 | <dd>
|
| 2772 |
|
| 2773 | <span class="param-type">Promise</span>
|
| 2774 |
|
| 2775 |
|
| 2776 | </dd>
|
| 2777 | </dl>
|
| 2778 |
|
| 2779 |
|
| 2780 |
|
| 2781 |
|
| 2782 |
|
| 2783 |
|
| 2784 |
|
| 2785 |
|
| 2786 |
|
| 2787 |
|
| 2788 |
|
| 2789 |
|
| 2790 |
|
| 2791 | <h4 class="name" id="hasDeviceGroup"><span class="type-signature"></span>hasDeviceGroup<span class="signature">(deviceGroup, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 2792 |
|
| 2793 |
|
| 2794 |
|
| 2795 |
|
| 2796 |
|
| 2797 |
|
| 2798 | <div class="description">
|
| 2799 | <p>Checks for existence of a device group</p>
|
| 2800 | </div>
|
| 2801 |
|
| 2802 |
|
| 2803 |
|
| 2804 |
|
| 2805 |
|
| 2806 |
|
| 2807 |
|
| 2808 |
|
| 2809 |
|
| 2810 | <h5>Parameters:</h5>
|
| 2811 |
|
| 2812 |
|
| 2813 | <table class="params">
|
| 2814 | <thead>
|
| 2815 | <tr>
|
| 2816 |
|
| 2817 | <th>Name</th>
|
| 2818 |
|
| 2819 |
|
| 2820 | <th>Type</th>
|
| 2821 |
|
| 2822 |
|
| 2823 | <th>Attributes</th>
|
| 2824 |
|
| 2825 |
|
| 2826 |
|
| 2827 |
|
| 2828 | <th class="last">Description</th>
|
| 2829 | </tr>
|
| 2830 | </thead>
|
| 2831 |
|
| 2832 | <tbody>
|
| 2833 |
|
| 2834 |
|
| 2835 | <tr>
|
| 2836 |
|
| 2837 | <td class="name"><code>deviceGroup</code></td>
|
| 2838 |
|
| 2839 |
|
| 2840 | <td class="type">
|
| 2841 |
|
| 2842 |
|
| 2843 | <span class="param-type">String</span>
|
| 2844 |
|
| 2845 |
|
| 2846 |
|
| 2847 | </td>
|
| 2848 |
|
| 2849 |
|
| 2850 | <td class="attributes">
|
| 2851 |
|
| 2852 |
|
| 2853 |
|
| 2854 |
|
| 2855 |
|
| 2856 | </td>
|
| 2857 |
|
| 2858 |
|
| 2859 |
|
| 2860 |
|
| 2861 | <td class="description last"><p>Name for device group.</p></td>
|
| 2862 | </tr>
|
| 2863 |
|
| 2864 |
|
| 2865 |
|
| 2866 | <tr>
|
| 2867 |
|
| 2868 | <td class="name"><code>retryOptions</code></td>
|
| 2869 |
|
| 2870 |
|
| 2871 | <td class="type">
|
| 2872 |
|
| 2873 |
|
| 2874 | <span class="param-type">Object</span>
|
| 2875 |
|
| 2876 |
|
| 2877 |
|
| 2878 | </td>
|
| 2879 |
|
| 2880 |
|
| 2881 | <td class="attributes">
|
| 2882 |
|
| 2883 | <optional><br>
|
| 2884 |
|
| 2885 |
|
| 2886 |
|
| 2887 |
|
| 2888 |
|
| 2889 | </td>
|
| 2890 |
|
| 2891 |
|
| 2892 |
|
| 2893 |
|
| 2894 | <td class="description last"><p>Options for retrying the request.</p>
|
| 2895 | <h6>Properties</h6>
|
| 2896 |
|
| 2897 |
|
| 2898 | <table class="params">
|
| 2899 | <thead>
|
| 2900 | <tr>
|
| 2901 |
|
| 2902 | <th>Name</th>
|
| 2903 |
|
| 2904 |
|
| 2905 | <th>Type</th>
|
| 2906 |
|
| 2907 |
|
| 2908 | <th>Attributes</th>
|
| 2909 |
|
| 2910 |
|
| 2911 |
|
| 2912 |
|
| 2913 | <th class="last">Description</th>
|
| 2914 | </tr>
|
| 2915 | </thead>
|
| 2916 |
|
| 2917 | <tbody>
|
| 2918 |
|
| 2919 |
|
| 2920 | <tr>
|
| 2921 |
|
| 2922 | <td class="name"><code>maxRetries</code></td>
|
| 2923 |
|
| 2924 |
|
| 2925 | <td class="type">
|
| 2926 |
|
| 2927 |
|
| 2928 | <span class="param-type">Integer</span>
|
| 2929 |
|
| 2930 |
|
| 2931 |
|
| 2932 | </td>
|
| 2933 |
|
| 2934 |
|
| 2935 | <td class="attributes">
|
| 2936 |
|
| 2937 | <optional><br>
|
| 2938 |
|
| 2939 |
|
| 2940 |
|
| 2941 |
|
| 2942 |
|
| 2943 | </td>
|
| 2944 |
|
| 2945 |
|
| 2946 |
|
| 2947 |
|
| 2948 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 2949 | 0 to not retry. Default 60.</p></td>
|
| 2950 | </tr>
|
| 2951 |
|
| 2952 |
|
| 2953 |
|
| 2954 | <tr>
|
| 2955 |
|
| 2956 | <td class="name"><code>retryIntervalMs</code></td>
|
| 2957 |
|
| 2958 |
|
| 2959 | <td class="type">
|
| 2960 |
|
| 2961 |
|
| 2962 | <span class="param-type">Integer</span>
|
| 2963 |
|
| 2964 |
|
| 2965 |
|
| 2966 | </td>
|
| 2967 |
|
| 2968 |
|
| 2969 | <td class="attributes">
|
| 2970 |
|
| 2971 | <optional><br>
|
| 2972 |
|
| 2973 |
|
| 2974 |
|
| 2975 |
|
| 2976 |
|
| 2977 | </td>
|
| 2978 |
|
| 2979 |
|
| 2980 |
|
| 2981 |
|
| 2982 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 2983 | </tr>
|
| 2984 |
|
| 2985 |
|
| 2986 | </tbody>
|
| 2987 | </table>
|
| 2988 |
|
| 2989 | </td>
|
| 2990 | </tr>
|
| 2991 |
|
| 2992 |
|
| 2993 | </tbody>
|
| 2994 | </table>
|
| 2995 |
|
| 2996 |
|
| 2997 |
|
| 2998 |
|
| 2999 |
|
| 3000 |
|
| 3001 | <dl class="details">
|
| 3002 |
|
| 3003 |
|
| 3004 |
|
| 3005 |
|
| 3006 |
|
| 3007 |
|
| 3008 |
|
| 3009 |
|
| 3010 |
|
| 3011 |
|
| 3012 |
|
| 3013 |
|
| 3014 |
|
| 3015 |
|
| 3016 |
|
| 3017 |
|
| 3018 |
|
| 3019 |
|
| 3020 |
|
| 3021 |
|
| 3022 |
|
| 3023 |
|
| 3024 |
|
| 3025 |
|
| 3026 |
|
| 3027 |
|
| 3028 |
|
| 3029 |
|
| 3030 |
|
| 3031 |
|
| 3032 |
|
| 3033 |
|
| 3034 | </dl>
|
| 3035 |
|
| 3036 |
|
| 3037 |
|
| 3038 |
|
| 3039 |
|
| 3040 |
|
| 3041 |
|
| 3042 |
|
| 3043 |
|
| 3044 |
|
| 3045 |
|
| 3046 |
|
| 3047 |
|
| 3048 | <h5>Returns:</h5>
|
| 3049 |
|
| 3050 |
|
| 3051 | <div class="param-desc">
|
| 3052 | <p>A promise which is resolved with true/false based on device group existence
|
| 3053 | or rejected if an error occurs.</p>
|
| 3054 | </div>
|
| 3055 |
|
| 3056 |
|
| 3057 |
|
| 3058 | <dl>
|
| 3059 | <dt>
|
| 3060 | Type
|
| 3061 | </dt>
|
| 3062 | <dd>
|
| 3063 |
|
| 3064 | <span class="param-type">Promise</span>
|
| 3065 |
|
| 3066 |
|
| 3067 | </dd>
|
| 3068 | </dl>
|
| 3069 |
|
| 3070 |
|
| 3071 |
|
| 3072 |
|
| 3073 |
|
| 3074 |
|
| 3075 |
|
| 3076 |
|
| 3077 |
|
| 3078 |
|
| 3079 |
|
| 3080 |
|
| 3081 |
|
| 3082 | <h4 class="name" id="isInDeviceGroup"><span class="type-signature"></span>isInDeviceGroup<span class="signature">(deviceName, deviceGroup, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 3083 |
|
| 3084 |
|
| 3085 |
|
| 3086 |
|
| 3087 |
|
| 3088 |
|
| 3089 | <div class="description">
|
| 3090 | <p>Checks to see if a device is device group</p>
|
| 3091 | </div>
|
| 3092 |
|
| 3093 |
|
| 3094 |
|
| 3095 |
|
| 3096 |
|
| 3097 |
|
| 3098 |
|
| 3099 |
|
| 3100 |
|
| 3101 | <h5>Parameters:</h5>
|
| 3102 |
|
| 3103 |
|
| 3104 | <table class="params">
|
| 3105 | <thead>
|
| 3106 | <tr>
|
| 3107 |
|
| 3108 | <th>Name</th>
|
| 3109 |
|
| 3110 |
|
| 3111 | <th>Type</th>
|
| 3112 |
|
| 3113 |
|
| 3114 | <th>Attributes</th>
|
| 3115 |
|
| 3116 |
|
| 3117 |
|
| 3118 |
|
| 3119 | <th class="last">Description</th>
|
| 3120 | </tr>
|
| 3121 | </thead>
|
| 3122 |
|
| 3123 | <tbody>
|
| 3124 |
|
| 3125 |
|
| 3126 | <tr>
|
| 3127 |
|
| 3128 | <td class="name"><code>deviceName</code></td>
|
| 3129 |
|
| 3130 |
|
| 3131 | <td class="type">
|
| 3132 |
|
| 3133 |
|
| 3134 | <span class="param-type">String</span>
|
| 3135 |
|
| 3136 |
|
| 3137 |
|
| 3138 | </td>
|
| 3139 |
|
| 3140 |
|
| 3141 | <td class="attributes">
|
| 3142 |
|
| 3143 |
|
| 3144 |
|
| 3145 |
|
| 3146 |
|
| 3147 | </td>
|
| 3148 |
|
| 3149 |
|
| 3150 |
|
| 3151 |
|
| 3152 | <td class="description last"><p>Device name to check for.</p></td>
|
| 3153 | </tr>
|
| 3154 |
|
| 3155 |
|
| 3156 |
|
| 3157 | <tr>
|
| 3158 |
|
| 3159 | <td class="name"><code>deviceGroup</code></td>
|
| 3160 |
|
| 3161 |
|
| 3162 | <td class="type">
|
| 3163 |
|
| 3164 |
|
| 3165 | <span class="param-type">String</span>
|
| 3166 |
|
| 3167 |
|
| 3168 |
|
| 3169 | </td>
|
| 3170 |
|
| 3171 |
|
| 3172 | <td class="attributes">
|
| 3173 |
|
| 3174 |
|
| 3175 |
|
| 3176 |
|
| 3177 |
|
| 3178 | </td>
|
| 3179 |
|
| 3180 |
|
| 3181 |
|
| 3182 |
|
| 3183 | <td class="description last"><p>Device group to check in.</p></td>
|
| 3184 | </tr>
|
| 3185 |
|
| 3186 |
|
| 3187 |
|
| 3188 | <tr>
|
| 3189 |
|
| 3190 | <td class="name"><code>retryOptions</code></td>
|
| 3191 |
|
| 3192 |
|
| 3193 | <td class="type">
|
| 3194 |
|
| 3195 |
|
| 3196 | <span class="param-type">Object</span>
|
| 3197 |
|
| 3198 |
|
| 3199 |
|
| 3200 | </td>
|
| 3201 |
|
| 3202 |
|
| 3203 | <td class="attributes">
|
| 3204 |
|
| 3205 | <optional><br>
|
| 3206 |
|
| 3207 |
|
| 3208 |
|
| 3209 |
|
| 3210 |
|
| 3211 | </td>
|
| 3212 |
|
| 3213 |
|
| 3214 |
|
| 3215 |
|
| 3216 | <td class="description last"><p>Options for retrying the request.</p>
|
| 3217 | <h6>Properties</h6>
|
| 3218 |
|
| 3219 |
|
| 3220 | <table class="params">
|
| 3221 | <thead>
|
| 3222 | <tr>
|
| 3223 |
|
| 3224 | <th>Name</th>
|
| 3225 |
|
| 3226 |
|
| 3227 | <th>Type</th>
|
| 3228 |
|
| 3229 |
|
| 3230 | <th>Attributes</th>
|
| 3231 |
|
| 3232 |
|
| 3233 |
|
| 3234 |
|
| 3235 | <th class="last">Description</th>
|
| 3236 | </tr>
|
| 3237 | </thead>
|
| 3238 |
|
| 3239 | <tbody>
|
| 3240 |
|
| 3241 |
|
| 3242 | <tr>
|
| 3243 |
|
| 3244 | <td class="name"><code>maxRetries</code></td>
|
| 3245 |
|
| 3246 |
|
| 3247 | <td class="type">
|
| 3248 |
|
| 3249 |
|
| 3250 | <span class="param-type">Integer</span>
|
| 3251 |
|
| 3252 |
|
| 3253 |
|
| 3254 | </td>
|
| 3255 |
|
| 3256 |
|
| 3257 | <td class="attributes">
|
| 3258 |
|
| 3259 | <optional><br>
|
| 3260 |
|
| 3261 |
|
| 3262 |
|
| 3263 |
|
| 3264 |
|
| 3265 | </td>
|
| 3266 |
|
| 3267 |
|
| 3268 |
|
| 3269 |
|
| 3270 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 3271 | 0 to not retry. Default 60.</p></td>
|
| 3272 | </tr>
|
| 3273 |
|
| 3274 |
|
| 3275 |
|
| 3276 | <tr>
|
| 3277 |
|
| 3278 | <td class="name"><code>retryIntervalMs</code></td>
|
| 3279 |
|
| 3280 |
|
| 3281 | <td class="type">
|
| 3282 |
|
| 3283 |
|
| 3284 | <span class="param-type">Integer</span>
|
| 3285 |
|
| 3286 |
|
| 3287 |
|
| 3288 | </td>
|
| 3289 |
|
| 3290 |
|
| 3291 | <td class="attributes">
|
| 3292 |
|
| 3293 | <optional><br>
|
| 3294 |
|
| 3295 |
|
| 3296 |
|
| 3297 |
|
| 3298 |
|
| 3299 | </td>
|
| 3300 |
|
| 3301 |
|
| 3302 |
|
| 3303 |
|
| 3304 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 3305 | </tr>
|
| 3306 |
|
| 3307 |
|
| 3308 | </tbody>
|
| 3309 | </table>
|
| 3310 |
|
| 3311 | </td>
|
| 3312 | </tr>
|
| 3313 |
|
| 3314 |
|
| 3315 | </tbody>
|
| 3316 | </table>
|
| 3317 |
|
| 3318 |
|
| 3319 |
|
| 3320 |
|
| 3321 |
|
| 3322 |
|
| 3323 | <dl class="details">
|
| 3324 |
|
| 3325 |
|
| 3326 |
|
| 3327 |
|
| 3328 |
|
| 3329 |
|
| 3330 |
|
| 3331 |
|
| 3332 |
|
| 3333 |
|
| 3334 |
|
| 3335 |
|
| 3336 |
|
| 3337 |
|
| 3338 |
|
| 3339 |
|
| 3340 |
|
| 3341 |
|
| 3342 |
|
| 3343 |
|
| 3344 |
|
| 3345 |
|
| 3346 |
|
| 3347 |
|
| 3348 |
|
| 3349 |
|
| 3350 |
|
| 3351 |
|
| 3352 |
|
| 3353 |
|
| 3354 |
|
| 3355 |
|
| 3356 | </dl>
|
| 3357 |
|
| 3358 |
|
| 3359 |
|
| 3360 |
|
| 3361 |
|
| 3362 |
|
| 3363 |
|
| 3364 |
|
| 3365 |
|
| 3366 |
|
| 3367 |
|
| 3368 |
|
| 3369 |
|
| 3370 | <h5>Returns:</h5>
|
| 3371 |
|
| 3372 |
|
| 3373 | <div class="param-desc">
|
| 3374 | <p>A promise which is resolved with true or false
|
| 3375 | or rejected if an error occurs.</p>
|
| 3376 | </div>
|
| 3377 |
|
| 3378 |
|
| 3379 |
|
| 3380 | <dl>
|
| 3381 | <dt>
|
| 3382 | Type
|
| 3383 | </dt>
|
| 3384 | <dd>
|
| 3385 |
|
| 3386 | <span class="param-type">Promise</span>
|
| 3387 |
|
| 3388 |
|
| 3389 | </dd>
|
| 3390 | </dl>
|
| 3391 |
|
| 3392 |
|
| 3393 |
|
| 3394 |
|
| 3395 |
|
| 3396 |
|
| 3397 |
|
| 3398 |
|
| 3399 |
|
| 3400 |
|
| 3401 |
|
| 3402 |
|
| 3403 |
|
| 3404 | <h4 class="name" id="isInTrustGroup"><span class="type-signature"></span>isInTrustGroup<span class="signature">(deviceName, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 3405 |
|
| 3406 |
|
| 3407 |
|
| 3408 |
|
| 3409 |
|
| 3410 |
|
| 3411 | <div class="description">
|
| 3412 | <p>Checks to see if a device is in the trust group</p>
|
| 3413 | </div>
|
| 3414 |
|
| 3415 |
|
| 3416 |
|
| 3417 |
|
| 3418 |
|
| 3419 |
|
| 3420 |
|
| 3421 |
|
| 3422 |
|
| 3423 | <h5>Parameters:</h5>
|
| 3424 |
|
| 3425 |
|
| 3426 | <table class="params">
|
| 3427 | <thead>
|
| 3428 | <tr>
|
| 3429 |
|
| 3430 | <th>Name</th>
|
| 3431 |
|
| 3432 |
|
| 3433 | <th>Type</th>
|
| 3434 |
|
| 3435 |
|
| 3436 | <th>Attributes</th>
|
| 3437 |
|
| 3438 |
|
| 3439 |
|
| 3440 |
|
| 3441 | <th class="last">Description</th>
|
| 3442 | </tr>
|
| 3443 | </thead>
|
| 3444 |
|
| 3445 | <tbody>
|
| 3446 |
|
| 3447 |
|
| 3448 | <tr>
|
| 3449 |
|
| 3450 | <td class="name"><code>deviceName</code></td>
|
| 3451 |
|
| 3452 |
|
| 3453 | <td class="type">
|
| 3454 |
|
| 3455 |
|
| 3456 | <span class="param-type">String</span>
|
| 3457 |
|
| 3458 |
|
| 3459 |
|
| 3460 | </td>
|
| 3461 |
|
| 3462 |
|
| 3463 | <td class="attributes">
|
| 3464 |
|
| 3465 |
|
| 3466 |
|
| 3467 |
|
| 3468 |
|
| 3469 | </td>
|
| 3470 |
|
| 3471 |
|
| 3472 |
|
| 3473 |
|
| 3474 | <td class="description last"><p>Device name to check for.</p></td>
|
| 3475 | </tr>
|
| 3476 |
|
| 3477 |
|
| 3478 |
|
| 3479 | <tr>
|
| 3480 |
|
| 3481 | <td class="name"><code>retryOptions</code></td>
|
| 3482 |
|
| 3483 |
|
| 3484 | <td class="type">
|
| 3485 |
|
| 3486 |
|
| 3487 | <span class="param-type">Object</span>
|
| 3488 |
|
| 3489 |
|
| 3490 |
|
| 3491 | </td>
|
| 3492 |
|
| 3493 |
|
| 3494 | <td class="attributes">
|
| 3495 |
|
| 3496 | <optional><br>
|
| 3497 |
|
| 3498 |
|
| 3499 |
|
| 3500 |
|
| 3501 |
|
| 3502 | </td>
|
| 3503 |
|
| 3504 |
|
| 3505 |
|
| 3506 |
|
| 3507 | <td class="description last"><p>Options for retrying the request.</p>
|
| 3508 | <h6>Properties</h6>
|
| 3509 |
|
| 3510 |
|
| 3511 | <table class="params">
|
| 3512 | <thead>
|
| 3513 | <tr>
|
| 3514 |
|
| 3515 | <th>Name</th>
|
| 3516 |
|
| 3517 |
|
| 3518 | <th>Type</th>
|
| 3519 |
|
| 3520 |
|
| 3521 | <th>Attributes</th>
|
| 3522 |
|
| 3523 |
|
| 3524 |
|
| 3525 |
|
| 3526 | <th class="last">Description</th>
|
| 3527 | </tr>
|
| 3528 | </thead>
|
| 3529 |
|
| 3530 | <tbody>
|
| 3531 |
|
| 3532 |
|
| 3533 | <tr>
|
| 3534 |
|
| 3535 | <td class="name"><code>maxRetries</code></td>
|
| 3536 |
|
| 3537 |
|
| 3538 | <td class="type">
|
| 3539 |
|
| 3540 |
|
| 3541 | <span class="param-type">Integer</span>
|
| 3542 |
|
| 3543 |
|
| 3544 |
|
| 3545 | </td>
|
| 3546 |
|
| 3547 |
|
| 3548 | <td class="attributes">
|
| 3549 |
|
| 3550 | <optional><br>
|
| 3551 |
|
| 3552 |
|
| 3553 |
|
| 3554 |
|
| 3555 |
|
| 3556 | </td>
|
| 3557 |
|
| 3558 |
|
| 3559 |
|
| 3560 |
|
| 3561 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 3562 | 0 to not retry. Default 60.</p></td>
|
| 3563 | </tr>
|
| 3564 |
|
| 3565 |
|
| 3566 |
|
| 3567 | <tr>
|
| 3568 |
|
| 3569 | <td class="name"><code>retryIntervalMs</code></td>
|
| 3570 |
|
| 3571 |
|
| 3572 | <td class="type">
|
| 3573 |
|
| 3574 |
|
| 3575 | <span class="param-type">Integer</span>
|
| 3576 |
|
| 3577 |
|
| 3578 |
|
| 3579 | </td>
|
| 3580 |
|
| 3581 |
|
| 3582 | <td class="attributes">
|
| 3583 |
|
| 3584 | <optional><br>
|
| 3585 |
|
| 3586 |
|
| 3587 |
|
| 3588 |
|
| 3589 |
|
| 3590 | </td>
|
| 3591 |
|
| 3592 |
|
| 3593 |
|
| 3594 |
|
| 3595 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 3596 | </tr>
|
| 3597 |
|
| 3598 |
|
| 3599 | </tbody>
|
| 3600 | </table>
|
| 3601 |
|
| 3602 | </td>
|
| 3603 | </tr>
|
| 3604 |
|
| 3605 |
|
| 3606 | </tbody>
|
| 3607 | </table>
|
| 3608 |
|
| 3609 |
|
| 3610 |
|
| 3611 |
|
| 3612 |
|
| 3613 |
|
| 3614 | <dl class="details">
|
| 3615 |
|
| 3616 |
|
| 3617 |
|
| 3618 |
|
| 3619 |
|
| 3620 |
|
| 3621 |
|
| 3622 |
|
| 3623 |
|
| 3624 |
|
| 3625 |
|
| 3626 |
|
| 3627 |
|
| 3628 |
|
| 3629 |
|
| 3630 |
|
| 3631 |
|
| 3632 |
|
| 3633 |
|
| 3634 |
|
| 3635 |
|
| 3636 |
|
| 3637 |
|
| 3638 |
|
| 3639 |
|
| 3640 |
|
| 3641 |
|
| 3642 |
|
| 3643 |
|
| 3644 |
|
| 3645 |
|
| 3646 |
|
| 3647 | </dl>
|
| 3648 |
|
| 3649 |
|
| 3650 |
|
| 3651 |
|
| 3652 |
|
| 3653 |
|
| 3654 |
|
| 3655 |
|
| 3656 |
|
| 3657 |
|
| 3658 |
|
| 3659 |
|
| 3660 |
|
| 3661 | <h5>Returns:</h5>
|
| 3662 |
|
| 3663 |
|
| 3664 | <div class="param-desc">
|
| 3665 | <p>A promise which is resolved with true or false
|
| 3666 | or rejected if an error occurs.</p>
|
| 3667 | </div>
|
| 3668 |
|
| 3669 |
|
| 3670 |
|
| 3671 | <dl>
|
| 3672 | <dt>
|
| 3673 | Type
|
| 3674 | </dt>
|
| 3675 | <dd>
|
| 3676 |
|
| 3677 | <span class="param-type">Promise</span>
|
| 3678 |
|
| 3679 |
|
| 3680 | </dd>
|
| 3681 | </dl>
|
| 3682 |
|
| 3683 |
|
| 3684 |
|
| 3685 |
|
| 3686 |
|
| 3687 |
|
| 3688 |
|
| 3689 |
|
| 3690 |
|
| 3691 |
|
| 3692 |
|
| 3693 |
|
| 3694 |
|
| 3695 | <h4 class="name" id="joinCluster"><span class="type-signature"></span>joinCluster<span class="signature">(deviceGroup, remoteHost, remoteUser, remotePassword, isLocal, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 3696 |
|
| 3697 |
|
| 3698 |
|
| 3699 |
|
| 3700 |
|
| 3701 |
|
| 3702 | <div class="description">
|
| 3703 | <p>Joins a cluster and optionally syncs.</p>
|
| 3704 | <p>This is a just a higher level function that calls other funcitons in this
|
| 3705 | and other bigIp* files:</p>
|
| 3706 | <pre class="prettyprint source"><code>- Add to trust on remote host
|
| 3707 | - Add to remote device group
|
| 3708 | - Sync remote device group
|
| 3709 | - Check for datasync-global-dg and sync that as well if it is present
|
| 3710 | (this is necessary so that we know when syncing is complete)</code></pre><p>The device group must already exist on the remote host.</p>
|
| 3711 | </div>
|
| 3712 |
|
| 3713 |
|
| 3714 |
|
| 3715 |
|
| 3716 |
|
| 3717 |
|
| 3718 |
|
| 3719 |
|
| 3720 |
|
| 3721 | <h5>Parameters:</h5>
|
| 3722 |
|
| 3723 |
|
| 3724 | <table class="params">
|
| 3725 | <thead>
|
| 3726 | <tr>
|
| 3727 |
|
| 3728 | <th>Name</th>
|
| 3729 |
|
| 3730 |
|
| 3731 | <th>Type</th>
|
| 3732 |
|
| 3733 |
|
| 3734 | <th>Attributes</th>
|
| 3735 |
|
| 3736 |
|
| 3737 |
|
| 3738 |
|
| 3739 | <th class="last">Description</th>
|
| 3740 | </tr>
|
| 3741 | </thead>
|
| 3742 |
|
| 3743 | <tbody>
|
| 3744 |
|
| 3745 |
|
| 3746 | <tr>
|
| 3747 |
|
| 3748 | <td class="name"><code>deviceGroup</code></td>
|
| 3749 |
|
| 3750 |
|
| 3751 | <td class="type">
|
| 3752 |
|
| 3753 |
|
| 3754 | <span class="param-type">String</span>
|
| 3755 |
|
| 3756 |
|
| 3757 |
|
| 3758 | </td>
|
| 3759 |
|
| 3760 |
|
| 3761 | <td class="attributes">
|
| 3762 |
|
| 3763 |
|
| 3764 |
|
| 3765 |
|
| 3766 |
|
| 3767 | </td>
|
| 3768 |
|
| 3769 |
|
| 3770 |
|
| 3771 |
|
| 3772 | <td class="description last"><p>Name of device group to join.</p></td>
|
| 3773 | </tr>
|
| 3774 |
|
| 3775 |
|
| 3776 |
|
| 3777 | <tr>
|
| 3778 |
|
| 3779 | <td class="name"><code>remoteHost</code></td>
|
| 3780 |
|
| 3781 |
|
| 3782 | <td class="type">
|
| 3783 |
|
| 3784 |
|
| 3785 | <span class="param-type">String</span>
|
| 3786 |
|
| 3787 |
|
| 3788 |
|
| 3789 | </td>
|
| 3790 |
|
| 3791 |
|
| 3792 | <td class="attributes">
|
| 3793 |
|
| 3794 |
|
| 3795 |
|
| 3796 |
|
| 3797 |
|
| 3798 | </td>
|
| 3799 |
|
| 3800 |
|
| 3801 |
|
| 3802 |
|
| 3803 | <td class="description last"><p>Managemnt IP for the remote device.</p></td>
|
| 3804 | </tr>
|
| 3805 |
|
| 3806 |
|
| 3807 |
|
| 3808 | <tr>
|
| 3809 |
|
| 3810 | <td class="name"><code>remoteUser</code></td>
|
| 3811 |
|
| 3812 |
|
| 3813 | <td class="type">
|
| 3814 |
|
| 3815 |
|
| 3816 | <span class="param-type">String</span>
|
| 3817 |
|
| 3818 |
|
| 3819 |
|
| 3820 | </td>
|
| 3821 |
|
| 3822 |
|
| 3823 | <td class="attributes">
|
| 3824 |
|
| 3825 |
|
| 3826 |
|
| 3827 |
|
| 3828 |
|
| 3829 | </td>
|
| 3830 |
|
| 3831 |
|
| 3832 |
|
| 3833 |
|
| 3834 | <td class="description last"><p>Remote device admin user name.</p></td>
|
| 3835 | </tr>
|
| 3836 |
|
| 3837 |
|
| 3838 |
|
| 3839 | <tr>
|
| 3840 |
|
| 3841 | <td class="name"><code>remotePassword</code></td>
|
| 3842 |
|
| 3843 |
|
| 3844 | <td class="type">
|
| 3845 |
|
| 3846 |
|
| 3847 | <span class="param-type">String</span>
|
| 3848 |
|
| 3849 |
|
| 3850 |
|
| 3851 | </td>
|
| 3852 |
|
| 3853 |
|
| 3854 | <td class="attributes">
|
| 3855 |
|
| 3856 |
|
| 3857 |
|
| 3858 |
|
| 3859 |
|
| 3860 | </td>
|
| 3861 |
|
| 3862 |
|
| 3863 |
|
| 3864 |
|
| 3865 | <td class="description last"><p>Remote device admin user password.</p></td>
|
| 3866 | </tr>
|
| 3867 |
|
| 3868 |
|
| 3869 |
|
| 3870 | <tr>
|
| 3871 |
|
| 3872 | <td class="name"><code>isLocal</code></td>
|
| 3873 |
|
| 3874 |
|
| 3875 | <td class="type">
|
| 3876 |
|
| 3877 |
|
| 3878 | <span class="param-type">Boolean</span>
|
| 3879 |
|
| 3880 |
|
| 3881 |
|
| 3882 | </td>
|
| 3883 |
|
| 3884 |
|
| 3885 | <td class="attributes">
|
| 3886 |
|
| 3887 |
|
| 3888 |
|
| 3889 |
|
| 3890 |
|
| 3891 | </td>
|
| 3892 |
|
| 3893 |
|
| 3894 |
|
| 3895 |
|
| 3896 | <td class="description last"><p>Whether the device group is defined locally or if
|
| 3897 | we are joining one on a remote host.</p></td>
|
| 3898 | </tr>
|
| 3899 |
|
| 3900 |
|
| 3901 |
|
| 3902 | <tr>
|
| 3903 |
|
| 3904 | <td class="name"><code>options</code></td>
|
| 3905 |
|
| 3906 |
|
| 3907 | <td class="type">
|
| 3908 |
|
| 3909 |
|
| 3910 | <span class="param-type">Object</span>
|
| 3911 |
|
| 3912 |
|
| 3913 |
|
| 3914 | </td>
|
| 3915 |
|
| 3916 |
|
| 3917 | <td class="attributes">
|
| 3918 |
|
| 3919 | <optional><br>
|
| 3920 |
|
| 3921 |
|
| 3922 |
|
| 3923 |
|
| 3924 |
|
| 3925 | </td>
|
| 3926 |
|
| 3927 |
|
| 3928 |
|
| 3929 |
|
| 3930 | <td class="description last"><p>Optional arguments.</p>
|
| 3931 | <h6>Properties</h6>
|
| 3932 |
|
| 3933 |
|
| 3934 | <table class="params">
|
| 3935 | <thead>
|
| 3936 | <tr>
|
| 3937 |
|
| 3938 | <th>Name</th>
|
| 3939 |
|
| 3940 |
|
| 3941 | <th>Type</th>
|
| 3942 |
|
| 3943 |
|
| 3944 | <th>Attributes</th>
|
| 3945 |
|
| 3946 |
|
| 3947 |
|
| 3948 |
|
| 3949 | <th class="last">Description</th>
|
| 3950 | </tr>
|
| 3951 | </thead>
|
| 3952 |
|
| 3953 | <tbody>
|
| 3954 |
|
| 3955 |
|
| 3956 | <tr>
|
| 3957 |
|
| 3958 | <td class="name"><code>remotePort</code></td>
|
| 3959 |
|
| 3960 |
|
| 3961 | <td class="type">
|
| 3962 |
|
| 3963 |
|
| 3964 | <span class="param-type">Number</span>
|
| 3965 |
|
| 3966 |
|
| 3967 |
|
| 3968 | </td>
|
| 3969 |
|
| 3970 |
|
| 3971 | <td class="attributes">
|
| 3972 |
|
| 3973 | <optional><br>
|
| 3974 |
|
| 3975 |
|
| 3976 |
|
| 3977 |
|
| 3978 |
|
| 3979 | </td>
|
| 3980 |
|
| 3981 |
|
| 3982 |
|
| 3983 |
|
| 3984 | <td class="description last"><p>Remote device port to connect to. Default the
|
| 3985 | port of this device instance.</p></td>
|
| 3986 | </tr>
|
| 3987 |
|
| 3988 |
|
| 3989 |
|
| 3990 | <tr>
|
| 3991 |
|
| 3992 | <td class="name"><code>sync</code></td>
|
| 3993 |
|
| 3994 |
|
| 3995 | <td class="type">
|
| 3996 |
|
| 3997 |
|
| 3998 | <span class="param-type">Boolean</span>
|
| 3999 |
|
| 4000 |
|
| 4001 |
|
| 4002 | </td>
|
| 4003 |
|
| 4004 |
|
| 4005 | <td class="attributes">
|
| 4006 |
|
| 4007 | <optional><br>
|
| 4008 |
|
| 4009 |
|
| 4010 |
|
| 4011 |
|
| 4012 |
|
| 4013 | </td>
|
| 4014 |
|
| 4015 |
|
| 4016 |
|
| 4017 |
|
| 4018 | <td class="description last"><p>Whether or not to perform a sync. Default true.</p></td>
|
| 4019 | </tr>
|
| 4020 |
|
| 4021 |
|
| 4022 |
|
| 4023 | <tr>
|
| 4024 |
|
| 4025 | <td class="name"><code>syncDelay</code></td>
|
| 4026 |
|
| 4027 |
|
| 4028 | <td class="type">
|
| 4029 |
|
| 4030 |
|
| 4031 | <span class="param-type">Number</span>
|
| 4032 |
|
| 4033 |
|
| 4034 |
|
| 4035 | </td>
|
| 4036 |
|
| 4037 |
|
| 4038 | <td class="attributes">
|
| 4039 |
|
| 4040 | <optional><br>
|
| 4041 |
|
| 4042 |
|
| 4043 |
|
| 4044 |
|
| 4045 |
|
| 4046 | </td>
|
| 4047 |
|
| 4048 |
|
| 4049 |
|
| 4050 |
|
| 4051 | <td class="description last"><p>Delay in ms to wait after sending sync command
|
| 4052 | before proceeding. Default 30000.</p></td>
|
| 4053 | </tr>
|
| 4054 |
|
| 4055 |
|
| 4056 |
|
| 4057 | <tr>
|
| 4058 |
|
| 4059 | <td class="name"><code>syncCompDelay</code></td>
|
| 4060 |
|
| 4061 |
|
| 4062 | <td class="type">
|
| 4063 |
|
| 4064 |
|
| 4065 | <span class="param-type">Number</span>
|
| 4066 |
|
| 4067 |
|
| 4068 |
|
| 4069 | </td>
|
| 4070 |
|
| 4071 |
|
| 4072 | <td class="attributes">
|
| 4073 |
|
| 4074 | <optional><br>
|
| 4075 |
|
| 4076 |
|
| 4077 |
|
| 4078 |
|
| 4079 |
|
| 4080 | </td>
|
| 4081 |
|
| 4082 |
|
| 4083 |
|
| 4084 |
|
| 4085 | <td class="description last"><p>Delay in ms to wait between checking sync complete.
|
| 4086 | Default 10000.</p></td>
|
| 4087 | </tr>
|
| 4088 |
|
| 4089 |
|
| 4090 |
|
| 4091 | <tr>
|
| 4092 |
|
| 4093 | <td class="name"><code>syncCompDevices</code></td>
|
| 4094 |
|
| 4095 |
|
| 4096 | <td class="type">
|
| 4097 |
|
| 4098 |
|
| 4099 | <span class="param-type">Array.<String></span>
|
| 4100 |
|
| 4101 |
|
| 4102 |
|
| 4103 | </td>
|
| 4104 |
|
| 4105 |
|
| 4106 | <td class="attributes">
|
| 4107 |
|
| 4108 | <optional><br>
|
| 4109 |
|
| 4110 |
|
| 4111 |
|
| 4112 |
|
| 4113 |
|
| 4114 | </td>
|
| 4115 |
|
| 4116 |
|
| 4117 |
|
| 4118 |
|
| 4119 | <td class="description last"><p>List of device names that should be connected.
|
| 4120 | If defined, sync complete failures are ignored
|
| 4121 | when device trust can not sync due to disconnected
|
| 4122 | devices that are not in this list. Default is to
|
| 4123 | leave undefined and fail on all sync complete failures.</p></td>
|
| 4124 | </tr>
|
| 4125 |
|
| 4126 |
|
| 4127 |
|
| 4128 | <tr>
|
| 4129 |
|
| 4130 | <td class="name"><code>passwordIsUrl</code></td>
|
| 4131 |
|
| 4132 |
|
| 4133 | <td class="type">
|
| 4134 |
|
| 4135 |
|
| 4136 | <span class="param-type">Boolean</span>
|
| 4137 |
|
| 4138 |
|
| 4139 |
|
| 4140 | </td>
|
| 4141 |
|
| 4142 |
|
| 4143 | <td class="attributes">
|
| 4144 |
|
| 4145 | <optional><br>
|
| 4146 |
|
| 4147 |
|
| 4148 |
|
| 4149 |
|
| 4150 |
|
| 4151 | </td>
|
| 4152 |
|
| 4153 |
|
| 4154 |
|
| 4155 |
|
| 4156 | <td class="description last"><p>Indicates that password is a URL for the password.</p></td>
|
| 4157 | </tr>
|
| 4158 |
|
| 4159 |
|
| 4160 |
|
| 4161 | <tr>
|
| 4162 |
|
| 4163 | <td class="name"><code>passwordEncrypted</code></td>
|
| 4164 |
|
| 4165 |
|
| 4166 | <td class="type">
|
| 4167 |
|
| 4168 |
|
| 4169 | <span class="param-type">Boolean</span>
|
| 4170 |
|
| 4171 |
|
| 4172 |
|
| 4173 | </td>
|
| 4174 |
|
| 4175 |
|
| 4176 | <td class="attributes">
|
| 4177 |
|
| 4178 | <optional><br>
|
| 4179 |
|
| 4180 |
|
| 4181 |
|
| 4182 |
|
| 4183 |
|
| 4184 | </td>
|
| 4185 |
|
| 4186 |
|
| 4187 |
|
| 4188 |
|
| 4189 | <td class="description last"><p>Indicates that the password is encrypted (with the
|
| 4190 | local cloud public key)</p></td>
|
| 4191 | </tr>
|
| 4192 |
|
| 4193 |
|
| 4194 |
|
| 4195 | <tr>
|
| 4196 |
|
| 4197 | <td class="name"><code>remoteHostname</code></td>
|
| 4198 |
|
| 4199 |
|
| 4200 | <td class="type">
|
| 4201 |
|
| 4202 |
|
| 4203 | <span class="param-type">String</span>
|
| 4204 |
|
| 4205 |
|
| 4206 |
|
| 4207 | </td>
|
| 4208 |
|
| 4209 |
|
| 4210 | <td class="attributes">
|
| 4211 |
|
| 4212 | <optional><br>
|
| 4213 |
|
| 4214 |
|
| 4215 |
|
| 4216 |
|
| 4217 |
|
| 4218 | </td>
|
| 4219 |
|
| 4220 |
|
| 4221 |
|
| 4222 |
|
| 4223 | <td class="description last"><p>If adding to a local group (isLocal === true) the
|
| 4224 | cm hostname of the remote host.</p></td>
|
| 4225 | </tr>
|
| 4226 |
|
| 4227 |
|
| 4228 |
|
| 4229 | <tr>
|
| 4230 |
|
| 4231 | <td class="name"><code>noWait</code></td>
|
| 4232 |
|
| 4233 |
|
| 4234 | <td class="type">
|
| 4235 |
|
| 4236 |
|
| 4237 | <span class="param-type">Boolean</span>
|
| 4238 |
|
| 4239 |
|
| 4240 |
|
| 4241 | </td>
|
| 4242 |
|
| 4243 |
|
| 4244 | <td class="attributes">
|
| 4245 |
|
| 4246 | <optional><br>
|
| 4247 |
|
| 4248 |
|
| 4249 |
|
| 4250 |
|
| 4251 |
|
| 4252 | </td>
|
| 4253 |
|
| 4254 |
|
| 4255 |
|
| 4256 |
|
| 4257 | <td class="description last"><p>Don't wait for configSyncIp, just fail if it's not
|
| 4258 | ready right away. This is used for providers that have
|
| 4259 | messaging - they will try again periodically</p></td>
|
| 4260 | </tr>
|
| 4261 |
|
| 4262 |
|
| 4263 |
|
| 4264 | <tr>
|
| 4265 |
|
| 4266 | <td class="name"><code>product</code></td>
|
| 4267 |
|
| 4268 |
|
| 4269 | <td class="type">
|
| 4270 |
|
| 4271 |
|
| 4272 | <span class="param-type">String</span>
|
| 4273 |
|
| 4274 |
|
| 4275 |
|
| 4276 | </td>
|
| 4277 |
|
| 4278 |
|
| 4279 | <td class="attributes">
|
| 4280 |
|
| 4281 | <optional><br>
|
| 4282 |
|
| 4283 |
|
| 4284 |
|
| 4285 |
|
| 4286 |
|
| 4287 | </td>
|
| 4288 |
|
| 4289 |
|
| 4290 |
|
| 4291 |
|
| 4292 | <td class="description last"><p>The product we are running on (BIG-IP | BIG-IQ). Default
|
| 4293 | is to determine the product programmatically.</p></td>
|
| 4294 | </tr>
|
| 4295 |
|
| 4296 |
|
| 4297 | </tbody>
|
| 4298 | </table>
|
| 4299 |
|
| 4300 | </td>
|
| 4301 | </tr>
|
| 4302 |
|
| 4303 |
|
| 4304 | </tbody>
|
| 4305 | </table>
|
| 4306 |
|
| 4307 |
|
| 4308 |
|
| 4309 |
|
| 4310 |
|
| 4311 |
|
| 4312 | <dl class="details">
|
| 4313 |
|
| 4314 |
|
| 4315 |
|
| 4316 |
|
| 4317 |
|
| 4318 |
|
| 4319 |
|
| 4320 |
|
| 4321 |
|
| 4322 |
|
| 4323 |
|
| 4324 |
|
| 4325 |
|
| 4326 |
|
| 4327 |
|
| 4328 |
|
| 4329 |
|
| 4330 |
|
| 4331 |
|
| 4332 |
|
| 4333 |
|
| 4334 |
|
| 4335 |
|
| 4336 |
|
| 4337 |
|
| 4338 |
|
| 4339 |
|
| 4340 |
|
| 4341 |
|
| 4342 |
|
| 4343 |
|
| 4344 |
|
| 4345 | </dl>
|
| 4346 |
|
| 4347 |
|
| 4348 |
|
| 4349 |
|
| 4350 |
|
| 4351 |
|
| 4352 |
|
| 4353 |
|
| 4354 |
|
| 4355 |
|
| 4356 |
|
| 4357 |
|
| 4358 |
|
| 4359 | <h5>Returns:</h5>
|
| 4360 |
|
| 4361 |
|
| 4362 | <div class="param-desc">
|
| 4363 | <p>A promise which is resolved when the request is complete
|
| 4364 | or rejected if an error occurs. If promise is resolved, it is
|
| 4365 | is resolved with true if syncing occurred.</p>
|
| 4366 | </div>
|
| 4367 |
|
| 4368 |
|
| 4369 |
|
| 4370 | <dl>
|
| 4371 | <dt>
|
| 4372 | Type
|
| 4373 | </dt>
|
| 4374 | <dd>
|
| 4375 |
|
| 4376 | <span class="param-type">Promise</span>
|
| 4377 |
|
| 4378 |
|
| 4379 | </dd>
|
| 4380 | </dl>
|
| 4381 |
|
| 4382 |
|
| 4383 |
|
| 4384 |
|
| 4385 |
|
| 4386 |
|
| 4387 |
|
| 4388 |
|
| 4389 |
|
| 4390 |
|
| 4391 |
|
| 4392 |
|
| 4393 |
|
| 4394 | <h4 class="name" id="removeAllFromDeviceGroup"><span class="type-signature"></span>removeAllFromDeviceGroup<span class="signature">(deviceGroup, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 4395 |
|
| 4396 |
|
| 4397 |
|
| 4398 |
|
| 4399 |
|
| 4400 |
|
| 4401 | <div class="description">
|
| 4402 | <p>Removes all devices from a device group</p>
|
| 4403 | </div>
|
| 4404 |
|
| 4405 |
|
| 4406 |
|
| 4407 |
|
| 4408 |
|
| 4409 |
|
| 4410 |
|
| 4411 |
|
| 4412 |
|
| 4413 | <h5>Parameters:</h5>
|
| 4414 |
|
| 4415 |
|
| 4416 | <table class="params">
|
| 4417 | <thead>
|
| 4418 | <tr>
|
| 4419 |
|
| 4420 | <th>Name</th>
|
| 4421 |
|
| 4422 |
|
| 4423 | <th>Type</th>
|
| 4424 |
|
| 4425 |
|
| 4426 | <th>Attributes</th>
|
| 4427 |
|
| 4428 |
|
| 4429 |
|
| 4430 |
|
| 4431 | <th class="last">Description</th>
|
| 4432 | </tr>
|
| 4433 | </thead>
|
| 4434 |
|
| 4435 | <tbody>
|
| 4436 |
|
| 4437 |
|
| 4438 | <tr>
|
| 4439 |
|
| 4440 | <td class="name"><code>deviceGroup</code></td>
|
| 4441 |
|
| 4442 |
|
| 4443 | <td class="type">
|
| 4444 |
|
| 4445 |
|
| 4446 | <span class="param-type">String</span>
|
| 4447 |
|
| 4448 |
|
| 4449 |
|
| 4450 | </td>
|
| 4451 |
|
| 4452 |
|
| 4453 | <td class="attributes">
|
| 4454 |
|
| 4455 |
|
| 4456 |
|
| 4457 |
|
| 4458 |
|
| 4459 | </td>
|
| 4460 |
|
| 4461 |
|
| 4462 |
|
| 4463 |
|
| 4464 | <td class="description last"><p>Name of device group.</p></td>
|
| 4465 | </tr>
|
| 4466 |
|
| 4467 |
|
| 4468 |
|
| 4469 | <tr>
|
| 4470 |
|
| 4471 | <td class="name"><code>retryOptions</code></td>
|
| 4472 |
|
| 4473 |
|
| 4474 | <td class="type">
|
| 4475 |
|
| 4476 |
|
| 4477 | <span class="param-type">Object</span>
|
| 4478 |
|
| 4479 |
|
| 4480 |
|
| 4481 | </td>
|
| 4482 |
|
| 4483 |
|
| 4484 | <td class="attributes">
|
| 4485 |
|
| 4486 | <optional><br>
|
| 4487 |
|
| 4488 |
|
| 4489 |
|
| 4490 |
|
| 4491 |
|
| 4492 | </td>
|
| 4493 |
|
| 4494 |
|
| 4495 |
|
| 4496 |
|
| 4497 | <td class="description last"><p>Options for retrying the request.</p>
|
| 4498 | <h6>Properties</h6>
|
| 4499 |
|
| 4500 |
|
| 4501 | <table class="params">
|
| 4502 | <thead>
|
| 4503 | <tr>
|
| 4504 |
|
| 4505 | <th>Name</th>
|
| 4506 |
|
| 4507 |
|
| 4508 | <th>Type</th>
|
| 4509 |
|
| 4510 |
|
| 4511 | <th>Attributes</th>
|
| 4512 |
|
| 4513 |
|
| 4514 |
|
| 4515 |
|
| 4516 | <th class="last">Description</th>
|
| 4517 | </tr>
|
| 4518 | </thead>
|
| 4519 |
|
| 4520 | <tbody>
|
| 4521 |
|
| 4522 |
|
| 4523 | <tr>
|
| 4524 |
|
| 4525 | <td class="name"><code>maxRetries</code></td>
|
| 4526 |
|
| 4527 |
|
| 4528 | <td class="type">
|
| 4529 |
|
| 4530 |
|
| 4531 | <span class="param-type">Integer</span>
|
| 4532 |
|
| 4533 |
|
| 4534 |
|
| 4535 | </td>
|
| 4536 |
|
| 4537 |
|
| 4538 | <td class="attributes">
|
| 4539 |
|
| 4540 | <optional><br>
|
| 4541 |
|
| 4542 |
|
| 4543 |
|
| 4544 |
|
| 4545 |
|
| 4546 | </td>
|
| 4547 |
|
| 4548 |
|
| 4549 |
|
| 4550 |
|
| 4551 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 4552 | 0 to not retry. Default 60.</p></td>
|
| 4553 | </tr>
|
| 4554 |
|
| 4555 |
|
| 4556 |
|
| 4557 | <tr>
|
| 4558 |
|
| 4559 | <td class="name"><code>retryIntervalMs</code></td>
|
| 4560 |
|
| 4561 |
|
| 4562 | <td class="type">
|
| 4563 |
|
| 4564 |
|
| 4565 | <span class="param-type">Integer</span>
|
| 4566 |
|
| 4567 |
|
| 4568 |
|
| 4569 | </td>
|
| 4570 |
|
| 4571 |
|
| 4572 | <td class="attributes">
|
| 4573 |
|
| 4574 | <optional><br>
|
| 4575 |
|
| 4576 |
|
| 4577 |
|
| 4578 |
|
| 4579 |
|
| 4580 | </td>
|
| 4581 |
|
| 4582 |
|
| 4583 |
|
| 4584 |
|
| 4585 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 4586 | </tr>
|
| 4587 |
|
| 4588 |
|
| 4589 | </tbody>
|
| 4590 | </table>
|
| 4591 |
|
| 4592 | </td>
|
| 4593 | </tr>
|
| 4594 |
|
| 4595 |
|
| 4596 | </tbody>
|
| 4597 | </table>
|
| 4598 |
|
| 4599 |
|
| 4600 |
|
| 4601 |
|
| 4602 |
|
| 4603 |
|
| 4604 | <dl class="details">
|
| 4605 |
|
| 4606 |
|
| 4607 |
|
| 4608 |
|
| 4609 |
|
| 4610 |
|
| 4611 |
|
| 4612 |
|
| 4613 |
|
| 4614 |
|
| 4615 |
|
| 4616 |
|
| 4617 |
|
| 4618 |
|
| 4619 |
|
| 4620 |
|
| 4621 |
|
| 4622 |
|
| 4623 |
|
| 4624 |
|
| 4625 |
|
| 4626 |
|
| 4627 |
|
| 4628 |
|
| 4629 |
|
| 4630 |
|
| 4631 |
|
| 4632 |
|
| 4633 |
|
| 4634 |
|
| 4635 |
|
| 4636 |
|
| 4637 | </dl>
|
| 4638 |
|
| 4639 |
|
| 4640 |
|
| 4641 |
|
| 4642 |
|
| 4643 |
|
| 4644 |
|
| 4645 |
|
| 4646 |
|
| 4647 |
|
| 4648 |
|
| 4649 |
|
| 4650 |
|
| 4651 | <h5>Returns:</h5>
|
| 4652 |
|
| 4653 |
|
| 4654 | <div class="param-desc">
|
| 4655 | <p>A promise which is resolved when the request is complete
|
| 4656 | or rejected if an error occurs.</p>
|
| 4657 | </div>
|
| 4658 |
|
| 4659 |
|
| 4660 |
|
| 4661 | <dl>
|
| 4662 | <dt>
|
| 4663 | Type
|
| 4664 | </dt>
|
| 4665 | <dd>
|
| 4666 |
|
| 4667 | <span class="param-type">Promise</span>
|
| 4668 |
|
| 4669 |
|
| 4670 | </dd>
|
| 4671 | </dl>
|
| 4672 |
|
| 4673 |
|
| 4674 |
|
| 4675 |
|
| 4676 |
|
| 4677 |
|
| 4678 |
|
| 4679 |
|
| 4680 |
|
| 4681 |
|
| 4682 |
|
| 4683 |
|
| 4684 |
|
| 4685 | <h4 class="name" id="removeFromCluster"><span class="type-signature"></span>removeFromCluster<span class="signature">(deviceNames)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 4686 |
|
| 4687 |
|
| 4688 |
|
| 4689 |
|
| 4690 |
|
| 4691 |
|
| 4692 | <div class="description">
|
| 4693 | <p>Removes a device from cluster</p>
|
| 4694 | <p>This is a just a higher level function that calls other funcitons in this
|
| 4695 | and other bigIp* files:</p>
|
| 4696 | <pre class="prettyprint source"><code>- Remove from device group
|
| 4697 | - Remove from trust</code></pre>
|
| 4698 | </div>
|
| 4699 |
|
| 4700 |
|
| 4701 |
|
| 4702 |
|
| 4703 |
|
| 4704 |
|
| 4705 |
|
| 4706 |
|
| 4707 |
|
| 4708 | <h5>Parameters:</h5>
|
| 4709 |
|
| 4710 |
|
| 4711 | <table class="params">
|
| 4712 | <thead>
|
| 4713 | <tr>
|
| 4714 |
|
| 4715 | <th>Name</th>
|
| 4716 |
|
| 4717 |
|
| 4718 | <th>Type</th>
|
| 4719 |
|
| 4720 |
|
| 4721 |
|
| 4722 |
|
| 4723 |
|
| 4724 | <th class="last">Description</th>
|
| 4725 | </tr>
|
| 4726 | </thead>
|
| 4727 |
|
| 4728 | <tbody>
|
| 4729 |
|
| 4730 |
|
| 4731 | <tr>
|
| 4732 |
|
| 4733 | <td class="name"><code>deviceNames</code></td>
|
| 4734 |
|
| 4735 |
|
| 4736 | <td class="type">
|
| 4737 |
|
| 4738 |
|
| 4739 | <span class="param-type">String</span>
|
| 4740 | |
|
| 4741 |
|
| 4742 | <span class="param-type">Array.<String></span>
|
| 4743 |
|
| 4744 |
|
| 4745 |
|
| 4746 | </td>
|
| 4747 |
|
| 4748 |
|
| 4749 |
|
| 4750 |
|
| 4751 |
|
| 4752 | <td class="description last"><p>Name or array of names of devices to remove</p></td>
|
| 4753 | </tr>
|
| 4754 |
|
| 4755 |
|
| 4756 | </tbody>
|
| 4757 | </table>
|
| 4758 |
|
| 4759 |
|
| 4760 |
|
| 4761 |
|
| 4762 |
|
| 4763 |
|
| 4764 | <dl class="details">
|
| 4765 |
|
| 4766 |
|
| 4767 |
|
| 4768 |
|
| 4769 |
|
| 4770 |
|
| 4771 |
|
| 4772 |
|
| 4773 |
|
| 4774 |
|
| 4775 |
|
| 4776 |
|
| 4777 |
|
| 4778 |
|
| 4779 |
|
| 4780 |
|
| 4781 |
|
| 4782 |
|
| 4783 |
|
| 4784 |
|
| 4785 |
|
| 4786 |
|
| 4787 |
|
| 4788 |
|
| 4789 |
|
| 4790 |
|
| 4791 |
|
| 4792 |
|
| 4793 |
|
| 4794 |
|
| 4795 |
|
| 4796 |
|
| 4797 | </dl>
|
| 4798 |
|
| 4799 |
|
| 4800 |
|
| 4801 |
|
| 4802 |
|
| 4803 |
|
| 4804 |
|
| 4805 |
|
| 4806 |
|
| 4807 |
|
| 4808 |
|
| 4809 |
|
| 4810 |
|
| 4811 | <h5>Returns:</h5>
|
| 4812 |
|
| 4813 |
|
| 4814 | <div class="param-desc">
|
| 4815 | <p>A promise which is resolved when the request is complete
|
| 4816 | or rejected if an error occurs.</p>
|
| 4817 | </div>
|
| 4818 |
|
| 4819 |
|
| 4820 |
|
| 4821 | <dl>
|
| 4822 | <dt>
|
| 4823 | Type
|
| 4824 | </dt>
|
| 4825 | <dd>
|
| 4826 |
|
| 4827 | <span class="param-type">Promise</span>
|
| 4828 |
|
| 4829 |
|
| 4830 | </dd>
|
| 4831 | </dl>
|
| 4832 |
|
| 4833 |
|
| 4834 |
|
| 4835 |
|
| 4836 |
|
| 4837 |
|
| 4838 |
|
| 4839 |
|
| 4840 |
|
| 4841 |
|
| 4842 |
|
| 4843 |
|
| 4844 |
|
| 4845 | <h4 class="name" id="removeFromDeviceGroup"><span class="type-signature"></span>removeFromDeviceGroup<span class="signature">(deviceNames, deviceGroup, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 4846 |
|
| 4847 |
|
| 4848 |
|
| 4849 |
|
| 4850 |
|
| 4851 |
|
| 4852 | <div class="description">
|
| 4853 | <p>Removes a device from a device group</p>
|
| 4854 | </div>
|
| 4855 |
|
| 4856 |
|
| 4857 |
|
| 4858 |
|
| 4859 |
|
| 4860 |
|
| 4861 |
|
| 4862 |
|
| 4863 |
|
| 4864 | <h5>Parameters:</h5>
|
| 4865 |
|
| 4866 |
|
| 4867 | <table class="params">
|
| 4868 | <thead>
|
| 4869 | <tr>
|
| 4870 |
|
| 4871 | <th>Name</th>
|
| 4872 |
|
| 4873 |
|
| 4874 | <th>Type</th>
|
| 4875 |
|
| 4876 |
|
| 4877 | <th>Attributes</th>
|
| 4878 |
|
| 4879 |
|
| 4880 |
|
| 4881 |
|
| 4882 | <th class="last">Description</th>
|
| 4883 | </tr>
|
| 4884 | </thead>
|
| 4885 |
|
| 4886 | <tbody>
|
| 4887 |
|
| 4888 |
|
| 4889 | <tr>
|
| 4890 |
|
| 4891 | <td class="name"><code>deviceNames</code></td>
|
| 4892 |
|
| 4893 |
|
| 4894 | <td class="type">
|
| 4895 |
|
| 4896 |
|
| 4897 | <span class="param-type">String</span>
|
| 4898 | |
|
| 4899 |
|
| 4900 | <span class="param-type">Array.<String></span>
|
| 4901 |
|
| 4902 |
|
| 4903 |
|
| 4904 | </td>
|
| 4905 |
|
| 4906 |
|
| 4907 | <td class="attributes">
|
| 4908 |
|
| 4909 |
|
| 4910 |
|
| 4911 |
|
| 4912 |
|
| 4913 | </td>
|
| 4914 |
|
| 4915 |
|
| 4916 |
|
| 4917 |
|
| 4918 | <td class="description last"><p>Name or array of names of devices to remove.</p></td>
|
| 4919 | </tr>
|
| 4920 |
|
| 4921 |
|
| 4922 |
|
| 4923 | <tr>
|
| 4924 |
|
| 4925 | <td class="name"><code>deviceGroup</code></td>
|
| 4926 |
|
| 4927 |
|
| 4928 | <td class="type">
|
| 4929 |
|
| 4930 |
|
| 4931 | <span class="param-type">String</span>
|
| 4932 |
|
| 4933 |
|
| 4934 |
|
| 4935 | </td>
|
| 4936 |
|
| 4937 |
|
| 4938 | <td class="attributes">
|
| 4939 |
|
| 4940 |
|
| 4941 |
|
| 4942 |
|
| 4943 |
|
| 4944 | </td>
|
| 4945 |
|
| 4946 |
|
| 4947 |
|
| 4948 |
|
| 4949 | <td class="description last"><p>Name of device group.</p></td>
|
| 4950 | </tr>
|
| 4951 |
|
| 4952 |
|
| 4953 |
|
| 4954 | <tr>
|
| 4955 |
|
| 4956 | <td class="name"><code>retryOptions</code></td>
|
| 4957 |
|
| 4958 |
|
| 4959 | <td class="type">
|
| 4960 |
|
| 4961 |
|
| 4962 | <span class="param-type">Object</span>
|
| 4963 |
|
| 4964 |
|
| 4965 |
|
| 4966 | </td>
|
| 4967 |
|
| 4968 |
|
| 4969 | <td class="attributes">
|
| 4970 |
|
| 4971 | <optional><br>
|
| 4972 |
|
| 4973 |
|
| 4974 |
|
| 4975 |
|
| 4976 |
|
| 4977 | </td>
|
| 4978 |
|
| 4979 |
|
| 4980 |
|
| 4981 |
|
| 4982 | <td class="description last"><p>Options for retrying the request.</p>
|
| 4983 | <h6>Properties</h6>
|
| 4984 |
|
| 4985 |
|
| 4986 | <table class="params">
|
| 4987 | <thead>
|
| 4988 | <tr>
|
| 4989 |
|
| 4990 | <th>Name</th>
|
| 4991 |
|
| 4992 |
|
| 4993 | <th>Type</th>
|
| 4994 |
|
| 4995 |
|
| 4996 | <th>Attributes</th>
|
| 4997 |
|
| 4998 |
|
| 4999 |
|
| 5000 |
|
| 5001 | <th class="last">Description</th>
|
| 5002 | </tr>
|
| 5003 | </thead>
|
| 5004 |
|
| 5005 | <tbody>
|
| 5006 |
|
| 5007 |
|
| 5008 | <tr>
|
| 5009 |
|
| 5010 | <td class="name"><code>maxRetries</code></td>
|
| 5011 |
|
| 5012 |
|
| 5013 | <td class="type">
|
| 5014 |
|
| 5015 |
|
| 5016 | <span class="param-type">Integer</span>
|
| 5017 |
|
| 5018 |
|
| 5019 |
|
| 5020 | </td>
|
| 5021 |
|
| 5022 |
|
| 5023 | <td class="attributes">
|
| 5024 |
|
| 5025 | <optional><br>
|
| 5026 |
|
| 5027 |
|
| 5028 |
|
| 5029 |
|
| 5030 |
|
| 5031 | </td>
|
| 5032 |
|
| 5033 |
|
| 5034 |
|
| 5035 |
|
| 5036 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 5037 | 0 to not retry. Default 60.</p></td>
|
| 5038 | </tr>
|
| 5039 |
|
| 5040 |
|
| 5041 |
|
| 5042 | <tr>
|
| 5043 |
|
| 5044 | <td class="name"><code>retryIntervalMs</code></td>
|
| 5045 |
|
| 5046 |
|
| 5047 | <td class="type">
|
| 5048 |
|
| 5049 |
|
| 5050 | <span class="param-type">Integer</span>
|
| 5051 |
|
| 5052 |
|
| 5053 |
|
| 5054 | </td>
|
| 5055 |
|
| 5056 |
|
| 5057 | <td class="attributes">
|
| 5058 |
|
| 5059 | <optional><br>
|
| 5060 |
|
| 5061 |
|
| 5062 |
|
| 5063 |
|
| 5064 |
|
| 5065 | </td>
|
| 5066 |
|
| 5067 |
|
| 5068 |
|
| 5069 |
|
| 5070 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 5071 | </tr>
|
| 5072 |
|
| 5073 |
|
| 5074 | </tbody>
|
| 5075 | </table>
|
| 5076 |
|
| 5077 | </td>
|
| 5078 | </tr>
|
| 5079 |
|
| 5080 |
|
| 5081 | </tbody>
|
| 5082 | </table>
|
| 5083 |
|
| 5084 |
|
| 5085 |
|
| 5086 |
|
| 5087 |
|
| 5088 |
|
| 5089 | <dl class="details">
|
| 5090 |
|
| 5091 |
|
| 5092 |
|
| 5093 |
|
| 5094 |
|
| 5095 |
|
| 5096 |
|
| 5097 |
|
| 5098 |
|
| 5099 |
|
| 5100 |
|
| 5101 |
|
| 5102 |
|
| 5103 |
|
| 5104 |
|
| 5105 |
|
| 5106 |
|
| 5107 |
|
| 5108 |
|
| 5109 |
|
| 5110 |
|
| 5111 |
|
| 5112 |
|
| 5113 |
|
| 5114 |
|
| 5115 |
|
| 5116 |
|
| 5117 |
|
| 5118 |
|
| 5119 |
|
| 5120 |
|
| 5121 |
|
| 5122 | </dl>
|
| 5123 |
|
| 5124 |
|
| 5125 |
|
| 5126 |
|
| 5127 |
|
| 5128 |
|
| 5129 |
|
| 5130 |
|
| 5131 |
|
| 5132 |
|
| 5133 |
|
| 5134 |
|
| 5135 |
|
| 5136 | <h5>Returns:</h5>
|
| 5137 |
|
| 5138 |
|
| 5139 | <div class="param-desc">
|
| 5140 | <p>A promise which is resolved when the request is complete
|
| 5141 | or rejected if an error occurs.</p>
|
| 5142 | </div>
|
| 5143 |
|
| 5144 |
|
| 5145 |
|
| 5146 | <dl>
|
| 5147 | <dt>
|
| 5148 | Type
|
| 5149 | </dt>
|
| 5150 | <dd>
|
| 5151 |
|
| 5152 | <span class="param-type">Promise</span>
|
| 5153 |
|
| 5154 |
|
| 5155 | </dd>
|
| 5156 | </dl>
|
| 5157 |
|
| 5158 |
|
| 5159 |
|
| 5160 |
|
| 5161 |
|
| 5162 |
|
| 5163 |
|
| 5164 |
|
| 5165 |
|
| 5166 |
|
| 5167 |
|
| 5168 |
|
| 5169 |
|
| 5170 | <h4 class="name" id="removeFromTrust"><span class="type-signature"></span>removeFromTrust<span class="signature">(deviceNames, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 5171 |
|
| 5172 |
|
| 5173 |
|
| 5174 |
|
| 5175 |
|
| 5176 |
|
| 5177 | <div class="description">
|
| 5178 | <p>Removes a device from the device trust</p>
|
| 5179 | </div>
|
| 5180 |
|
| 5181 |
|
| 5182 |
|
| 5183 |
|
| 5184 |
|
| 5185 |
|
| 5186 |
|
| 5187 |
|
| 5188 |
|
| 5189 | <h5>Parameters:</h5>
|
| 5190 |
|
| 5191 |
|
| 5192 | <table class="params">
|
| 5193 | <thead>
|
| 5194 | <tr>
|
| 5195 |
|
| 5196 | <th>Name</th>
|
| 5197 |
|
| 5198 |
|
| 5199 | <th>Type</th>
|
| 5200 |
|
| 5201 |
|
| 5202 | <th>Attributes</th>
|
| 5203 |
|
| 5204 |
|
| 5205 |
|
| 5206 |
|
| 5207 | <th class="last">Description</th>
|
| 5208 | </tr>
|
| 5209 | </thead>
|
| 5210 |
|
| 5211 | <tbody>
|
| 5212 |
|
| 5213 |
|
| 5214 | <tr>
|
| 5215 |
|
| 5216 | <td class="name"><code>deviceNames</code></td>
|
| 5217 |
|
| 5218 |
|
| 5219 | <td class="type">
|
| 5220 |
|
| 5221 |
|
| 5222 | <span class="param-type">String</span>
|
| 5223 | |
|
| 5224 |
|
| 5225 | <span class="param-type">Array.<String></span>
|
| 5226 |
|
| 5227 |
|
| 5228 |
|
| 5229 | </td>
|
| 5230 |
|
| 5231 |
|
| 5232 | <td class="attributes">
|
| 5233 |
|
| 5234 |
|
| 5235 |
|
| 5236 |
|
| 5237 |
|
| 5238 | </td>
|
| 5239 |
|
| 5240 |
|
| 5241 |
|
| 5242 |
|
| 5243 | <td class="description last"><p>Name or array of names of devices to remove</p></td>
|
| 5244 | </tr>
|
| 5245 |
|
| 5246 |
|
| 5247 |
|
| 5248 | <tr>
|
| 5249 |
|
| 5250 | <td class="name"><code>retryOptions</code></td>
|
| 5251 |
|
| 5252 |
|
| 5253 | <td class="type">
|
| 5254 |
|
| 5255 |
|
| 5256 | <span class="param-type">Object</span>
|
| 5257 |
|
| 5258 |
|
| 5259 |
|
| 5260 | </td>
|
| 5261 |
|
| 5262 |
|
| 5263 | <td class="attributes">
|
| 5264 |
|
| 5265 | <optional><br>
|
| 5266 |
|
| 5267 |
|
| 5268 |
|
| 5269 |
|
| 5270 |
|
| 5271 | </td>
|
| 5272 |
|
| 5273 |
|
| 5274 |
|
| 5275 |
|
| 5276 | <td class="description last"><p>Options for retrying the request.</p>
|
| 5277 | <h6>Properties</h6>
|
| 5278 |
|
| 5279 |
|
| 5280 | <table class="params">
|
| 5281 | <thead>
|
| 5282 | <tr>
|
| 5283 |
|
| 5284 | <th>Name</th>
|
| 5285 |
|
| 5286 |
|
| 5287 | <th>Type</th>
|
| 5288 |
|
| 5289 |
|
| 5290 | <th>Attributes</th>
|
| 5291 |
|
| 5292 |
|
| 5293 |
|
| 5294 |
|
| 5295 | <th class="last">Description</th>
|
| 5296 | </tr>
|
| 5297 | </thead>
|
| 5298 |
|
| 5299 | <tbody>
|
| 5300 |
|
| 5301 |
|
| 5302 | <tr>
|
| 5303 |
|
| 5304 | <td class="name"><code>maxRetries</code></td>
|
| 5305 |
|
| 5306 |
|
| 5307 | <td class="type">
|
| 5308 |
|
| 5309 |
|
| 5310 | <span class="param-type">Integer</span>
|
| 5311 |
|
| 5312 |
|
| 5313 |
|
| 5314 | </td>
|
| 5315 |
|
| 5316 |
|
| 5317 | <td class="attributes">
|
| 5318 |
|
| 5319 | <optional><br>
|
| 5320 |
|
| 5321 |
|
| 5322 |
|
| 5323 |
|
| 5324 |
|
| 5325 | </td>
|
| 5326 |
|
| 5327 |
|
| 5328 |
|
| 5329 |
|
| 5330 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 5331 | 0 to not retry. Default 60.</p></td>
|
| 5332 | </tr>
|
| 5333 |
|
| 5334 |
|
| 5335 |
|
| 5336 | <tr>
|
| 5337 |
|
| 5338 | <td class="name"><code>retryIntervalMs</code></td>
|
| 5339 |
|
| 5340 |
|
| 5341 | <td class="type">
|
| 5342 |
|
| 5343 |
|
| 5344 | <span class="param-type">Integer</span>
|
| 5345 |
|
| 5346 |
|
| 5347 |
|
| 5348 | </td>
|
| 5349 |
|
| 5350 |
|
| 5351 | <td class="attributes">
|
| 5352 |
|
| 5353 | <optional><br>
|
| 5354 |
|
| 5355 |
|
| 5356 |
|
| 5357 |
|
| 5358 |
|
| 5359 | </td>
|
| 5360 |
|
| 5361 |
|
| 5362 |
|
| 5363 |
|
| 5364 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 5365 | </tr>
|
| 5366 |
|
| 5367 |
|
| 5368 | </tbody>
|
| 5369 | </table>
|
| 5370 |
|
| 5371 | </td>
|
| 5372 | </tr>
|
| 5373 |
|
| 5374 |
|
| 5375 | </tbody>
|
| 5376 | </table>
|
| 5377 |
|
| 5378 |
|
| 5379 |
|
| 5380 |
|
| 5381 |
|
| 5382 |
|
| 5383 | <dl class="details">
|
| 5384 |
|
| 5385 |
|
| 5386 |
|
| 5387 |
|
| 5388 |
|
| 5389 |
|
| 5390 |
|
| 5391 |
|
| 5392 |
|
| 5393 |
|
| 5394 |
|
| 5395 |
|
| 5396 |
|
| 5397 |
|
| 5398 |
|
| 5399 |
|
| 5400 |
|
| 5401 |
|
| 5402 |
|
| 5403 |
|
| 5404 |
|
| 5405 |
|
| 5406 |
|
| 5407 |
|
| 5408 |
|
| 5409 |
|
| 5410 |
|
| 5411 |
|
| 5412 |
|
| 5413 |
|
| 5414 |
|
| 5415 |
|
| 5416 | </dl>
|
| 5417 |
|
| 5418 |
|
| 5419 |
|
| 5420 |
|
| 5421 |
|
| 5422 |
|
| 5423 |
|
| 5424 |
|
| 5425 |
|
| 5426 |
|
| 5427 |
|
| 5428 |
|
| 5429 |
|
| 5430 | <h5>Returns:</h5>
|
| 5431 |
|
| 5432 |
|
| 5433 | <div class="param-desc">
|
| 5434 | <p>A promise which is resolved when the request is complete
|
| 5435 | or rejected if an error occurs.</p>
|
| 5436 | </div>
|
| 5437 |
|
| 5438 |
|
| 5439 |
|
| 5440 | <dl>
|
| 5441 | <dt>
|
| 5442 | Type
|
| 5443 | </dt>
|
| 5444 | <dd>
|
| 5445 |
|
| 5446 | <span class="param-type">Promise</span>
|
| 5447 |
|
| 5448 |
|
| 5449 | </dd>
|
| 5450 | </dl>
|
| 5451 |
|
| 5452 |
|
| 5453 |
|
| 5454 |
|
| 5455 |
|
| 5456 |
|
| 5457 |
|
| 5458 |
|
| 5459 |
|
| 5460 |
|
| 5461 |
|
| 5462 |
|
| 5463 |
|
| 5464 | <h4 class="name" id="resetTrust"><span class="type-signature"></span>resetTrust<span class="signature">(retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 5465 |
|
| 5466 |
|
| 5467 |
|
| 5468 |
|
| 5469 |
|
| 5470 |
|
| 5471 | <div class="description">
|
| 5472 | <p>Resets the device trust</p>
|
| 5473 | </div>
|
| 5474 |
|
| 5475 |
|
| 5476 |
|
| 5477 |
|
| 5478 |
|
| 5479 |
|
| 5480 |
|
| 5481 |
|
| 5482 |
|
| 5483 | <h5>Parameters:</h5>
|
| 5484 |
|
| 5485 |
|
| 5486 | <table class="params">
|
| 5487 | <thead>
|
| 5488 | <tr>
|
| 5489 |
|
| 5490 | <th>Name</th>
|
| 5491 |
|
| 5492 |
|
| 5493 | <th>Type</th>
|
| 5494 |
|
| 5495 |
|
| 5496 | <th>Attributes</th>
|
| 5497 |
|
| 5498 |
|
| 5499 |
|
| 5500 |
|
| 5501 | <th class="last">Description</th>
|
| 5502 | </tr>
|
| 5503 | </thead>
|
| 5504 |
|
| 5505 | <tbody>
|
| 5506 |
|
| 5507 |
|
| 5508 | <tr>
|
| 5509 |
|
| 5510 | <td class="name"><code>retryOptions</code></td>
|
| 5511 |
|
| 5512 |
|
| 5513 | <td class="type">
|
| 5514 |
|
| 5515 |
|
| 5516 | <span class="param-type">Object</span>
|
| 5517 |
|
| 5518 |
|
| 5519 |
|
| 5520 | </td>
|
| 5521 |
|
| 5522 |
|
| 5523 | <td class="attributes">
|
| 5524 |
|
| 5525 | <optional><br>
|
| 5526 |
|
| 5527 |
|
| 5528 |
|
| 5529 |
|
| 5530 |
|
| 5531 | </td>
|
| 5532 |
|
| 5533 |
|
| 5534 |
|
| 5535 |
|
| 5536 | <td class="description last"><p>Options for retrying the request.</p>
|
| 5537 | <h6>Properties</h6>
|
| 5538 |
|
| 5539 |
|
| 5540 | <table class="params">
|
| 5541 | <thead>
|
| 5542 | <tr>
|
| 5543 |
|
| 5544 | <th>Name</th>
|
| 5545 |
|
| 5546 |
|
| 5547 | <th>Type</th>
|
| 5548 |
|
| 5549 |
|
| 5550 | <th>Attributes</th>
|
| 5551 |
|
| 5552 |
|
| 5553 |
|
| 5554 |
|
| 5555 | <th class="last">Description</th>
|
| 5556 | </tr>
|
| 5557 | </thead>
|
| 5558 |
|
| 5559 | <tbody>
|
| 5560 |
|
| 5561 |
|
| 5562 | <tr>
|
| 5563 |
|
| 5564 | <td class="name"><code>maxRetries</code></td>
|
| 5565 |
|
| 5566 |
|
| 5567 | <td class="type">
|
| 5568 |
|
| 5569 |
|
| 5570 | <span class="param-type">Integer</span>
|
| 5571 |
|
| 5572 |
|
| 5573 |
|
| 5574 | </td>
|
| 5575 |
|
| 5576 |
|
| 5577 | <td class="attributes">
|
| 5578 |
|
| 5579 | <optional><br>
|
| 5580 |
|
| 5581 |
|
| 5582 |
|
| 5583 |
|
| 5584 |
|
| 5585 | </td>
|
| 5586 |
|
| 5587 |
|
| 5588 |
|
| 5589 |
|
| 5590 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 5591 | 0 to not retry. Default 60.</p></td>
|
| 5592 | </tr>
|
| 5593 |
|
| 5594 |
|
| 5595 |
|
| 5596 | <tr>
|
| 5597 |
|
| 5598 | <td class="name"><code>retryIntervalMs</code></td>
|
| 5599 |
|
| 5600 |
|
| 5601 | <td class="type">
|
| 5602 |
|
| 5603 |
|
| 5604 | <span class="param-type">Integer</span>
|
| 5605 |
|
| 5606 |
|
| 5607 |
|
| 5608 | </td>
|
| 5609 |
|
| 5610 |
|
| 5611 | <td class="attributes">
|
| 5612 |
|
| 5613 | <optional><br>
|
| 5614 |
|
| 5615 |
|
| 5616 |
|
| 5617 |
|
| 5618 |
|
| 5619 | </td>
|
| 5620 |
|
| 5621 |
|
| 5622 |
|
| 5623 |
|
| 5624 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 5625 | </tr>
|
| 5626 |
|
| 5627 |
|
| 5628 | </tbody>
|
| 5629 | </table>
|
| 5630 |
|
| 5631 | </td>
|
| 5632 | </tr>
|
| 5633 |
|
| 5634 |
|
| 5635 | </tbody>
|
| 5636 | </table>
|
| 5637 |
|
| 5638 |
|
| 5639 |
|
| 5640 |
|
| 5641 |
|
| 5642 |
|
| 5643 | <dl class="details">
|
| 5644 |
|
| 5645 |
|
| 5646 |
|
| 5647 |
|
| 5648 |
|
| 5649 |
|
| 5650 |
|
| 5651 |
|
| 5652 |
|
| 5653 |
|
| 5654 |
|
| 5655 |
|
| 5656 |
|
| 5657 |
|
| 5658 |
|
| 5659 |
|
| 5660 |
|
| 5661 |
|
| 5662 |
|
| 5663 |
|
| 5664 |
|
| 5665 |
|
| 5666 |
|
| 5667 |
|
| 5668 |
|
| 5669 |
|
| 5670 |
|
| 5671 |
|
| 5672 |
|
| 5673 |
|
| 5674 |
|
| 5675 |
|
| 5676 | </dl>
|
| 5677 |
|
| 5678 |
|
| 5679 |
|
| 5680 |
|
| 5681 |
|
| 5682 |
|
| 5683 |
|
| 5684 |
|
| 5685 |
|
| 5686 |
|
| 5687 |
|
| 5688 |
|
| 5689 |
|
| 5690 | <h5>Returns:</h5>
|
| 5691 |
|
| 5692 |
|
| 5693 | <div class="param-desc">
|
| 5694 | <p>A promise which is resolved when the request is complete
|
| 5695 | or rejected if an error occurs.</p>
|
| 5696 | </div>
|
| 5697 |
|
| 5698 |
|
| 5699 |
|
| 5700 | <dl>
|
| 5701 | <dt>
|
| 5702 | Type
|
| 5703 | </dt>
|
| 5704 | <dd>
|
| 5705 |
|
| 5706 | <span class="param-type">Promise</span>
|
| 5707 |
|
| 5708 |
|
| 5709 | </dd>
|
| 5710 | </dl>
|
| 5711 |
|
| 5712 |
|
| 5713 |
|
| 5714 |
|
| 5715 |
|
| 5716 |
|
| 5717 |
|
| 5718 |
|
| 5719 |
|
| 5720 |
|
| 5721 |
|
| 5722 |
|
| 5723 |
|
| 5724 | <h4 class="name" id="sync"><span class="type-signature"></span>sync<span class="signature">(direction, deviceGroup, forceFullLoadPush<span class="signature-attributes">opt</span>, retryOptions<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 5725 |
|
| 5726 |
|
| 5727 |
|
| 5728 |
|
| 5729 |
|
| 5730 |
|
| 5731 | <div class="description">
|
| 5732 | <p>Syncs to/from device group</p>
|
| 5733 | </div>
|
| 5734 |
|
| 5735 |
|
| 5736 |
|
| 5737 |
|
| 5738 |
|
| 5739 |
|
| 5740 |
|
| 5741 |
|
| 5742 |
|
| 5743 | <h5>Parameters:</h5>
|
| 5744 |
|
| 5745 |
|
| 5746 | <table class="params">
|
| 5747 | <thead>
|
| 5748 | <tr>
|
| 5749 |
|
| 5750 | <th>Name</th>
|
| 5751 |
|
| 5752 |
|
| 5753 | <th>Type</th>
|
| 5754 |
|
| 5755 |
|
| 5756 | <th>Attributes</th>
|
| 5757 |
|
| 5758 |
|
| 5759 |
|
| 5760 |
|
| 5761 | <th class="last">Description</th>
|
| 5762 | </tr>
|
| 5763 | </thead>
|
| 5764 |
|
| 5765 | <tbody>
|
| 5766 |
|
| 5767 |
|
| 5768 | <tr>
|
| 5769 |
|
| 5770 | <td class="name"><code>direction</code></td>
|
| 5771 |
|
| 5772 |
|
| 5773 | <td class="type">
|
| 5774 |
|
| 5775 |
|
| 5776 | <span class="param-type">String</span>
|
| 5777 |
|
| 5778 |
|
| 5779 |
|
| 5780 | </td>
|
| 5781 |
|
| 5782 |
|
| 5783 | <td class="attributes">
|
| 5784 |
|
| 5785 |
|
| 5786 |
|
| 5787 |
|
| 5788 |
|
| 5789 | </td>
|
| 5790 |
|
| 5791 |
|
| 5792 |
|
| 5793 |
|
| 5794 | <td class="description last"><p>'to-group' || 'from-group'</p></td>
|
| 5795 | </tr>
|
| 5796 |
|
| 5797 |
|
| 5798 |
|
| 5799 | <tr>
|
| 5800 |
|
| 5801 | <td class="name"><code>deviceGroup</code></td>
|
| 5802 |
|
| 5803 |
|
| 5804 | <td class="type">
|
| 5805 |
|
| 5806 |
|
| 5807 | <span class="param-type">String</span>
|
| 5808 |
|
| 5809 |
|
| 5810 |
|
| 5811 | </td>
|
| 5812 |
|
| 5813 |
|
| 5814 | <td class="attributes">
|
| 5815 |
|
| 5816 |
|
| 5817 |
|
| 5818 |
|
| 5819 |
|
| 5820 | </td>
|
| 5821 |
|
| 5822 |
|
| 5823 |
|
| 5824 |
|
| 5825 | <td class="description last"><p>Name of the device group to sync.</p></td>
|
| 5826 | </tr>
|
| 5827 |
|
| 5828 |
|
| 5829 |
|
| 5830 | <tr>
|
| 5831 |
|
| 5832 | <td class="name"><code>forceFullLoadPush</code></td>
|
| 5833 |
|
| 5834 |
|
| 5835 | <td class="type">
|
| 5836 |
|
| 5837 |
|
| 5838 | <span class="param-type">Boolean</span>
|
| 5839 |
|
| 5840 |
|
| 5841 |
|
| 5842 | </td>
|
| 5843 |
|
| 5844 |
|
| 5845 | <td class="attributes">
|
| 5846 |
|
| 5847 | <optional><br>
|
| 5848 |
|
| 5849 |
|
| 5850 |
|
| 5851 |
|
| 5852 |
|
| 5853 | </td>
|
| 5854 |
|
| 5855 |
|
| 5856 |
|
| 5857 |
|
| 5858 | <td class="description last"><p>Whether or not to use the force-full-load-push option.
|
| 5859 | Default false.</p></td>
|
| 5860 | </tr>
|
| 5861 |
|
| 5862 |
|
| 5863 |
|
| 5864 | <tr>
|
| 5865 |
|
| 5866 | <td class="name"><code>retryOptions</code></td>
|
| 5867 |
|
| 5868 |
|
| 5869 | <td class="type">
|
| 5870 |
|
| 5871 |
|
| 5872 | <span class="param-type">Object</span>
|
| 5873 |
|
| 5874 |
|
| 5875 |
|
| 5876 | </td>
|
| 5877 |
|
| 5878 |
|
| 5879 | <td class="attributes">
|
| 5880 |
|
| 5881 | <optional><br>
|
| 5882 |
|
| 5883 |
|
| 5884 |
|
| 5885 |
|
| 5886 |
|
| 5887 | </td>
|
| 5888 |
|
| 5889 |
|
| 5890 |
|
| 5891 |
|
| 5892 | <td class="description last"><p>Options for retrying the request.</p>
|
| 5893 | <h6>Properties</h6>
|
| 5894 |
|
| 5895 |
|
| 5896 | <table class="params">
|
| 5897 | <thead>
|
| 5898 | <tr>
|
| 5899 |
|
| 5900 | <th>Name</th>
|
| 5901 |
|
| 5902 |
|
| 5903 | <th>Type</th>
|
| 5904 |
|
| 5905 |
|
| 5906 | <th>Attributes</th>
|
| 5907 |
|
| 5908 |
|
| 5909 |
|
| 5910 |
|
| 5911 | <th class="last">Description</th>
|
| 5912 | </tr>
|
| 5913 | </thead>
|
| 5914 |
|
| 5915 | <tbody>
|
| 5916 |
|
| 5917 |
|
| 5918 | <tr>
|
| 5919 |
|
| 5920 | <td class="name"><code>maxRetries</code></td>
|
| 5921 |
|
| 5922 |
|
| 5923 | <td class="type">
|
| 5924 |
|
| 5925 |
|
| 5926 | <span class="param-type">Integer</span>
|
| 5927 |
|
| 5928 |
|
| 5929 |
|
| 5930 | </td>
|
| 5931 |
|
| 5932 |
|
| 5933 | <td class="attributes">
|
| 5934 |
|
| 5935 | <optional><br>
|
| 5936 |
|
| 5937 |
|
| 5938 |
|
| 5939 |
|
| 5940 |
|
| 5941 | </td>
|
| 5942 |
|
| 5943 |
|
| 5944 |
|
| 5945 |
|
| 5946 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 5947 | 0 to not retry. Default 60.</p></td>
|
| 5948 | </tr>
|
| 5949 |
|
| 5950 |
|
| 5951 |
|
| 5952 | <tr>
|
| 5953 |
|
| 5954 | <td class="name"><code>retryIntervalMs</code></td>
|
| 5955 |
|
| 5956 |
|
| 5957 | <td class="type">
|
| 5958 |
|
| 5959 |
|
| 5960 | <span class="param-type">Integer</span>
|
| 5961 |
|
| 5962 |
|
| 5963 |
|
| 5964 | </td>
|
| 5965 |
|
| 5966 |
|
| 5967 | <td class="attributes">
|
| 5968 |
|
| 5969 | <optional><br>
|
| 5970 |
|
| 5971 |
|
| 5972 |
|
| 5973 |
|
| 5974 |
|
| 5975 | </td>
|
| 5976 |
|
| 5977 |
|
| 5978 |
|
| 5979 |
|
| 5980 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 5981 | </tr>
|
| 5982 |
|
| 5983 |
|
| 5984 | </tbody>
|
| 5985 | </table>
|
| 5986 |
|
| 5987 | </td>
|
| 5988 | </tr>
|
| 5989 |
|
| 5990 |
|
| 5991 | </tbody>
|
| 5992 | </table>
|
| 5993 |
|
| 5994 |
|
| 5995 |
|
| 5996 |
|
| 5997 |
|
| 5998 |
|
| 5999 | <dl class="details">
|
| 6000 |
|
| 6001 |
|
| 6002 |
|
| 6003 |
|
| 6004 |
|
| 6005 |
|
| 6006 |
|
| 6007 |
|
| 6008 |
|
| 6009 |
|
| 6010 |
|
| 6011 |
|
| 6012 |
|
| 6013 |
|
| 6014 |
|
| 6015 |
|
| 6016 |
|
| 6017 |
|
| 6018 |
|
| 6019 |
|
| 6020 |
|
| 6021 |
|
| 6022 |
|
| 6023 |
|
| 6024 |
|
| 6025 |
|
| 6026 |
|
| 6027 |
|
| 6028 |
|
| 6029 |
|
| 6030 |
|
| 6031 |
|
| 6032 | </dl>
|
| 6033 |
|
| 6034 |
|
| 6035 |
|
| 6036 |
|
| 6037 |
|
| 6038 |
|
| 6039 |
|
| 6040 |
|
| 6041 |
|
| 6042 |
|
| 6043 |
|
| 6044 |
|
| 6045 |
|
| 6046 | <h5>Returns:</h5>
|
| 6047 |
|
| 6048 |
|
| 6049 | <div class="param-desc">
|
| 6050 | <p>A promise which is resolved when the request is complete
|
| 6051 | or rejected if an error occurs.</p>
|
| 6052 | </div>
|
| 6053 |
|
| 6054 |
|
| 6055 |
|
| 6056 | <dl>
|
| 6057 | <dt>
|
| 6058 | Type
|
| 6059 | </dt>
|
| 6060 | <dd>
|
| 6061 |
|
| 6062 | <span class="param-type">Promise</span>
|
| 6063 |
|
| 6064 |
|
| 6065 | </dd>
|
| 6066 | </dl>
|
| 6067 |
|
| 6068 |
|
| 6069 |
|
| 6070 |
|
| 6071 |
|
| 6072 |
|
| 6073 |
|
| 6074 |
|
| 6075 |
|
| 6076 |
|
| 6077 |
|
| 6078 |
|
| 6079 |
|
| 6080 | <h4 class="name" id="syncComplete"><span class="type-signature"></span>syncComplete<span class="signature">(retryOptions<span class="signature-attributes">opt</span>, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise}</span></h4>
|
| 6081 |
|
| 6082 |
|
| 6083 |
|
| 6084 |
|
| 6085 |
|
| 6086 |
|
| 6087 | <div class="description">
|
| 6088 | <p>Checks sync status to see if it is complete</p>
|
| 6089 | </div>
|
| 6090 |
|
| 6091 |
|
| 6092 |
|
| 6093 |
|
| 6094 |
|
| 6095 |
|
| 6096 |
|
| 6097 |
|
| 6098 |
|
| 6099 | <h5>Parameters:</h5>
|
| 6100 |
|
| 6101 |
|
| 6102 | <table class="params">
|
| 6103 | <thead>
|
| 6104 | <tr>
|
| 6105 |
|
| 6106 | <th>Name</th>
|
| 6107 |
|
| 6108 |
|
| 6109 | <th>Type</th>
|
| 6110 |
|
| 6111 |
|
| 6112 | <th>Attributes</th>
|
| 6113 |
|
| 6114 |
|
| 6115 |
|
| 6116 |
|
| 6117 | <th class="last">Description</th>
|
| 6118 | </tr>
|
| 6119 | </thead>
|
| 6120 |
|
| 6121 | <tbody>
|
| 6122 |
|
| 6123 |
|
| 6124 | <tr>
|
| 6125 |
|
| 6126 | <td class="name"><code>retryOptions</code></td>
|
| 6127 |
|
| 6128 |
|
| 6129 | <td class="type">
|
| 6130 |
|
| 6131 |
|
| 6132 | <span class="param-type">Object</span>
|
| 6133 |
|
| 6134 |
|
| 6135 |
|
| 6136 | </td>
|
| 6137 |
|
| 6138 |
|
| 6139 | <td class="attributes">
|
| 6140 |
|
| 6141 | <optional><br>
|
| 6142 |
|
| 6143 |
|
| 6144 |
|
| 6145 |
|
| 6146 |
|
| 6147 | </td>
|
| 6148 |
|
| 6149 |
|
| 6150 |
|
| 6151 |
|
| 6152 | <td class="description last"><p>Options for retrying the request.</p>
|
| 6153 | <h6>Properties</h6>
|
| 6154 |
|
| 6155 |
|
| 6156 | <table class="params">
|
| 6157 | <thead>
|
| 6158 | <tr>
|
| 6159 |
|
| 6160 | <th>Name</th>
|
| 6161 |
|
| 6162 |
|
| 6163 | <th>Type</th>
|
| 6164 |
|
| 6165 |
|
| 6166 | <th>Attributes</th>
|
| 6167 |
|
| 6168 |
|
| 6169 |
|
| 6170 |
|
| 6171 | <th class="last">Description</th>
|
| 6172 | </tr>
|
| 6173 | </thead>
|
| 6174 |
|
| 6175 | <tbody>
|
| 6176 |
|
| 6177 |
|
| 6178 | <tr>
|
| 6179 |
|
| 6180 | <td class="name"><code>maxRetries</code></td>
|
| 6181 |
|
| 6182 |
|
| 6183 | <td class="type">
|
| 6184 |
|
| 6185 |
|
| 6186 | <span class="param-type">Integer</span>
|
| 6187 |
|
| 6188 |
|
| 6189 |
|
| 6190 | </td>
|
| 6191 |
|
| 6192 |
|
| 6193 | <td class="attributes">
|
| 6194 |
|
| 6195 | <optional><br>
|
| 6196 |
|
| 6197 |
|
| 6198 |
|
| 6199 |
|
| 6200 |
|
| 6201 | </td>
|
| 6202 |
|
| 6203 |
|
| 6204 |
|
| 6205 |
|
| 6206 | <td class="description last"><p>Number of times to retry if first try fails.
|
| 6207 | 0 to not retry. Default 60.</p></td>
|
| 6208 | </tr>
|
| 6209 |
|
| 6210 |
|
| 6211 |
|
| 6212 | <tr>
|
| 6213 |
|
| 6214 | <td class="name"><code>retryIntervalMs</code></td>
|
| 6215 |
|
| 6216 |
|
| 6217 | <td class="type">
|
| 6218 |
|
| 6219 |
|
| 6220 | <span class="param-type">Integer</span>
|
| 6221 |
|
| 6222 |
|
| 6223 |
|
| 6224 | </td>
|
| 6225 |
|
| 6226 |
|
| 6227 | <td class="attributes">
|
| 6228 |
|
| 6229 | <optional><br>
|
| 6230 |
|
| 6231 |
|
| 6232 |
|
| 6233 |
|
| 6234 |
|
| 6235 | </td>
|
| 6236 |
|
| 6237 |
|
| 6238 |
|
| 6239 |
|
| 6240 | <td class="description last"><p>Milliseconds between retries. Default 10000.</p></td>
|
| 6241 | </tr>
|
| 6242 |
|
| 6243 |
|
| 6244 | </tbody>
|
| 6245 | </table>
|
| 6246 |
|
| 6247 | </td>
|
| 6248 | </tr>
|
| 6249 |
|
| 6250 |
|
| 6251 |
|
| 6252 | <tr>
|
| 6253 |
|
| 6254 | <td class="name"><code>options</code></td>
|
| 6255 |
|
| 6256 |
|
| 6257 | <td class="type">
|
| 6258 |
|
| 6259 |
|
| 6260 | <span class="param-type">Object</span>
|
| 6261 |
|
| 6262 |
|
| 6263 |
|
| 6264 | </td>
|
| 6265 |
|
| 6266 |
|
| 6267 | <td class="attributes">
|
| 6268 |
|
| 6269 | <optional><br>
|
| 6270 |
|
| 6271 |
|
| 6272 |
|
| 6273 |
|
| 6274 |
|
| 6275 | </td>
|
| 6276 |
|
| 6277 |
|
| 6278 |
|
| 6279 |
|
| 6280 | <td class="description last"><p>Optional arguments.</p>
|
| 6281 | <h6>Properties</h6>
|
| 6282 |
|
| 6283 |
|
| 6284 | <table class="params">
|
| 6285 | <thead>
|
| 6286 | <tr>
|
| 6287 |
|
| 6288 | <th>Name</th>
|
| 6289 |
|
| 6290 |
|
| 6291 | <th>Type</th>
|
| 6292 |
|
| 6293 |
|
| 6294 | <th>Attributes</th>
|
| 6295 |
|
| 6296 |
|
| 6297 |
|
| 6298 |
|
| 6299 | <th class="last">Description</th>
|
| 6300 | </tr>
|
| 6301 | </thead>
|
| 6302 |
|
| 6303 | <tbody>
|
| 6304 |
|
| 6305 |
|
| 6306 | <tr>
|
| 6307 |
|
| 6308 | <td class="name"><code>connectedDevices</code></td>
|
| 6309 |
|
| 6310 |
|
| 6311 | <td class="type">
|
| 6312 |
|
| 6313 |
|
| 6314 | <span class="param-type">Array.<String></span>
|
| 6315 |
|
| 6316 |
|
| 6317 |
|
| 6318 | </td>
|
| 6319 |
|
| 6320 |
|
| 6321 | <td class="attributes">
|
| 6322 |
|
| 6323 | <optional><br>
|
| 6324 |
|
| 6325 |
|
| 6326 |
|
| 6327 |
|
| 6328 |
|
| 6329 | </td>
|
| 6330 |
|
| 6331 |
|
| 6332 |
|
| 6333 |
|
| 6334 | <td class="description last"><p>List of device names that should be connected.
|
| 6335 | If defined, sync complete failures are ignored
|
| 6336 | when device trust can not sync due to disconnected
|
| 6337 | devices that are not in this list. Default is to
|
| 6338 | leave undefined and fail on all sync complete failures.</p></td>
|
| 6339 | </tr>
|
| 6340 |
|
| 6341 |
|
| 6342 | </tbody>
|
| 6343 | </table>
|
| 6344 |
|
| 6345 | </td>
|
| 6346 | </tr>
|
| 6347 |
|
| 6348 |
|
| 6349 | </tbody>
|
| 6350 | </table>
|
| 6351 |
|
| 6352 |
|
| 6353 |
|
| 6354 |
|
| 6355 |
|
| 6356 |
|
| 6357 | <dl class="details">
|
| 6358 |
|
| 6359 |
|
| 6360 |
|
| 6361 |
|
| 6362 |
|
| 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 | </dl>
|
| 6391 |
|
| 6392 |
|
| 6393 |
|
| 6394 |
|
| 6395 |
|
| 6396 |
|
| 6397 |
|
| 6398 |
|
| 6399 |
|
| 6400 |
|
| 6401 |
|
| 6402 |
|
| 6403 |
|
| 6404 | <h5>Returns:</h5>
|
| 6405 |
|
| 6406 |
|
| 6407 | <div class="param-desc">
|
| 6408 | <p>A promise which is resolved if sync is complete,
|
| 6409 | or rejected on error or recommended action.</p>
|
| 6410 | </div>
|
| 6411 |
|
| 6412 |
|
| 6413 |
|
| 6414 | <dl>
|
| 6415 | <dt>
|
| 6416 | Type
|
| 6417 | </dt>
|
| 6418 | <dd>
|
| 6419 |
|
| 6420 | <span class="param-type">Promise</span>
|
| 6421 |
|
| 6422 |
|
| 6423 | </dd>
|
| 6424 | </dl>
|
| 6425 |
|
| 6426 |
|
| 6427 |
|
| 6428 |
|
| 6429 |
|
| 6430 |
|
| 6431 |
|
| 6432 |
|
| 6433 |
|
| 6434 |
|
| 6435 |
|
| 6436 |
|
| 6437 |
|
| 6438 | </article>
|
| 6439 |
|
| 6440 | </section>
|
| 6441 |
|
| 6442 |
|
| 6443 |
|
| 6444 |
|
| 6445 | </div>
|
| 6446 |
|
| 6447 | <nav>
|
| 6448 | <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>
|
| 6449 | </nav>
|
| 6450 |
|
| 6451 | <br class="clear">
|
| 6452 |
|
| 6453 | <footer>
|
| 6454 | Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
|
| 6455 | </footer>
|
| 6456 |
|
| 6457 | <script> prettyPrint(); </script>
|
| 6458 | <script src="scripts/linenumber.js"> </script>
|
| 6459 | </body>
|
| 6460 | </html> |
| \ | No newline at end of file |