Internet DRAFT - draft-chh-bier-bier-yang
draft-chh-bier-bier-yang
BIER WG Ran. Chen
Internet-Draft Fangwei. Hu
Intended status: Standards Track Zheng. Zhang
Expires: November 20, 2016 Xianxia. Dai
ZTE Corporation
Mahesh Sivakumar
Cisco Systems, Inc.
May 19, 2016
YANG Data Model for BIER Protocol
draft-chh-bier-bier-yang-04.txt
Abstract
This document defines a YANG data model for BIER configuration and
operation.
Status of This Memo
This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."
This Internet-Draft will expire on November 20, 2016.
Copyright Notice
Copyright (c) 2016 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
Chen, et al. Expires November 20, 2016 [Page 1]
Internet-Draft BIER YANG May 2016
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Design of the Data Model . . . . . . . . . . . . . . . . . . 2
3. Configuration . . . . . . . . . . . . . . . . . . . . . . . . 4
4. Control plane configuration . . . . . . . . . . . . . . . . . 4
5. States . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
6. Notification . . . . . . . . . . . . . . . . . . . . . . . . 5
7. BIER YANG Data Model . . . . . . . . . . . . . . . . . . . . 5
8. Security Considerations . . . . . . . . . . . . . . . . . . . 16
9. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 16
10. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 16
11. References . . . . . . . . . . . . . . . . . . . . . . . . . 16
11.1. Normative references . . . . . . . . . . . . . . . . . . 16
11.2. Informative references . . . . . . . . . . . . . . . . . 18
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 18
1. Introduction
This document defines a YANG data model for BIER configuration and
operation.
2. Design of the Data Model
module: ietf-bier
augment /rt:routing:
+--rw bier
+--rw bier-global
+--rw encapsulation-type? identityref
+--rw bitstringlength? bsl
+--rw bfr-id? bfr-id
+--rw ipv4-bfr-prefix? inet:ipv4-prefix
+--rw ipv6-bfr-prefix? inet:ipv6-prefix
+--rw sub-domain* [sub-domain-id]
+--rw sub-domain-id sub-domain-id
+--rw igp-type? igp-type
+--rw mt-id? mt-id
+--rw bfr-id? bfr-id
+--rw bitstringlength? bsl
+--rw af
+--rw ipv4* [bitstringlength bier-mpls-label-base]
| +--rw bitstringlength uint16
| +--rw bier-mpls-label-base mpls:mpls-label
| +--rw bier-mpls-label-range-size? bier-mpls-label-range-size
+--rw ipv6* [bitstringlength bier-mpls-label-base]
Chen, et al. Expires November 20, 2016 [Page 2]
Internet-Draft BIER YANG May 2016
+--rw bitstringlength uint16
+--rw bier-mpls-label-base mpls:mpls-label
+--rw bier-mpls-label-range-size? bier-mpls-label-range-size
augment /rt:routing/rt:routing-protocols/rt:routing-protocol/ospf:ospf/ospf:instance:
+--rw bier-ospf-cfg
+--rw mt-id mt-id
+--rw bier-global
+--rw enable? boolean
+--rw advertise? boolean
+--rw receive? boolean
augment /rt:routing/rt:routing-protocols/rt:routing-protocol/isis:isis:
+--rw bier-isis-cfg
+--rw mt-id mt-id
+--rw bier-global
+--rw enable? boolean
+--rw advertise? boolean
+--rw receive? boolean
augment /rt:routing-state:
+--ro bier-global
| +--ro encapsulation-type? identityref
| +--ro bitstringlength? bsl
| +--ro bfr-id? bfr-id
| +--ro ipv4-bfr-prefix? inet:ipv4-prefix
| +--ro ipv6-bfr-prefix? inet:ipv6-prefix
| +--ro sub-domain* [sub-domain-id]
| +--ro sub-domain-id sub-domain-id
| +--ro igp-type igp-type
| +--ro mt-id? mt-id
| +--ro bfr-id? bfr-id
| +--rw bitstringlength? bsl
| +--ro ipv4* [bitstringlength bier-mpls-label-base]
| | +--ro bitstringlength uint16
| | +--ro bier-mpls-label-base mpls:mpls-label
| | +--ro bier-mpls-label-range-size? bier-mpls-label-range-size
| +--ro ipv6* [bitstringlength bier-mpls-label-base]
| +--ro bitstringlength uint16
| +--ro bier-mpls-label-base mpls:mpls-label
| +--ro bier-mpls-label-range-size? bier-mpls-label-range-size
+--ro birts
+--ro birt* [sub-domain-id]
+--ro sub-domain-id sub-domain-id
Chen, et al. Expires November 20, 2016 [Page 3]
Internet-Draft BIER YANG May 2016
+--ro birt-bitstringlength* [bitstringlength]
+--ro bitstringlength uint16
+--ro birt-si* [si]
+--ro si si
+--ro f-bm? uint16
+--ro bier-mpls-in-label? mpls:mpls-label
+--ro bfr-nbr? inet:ip-address
+--ro bier-mpls-out-label? mpls:mpls-label
notifications:
+---n bfr-id-collision
| +--ro bfr-id? bfr-id
+---n bfr-zero
| +--ro ipv4-bfr-prefix? inet:ipv4-prefix
| +--ro ipv6-bfr-prefix? inet:ipv6-prefix
+---n sub-domain-id-collision
+--ro sub-domain-id? sub-domain-id
+--ro mt-id? uint16
3. Configuration
This Module augments the "/rt:routing:" with a BIER container. This
Container defines all the configuration parameters related to BIER
for this particular routing.
The BIER configuration contains global configuration.
The global configuration includes BIER encapsulation type, imposition
BitStringLengths, BFR-id, BFR-prefixes, and parameters associated
with bier sub-domain.
In this document, we contains two types of BitStringLengths:
Imposition and Disposition BitStringLengths, as defined in
([I-D.ietf-bier-architecture]).The imposition BitStringLengths is
defined under bier-global container, and the disposition
BitStringLengths is defined under the sub-domain.
4. Control plane configuration
This Module augments the "/rt:routing/rt:routing-instance/rt:routing-
protocolsbier-protocol-extensions /rt:routing-protocol/ospf:ospf/
ospf:instance:" and "/rt:routing/rt:routing-instance/rt:routing-
protocols /rt:routing-protocol/isis:isis/isis:instance:"configuration
with BIER.
This Module supports ISIS ([I-D.ietf-bier-isis-extensions])and OSPF
([I-D.ietf-bier-ospf-bier-extensions]) as control plane for BIER.
Chen, et al. Expires November 20, 2016 [Page 4]
Internet-Draft BIER YANG May 2016
5. States
The operational states contains basic parameters associated with
bier, such as BIER encapsulation type, BitStringLengths, BFR-id, BFR-
prefixes, and parameters associated with bier sub-domain.
It also includes the Bit Index Routing Table(BIRT).
6. Notification
This Module includes bfr-id-collision, bfr-zero, and sub-domain-id-
collision.
7. BIER YANG Data Model
<CODE BEGINS> file "ietf-bier.yang"
module ietf-bier {
namespace "urn:ietf:params:xml:ns:yang:ietf-bier";
prefix "bier";
import ietf-routing {
prefix "rt";
}
import ietf-inet-types {
prefix "inet";
}
import ietf-mpls {
prefix "mpls";
}
import ietf-isis{
prefix "isis";
}
import ietf-ospf {
prefix "ospf";
}
organization
"IETF BIER(Bit Indexed Explicit Replication ) Working Group";
contact
"WG List: <mailto:bier@ietf.org>
Chen, et al. Expires November 20, 2016 [Page 5]
Internet-Draft BIER YANG May 2016
WG Chair: Tony Przygienda
<mailto:tonysietf@gmail.com>
WG Chair: Greg Shepherd
<mailto:gjshep@gmail.com>
Editor: Ran Chen
<mailto:chen.ran@zte.com.cn>
Editor: Fangwei Hu
<mailto:hu.fangwei@zte.com.cn>
Editor: Zheng Zhang
<mailto:zhang.zheng@zte.com.cn>
Editor: Xianxian Dai
<mailto:dai.xianxian@zte.com.cn>
Editor: Mahesh Sivakumar
<mailto:masivaku@cisco.com>
";
description
"The YANG module defines a generic configuration
model for BIER.";
revision 2016-05-12{
description
"04 revision";
reference
"draft-chh-bier-bier-yang-04";
}
revision 2016-03-16 {
description
"03 revision";
reference
"draft-chh-bier-bier-yang-03";
}
revision 2015-12-03 {
description
"02 revision";
reference
"draft-chh-bier-bier-yang-02";
}
revision 2015-10-16 {
description
"01 revision.";
reference
"draft-chh-bier-bier-yang-01";
Chen, et al. Expires November 20, 2016 [Page 6]
Internet-Draft BIER YANG May 2016
}
revision 2015-06-22 {
description
"Initial revision.";
reference
"draft-chh-bier-bier-yang-00";
}
/* Identities */
identity bier-encapsulation{
description
"Base identity for BIER encapsulation.";
}
identity bier-encapsulation-mpls {
base bier-encapsulation;
description
"This identity represents MPLS encapsulation for bier.";
}
/*Typedefs*/
typedef sub-domain-id {
type uint16;
description
"The type for sub-domain-id";
}
typedef si {
type uint16;
description
"The type for set identifier";
}
typedef bfr-id {
type uint16;
description
"The type for bfr identifier";
}
typedef mt-id {
type uint16;
description
"The type for multi-topology identifier";
}
typedef bier-mpls-label-range-size{
type uint8;
Chen, et al. Expires November 20, 2016 [Page 7]
Internet-Draft BIER YANG May 2016
description
"The type for BIER label range size.";
}
typedef bsl {
type enumeration{
enum 64-bit{
value 1;
description
"bitstringlength is 64";
}
enum 128-bit{
value 2;
description
"bitstringlength is 128";
}
enum 256-bit{
value 3;
description
"bitstringlength is 256";
}
enum 512-bit{
value 4;
description
"bitstringlength is 512";
}
enum 1024-bit{
value 5;
description
"bitstringlength is 1024";
}
enum 2048-bit{
value 6;
description
"bitstringlength is 2048";
}
enum 4096-bit{
value 7;
description
"bitstringlength is 4096";
}
}
description
"The bitstringlength type for imposition mode";
}
typedef igp-type {
type enumeration{
Chen, et al. Expires November 20, 2016 [Page 8]
Internet-Draft BIER YANG May 2016
enum ISIS{
value 1;
description
"isis protocol";
}
enum OSPF{
value 2;
description
"ospf protocol";
}
}
description
"The IGP type";
}
/*grouping*/
grouping bier-protocol-extensions{
leaf mt-id{
type mt-id;
description
"Multi-topology associated with bier sub-domain.";
}
container bier-global {
leaf enable {
type boolean;
default false;
description
"Enables bier protocol extensions.";
}
leaf advertise {
type boolean;
default true;
description
"Enable to advertise the parameters associated with bier.";
}
leaf receive {
type boolean;
default true;
description
"Enable to receive the parameters associated with bier.";
}
description
"BIER global config.";
}
description
"Defines protocol extensions.";
}
Chen, et al. Expires November 20, 2016 [Page 9]
Internet-Draft BIER YANG May 2016
grouping bier-parameters{
leaf encapsulation-type {
type identityref {
base bier-encapsulation;
}
default "bier-encapsulation-mpls";
description
"Dataplane to be used.";
}
leaf bitstringlength{
type bsl;
description
"imposition bitstringlength.";
}
leaf bfr-id {
type bfr-id;
description
"BIER bfr identifier.";
}
leaf ipv4-bfr-prefix {
type inet:ipv4-prefix;
description
"BIER IPv4 prefix.";
}
leaf ipv6-bfr-prefix {
type inet:ipv6-prefix;
description
"BIER IPv6 prefix.";
}
description
" BIER parameters.";
}
grouping bier-mpls-cfg{
leaf bitstringlength {
type uint16;
description
"BIER bitstringlength.";
}
leaf bier-mpls-label-base{
type mpls:mpls-label;
description
"BIER label base.";
}
leaf bier-mpls-label-range-size{
type bier-mpls-label-range-size;
description
"BIER label range.";
Chen, et al. Expires November 20, 2016 [Page 10]
Internet-Draft BIER YANG May 2016
}
description
"Defines the necessary label ranges per bitstring length.";
}
/* Configuration Data */
augment "/rt:routing" {
description
"This augments routing-instance configuration with bier.";
container bier{
container bier-global {
uses bier-parameters;
list sub-domain{
key "sub-domain-id";
leaf sub-domain-id{
type sub-domain-id;
description
"sub-domain ID.";
}
leaf igp-type {
type igp-type;
description
"IGP type.";
}
leaf mt-id {
type mt-id;
description
"multi-topology ID.";
}
leaf bfr-id{
type bfr-id;
description
"BIER bfr identifier.";
}
leaf bitstringlength{
type bsl;
description
"Disposition bitstringlength.";
}
container af {
list ipv4 {
key "bitstringlength bier-mpls-label-base";
uses bier-mpls-cfg;
description
"Defines the necessary label ranges per bitstring length in ipv4.";
Chen, et al. Expires November 20, 2016 [Page 11]
Internet-Draft BIER YANG May 2016
}
list ipv6 {
key "bitstringlength bier-mpls-label-base";
uses bier-mpls-cfg;
description
"Defines the necessary label ranges per bitstring length in ipv6.";
}
description
"Bier mapping entries.";
}
description
"Denfines subdomain configuration";
}
description
"BIER global config.";
}
description "BIER config.";
}
}
augment "/rt:routing/rt:routing-protocols/"
+ "rt:routing-protocol/ospf:ospf/ospf:instance" {
when "../../rt:type = 'ospf:ospfv2' or
../../rt:type = 'ospf:ospfv3'" {
description
"This augments the ospf routing protocol when used";
}
description
"This augments ospf protocol configuration with bier.";
container bier-ospf-cfg{
uses bier-protocol-extensions;
description
"Control of bier advertisement and reception.";
}
}
augment "/rt:routing/rt:routing-protocols/" +
"rt:routing-protocol"{
when "rt:type = 'isis:isis'" {
description
"This augment is only valid when routing protocol instance type is isis.";
}
description
"This augments ISIS protocol configuration with bier.";
container bier-isis-cfg{
uses bier-protocol-extensions;
Chen, et al. Expires November 20, 2016 [Page 12]
Internet-Draft BIER YANG May 2016
description
"Control of bier advertisement and reception.";
}
}
/* Operational data */
augment "/rt:routing-state" {
description
"This augments the operational states with bier.";
container bier-global{
uses bier-parameters;
list sub-domain{
key "sub-domain-id";
leaf sub-domain-id{
type sub-domain-id;
description
"sub-domain ID.";
}
leaf igp-type {
type igp-type;
description
"IGP type.";
}
leaf mt-id {
type mt-id;
description
"multi-topology ID.";
}
leaf bfr-id{
type bfr-id;
description
"BIER bfr identifier.";
}
leaf bitstringlength{
type bsl;
description
"Disposition bitstringlength.";
}
list ipv4 {
key "bitstringlength bier-mpls-label-base";
uses bier-mpls-cfg;
description
"Show the necessary label ranges per bitstring length in ipv4.";
}
list ipv6 {
key "bitstringlength bier-mpls-label-base";
Chen, et al. Expires November 20, 2016 [Page 13]
Internet-Draft BIER YANG May 2016
uses bier-mpls-cfg;
description
"Show the necessary label ranges per bitstring length in ipv6.";
}
description
"Denfines subdomain configuration";
}
description
"Parameters associated with bier.";
}
container birts{
list birt{
key "sub-domain-id";
leaf sub-domain-id{
type sub-domain-id;
description
"BIER sub domain ID";
}
list birt-bitstringlength {
key "bitstringlength";
leaf bitstringlength{
type uint16;
description
"BIER bitstringlength.";
}
list birt-si {
key "si";
leaf si{
type si;
description
"BIER set identifier.";
}
leaf f-bm{
type uint16;
description
"BIER Forwarding Bit Mask.";
}
leaf bier-mpls-in-label{
type mpls:mpls-label;
description
"BIER in-label.";
}
leaf bfr-nbr{
type inet:ip-address;
description
"BIER BFR Neighbors.";
}
Chen, et al. Expires November 20, 2016 [Page 14]
Internet-Draft BIER YANG May 2016
leaf bier-mpls-out-label{
type mpls:mpls-label;
description
"BIER out-label.";
}
description
"Query the BIRT based on the key set identifier & bitstringlength & sub-domain-id.";
}
description
"Query the BIRT based on the key bitstringlengt & sub-domain-id.";
}
description
"Query the BIRT based on the key sub-domain.";
}
description
"Shows Bit Index Routing Table.";
}
}
/* Notifications */
notification bfr-id-collision{
leaf bfr-id{
type bfr-id;
description
"BIER BFR ID.";
}
description
"BFR ID received in the controlplane that caused BFR ID collision.";
}
notification bfr-zero{
leaf ipv4-bfr-prefix{
type inet:ipv4-prefix;
description
"BIER ipv4 bfr prefix";
}
leaf ipv6-bfr-prefix{
type inet:ipv6-prefix;
description
"BIER ipv6 bfr prefix";
}
description
"Invalid value associated with prefix";
}
notification sub-domain-id-collision{
leaf sub-domain-id{
Chen, et al. Expires November 20, 2016 [Page 15]
Internet-Draft BIER YANG May 2016
type sub-domain-id;
description
"BIER sub domain ID";
}
leaf mt-id{
type uint16;
description
"Multi-topology ID";
}
description
"Sub domain ID received in the controlplane that caused Sub domain ID collision";
}
}
<CODE ENDS>
8. Security Considerations
TBD.
9. Acknowledgements
We would like to thank IJsbrand Wijnands, Reshad Rahman and Giles
Heron for their comments and support of this work.
10. IANA Considerations
This document requires no IANA Actions. Please remove this section
before RFC publication.
11. References
11.1. Normative references
[I-D.ietf-bier-architecture]
Wijnands, I., Rosen, E., Dolganow, A., Przygienda, A., and
S. Aldrin, "Multicast using Bit Index Explicit
Replication", draft-ietf-bier-architecture-03 (work in
progress), January 2016.
[I-D.ietf-bier-isis-extensions]
Ginsberg, L., Przygienda, A., Aldrin, S., and J. Zhang,
"BIER support via ISIS", draft-ietf-bier-isis-
extensions-02 (work in progress), March 2016.
Chen, et al. Expires November 20, 2016 [Page 16]
Internet-Draft BIER YANG May 2016
[I-D.ietf-bier-mpls-encapsulation]
Wijnands, I., Rosen, E., Dolganow, A., Tantsura, J., and
S. Aldrin, "Encapsulation for Bit Index Explicit
Replication in MPLS Networks", draft-ietf-bier-mpls-
encapsulation-04 (work in progress), April 2016.
[I-D.ietf-bier-ospf-bier-extensions]
Psenak, P., Kumar, N., Wijnands, I., Dolganow, A.,
Przygienda, A., Zhang, J., and S. Aldrin, "OSPF Extensions
for BIER", draft-ietf-bier-ospf-bier-extensions-02 (work
in progress), March 2016.
[I-D.ietf-isis-yang-isis-cfg]
Litkowski, S., Yeung, D., Lindem, A., Zhang, J., and L.
Lhotka, "YANG Data Model for IS-IS protocol", draft-ietf-
isis-yang-isis-cfg-08 (work in progress), March 2016.
[I-D.ietf-netmod-routing-cfg]
Lhotka, L. and A. Lindem, "A YANG Data Model for Routing
Management", draft-ietf-netmod-routing-cfg-21 (work in
progress), March 2016.
[I-D.ietf-ospf-yang]
Yeung, D., Qu, Y., Zhang, J., Bogdanovic, D., and K.
Koushik, "Yang Data Model for OSPF Protocol", draft-ietf-
ospf-yang-04 (work in progress), March 2016.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<http://www.rfc-editor.org/info/rfc6020>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<http://www.rfc-editor.org/info/rfc6241>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013,
<http://www.rfc-editor.org/info/rfc6991>.
[RFC7223] Bjorklund, M., "A YANG Data Model for Interface
Management", RFC 7223, DOI 10.17487/RFC7223, May 2014,
<http://www.rfc-editor.org/info/rfc7223>.
Chen, et al. Expires November 20, 2016 [Page 17]
Internet-Draft BIER YANG May 2016
11.2. Informative references
[I-D.saad-mpls-static-yang]
Saad, T., Raza, K., Gandhi, R., Liu, X., Beeram, V., Shah,
H., Bryskin, I., Chen, X., Jones, R., and B. Wen, "A YANG
Data Model for MPLS Static LSPs", draft-saad-mpls-static-
yang-03 (work in progress), May 2016.
Authors' Addresses
Ran Chen
ZTE Corporation
No.50 Software Avenue,Yuhuatai District
Nanjing, Jiangsu Province 210012
China
Phone: +86 025 88014636
Email: chen.ran@zte.com.cn
Fangwei Hu
ZTE Corporation
No.889 Bibo Rd
Shanghai 201203
China
Phone: +86 21 68896273
Email: hu.fangwei@zte.com.cn
Zheng Zhang
ZTE Corporation
No.50 Software Avenue,Yuhuatai District
Nanjing, Jiangsu Province 210012
China
Email: zhang.zheng@zte.com.cn
Xianxian Dai
ZTE Corporation
No.50 Software Avenue,Yuhuatai District
Nanjing, Jiangsu Province 210012
China
Email: Dai.xianxian@zte.com.cn
Chen, et al. Expires November 20, 2016 [Page 18]
Internet-Draft BIER YANG May 2016
Mahesh Sivakumar
Cisco Systems, Inc.
510 McCarthy Blvd
Milpitas,California 95035
United States
Email: masivaku@cisco.com
Chen, et al. Expires November 20, 2016 [Page 19]
