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