66b369033b4629b768bd3c58338dd9bfde7394e3
[transportpce.git] / 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-04-26 {
40       description
41         "Version 1.5";
42   }
43   revision 2017-10-17 {
44     description
45       "Version 1.6";
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; //to be clarified with topology model
68           }
69         }
70
71         case clli {
72           leaf clli {
73                type string; //to be clarified with topology model
74           }
75         }
76
77         case node {
78           leaf node-id {
79                type string; // to be clarified with topology model
80           }
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   grouping routing-constraints-sp {
106     container hard-constraints {
107       uses constraints-sp;
108     }
109     container soft-constraints {
110       uses constraints-sp;
111     }
112     leaf pce-metric {
113          type enumeration {
114               enum hop-count;
115               enum propagation-delay;
116               enum TE-metric;
117               enum IGP-metric;
118          }
119     }
120     leaf locally-protected-links {
121          type boolean;
122          description "indicates whether it must use locally protected links or not";
123     }
124   }
125
126   grouping constraints-sp {
127     leaf-list customer-code {
128       type string;
129     }
130     choice co-routing-or-general {
131       case general {
132         container diversity {
133           uses diversity-existing-service-contraints-sp;
134         }
135         container exclude_ {
136           uses common-constraints-sp;
137           leaf-list supporting-service-name {
138             description
139               "Supporting service(s) to exclude from this route.";
140             type string;
141           }
142           leaf affinity {
143                type uint32;
144           }
145         }
146         container include_ {
147           list ordered-hops {
148                key hop-number;
149                leaf hop-number {
150                     description
151                       "designates the id of the hop: node-id, SRLG-id, site-id";
152                     type uint16;
153                }
154                uses ordered-constraints-sp;
155           }
156
157         }
158         container latency {
159           description
160             "Maximum latency allowed";
161           leaf max-latency {
162             type uint32;
163             units "ms";
164           }
165         }
166       }
167       case co-routing {
168         container co-routing {
169           leaf-list existing-service {
170             type string;
171             description
172               "Diverse from existing services identified by facility CLFI";
173           }
174         }
175       }
176     }
177   }
178
179
180 }