Internet-Draft Client Tunnel YANG Model March 2023
Zheng, et al. Expires 7 September 2023 [Page]
CCAMP Working Group
Intended Status:
Standards Track
H. Zheng
Huawei Technologies
A. Guo
I. Busi
Huawei Technologies
Y. Xu
Y. Zhao
China Mobile
X. Liu
Volta Networks

A YANG Data Model for Client-layer Tunnel


A transport network is a server-layer network to provide connectivity services to its client. In this draft the tunnel of client is described, with the definition of client tunnel YANG model.

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

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 7 September 2023.

Table of Contents

1. Introduction

A transport network is a server-layer network designed to provide connectivity services for a client-layer network to carry the client traffic transparently across the server-layer network resources. The tunnel model in Traffic-Engineered network has been defined in both generic way and technology-specific way. The generic model, which is the base TE tunnel YANG model, can be found at [I-D.ietf-teas-yang-te]. Technology-specific models, such as OTN/WSON tunnel model, have also been defined in [I-D.ietf-ccamp-otn-tunnel-model] and [I-D.ietf-ccamp-wson-tunnel-model] respectively. Corresponding tunnel on client-layer is also required, to have a complete topology view from the perspective of network controllers.

This document defines a data model of all client-layer tunnel, using YANG language defined in [RFC7950]. The model is augmenting the generic TE tunnel model, and can be used by applications exposing to a network controller via a REST interface. Furthermore, it can be used by an application to describe the client tunnel that constructed above the server-layer network. It is also worth noting that the client layer network will only need the tunnel model when there is a demand for switching techniques, such as Carrier Ethernet and MPLS-TP. The transparent signals do not need this model.

2. Terminology and Notations

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.

3. YANG Model for Client-layer Tunnel

3.1. YANG Tree for Ethernet Tunnel

module: ietf-eth-te-tunnel
  augment /te:te/te:tunnels/te:tunnel:
    +--rw src-eth-tunnel-endpoint
    |  +--rw vlanid?     etht-types:vlanid
    |  +--rw tag-type?   etht-types:eth-tag-type
    +--rw dst-eth-tunnel-endpoint
    |  +--rw vlanid?     etht-types:vlanid
    |  +--rw tag-type?   etht-types:eth-tag-type
    +--rw bandwidth-profile
       +--rw bandwidth-profile-name?   string
       +--rw bandwidth-profile-type?   etht-types:bandwidth-profile-type
       +--rw CIR?                      uint64
       +--rw CBS?                      uint64
       +--rw EIR?                      uint64
       +--rw EBS?                      uint64
       +--rw color-aware?              boolean
       +--rw coupling-flag?            boolean

3.2. YANG Tree for Tunnel of other Client Signal Model

This section will be completed later.

4. YANG Code for Client-layer Tunnel

4.1. The ETH Tunnel YANG Code

<CODE BEGINS> file "ietf-eth-te-tunnel@2018-03-01.yang"

module ietf-eth-te-tunnel {

    namespace "urn:ietf:params:xml:ns:yang:ietf-eth-te-tunnel";

    prefix "eth-tunnel";

    import ietf-te {
        prefix "te";

    import ietf-eth-tran-types {
        prefix "etht-types";

        "Internet Engineering Task Force (IETF) CCAMP WG";
      WG List: <>

      ID-draft editor:
        Haomian Zheng (;
        Italo Busi (;
        Aihua Guo (;
        Yunbin Xu (;
        Yang Zhao (;
        Xufeng Liu (;

        "This module defines a model for ETH transport tunnel";

    revision 2018-03-01 {
            "Initial revision";

    grouping eth-tunnel-endpoint {
        description "Parameters for ETH tunnel.";

        leaf vlanid {
            type etht-types:vlanid;
                "VLAN tag id.";

        leaf tag-type {
            type etht-types:eth-tag-type;
            description "VLAN tag type.";

    augment "/te:te/te:tunnels/te:tunnel" {
            "Augment with additional parameters required for ETH

        container src-eth-tunnel-endpoint {
                "Source ETH tunnel endpoint.";

            uses eth-tunnel-endpoint;

        container dst-eth-tunnel-endpoint {
                "Destination ETH tunnel endpoint.";

            uses eth-tunnel-endpoint;

        container bandwidth-profile {
                "ETH tunnel bandwidth profile specification.";

            uses etht-types:etht-bandwidth-profiles;


4.2. Other Client-layer Tunnel YANG Code


5. Considerations and Open Issue

Editor Notes: This section is used to note temporary discussion/conclusion that to be fixed in the future version, and will be removed before publication. This is a part of L2 work, need to discuss how to go with other L2 network models. The expectation is to include all potential L2 TE part in this work.

6. IANA Considerations


7. Manageability Considerations


8. Security Considerations

The data following the model defined in this document is exchanged via, for example, the interface between an orchestrator and a transport network controller. The security concerns mentioned in [I-D.ietf-teas-yang-te] also applies to this document.

The YANG module defined in this document can be accessed via the RESTCONF protocol defined in [RFC8040], or maybe via the NETCONF protocol [RFC6241].

9. Acknowledgements

We would like to thank Igor Bryskin and Daniel King for their comments and discussions.

10. Contributors

Yanlei Zheng China Unicom Email:

Zhe Liu Huawei Technologies, Email:

Sergio Belotti Nokia, Email:

Yingxi Yao Shanghai Bell,

Giuseppe Fioccola Huawei Technologies

11. References

11.1. Normative References

Saad, T., Gandhi, R., Liu, X., Beeram, V. P., Bryskin, I., and O. G. de Dios, "A YANG Data Model for Traffic Engineering Tunnels, Label Switched Paths and Interfaces", Work in Progress, Internet-Draft, draft-ietf-teas-yang-te-31, , <>.
Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed., and A. Bierman, Ed., "Network Configuration Protocol (NETCONF)", RFC 6241, DOI 10.17487/RFC6241, , <>.
Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language", RFC 7950, DOI 10.17487/RFC7950, , <>.
Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF Protocol", RFC 8040, DOI 10.17487/RFC8040, , <>.

11.2. Informative References

Zheng, H., Busi, I., Belotti, S., Lopez, V., and Y. Xu, "OTN Tunnel YANG Model", Work in Progress, Internet-Draft, draft-ietf-ccamp-otn-tunnel-model-17, , <>.
Lee, Y., Zheng, H., Guo, A., Lopez, V., King, D., Yoon, B. Y., and R. Vilalta, "A Yang Data Model for WSON Tunnel", Work in Progress, Internet-Draft, draft-ietf-ccamp-wson-tunnel-model-08, , <>.
Bjorklund, M. and L. Berger, Ed., "YANG Tree Diagrams", BCP 215, RFC 8340, DOI 10.17487/RFC8340, , <>.

Authors' Addresses

Haomian Zheng
Huawei Technologies
H1, XiliuBeipo Village, Songshan Lake
Guangdong, 523808
Aihua Guo
Italo Busi
Huawei Technologies
Yunbin Xu
Yang Zhao
China Mobile
Xufeng Liu
Volta Networks