| Internet-Draft | draft-wang-ccamp-flexe-yang | May 2022 |
| Wang, et al. | Expires 17 November 2022 | [Page] |
This document defines a service provider targeted YANG data model for the configuration and management of a Flex Ethernet (FlexE) network, including FlexE groups. It also supports the configuration of each FlexE client as an interface. The YANG module in this document conforms to the Network Management Datastore Architecture (NMDA).¶
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 https://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 17 November 2022.¶
Copyright (c) 2022 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 (https://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 Revised BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Revised BSD License.¶
From a service provider's point of view, a transport network with Flex Ethernet (FlexE) support is usually deployed with all FlexE Groups configured at first, and then FlexE clients are added one by one at a later stage. This document defines a service provider targeted YANG data model for the configuration and management of FlexE, including FlexE groups and FlexE clients. It supports the configuration of FlexE client as an interface as the data model of FlexE client is augmented based on the generic interfaces data model as defined in [RFC8343]. Furthermore, when a FlexE transport network is used to backhaul 5G mobile services, synchronization channel can also be imbedded in a FlexE PHY. The specific PHY used for synchronization channel can be retrieved for management. Other FlexE attributes are based on the FlexE 2.1 Implementation Agreement as specified in [FLEXE].¶
Note that this document would only focus on the configuration and maintenance of the FlexE interfaces. Cross connection of FlexE timeslots in a network node is tentatively out of the scope of this document.¶
The YANG modules in this document conforms to the Network Management Datastore Architecture (NMDA) [RFC8342].¶
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.¶
A simplified graphical representation of the data model is used in this document. The meaning of the symbols in the YANG data tree presented later in this document is defined in [RFC8340]. They are provided below for reference.¶
o Brackets "[" and "]" enclose list keys.¶
o Abbreviations before data node names: "rw" means configuration (read-write) and "ro" state data (read-only).¶
o Symbols after data node names: "?" means an optional node, "!" means a presence container, and "*" denotes a list and leaf-list¶
o Parentheses enclose choice and case nodes, and case nodes are also marked with a colon (":").¶
o Ellipsis ("...") stands for contents of subtrees that are not shown.¶
o Some of the key terms used in this document are listed as follow.¶
The terminology for describing YANG data models is found in [RFC7950].¶
Most terminologies used in this document are extracted from [FLEXE].¶
Calendar: The total capacity of a FlexE Group is represented as a collection of slots. The calendar for a FlexE Group composed of n PHYs is represented in each PHY as an array of slots (e.g., each representing 5Gbps of bandwidth), i.e., timeslot-list string.¶
Ethernet PHY: an entity representing Ethernet Physical Coding Sublayer (PCS), Physical Media Attachment (PMA), and Physical Media Dependent (PMD) layers. Each PHY is consisted of one or more FlexE Instance (e.g., a 400GBASE-R PHY has four FlexE Instances).¶
FlexE: Flex Ethernet.¶
FlexE Client: An Ethernet flow based on a MAC data rate that may or may not correspond to any Ethernet PHY rate.¶
FlexE Group: A FlexE Group is composed of from 1 to n Ethernet PHYs.¶
FlexE PHY: 50GBASE-R, 100GBASE-R, 200GBASE-R, 400GBASE-R are defined as FlexE PHY by OIF FlexE IA.¶
In following sections, the requirements are summarized according to the descriptions in OIF FlexE Implementation Agreement and ITU-T FlexE related standards e.g. [ITU-T_G.8023]. FlexE YANG data model targets to provide the configurations of the functions, as well as to report the real states and verify the consistency between the configuration and the real states. The requirements of FlexE groups and FlexE clients are summarized and illustrated as follows.¶
Requirements of the FlexE group include,¶
R-Group-01 The model SHALL support the management of the FlexE group, consisting of one or more Ethernet PHY(s).¶
R-Group-02 The model SHOULD be able to verify that the collection of Ethernet PHY(s) included in a FlexE group have the same characteristics (e.g. number of PHYs, timeslots of PHYs, etc.) at the local FlexE shims. If inconsistency exists, notifications (e.g. errors) SHOULD be invoked.¶
Requirements of the FlexE client include,¶
R-Client-01 The model SHALL support to assign required calendar slots to transport the FlexE clients. The assigned calendar slots MAY be in different FlexE timeslots with different ETH PHYs.¶
R-Client-02 The model SHALL support to add FlexE client(s) into or remove FlexE client(s) from the FlexE group, without affecting the other existing FlexE clients whose size and calendar slot assignments are not changed.¶
This section describes the hierarchy of the YANG modules for the FlexE management.¶
Configuration management of FlexE group includes:¶
Configuration management of a FlexE client includes:¶
A simplified YANG tree diagram [RFC8340] representing the data model is typically used by YANG modules. This document uses the same tree diagram syntax as described in [RFC8340].¶
A tree diagram of FlexE group is depicted as the following:¶
module: ietf-flexe
+--rw flexe
+--rw flexe-groups
+--rw flexe-group* [index]
+--rw index uint32
+--rw group-num uint32
+--rw negotiation-mode negotiation-mode-type
+--ro total-bandwidth string
+--ro free-bandwidth? string
+--ro sync-phy-number uint32
+--rw flexe-phys
+--rw flexe-phy-list* [port-name]
+--rw port-name if:interface-ref
+--rw phy-number uint32
+--ro free-timeslot-list string
+--ro used-timeslot-list string
¶
A tree diagram of FlexE client is depicted as the following:¶
augment /if:interfaces/if:interface:
+--rw flexe-client
+--rw client-index uint32
+--rw group-index leafref
+--rw client-num uint32
+--rw timeslot-lists
+--rw timeslot-list* [port-name]
+--rw port-name if:interface-ref
+--rw time-slot string
¶
The following YANG data module augments the interface container defined in [RFC8343] for a FlexE group interface. It imports iana-if-type [RFC7224] and ietf-interfaces [RFC8343].¶
<CODE BEGINS> file "ietf-flexe@2022-05-16.yang"
module ietf-flexe {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-flexe";
prefix "flexe";
import iana-if-type {
prefix ianaift;
}
import ietf-interfaces {
prefix if;
reference
"RFC8343: A YANG Data Model for Interface Management";
}
organization "IETF CCAMP Working Group";
contact
"WG Web: http://tools.ietf.org/wg/ccamp/
WG List: <mailto:ccamp@ietf.org>
Author: Minxue Wang
<mailto: wangminxue@chinamobile.com>
Author: Liuyan Han
<mailto: hanliuyan@chinamobile.com>
Author: Fan Yang
<mailto:shirley.yangfan@huawei.com>
Author: Xiaobing Niu
<mailto: niu.xiaobing@zte.com.cn>
Author: Luis M. Contreras
<mailto:luismiguel.contrerasmurillo@telefonica.com>
Author: Xufeng Liu
<mailto:xufeng.liu.ietf@gmail.com>";
description
"This YANG module defines a data model for the configuration
of a FlexE network.";
revision "2022-05-16" {
description "the third version";
reference
"draft-wang-ccamp-flexe-yang-cm-03: YANG Data Model for FlexE
Management";
}
typedef negotiation-mode-type {
type enumeration {
enum "dynamic" {
value 1;
description
"Dynamic mode.";
}
enum "static" {
value 2;
description
"Static mode.";
}
}
description
"Negotiation mode of a FlexE group.";
}
container flexe {
description
"Specify FlexE configuration information.";
container flexe-groups {
description
"List of FlexE groups.";
list flexe-group {
key "index";
description
"Configure FlexE group.";
leaf index {
type uint32 {
range "1..65535";
}
description
"FlexE group index.";
}
leaf group-num {
type uint32 {
range "1..1048574";
}
mandatory true;
description
"FlexE group number, as specified in OIF FlexE 2.1.";
}
leaf negotiation-mode {
type negotiation-mode-type;
mandatory true;
description
"FlexE group calendar negotiation mode, the default
value is 'dynamic'.";
}
leaf total-bandwidth {
type string {
length "1..9";
}
config false;
mandatory true;
description
"FlexE group total bandwidth in Gbit/s, such as 10.";
}
leaf free-bandwidth {
type string {
length "1..9";
}
config false;
description
"FlexE group free bandwidth in Gbit/s, such as 100.";
}
leaf sync-phy-number {
type uint32 {
range "1..254";
}
config false;
mandatory true;
description
"The FlexE PHY number used for synchronization management
channel in a FlexE group, which is one of the PHY number
value in a FlexE group.";
}
container flexe-phys {
description
"List of physical port information in a FlexE Group.";
list flexe-phy {
key "port-name";
description
"FlexE PHY port name.";
leaf port-name {
type if:interface-ref;
description
"Physical port name. ";
}
leaf phy-number {
type uint32 {
range "1..254";
}
mandatory true;
description
"Number of a FlexE physical port. The PHY number of
a 100G port is an integer ranging from 1 to 254.
The PHY number of a 50G port is an integer ranging
from 1 to 126.";
}
leaf free-timeslot-list {
type string {
length "1..199";
}
config false;
mandatory true;
description
"Free timeslots of a FlexE PHY. The string
consists of one or more numbers separated by
commas (,) or hyphens (-), e.g.'1-5' indicates
1,2,3,4,5 timeslots, '0,5,7-10' indicates
0,5,7,8,9,10 timeslots.";
}
leaf used-timeslot-list {
type string {
length "1..199";
}
config false;
mandatory true;
description
"Used timeslots of a FlexE PHY. The string
consists of one or more numbers separated by
commas (,) or hyphens (-), e.g.'1-5' indicates
1,2,3,4,5 timeslots, '0,5,7-10' indicates
0,5,7,8,9,10 timeslots.";
}
}
}
}
}
}
}
<CODE ENDS>¶
<CODE BEGINS> file "ietf-flexe@2022-05-16.yang"
module ietf-flexe {
yang-version 1.1;
namespace "urn:ietf:params:xml:ns:yang:ietf-flexe";
prefix "flexe";
import iana-if-type {
prefix ianaift;
}
import ietf-interfaces {
prefix if;
reference
"RFC8343: A YANG Data Model for Interface Management";
}
organization "IETF CCAMP Working Group";
contact
"WG Web: http://tools.ietf.org/wg/ccamp/
WG List: <mailto:ccamp@ietf.org>
Author: Minxue Wang
<mailto: wangminxue@chinamobile.com>
Author: Liuyan Han
<mailto: hanliuyan@chinamobile.com>
Author: Fan Yang
<mailto:shirley.yangfan@huawei.com>
Author: Xiaobing Niu
<mailto: niu.xiaobing@zte.com.cn>
Author: Luis M. Contreras
<mailto:luismiguel.contrerasmurillo@telefonica.com>
Author: Xufeng Liu
<mailto:xufeng.liu.ietf@gmail.com>";
description
"This YANG module defines a data model for the configuration
of a FlexE client.";
revision "2022-05-16" {
description "the third version";
reference
"draft-wang-ccamp-flexe-yang-cm-03: YANG Data Model for FlexE
Management";
}
augment "/if:interfaces/if:interface" {
when "if:type = 'ianaift:flexEclient'" {
description "Applies to FlexE client interfaces";
}
description
"Augment interface model with FlexE client interface specific
configuration nodes. Each flexe client interface represents a
FlexE client configured in a device.";
container flexe-client {
description
"FlexE client.";
leaf client-index {
type uint32 {
range "1..65535";
}
mandatory true;
description
"FlexE client index.";
}
leaf group-index {
type leafref {
path "/flexe:flexe/flexe:flexe-groups"
+ "/flexe:flexe-group/flexe:index";
}
mandatory true;
description
"A local FlexE group index configured for a client on one
equipment for the sake of simplicity on configuration and
management.";
}
leaf client-num {
type uint32 {
range "1..65534";
}
mandatory true;
description
"FlexE Client number.";
}
container timeslot-lists {
description
"List of binding timeslots.";
list timeslot-list {
key "port-name";
description
"Configure binding timeslots.";
leaf port-name {
type if:interface-ref;
description
"FlexE physical port name.";
}
leaf time-slot {
type string {
length "1..199";
}
mandatory true;
description
"Timeslot allocated for a FlexE client. The string
consists of one or more numbers separated by
commas (,) or hyphens (-), e.g.'1-5' indicates
1,2,3,4,5 timeslots, '0,5,7-10' indicates
0,5,7,8,9,10 timeslots.";
}
}
}
}
}
}
<CODE ENDS>¶
The YANG module specified in this document defines a schema for data that is designed to be accessed via network management protocols such as NETCONF [RFC6241] or RESTCONF [RFC8040]. The lowest NETCONF layer is the secure transport layer, and the mandatory-to-implement secure transport is Secure Shell (SSH) [RFC6242]. The lowest RESTCONF layer is HTTPS, and the mandatory-to-implement secure transport is TLS [RFC8446].¶
The NETCONF access control model [RFC8341] provides the means to restrict access for particular NETCONF or RESTCONF users to a preconfigured subset of all available NETCONF or RESTCONF protocol operations and content.¶
There are a number of data nodes defined in the YANG data modules in this document are writable, and the involved subtrees that are sensitive include:¶
Write operations (e.g., edit-config) to these data nodes without proper protection can have a negative effect on network operations. Specifically, an inappropriate configuration of them may cause an interrupt of a FlexE client flow, drop of all Ethernet frames of a FlexE client, or even break down of a whole FlexE group interface.¶
It is proposed that IANA should assign new URIs from the "IETF XML Registry" [RFC3688] as follows:¶
URI: urn:ietf:params:xml:ns:yang:ietf-flexe Registrant Contact: The IESG XML: N/A; the requested URI is an XML namespace URI: urn:ietf:params:xml:ns:yang:ietf-interfaces-flexe-client Registrant Contact: The IESG XML: N/A; the requested URI is an XML namespace¶
It is proposed that IANA register the following YANG module in the "YANG Module Names" registry:¶
Name: ietf-flexe Namespace: Prefix: flexe Reference: this document¶
It is proposed that IANA register the following YANG module in the "YANG Module Names" registry:¶
Name: ietf-interfaces-flexe-client Namespace: urn:ietf:params:xml:ns:yang:ietf-interfaces-flexe-client Prefix: flexecl Reference: this document¶
It is proposed that IANA register a new IANAifType TBD for the interface type of Flex Ethernet client in the "IANA Interface Type YANG Module" [RFC7224].¶
The authors would like to thank Weiqiang Cheng and Yuanlong Jiang for their valuable suggestions.¶
A FlexE group must be configured first before any client signals are carried over it. The initial configuration commands could be from external management system, SDN controller etc.¶
Currently, the FlexE configuration model shows the necessary parameters about the FlexE group and the FlexE client. That is the base model for further augments or extensions.¶
In this section, more details about parameters in the model are elaborated, and some examples are illustrated based on following figure.¶
+--------+ +---------+
| | 1 FlexE group 1 | |
FlexE client1-| +----------------------+ |-FlexE client1
| FlexE | 2 2 | FlexeE |
FlexE client2-| mux +----------------------+ demux |-FlexE client2
| | 3 3 | |
| +----------------------+ |
| | 4 4 | |
| +----------------------+ |
+--------+ +---------+
The FlexE group YANG tree is shown in section 4. More explanations for the flexe-group data node include,¶
<flexe-group>
<index>20221</index>
<group-num>2222</group-num>
<negotiation-mode>static</negotiation-mode>
<flexe-phys>
<flexe-phy>
<port-name>ifa001</port-name>
<phy-number>1</phy-number>
</flexe-phy>
<flexe-phy>
<port-name>ifa002</port-name>
<phy-number>2</phy-number>
</flexe-phy>
<flexe-phy>
<port-name>ifa003</port-name>
<phy-number>3</phy-number>
</flexe-phy>
<flexe-phy>
<port-name>ifa004</port-name>
<phy-number>4</phy-number>
</flexe-phy>
</flexe-phys>
</flexe-group>
While in the FlexE demux, part of the configuration for FlexE group is shown as follows,¶
<flexe-group>
<index>3001</index>
<group-num>2222</group-num>
<negotiation-mode>static</negotiation-mode>
<flexe-phys>
<flexe-phy>
<port-name>ifb001</port-name>
<phy-number>1</phy-number>
</flexe-phy>
<flexe-phy>
<port-name>ifb002</port-name>
<phy-number>2</phy-number>
</flexe-phy>
<flexe-phy>
<port-name>ifb003</port-name>
<phy-number>3</phy-number>
</flexe-phy>
<flexe-phy>
<port-name>ifb004</port-name>
<phy-number>4</phy-number>
</flexe-phy>
</flexe-phys>
</flexe-group>
Based on the configuration above, the running states in the FlexE device can be gotten by using NETCONF Get command. To FlexE group, the running states include total-bandwidth and free-bandwidth of the FlexE group, and free-timeslot-list and used-timeslot-list of each PHY in the FlexE group.¶
he FlexE client YANG tree is shown in section 4. More explanations for the flexe-client data node include,¶
For example, two FlexE clients are configured to be transported by the FlexE group in section 4.1.¶
The bandwidth of the first FlexE client is 10Gb/s, and the assigned calendar slots include two 5G slots.¶
The bandwidth of the second FlexE client is 200Gb/s, and the assigned calendar slots include 40 5G slots, exactly located in two 100G PHYs. This configuration shows the capability of FlexE bonding.¶
Part of the configuration for the first and second FlexE client in FlexE mux is shown as follows,¶
<flexe-client>
<client-index>6001</client-index>
<group-index>20221</group-index>
<client-num>1001</client-num>
<timeslot-lists>
<timeslot-list>
<port-num>ifa001</port-num>
<time-slot>1-2</time-slot>
</timeslot-list>
</timeslot-lists>
</flexe-client>
<flexe-client>
<client-index>6002</client-index>
<group-index>20221</group-index>
<client-num>1002</client-num>
<timeslot-lists>
<timeslot-list>
<port-num>ifa002</port-num>
<time-slot>1-20</time-slot>
</timeslot-list>
<timeslot-list>
<port-num>ifa003</port-num>
<time-slot>1-20</time-slot>
</timeslot-list>
</timeslot-lists>
</flexe-client>
Part of the configuration for the first and second FlexE client in FlexE demux is shown as follows,¶
<flexe-client>
<client-index>7001</client-index>
<group-index>3001</group-index>
<client-num>1001</client-num>
<timeslot-lists>
<timeslot-list>
<port-num>ifb001</port-num>
<time-slot>1-2</time-slot>
</timeslot-list>
</timeslot-lists>
</flexe-client>
<flexe-client>
<client-index>7002</client-index>
<group-index>3001</group-index>
<client-num>1002</client-num>
<timeslot-lists>
<timeslot-list>
<port-num>ifb002</port-num>
<time-slot>1-20</time-slot>
</timeslot-list>
<timeslot-list>
<port-num>ifb003</port-num>
<time-slot>1-20</time-slot>
</timeslot-list>
</timeslot-lists>
</flexe-client>