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

   1 module transportpce-routing-constraints {
   2   namespace "http://org/transportpce/B-C-interface/routing/constraints";
   3   prefix transportpce-routing-constraints;
   4
   5   organization
   6     "transportPCE";
   7   contact
   8     "transportPCE committers - ODL";
   9   description
  10     "YANG definitions of B interface (transportPCE). Adapted from service definition (openroadm)
  11      Copyright ©  2017 Orange, Inc. and others.  All rights reserved.
  12      openroadm copyright:
  13       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
  14       AT&T Intellectual Property.  All other rights reserved.
  15
  16       Redistribution and use in source and binary forms, with or without modification,
  17       are permitted provided that the following conditions are met:
  18
  19       * Redistributions of source code must retain the above copyright notice, this
  20         list of conditions and the following disclaimer.
  21       * Redistributions in binary form must reproduce the above copyright notice,
  22         this list of conditions and the following disclaimer in the documentation and/or
  23         other materials provided with the distribution.
  24       * Neither the Members of the Open ROADM MSA Agreement nor the names of its
  25         contributors may be used to endorse or promote products derived from this software
  26         without specific prior written permission.
  27
  28       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
  29       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  30       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  31       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
  32       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  33       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
  34       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  35       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  36       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  37       POSSIBILITY OF SUCH DAMAGE";
  38
  39   revision 2017-10-17 {
  40     description
  41       "Version 1.6";
  42   }
  43   revision 2017-04-26 {
  44     description
  45       "Version 1.5";
  46   }
  47
  48   grouping common-constraints-sp {
  49     leaf-list SRLG {
  50       type string;
  51     }
  52     leaf-list clli {
  53       type string;
  54     }
  55     leaf-list node-id {
  56       type string;
  57     }
  58   }
  59
  60   grouping ordered-constraints-sp {
  61     description
  62       "";
  63     container hop-type {
  64       choice hop-type {
  65         case SRLG {
  66           leaf SRLG {
  67             type string;
  68             //to be clarified with topology model
  69           }
  70         }
  71         case clli {
  72           leaf clli {
  73             type string;
  74             //to be clarified with topology model
  75           }
  76         }
  77         case node {
  78           leaf node-id {
  79             type string;
  80             // to be clarified with topology model
  81           }
  82         }
  83       }
  84     }
  85   }
  86
  87   grouping diversity-existing-service-contraints-sp {
  88     leaf-list existing-service {
  89       type string;
  90       description
  91         "Diverse from existing services identified by facility CLFI";
  92     }
  93     container existing-service-applicability {
  94       leaf clli {
  95         type boolean;
  96       }
  97       leaf node {
  98         type boolean;
  99       }
 100       leaf srlg {
 101         type boolean;
 102       }
 103     }
 104   }
 105
 106   grouping routing-constraints-sp {
 107     container hard-constraints {
 108       uses constraints-sp;
 109     }
 110     container soft-constraints {
 111       uses constraints-sp;
 112     }
 113     leaf pce-metric {
 114       type enumeration {
 115         enum hop-count;
 116         enum propagation-delay;
 117         enum TE-metric;
 118         enum IGP-metric;
 119       }
 120     }
 121     leaf locally-protected-links {
 122       type boolean;
 123       description
 124         "indicates whether it must use locally protected links or not";
 125     }
 126   }
 127
 128   grouping constraints-sp {
 129     leaf-list customer-code {
 130       type string;
 131     }
 132     choice co-routing-or-general {
 133       case general {
 134         container diversity {
 135           uses diversity-existing-service-contraints-sp;
 136         }
 137         container exclude_ {
 138           uses common-constraints-sp;
 139           leaf-list supporting-service-name {
 140             type string;
 141             description
 142               "Supporting service(s) to exclude from this route.";
 143           }
 144           leaf affinity {
 145             type uint32;
 146           }
 147         }
 148         container include_ {
 149           list ordered-hops {
 150             key "hop-number";
 151             leaf hop-number {
 152               type uint16;
 153               description
 154                 "designates the id of the hop: node-id, SRLG-id, site-id";
 155             }
 156             uses ordered-constraints-sp;
 157           }
 158         }
 159         container latency {
 160           description
 161             "Maximum latency allowed";
 162           leaf max-latency {
 163             type uint32;
 164             units "ms";
 165           }
 166         }
 167       }
 168       case co-routing {
 169         container co-routing {
 170           leaf-list existing-service {
 171             type string;
 172             description
 173               "Diverse from existing services identified by facility CLFI";
 174           }
 175         }
 176       }
 177     }
 178   }
 179 }