idnits 2.17.1 draft-ietf-mboned-multicast-yang-model-01.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 : ---------------------------------------------------------------------------- ** The document seems to lack a Security Considerations section. ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) ** There are 50 instances of too long lines in the document, the longest one being 38 characters in excess of 72. == There are 1 instance of lines with multicast IPv4 addresses in the document. If these are generic example addresses, they should be changed to use the 233.252.0.x range defined in RFC 5771 Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == Line 224 has weird spacing: '...ss-node ine...' == Line 229 has weird spacing: '...ss-node bie...' -- The document date (February 27, 2019) is 1884 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-bier-bier-yang' is defined on line 936, but no explicit reference was found in the text == Unused Reference: 'I-D.ietf-bier-te-arch' is defined on line 942, but no explicit reference was found in the text == Unused Reference: 'I-D.ietf-pim-yang' is defined on line 948, but no explicit reference was found in the text == Unused Reference: 'RFC6020' is defined on line 954, but no explicit reference was found in the text == Unused Reference: 'RFC6037' is defined on line 959, but no explicit reference was found in the text == Unused Reference: 'RFC6087' is defined on line 964, but no explicit reference was found in the text == Unused Reference: 'RFC6241' is defined on line 968, but no explicit reference was found in the text == Unused Reference: 'RFC6513' is defined on line 973, but no explicit reference was found in the text == Unused Reference: 'RFC7223' is defined on line 977, but no explicit reference was found in the text == Unused Reference: 'RFC7277' is defined on line 981, but no explicit reference was found in the text == Unused Reference: 'RFC8177' is defined on line 985, but no explicit reference was found in the text == Unused Reference: 'RFC8279' is defined on line 990, but no explicit reference was found in the text == Unused Reference: 'RFC8294' is defined on line 996, but no explicit reference was found in the text == Unused Reference: 'RFC8349' is defined on line 1001, but no explicit reference was found in the text == Outdated reference: A later version (-08) exists of draft-ietf-bier-bier-yang-04 == Outdated reference: A later version (-13) exists of draft-ietf-bier-te-arch-01 ** Downref: Normative reference to an Historic RFC: RFC 6037 ** Obsolete normative reference: RFC 6087 (Obsoleted by RFC 8407) ** Obsolete normative reference: RFC 7223 (Obsoleted by RFC 8343) ** Obsolete normative reference: RFC 7277 (Obsoleted by RFC 8344) Summary: 7 errors (**), 0 flaws (~~), 20 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 MBONED WG Zheng. Zhang 3 Internet-Draft Cui. Wang 4 Intended status: Standards Track ZTE Corporation 5 Expires: August 31, 2019 Ying. Cheng 6 China Unicom 7 Xufeng. Liu 8 Volta Networks 9 Mahesh. Sivakumar 10 Juniper networks 11 February 27, 2019 13 Multicast YANG Data Model 14 draft-ietf-mboned-multicast-yang-model-01 16 Abstract 18 This document intents to provide a general and all-round multicast 19 YANG data model, which tries to stand at a high level to take full 20 advantages of existed multicast protocol models to control the 21 multicast network, and guides the deployment of multicast service. 22 And also, there will define several possible RPCs about how to 23 interact between multicast YANG data model and multicast protocol 24 models. This multicast YANG data model is mainly used by the 25 management tools run by the network operators in order to manage, 26 monitor and debug the network resources used to deliver multicast 27 service, as well as gathering some data from the network. 29 Status of This Memo 31 This Internet-Draft is submitted in full conformance with the 32 provisions of BCP 78 and BCP 79. 34 Internet-Drafts are working documents of the Internet Engineering 35 Task Force (IETF). Note that other groups may also distribute 36 working documents as Internet-Drafts. The list of current Internet- 37 Drafts is at https://datatracker.ietf.org/drafts/current/. 39 Internet-Drafts are draft documents valid for a maximum of six months 40 and may be updated, replaced, or obsoleted by other documents at any 41 time. It is inappropriate to use Internet-Drafts as reference 42 material or to cite them other than as "work in progress." 44 This Internet-Draft will expire on August 31, 2019. 46 Copyright Notice 48 Copyright (c) 2019 IETF Trust and the persons identified as the 49 document authors. All rights reserved. 51 This document is subject to BCP 78 and the IETF Trust's Legal 52 Provisions Relating to IETF Documents 53 (https://trustee.ietf.org/license-info) in effect on the date of 54 publication of this document. Please review these documents 55 carefully, as they describe your rights and restrictions with respect 56 to this document. Code Components extracted from this document must 57 include Simplified BSD License text as described in Section 4.e of 58 the Trust Legal Provisions and are provided without warranty as 59 described in the Simplified BSD License. 61 Table of Contents 63 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2 64 2. Design of the multicast model . . . . . . . . . . . . . . . . 4 65 3. UML Class like Diagram for Multicast YANG data Model . . . . 4 66 4. Model Structure . . . . . . . . . . . . . . . . . . . . . . . 5 67 5. Multicast YANG data Model . . . . . . . . . . . . . . . . . . 7 68 6. Notifications . . . . . . . . . . . . . . . . . . . . . . . . 20 69 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 20 70 8. Normative References . . . . . . . . . . . . . . . . . . . . 20 71 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 22 73 1. Introduction 75 Currently, there are many multicast protocol YANG models, such as 76 PIM, MLD, and BIER and so on. But all these models are distributed 77 in different working groups as separate files and focus on the 78 protocol itself. Furthermore, they cannot describe a high-level 79 multicast service required by network operators. 81 This document intents to provide a general and all-round multicast 82 model, which tries to stand at a high level to take full advantages 83 of these aforementioned models to control the multicast network, and 84 guides the deployment of multicast service. 86 This multicast YANG data model is mainly used by the management tools 87 run by the network operators in order to manage, monitor and debug 88 the network resources used to deliver multicast service, as well as 89 gathering some data from the network. 91 +------------------------+ 92 | Multicast Model | 93 +------------------------+ 94 | | | 95 | | | 96 | +---------+ +----------+ 97 | | EMS/NMS | |Controller| 98 | +---------+ +----------+ 99 | | | 100 | | | 101 +------------------------------------------------+ 102 | Network Element1.....N | 103 +------------------------------------------------+ 105 Figure 1: Example usage of Multicast Model 107 Detailly, in figure 1, there is an example of usage of this multicast 108 model. Network operators can use this model in a controller who is 109 responsible to implement some multicast flows with specific protocols 110 and invoke the corresponding protocols' model to configure the 111 network elements through NETCONF/RESTCONF/CLI. Or network operators 112 can use this model to the EMS/NMS to manage the network elements or 113 configure the network elements directly. For example, a multicast 114 service need to be delopy in a network, supposed that the multicast 115 flow is 239.0.0.0/8, the flow should be transport by BIER technology. 116 Then we use this multicast YANG data model and set the correspond key 117 (239.0.0.0) and associated transport technology with BIER, send the 118 model from controller to every egde node in the network. Then there 119 is an interaction among all the nodes to exchange the multicast flow 120 information. The ingress node will encapsulate the multicast flow 121 with BIER header and send it into the network. Intermediate nodes 122 will forward the flows to all the egress nodes by BIER forwarding. 124 On the other hand, when the network elements detect failure or some 125 other changes, the network devices can send the affected multicast 126 flows and the associated overlay/ transport/ underlay information to 127 the controller. Then the controller/ EMS/NMS can response 128 immediately due to the failure and distribute new model for the flows 129 to the network nodes quickly. Such as the changing of the failure 130 overlay protocol to another one, as well as transport and underlay 131 protocol. 133 Specifically, in section 3, it provides a human readability of the 134 whole multicast network through UML like class diagram, which frames 135 different multicast components and correlates them in a readable 136 fashion. Then, based on this UML like class diagram, there is 137 instantiated and detailed YANG model in Section 5. 139 In other words, this document does not define any specific protocol 140 model, instead, it depends on many existed multicast protocol models 141 and relates several multicast information together to fulfill 142 multicast service. 144 2. Design of the multicast model 146 This model includes multicast service keys and three layers: the 147 multicast overlay, the transport layer and the multicast underlay 148 information. Multicast keys include the features of multicast flow, 149 such as(vpnid, multicast source and multicast group) information. In 150 data center network, for fine-grained to gather the nodes belonging 151 to the same virtual network, there may need VNI-related information 152 to assist. 154 Multicast overlay defines (ingress-node, egress-nodes) nodes 155 information. If the transport layer is BIER, there may define BIER 156 information including (Subdomain, ingress-node BFR-id, egress-nodes 157 BFR-id). If no (ingress-node, egress-nodes) information are defined 158 directly, there may need overlay multicast signaling technology, such 159 as MLD or MVPN, to collect these nodes information. 161 Multicast transport layer defines the type of transport technologies 162 that can be used to forward multicast flow, including BIER forwarding 163 type, MPLS forwarding type, or PIM forwarding type and so on. One or 164 several transport technologies could be defined at the same time. As 165 for the detailed parameters for each transport technology, this 166 multicast YANG data model can invoke the corresponding protocol model 167 to define them. 169 Multicast underlay defines the type of underlay technologies, such as 170 OSPF, ISIS, BGP, PIM or BABEL and so on. One or several underlay 171 technologies could be defined at the same time if there is protective 172 requirement. As for the specific parameters for each underlay 173 technology, this multicast YANG data model can depend the 174 corresponding protocol model to configure them as well. 176 3. UML Class like Diagram for Multicast YANG data Model 178 The following is a UML like diagram for Multicast YANG data Model. 180 +-------------------+ 181 | Multicast Model | 182 +-------------------+ 183 | | | |Contain 184 +-----------------------------------------+ | | | 185 | +----------------- -+ | +---------------------------+ 186 | | | | 187 +-----------+ +-------------------+ +----------------------+ +--------------------+ 188 |Multi-keys | | Multicast Overlay | | Multicast Transport | | Multicast Underlay | 189 +-----------+ +-------------------+ +----------------------+ +--------------------+ 190 |Group Addr | | |Contain | | | | | invoke | | | | | invoke 191 +-----------+ +--------+ +-------+ +----+ | | | +----+ +----+ | | | +----+ 192 |Source Addr| | | | | | | | | | | | | 193 +-----------+ +------------+ +--------------+ +-----+ | | | +------+ +------+ | | | +------+ 194 |VPN Info | |Overlay Tech| | Ing/Eg Nodes | | PIM | | | | | MPLS | | OSPF | | | | | PIM | 195 +-----------+ +------------+ +--------------+ +-----+ | | | +------+ +------+ | | | +------+ 196 |VNI Info | | MLD | |Ingress Nodes | +----+ | +-----+ +----+ | +-----+ 197 +-----------+ +------------+ +--------------+ | | | | | | 198 | MVPN | |Egress Nodes | +----------+ | +--------+ +-----+ | +------+ 199 +------------+ +--------------+ |Cisco Mode| | |BIER-TE | |BABEL| | | BGP | 200 | BGP | | relate +----------+ | +--------+ +-----+ | +------+ 201 +------------+ \|/ +----+ +----+ 202 |MLD-Snooping| +----------------+ | | 203 +------------+ | BIER Nodes Info| +------+ +------+ 204 +----------------+ | BIER | | ISIS | 205 | BFR-ID | +------+ +------+ 206 +----------------+ 208 Figure 2: UML like Class Diagram for Multicast YANG data Model 210 4. Model Structure 212 module: ietf-multicast-model 213 +--rw multicast-model 214 +--rw multicast-keys* [vpn-rd source-address group-address vni-type vni-value] 215 +--rw vpn-rd rt-types:route-distinguisher 216 +--rw source-address ip-multicast-source-address 217 +--rw group-address rt-types:ip-multicast-group-address 218 +--rw vni-type virtual-type 219 +--rw vni-value uint32 220 +--rw multicast-overlay 221 | +--rw ingress-egress 222 | | +--rw ingress-node? inet:ip-address 223 | | +--rw egress-nodes* [egress-node] 224 | | +--rw egress-node inet:ip-address 225 | +--rw bier-ids 226 | | +--rw sub-domain? bier:sub-domain-id 227 | | +--rw ingress-node? bier:bfr-id 228 | | +--rw egress-nodes* [egress-node] 229 | | +--rw egress-node bier:bfr-id 230 | +--rw overlay-tech-type? enumeration 231 +--rw multicast-transport 232 | +--rw bier 233 | | +--rw sub-domain? bier:sub-domain-id 234 | | +--rw (encap-type)? 235 | | | +--:(mpls) 236 | | | +--:(eth) 237 | | | +--:(ipv6) 238 | | +--rw bitstringlength? bier:bsl 239 | | +--rw set-identifier? bier:si 240 | | +--rw ecmp? boolean 241 | | +--rw frr? boolean 242 | +--rw bier-te 243 | | +--rw sub-domain? bier:sub-domain-id 244 | | +--rw (encap-type)? 245 | | | +--:(mpls) 246 | | | +--:(non-mpls) 247 | | +--rw bitstringlength? bier:bsl 248 | | +--rw set-identifier? bier:si 249 | | +--rw ecmp? boolean 250 | | +--rw frr? boolean 251 | +--rw cisco-mode 252 | | +--rw p-group? rt-types:ip-multicast-group-address 253 | | +--rw graceful-restart? boolean 254 | | +--rw bfd? boolean 255 | +--rw mpls 256 | | +--rw (mpls-tunnel-type)? 257 | | +--:(mldp) 258 | | | +--rw mldp-tunnel-id? uint32 259 | | | +--rw mldp-frr? boolean 260 | | | +--rw mldp-backup-tunnel? boolean 261 | | +--:(p2mp-te) 262 | | +--rw te-tunnel-id? uint32 263 | | +--rw te-frr? boolean 264 | | +--rw te-backup-tunnel? boolean 265 | +--rw pim 266 | +--rw graceful-restart? boolean 267 | +--rw bfd? boolean 268 +--rw multicast-underlay 269 +--rw underlay-requirement? boolean 270 +--rw bgp 271 +--rw ospf 272 | +--rw topology-id? uint8 273 +--rw isis 274 | +--rw topology-id? uint16 275 +--rw babel 277 notifications: 278 +---n head-end-event 279 +--ro event-type? enumeration 280 +--ro multicast-key 281 | +--ro vpn-rd? rt-types:route-distinguisher 282 | +--ro source-address? ip-multicast-source-address 283 | +--ro group-address? rt-types:ip-multicast-group-address 284 | +--ro vni-type? virtual-type 285 | +--ro vni-value? uint32 286 +--ro overlay-tech-type? enumeration 287 +--ro transport-tech? enumeration 288 +--ro underlay-tech? enumeration 290 5. Multicast YANG data Model 292 file "ietf-multicast-model.yang" 293 module ietf-multicast-model { 295 yang-version 1.1; 297 namespace "urn:ietf:params:xml:ns:yang:ietf-multicast-model"; 298 prefix multicast-model; 300 import ietf-inet-types { 301 prefix "inet"; 302 reference "RFC6991"; 303 } 305 import ietf-routing-types { 306 prefix rt-types; 307 reference "RFC8294"; 308 } 310 import ietf-bier { 311 prefix bier; 312 } 314 organization " IETF MBONED( MBONE Deployment ) Working Group"; 315 contact 316 "WG List: 318 Editor: Zheng Zhang 319 320 Editor: Cui Wang 321 322 Editor: Ying Cheng 323 324 Editor: Xufeng Liu 325 326 Editor: Mahesh Sivakumar 327 328 "; 330 description 331 "The module defines the YANG definitions for multicast service 332 management. 334 Copyright (c) 2018 IETF Trust and the persons 335 identified as authors of the code. All rights reserved. 337 Redistribution and use in source and binary forms, with or 338 without modification, is permitted pursuant to, and subject 339 to the license terms contained in, the Simplified BSD License 340 set forth in Section 4.c of the IETF Trust's Legal Provisions 341 Relating to IETF Documents 342 (http://trustee.ietf.org/license-info). 343 This version of this YANG module has relationship with 344 overall multicast technologies, such as PIM(RFC7761), 345 BIER(RFC8279), MVPN(RFC6513), and so on; see the RFC itself 346 for full legal notices."; 348 revision 2018-07-30 { 349 description 350 "Initial revision."; 351 reference 352 "RFC XXXX: A YANG Data Model for multicast YANG. 353 RFC 7761: Protocol Independent Multicast - Sparse Mode (PIM-SM): 354 Protocol Specification (Revised). 355 RFC 8279: Multicast Using Bit Index Explicit Replication (BIER); 356 RFC 6513: Multicast in MPLS/BGP IP VPNs"; 357 } 359 /*key*/ 361 typedef ip-multicast-source-address { 362 type union { 363 type rt-types:ipv4-multicast-source-address; 364 type rt-types:ipv6-multicast-source-address; 365 } 366 description 367 "This type represents a version-neutral IP multicast 368 source address. The format of the textual 369 representation implies the IP version."; 370 reference 371 "RFC8294: Common YANG Data Types for the Routing Area."; 372 } 373 typedef virtual-type { 374 type enumeration { 375 enum "vxlan" { 376 description "The vxlan type. See more detail in RFC7348."; 377 } 378 enum "virtual subnet" { 379 description "The nvgre type. See more detail in RFC7637."; 380 } 381 enum "vni" { 382 description 383 "The geneve type. See more detail in [ietf-nvo3-geneve]."; 384 } 385 } 386 description "The collection of virtual network type."; 387 } 389 grouping general-multicast-key { 390 description "The general multicast keys. They are used to 391 distinguish different multicast service."; 392 leaf vpn-rd { 393 type rt-types:route-distinguisher; 394 description "A Route Distinguisher used to distinguish 395 routes from different MVPNs (RFC 6513)."; 396 reference 397 "RFC8294: Common YANG Data Types for the Routing Area."; 398 } 399 leaf source-address { 400 type ip-multicast-source-address; 401 description 402 "The IPv4/IPv6 source address of multicast flow. The 403 value set to zero means that the receiver interests 404 in all source that relevant to one given group."; 405 } 406 leaf group-address { 407 type rt-types:ip-multicast-group-address; 408 description 409 "The IPv4/IPv6 group address of multicast flow. This 410 type represents a version-neutral IP multicast group 411 address. The format of the textual representation 412 implies the IP version."; 413 reference 414 "RFC8294: Common YANG Data Types for the Routing Area."; 415 } 416 leaf vni-type { 417 type virtual-type; 418 description 419 "The type of virtual network identifier. Includes the 420 Vxlan, NVGRE and Geneve. This value and vni-value is 421 used to indicate a specific virtual multicast service."; 422 } 423 leaf vni-value { 424 type uint32; 425 description 426 "The value of Vxlan network identifier, virtual subnet 427 ID or virtual net identifier. This value and vni-type 428 is used to indicate a specific virtual multicast service."; 429 } 430 } 432 /*overlay*/ 434 grouping overlay-technology { 435 leaf overlay-tech-type { 436 type enumeration { 437 enum mld { 438 description "MLD technology is used for multicast 439 overlay. See more detail in [draft-ietf-bier-mld]"; 440 } 441 enum mvpn { 442 description "MVPN technology is used for multicast 443 overlay. See more detail in RFC6513."; 444 } 445 enum bgp { 446 description "BGP technology is used for multicast 447 overlay. See more detail in RFC7716."; 448 } 449 enum mld-snooping { 450 description "MLD snooping technology is used for 451 multicast overlay. See more detail in RFC4541."; 452 } 453 } 454 description "The possible overlay technologies for multicast service."; 455 } 456 description "The possible overlay technologies for multicast service."; 457 } 459 grouping multicast-overlay { 460 description 461 "The multicast overlay information, includes ingress node 462 and egress nodes' information."; 464 container ingress-egress { 465 description "The ingress and egress nodes address collection."; 466 leaf ingress-node { 467 type inet:ip-address; 468 description 469 "The ip address of ingress node for one or more 470 multicast flow. Or the ingress node of MVPN and 471 BIER. In MVPN, this is the address of ingress 472 PE; in BIER, this is the BFR-prefix of ingress 473 nodes."; 474 } 476 list egress-nodes { 477 key "egress-node"; 478 description 479 "The egress multicast nodes of multicast flow. Or 480 the egress node of MVPN and BIER. In MVPN, this 481 is the address of egress PE; in BIER, this is the 482 BFR-prefix of ingress nodes."; 484 leaf egress-node { 485 type inet:ip-address; 486 description 487 "The ip-address of egress multicast nodes. 488 See more details in RFC6513."; 489 } 490 } 491 } 493 container bier-ids { 494 description 495 "The BFR-ids of ingress and egress BIER nodes for 496 one or more multicast flows."; 497 leaf sub-domain { 498 type bier:sub-domain-id; 499 description 500 "The sub-domain that this multicast flow belongs 501 to. See more details in RFC8279."; 502 } 503 leaf ingress-node { 504 type bier:bfr-id; 505 description 506 "The ingress node of multicast flow. This is the 507 BFR-id of ingress nodes. See more details in RFC8279."; 508 } 509 list egress-nodes { 510 key "egress-node"; 511 description 512 "This ID information of one adjacency. See more 513 details in RFC8279."; 515 leaf egress-node { 516 type bier:bfr-id; 517 description 518 "The BFR-ids of egress multicast BIER nodes. 519 See more details in RFC8279."; 520 } 521 } 522 } 524 uses overlay-technology; 525 } 527 /*transport*/ 529 grouping transport-pim { 530 description 531 "The requirement information of pim transportion. 532 PIM protocol is defined in RFC7761."; 533 leaf graceful-restart { 534 type boolean; 535 description 536 "If the graceful restart function should be supported."; 537 } 538 leaf bfd { 539 type boolean; 540 description "If the bfd function should be supported."; 541 } 542 } 544 grouping multicast-transport { 545 description "The transport information of multicast service."; 546 container bier { 547 description 548 "The transport technology is BIER. The BIER technology 549 is introduced in RFC8279. The parameter is consistent 550 with the definition in [ietf-bier-bier-yang]."; 551 leaf sub-domain { 552 type bier:sub-domain-id; 553 description 554 "The subdomain id that the multicast flow belongs 555 to. See more details in RFC8279."; 556 } 557 choice encap-type { 558 case mpls { 559 description "The BIER forwarding depends on mpls. 560 See more details in RFC8296."; 561 } 562 case eth { 563 description "The BIER forwarding depends on ethernet. 565 See more details in RFC8296."; 566 } 567 case ipv6 { 568 description "The BIER forwarding depends on IPv6."; 569 } 570 description "The encapsulation type in BIER."; 571 } 572 leaf bitstringlength { 573 type bier:bsl; 574 description "The bitstringlength used by BIER forwarding. 575 See more details in RFC8279."; 576 } 577 leaf set-identifier { 578 type bier:si; 579 description "The set identifier used by the multicast flow. 580 See more details in RFC8279."; 581 } 582 leaf ecmp { 583 type boolean; 584 description 585 "The capability of ECMP. If this value is set to true, 586 ecmp mechanism should be enabled. See more details in RFC8279."; 587 } 588 leaf frr { 589 type boolean; 590 description 591 "The capability of fast re-route. If this value is 592 set to true, fast re-route mechanism should be 593 enabled. See more details in RFC8279."; 594 } 595 } 596 container bier-te { 597 description 598 "The transport technology is BIER-TE. BIER-TE technology 599 is introduced in [ietf-bier-te-arch]."; 600 leaf sub-domain { 601 type bier:sub-domain-id; 602 description 603 "The subdomain id that the multicast flow belongs to. 604 See more details in [ietf-bier-te-arch]."; 605 } 606 choice encap-type { 607 case mpls { 608 description 609 "The BIER-TE forwarding depends on mpls. See more 610 details in [ietf-bier-te-arch]."; 611 } 612 case non-mpls { 613 description 614 "The BIER-TE forwarding depends on non-mpls. See 615 more details in [ietf-bier-te-arch]."; 616 } 617 description "The encapsulation type in BIER-TE."; 618 } 619 leaf bitstringlength { 620 type bier:bsl; 621 description "The bitstringlength used by BIER-TE forwarding. 622 See more details in [ietf-bier-te-arch]."; 623 } 624 leaf set-identifier { 625 type bier:si; 626 description 627 "The set identifier used by the multicast flow, 628 especially in BIER TE. See more details in 629 [ietf-bier-te-arch]."; 630 } 631 leaf ecmp { 632 type boolean; 633 description 634 "The capability of ECMP. If this value is set to 635 true, ecmp mechanism should be enabled. 636 See more details in [ietf-bier-te-arch]."; 637 } 638 leaf frr { 639 type boolean; 640 description 641 "The capability of fast re-route. If this value 642 is set to true, fast re-route mechanism should 643 be enabled. See more details in 644 [ietf-eckert-bier-te-frr]."; 645 } 646 } 647 container cisco-mode { 648 description 649 "The transport technology is cisco-mode. The Cisco MDT 650 multicast mechanism is defined in RFC6037."; 651 leaf p-group { 652 type rt-types:ip-multicast-group-address; 653 description 654 "The address of p-group. It is used to encapsulate 655 and forward flow according to multicast tree from 656 ingress node to egress nodes."; 657 } 658 uses transport-pim; 659 } 660 container mpls { 661 description 662 "The transport technology is mpls. MVPN overlay can use 663 mpls tunnel technologies to build transport layer. The 664 usage is introduced in RFC6513."; 665 choice mpls-tunnel-type { 666 case mldp { 667 description "The mldp tunnel. The protocol detail 668 is defined in RFC6388."; 669 leaf mldp-tunnel-id { 670 type uint32; 671 description "The tunnel id that correspond this 672 flow. The detail is defined in RFC6388."; 673 } 674 leaf mldp-frr { 675 type boolean; 676 description 677 "If the fast re-route function should be 678 supported. The detail is defined in RFC6388."; 679 } 680 leaf mldp-backup-tunnel { 681 type boolean; 682 description 683 "If the backup tunnel function should be 684 supported. The detail is defined in RFC6388."; 685 } 686 } 687 case p2mp-te { 688 description 689 "The p2mp te tunnel. The protocol detail is 690 defined in RFC4875."; 691 leaf te-tunnel-id { 692 type uint32; 693 description 694 "The tunnel id that correspond this flow. 695 The detail is defined in RFC4875."; 696 } 697 leaf te-frr { 698 type boolean; 699 description 700 "If the fast re-route function should be 701 supported. The detail is defined in RFC4875."; 702 } 703 leaf te-backup-tunnel { 704 type boolean; 705 description 706 "If the backup tunnel function should be 707 supported. The detail is defined in RFC4875."; 708 } 710 } 711 description "The collection types of mpls tunnels"; 712 } 713 } 714 container pim { 715 uses transport-pim; 716 description 717 "The transport technology is PIM. PIM [RFC7761] is used 718 commonly in traditional network."; 719 } 720 } 722 /*underlay*/ 724 grouping multicast-underlay { 725 description 726 "The underlay information relevant multicast service. 727 Underlay protocols are used to build transport layer. 728 It is unnecessary in traditional network that use 729 PIM [RFC7761] to build multicast tree. Diversity underlay 730 protocols can be choosed to build BIER transport layer."; 731 leaf underlay-requirement { 732 type boolean; 733 description "If the underlay technology is required."; 734 } 735 container bgp { 736 description 737 "The underlay technology is BGP. BGP protocol RFC4271 738 should be triggered to run if BGP is used as 739 underlay protocol."; 740 } 741 container ospf { 742 description 743 "The underlay technology is OSPF. OSPF protocol RFC2328 744 should be triggered to run if OSPF is used as underlay 745 protocol."; 746 leaf topology-id { 747 type uint8; 748 description 749 "The topology id of ospf instance. The topology id 750 can be assigned In some situations. More details 751 is defined in RFC2328."; 752 } 753 } 754 container isis { 755 description 756 "The underlay technology is ISIS. ISIS protocol should 757 be triggered to run if ISIS is used as underlay protocol. 759 Details is defined in RFC1195."; 760 leaf topology-id { 761 type uint16; 762 description 763 "The topology id of isis instance. The topology id 764 can be assigned In some situations."; 765 } 766 } 767 container babel { 768 description 769 "The underlay technology is Babel. Babel protocol should 770 be triggered to run if Babel is used as underlay protocol."; 771 } 772 } 774 container multicast-model { 775 description 776 "The model of multicast YANG data. Include keys, overlay, 777 transport and underlay."; 779 list multicast-keys{ 780 key "vpn-rd source-address group-address vni-type vni-value"; 781 uses general-multicast-key; 783 container multicast-overlay { 784 description 785 "The overlay information of multicast service. 786 Overlay technology is used to exchange multicast 787 flows information. Overlay technology may not be 788 used in SDN controlled completely situation, but 789 it can be used in partial SDN controlled situation 790 or non-SDN controlled situation. Different overlay 791 technology can be choosed according to different 792 deploy consideration."; 793 uses multicast-overlay; 794 } 795 container multicast-transport { 796 description 797 "The transportion of multicast service. Transport 798 protocol is responsible for delivering multicast 799 flows from ingress nodes to egress nodes with or 800 without specific encapsulation. Different transport 801 technology can be choosed according to different 802 deploy consideration. Once a transport technology 803 is choosed, associated protocol should be triggered 804 to run."; 805 uses multicast-transport; 806 } 807 container multicast-underlay { 808 description 809 "The underlay of multicast service. Underlay protocol 810 is used to build transport layer. Underlay protocol 811 need not be assigned in ordinary network since 812 existed underlay protocol fits well, but it can be 813 assigned in particular networks for better 814 controll. Once a underlay technology is choosed, 815 associated protocol should be triggered to run."; 816 uses multicast-underlay; 817 } 818 description 819 "The model of multicast YANG data. Include keys, 820 overlay, transport and underlay."; 821 } 822 } 824 /*Notifications*/ 826 notification head-end-event { 827 leaf event-type { 828 type enumeration { 829 enum down { 830 description 831 "There is something wrong with head end node, 832 and head end node can't work properlay."; 833 } 834 enum module-loaded { 835 description 836 "Some new modules that can be used by multicast 837 flows finish loading."; 838 } 839 enum module-unloaded { 840 description 841 "Some new modules that can be used by multicast 842 flows have been unloaded."; 843 } 844 } 845 description "Event type."; 846 } 847 container multicast-key { 848 uses general-multicast-key; 849 description 850 "The associated multicast keys that are influenced by 851 head end node failer."; 852 } 853 uses overlay-technology; 854 leaf transport-tech { 855 type enumeration { 856 enum bier { 857 description 858 "BIER(RFC8279) technology can be used to 859 forward multicast flows."; 860 } 861 enum bier-te { 862 description 863 "BIER-TE(draft-ietf-bier-te-arch) technology 864 can be used to forward multicast flows."; 865 } 866 enum cisco-mode { 867 description 868 "Cisco mode(RFC6037) technology can be used 869 to forward multicast flows."; 870 } 871 enum mldp { 872 description 873 "MLDP(RFC6388) technology can be used to 874 forward multicast flows."; 875 } 876 enum p2mp-te { 877 description 878 "P2MP TE(RFC4875) technology can be used to 879 forward multicast flows."; 880 } 881 enum pim { 882 description 883 "PIM(RFC7761) technology can be used to 884 forward multicast flows."; 885 } 886 } 887 description "The modules can be used to forward multicast flows."; 888 } 889 leaf underlay-tech { 890 type enumeration { 891 enum bgp { 892 description "BGP protocol can be used to build 893 multicast transport layer."; 894 } 895 enum ospf { 896 description "OSPF protocol can be used to build 897 multicast transport layer."; 898 } 899 enum isis { 900 description "ISIS protocol can be used to build 901 multicast transport layer."; 903 } 904 enum babel { 905 description "Babel protocol can be used to build 906 multicast transport layer."; 907 } 908 } 909 description "The modules can be used to build multicast 910 transport layer."; 911 } 912 description 913 "Notification events for the head end nodes. Like head 914 node failer, overlay/ transport/ underlay module 915 loading/ unloading. And the potential failer about some 916 multicast flows and associated 917 overlay/ transport/ underlay technologies."; 918 } 919 } 920 922 6. Notifications 924 The defined Notifications include the events of head end nodes. Like 925 head node failer, overlay/ transport/ underlay module loading/ 926 unloading. And the potential failer about some multicast flows and 927 associated overlay/ transport/ underlay technologies. 929 7. Acknowledgements 931 The authors would like to thank Stig Venaas, Jake Holland, Min Gu for 932 their valuable comments and suggestions. 934 8. Normative References 936 [I-D.ietf-bier-bier-yang] 937 Chen, R., hu, f., Zhang, Z., dai.xianxian@zte.com.cn, d., 938 and M. Sivakumar, "YANG Data Model for BIER Protocol", 939 draft-ietf-bier-bier-yang-04 (work in progress), September 940 2018. 942 [I-D.ietf-bier-te-arch] 943 Eckert, T., Cauchie, G., Braun, W., and M. Menth, "Traffic 944 Engineering for Bit Index Explicit Replication (BIER-TE)", 945 draft-ietf-bier-te-arch-01 (work in progress), October 946 2018. 948 [I-D.ietf-pim-yang] 949 Liu, X., McAllister, P., Peter, A., Sivakumar, M., Liu, 950 Y., and f. hu, "A YANG Data Model for Protocol Independent 951 Multicast (PIM)", draft-ietf-pim-yang-17 (work in 952 progress), May 2018. 954 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 955 the Network Configuration Protocol (NETCONF)", RFC 6020, 956 DOI 10.17487/RFC6020, October 2010, 957 . 959 [RFC6037] Rosen, E., Ed., Cai, Y., Ed., and IJ. Wijnands, "Cisco 960 Systems' Solution for Multicast in BGP/MPLS IP VPNs", 961 RFC 6037, DOI 10.17487/RFC6037, October 2010, 962 . 964 [RFC6087] Bierman, A., "Guidelines for Authors and Reviewers of YANG 965 Data Model Documents", RFC 6087, DOI 10.17487/RFC6087, 966 January 2011, . 968 [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., 969 and A. Bierman, Ed., "Network Configuration Protocol 970 (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011, 971 . 973 [RFC6513] Rosen, E., Ed. and R. Aggarwal, Ed., "Multicast in MPLS/ 974 BGP IP VPNs", RFC 6513, DOI 10.17487/RFC6513, February 975 2012, . 977 [RFC7223] Bjorklund, M., "A YANG Data Model for Interface 978 Management", RFC 7223, DOI 10.17487/RFC7223, May 2014, 979 . 981 [RFC7277] Bjorklund, M., "A YANG Data Model for IP Management", 982 RFC 7277, DOI 10.17487/RFC7277, June 2014, 983 . 985 [RFC8177] Lindem, A., Ed., Qu, Y., Yeung, D., Chen, I., and J. 986 Zhang, "YANG Data Model for Key Chains", RFC 8177, 987 DOI 10.17487/RFC8177, June 2017, 988 . 990 [RFC8279] Wijnands, IJ., Ed., Rosen, E., Ed., Dolganow, A., 991 Przygienda, T., and S. Aldrin, "Multicast Using Bit Index 992 Explicit Replication (BIER)", RFC 8279, 993 DOI 10.17487/RFC8279, November 2017, 994 . 996 [RFC8294] Liu, X., Qu, Y., Lindem, A., Hopps, C., and L. Berger, 997 "Common YANG Data Types for the Routing Area", RFC 8294, 998 DOI 10.17487/RFC8294, December 2017, 999 . 1001 [RFC8349] Lhotka, L., Lindem, A., and Y. Qu, "A YANG Data Model for 1002 Routing Management (NMDA Version)", RFC 8349, 1003 DOI 10.17487/RFC8349, March 2018, 1004 . 1006 Authors' Addresses 1008 Zheng Zhang 1009 ZTE Corporation 1010 China 1012 Email: zzhang_ietf@hotmail.com 1014 Cui(Linda) Wang 1015 ZTE Corporation 1016 China 1018 Email: lindawangjoy@gmail.com 1020 Ying Cheng 1021 China Unicom 1022 Beijing 1023 China 1025 Email: chengying10@chinaunicom.cn 1027 Xufeng Liu 1028 Volta Networks 1030 Email: xufeng.liu.ietf@gmail.com 1032 Mahesh Sivakumar 1033 Juniper networks 1034 1133 Innovation Way 1035 Sunnyvale, CALIFORNIA 94089 1036 USA 1038 Email: sivakumar.mahesh@gmail.com