Skip to main content

OTN Tunnel YANG Model
draft-ietf-ccamp-otn-tunnel-model-02

The information below is for an old version of the document.
Document Type
This is an older version of an Internet-Draft whose latest revision state is "Active".
Authors Haomian Zheng , Aihua Guo , Italo Busi , Anurag Sharma , Rajan Rao , Sergio Belotti , Victor Lopez , Yunbo Li , Yunbin Xu
Last updated 2018-06-19
Replaces draft-sharma-ccamp-otn-tunnel-model
RFC stream Internet Engineering Task Force (IETF)
Formats
Reviews
Additional resources Mailing list discussion
Stream WG state WG Document
Associated WG milestone
Nov 2022
Submit OTN tunnel model to IESG for review
Document shepherd (None)
IESG IESG state I-D Exists
Consensus boilerplate Unknown
Telechat date (None)
Responsible AD (None)
Send notices to (None)
draft-ietf-ccamp-otn-tunnel-model-02
CCAMP Working Group                                             H. Zheng
Internet-Draft                                                    A. Guo
Intended status: Standards Track                                 I. Busi
Expires: December 21, 2018                           Huawei Technologies
                                                               A. Sharma
                                                                  Google
                                                                  R. Rao
                                                                Infinera
                                                              S. Belotti
                                                                   Nokia
                                                                V. Lopez
                                                              Telefonica
                                                                   Y. Li
                                                            China Mobile
                                                                   Y. Xu
                                                                   CAICT
                                                           June 19, 2018

                         OTN Tunnel YANG Model
                  draft-ietf-ccamp-otn-tunnel-model-02

Abstract

   This document describes the YANG data model for OTN Tunnels.

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 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 December 21, 2018.

Copyright Notice

   Copyright (c) 2018 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

Zheng, et al.           Expires December 21, 2018               [Page 1]
Internet-Draft            OTN Tunnel YANG Model                June 2018

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

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Terminology and Notations . . . . . . . . . . . . . . . . . .   2
   3.  OTN Tunnel Model Description  . . . . . . . . . . . . . . . .   3
     3.1.  Overview of OTN Tunnel Model  . . . . . . . . . . . . . .   3
     3.2.  OTN-specific Parameters in Tunnel Model . . . . . . . . .   3
     3.3.  OTN Path Compute RPC  . . . . . . . . . . . . . . . . . .   4
   4.  OTN Tunnel YANG Tree  . . . . . . . . . . . . . . . . . . . .   4
   5.  OTN Tunnel YANG Code  . . . . . . . . . . . . . . . . . . . .  12
   6.  OTN Types YANG Code . . . . . . . . . . . . . . . . . . . . .  30
   7.  Security Considerations . . . . . . . . . . . . . . . . . . .  42
   8.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  42
   9.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .  42
   10. Contributors  . . . . . . . . . . . . . . . . . . . . . . . .  42
   11. References  . . . . . . . . . . . . . . . . . . . . . . . . .  43
     11.1.  Normative References . . . . . . . . . . . . . . . . . .  43
     11.2.  Informative References . . . . . . . . . . . . . . . . .  44
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  44

1.  Introduction

   OTN transport networks can carry various types of client services.
   In many cases, the client signal is carried over an OTN tunnel across
   connected domains in a multi-domain network.  These OTN services can
   either be transported or switched in the OTN network.  If an OTN
   tunnel is switched, then additional parameters need to be provided to
   create a Mux OTN service.

   This document provides YANG model for creating OTN tunnel.  The model
   augments the TE Tunnel 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 draft is defined in

Zheng, et al.           Expires December 21, 2018               [Page 2]
Internet-Draft            OTN Tunnel YANG Model                June 2018

   [I-D.ietf-netmod-yang-tree-diagrams].  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.

3.  OTN Tunnel Model Description

3.1.  Overview of OTN Tunnel Model

   The OTN tunnel model is using TE tunnel [I-D.ietf-teas-yang-te] as a
   basic model and augment to the TE tunnel with OTN-specific
   parameters, including the bandwidth information and label
   information.  It is also worth noting that the OTN tunnel
   provisioning is usually based on the OTN topology.  Therefore the OTN
   tunnel model is usually used together with OTN topology model
   specified in [I-D.ietf-ccamp-otn-topo-yang].

   More scenarios and model applications can be found in
   [I-D.ietf-ccamp-transport-nbi-app-statement] and
   [I-D.ietf-teas-actn-yang].  The current model is following the YANG
   language specification as [RFC7950], and the corresponding protocol
   is recommended to be Netconf protocol in [RFC6241] or RESTconf
   protocol in [RFC8040].

3.2.  OTN-specific Parameters in Tunnel Model

   OTN specific parameters have been augmenting to the TE tunnel models.
   The attributes on both of the source and destination need to be
   configured when setting up the tunnel.  Typical parameters, including
   client signal, TPN, TSG and corresponding tributary slot information,
   are required in the OTN tunnel model.  These parameters are
   consistent with the framework in [RFC7062], and the specification in
   [RFC7138] and [RFC7139].

   The OTN bandwidth information has been augmenting to various sections
   of TE tunnel models, including tunnel bandwidth, primary path

Zheng, et al.           Expires December 21, 2018               [Page 3]
Internet-Draft            OTN Tunnel YANG Model                June 2018

   bandwidth and so on.  The OTN label information has been augmenting
   to label hop of a group of routing objects and also LSPs.

3.3.  OTN Path Compute RPC

   Similarly with TE tunnel, a 'compute-only' mode of OTN tunnel model
   is also supported by specifing a Remote Procedural Call (RPC).  On
   receiving this RPC, the provider is expected to compute the available
   path subject to the constraints specified in RPC and feedback to the
   client without any changing of the OTN network.  Given the OTN tunnel
   computed, the client may query and/or subscribe on the tunnel to be
   notified whenever it changes.

4.  OTN Tunnel YANG Tree

module: ietf-otn-tunnel
  augment /te:te/te:tunnels/te:tunnel:
    +--rw payload-treatment?          enumeration
    +--rw src-client-signal?          identityref
    +--rw src-tpn?                    uint16
    +--rw src-tsg?                    identityref
    +--rw src-tributary-slot-count?   uint16
    +--rw src-tributary-slots
    |  +--rw values*   uint8
    +--rw dst-client-signal?          identityref
    +--rw dst-tpn?                    uint16
    +--rw dst-tsg?                    identityref
    +--rw dst-tributary-slot-count?   uint16
    +--rw dst-tributary-slots
       +--rw values*   uint8
  augment /te:te/te:globals/te:named-path-constraints
          /te:named-path-constraint/te:te-bandwidth/te:technology:
    +--:(otn)
       +--rw odu-type?   identityref
  augment /te:te/te:tunnels/te:tunnel/te:te-bandwidth/te:technology:
    +--:(otn)
       +--rw odu-type?   identityref
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:te-bandwidth/te:technology:
    +--:(otn)
       +--rw odu-type?   identityref
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:p2p-reverse-primary-path
          /te:te-bandwidth/te:technology:
    +--:(otn)

Zheng, et al.           Expires December 21, 2018               [Page 4]
Internet-Draft            OTN Tunnel YANG Model                June 2018

       +--rw odu-type?   identityref
  augment /te:te/te:tunnels/te:tunnel/te:p2p-secondary-paths
          /te:p2p-secondary-path/te:te-bandwidth/te:technology:
    +--:(otn)
       +--rw odu-type?   identityref
  augment /te:te/te:globals/te:named-path-constraints
          /te:named-path-constraint/te:explicit-route-objects
          /te:route-object-exclude-always/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:globals/te:named-path-constraints
          /te:named-path-constraint/te:explicit-route-objects
          /te:route-object-include-exclude/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:explicit-route-objects
          /te:route-object-exclude-always/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:explicit-route-objects
          /te:route-object-include-exclude/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:optimizations/te:algorithm/te:metric
          /te:optimization-metric/te:explicit-route-exclude-objects
          /te:route-object-exclude-object/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:optimizations/te:algorithm/te:metric

Zheng, et al.           Expires December 21, 2018               [Page 5]
Internet-Draft            OTN Tunnel YANG Model                June 2018

          /te:optimization-metric/te:explicit-route-include-objects
          /te:route-object-include-object/te:type/te:label/te:label-hop
          /te:te-label/te:technology:
    +--:(otn)
       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:state/te:path-properties
          /te:path-route-objects/te:path-computed-route-object
          /te:state/te:type/te:label/te:label-hop/te:te-label
          /te:technology:
    +--:(otn)
       +--ro tpn?       uint16
       +--ro tsg?       identityref
       +--ro ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:state/te:lsps/te:lsp
          /te:path-properties/te:path-route-objects
          /te:path-computed-route-object/te:state/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--ro tpn?       uint16
       +--ro tsg?       identityref
       +--ro ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:p2p-reverse-primary-path
          /te:explicit-route-objects/te:route-object-exclude-always
          /te:type/te:label/te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:p2p-reverse-primary-path
          /te:explicit-route-objects/te:route-object-include-exclude
          /te:type/te:label/te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:p2p-reverse-primary-path
          /te:optimizations/te:algorithm/te:metric
          /te:optimization-metric/te:explicit-route-exclude-objects
          /te:route-object-exclude-object/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)

Zheng, et al.           Expires December 21, 2018               [Page 6]
Internet-Draft            OTN Tunnel YANG Model                June 2018

       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:p2p-reverse-primary-path
          /te:optimizations/te:algorithm/te:metric
          /te:optimization-metric/te:explicit-route-include-objects
          /te:route-object-include-object/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:p2p-reverse-primary-path/te:state
          /te:path-properties/te:path-route-objects
          /te:path-computed-route-object/te:state/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--ro tpn?       uint16
       +--ro tsg?       identityref
       +--ro ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-primary-paths
          /te:p2p-primary-path/te:p2p-reverse-primary-path/te:state
          /te:lsps/te:lsp/te:path-properties/te:path-route-objects
          /te:path-computed-route-object/te:state/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--ro tpn?       uint16
       +--ro tsg?       identityref
       +--ro ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-secondary-paths
          /te:p2p-secondary-path/te:explicit-route-objects
          /te:route-object-exclude-always/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-secondary-paths
          /te:p2p-secondary-path/te:explicit-route-objects
          /te:route-object-include-exclude/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-secondary-paths

Zheng, et al.           Expires December 21, 2018               [Page 7]
Internet-Draft            OTN Tunnel YANG Model                June 2018

          /te:p2p-secondary-path/te:optimizations/te:algorithm
          /te:metric/te:optimization-metric
          /te:explicit-route-exclude-objects
          /te:route-object-exclude-object/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-secondary-paths
          /te:p2p-secondary-path/te:optimizations/te:algorithm
          /te:metric/te:optimization-metric
          /te:explicit-route-include-objects
          /te:route-object-include-object/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--rw tpn?       uint16
       +--rw tsg?       identityref
       +--rw ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-secondary-paths
          /te:p2p-secondary-path/te:state/te:path-properties
          /te:path-route-objects/te:path-computed-route-object/te:state
          /te:type/te:label/te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--ro tpn?       uint16
       +--ro tsg?       identityref
       +--ro ts-list?   string
  augment /te:te/te:tunnels/te:tunnel/te:p2p-secondary-paths
          /te:p2p-secondary-path/te:state/te:lsps/te:lsp
          /te:path-properties/te:path-route-objects
          /te:path-computed-route-object/te:state/te:type/te:label
          /te:label-hop/te:te-label/te:technology:
    +--:(otn)
       +--ro tpn?       uint16
       +--ro tsg?       identityref
       +--ro ts-list?   string

  rpcs:
    +---x otn-te-tunnel-path-compute
       +---w input
       |  +---w request* [id]
       |     +---w id                          uint8
       |     +---w type?                       identityref
       |     +---w source?                     inet:ip-address
       |     +---w destination?                inet:ip-address
       |     +---w src-tp-id?                  binary
       |     +---w dst-tp-id?                  binary
       |     +---w switching-layer?            identityref

Zheng, et al.           Expires December 21, 2018               [Page 8]
Internet-Draft            OTN Tunnel YANG Model                June 2018

       |     +---w encoding?                   identityref
       |     +---w protection-type?            identityref
       |     +---w restoration-type?           identityref
       |     +---w provider-id?                te-types:te-global-id
       |     +---w client-id?                  te-types:te-global-id
       |     +---w te-topology-id?             te-types:te-topology-id
       |     +---w setup-priority?             uint8
       |     +---w hold-priority?              uint8
       |     +---w te-path-metric-type?        identityref
       |     +---w odu-type?                   identityref
       |     +---w p2p-primary-paths
       |     |  +---w p2p-primary-path* [name]
       |     |     +---w name                      string
       |     |     +---w te-default-metric?        uint32
       |     |     +---w te-delay-metric?          uint32
       |     |     +---w te-hop-metric?            uint32
       |     |     +---w explicit-route-objects
       |     |        +---w explicit-route-object* [index]
       |     |           +---w explicit-route-usage?   identityref
       |     |           +---w index                   uint32
       |     |           +---w (type)?
       |     |              +--:(numbered)
       |     |              |  +---w numbered-hop
       |     |              |     +---w address?     te-types:te-tp-id
       |     |              |     +---w hop-type?    te-hop-type
       |     |              |     +---w direction?   te-link-direction
       |     |              +--:(as-number)
       |     |              |  +---w as-number-hop
       |     |              |     +---w as-number?   binary
       |     |              |     +---w hop-type?    te-hop-type
       |     |              +--:(unnumbered)
       |     |              |  +---w unnumbered-hop
       |     |              |     +---w node-id?      te-types:te-node-id
       |     |              |     +---w link-tp-id?   te-types:te-tp-id
       |     |              |     +---w hop-type?     te-hop-type
       |     |              |     +---w direction?    te-link-direction
       |     |              +--:(label)
       |     |                 +---w label-hop
       |     |                    +---w te-label
       |     |                       +---w (technology)?
       |     |                       |  +--:(generic)
       |     |                       |  |  +---w generic?
       rt-types:generalized-label
       |     |                       |  +--:(otn)
       |     |                       |     +---w tpn?         uint16
       |     |                       |     +---w tsg?         identityref
       |     |                       |     +---w ts-list?     string
       |     |                       +---w direction?   te-label-direction

Zheng, et al.           Expires December 21, 2018               [Page 9]
Internet-Draft            OTN Tunnel YANG Model                June 2018

       |     +---w p2p-secondary-paths
       |     |  +---w p2p-secondary-path* [name]
       |     |     +---w name                      string
       |     |     +---w te-default-metric?        uint32
       |     |     +---w te-delay-metric?          uint32
       |     |     +---w te-hop-metric?            uint32
       |     |     +---w explicit-route-objects
       |     |        +---w explicit-route-object* [index]
       |     |           +---w explicit-route-usage?   identityref
       |     |           +---w index                   uint32
       |     |           +---w (type)?
       |     |              +--:(numbered)
       |     |              |  +---w numbered-hop
       |     |              |     +---w address?     te-types:te-tp-id
       |     |              |     +---w hop-type?    te-hop-type
       |     |              |     +---w direction?   te-link-direction
       |     |              +--:(as-number)
       |     |              |  +---w as-number-hop
       |     |              |     +---w as-number?   binary
       |     |              |     +---w hop-type?    te-hop-type
       |     |              +--:(unnumbered)
       |     |              |  +---w unnumbered-hop
       |     |              |     +---w node-id?      te-types:te-node-id
       |     |              |     +---w link-tp-id?   te-types:te-tp-id
       |     |              |     +---w hop-type?     te-hop-type
       |     |              |     +---w direction?    te-link-direction
       |     |              +--:(label)
       |     |                 +---w label-hop
       |     |                    +---w te-label
       |     |                       +---w (technology)?
       |     |                       |  +--:(generic)
       |     |                       |  |  +---w generic?
       rt-types:generalized-label
       |     |                       |  +--:(otn)
       |     |                       |     +---w tpn?         uint16
       |     |                       |     +---w tsg?         identityref
       |     |                       |     +---w ts-list?     string
       |     |                       +---w direction?
       te-label-direction
       |     +---w payload-treatment?          enumeration
       |     +---w src-client-signal?          identityref
       |     +---w src-tpn?                    uint16
       |     +---w src-tsg?                    identityref
       |     +---w src-tributary-slot-count?   uint16
       |     +---w src-tributary-slots
       |     |  +---w values*   uint8
       |     +---w dst-client-signal?          identityref
       |     +---w dst-tpn?                    uint16

Zheng, et al.           Expires December 21, 2018              [Page 10]
Internet-Draft            OTN Tunnel YANG Model                June 2018

       |     +---w dst-tsg?                    identityref
       |     +---w dst-tributary-slot-count?   uint16
       |     +---w dst-tributary-slots
       |        +---w values*   uint8
       +--ro output
          +--ro return-code?   enumeration
          +--ro result* [id]
             +--ro id                     uint8
             +--ro p2p-primary-paths
             |  +--ro p2p-primary-path* [name]
             |     +--ro name                      string
             |     +--ro te-default-metric?        uint32
             |     +--ro te-delay-metric?          uint32
             |     +--ro te-hop-metric?            uint32
             |     +--ro explicit-route-objects
             |        +--ro explicit-route-object* [index]
             |           +--ro explicit-route-usage?   identityref
             |           +--ro index                   uint32
             |           +--ro (type)?
             |              +--:(numbered)
             |              |  +--ro numbered-hop
             |              |     +--ro address?     te-types:te-tp-id
             |              |     +--ro hop-type?    te-hop-type
             |              |     +--ro direction?   te-link-direction
             |              +--:(as-number)
             |              |  +--ro as-number-hop
             |              |     +--ro as-number?   binary
             |              |     +--ro hop-type?    te-hop-type
             |              +--:(unnumbered)
             |              |  +--ro unnumbered-hop
             |              |     +--ro node-id?      te-types:te-node-id
             |              |     +--ro link-tp-id?   te-types:te-tp-id
             |              |     +--ro hop-type?     te-hop-type
             |              |     +--ro direction?    te-link-direction
             |              +--:(label)
             |                 +--ro label-hop
             |                    +--ro te-label
             |                       +--ro (technology)?
             |                       |  +--:(generic)
             |                       |  |  +--ro generic?
             rt-types:generalized-label
             |                       |  +--:(otn)
             |                       |     +--ro tpn?         uint16
             |                       |     +--ro tsg?         identityref
             |                       |     +--ro ts-list?     string
             |                       +--ro direction?   te-label-direction
             +--ro p2p-secondary-paths
                +--ro p2p-secondary-path* [name]

Zheng, et al.           Expires December 21, 2018              [Page 11]
Internet-Draft            OTN Tunnel YANG Model                June 2018

                   +--ro name                      string
                   +--ro te-default-metric?        uint32
                   +--ro te-delay-metric?          uint32
                   +--ro te-hop-metric?            uint32
                   +--ro explicit-route-objects
                      +--ro explicit-route-object* [index]
                         +--ro explicit-route-usage?   identityref
                         +--ro index                   uint32
                         +--ro (type)?
                            +--:(numbered)
                            |  +--ro numbered-hop
                            |     +--ro address?     te-types:te-tp-id
                            |     +--ro hop-type?    te-hop-type
                            |     +--ro direction?   te-link-direction
                            +--:(as-number)
                            |  +--ro as-number-hop
                            |     +--ro as-number?   binary
                            |     +--ro hop-type?    te-hop-type
                            +--:(unnumbered)
                            |  +--ro unnumbered-hop
                            |     +--ro node-id?      te-types:te-node-id
                            |     +--ro link-tp-id?   te-types:te-tp-id
                            |     +--ro hop-type?     te-hop-type
                            |     +--ro direction?    te-link-direction
                            +--:(label)
                               +--ro label-hop
                                  +--ro te-label
                                     +--ro (technology)?
                                     |  +--:(generic)
                                     |  |  +--ro generic?
                                     rt-types:generalized-label
                                     |  +--:(otn)
                                     |     +--ro tpn?         uint16
                                     |     +--ro tsg?         identityref
                                     |     +--ro ts-list?     string
                                     +--ro direction?   te-label-direction

5.  OTN Tunnel YANG Code

<CODE BEGINS>file "ietf-otn-tunnel@2018-06-07.yang"

module ietf-otn-tunnel {
  yang-version 1.1;

Zheng, et al.           Expires December 21, 2018              [Page 12]
Internet-Draft            OTN Tunnel YANG Model                June 2018

  namespace "urn:ietf:params:xml:ns:yang:ietf-otn-tunnel";
  prefix "otn-tunnel";

  import ietf-te {
    prefix "te";
  }

  import ietf-otn-types {
    prefix "otn-types";
  }

  import ietf-te-types {
    prefix "te-types";
  }

  import ietf-inet-types {
    prefix "inet";
  }

  organization
    "IETF CCAMP Working Group";
  contact
    "WG Web: <http://tools.ietf.org/wg/ccamp/>
     WG List: <mailto:ccamp@ietf.org>

     Editor: Haomian Zheng
             <mailto:zhenghaomian@huawei.com>

     Editor: Aihua Guo
             <mailto:aihuaguo@huawei.com>

     Editor: Italo Busi
             <mailto:italo.busi@huawei.com>

     Editor: Anurag Sharma
             <mailto:ansha@google.com>

     Editor: Rajan Rao
             <mailto:rrao@infinera.com>

     Editor: Sergio Belotti
             <mailto:sergio.belotti@nokia.com>

     Editor: Victor Lopez
             <mailto:victor.lopezalvarez@telefonica.com>

     Editor: Yunbo Li
             <mailto:liyunbo@chinamobile.com>

Zheng, et al.           Expires December 21, 2018              [Page 13]
Internet-Draft            OTN Tunnel YANG Model                June 2018

     Editor: Yunbin Xu
             <mailto:xuyunbin@ritt.cn>";

  description
    "This module defines a model for OTN Tunnel Services.";

  revision "2018-06-07" {
    description
      "Revision 0.5";
    reference
      "draft-ietf-ccamp-otn-tunnel-model-02";
  }

 /*
  * Groupings
  */

  grouping otn-tunnel-endpoint {
    description "Parameters for OTN tunnel";

    leaf payload-treatment {
      type enumeration {
        enum switching {
          description "Client signal is switched to another tunnel
                       in this domain";
        }
        enum transport {
          description "Client signal is transparently transmitted
                       in this domain";
        }
      }
      default switching;
      description
        "Treatment of the incoming payload. Payload can be switched
         or transported.";
    }

    leaf src-client-signal {
      type identityref {
        base otn-types:client-signal;
      }
      description
        "Client signal at the source endpoint of the tunnel";
    }

    leaf src-tpn {
      type uint16 {
        range "0..4095";

Zheng, et al.           Expires December 21, 2018              [Page 14]
Internet-Draft            OTN Tunnel YANG Model                June 2018

      }
      description
        "Tributary Port Number. Applicable in case of mux services";
      reference
        "RFC7139: GMPLS Signaling Extensions for Control of Evolving
         G.709 Optical Transport Networks";
    }

    leaf src-tsg {
      type identityref {
        base otn-types:tributary-slot-granularity;
      }
      description
        "Tributary slot granularity.
         Applicable in case of mux services";
      reference
        "G.709/Y.1331, February 2016: Interfaces for the
         Optical Transport Network (OTN)";
    }

    leaf src-tributary-slot-count {
      type uint16;
      description
        "Number of tributary slots used at the source.";
    }

    container src-tributary-slots {
      description
        "A list of tributary slots used by the client service.
         Applicable in case of mux services";
      leaf-list values {
        type uint8;
          description
            "Tributary tributary slot value";
          reference
            "G.709/Y.1331, February 2016: Interfaces for the
             Optical Transport Network (OTN)";
      }
    }

    leaf dst-client-signal {
      type identityref {
        base otn-types:client-signal;
      }
      description
        "Client signal at the destination endpoint of the tunnel";
    }

Zheng, et al.           Expires December 21, 2018              [Page 15]
Internet-Draft            OTN Tunnel YANG Model                June 2018

    leaf dst-tpn {
      type uint16 {
        range "0..4095";
      }
      description
        "Tributary Port Number. Applicable in case of mux services";
      reference
        "RFC7139: GMPLS Signaling Extensions for Control of Evolving
         G.709 Optical Transport Networks.";
    }

    leaf dst-tsg {
      type identityref {
        base otn-types:tributary-slot-granularity;
      }
      description
        "Tributary slot granularity.
         Applicable in case of mux services";
      reference
        "G.709/Y.1331, February 2016: Interfaces for the
         Optical Transport Network (OTN)";
    }

    leaf dst-tributary-slot-count {
      type uint16;
      description
        "Number of tributary slots used at the destination.";
    }

    container dst-tributary-slots {
      description
        "A list of tributary slots used by the client service.
         Applicable in case of mux services";
      leaf-list values {
        type uint8;
        description
          "Tributary slot value";
        reference
          "G.709/Y.1331, February 2016: Interfaces for the
           Optical Transport Network (OTN)";
      }
    }
  }

  /*
  Note: Comment has been given to authors of TE Tunnel model to add
  list of endpoints under config to support P2MP tunnel.
  */

Zheng, et al.           Expires December 21, 2018              [Page 16]
Internet-Draft            OTN Tunnel YANG Model                June 2018

 /*
  * Data nodes
  */

  augment "/te:te/te:tunnels/te:tunnel" {
    description
      "Augment with additional parameters required for OTN service";
    uses otn-tunnel-endpoint;
  }

  /*
   * Augment TE bandwidth
   */

         /* Augment bandwidth of named-path-constraints */
  augment "/te:te/te:globals/te:named-path-constraints/"
        + "te:named-path-constraint/"
        + "te:te-bandwidth/te:technology" {
    description "OTN bandwidth.";
    case otn {
      uses otn-types:otn-path-bandwidth;
    }
  }

  /* Augment bandwdith of tunnel */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:te-bandwidth/te:technology" {
    description "OTN bandwidth.";
    case otn {
      uses otn-types:otn-path-bandwidth;
    }
  }

  /* Augment bandwidth of primary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
        + "te:te-bandwidth/te:technology" {
    description "OTN bandwidth.";
    case otn {
      uses otn-types:otn-path-bandwidth;
    }
  }

  /* Augment bandwidth of reverse primary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
        + "te:p2p-reverse-primary-path/"
        + "te:te-bandwidth/te:technology" {

Zheng, et al.           Expires December 21, 2018              [Page 17]
Internet-Draft            OTN Tunnel YANG Model                June 2018

    description "OTN bandwidth.";
    case otn {
      uses otn-types:otn-path-bandwidth;
    }
  }

  /* Augment bandwidht of secondary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-secondary-paths/te:p2p-secondary-path/"
        + "te:te-bandwidth/te:technology" {
    description "OTN bandwidth.";
    case otn {
      uses otn-types:otn-path-bandwidth;
    }
  }

  /*
   * Augment TE label.
   */

  /* Augment label hop of route-object-exclude-always of named-path-constraints */
  augment "/te:te/te:globals/te:named-path-constraints/"
        + "te:named-path-constraint/te:explicit-route-objects/"
        + "te:route-object-exclude-always/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of route-object-include-exclude of named-path-constraints */
  augment "/te:te/te:globals/te:named-path-constraints/"
        + "te:named-path-constraint/te:explicit-route-objects/"
        + "te:route-object-include-exclude/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of route-object-exclude-always of primary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
        + "te:explicit-route-objects/"
        + "te:route-object-exclude-always/te:type/te:label/"

Zheng, et al.           Expires December 21, 2018              [Page 18]
Internet-Draft            OTN Tunnel YANG Model                June 2018

        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of route-object-include-exclude of primary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
        + "te:explicit-route-objects/"
        + "te:route-object-include-exclude/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of route-exclude of primary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
        + "te:optimizations/te:algorithm/te:metric/"
        + "te:optimization-metric/te:explicit-route-exclude-objects/"
        + "te:route-object-exclude-object/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of route-include of primary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
        + "te:optimizations/te:algorithm/te:metric/"
        + "te:optimization-metric/te:explicit-route-include-objects/"
        + "te:route-object-include-object/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of path-route of primary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"

Zheng, et al.           Expires December 21, 2018              [Page 19]
Internet-Draft            OTN Tunnel YANG Model                June 2018

        + "te:state/te:path-properties/"
        + "te:path-route-objects/te:path-computed-route-object/"
        + "te:state/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /*
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
        + "te:state/te:lsps/te:lsp/te:record-route-subobjects/"
                + "te:record-route-subobject/"
                + "te:state/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
          uses otn-types:otn-path-label;
        }
  }
  */

  /* Augment label hop of path-route of primary LSP */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
        + "te:state/te:lsps/te:lsp/te:path-properties/"
        + "te:path-route-objects/te:path-computed-route-object/"
        + "te:state/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of route-object-exclude-always of reverse primary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
        + "te:p2p-reverse-primary-path/"
        + "te:explicit-route-objects/"
        + "te:route-object-exclude-always/"
        + "te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;

Zheng, et al.           Expires December 21, 2018              [Page 20]
Internet-Draft            OTN Tunnel YANG Model                June 2018

    }
  }

  /* Augment label hop of route-object-include-exclude of reverse primary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
        + "te:p2p-reverse-primary-path/"
        + "te:explicit-route-objects/"
        + "te:route-object-include-exclude/"
        + "te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of route-exclude of reverse primary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
        + "te:p2p-reverse-primary-path/"
        + "te:optimizations/te:algorithm/te:metric/"
        + "te:optimization-metric/te:explicit-route-exclude-objects/"
        + "te:route-object-exclude-object/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of route-include of reverse primary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
        + "te:p2p-reverse-primary-path/"
        + "te:optimizations/te:algorithm/te:metric/"
        + "te:optimization-metric/te:explicit-route-include-objects/"
        + "te:route-object-include-object/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of label hop of path-route of reverse primary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"

Zheng, et al.           Expires December 21, 2018              [Page 21]
Internet-Draft            OTN Tunnel YANG Model                June 2018

        + "te:p2p-reverse-primary-path/"
        + "te:state/te:path-properties/"
        + "te:path-route-objects/te:path-computed-route-object/"
        + "te:state/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /*
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
                + "te:p2p-reverse-primary-path/"
        + "te:state/te:lsps/te:lsp/te:lsp-record-route-subobjects/"
                + "te:record-route-subobject/"
                + "te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
          uses otn-types:otn-path-label;
        }
  }
  */

  /* Augment label hop of path-route of reverse primary LSP */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-primary-paths/te:p2p-primary-path/"
        + "te:p2p-reverse-primary-path/"
        + "te:state/te:lsps/te:lsp/te:path-properties/"
        + "te:path-route-objects/te:path-computed-route-object/"
        + "te:state/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of route-object-exclude-always of secondary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-secondary-paths/te:p2p-secondary-path/"
        + "te:explicit-route-objects/"
        + "te:route-object-exclude-always/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {

Zheng, et al.           Expires December 21, 2018              [Page 22]
Internet-Draft            OTN Tunnel YANG Model                June 2018

      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of route-object-include-exclude of secondary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-secondary-paths/te:p2p-secondary-path/"
        + "te:explicit-route-objects/"
        + "te:route-object-include-exclude/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of route-exclude of secondary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-secondary-paths/te:p2p-secondary-path/"
        + "te:optimizations/te:algorithm/te:metric/"
        + "te:optimization-metric/te:explicit-route-exclude-objects/"
        + "te:route-object-exclude-object/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of route-include of secondary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-secondary-paths/te:p2p-secondary-path/"
        + "te:optimizations/te:algorithm/te:metric/"
        + "te:optimization-metric/te:explicit-route-include-objects/"
        + "te:route-object-include-object/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /* Augment label hop of label hop of path-route of secondary path */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-secondary-paths/te:p2p-secondary-path/"
        + "te:state/te:path-properties/te:path-route-objects/"
        + "te:path-computed-route-object/te:state/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {

Zheng, et al.           Expires December 21, 2018              [Page 23]
Internet-Draft            OTN Tunnel YANG Model                June 2018

    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /*
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-secondary-paths/te:p2p-secondary-path/"
        + "te:state/te:lsps/te:lsp/te:lsp-record-route-subobjects/"
                + "te:record-route-subobject/"
                + "te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
          uses otn-types:otn-path-label;
        }
  }
  */

  /* Augment label hop of path-route of secondary LSP */
  augment "/te:te/te:tunnels/te:tunnel/"
        + "te:p2p-secondary-paths/te:p2p-secondary-path/"
        + "te:state/te:lsps/te:lsp/te:path-properties/"
        + "te:path-route-objects/"
        + "te:path-computed-route-object/te:state/te:type/te:label/"
        + "te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
      uses otn-types:otn-path-label;
    }
  }

  /*
  augment "/te:te/te:lsp-state/"
        + "te:lsp-record-route-subobjects/te:lsp-record-route-subobject/"
                + "te:record-route-subobject/"
                + "te:type/te:label/te:label-hop/te:te-label/te:technology" {
    description "OTN label.";
    case otn {
          uses otn-types:otn-path-label;
        }
  }
  */

  grouping p2p-path-ero {
    description

Zheng, et al.           Expires December 21, 2018              [Page 24]
Internet-Draft            OTN Tunnel YANG Model                June 2018

      "TE tunnel ERO configuration grouping";

    leaf te-default-metric {
      type uint32;
      description
        "Traffic engineering metric.";
    }
    leaf te-delay-metric {
      type uint32;
      description
        "Traffic engineering delay metric.";
    }
    leaf te-hop-metric {
      type uint32;
      description
        "Traffic engineering hop metric.";
    }
    container explicit-route-objects {
      description "Explicit route objects container";
      list explicit-route-object {
        key "index";
        description
          "List of explicit route objects";
        leaf explicit-route-usage {
          type identityref {
            base te-types:route-usage-type;
          }
          description "An explicit-route hop action.";
        }
        uses te-types:explicit-route-hop {
                  augment "type/label/label-hop/te-label/technology" {
                    description "OTN label.";
            case otn {
                  uses otn-types:otn-path-label;
                }
                  }
                }
      }
    }
  }

  rpc otn-te-tunnel-path-compute {
    description "OTN TE tunnel path computation";
    input {
      list request {
        key "id";
        description "A list of path computation requests.";

Zheng, et al.           Expires December 21, 2018              [Page 25]
Internet-Draft            OTN Tunnel YANG Model                June 2018

        leaf id {
          type uint8;
          description
            "Request ID.";
        }
        leaf type {
          type identityref {
            base te-types:tunnel-type;
          }
          description "TE tunnel type.";
        }
        leaf source {
          type inet:ip-address;
          description
            "TE tunnel source address.";
        }
        leaf destination {
          type inet:ip-address;
          description
            "TE tunnel destination address";
        }
        leaf src-tp-id {
          type binary;
          description
            "TE tunnel source termination point identifier.";
        }
        leaf dst-tp-id {
          type binary;
          description
            "TE tunnel destination termination point identifier.";
        }
        leaf switching-layer {
          type identityref {
            base te-types:switching-capabilities;
          }
          description
            "Switching layer where the requests are computed.";
        }
        leaf encoding {
          type identityref {
            base te-types:lsp-encoding-types;
          }
          description "LSP encoding type";
        }
        leaf protection-type {
          type identityref {
            base te-types:lsp-protection-type;
          }

Zheng, et al.           Expires December 21, 2018              [Page 26]
Internet-Draft            OTN Tunnel YANG Model                June 2018

          description "LSP protection type";
        }
        leaf restoration-type {
          type identityref {
            base te-types:lsp-restoration-type;
          }
          description "LSP restoration type";
        }
        leaf provider-id {
          type te-types:te-global-id;
          description
            "An identifier to uniquely identify a provider.";
        }
        leaf client-id {
          type te-types:te-global-id;
          description
            "An identifier to uniquely identify a client.";
        }
        leaf te-topology-id {
          type te-types:te-topology-id;
          description
            "It is presumed that a datastore will contain many
             topologies. To distinguish between topologies it is
             vital to have UNIQUE topology identifiers.";
        }
        leaf setup-priority {
          type uint8 {
            range "0..7";
          }
          description
            "TE LSP setup priority";
        }
        leaf hold-priority {
          type uint8 {
            range "0..7";
          }
          description
            "TE LSP hold priority";
        }
        leaf te-path-metric-type {
          type identityref {
            base te-types:path-metric-type;
          }
          default te-types:path-metric-te;
          description
            "The tunnel path metric type.";
        }

Zheng, et al.           Expires December 21, 2018              [Page 27]
Internet-Draft            OTN Tunnel YANG Model                June 2018

        leaf odu-type {
          type identityref{
            base otn-types:tributary-protocol-type;
          }
          description "Type of ODU";
        }
        container p2p-primary-paths {
          description "Set of P2P primary paths container";
          list p2p-primary-path {
            key "name";
            description
              "List of primary paths for this tunnel.";
            leaf name {
              type string;
              description "TE path name";
            }
            uses p2p-path-ero;
          }
        }
        container p2p-secondary-paths {
          description "Set of P2P secondary paths container";
          list p2p-secondary-path {
            key "name";
            description
              "List of secondary paths for this tunnel.";
            leaf name {
              type string;
              description "TE path name";
            }
            uses p2p-path-ero;
          }
        }
        uses otn-tunnel-endpoint;
      }
    }
    output {
      leaf return-code {
        type enumeration {
          enum success {
            description "success";
          }
          enum aborted {
            description "aborted";
          }
          enum destination-not-found {
            description "destination-not-found";
          }
          enum invalid-argument {

Zheng, et al.           Expires December 21, 2018              [Page 28]
Internet-Draft            OTN Tunnel YANG Model                June 2018

            description "invalid-argument";
          }
          enum no-memory {
            description "no-memory";
          }
          enum no-path-found {
            description "no-path-found";
          }
          enum other-error {
            description "other-error";
          }
          enum some-path-not-found {
            description "some-path-not-found";
          }
          enum source-not-found {
            description "source-not-found";
          }
          enum topology-error {
            description "topology-error";
          }
        }
        description
          "Return code";
      }
      list result {
        key "id";
        description
          "A list of results for all requests.";

        leaf id {
          type uint8;
          description
            "Request ID";
        }
        container p2p-primary-paths {
          description "Set of P2P primary paths container";
          list p2p-primary-path {
            key "name";
            description
              "List of resultant primary paths for this tunnel.";
            leaf name {
              type string;
              description "TE path name";
            }
            uses p2p-path-ero;
          }
        }
        container p2p-secondary-paths {

Zheng, et al.           Expires December 21, 2018              [Page 29]
Internet-Draft            OTN Tunnel YANG Model                June 2018

          description "Set of P2P secondary paths container";
          list p2p-secondary-path {
            key "name";
            description
              "List of resultant secondary paths for this tunnel.";
            leaf name {
              type string;
              description "TE path name";
            }
            uses p2p-path-ero;
          }
        }
      }
    }
  }
}

<CODE ENDS>

6.  OTN Types YANG Code

<CODE BEGINS> file "ietf-otn-types@2018-06-07.yang"

module ietf-otn-types {
  namespace "urn:ietf:params:xml:ns:yang:ietf-otn-types";
  prefix "otn-types";

  organization
    "IETF CCAMP Working Group";
  contact
    "WG Web: <http://tools.ietf.org/wg/ccamp/>
     WG List: <mailto:ccamp@ietf.org>

     Editor: Haomian Zheng
             <mailto:zhenghaomian@huawei.com>

     Editor: Aihua Guo
             <mailto:aihuaguo@huawei.com>

     Editor: Italo Busi
             <mailto:italo.busi@huawei.com>

     Editor: Anurag Sharma
             <mailto:ansha@google.com>

Zheng, et al.           Expires December 21, 2018              [Page 30]
Internet-Draft            OTN Tunnel YANG Model                June 2018

     Editor: Rajan Rao
             <mailto:rrao@infinera.com>

     Editor: Sergio Belotti
             <mailto:sergio.belotti@nokia.com>

     Editor: Victor Lopez
             <mailto:victor.lopezalvarez@telefonica.com>

     Editor: Yunbo Li
             <mailto:liyunbo@chinamobile.com>

     Editor: Yunbin Xu
             <mailto:xuyunbin@ritt.cn>";

  description
    "This module defines OTN types.";

  revision "2018-06-07" {
    description
      "Revision 0.5";
    reference
      "draft-ietf-ccamp-otn-tunnel-model-02";
  }

  identity tributary-slot-granularity {
    description
      "Tributary slot granularity";
    reference
      "G.709/Y.1331, February 2016: Interfaces for the Optical
       Transport Network (OTN)";
  }

  identity tsg-1.25G {
    base tributary-slot-granularity;
    description
      "1.25G tributary slot granularity";
  }

  identity tsg-2.5G {
    base tributary-slot-granularity;
    description
      "2.5G tributary slot granularity";
  }
/*
  identity tsg-1.25Gand2.5G {
    base tributary-slot-granularity;
    description

Zheng, et al.           Expires December 21, 2018              [Page 31]
Internet-Draft            OTN Tunnel YANG Model                June 2018

      "Both 1.25G and 2.5G tributary slot granularity";
  }
*/
  identity tributary-protocol-type {
    description
      "Base identity for protocol framing used by tributary signals";
  }

  identity prot-OTU1 {
    base tributary-protocol-type;
    description
      "OTU1 protocol (2.66G)";
  }
/*
  identity prot-OTU1e {
    base tributary-protocol-type;
    description
      "OTU1e type (11.04G)";
  }

  identity prot-OTU1f {
    base tributary-protocol-type;
    description
      "OTU1f type (11.27G)";
  }
*/
  identity prot-OTU2 {
    base tributary-protocol-type;
    description
      "OTU2 type (10.70G)";
  }

  identity prot-OTU2e {
    base tributary-protocol-type;
    description
      "OTU2e type (11.09G)";
  }
/*
  identity prot-OTU2f {
    base tributary-protocol-type;
    description
      "OTU2f type (11.31G)";
  }
*/
  identity prot-OTU3 {
    base tributary-protocol-type;
    description
      "OTU3 type (43.01G)";

Zheng, et al.           Expires December 21, 2018              [Page 32]
Internet-Draft            OTN Tunnel YANG Model                June 2018

  }
/*
  identity prot-OTU3e1 {
    base tributary-protocol-type;
    description
      "OTU3e1 type (44.57G)";
  }

  identity prot-OTU3e2 {
    base tributary-protocol-type;
    description
      "OTU3e2 type (44.58G)";
  }
*/
  identity prot-OTU4 {
    base tributary-protocol-type;
    description
      "OTU4 type (111.80G)";
  }

  identity prot-OTUCn {
    base tributary-protocol-type;
    description
      "OTUCn type (beyond 100G)";
  }

  identity prot-ODU0 {
    base tributary-protocol-type;
    description
      "ODU0 protocol (1.24G)";
  }

  identity prot-ODU1 {
    base tributary-protocol-type;
    description
      "ODU1 protocol (2.49G)";
  }
/*
  identity prot-ODU1e {
    base tributary-protocol-type;
    description
      "ODU1e protocol (10.35G).";
  }

  identity prot-ODU1f {
    base tributary-protocol-type;
    description
      "ODU1f protocol (10.56G).";

Zheng, et al.           Expires December 21, 2018              [Page 33]
Internet-Draft            OTN Tunnel YANG Model                June 2018

  }
*/
  identity prot-ODU2 {
    base tributary-protocol-type;
    description
      "ODU2 protocol (10.03G)";
  }

  identity prot-ODU2e {
    base tributary-protocol-type;
    description
      "ODU2e protocol (10.39G)";
  }
/*
  identity prot-ODU2f {
    base tributary-protocol-type;
    description
      "ODU2f protocol (10.60G).";
  }
*/
  identity prot-ODU3 {
    base tributary-protocol-type;
    description
      "ODU3 protocol (40.31G)";
  }
/*
  identity prot-ODU3e1 {
    base tributary-protocol-type;
    description
      "ODU3e1 protocol (41.77G).";
  }

  identity prot-ODU3e2 {
    base tributary-protocol-type;
    description
      "ODU3e2 protocol (41.78G).";
  }
*/
  identity prot-ODU4 {
    base tributary-protocol-type;
    description
      "ODU4 protocol (104.79G)";
  }

  identity prot-ODUFlex-cbr {
    base tributary-protocol-type;
    description
      "ODU Flex CBR protocol for transporting constant bit rate

Zheng, et al.           Expires December 21, 2018              [Page 34]
Internet-Draft            OTN Tunnel YANG Model                June 2018

       signal";
  }

  identity prot-ODUFlex-gfp {
    base tributary-protocol-type;
    description
      "ODU Flex GFP protocol for transporting stream of packets
       using Generic Framing Procedure";
  }

  identity prot-ODUCn {
    base tributary-protocol-type;
    description
      "ODUCn protocol (beyond 100G)";
  }

  identity prot-1GbE {
    base tributary-protocol-type;
    description
      "1G Ethernet protocol";
  }
  identity prot-10GbE-LAN {
    base tributary-protocol-type;
    description
      "10G Ethernet LAN protocol";
  }

  identity prot-40GbE {
    base tributary-protocol-type;
    description
      "40G Ethernet protocol";
  }

  identity prot-100GbE {
    base tributary-protocol-type;
    description
      "100G Ethernet protocol";
  }

  identity client-signal {
    description
      "Base identity from which specific client signals for the
       tunnel are derived";
  }

  identity client-signal-1GbE {
    base client-signal;
    description

Zheng, et al.           Expires December 21, 2018              [Page 35]
Internet-Draft            OTN Tunnel YANG Model                June 2018

      "Client signal type of 1GbE";
  }

  identity client-signal-10GbE-LAN {
    base client-signal;
    description
      "Client signal type of 10GbE LAN";
  }

  identity client-signal-10GbE-WAN {
    base client-signal;
    description
      "Client signal type of 10GbE WAN";
  }

  identity client-signal-40GbE {
    base client-signal;
    description
      "Client signal type of 40GbE";
  }

  identity client-signal-100GbE {
    base client-signal;
    description
      "Client signal type of 100GbE";
  }

  identity client-signal-OC3_STM1 {
    base client-signal;
    description
      "Client signal type of OC3 & STM1";
  }

  identity client-signal-OC12_STM4 {
    base client-signal;
    description
      "Client signal type of OC12 & STM4";
  }

  identity client-signal-OC48_STM16 {
    base client-signal;
    description
      "Client signal type of OC48 & STM16";
  }

  identity client-signal-OC192_STM64 {
    base client-signal;
    description

Zheng, et al.           Expires December 21, 2018              [Page 36]
Internet-Draft            OTN Tunnel YANG Model                June 2018

      "Client signal type of OC192 & STM64";
  }

  identity client-signal-OC768_STM256 {
    base client-signal;
    description
      "Client signal type of OC768 & STM256";
  }

  identity client-signal-ODU0 {
    base client-signal;
    description
      "Client signal type of ODU0 (1.24G)";
  }

  identity client-signal-ODU1 {
    base client-signal;
    description
      "ODU1 protocol (2.49G)";
  }

  identity client-signal-ODU2 {
    base client-signal;
    description
      "Client signal type of ODU2 (10.03G)";
  }

  identity client-signal-ODU2e {
    base client-signal;
    description
      "Client signal type of ODU2e (10.39G)";
  }

  identity client-signal-ODU3 {
    base client-signal;
    description
      "Client signal type of ODU3 (40.31G)";
  }
/*
  identity client-signal-ODU3e2 {
    base client-signal;
    description
      "Client signal type of ODU3e2 (41.78G)";
  }
*/
  identity client-signal-ODU4 {
    base client-signal;
    description

Zheng, et al.           Expires December 21, 2018              [Page 37]
Internet-Draft            OTN Tunnel YANG Model                June 2018

      "Client signal type of ODU4 (104.79G)";
  }

  identity client-signal-ODUflex-cbr {
    base client-signal;
    description
      "Client signal type of ODU Flex CBR";
  }

  identity client-signal-ODUflex-gfp {
    base client-signal;
    description
      "Client signal type of ODU Flex GFP";
  }

  identity client-signal-ODUCn {
    base client-signal;
    description
      "Client signal type of ODUCn (beyond 100G)";
  }

  identity client-signal-FC400 {
    base client-signal;
    description
      "Client signal type of Fibre Channel FC400";
  }

  identity client-signal-FC800 {
    base client-signal;
    description
      "Client signal type of Fibre Channel FC800";
  }

  identity client-signal-FICON-4G {
    base client-signal;
    description
      "Client signal type of Fibre Connection 4G";
  }

  identity client-signal-FICON-8G {
    base client-signal;
    description
      "Client signal type of Fibre Connection 8G";
  }

  identity client-signal-OTU1 {
    base client-signal;
    description

Zheng, et al.           Expires December 21, 2018              [Page 38]
Internet-Draft            OTN Tunnel YANG Model                June 2018

      "Client signal type of OTU1";
  }

  identity client-signal-OTU2 {
    base client-signal;
    description
      "Client signal type of OTU2";
  }

  identity client-signal-OTU2e {
    base client-signal;
    description
      "Client signal type of OTU2e";
  }

  identity client-signal-OTU3 {
    base client-signal;
    description
      "Client signal type of OTU3";
  }

  identity client-signal-OTU4 {
    base client-signal;
    description
      "Client signal type of OTU4";
  }

  identity otn-label-range-type {
    description
      "Base identity from which specific OTN label
           range types derived";
  }

  identity label-range-trib-slot {
    base otn-label-range-type;
    description
      "Defines a range of OTN tributary slots";
  }

  identity label-range-trib-port {
    base otn-label-range-type;
    description
      "Defines a range of OTN tributary ports";
  }

  grouping otn-link-bandwidth {
    list odulist {
      key "odu-type";

Zheng, et al.           Expires December 21, 2018              [Page 39]
Internet-Draft            OTN Tunnel YANG Model                June 2018

      description
        "OTN bandwidth definition";
      leaf odu-type {
        type identityref {
          base otn-types:tributary-protocol-type;
        }
        description "ODU type";
      }
      leaf number {
        type uint16;
        description "Number of ODUs";
      }
    }
  }

  grouping otn-path-bandwidth {
    leaf odu-type {
      type identityref {
        base otn-types:tributary-protocol-type;
      }
      description "ODU type";
    }
  }

  grouping otn-label-restriction {
    leaf range-type {
      type identityref {
        base otn-types:otn-label-range-type;
      }
    }
    leaf tsg {
      type identityref {
        base otn-types:tributary-slot-granularity;
      }
      description "Tributary slot granularity.";
      reference
        "G.709/Y.1331, February 2016: Interfaces for the
         Optical Transport Network (OTN)";
    }
    leaf priority {
      type uint8;
      description "priority.";
    }
  }

  grouping otn-link-label {
    choice otn-label-type {

Zheng, et al.           Expires December 21, 2018              [Page 40]
Internet-Draft            OTN Tunnel YANG Model                June 2018

      description
        "OTN label type";
      case tributary-port {
        leaf tpn {
          type uint16 {
            range "1..4095";
          }
          description
            "Tributary Port Number. Applicable in case of mux services.";
          reference
            "RFC7139: GMPLS Signaling Extensions for Control of Evolving
             G.709 Optical Transport Networks.";
        }
      }
      case tributary-slot {
        leaf ts {
          type uint16 {
            range "1..4095";
          }
          description
            "Tributary Slot Number. Applicable in case of mux services.";
          reference
            "RFC7139: GMPLS Signaling Extensions for Control of Evolving
             G.709 Optical Transport Networks.";
        }
      }
    }
  }

  grouping otn-path-label {
    leaf tpn {
      type uint16 {
        range "1..4095";
      }
      description
        "Tributary Port Number. Applicable in case of mux services.";
      reference
        "RFC7139: GMPLS Signaling Extensions for Control of Evolving
         G.709 Optical Transport Networks.";
    }
    leaf tsg {
      type identityref {
        base otn-types:tributary-slot-granularity;
      }
      description "Tributary slot granularity.";
      reference
        "G.709/Y.1331, February 2016: Interfaces for the
         Optical Transport Network (OTN)";

Zheng, et al.           Expires December 21, 2018              [Page 41]
Internet-Draft            OTN Tunnel YANG Model                June 2018

    }
    leaf ts-list {
      type string {
          pattern "([1-9][0-9]{0,3}(-[1-9][0-9]{0,3})?"
                + "(,[1-9][0-9]{0,3}(-[1-9][0-9]{0,3})?)*)";
        }
        description
          "A list of available tributary slots ranging
           between 1 and 9999.
           For example 1-20,25,50-1000";
        reference "RFC 7139: GMPLS Signaling Extensions for Control
                   of Evolving G.709 Optical Transport Networks";
    }
  }
}

<CODE ENDS>

7.  Security Considerations

   TBD.

8.  IANA Considerations

   TBD.

9.  Acknowledgements

   TBD.

10.  Contributors

   Dieter Beller
   Nokia
   Email: dieter.beller@nokia.com

   Yanlei Zheng
   China Unicom
   Email: zhengyl@dimpt.com

   Xian Zhang
   Huawei Technologies
   Email: zhang.xian@huawei.com

   Lei Wang
   China Mobile

Zheng, et al.           Expires December 21, 2018              [Page 42]
Internet-Draft            OTN Tunnel YANG Model                June 2018

   Email: wangleiyj@chinamobile.com

   Oscar Gonzalez de Dios
   Telefonica
   Email: oscar.gonzalezdedios@telefonica.com

11.  References

11.1.  Normative References

   [I-D.ietf-ccamp-otn-topo-yang]
              zhenghaomian@huawei.com, z., Guo, A., Busi, I., Sharma,
              A., Liu, X., Belotti, S., Xu, Y., Wang, L., and O. Dios,
              "A YANG Data Model for Optical Transport Network
              Topology", draft-ietf-ccamp-otn-topo-yang-03 (work in
              progress), June 2018.

   [I-D.ietf-ccamp-transport-nbi-app-statement]
              Busi, I., King, D., zhenghaomian@huawei.com, z., and Y.
              Xu, "Transport Northbound Interface Applicability
              Statement", draft-ietf-ccamp-transport-nbi-app-
              statement-01 (work in progress), March 2018.

   [I-D.ietf-teas-yang-te]
              Saad, T., Gandhi, R., Liu, X., Beeram, V., Shah, H., and
              I. Bryskin, "A YANG Data Model for Traffic Engineering
              Tunnels and Interfaces", draft-ietf-teas-yang-te-15 (work
              in progress), June 2018.

   [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>.

   [RFC7139]  Zhang, F., Ed., Zhang, G., Belotti, S., Ceccarelli, D.,
              and K. Pithewan, "GMPLS Signaling Extensions for Control
              of Evolving G.709 Optical Transport Networks", RFC 7139,
              DOI 10.17487/RFC7139, March 2014,
              <https://www.rfc-editor.org/info/rfc7139>.

   [RFC7950]  Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
              RFC 7950, DOI 10.17487/RFC7950, August 2016,
              <https://www.rfc-editor.org/info/rfc7950>.

   [RFC8040]  Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
              Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
              <https://www.rfc-editor.org/info/rfc8040>.

Zheng, et al.           Expires December 21, 2018              [Page 43]
Internet-Draft            OTN Tunnel YANG Model                June 2018

11.2.  Informative References

   [I-D.ietf-netmod-yang-tree-diagrams]
              Bjorklund, M. and L. Berger, "YANG Tree Diagrams", draft-
              ietf-netmod-yang-tree-diagrams-06 (work in progress),
              February 2018.

   [I-D.ietf-teas-actn-yang]
              Lee, Y., zhenghaomian@huawei.com, z., Ceccarelli, D.,
              Yoon, B., and S. Belotti, "Applicability of YANG models
              for Abstraction and Control of Traffic Engineered
              Networks", draft-ietf-teas-actn-yang-01 (work in
              progress), February 2018.

   [RFC7062]  Zhang, F., Ed., Li, D., Li, H., Belotti, S., and D.
              Ceccarelli, "Framework for GMPLS and PCE Control of G.709
              Optical Transport Networks", RFC 7062,
              DOI 10.17487/RFC7062, November 2013,
              <https://www.rfc-editor.org/info/rfc7062>.

   [RFC7138]  Ceccarelli, D., Ed., Zhang, F., Belotti, S., Rao, R., and
              J. Drake, "Traffic Engineering Extensions to OSPF for
              GMPLS Control of Evolving G.709 Optical Transport
              Networks", RFC 7138, DOI 10.17487/RFC7138, March 2014,
              <https://www.rfc-editor.org/info/rfc7138>.

Authors' Addresses

   Haomian Zheng
   Huawei Technologies
   F3 R&D Center, Huawei Industrial Base, Bantian, Longgang District
   Shenzhen, Guangdong  518129
   P.R.China

   Email: zhenghaomian@huawei.com

   Aihua Guo
   Huawei Technologies
   12007 Sunrise Valley Drive, Suite 325
   Reston, VA  20171
   U.S.A

   Email: aihuaguo@huawei.com

Zheng, et al.           Expires December 21, 2018              [Page 44]
Internet-Draft            OTN Tunnel YANG Model                June 2018

   Italo Busi
   Huawei Technologies
   HUAWEI TECHNOLOGIES ITALIA Srl Centro Direzionale Milano 2
   Milan, Milan  20090
   Italy

   Email: Italo.Busi@huawei.com

   Anurag Sharma
   Google
   1600 Amphitheatre Parkway
   Mountain View, CA  94043
   USA

   Email: ansha@google.com

   Rajan Rao
   Infinera
   169 Java Drive
   Sunnyvale, CA  94089
   USA

   Email: rrao@infinera.com

   Sergio Belotti
   Nokia

   Email: sergio.belotti@nokia.com

   Victor Lopez
   Telefonica

   Email: victor.lopezalvarez@telefonica.com

   Yunbo Li
   China Mobile

   Email: liyunbo@chinamobile.com

Zheng, et al.           Expires December 21, 2018              [Page 45]
Internet-Draft            OTN Tunnel YANG Model                June 2018

   Yunbin Xu
   CAICT

   Email: xuyunbin@ritt.cn

Zheng, et al.           Expires December 21, 2018              [Page 46]