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           leaf tp-id {
  61               type string; //to be clarified with topology model
  62           }
  63           leaf tp-node-id {
  64               type string; //to be clarified with topology model
  65           }
  66         }
  67
  68         case link {
  69           leaf link-id {
  70               type string; //to be clarified with topology model
  71           }
  72         }
  73
  74         case node {
  75           leaf node-id {
  76               type string; // to be clarified with topology model
  77           }
  78         }
  79       }
  80     }
  81   }
  82
  83
  84   grouping path-description {
  85     description
  86       "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
  87        at its edge that are available for externally connections. It includes both physical and logical ports.
  88        Physical ports are ordered with the logical ports that run over them as follows:
  89        a.\tOn ingress to a node/card, physical then logical
  90        b.\tOn egress to a node/card, logical then physical";
  91     container aToZ-direction {
  92         leaf aToZ-wavelength-number {
  93             type uint32;
  94             mandatory true;
  95         }
  96         leaf rate {
  97             type uint32;
  98             mandatory true;
  99         }
 100         leaf modulation-format {
 101             type string; // enum ?
 102         }
 103         list aToZ {
 104           key "id";
 105           leaf id {
 106             description
 107               "Unigue identifier for this topology component within this service";
 108             type string;
 109           }
 110           uses hop;
 111         }
 112     }
 113
 114     container zToA-direction {
 115         leaf zToA-wavelength-number {
 116             type uint32;
 117             mandatory true;
 118         }
 119         leaf rate {
 120             type uint32;
 121             mandatory true;
 122         }
 123         leaf modulation-format {
 124             type string; // enum ?
 125         }
 126         list zToA {
 127           key "id";
 128           leaf id {
 129             description
 130               "Unigue identifier for this topology component within this service";
 131             type string;
 132           }
 133           uses hop;
 134         }
 135     }
 136   }
 137
 138
 139   grouping hop {
 140     uses PCE-resource;
 141   }
 142 }