Internet DRAFT - draft-ietf-bess-evpn-yang
draft-ietf-bess-evpn-yang
BESS Working Group P. Brissette Ed.
Internet Draft Cisco System
Intended Status: Proposed Standard H. Shah Ed.
Expires: September 12, 2019 Ciena Corporation
I. Chen Ed.
Jabil
I. Hussain Ed.
Infinera Corporation
K. Tiruveedhula Ed.
Juniper Networks
J. Rabadan Ed.
Nokia
March 11, 2019
Yang Data Model for EVPN
draft-ietf-bess-evpn-yang-07
Abstract
This document describes a YANG data model for Ethernet VPN services.
The model is agnostic of the underlay. It apply to MPLS as well as to
VxLAN encapsulation. The model is also agnostic of the services
including E-LAN, E-LINE and E-TREE services. This document mainly
focuses on EVPN and Ethernet-Segment instance framework.
Status of this Memo
This Internet-Draft is submitted to IETF in full conformance with the
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF), its areas, and its working groups. Note that
other groups may also distribute working documents as
Internet-Drafts.
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."
The list of current Internet-Drafts can be accessed at
http://www.ietf.org/1id-abstracts.html
The list of Internet-Draft Shadow Directories can be accessed at
http://www.ietf.org/shadow.html
Brissette, et. al Expires September 12, 2019 [Page 1]
Internet-Draft draft-bess-evpn-yang March 11, 2019
Copyright and License Notice
Copyright (c) 2019 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
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
Convention
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 2
2. Specification of Requirements . . . . . . . . . . . . . . . . . 3
3. EVPN YANG Model . . . . . . . . . . . . . . . . . . . . . . . . 4
3.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 4
3.2 Ethernet-Segment Model . . . . . . . . . . . . . . . . . . . 4
3.3 EVPN Model . . . . . . . . . . . . . . . . . . . . . . . . . 5
4. YANG Module . . . . . . . . . . . . . . . . . . . . . . . . . . 8
4.1 Ethernet Segment Yang Module . . . . . . . . . . . . . . . . 9
4.2 EVPN Yang Module . . . . . . . . . . . . . . . . . . . . . . 15
5. Security Considerations . . . . . . . . . . . . . . . . . . . . 26
6. IANA Considerations . . . . . . . . . . . . . . . . . . . . . . 26
7. References . . . . . . . . . . . . . . . . . . . . . . . . . . 26
7.1. Normative References . . . . . . . . . . . . . . . . . . . 26
7.2. Informative References . . . . . . . . . . . . . . . . . . 27
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 27
1. Introduction
The Network Configuration Protocol (NETCONF) [RFC6241] is a network
management protocol that defines mechanisms to manage network
devices. YANG [RFC6020] is a modular language that represents data
structures in an XML or JSON tree format, and is used as a data
modeling language for the NETCONF.
Brissette, et. al Expires September 12, 2019 [Page 2]
Internet-Draft draft-bess-evpn-yang March 11, 2019
This document introduces a YANG data model for Ethernet VPN services
(EVPN) [RFC7432], Provider Backbone Bridging Combined with Ethernet
VPN (PBB-EVPN) [RFC7623] as well as other WG draft such as EVPN-VPWS,
etc. The EVPN services runs over MPLS and VxLAN underlay.
The Yang data model in this document defines Ethernet VPN based
services. The model leverages the definitions used in other IETF
Yang draft such as L2VPN Yang.
The goal is to propose a data object model consisting of building
blocks that can be assembled in different order to realize different
EVPN-based services. The definition work is undertaken initially by a
smaller working group with members representing various vendors and
service providers. The EVPN basic framework consist of two modules:
EVPN and Ethernet-Segment. These models are completely orthogonal.
They usually work in pair but user can definitely use one or the
other for its own need.
The data model is defined for following constructs that are used for
managing the services:
o Configuration
o Operational State
o Notifications
The document is organized to first define the data model for the
configuration, operational state and notifications of EVPN and
Ethernet-Segment.
The EVPN data object model defined in this document uses the instance
centric approach whereby EVPN service attributes are specified for a
given EVPN instance.
The Ethernet-Segment data object model defined in this document refer
to a specific interface. That interface can be a physical interface,
a bundle interface or virtual interface. The latter includes
attachment-circuit and pseudowire. The purpose of creating a separate
module is due to the fact that it can be used without having the need
to have EVPN configured as layer 2/3 service. For example, an access
node can be dual-homed to two service nodes servicing a VPLS or an
IPVPN core. The access connectivity can be represented by an
Ethernet-Segment where EVPN BGP DF election is performed over both
service nodes.
2. Specification of Requirements
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
Brissette, et. al Expires September 12, 2019 [Page 3]
Internet-Draft draft-bess-evpn-yang March 11, 2019
NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL"
in this document are to be interpreted as described in [RFC2119].
3. EVPN YANG Model
3.1. Overview
Two top level module, Ethernet-Segment and EVPN, are defined. The
Ethernet-Segment contains a list of interface to which any Ethernet-
Segment attributes are configured/applied.
The EVPN module has two main containers: common and instance. The
first one has common attributes to all VPNs where as the latter has
attributes specific to an EVI (EVPN instance). This document state
the scope of the EVPN object models definition. The following
documents are within the scope. This is not an exhaustive list but a
representation of documents that are covered for this work:
o Reqs for EVPN:[RFC7209]
o EVPN: [RFC7432]
o PBB-EVPN: [RFC7623]
o EVPN-VPWS: [RFC8214]
o EVPN-ETREE: [RFC8317]
o EVPN Overlay [RFC8365]
The integration with L2VPN instance Yang model is being done as part
of the L2VPN Yang model.
Following documents will be covered at that time:
o (PBB-)EVPN Seamless Integration with (PBB-)VPLS:
draft-ietf-bess-evpn-vpls-seamless-integ
o EVPN Virtual Ethernet Segment:
draft-sajassi-bess-evpn-virtual-eth-segment
o IP Prefix Advertisement in EVPN:
draft-ietf-bess-evpn-prefix-advertisement
o VXLAN DCI Using EVPN:
draft-boutros-l2vpn-vxlan-evpn
o Interconnect Solution for EVPN Overlay networks:
draft-ietf-bess-dci-evpn-overlay
o Integrated Routing and Bridging in EVPN:
draft-ietf-bess-evpn-inter-subnet-forwarding
3.2 Ethernet-Segment Model
The Ethernet-Segment data model has a list of ES where each refer to
an interface. All attributes are optional due to auto-sensing default
mode where all values are auto-derive from the network connectivity.
module: ietf-ethernet-segment
Brissette, et. al Expires September 12, 2019 [Page 4]
Internet-Draft draft-bess-evpn-yang March 11, 2019
+--rw ethernet-segments
+--rw ethernet-segment* [name]
+--rw name string
+--ro service-type? string
+--ro status? status-type
+--rw (ac-or-pw)?
| +--:(ac)
| | +--rw ac* if:interface-ref
| +--:(pw)
| +--rw pw* pw:pseudowire-ref
+--ro interface-status? status-type
+--rw ethernet-segment-identifier? ethernet-segment-identifier-type
+--rw (active-mode)
| +--:(single-active)
| | +--rw single-active-mode? empty
| +--:(all-active)
| +--rw all-active-mode? empty
+--rw pbb-parameters {ethernet-segment-pbb-params}?
| +--rw backbone-src-mac? yang:mac-address
+--rw bgp-parameters
| +--rw common
| +--rw rd-rt* [route-distinguisher]
| {ethernet-segment-bgp-params}?
| +--rw route-distinguisher
| rt-types:route-distinguisher
| +--rw vpn-targets
| rt-types:vpn-route-targets
+--rw df-election
| +--rw df-election-method? df-election-method-type
| +--rw preference? uint16
| +--rw revertive? boolean
| +--rw election-wait-time? uint32
+--rw ead-evi-route? boolean
+--ro esi-label? string
+--ro member*
| +--ro ip-address? inet:ip-address
+--ro df*
+--ro service-identifier? uint32
+--ro vlan? uint32
+--ro ip-address? inet:ip-address
3.3 EVPN Model
The evpn-instances container contains a list of evpn-instance. Each
entry of the evpn-instance represents a different Ethernet VPN and it
is represented by a EVI. Again, mainly all attributes are optional
for the same reason as for the Ethernet-Segment module.
Brissette, et. al Expires September 12, 2019 [Page 5]
Internet-Draft draft-bess-evpn-yang March 11, 2019
module: ietf-evpn
+--rw evpn
+--rw common
| +--rw (replication-type)?
| +--:(ingress-replication)
| | +--rw ingress-replication? boolean
| +--:(p2mp-replication)
| +--rw p2mp-replication? boolean
+--rw evpn-instances
+--rw evpn-instance* [name]
+--rw name string
+--rw evi? uint32
+--rw pbb-parameters {evpn-pbb-params}?
| +--rw source-bmac? yang:mac-address
+--rw bgp-parameters
| +--rw common
| +--rw rd-rt* [route-distinguisher]
| {evpn-bgp-params}?
| +--rw route-distinguisher
| | rt-types:route-distinguisher
| +--rw vpn-targets
| rt-types:vpn-route-targets
+--rw arp-proxy? boolean
+--rw arp-suppression? boolean
+--rw nd-proxy? boolean
+--rw nd-suppression? boolean
+--rw underlay-multicast? boolean
+--rw flood-unknown-unicast-supression? boolean
+--rw vpws-vlan-aware? boolean
+--ro routes
| +--ro ethernet-auto-discovery-route*
| | +--ro rd-rt* [route-distinguisher]
| | | +--ro route-distinguisher
| | | rt-types:route-distinguisher
| | | +--ro vpn-targets
| | | rt-types:vpn-route-targets
| | +--ro ethernet-segment-identifier? es:ethernet-segment-identifier-type
| | +--ro ethernet-tag? uint32
| | +--ro path*
| | +--ro next-hop? inet:ip-address
| | +--ro label? rt-types:mpls-label
| | +--ro detail
| | +--ro attributes
| | | +--ro extended-community* string
| | +--ro bestpath? empty
| +--ro mac-ip-advertisement-route*
| | +--ro rd-rt* [route-distinguisher]
| | | +--ro route-distinguisher
Brissette, et. al Expires September 12, 2019 [Page 6]
Internet-Draft draft-bess-evpn-yang March 11, 2019
| | | rt-types:route-distinguisher
| | | +--ro vpn-targets
| | | rt-types:vpn-route-targets
| | +--ro ethernet-segment-identifier? es:ethernet-segment-identifier-type
| | +--ro ethernet-tag? uint32
| | +--ro mac-address? yang:mac-address
| | +--ro mac-address-length? uint8
| | +--ro ip-prefix? inet:ip-prefix
| | +--ro path*
| | +--ro next-hop? inet:ip-address
| | +--ro label? rt-types:mpls-label
| | +--ro label2? rt-types:mpls-label
| | +--ro detail
| | +--ro attributes
| | | +--ro extended-community* string
| | +--ro bestpath? empty
| +--ro inclusive-multicast-ethernet-tag-route*
| | +--ro rd-rt* [route-distinguisher]
| | | +--ro route-distinguisher
| | | rt-types:route-distinguisher
| | | +--ro vpn-targets
| | | rt-types:vpn-route-targets
| | +--ro originator-ip-prefix? inet:ip-prefix
| | +--ro path*
| | +--ro next-hop? inet:ip-address
| | +--ro label? rt-types:mpls-label
| | +--ro detail
| | +--ro attributes
| | | +--ro extended-community* string
| | +--ro bestpath? empty
| +--ro ethernet-segment-route*
| | +--ro rd-rt* [route-distinguisher]
| | | +--ro route-distinguisher
| | | rt-types:route-distinguisher
| | | +--ro vpn-targets
| | | rt-types:vpn-route-targets
| | +--ro ethernet-segment-identifier? es:ethernet-segment-identifier-type
| | +--ro originator-ip-prefix? inet:ip-prefix
| | +--ro path*
| | +--ro next-hop? inet:ip-address
| | +--ro detail
| | +--ro attributes
| | | +--ro extended-community* string
| | +--ro bestpath? empty
| +--ro ip-prefix-route*
| +--ro rd-rt* [route-distinguisher]
| | +--ro route-distinguisher
| | rt-types:route-distinguisher
Brissette, et. al Expires September 12, 2019 [Page 7]
Internet-Draft draft-bess-evpn-yang March 11, 2019
| | +--ro vpn-targets
| | rt-types:vpn-route-targets
| +--ro ethernet-segment-identifier?
| | es:ethernet-segment-identifier-type
| +--ro ip-prefix? inet:ip-prefix
| +--ro path*
| +--ro next-hop? inet:ip-address
| +--ro label? rt-types:mpls-label
| +--ro detail
| +--ro attributes
| | +--ro extended-community* string
| +--ro bestpath? empty
+--ro statistics
+--ro tx-count? yang:zero-based-counter32
+--ro rx-count? yang:zero-based-counter32
+--ro detail
+--ro broadcast-tx-count?
yang:zero-based-counter32
+--ro broadcast-rx-count?
yang:zero-based-counter32
+--ro multicast-tx-count?
yang:zero-based-counter32
+--ro multicast-rx-count?
yang:zero-based-counter32
+--ro unknown-unicast-tx-count?
yang:zero-based-counter32
+--ro unknown-unicast-rx-count?
yang:zero-based-counter32
augment /pw:pseudowires/pw:pseudowire/pw:pw-type:
+--:(evpn-pw)
+--rw evpn-pw
+--rw remote-id? uint32
+--rw local-id? uint32
augment
/ni:network-instances/ni:network-instance/ni:ni-type/l2vpn:l2vpn:
+--rw evpn-instance? evpn-instance-ref
augment
/ni:network-instances/ni:network-instance/ni:ni-type/l2vpn:l2vpn:
+--rw vpls-contstraints
notifications:
+---n evpn-state-change-notification
+--ro evpn-instance? evpn-instance-ref
+--ro state? identityref
4. YANG Module
The EVPN configuration container is logically divided into
Brissette, et. al Expires September 12, 2019 [Page 8]
Internet-Draft draft-bess-evpn-yang March 11, 2019
following high level configuration areas:
4.1 Ethernet Segment Yang Module
<CODE BEGINS> file "ietf-ethernet-segment@2019-03-09.yang"
module ietf-ethernet-segment {
namespace "urn:ietf:params:xml:ns:yang:ietf-ethernet-segment";
prefix "es";
import ietf-yang-types {
prefix "yang";
}
import ietf-inet-types {
prefix "inet";
}
import ietf-routing-types {
prefix "rt-types";
}
import ietf-interfaces {
prefix "if";
}
import ietf-pseudowires {
prefix "pw";
}
organization "ietf";
contact "ietf";
description "ethernet segment";
revision "2019-03-09" {
description " - Create an ethernet-segment type and change references " +
" to ethernet-segment-identifier " +
" - Updated Route-target lists to rt-types:vpn-route-targets " +
"";
reference "";
}
revision "2018-02-20" {
description " - Change the type of attachment circuit to " +
" if:interface-ref " +
"";
reference "";
}
revision "2017-10-21" {
Brissette, et. al Expires September 12, 2019 [Page 9]
Internet-Draft draft-bess-evpn-yang March 11, 2019
description " - Updated ethernet segment's AC/PW members to " +
" accommodate more than one AC or more than one " +
" PW " +
" - Added the new preference based DF election " +
" method " +
" - Referenced pseudowires in the new " +
" ietf-pseudowires.yang model " +
" - Moved model to NMDA style specified in " +
" draft-dsdt-nmda-guidelines-01.txt " +
"";
reference "";
}
revision "2017-03-08" {
description " - Updated to use BGP parameters from " +
" ietf-routing-types.yang instead of from " +
" ietf-evpn.yang " +
" - Updated ethernet segment's AC/PW members to " +
" accommodate more than one AC or more than one " +
" PW " +
" - Added the new preference based DF election " +
" method " +
"";
reference "";
}
revision "2016-07-08" {
description " - Added the configuration option to enable or " +
" disable per-EVI/EAD route " +
" - Added PBB parameter backbone-src-mac " +
" - Added operational state branch, initially " +
" to match the configuration branch" +
"";
reference "";
}
revision "2016-06-23" {
description "WG document adoption";
reference "";
}
revision "2015-10-15" {
description "Initial revision";
reference "";
}
/* Features */
Brissette, et. al Expires September 12, 2019 [Page 10]
Internet-Draft draft-bess-evpn-yang March 11, 2019
feature ethernet-segment-bgp-params {
description "Ethernet segment's BGP parameters";
}
feature ethernet-segment-pbb-params {
description "Ethernet segment's PBB parameters";
}
/* Typedefs */
typedef status-type {
type enumeration {
enum up {
description "Status is up";
}
enum down {
description "Status is down";
}
}
description "status type";
}
typedef df-election-method-type {
type enumeration {
enum default {
value 0;
description "The default DF election method";
}
enum highest-random-weight {
value 1;
description "The highest random weight (HRW) method";
reference "draft-mohanty-bess-evpn-df-election";
}
enum preference {
value 2;
description "The preference based method";
reference "draft-rabadan-bess-evpn-pref-df";
}
}
description "The DF election method type";
}
typedef ethernet-segment-identifier-type {
type yang:hex-string {
length "29";
}
description "10-octet Ethernet segment identifier (esi),
ex: 00:5a:5a:5a:5a:5a:5a:5a:5a:5a";
}
Brissette, et. al Expires September 12, 2019 [Page 11]
Internet-Draft draft-bess-evpn-yang March 11, 2019
/* EVPN Ethernet Segment YANG Model */
container ethernet-segments {
description "ethernet-segment";
list ethernet-segment {
key "name";
leaf name {
type string;
description "Name of the ethernet segment";
}
leaf service-type {
type string;
config false;
description "service-type";
}
leaf status {
type status-type;
config false;
description "Ethernet segment status";
}
choice ac-or-pw {
description "ac-or-pw";
case ac {
leaf-list ac {
type if:interface-ref;
description "Name of attachment circuit";
}
}
case pw {
leaf-list pw {
type pw:pseudowire-ref;
description "Reference to a pseudowire";
}
}
}
leaf interface-status {
type status-type;
config false;
description "interface status";
}
leaf ethernet-segment-identifier {
type ethernet-segment-identifier-type;
description "Ethernet segment identifier (esi)";
}
choice active-mode {
mandatory true;
description "Choice of active mode";
case single-active {
Brissette, et. al Expires September 12, 2019 [Page 12]
Internet-Draft draft-bess-evpn-yang March 11, 2019
leaf single-active-mode {
type empty;
description "single-active-mode";
}
}
case all-active {
leaf all-active-mode {
type empty;
description "all-active-mode";
}
}
}
container pbb-parameters {
if-feature ethernet-segment-pbb-params;
description "PBB configuration";
leaf backbone-src-mac {
type yang:mac-address;
description "backbone-src-mac, only if this is a PBB";
}
}
container bgp-parameters {
description "BGP parameters";
container common {
description "BGP parameters common to all pseudowires";
list rd-rt {
if-feature ethernet-segment-bgp-params;
key "route-distinguisher";
leaf route-distinguisher {
type rt-types:route-distinguisher;
description "Route distinguisher";
}
uses rt-types:vpn-route-targets;
description "A list of route distinguishers and " +
"corresponding VPN route targets";
}
}
}
container df-election {
description "df-election";
leaf df-election-method {
type df-election-method-type;
description "The DF election method";
}
leaf preference {
when "../df-election-method = 'preference'" {
description "The preference value is only applicable " +
"to the preference based method";
}
Brissette, et. al Expires September 12, 2019 [Page 13]
Internet-Draft draft-bess-evpn-yang March 11, 2019
type uint16;
description "The DF preference";
}
leaf revertive {
when "../df-election-method = 'preference'" {
description "The revertive value is only applicable " +
"to the preference method";
}
type boolean;
default true;
description "The 'preempt' or 'revertive' behavior";
}
leaf election-wait-time {
type uint32;
description "election-wait-time";
}
}
leaf ead-evi-route {
type boolean;
default false;
description "Enable (true) or disable (false) ead-evi-route";
}
leaf esi-label {
type rt-types:mpls-label;
config false;
description "esi-label";
}
list member {
config false;
leaf ip-address {
type inet:ip-address;
description "ip-address";
}
description "member of the ethernet segment";
}
list df {
config false;
leaf service-identifier {
type uint32;
description "service-identifier";
}
leaf vlan {
type uint32;
description "vlan";
}
leaf ip-address {
type inet:ip-address;
description "ip-address";
Brissette, et. al Expires September 12, 2019 [Page 14]
Internet-Draft draft-bess-evpn-yang March 11, 2019
}
description "df of an evpn instance's vlan";
}
description "An ethernet segment";
}
}
}
<CODE ENDS>
4.2 EVPN Yang Module
<CODE BEGINS> file "ietf-evpn@2019-03-09.yang"
module ietf-evpn {
namespace "urn:ietf:params:xml:ns:yang:ietf-evpn";
prefix "evpn";
import ietf-inet-types {
prefix "inet";
}
import ietf-yang-types {
prefix "yang";
}
import ietf-routing-types {
prefix "rt-types";
}
import ietf-network-instance {
prefix "ni";
}
import ietf-l2vpn {
prefix "l2vpn";
}
import ietf-pseudowires {
prefix "pw";
}
import ietf-ethernet-segment {
prefix "es";
}
organization "ietf";
contact "ietf";
Brissette, et. al Expires September 12, 2019 [Page 15]
Internet-Draft draft-bess-evpn-yang March 11, 2019
description "evpn";
revision "2019-03-09" {
description " - Incorporated ietf-ethernet-segment model and" +
" normalised ethernet-segment entries on routes " +
" - Updated Route-target lists to rt-types:vpn-route-targets " +
"";
reference "";
}
revision "2018-02-20" {
description " - Incorporated ietf-network-instance model" +
" on which ietf-l2vpn is now based " +
"";
reference "";
}
revision "2017-10-21" {
description " - Modified the operational state augment " +
" - Renamed evpn-instances-state to evpn-instances" +
" - Added vpws-vlan-aware to an EVPN instance " +
" - Added a new augment to L2VPN to add EPVN " +
" - pseudowire for the case of EVPN VPWS " +
" - Added state change notification " +
"";
reference "";
}
revision "2017-03-13" {
description " - Added an augment to base L2VPN model to " +
" reference an EVPN instance " +
" - Reused ietf-routing-types.yang " +
" vpn-route-targets grouping instead of " +
" defining it in this module " +
"";
reference "";
}
revision "2016-07-08" {
description " - Added operational state" +
" - Added a configuration knob to enable/disable " +
" underlay-multicast " +
" - Added a configuration knob to enable/disable " +
" flooding of unknonw unicast " +
" - Added several configuration knobs " +
" to manage ARP and ND" +
"";
reference "";
Brissette, et. al Expires September 12, 2019 [Page 16]
Internet-Draft draft-bess-evpn-yang March 11, 2019
}
revision "2016-06-23" {
description "WG document adoption";
reference "";
}
revision "2015-10-15" {
description "Initial revision";
reference "";
}
feature evpn-bgp-params {
description "EVPN's BGP parameters";
}
feature evpn-pbb-params {
description "EVPN's PBB parameters";
}
/* Identities */
identity evpn-notification-state {
description "The base identity on which EVPN notification " +
"states are based";
}
identity MAC-duplication-detected {
base "evpn-notification-state";
description "MAC duplication is detected";
}
identity mass-withdraw-received {
base "evpn-notification-state";
description "Mass withdraw received";
}
identity static-MAC-move-detected {
base "evpn-notification-state";
description "Static MAC move is detected";
}
/* Typedefs */
typedef evpn-instance-ref {
type leafref {
path "/evpn/evpn-instances/evpn-instance/name";
}
Brissette, et. al Expires September 12, 2019 [Page 17]
Internet-Draft draft-bess-evpn-yang March 11, 2019
description "A leafref type to an EVPN instance";
}
/* Groupings */
grouping route-rd-rt-grp {
description "A grouping for a route's route distinguishers " +
"and route targets";
list rd-rt {
key "route-distinguisher";
leaf route-distinguisher {
type rt-types:route-distinguisher;
description "Route distinguisher";
}
list vpn-target {
key "route-target";
leaf route-target {
type rt-types:route-target;
description "BGP route target";
}
description "A list of route targets";
}
description "A list of route distinguishers and " +
"corresponding VPN route targets";
}
}
grouping next-hop-label-grp {
description "next-hop-label-grp";
leaf next-hop {
type inet:ip-address;
description "next-hop";
}
leaf label {
type rt-types:mpls-label;
description "label";
}
}
grouping next-hop-label2-grp {
description "next-hop-label2-grp";
leaf label2 {
type rt-types:mpls-label;
description "label2";
}
}
grouping path-detail-grp {
Brissette, et. al Expires September 12, 2019 [Page 18]
Internet-Draft draft-bess-evpn-yang March 11, 2019
description "path-detail-grp";
container detail {
config false;
description "path details";
container attributes {
leaf-list extended-community {
type string;
description "extended-community";
}
description "attributes";
}
leaf bestpath {
type empty;
description "Indicate this path is the best path";
}
}
}
/* EVPN YANG Model */
container evpn {
description "evpn";
container common {
description "common epn attributes";
choice replication-type {
description "A choice of replication type";
case ingress-replication {
leaf ingress-replication {
type boolean;
description "ingress-replication";
}
}
case p2mp-replication {
leaf p2mp-replication {
type boolean;
description "p2mp-replication";
}
}
}
}
container evpn-instances {
description "evpn-instances";
list evpn-instance {
key "name";
description "An EVPN instance";
leaf name {
type string;
description "Name of EVPN instance";
Brissette, et. al Expires September 12, 2019 [Page 19]
Internet-Draft draft-bess-evpn-yang March 11, 2019
}
leaf evi {
type uint32;
description "evi";
}
container pbb-parameters {
if-feature "evpn-pbb-params";
description "PBB parameters";
leaf source-bmac {
type yang:hex-string;
description "source-bmac";
}
}
container bgp-parameters {
description "BGP parameters";
container common {
description "BGP parameters common to all pseudowires";
list rd-rt {
if-feature evpn-bgp-params;
key "route-distinguisher";
leaf route-distinguisher {
type rt-types:route-distinguisher;
description "Route distinguisher";
}
uses rt-types:vpn-route-targets;
description "A list of route distinguishers and " +
"corresponding VPN route targets";
}
}
}
leaf arp-proxy {
type boolean;
default false;
description "Enable (TRUE) or disable (FALSE) ARP proxy";
}
leaf arp-suppression {
type boolean;
default false;
description "Enable (TRUE) or disable (FALSE) " +
"ARP suppression";
}
leaf nd-proxy {
type boolean;
default false;
description "Enable (TRUE) or disable (FALSE) ND proxy";
}
leaf nd-suppression {
type boolean;
Brissette, et. al Expires September 12, 2019 [Page 20]
Internet-Draft draft-bess-evpn-yang March 11, 2019
default false;
description "Enable (TRUE) or disable (FALSE) " +
"ND suppression";
}
leaf underlay-multicast {
type boolean;
default false;
description "Enable (TRUE) or disable (FALSE) " +
"underlay multicast";
}
leaf flood-unknown-unicast-supression {
type boolean;
default false;
description "Enable (TRUE) or disable (FALSE) " +
"flood unknown unicast suppression";
}
leaf vpws-vlan-aware {
type boolean;
default false;
description "Enable (TRUE) or disable (FALSE) " +
"VPWS VLAN aware";
}
container routes {
config false;
description "routes";
list ethernet-auto-discovery-route {
uses route-rd-rt-grp;
leaf ethernet-segment-identifier {
type es:ethernet-segment-identifier-type;
description "Ethernet segment identifier (esi)";
}
leaf ethernet-tag {
type uint32;
description "An ethernet tag (etag) indentifying a " +
"broadcast domain";
}
list path {
uses next-hop-label-grp;
uses path-detail-grp;
description "path";
}
description "ethernet-auto-discovery-route";
}
list mac-ip-advertisement-route {
uses route-rd-rt-grp;
leaf ethernet-segment-identifier {
type es:ethernet-segment-identifier-type;
description "Ethernet segment identifier (esi)";
Brissette, et. al Expires September 12, 2019 [Page 21]
Internet-Draft draft-bess-evpn-yang March 11, 2019
}
leaf ethernet-tag {
type uint32;
description "An ethernet tag (etag) indentifying a " +
"broadcast domain";
}
leaf mac-address {
type yang:mac-address;
description "Route mac address";
}
leaf mac-address-length {
type uint8 {
range "0..48";
}
description "mac address length";
}
leaf ip-prefix {
type inet:ip-prefix;
description "ip-prefix";
}
list path {
uses next-hop-label-grp;
uses next-hop-label2-grp;
uses path-detail-grp;
description "path";
}
description "mac-ip-advertisement-route";
}
list inclusive-multicast-ethernet-tag-route {
uses route-rd-rt-grp;
leaf originator-ip-prefix {
type inet:ip-prefix;
description "originator-ip-prefix";
}
list path {
uses next-hop-label-grp;
uses path-detail-grp;
description "path";
}
description "inclusive-multicast-ethernet-tag-route";
}
list ethernet-segment-route {
uses route-rd-rt-grp;
leaf ethernet-segment-identifier {
type es:ethernet-segment-identifier-type;
description "Ethernet segment identifier (esi)";
}
leaf originator-ip-prefix {
Brissette, et. al Expires September 12, 2019 [Page 22]
Internet-Draft draft-bess-evpn-yang March 11, 2019
type inet:ip-prefix;
description "originator ip-prefix";
}
list path {
leaf next-hop {
type inet:ip-address;
description "next-hop";
}
uses path-detail-grp;
description "path";
}
description "ethernet-segment-route";
}
list ip-prefix-route {
uses route-rd-rt-grp;
leaf ethernet-segment-identifier {
type es:ethernet-segment-identifier-type;
description "Ethernet segment identifier (esi)";
}
leaf ip-prefix {
type inet:ip-prefix;
description "ip-prefix";
}
list path {
uses next-hop-label-grp;
uses path-detail-grp;
description "path";
}
description "ip-prefix route";
}
}
container statistics {
config false;
description "Statistics";
leaf tx-count {
type yang:zero-based-counter32;
description "transmission count";
}
leaf rx-count {
type yang:zero-based-counter32;
description "receive count";
}
container detail {
description "Detailed statistics";
leaf broadcast-tx-count {
type yang:zero-based-counter32;
description "broadcast transmission count";
}
Brissette, et. al Expires September 12, 2019 [Page 23]
Internet-Draft draft-bess-evpn-yang March 11, 2019
leaf broadcast-rx-count {
type yang:zero-based-counter32;
description "broadcast receive count";
}
leaf multicast-tx-count {
type yang:zero-based-counter32;
description "multicast transmission count";
}
leaf multicast-rx-count {
type yang:zero-based-counter32;
description "multicast receive count";
}
leaf unknown-unicast-tx-count {
type yang:zero-based-counter32;
description "unknown unicast transmission count";
}
leaf unknown-unicast-rx-count {
type yang:zero-based-counter32;
description "unknown-unicast receive count";
}
}
}
}
}
}
/* augments */
augment "/pw:pseudowires/pw:pseudowire/pw:pw-type" {
description "Augment for an L2VPN instance to add EVPN VPWS " +
"pseudowire";
case evpn-pw {
container evpn-pw {
description "EVPN pseudowire";
leaf remote-id {
type uint32;
description "Remote pseudowire ID";
}
leaf local-id {
type uint32;
description "Local pseudowire ID";
}
}
}
}
augment "/ni:network-instances/ni:network-instance/ni:ni-type" +
"/l2vpn:l2vpn" {
Brissette, et. al Expires September 12, 2019 [Page 24]
Internet-Draft draft-bess-evpn-yang March 11, 2019
description "Augment for an L2VPN instance and EVPN association";
leaf evpn-instance {
type evpn-instance-ref;
description "Reference to an EVPN instance";
}
}
augment "/ni:network-instances/ni:network-instance/ni:ni-type" +
"/l2vpn:l2vpn" {
when "l2vpn:type = 'l2vpn:vpls-instance-type'" {
description "Constraints only for VPLS pseudowires";
}
description "Augment for VPLS instance";
container vpls-contstraints {
must "not(boolean(/pw:pseudowires/pw:pseudowire" +
" [pw:name = current()/../l2vpn:endpoint" +
" /l2vpn:pw/l2vpn:name]" +
" /evpn-pw/remote-id)) and " +
"not(boolean(/pw:pseudowires/pw:pseudowire" +
" [pw:name = current()/../l2vpn:endpoint" +
" /l2vpn:pw/l2vpn:name]" +
" /evpn-pw/local-id)) and " +
"not(boolean(/pw:pseudowires/pw:pseudowire" +
" [pw:name = current()/../l2vpn:endpoint" +
" /l2vpn:primary-pw/l2vpn:name]" +
" /evpn-pw/remote-id)) and " +
"not(boolean(/pw:pseudowires/pw:pseudowire" +
" [pw:name = current()/../l2vpn:endpoint" +
" /l2vpn:primary-pw/l2vpn:name]" +
" /evpn-pw/local-id)) and " +
"not(boolean(/pw:pseudowires/pw:pseudowire" +
" [pw:name = current()/../l2vpn:endpoint" +
" /l2vpn:backup-pw/l2vpn:name]" +
" /evpn-pw/remote-id)) and " +
"not(boolean(/pw:pseudowires/pw:pseudowire" +
" [pw:name = current()/../l2vpn:endpoint" +
" /l2vpn:backup-pw/l2vpn:name]" +
" /evpn-pw/local-id))" {
description "A VPLS pseudowire must not be EVPN PW";
}
description "VPLS constraints";
}
}
/* Notifications */
notification evpn-state-change-notification {
description "EVPN state change notification";
Brissette, et. al Expires September 12, 2019 [Page 25]
Internet-Draft draft-bess-evpn-yang March 11, 2019
leaf evpn-instance {
type evpn-instance-ref;
description "Related EVPN instance";
}
leaf state {
type identityref {
base evpn-notification-state;
}
description "State change notification";
}
}
}
<CODE ENDS>
5. Security Considerations
The configuration, state, action and notification data defined in
this document are designed to be accessed via the NETCONF protocol
[RFC6241]. The lowest NETCONF layer is the secure transport layer
and the mandatory-to-implement secure transport is SSH [RFC6242]. The
NETCONF access control model [RFC6536] provides means to restrict
access for particular NETCONF users to a pre-configured subset of all
available NETCONF protocol operations and content.
The security concerns listed above are, however, no different than
faced by other routing protocols. Hence, this draft does not change
any underlying security issues inherent in [I-D.ietf-netmod-routing-
cfg]
6. IANA Considerations
None.
7. References
7.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, DOI
10.17487/RFC2119, March 1997, <https://www.rfc-
editor.org/info/rfc2119>.
[RFC6991] Schoenwaelder, J., Ed., "Common YANG Data Types",
RFC 6991, DOI 10.17487/RFC6991, July 2013,
<https://www.rfc-editor.org/info/rfc6991>.
[RFC8294] Liu, X., Qu, Y., Lindem, A., Hopps, C., and L. Berger,
"Common YANG Data Types for the Routing Area", RFC 8294,
Brissette, et. al Expires September 12, 2019 [Page 26]
Internet-Draft draft-bess-evpn-yang March 11, 2019
DOI 10.17487/RFC8294, December 2017, <https://www.rfc-
editor.org/info/rfc8294>.
7.2. Informative References
[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,
<https://www.rfc-editor.org/info/rfc6241>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010, <https://www.rfc-
editor.org/info/rfc6020>.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, DOI 10.17487/RFC6242, June 2011,
<https://www.rfc-editor.org/info/rfc6242>.
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536, DOI
10.17487/RFC6536, March 2012, <https://www.rfc-
editor.org/info/rfc6536>.
[RFC7209] Sajassi, A., Aggarwal, R., Uttaro, J., Bitar, N.,
Henderickx, W., and A. Isaac, "Requirements for Ethernet
VPN (EVPN)", RFC 7209, DOI 10.17487/RFC7209, May 2014,
<https://www.rfc-editor.org/info/rfc7209>.
[RFC7432] Sajassi, A., Ed., Aggarwal, R., Bitar, N., Isaac, A.,
Uttaro, J., Drake, J., and W. Henderickx, "BGP MPLS-Based
Ethernet VPN", RFC 7432, DOI 10.17487/RFC7432, February
2015, <https://www.rfc-editor.org/info/rfc7432>.
[RFC7623] Sajassi, A., Ed., Salam, S., Bitar, N., Isaac, A., and W.
Henderickx, "Provider Backbone Bridging Combined with
Ethernet VPN (PBB-EVPN)", RFC 7623, DOI 10.17487/RFC7623,
September 2015, <https://www.rfc-editor.org/info/rfc7623>.
[RFC8214] Boutros, S., Sajassi, A., Salam, S., Drake, J., and J.
Rabadan, "Virtual Private Wire Service Support in Ethernet
VPN", RFC 8214, DOI 10.17487/RFC8214, August 2017,
<https://www.rfc-editor.org/info/rfc8214>.
Authors' Addresses
Brissette, et. al Expires September 12, 2019 [Page 27]
Internet-Draft draft-bess-evpn-yang March 11, 2019
Patrice Brissette
Cisco Systems, Inc.
EMail: pbrisset@cisco.com
Himanshu Shah
Ciena Corporation
EMail: hshah@ciena.com
Helen Chen
Jabil
EMail: Ing-Wher_Chen@jabil.com
Iftekar Hussain
Infinera Corporation
EMail: ihussain@infinera.com
Kishore Tiruveedhula
Juniper Networks
EMail: kishoret@juniper.net
Jorge Rabadan
Nokia
EMail: jorge.rabadan@nokia.com
Ali Sajassi
Cisco Systems, Inc.
EMail: sajassi@cisco.com
Zhenbin Li
Huawei Technologies
EMail: lizhenbin@huawei.com
Brissette, et. al Expires September 12, 2019 [Page 28]
