idnits 2.17.1 draft-ietf-pim-msdp-yang-03.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** There are 9 instances of too long lines in the document, the longest one being 56 characters in excess of 72. ** The document seems to lack a both a reference to RFC 2119 and the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords. RFC 2119 keyword, line 557: '...r connect-retry, SHOULD be set to 30 s...' Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year -- The document date (April 11, 2018) is 2206 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Unused Reference: 'I-D.ietf-netmod-rfc6087bis' is defined on line 995, but no explicit reference was found in the text == Unused Reference: 'RFC4624' is defined on line 1009, but no explicit reference was found in the text == Unused Reference: 'RFC6087' is defined on line 1023, but no explicit reference was found in the text == Unused Reference: 'RFC6991' is defined on line 1041, but no explicit reference was found in the text == Unused Reference: 'RFC7223' is defined on line 1045, but no explicit reference was found in the text == Unused Reference: 'RFC7277' is defined on line 1049, but no explicit reference was found in the text == Unused Reference: 'RFC8022' is defined on line 1053, but no explicit reference was found in the text == Unused Reference: 'RFC8177' is defined on line 1061, but no explicit reference was found in the text ** Downref: Normative reference to an Experimental RFC: RFC 3618 ** Downref: Normative reference to an Experimental RFC: RFC 4624 ** Obsolete normative reference: RFC 5246 (Obsoleted by RFC 8446) ** Obsolete normative reference: RFC 6087 (Obsoleted by RFC 8407) ** Obsolete normative reference: RFC 6536 (Obsoleted by RFC 8341) ** Obsolete normative reference: RFC 7223 (Obsoleted by RFC 8343) ** Obsolete normative reference: RFC 7277 (Obsoleted by RFC 8344) ** Obsolete normative reference: RFC 8022 (Obsoleted by RFC 8349) Summary: 10 errors (**), 0 flaws (~~), 9 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 PIM WG Xufeng. Liu 3 Internet-Draft Jabil 4 Intended status: Standards Track Zheng. Zhang 5 Expires: October 13, 2018 ZTE Corporation 6 Anish. Peter 7 Individual contributor 8 Mahesh. Sivakumar 9 Cisco Systems 10 Feng. Guo 11 Huawei Technologies 12 Pete. McAllister 13 Metaswitch Networks 14 April 11, 2018 16 MSDP YANG Model 17 draft-ietf-pim-msdp-yang-03 19 Abstract 21 This document defines a YANG data model for the configuration and 22 management of MSDP Protocol. 24 Status of This Memo 26 This Internet-Draft is submitted in full conformance with the 27 provisions of BCP 78 and BCP 79. 29 Internet-Drafts are working documents of the Internet Engineering 30 Task Force (IETF). Note that other groups may also distribute 31 working documents as Internet-Drafts. The list of current Internet- 32 Drafts is at https://datatracker.ietf.org/drafts/current/. 34 Internet-Drafts are draft documents valid for a maximum of six months 35 and may be updated, replaced, or obsoleted by other documents at any 36 time. It is inappropriate to use Internet-Drafts as reference 37 material or to cite them other than as "work in progress." 39 This Internet-Draft will expire on October 13, 2018. 41 Copyright Notice 43 Copyright (c) 2018 IETF Trust and the persons identified as the 44 document authors. All rights reserved. 46 This document is subject to BCP 78 and the IETF Trust's Legal 47 Provisions Relating to IETF Documents 48 (https://trustee.ietf.org/license-info) in effect on the date of 49 publication of this document. Please review these documents 50 carefully, as they describe your rights and restrictions with respect 51 to this document. Code Components extracted from this document must 52 include Simplified BSD License text as described in Section 4.e of 53 the Trust Legal Provisions and are provided without warranty as 54 described in the Simplified BSD License. 56 Table of Contents 58 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 59 2. Design of the Data Model . . . . . . . . . . . . . . . . . . 2 60 3. MSDP configuration . . . . . . . . . . . . . . . . . . . . . 4 61 4. MSDP State . . . . . . . . . . . . . . . . . . . . . . . . . 5 62 5. MSDP RPC . . . . . . . . . . . . . . . . . . . . . . . . . . 5 63 6. Notifications . . . . . . . . . . . . . . . . . . . . . . . . 5 64 7. MSDP YANG model . . . . . . . . . . . . . . . . . . . . . . . 5 65 8. Security Considerations . . . . . . . . . . . . . . . . . . . 20 66 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 21 67 10. Contributors . . . . . . . . . . . . . . . . . . . . . . . . 21 68 11. Normative References . . . . . . . . . . . . . . . . . . . . 21 69 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 23 71 1. Introduction 73 [RFC3618] introduces the protocol definition of MSDP. This document 74 defines a YANG data model that can be used to configure and manage 75 the MSDP protocol. The operational state data and statistics can 76 also be retrieved by this model. 78 This model is designed to be used along with other multicast YANG 79 models such as PIM, which are not covered in this document. 81 2. Design of the Data Model 83 This model imports and augments ietf-routing YANG model defined in 84 [RFC8349]. Both configuration branch and state branch of [RFC8349] 85 are augmented. The configuration branch covers global configuration 86 attributes and per peer configuration attributes. The state branch 87 includes global, per peer, and source-active information. The 88 container "msdp" is the top level container in this data model. The 89 presence of this container is expected to enable MSDP protocol 90 functionality. 92 module: ietf-msdp 93 augment /rt:routing/rt:control-plane-protocols: 94 +--rw msdp! 95 +--rw global 96 | +--rw tcp-connection-source? if:interface-ref 97 | +--rw default-peer! {global-default-peer}? 98 | | +--rw peer-addr -> ../../../peers/peer/address 99 | | +--rw prefix-policy? string {global-default-peer-policy}? 100 | +--rw originating-rp 101 | | +--rw interface? if:interface-ref 102 | +--rw sa-filter 103 | | +--rw in? string 104 | | +--rw out? string 105 | +--rw sa-limit? uint32 {global-sa-limit}? 106 | +--rw ttl-threshold? uint8 107 +--rw peers 108 | +--rw peer* [address] 109 | +--rw address inet:ipv4-address 110 | +--rw authentication 111 | | +--rw (authentication-type)? 112 | | +--:(key-chain) {peer-key-chain}? 113 | | | +--rw key-chain? key-chain:key-chain-ref 114 | | +--:(password) 115 | | +--rw key? string 116 | | +--rw crypto-algorithm? identityref 117 | +--rw enable? boolean {peer-admin-enable}? 118 | +--rw tcp-connection-source? if:interface-ref 119 | +--rw description? string {peer-description}? 120 | +--rw mesh-group? string 121 | +--rw peer-as? string {peer-as}? 122 | +--rw sa-filter 123 | | +--rw in? string 124 | | +--rw out? string 125 | +--rw sa-limit? uint32 {peer-sa-limit}? 126 | +--rw timer 127 | | +--rw connect-retry-interval? uint16 128 | | +--rw holdtime-interval? uint16 129 | | +--rw keepalive-interval? uint16 130 | +--rw ttl-threshold? uint8 131 | +--ro session-state? enumeration 132 | +--ro elapsed-time? uint32 133 | +--ro connect-retry-expire? uint32 134 | +--ro hold-expire? uint32 135 | +--ro is-default-peer? boolean 136 | +--ro keepalive-expire? uint32 137 | +--ro reset-count? uint32 138 | +--ro statistics 139 | +--ro discontinuity-time? yang:date-and-time 140 | +--ro error 141 | | +--ro rpf-failure? uint32 142 | +--ro queue 143 | | +--ro size-in? uint32 144 | | +--ro size-out? uint32 145 | +--ro received 146 | | +--ro keepalive? yang:counter64 147 | | +--ro notification? yang:counter64 148 | | +--ro sa-message? yang:counter64 149 | | +--ro sa-response? yang:counter64 150 | | +--ro sa-request? yang:counter64 151 | | +--ro total? yang:counter64 152 | +--ro sent 153 | +--ro keepalive? yang:counter64 154 | +--ro notification? yang:counter64 155 | +--ro sa-message? yang:counter64 156 | +--ro sa-response? yang:counter64 157 | +--ro sa-request? yang:counter64 158 | +--ro total? yang:counter64 159 +--ro sa-cache 160 +--ro entry* [group source-addr] 161 +--ro group inet:ipv4-address 162 +--ro source-addr union 163 +--ro origin-rp* [rp-address] 164 | +--ro rp-address inet:ip-address 165 | +--ro is-local-rp? boolean 166 | +--ro sa-adv-expire? uint32 167 +--ro state-attributes 168 +--ro up-time? uint32 169 +--ro expire? uint32 170 +--ro holddown-interval? uint32 171 +--ro peer-learned-from? inet:ipv4-address 172 +--ro rpf-peer? inet:ipv4-address 174 rpcs: 175 +---x clear-peer 176 | +---w input 177 | +---w peer-address? inet:ipv4-address 178 +---x clear-sa-cache {rpc-clear-sa-cache}? 179 +---w input 180 +---w entry! 181 | +---w group rt-types:ipv4-multicast-group-address 182 | +---w source-addr? rt-types:ipv4-multicast-source-address 183 +---w peer-address? inet:ipv4-address 184 +---w peer-as? inet:as-number 186 3. MSDP configuration 188 MSDP configurations require peer configurations. Several peers may 189 be configured in a mesh-group. The Source-Active information may be 190 filtered by peers. 192 The configuration modeling branch is composed of MSDP global and peer 193 configurations. The two parts are the most important parts of MSDP. 195 Besides the fundamental features of MSDP protocol, several optional 196 features are included in the model. These features help the control 197 of MSDP protocol. The peer features and SA features make the 198 deployment and control easier. The connection parameters can be used 199 to control the TCP connection because MSDP protocol is based on TCP. 200 The authentication features make the protocol more secure. The 201 filter features allow operators to avoid some SA information be 202 forwarded to some peers. 204 4. MSDP State 206 MSDP states are composed of MSDP global state, MSDP peer state, 207 statistics information and Sa-cache information. The statistics 208 information and Sa-cache information helps the operator to retrieve 209 the protocol condition. 211 5. MSDP RPC 213 The part is used to define some useful and ordinary operations of 214 protocol management. Network manager can delete all the information 215 from a given peer by using the clear-peer rpc. And network manager 216 can delete a given SA cache information by clear-sa-cache rpc. 218 6. Notifications 220 No notification is defined in this model. 222 7. MSDP YANG model 224 file "ietf-msdp@2018-04-11.yang" 225 module ietf-msdp { 227 yang-version 1.1; 229 namespace "urn:ietf:params:xml:ns:yang:ietf-msdp"; 230 prefix msdp; 232 import ietf-yang-types { 233 prefix "yang"; 234 reference "RFC6991"; 235 } 237 import ietf-inet-types { 238 prefix "inet"; 239 reference "RFC6991"; 241 } 243 import ietf-routing { 244 prefix "rt"; 245 reference "RFC8022"; 246 } 248 import ietf-interfaces { 249 prefix "if"; 250 reference "RFC7223"; 251 } 253 import ietf-ip { 254 prefix "ip"; 255 reference "RFC7277"; 256 } 258 import ietf-key-chain { 259 prefix "key-chain"; 260 reference "RFC8177"; 261 } 263 import ietf-routing-types { 264 prefix "rt-types"; 265 reference "RFC8294"; 266 } 268 organization 269 "IETF PIM(Protocols for IP Multicast) Working Group"; 271 contact 272 "WG Web: 273 WG List: 275 Editor: Xufeng Liu 276 278 Editor: Zheng Zhang 279 281 Editor: Anish Peter 282 284 Editor: Mahesh Sivakumar 285 287 Editor: Feng Guo 288 "; 290 description 291 "The module defines the YANG definitions for MSDP. 293 Copyright (c) 2018 IETF Trust and the persons 294 identified as authors of the code. All rights reserved. 296 Redistribution and use in source and binary forms, with or 297 without modification, is permitted pursuant to, and subject 298 to the license terms contained in, the Simplified BSD License 299 set forth in Section 4.c of the IETF Trust's Legal Provisions 300 Relating to IETF Documents 301 (http://trustee.ietf.org/license-info). 302 This version of this YANG module is part of RFC 3618; see 303 the RFC itself for full legal notices."; 305 revision 2018-02-11 { 306 description 307 "Initial revision."; 308 reference 309 "RFC XXXX: A YANG Data Model for MSDP. 310 RFC 3618: Multicast Source Discovery Protocol (MSDP). 311 RFC 4624: Multicast Source Discovery Protocol (MSDP) MIB"; 312 } 314 /* 315 * Features 316 */ 317 feature global-connect-source { 318 description 319 "Support configuration of global connect-source."; 320 } 322 feature global-default-peer { 323 description 324 "Support configuration of global default peer."; 325 } 327 feature global-default-peer-policy { 328 description 329 "Support policy configuration of global default peer."; 330 } 332 feature global-sa-filter { 333 description 334 "Support configuration of global SA filter."; 335 } 337 feature global-sa-limit { 338 description 339 "Support configuration of global limit on SA entries."; 340 } 342 feature global-ttl-threshold { 343 description 344 "Support configuration of global ttl-threshold."; 345 } 347 feature rpc-clear-sa-cache { 348 description 349 "Support the rpc to clear SA cache."; 350 } 352 feature peer-admin-enable { 353 description 354 "Support configuration of peer administrative enabling."; 355 } 357 feature peer-as { 358 description 359 "Support configuration of peer AS number."; 360 } 362 feature peer-connect-source { 363 description 364 "Support configuration of global connect-source."; 365 } 367 feature peer-description { 368 description 369 "Support configuration of peer description."; 370 } 372 feature peer-key-chain { 373 description 374 "Support configuration of peer key-chain."; 375 } 377 feature peer-password { 378 description 379 "Support configuration of peer password."; 380 } 382 feature peer-sa-limit { 383 description 384 "Support configuration of per peer limit on SA entries."; 385 } 386 /* 387 * Groupings 388 */ 389 grouping authentication-container { 390 description 391 "A container defining authentication attributes."; 392 container authentication { 393 description 394 "A container defining authentication attributes."; 395 choice authentication-type { 396 case key-chain { 397 if-feature peer-key-chain; 398 leaf key-chain { 399 type key-chain:key-chain-ref; 400 description 401 "Reference to a key-chain."; 402 } 403 } 404 case password { 405 leaf key { 406 type string; 407 description 408 "This leaf describes the authentication key."; 409 } 410 leaf crypto-algorithm { 411 type identityref { 412 base key-chain:crypto-algorithm; 413 } 414 description 415 "Cryptographic algorithm associated with key."; 416 } 417 } 418 description 419 "Choice of authentication."; 420 } 421 } 422 } // authentication-container 424 grouping connect-source { 425 description "Attribute to configure peer tcp connection source."; 426 leaf tcp-connection-source { 427 type if:interface-ref; 428 must "/if:interfaces/if:interface[if:name = current()]/" 429 + "ip:ipv4" { 430 description 431 "The interface must have IPv4 enabled."; 432 } 433 description 434 "The interface is to be the source for the TCP connection. 435 It is a reference to an entry in the global interface 436 list."; 437 } 438 } // tcp-connection-source 440 grouping global-config-attributes { 441 description "Global MSDP configuration."; 443 uses connect-source { 444 if-feature global-connect-source; 445 } 446 container default-peer { 447 if-feature global-default-peer; 448 presence "Present if the default peer is configured."; 449 description 450 "The default peer accepts all MSDP SA messages. 451 A default peer is needed in topologies where MSDP peers do 452 not coexist with BGP peers. The reverse path forwarding 453 (RPF) check on SA messages can fail, and no SA messages are 454 accepted. In these cases, you can configure the peer as a 455 default peer and bypass RPF checks."; 456 leaf peer-addr { 457 type leafref { 458 path "../../../peers/peer/address"; 459 } 460 mandatory true; 461 description 462 "Reference to a peer that is in the peer list."; 463 } 464 leaf prefix-policy { 465 if-feature global-default-peer-policy; 466 type string; 467 description 468 "If specified, only those SA entries whose RP is permitted 469 in the prefix list are allowed; 470 if not specified, all SA messages from the default peer 471 are accepted."; 472 } 473 } // default-peer 475 container originating-rp { 476 description 477 "The container of originating-rp."; 478 leaf interface { 479 type if:interface-ref; 480 must "/if:interfaces/if:interface[if:name = current()]/" 481 + "ip:ipv4" { 482 description 483 "The interface must have IPv4 enabled."; 484 } 485 description 486 "Reference to an entry in the global interface 487 list. 488 IP address of the interface is used in the RP field of an 489 SA message entry. When Anycast RPs are used, all RPs use 490 the same IP address. This parameter can be used to define 491 a unique IP address for the RP of each MSDP peer. 492 By default, the software uses the RP address of the 493 local system."; 494 } 495 } // originating-rp 497 uses sa-filter-container { 498 if-feature global-sa-filter; 499 } 500 leaf sa-limit { 501 if-feature global-sa-limit; 502 type uint32; 503 description 504 "A limit on the number of SA entries accepted. By default, 505 there is no limit."; 506 } 507 uses ttl-threshold { 508 if-feature global-ttl-threshold; 509 } 510 } // global-config-attributes 512 grouping peer-config-attributes { 513 description "Per peer configuration for MSDP."; 515 uses authentication-container; 516 leaf enable { 517 if-feature peer-admin-enable; 518 type boolean; 519 description 520 "true to enable peer; 521 false to disable peer."; 522 } 523 uses connect-source { 524 if-feature peer-connect-source; 525 } 526 leaf description { 527 if-feature peer-description; 528 type string; 529 description 530 "The peer description."; 531 } 532 leaf mesh-group { 533 type string; 534 description 535 "Configure this peer to be a member of a mesh group"; 536 } 537 leaf peer-as { 538 if-feature peer-as; 539 type string; 540 description 541 "Peer's autonomous system number (ASN). Using peer-as to do verification can provide more controlled ability."; 542 } 543 uses sa-filter-container; 544 leaf sa-limit { 545 if-feature peer-sa-limit; 546 type uint32; 547 description 548 "A limit on the number of SA entries accepted from this peer. 549 By default, there is no limit."; 550 } 551 container timer { 552 description "Timer attributes."; 553 leaf connect-retry-interval { 554 type uint16; 555 units seconds; 556 default 30; 557 description "Peer timer for connect-retry, SHOULD be set to 30 seconds. "; 558 } 559 leaf holdtime-interval { 560 type uint16; 561 units seconds; 562 must ". > 3"; 563 default 75; 564 description "The SA-Hold-Down-Period of this MSDP peer."; 565 } 566 leaf keepalive-interval { 567 type uint16; 568 units seconds; 569 must ". > 1 and . < ../holdtime-interval"; 570 default 60; 571 description "The keepalive timer of this MSDP peer."; 572 } 573 } // timer 574 uses ttl-threshold; 575 } // peer-config-attributes 577 grouping peer-state-attributes { 578 description "Per peer state attributes for MSDP."; 580 leaf session-state { 581 type enumeration { 582 enum disabled { 583 description "Disabled."; 584 } 585 enum inactive { 586 description "Inactive."; 587 } 588 enum listen { 589 description "Listen."; 590 } 591 enum connecting { 592 description "Connecting."; 593 } 594 enum established { 595 description "Established."; 596 } 597 } 598 config false; 599 description 600 "Peer session state."; 601 reference 602 "RFC3618: Multicast Source Discovery Protocol (MSDP)."; 603 } 604 leaf elapsed-time { 605 type uint32; 606 units seconds; 607 config false; 608 description "Elapsed time for being in a state."; 609 } 610 leaf connect-retry-expire { 611 type uint32; 612 units seconds; 613 config false; 614 description "Connect retry expire time of peer connection."; 615 } 616 leaf hold-expire { 617 type uint32; 618 units seconds; 619 config false; 620 description "Hold expire time of peer connection."; 621 } 622 leaf is-default-peer { 623 type boolean; 624 config false; 625 description "If this peer is default peer."; 627 } 628 leaf keepalive-expire { 629 type uint32; 630 units seconds; 631 config false; 632 description "Keepalive expire time of this peer."; 633 } 634 leaf reset-count { 635 type uint32; 636 config false; 637 description "The reset count of this peer."; 638 } 640 container statistics { 641 config false; 642 description 643 "A container defining statistics attributes."; 645 leaf discontinuity-time { 646 type yang:date-and-time; 647 description 648 "The time on the most recent occasion at which any one 649 or more of the statistic counters suffered a 650 discontinuity. If no such discontinuities have occurred 651 since the last re-initialization of the local 652 management subsystem, then this node contains the time 653 the local management subsystem re-initialized itself."; 654 } 656 container error { 657 description 658 "A grouping defining error statistics 659 attributes."; 660 leaf rpf-failure { 661 type uint32; 662 description "Number of RPF failures."; 663 } 664 } // statistics-error 666 container queue { 667 description 668 "A container includes queue statistics 669 attributes."; 670 leaf size-in { 671 type uint32; 672 description 673 "The size of the input queue."; 674 } 675 leaf size-out { 676 type uint32; 677 description 678 "The size of the output queue."; 679 } 680 } // statistics-queue 682 container received { 683 description "Received message counters."; 684 uses statistics-sent-received; 685 } 686 container sent { 687 description "Sent message counters."; 688 uses statistics-sent-received; 689 } 690 } // statistics-container 691 } // peer-state-attributes 693 grouping sa-filter-container { 694 description "A container defining SA filters."; 695 container sa-filter { 696 description 697 "Specifies an access control list (ACL) to filter source 698 active (SA) messages coming in to or going out of the 699 peer."; 700 leaf in { 701 type string; 702 description 703 "Filters incoming SA messages only."; 704 } 705 leaf out { 706 type string; 707 description 708 "Filters outgoing SA messages only."; 709 } 710 } // sa-filter 711 } // sa-filter-container 713 grouping ttl-threshold { 714 description "Attribute to configure TTL threshold."; 715 leaf ttl-threshold { 716 type uint8 { 717 range 1..255; 718 } 719 description 720 "Maximum number of hops data packets can traverse before 721 being dropped."; 722 } 724 } // sa-ttl-threshold 726 grouping statistics-sent-received { 727 description 728 "A grouping defining sent and received statistics 729 attributes."; 730 leaf keepalive { 731 type yang:counter64; 732 description 733 "The number of keepalive messages."; 734 } 735 leaf notification { 736 type yang:counter64; 737 description 738 "The number of notification messages."; 739 } 740 leaf sa-message { 741 type yang:counter64; 742 description 743 "The number of SA messages."; 744 } 745 leaf sa-response { 746 type yang:counter64; 747 description 748 "The number of SA response messages."; 749 } 750 leaf sa-request { 751 type yang:counter64; 752 description 753 "The number of SA request messages."; 754 } 755 leaf total { 756 type yang:counter64; 757 description 758 "The number of total messages."; 759 } 760 } // statistics-sent-received 762 /* 763 * Data nodes 764 */ 765 augment "/rt:routing/rt:control-plane-protocols" { 766 description 767 "MSDP augmentation to routing instance. This augmentation is only valid for a routing protocol instance of MSDP."; 769 container msdp { 770 presence "Container for MSDP protocol."; 771 description 772 "MSDP configuration data."; 774 container global { 775 description 776 "Global attributes."; 777 uses global-config-attributes; 778 } 780 container peers { 781 description 782 "Containing a list of peers."; 783 list peer { 784 key "address"; 785 description 786 "List of MSDP peers."; 787 leaf address { 788 type inet:ipv4-address; 789 description 790 "The address of peer"; 791 } 792 uses peer-config-attributes; 793 uses peer-state-attributes; 794 } // peer 795 } // peers 797 container sa-cache { 798 config false; 799 description 800 "The sa cache information."; 801 list entry { 802 key "group source-addr"; 803 description "A list of sa cache entries."; 804 leaf group { 805 type inet:ipv4-address; 806 description "The group address of this sa cache."; 807 } 808 leaf source-addr { 809 type union { 810 type enumeration { 811 enum '*' { 812 description "Any source address."; 813 } 814 } 815 type inet:ipv4-address; 816 } 817 description "Source IPv4 address."; 818 } 819 list origin-rp { 820 key "rp-address"; 821 description 822 "Origin RP address."; 823 leaf rp-address { 824 type inet:ip-address; 825 description "The RP address."; 826 } 827 leaf is-local-rp { 828 type boolean; 829 description "The RP is local."; 830 } 831 leaf sa-adv-expire { 832 type uint32; 833 units seconds; 834 description 835 "Periodic SA advertisement timer exipiring time on 836 a local RP."; 837 } 838 } 840 container state-attributes { 841 description "SA cache state attributes for MSDP."; 843 leaf up-time { 844 type uint32; 845 units seconds; 846 description "The duration time of receiving this SA cache."; 847 } 848 leaf expire { 849 type uint32; 850 units seconds; 851 description "The duration time since this SA cache expires."; 852 } 853 leaf holddown-interval { 854 type uint32; 855 units seconds; 856 description "Holddown timer value for SA forwarding."; 857 } 858 leaf peer-learned-from { 859 type inet:ipv4-address; 860 description 861 "The address of the peer that we learned this SA from."; 862 } 863 leaf rpf-peer { 864 type inet:ipv4-address; 865 description "The address is used to find the SA's originating RP."; 866 } 867 } // sa-cache-state-attributes 869 } // entry 870 } // sa-cache 871 } // msdp 872 } // augment 874 /* 875 * RPCs 876 */ 877 rpc clear-peer { 878 description 879 "Clears the TCP connection to the peer."; 880 input { 881 leaf peer-address { 882 type inet:ipv4-address; 883 description 884 "Address of peer to be cleared. If this is not provided 885 then all peers are cleared."; 886 } 887 } 888 } 890 rpc clear-sa-cache { 891 if-feature rpc-clear-sa-cache; 892 description 893 "Clears MSDP source active (SA) cache entries."; 894 input { 895 container entry { 896 presence "Present if a particular is cleared."; 897 description 898 "The SA cache (S,G) or (*,G) entry to be cleared. If this 899 is not provided, all entries are cleared."; 900 leaf group { 901 type rt-types:ipv4-multicast-group-address; 902 mandatory true; 903 description "The group address"; 904 } 905 leaf source-addr { 906 type rt-types:ipv4-multicast-source-address; 907 description "Address of multicast source to be cleared. If this is not provided 908 then all entries related to the given group are cleared."; 909 } 910 } // s-g 911 leaf peer-address { 912 type inet:ipv4-address; 913 description 914 "Peer IP address from which MSDP SA cache entries have been 915 learned. If this is not provided, entries learned from all 916 peers are cleared."; 918 } 919 leaf peer-as { 920 type inet:as-number; 921 description 922 "ASN from which MSDP SA cache entries have been learned. 923 If this is not provided, entries learned from all AS's 924 are cleared."; 925 } 926 } 927 } 928 } 929 931 8. Security Considerations 933 The YANG module specified in this document defines a schema for data 934 that is designed to be accessed via network management protocols such 935 as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer 936 is the secure transport layer, and the mandatory-to-implement secure 937 transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer 938 is HTTPS, and the mandatory-to-implement secure transport is TLS 939 [RFC5246]. 941 The NETCONF access control model [RFC6536] provides the means to 942 restrict access for particular NETCONF or RESTCONF users to a 943 preconfigured subset of all available NETCONF or RESTCONF protocol 944 operations and content. 946 There are a number of data nodes defined in this YANG module that are 947 writable/creatable/deletable (i.e., config true, which is the 948 default). These data nodes may be considered sensitive or vulnerable 949 in some network environments. Write operations (e.g., edit-config) 950 to these data nodes without proper protection can have a negative 951 effect on network operations. For MSDP, the ability to modify MSDP 952 configuration will allow the unexpected MSDP peer establishment and 953 unexpected SA information learning and advertisement. The "password" 954 field is also a sensitive readable configuration, the unauthorized 955 reading function may lead to the password leaking. The security 956 considerations of MSDP [RFC3618] are applicable. 958 The RPC operations in this YANG module may be considered sensitive or 959 vulnerable in some network environments. It is thus important to 960 control access to these operations. The MSDP Yang module supports 961 the "clear-peer" and "clear-sa-cache" RPCs. If access to either of 962 these is compromised, they can result in unexpected MSDP peer 963 breakdown and unexpected SA information deletion. 965 9. IANA Considerations 967 The IANA is requested to assign two new URIs from the IETF XML 968 registry ([RFC3688]). Authors are suggesting the following URI: 970 URI: urn:ietf:params:xml:ns:yang:ietf-msdp 972 Registrant Contact: PIM WG 974 XML: N/A, the requested URI is an XML namespace 976 This document also requests one new YANG module name in the YANG 977 Module Names registry ([RFC6020]) with the following suggestion: 979 name: ietf-msdp 981 namespace: urn:ietf:params:xml:ns:yang:ietf-msdp 983 prefix: msdp 985 reference: RFC XXXX 987 10. Contributors 989 The authors would like to thank Yisong Liu (liuyisong@huawei.com), 990 Benchong Xu (xu.benchong@zte.com.cn), Tanmoy Kundu 991 (tanmoy.kundu@alcatel-lucent.com) for their valuable contributions. 993 11. Normative References 995 [I-D.ietf-netmod-rfc6087bis] 996 Bierman, A., "Guidelines for Authors and Reviewers of YANG 997 Data Model Documents", draft-ietf-netmod-rfc6087bis-20 998 (work in progress), March 2018. 1000 [RFC3618] Fenner, B., Ed. and D. Meyer, Ed., "Multicast Source 1001 Discovery Protocol (MSDP)", RFC 3618, 1002 DOI 10.17487/RFC3618, October 2003, 1003 . 1005 [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, 1006 DOI 10.17487/RFC3688, January 2004, 1007 . 1009 [RFC4624] Fenner, B. and D. Thaler, "Multicast Source Discovery 1010 Protocol (MSDP) MIB", RFC 4624, DOI 10.17487/RFC4624, 1011 October 2006, . 1013 [RFC5246] Dierks, T. and E. Rescorla, "The Transport Layer Security 1014 (TLS) Protocol Version 1.2", RFC 5246, 1015 DOI 10.17487/RFC5246, August 2008, 1016 . 1018 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 1019 the Network Configuration Protocol (NETCONF)", RFC 6020, 1020 DOI 10.17487/RFC6020, October 2010, 1021 . 1023 [RFC6087] Bierman, A., "Guidelines for Authors and Reviewers of YANG 1024 Data Model Documents", RFC 6087, DOI 10.17487/RFC6087, 1025 January 2011, . 1027 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 1028 and A. Bierman, Ed., "Network Configuration Protocol 1029 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 1030 . 1032 [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure 1033 Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011, 1034 . 1036 [RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration 1037 Protocol (NETCONF) Access Control Model", RFC 6536, 1038 DOI 10.17487/RFC6536, March 2012, 1039 . 1041 [RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types", 1042 RFC 6991, DOI 10.17487/RFC6991, July 2013, 1043 . 1045 [RFC7223] Bjorklund, M., "A YANG Data Model for Interface 1046 Management", RFC 7223, DOI 10.17487/RFC7223, May 2014, 1047 . 1049 [RFC7277] Bjorklund, M., "A YANG Data Model for IP Management", 1050 RFC 7277, DOI 10.17487/RFC7277, June 2014, 1051 . 1053 [RFC8022] Lhotka, L. and A. Lindem, "A YANG Data Model for Routing 1054 Management", RFC 8022, DOI 10.17487/RFC8022, November 1055 2016, . 1057 [RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF 1058 Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017, 1059 . 1061 [RFC8177] Lindem, A., Ed., Qu, Y., Yeung, D., Chen, I., and J. 1062 Zhang, "YANG Data Model for Key Chains", RFC 8177, 1063 DOI 10.17487/RFC8177, June 2017, 1064 . 1066 [RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for 1067 Routing Management (NMDA Version)", RFC 8349, 1068 DOI 10.17487/RFC8349, March 2018, 1069 . 1071 Authors' Addresses 1073 Xufeng Liu 1074 Jabil 1075 8281 Greensboro Drive, Suite 200 1076 McLean VA 22102 1077 USA 1079 Email: xufeng.liu.ietf@gmail.com 1081 Zheng Zhang 1082 ZTE Corporation 1083 No. 50 Software Ave, Yuhuatai Distinct 1084 Nanjing 1085 China 1087 Email: zhang.zheng@zte.com.cn 1089 Anish Peter 1090 Individual contributor 1092 Email: anish.ietf@gmail.com 1094 Mahesh Sivakumar 1095 Cisco Systems 1096 510 McCarthy Boulevard 1097 Milpitas, California 1098 USA 1100 Email: masivaku@cisco.com 1101 Feng Guo 1102 Huawei Technologies 1103 Huawei Bld., No.156 Beiqing Rd. 1104 Beijing 100095 1105 China 1107 Email: guofeng@huawei.com 1109 Pete McAllister 1110 Metaswitch Networks 1111 100 Church Street 1112 Enfield EN2 6BQ 1113 UK 1115 Email: pete.mcallister@metaswitch.com