api/src/main/yang/service_path/transportpce-pathDescription@2017-10-17.yang

   1 module transportpce-pathDescription {
   2   namespace "http://org/transportpce/B-C-interface/pathDescription";
   3   prefix transportpce-pathDescription;
   4
   5   import org-openroadm-resource {
   6     prefix org-openroadm-resource;
   7   }
   8
   9   organization
  10     "transportPCE";
  11   contact
  12     "transportPCE committers - ODL";
  13   description
  14     "YANG definitions of B interface (transportPCE). Adapted from service definition (openroadm)
  15      Copyright © 2017 Orange, Inc. and others.  All rights reserved.
  16
  17      openroadm copyright:
  18       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  19       AT&T Intellectual Property.  All other rights reserved.
  20
  21       Redistribution and use in source and binary forms, with or without modification,
  22       are permitted provided that the following conditions are met:
  23
  24       * Redistributions of source code must retain the above copyright notice, this
  25         list of conditions and the following disclaimer.
  26       * Redistributions in binary form must reproduce the above copyright notice,
  27         this list of conditions and the following disclaimer in the documentation and/or
  28         other materials provided with the distribution.
  29       * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  30         contributors may be used to endorse or promote products derived from this software
  31         without specific prior written permission.
  32
  33       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  34       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  35       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  36       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  37       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  38       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  39       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  40       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  41       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  42       POSSIBILITY OF SUCH DAMAGE";
  43
  44   revision 2017-04-26 {
  45       description
  46         "Version 1.5";
  47   }
  48
  49   revision 2017-10-17 {
  50     description
  51       "Version 1.6";
  52   }
  53  grouping PCE-resource {
  54     description
  55       "This resource identifier is intended to provide a generic identifer
  56        for any resource that can be used without specific knowledge of
  57        the resource.";
  58     container resource {
  59       choice resource {
  60         case termination-point {
  61           leaf tp-id {
  62                type string; //to be clarified with topology model
  63           }
  64           leaf tp-node-id {
  65                type string; //to be clarified with topology model
  66           }
  67         }
  68
  69         case link {
  70           leaf link-id {
  71                type string; //to be clarified with topology model
  72           }
  73         }
  74
  75         case node {
  76           leaf node-id {
  77                type string; // to be clarified with topology model
  78           }
  79         }
  80       }
  81     }
  82   }
  83
  84
  85   grouping path-description {
  86     description
  87       "Topology reports the individual hops along the service in the A to Z direction and Z to A directions.  This includes both ports internal to a device and those
  88        at its edge that are available for externally connections. It includes both physical and logical ports.
  89        Physical ports are ordered with the logical ports that run over them as follows:
  90        a.\tOn ingress to a node/card, physical then logical
  91        b.\tOn egress to a node/card, logical then physical";
  92     container aToZ-direction {
  93          leaf aToZ-wavelength-number {
  94               type uint32;
  95               mandatory true;
  96          }
  97          leaf rate {
  98               type uint32;
  99               mandatory true;
 100          }
 101          leaf modulation-format {
 102               type string; // enum ?
 103          }
 104          list aToZ {
 105            key "id";
 106            leaf id {
 107              description
 108                "Unique identifier for this topology component within this service";
 109              type string;
 110            }
 111            uses hop;
 112          }
 113     }
 114
 115     container zToA-direction {
 116          leaf zToA-wavelength-number {
 117               type uint32;
 118               mandatory true;
 119          }
 120          leaf rate {
 121               type uint32;
 122               mandatory true;
 123          }
 124          leaf modulation-format {
 125               type string; // enum ?
 126          }
 127          list zToA {
 128            key "id";
 129            leaf id {
 130              description
 131                "Unigue identifier for this topology component within this service";
 132              type string;
 133            }
 134            uses hop;
 135          }
 136        }
 137     }
 138
 139
 140   grouping hop {
 141     uses PCE-resource;
 142   }
 143 }