1.. _cisco.nxos.nxos_ntp_global_module: 2 3 4************************** 5cisco.nxos.nxos_ntp_global 6************************** 7 8**NTP Global resource module.** 9 10 11Version added: 2.6.0 12 13.. contents:: 14 :local: 15 :depth: 1 16 17 18Synopsis 19-------- 20- This module manages ntp configuration on devices running Cisco NX-OS. 21 22 23 24 25Parameters 26---------- 27 28.. raw:: html 29 30 <table border=0 cellpadding=0 class="documentation-table"> 31 <tr> 32 <th colspan="4">Parameter</th> 33 <th>Choices/<font color="blue">Defaults</font></th> 34 <th width="100%">Comments</th> 35 </tr> 36 <tr> 37 <td colspan="4"> 38 <div class="ansibleOptionAnchor" id="parameter-"></div> 39 <b>config</b> 40 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 41 <div style="font-size: small"> 42 <span style="color: purple">dictionary</span> 43 </div> 44 </td> 45 <td> 46 </td> 47 <td> 48 <div>A dict of ntp configuration.</div> 49 </td> 50 </tr> 51 <tr> 52 <td class="elbow-placeholder"></td> 53 <td colspan="3"> 54 <div class="ansibleOptionAnchor" id="parameter-"></div> 55 <b>access_group</b> 56 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 57 <div style="font-size: small"> 58 <span style="color: purple">dictionary</span> 59 </div> 60 </td> 61 <td> 62 </td> 63 <td> 64 <div>NTP access-group.</div> 65 </td> 66 </tr> 67 <tr> 68 <td class="elbow-placeholder"></td> 69 <td class="elbow-placeholder"></td> 70 <td colspan="2"> 71 <div class="ansibleOptionAnchor" id="parameter-"></div> 72 <b>match_all</b> 73 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 74 <div style="font-size: small"> 75 <span style="color: purple">boolean</span> 76 </div> 77 </td> 78 <td> 79 <ul style="margin: 0; padding: 0"><b>Choices:</b> 80 <li>no</li> 81 <li>yes</li> 82 </ul> 83 </td> 84 <td> 85 <div>Scan ACLs present in all ntp access groups.</div> 86 </td> 87 </tr> 88 <tr> 89 <td class="elbow-placeholder"></td> 90 <td class="elbow-placeholder"></td> 91 <td colspan="2"> 92 <div class="ansibleOptionAnchor" id="parameter-"></div> 93 <b>peer</b> 94 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 95 <div style="font-size: small"> 96 <span style="color: purple">list</span> 97 / <span style="color: purple">elements=dictionary</span> 98 </div> 99 </td> 100 <td> 101 </td> 102 <td> 103 <div>Access-group peer.</div> 104 </td> 105 </tr> 106 <tr> 107 <td class="elbow-placeholder"></td> 108 <td class="elbow-placeholder"></td> 109 <td class="elbow-placeholder"></td> 110 <td colspan="1"> 111 <div class="ansibleOptionAnchor" id="parameter-"></div> 112 <b>access_list</b> 113 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 114 <div style="font-size: small"> 115 <span style="color: purple">string</span> 116 </div> 117 </td> 118 <td> 119 </td> 120 <td> 121 <div>Name of access list.</div> 122 </td> 123 </tr> 124 125 <tr> 126 <td class="elbow-placeholder"></td> 127 <td class="elbow-placeholder"></td> 128 <td colspan="2"> 129 <div class="ansibleOptionAnchor" id="parameter-"></div> 130 <b>query_only</b> 131 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 132 <div style="font-size: small"> 133 <span style="color: purple">list</span> 134 / <span style="color: purple">elements=dictionary</span> 135 </div> 136 </td> 137 <td> 138 </td> 139 <td> 140 <div>Access-group query-only.</div> 141 </td> 142 </tr> 143 <tr> 144 <td class="elbow-placeholder"></td> 145 <td class="elbow-placeholder"></td> 146 <td class="elbow-placeholder"></td> 147 <td colspan="1"> 148 <div class="ansibleOptionAnchor" id="parameter-"></div> 149 <b>access_list</b> 150 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 151 <div style="font-size: small"> 152 <span style="color: purple">string</span> 153 </div> 154 </td> 155 <td> 156 </td> 157 <td> 158 <div>Name of access list.</div> 159 </td> 160 </tr> 161 162 <tr> 163 <td class="elbow-placeholder"></td> 164 <td class="elbow-placeholder"></td> 165 <td colspan="2"> 166 <div class="ansibleOptionAnchor" id="parameter-"></div> 167 <b>serve</b> 168 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 169 <div style="font-size: small"> 170 <span style="color: purple">list</span> 171 / <span style="color: purple">elements=dictionary</span> 172 </div> 173 </td> 174 <td> 175 </td> 176 <td> 177 <div>Access-group serve.</div> 178 </td> 179 </tr> 180 <tr> 181 <td class="elbow-placeholder"></td> 182 <td class="elbow-placeholder"></td> 183 <td class="elbow-placeholder"></td> 184 <td colspan="1"> 185 <div class="ansibleOptionAnchor" id="parameter-"></div> 186 <b>access_list</b> 187 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 188 <div style="font-size: small"> 189 <span style="color: purple">string</span> 190 </div> 191 </td> 192 <td> 193 </td> 194 <td> 195 <div>Name of access list.</div> 196 </td> 197 </tr> 198 199 <tr> 200 <td class="elbow-placeholder"></td> 201 <td class="elbow-placeholder"></td> 202 <td colspan="2"> 203 <div class="ansibleOptionAnchor" id="parameter-"></div> 204 <b>serve_only</b> 205 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 206 <div style="font-size: small"> 207 <span style="color: purple">list</span> 208 / <span style="color: purple">elements=dictionary</span> 209 </div> 210 </td> 211 <td> 212 </td> 213 <td> 214 <div>Access-group serve-only.</div> 215 </td> 216 </tr> 217 <tr> 218 <td class="elbow-placeholder"></td> 219 <td class="elbow-placeholder"></td> 220 <td class="elbow-placeholder"></td> 221 <td colspan="1"> 222 <div class="ansibleOptionAnchor" id="parameter-"></div> 223 <b>access_list</b> 224 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 225 <div style="font-size: small"> 226 <span style="color: purple">string</span> 227 </div> 228 </td> 229 <td> 230 </td> 231 <td> 232 <div>Name of access list.</div> 233 </td> 234 </tr> 235 236 237 <tr> 238 <td class="elbow-placeholder"></td> 239 <td colspan="3"> 240 <div class="ansibleOptionAnchor" id="parameter-"></div> 241 <b>allow</b> 242 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 243 <div style="font-size: small"> 244 <span style="color: purple">dictionary</span> 245 </div> 246 </td> 247 <td> 248 </td> 249 <td> 250 <div>Enable/Disable the packets.</div> 251 </td> 252 </tr> 253 <tr> 254 <td class="elbow-placeholder"></td> 255 <td class="elbow-placeholder"></td> 256 <td colspan="2"> 257 <div class="ansibleOptionAnchor" id="parameter-"></div> 258 <b>control</b> 259 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 260 <div style="font-size: small"> 261 <span style="color: purple">dictionary</span> 262 </div> 263 </td> 264 <td> 265 </td> 266 <td> 267 <div>Control mode packets.</div> 268 </td> 269 </tr> 270 <tr> 271 <td class="elbow-placeholder"></td> 272 <td class="elbow-placeholder"></td> 273 <td class="elbow-placeholder"></td> 274 <td colspan="1"> 275 <div class="ansibleOptionAnchor" id="parameter-"></div> 276 <b>rate_limit</b> 277 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 278 <div style="font-size: small"> 279 <span style="color: purple">integer</span> 280 </div> 281 </td> 282 <td> 283 </td> 284 <td> 285 <div>Rate-limit delay.</div> 286 </td> 287 </tr> 288 289 <tr> 290 <td class="elbow-placeholder"></td> 291 <td class="elbow-placeholder"></td> 292 <td colspan="2"> 293 <div class="ansibleOptionAnchor" id="parameter-"></div> 294 <b>private</b> 295 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 296 <div style="font-size: small"> 297 <span style="color: purple">boolean</span> 298 </div> 299 </td> 300 <td> 301 <ul style="margin: 0; padding: 0"><b>Choices:</b> 302 <li>no</li> 303 <li>yes</li> 304 </ul> 305 </td> 306 <td> 307 <div>Enable/Disable Private mode packets.</div> 308 </td> 309 </tr> 310 311 <tr> 312 <td class="elbow-placeholder"></td> 313 <td colspan="3"> 314 <div class="ansibleOptionAnchor" id="parameter-"></div> 315 <b>authenticate</b> 316 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 317 <div style="font-size: small"> 318 <span style="color: purple">boolean</span> 319 </div> 320 </td> 321 <td> 322 <ul style="margin: 0; padding: 0"><b>Choices:</b> 323 <li>no</li> 324 <li>yes</li> 325 </ul> 326 </td> 327 <td> 328 <div>Enable/Disable authentication.</div> 329 </td> 330 </tr> 331 <tr> 332 <td class="elbow-placeholder"></td> 333 <td colspan="3"> 334 <div class="ansibleOptionAnchor" id="parameter-"></div> 335 <b>authentication_keys</b> 336 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 337 <div style="font-size: small"> 338 <span style="color: purple">list</span> 339 / <span style="color: purple">elements=dictionary</span> 340 </div> 341 </td> 342 <td> 343 </td> 344 <td> 345 <div>NTP authentication key.</div> 346 </td> 347 </tr> 348 <tr> 349 <td class="elbow-placeholder"></td> 350 <td class="elbow-placeholder"></td> 351 <td colspan="2"> 352 <div class="ansibleOptionAnchor" id="parameter-"></div> 353 <b>encryption</b> 354 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 355 <div style="font-size: small"> 356 <span style="color: purple">integer</span> 357 </div> 358 </td> 359 <td> 360 </td> 361 <td> 362 <div>0 for Clear text</div> 363 <div>7 for Encrypted</div> 364 </td> 365 </tr> 366 <tr> 367 <td class="elbow-placeholder"></td> 368 <td class="elbow-placeholder"></td> 369 <td colspan="2"> 370 <div class="ansibleOptionAnchor" id="parameter-"></div> 371 <b>id</b> 372 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 373 <div style="font-size: small"> 374 <span style="color: purple">integer</span> 375 </div> 376 </td> 377 <td> 378 </td> 379 <td> 380 <div>Authentication key number (range 1-65535).</div> 381 </td> 382 </tr> 383 <tr> 384 <td class="elbow-placeholder"></td> 385 <td class="elbow-placeholder"></td> 386 <td colspan="2"> 387 <div class="ansibleOptionAnchor" id="parameter-"></div> 388 <b>key</b> 389 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 390 <div style="font-size: small"> 391 <span style="color: purple">string</span> 392 </div> 393 </td> 394 <td> 395 </td> 396 <td> 397 <div>Authentication key.</div> 398 </td> 399 </tr> 400 401 <tr> 402 <td class="elbow-placeholder"></td> 403 <td colspan="3"> 404 <div class="ansibleOptionAnchor" id="parameter-"></div> 405 <b>logging</b> 406 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 407 <div style="font-size: small"> 408 <span style="color: purple">boolean</span> 409 </div> 410 </td> 411 <td> 412 <ul style="margin: 0; padding: 0"><b>Choices:</b> 413 <li>no</li> 414 <li>yes</li> 415 </ul> 416 </td> 417 <td> 418 <div>Enable/Disable logging of NTPD Events.</div> 419 </td> 420 </tr> 421 <tr> 422 <td class="elbow-placeholder"></td> 423 <td colspan="3"> 424 <div class="ansibleOptionAnchor" id="parameter-"></div> 425 <b>master</b> 426 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 427 <div style="font-size: small"> 428 <span style="color: purple">dictionary</span> 429 </div> 430 </td> 431 <td> 432 </td> 433 <td> 434 <div>Act as NTP master clock.</div> 435 </td> 436 </tr> 437 <tr> 438 <td class="elbow-placeholder"></td> 439 <td class="elbow-placeholder"></td> 440 <td colspan="2"> 441 <div class="ansibleOptionAnchor" id="parameter-"></div> 442 <b>stratum</b> 443 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 444 <div style="font-size: small"> 445 <span style="color: purple">integer</span> 446 </div> 447 </td> 448 <td> 449 </td> 450 <td> 451 <div>Stratum number.</div> 452 </td> 453 </tr> 454 455 <tr> 456 <td class="elbow-placeholder"></td> 457 <td colspan="3"> 458 <div class="ansibleOptionAnchor" id="parameter-"></div> 459 <b>passive</b> 460 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 461 <div style="font-size: small"> 462 <span style="color: purple">boolean</span> 463 </div> 464 </td> 465 <td> 466 <ul style="margin: 0; padding: 0"><b>Choices:</b> 467 <li>no</li> 468 <li>yes</li> 469 </ul> 470 </td> 471 <td> 472 <div>NTP passive command.</div> 473 </td> 474 </tr> 475 <tr> 476 <td class="elbow-placeholder"></td> 477 <td colspan="3"> 478 <div class="ansibleOptionAnchor" id="parameter-"></div> 479 <b>peers</b> 480 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 481 <div style="font-size: small"> 482 <span style="color: purple">list</span> 483 / <span style="color: purple">elements=dictionary</span> 484 </div> 485 </td> 486 <td> 487 </td> 488 <td> 489 <div>NTP Peers.</div> 490 </td> 491 </tr> 492 <tr> 493 <td class="elbow-placeholder"></td> 494 <td class="elbow-placeholder"></td> 495 <td colspan="2"> 496 <div class="ansibleOptionAnchor" id="parameter-"></div> 497 <b>key_id</b> 498 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 499 <div style="font-size: small"> 500 <span style="color: purple">integer</span> 501 </div> 502 </td> 503 <td> 504 </td> 505 <td> 506 <div>Keyid to be used while communicating to this server.</div> 507 </td> 508 </tr> 509 <tr> 510 <td class="elbow-placeholder"></td> 511 <td class="elbow-placeholder"></td> 512 <td colspan="2"> 513 <div class="ansibleOptionAnchor" id="parameter-"></div> 514 <b>maxpoll</b> 515 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 516 <div style="font-size: small"> 517 <span style="color: purple">integer</span> 518 </div> 519 </td> 520 <td> 521 </td> 522 <td> 523 <div>Maximum interval to poll a peer.</div> 524 <div>Poll interval in secs to a power of 2.</div> 525 </td> 526 </tr> 527 <tr> 528 <td class="elbow-placeholder"></td> 529 <td class="elbow-placeholder"></td> 530 <td colspan="2"> 531 <div class="ansibleOptionAnchor" id="parameter-"></div> 532 <b>minpoll</b> 533 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 534 <div style="font-size: small"> 535 <span style="color: purple">integer</span> 536 </div> 537 </td> 538 <td> 539 </td> 540 <td> 541 <div>Minimum interval to poll a peer.</div> 542 <div>Poll interval in secs to a power of 2.</div> 543 </td> 544 </tr> 545 <tr> 546 <td class="elbow-placeholder"></td> 547 <td class="elbow-placeholder"></td> 548 <td colspan="2"> 549 <div class="ansibleOptionAnchor" id="parameter-"></div> 550 <b>peer</b> 551 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 552 <div style="font-size: small"> 553 <span style="color: purple">string</span> 554 </div> 555 </td> 556 <td> 557 </td> 558 <td> 559 <div>Hostname/IP address of the NTP Peer.</div> 560 </td> 561 </tr> 562 <tr> 563 <td class="elbow-placeholder"></td> 564 <td class="elbow-placeholder"></td> 565 <td colspan="2"> 566 <div class="ansibleOptionAnchor" id="parameter-"></div> 567 <b>prefer</b> 568 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 569 <div style="font-size: small"> 570 <span style="color: purple">boolean</span> 571 </div> 572 </td> 573 <td> 574 <ul style="margin: 0; padding: 0"><b>Choices:</b> 575 <li>no</li> 576 <li>yes</li> 577 </ul> 578 </td> 579 <td> 580 <div>Preferred Server.</div> 581 </td> 582 </tr> 583 <tr> 584 <td class="elbow-placeholder"></td> 585 <td class="elbow-placeholder"></td> 586 <td colspan="2"> 587 <div class="ansibleOptionAnchor" id="parameter-"></div> 588 <b>use_vrf</b> 589 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 590 <div style="font-size: small"> 591 <span style="color: purple">string</span> 592 </div> 593 </td> 594 <td> 595 </td> 596 <td> 597 <div>Display per-VRF information.</div> 598 </td> 599 </tr> 600 601 <tr> 602 <td class="elbow-placeholder"></td> 603 <td colspan="3"> 604 <div class="ansibleOptionAnchor" id="parameter-"></div> 605 <b>servers</b> 606 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 607 <div style="font-size: small"> 608 <span style="color: purple">list</span> 609 / <span style="color: purple">elements=dictionary</span> 610 </div> 611 </td> 612 <td> 613 </td> 614 <td> 615 <div>NTP servers.</div> 616 </td> 617 </tr> 618 <tr> 619 <td class="elbow-placeholder"></td> 620 <td class="elbow-placeholder"></td> 621 <td colspan="2"> 622 <div class="ansibleOptionAnchor" id="parameter-"></div> 623 <b>key_id</b> 624 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 625 <div style="font-size: small"> 626 <span style="color: purple">integer</span> 627 </div> 628 </td> 629 <td> 630 </td> 631 <td> 632 <div>Keyid to be used while communicating to this server.</div> 633 </td> 634 </tr> 635 <tr> 636 <td class="elbow-placeholder"></td> 637 <td class="elbow-placeholder"></td> 638 <td colspan="2"> 639 <div class="ansibleOptionAnchor" id="parameter-"></div> 640 <b>maxpoll</b> 641 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 642 <div style="font-size: small"> 643 <span style="color: purple">integer</span> 644 </div> 645 </td> 646 <td> 647 </td> 648 <td> 649 <div>Maximum interval to poll a peer.</div> 650 <div>Poll interval in secs to a power of 2.</div> 651 </td> 652 </tr> 653 <tr> 654 <td class="elbow-placeholder"></td> 655 <td class="elbow-placeholder"></td> 656 <td colspan="2"> 657 <div class="ansibleOptionAnchor" id="parameter-"></div> 658 <b>minpoll</b> 659 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 660 <div style="font-size: small"> 661 <span style="color: purple">integer</span> 662 </div> 663 </td> 664 <td> 665 </td> 666 <td> 667 <div>Minimum interval to poll a peer.</div> 668 <div>Poll interval in secs to a power of 2.</div> 669 </td> 670 </tr> 671 <tr> 672 <td class="elbow-placeholder"></td> 673 <td class="elbow-placeholder"></td> 674 <td colspan="2"> 675 <div class="ansibleOptionAnchor" id="parameter-"></div> 676 <b>prefer</b> 677 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 678 <div style="font-size: small"> 679 <span style="color: purple">boolean</span> 680 </div> 681 </td> 682 <td> 683 <ul style="margin: 0; padding: 0"><b>Choices:</b> 684 <li>no</li> 685 <li>yes</li> 686 </ul> 687 </td> 688 <td> 689 <div>Preferred Server.</div> 690 </td> 691 </tr> 692 <tr> 693 <td class="elbow-placeholder"></td> 694 <td class="elbow-placeholder"></td> 695 <td colspan="2"> 696 <div class="ansibleOptionAnchor" id="parameter-"></div> 697 <b>server</b> 698 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 699 <div style="font-size: small"> 700 <span style="color: purple">string</span> 701 </div> 702 </td> 703 <td> 704 </td> 705 <td> 706 <div>Hostname/IP address of the NTP Peer.</div> 707 </td> 708 </tr> 709 <tr> 710 <td class="elbow-placeholder"></td> 711 <td class="elbow-placeholder"></td> 712 <td colspan="2"> 713 <div class="ansibleOptionAnchor" id="parameter-"></div> 714 <b>use_vrf</b> 715 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 716 <div style="font-size: small"> 717 <span style="color: purple">string</span> 718 </div> 719 </td> 720 <td> 721 </td> 722 <td> 723 <div>Display per-VRF information.</div> 724 </td> 725 </tr> 726 727 <tr> 728 <td class="elbow-placeholder"></td> 729 <td colspan="3"> 730 <div class="ansibleOptionAnchor" id="parameter-"></div> 731 <b>source</b> 732 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 733 <div style="font-size: small"> 734 <span style="color: purple">string</span> 735 </div> 736 </td> 737 <td> 738 </td> 739 <td> 740 <div>Source of NTP packets.</div> 741 </td> 742 </tr> 743 <tr> 744 <td class="elbow-placeholder"></td> 745 <td colspan="3"> 746 <div class="ansibleOptionAnchor" id="parameter-"></div> 747 <b>source_interface</b> 748 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 749 <div style="font-size: small"> 750 <span style="color: purple">string</span> 751 </div> 752 </td> 753 <td> 754 </td> 755 <td> 756 <div>Source interface sending NTP packets.</div> 757 </td> 758 </tr> 759 <tr> 760 <td class="elbow-placeholder"></td> 761 <td colspan="3"> 762 <div class="ansibleOptionAnchor" id="parameter-"></div> 763 <b>trusted_keys</b> 764 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 765 <div style="font-size: small"> 766 <span style="color: purple">list</span> 767 / <span style="color: purple">elements=dictionary</span> 768 </div> 769 </td> 770 <td> 771 </td> 772 <td> 773 <div>NTP trusted-key number.</div> 774 </td> 775 </tr> 776 <tr> 777 <td class="elbow-placeholder"></td> 778 <td class="elbow-placeholder"></td> 779 <td colspan="2"> 780 <div class="ansibleOptionAnchor" id="parameter-"></div> 781 <b>key_id</b> 782 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 783 <div style="font-size: small"> 784 <span style="color: purple">integer</span> 785 </div> 786 </td> 787 <td> 788 </td> 789 <td> 790 <div>Trusted-Key number.</div> 791 </td> 792 </tr> 793 794 795 <tr> 796 <td colspan="4"> 797 <div class="ansibleOptionAnchor" id="parameter-"></div> 798 <b>running_config</b> 799 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 800 <div style="font-size: small"> 801 <span style="color: purple">string</span> 802 </div> 803 </td> 804 <td> 805 </td> 806 <td> 807 <div>This option is used only with state <em>parsed</em>.</div> 808 <div>The value of this option should be the output received from the NX-OS device by executing the command <b>show running-config ntp</b>.</div> 809 <div>The state <em>parsed</em> reads the configuration from <code>running_config</code> option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the <em>parsed</em> key within the result.</div> 810 </td> 811 </tr> 812 <tr> 813 <td colspan="4"> 814 <div class="ansibleOptionAnchor" id="parameter-"></div> 815 <b>state</b> 816 <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> 817 <div style="font-size: small"> 818 <span style="color: purple">string</span> 819 </div> 820 </td> 821 <td> 822 <ul style="margin: 0; padding: 0"><b>Choices:</b> 823 <li><div style="color: blue"><b>merged</b> ←</div></li> 824 <li>replaced</li> 825 <li>overridden</li> 826 <li>deleted</li> 827 <li>parsed</li> 828 <li>gathered</li> 829 <li>rendered</li> 830 </ul> 831 </td> 832 <td> 833 <div>The state the configuration should be left in.</div> 834 <div>The states <em>replaced</em> and <em>overridden</em> have identical behaviour for this module.</div> 835 <div>Please refer to examples for more details.</div> 836 </td> 837 </tr> 838 </table> 839 <br/> 840 841 842Notes 843----- 844 845.. note:: 846 - Tested against NX-OS 9.3.6. 847 - This module works with connection ``network_cli`` and ``httpapi``. 848 849 850 851Examples 852-------- 853 854.. code-block:: yaml 855 856 # Using merged 857 858 # Before state: 859 # ------------- 860 # nxos-9k-rdo# show running-config ntp 861 # nxos-9k-rdo# 862 863 - name: Merge the provided configuration with the existing running configuration 864 cisco.nxos.nxos_ntp_global: &id001 865 config: 866 access_group: 867 peer: 868 - access_list: PeerAcl1 869 serve: 870 - access_list: ServeAcl1 871 authenticate: True 872 authentication_keys: 873 - id: 1001 874 key: vagwwtKfkv 875 encryption: 7 876 - id: 1002 877 key: vagwwtKfkvgthz 878 encryption: 7 879 logging: True 880 master: 881 stratum: 2 882 peers: 883 - peer: 192.0.2.1 884 key_id: 1 885 maxpoll: 15 886 minpoll: 5 887 use_vrf: default 888 - peer: 192.0.2.2 889 key_id: 2 890 prefer: True 891 use_vrf: siteA 892 servers: 893 - server: 198.51.100.1 894 key_id: 2 895 use_vrf: default 896 - server: 203.0.113.1 897 key_id: 1 898 use_vrf: siteB 899 900 # Task output 901 # ------------- 902 # before: {} 903 # 904 # commands: 905 # - "ntp authenticate" 906 # - "ntp logging" 907 # - "ntp master 2" 908 # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" 909 # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" 910 # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" 911 # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" 912 # - "ntp server 198.51.100.1 use-vrf default key 2" 913 # - "ntp server 203.0.113.1 use-vrf siteB key 1" 914 # - "ntp access-group peer PeerAcl1" 915 # - "ntp access-group serve ServeAcl1" 916 # 917 # after: 918 # access_group: 919 # peer: 920 # - access_list: PeerAcl1 921 # serve: 922 # - access_list: ServeAcl1 923 # authenticate: True 924 # authentication_keys: 925 # - id: 1001 926 # key: vagwwtKfkv 927 # encryption: 7 928 # - id: 1002 929 # key: vagwwtKfkvgthz 930 # encryption: 7 931 # logging: True 932 # master: 933 # stratum: 2 934 # peers: 935 # - peer: 192.0.2.1 936 # key_id: 1 937 # maxpoll: 15 938 # minpoll: 5 939 # use_vrf: default 940 # - peer: 192.0.2.2 941 # key_id: 2 942 # prefer: True 943 # use_vrf: siteA 944 # servers: 945 # - server: 198.51.100.1 946 # key_id: 2 947 # use_vrf: default 948 # - server: 203.0.113.1 949 # key_id: 1 950 # use_vrf: siteB 951 952 # After state: 953 # ------------ 954 # nxos-9k-rdo# show running-config ntp 955 # ntp authenticate 956 # ntp logging 957 # ntp master 2 958 # ntp authentication-keys 1001 md5 vagwwtKfkv 7 959 # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 960 # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 961 # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 962 # ntp server 198.51.100.1 use-vrf default key 2 963 # ntp server 203.0.113.1 use-vrf siteB key 1 964 # ntp access-group peer PeerAcl1 965 # ntp access-group serve ServeAcl1 966 967 # Using replaced 968 969 # Before state: 970 # ------------ 971 # nxos-9k-rdo# show running-config ntp 972 # ntp authenticate 973 # ntp logging 974 # ntp master 2 975 # ntp authentication-keys 1001 md5 vagwwtKfkv 7 976 # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 977 # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 978 # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 979 # ntp server 198.51.100.1 use-vrf default key 2 980 # ntp server 203.0.113.1 use-vrf siteB key 1 981 # ntp access-group peer PeerAcl1 982 # ntp access-group serve ServeAcl1 983 984 - name: Replace logging global configurations of listed logging global with provided configurations 985 cisco.nxos.nxos_ntp_global: 986 config: 987 access_group: 988 peer: 989 - access_list: PeerAcl2 990 serve: 991 - access_list: ServeAcl2 992 logging: True 993 master: 994 stratum: 2 995 peers: 996 - peer: 192.0.2.1 997 key_id: 1 998 maxpoll: 15 999 minpoll: 5 1000 use_vrf: default 1001 - peer: 192.0.2.5 1002 key_id: 2 1003 prefer: True 1004 use_vrf: siteA 1005 servers: 1006 - server: 198.51.100.1 1007 key_id: 2 1008 use_vrf: default 1009 state: replaced 1010 1011 # Task output 1012 # ------------- 1013 # before: 1014 # access_group: 1015 # peer: 1016 # - access_list: PeerAcl1 1017 # serve: 1018 # - access_list: ServeAcl1 1019 # authenticate: True 1020 # authentication_keys: 1021 # - id: 1001 1022 # key: vagwwtKfkv 1023 # encryption: 7 1024 # - id: 1002 1025 # key: vagwwtKfkvgthz 1026 # encryption: 7 1027 # logging: True 1028 # master: 1029 # stratum: 2 1030 # peers: 1031 # - peer: 192.0.2.1 1032 # key_id: 1 1033 # maxpoll: 15 1034 # minpoll: 5 1035 # use_vrf: default 1036 # - peer: 192.0.2.2 1037 # key_id: 2 1038 # prefer: True 1039 # use_vrf: siteA 1040 # servers: 1041 # - server: 198.51.100.1 1042 # key_id: 2 1043 # use_vrf: default 1044 # - server: 203.0.113.1 1045 # key_id: 1 1046 # use_vrf: siteB 1047 # 1048 # commands: 1049 # - "no ntp authenticate" 1050 # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" 1051 # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" 1052 # - "ntp peer 192.0.2.5 prefer use-vrf siteA key 2" 1053 # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" 1054 # - "no ntp server 203.0.113.1 use-vrf siteB key 1" 1055 # - "ntp access-group peer PeerAcl2" 1056 # - "no ntp access-group peer PeerAcl1" 1057 # - "ntp access-group serve ServeAcl2" 1058 # - "no ntp access-group serve ServeAcl1" 1059 # 1060 # after: 1061 # access_group: 1062 # peer: 1063 # - access_list: PeerAcl2 1064 # serve: 1065 # - access_list: ServeAcl2 1066 # logging: True 1067 # master: 1068 # stratum: 2 1069 # peers: 1070 # - peer: 192.0.2.1 1071 # key_id: 1 1072 # maxpoll: 15 1073 # minpoll: 5 1074 # use_vrf: default 1075 # - peer: 192.0.2.5 1076 # key_id: 2 1077 # prefer: True 1078 # use_vrf: siteA 1079 # servers: 1080 # - server: 198.51.100.1 1081 # key_id: 2 1082 # use_vrf: default 1083 1084 # After state: 1085 # ------------ 1086 # nxos-9k-rdo# show running-config ntp 1087 # ntp logging 1088 # ntp master 2 1089 # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 1090 # ntp peer 192.0.2.5 prefer use-vrf siteA key 2 1091 # ntp server 198.51.100.1 use-vrf default key 2 1092 # ntp access-group peer PeerAcl2 1093 # ntp access-group serve ServeAcl2 1094 1095 # Using deleted to delete all logging configurations 1096 1097 # Before state: 1098 # ------------ 1099 # nxos-9k-rdo# show running-config ntp 1100 1101 - name: Delete all logging configuration 1102 cisco.nxos.nxos_ntp_global: 1103 state: deleted 1104 1105 # Task output 1106 # ------------- 1107 # before: 1108 # access_group: 1109 # peer: 1110 # - access_list: PeerAcl1 1111 # serve: 1112 # - access_list: ServeAcl1 1113 # authenticate: True 1114 # authentication_keys: 1115 # - id: 1001 1116 # key: vagwwtKfkv 1117 # encryption: 7 1118 # - id: 1002 1119 # key: vagwwtKfkvgthz 1120 # encryption: 7 1121 # logging: True 1122 # master: 1123 # stratum: 2 1124 # peers: 1125 # - peer: 192.0.2.1 1126 # key_id: 1 1127 # maxpoll: 15 1128 # minpoll: 5 1129 # use_vrf: default 1130 # - peer: 192.0.2.2 1131 # key_id: 2 1132 # prefer: True 1133 # use_vrf: siteA 1134 # servers: 1135 # - server: 198.51.100.1 1136 # key_id: 2 1137 # use_vrf: default 1138 # - server: 203.0.113.1 1139 # key_id: 1 1140 # use_vrf: siteB 1141 # 1142 # commands: 1143 # - "no ntp authenticate" 1144 # - "no ntp logging" 1145 # - "no ntp master 2" 1146 # - "no ntp authentication-keys 1001 md5 vagwwtKfkv 7" 1147 # - "no ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" 1148 # - "no ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" 1149 # - "no ntp peer 192.0.2.2 prefer use-vrf siteA key 2" 1150 # - "no ntp server 198.51.100.1 use-vrf default key 2" 1151 # - "no ntp server 203.0.113.1 use-vrf siteB key 1" 1152 # - "no ntp access-group peer PeerAcl1" 1153 # - "no ntp access-group serve ServeAcl1" 1154 # 1155 # after: {} 1156 1157 # After state: 1158 # ------------ 1159 # nxos-9k-rdo# show running-config ntp 1160 # nxos-9k-rdo# 1161 1162 # Using rendered 1163 1164 - name: Render platform specific configuration lines with state rendered (without connecting to the device) 1165 cisco.nxos.nxos_ntp_global: 1166 config: 1167 access_group: 1168 peer: 1169 - access_list: PeerAcl1 1170 serve: 1171 - access_list: ServeAcl1 1172 authenticate: True 1173 authentication_keys: 1174 - id: 1001 1175 key: vagwwtKfkv 1176 encryption: 7 1177 - id: 1002 1178 key: vagwwtKfkvgthz 1179 encryption: 7 1180 logging: True 1181 master: 1182 stratum: 2 1183 peers: 1184 - peer: 192.0.2.1 1185 key_id: 1 1186 maxpoll: 15 1187 minpoll: 5 1188 use_vrf: default 1189 - peer: 192.0.2.2 1190 key_id: 2 1191 prefer: True 1192 use_vrf: siteA 1193 servers: 1194 - server: 198.51.100.1 1195 key_id: 2 1196 use_vrf: default 1197 - server: 203.0.113.1 1198 key_id: 1 1199 use_vrf: siteB 1200 state: rendered 1201 1202 # Task Output (redacted) 1203 # ----------------------- 1204 # rendered: 1205 # - "ntp authenticate" 1206 # - "ntp logging" 1207 # - "ntp master 2" 1208 # - "ntp authentication-keys 1001 md5 vagwwtKfkv 7" 1209 # - "ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7" 1210 # - "ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15" 1211 # - "ntp peer 192.0.2.2 prefer use-vrf siteA key 2" 1212 # - "ntp server 198.51.100.1 use-vrf default key 2" 1213 # - "ntp server 203.0.113.1 use-vrf siteB key 1" 1214 # - "ntp access-group peer PeerAcl1" 1215 # - "ntp access-group serve ServeAcl1" 1216 1217 # Using parsed 1218 1219 # parsed.cfg 1220 # ------------ 1221 # ntp authenticate 1222 # ntp logging 1223 # ntp master 2 1224 # ntp authentication-keys 1001 md5 vagwwtKfkv 7 1225 # ntp authentication-keys 1002 md5 vagwwtKfkvgthz 7 1226 # ntp peer 192.0.2.1 use-vrf default key 1 minpoll 5 maxpoll 15 1227 # ntp peer 192.0.2.2 prefer use-vrf siteA key 2 1228 # ntp server 198.51.100.1 use-vrf default key 2 1229 # ntp server 203.0.113.1 use-vrf siteB key 1 1230 # ntp access-group peer PeerAcl1 1231 # ntp access-group serve ServeAcl1 1232 1233 - name: Parse externally provided ntp configuration 1234 cisco.nxos.nxos_ntp_global: 1235 running_config: "{{ lookup('file', './fixtures/parsed.cfg') }}" 1236 state: parsed 1237 1238 # Task output (redacted) 1239 # ----------------------- 1240 # parsed: 1241 # access_group: 1242 # peer: 1243 # - access_list: PeerAcl1 1244 # serve: 1245 # - access_list: ServeAcl1 1246 # authenticate: True 1247 # authentication_keys: 1248 # - id: 1001 1249 # key: vagwwtKfkv 1250 # encryption: 7 1251 # - id: 1002 1252 # key: vagwwtKfkvgthz 1253 # encryption: 7 1254 # logging: True 1255 # master: 1256 # stratum: 2 1257 # peers: 1258 # - peer: 192.0.2.1 1259 # key_id: 1 1260 # maxpoll: 15 1261 # minpoll: 5 1262 # use_vrf: default 1263 # - peer: 192.0.2.2 1264 # key_id: 2 1265 # prefer: True 1266 # use_vrf: siteA 1267 # servers: 1268 # - server: 198.51.100.1 1269 # key_id: 2 1270 # use_vrf: default 1271 # - server: 203.0.113.1 1272 # key_id: 1 1273 # use_vrf: siteB 1274 1275 1276 1277Return Values 1278------------- 1279Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module: 1280 1281.. raw:: html 1282 1283 <table border=0 cellpadding=0 class="documentation-table"> 1284 <tr> 1285 <th colspan="1">Key</th> 1286 <th>Returned</th> 1287 <th width="100%">Description</th> 1288 </tr> 1289 <tr> 1290 <td colspan="1"> 1291 <div class="ansibleOptionAnchor" id="return-"></div> 1292 <b>after</b> 1293 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1294 <div style="font-size: small"> 1295 <span style="color: purple">dictionary</span> 1296 </div> 1297 </td> 1298 <td>when changed</td> 1299 <td> 1300 <div>The resulting configuration after module execution.</div> 1301 <br/> 1302 <div style="font-size: smaller"><b>Sample:</b></div> 1303 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> 1304 </td> 1305 </tr> 1306 <tr> 1307 <td colspan="1"> 1308 <div class="ansibleOptionAnchor" id="return-"></div> 1309 <b>before</b> 1310 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1311 <div style="font-size: small"> 1312 <span style="color: purple">dictionary</span> 1313 </div> 1314 </td> 1315 <td>when <em>state</em> is <code>merged</code>, <code>replaced</code>, <code>overridden</code>, <code>deleted</code> or <code>purged</code></td> 1316 <td> 1317 <div>The configuration prior to the module execution.</div> 1318 <br/> 1319 <div style="font-size: smaller"><b>Sample:</b></div> 1320 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> 1321 </td> 1322 </tr> 1323 <tr> 1324 <td colspan="1"> 1325 <div class="ansibleOptionAnchor" id="return-"></div> 1326 <b>commands</b> 1327 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1328 <div style="font-size: small"> 1329 <span style="color: purple">list</span> 1330 </div> 1331 </td> 1332 <td>when <em>state</em> is <code>merged</code>, <code>replaced</code>, <code>overridden</code>, <code>deleted</code> or <code>purged</code></td> 1333 <td> 1334 <div>The set of commands pushed to the remote device.</div> 1335 <br/> 1336 <div style="font-size: smaller"><b>Sample:</b></div> 1337 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']</div> 1338 </td> 1339 </tr> 1340 <tr> 1341 <td colspan="1"> 1342 <div class="ansibleOptionAnchor" id="return-"></div> 1343 <b>gathered</b> 1344 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1345 <div style="font-size: small"> 1346 <span style="color: purple">list</span> 1347 </div> 1348 </td> 1349 <td>when <em>state</em> is <code>gathered</code></td> 1350 <td> 1351 <div>Facts about the network resource gathered from the remote device as structured data.</div> 1352 <br/> 1353 <div style="font-size: smaller"><b>Sample:</b></div> 1354 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> 1355 </td> 1356 </tr> 1357 <tr> 1358 <td colspan="1"> 1359 <div class="ansibleOptionAnchor" id="return-"></div> 1360 <b>parsed</b> 1361 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1362 <div style="font-size: small"> 1363 <span style="color: purple">list</span> 1364 </div> 1365 </td> 1366 <td>when <em>state</em> is <code>parsed</code></td> 1367 <td> 1368 <div>The device native config provided in <em>running_config</em> option parsed into structured data as per module argspec.</div> 1369 <br/> 1370 <div style="font-size: smaller"><b>Sample:</b></div> 1371 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">This output will always be in the same format as the module argspec.</div> 1372 </td> 1373 </tr> 1374 <tr> 1375 <td colspan="1"> 1376 <div class="ansibleOptionAnchor" id="return-"></div> 1377 <b>rendered</b> 1378 <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a> 1379 <div style="font-size: small"> 1380 <span style="color: purple">list</span> 1381 </div> 1382 </td> 1383 <td>when <em>state</em> is <code>rendered</code></td> 1384 <td> 1385 <div>The provided configuration in the task rendered in device-native format (offline).</div> 1386 <br/> 1387 <div style="font-size: smaller"><b>Sample:</b></div> 1388 <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">['ntp master stratum 2', 'ntp peer 198.51.100.1 use-vrf test maxpoll 7', 'ntp authentication-key 10 md5 wawyhanx2 7', 'ntp access-group peer PeerAcl1', 'ntp access-group peer PeerAcl2', 'ntp access-group query-only QueryAcl1']</div> 1389 </td> 1390 </tr> 1391 </table> 1392 <br/><br/> 1393 1394 1395Status 1396------ 1397 1398 1399Authors 1400~~~~~~~ 1401 1402- Nilashish Chakraborty (@NilashishC) 1403