Update docs conf.yaml version to Sulfur
[transportpce.git] / ordmodels / common / src / main / yang / org-openroadm-network-resource@2019-11-29.yang
1 module org-openroadm-network-resource {
2   namespace "http://org/openroadm/network-resource";
3   prefix org-openroadm-network-resource;
4
5   organization
6     "Open ROADM MSA";
7   contact
8     "OpenROADM.org";
9   description
10     "YANG definitions of resources.
11
12       Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
13       All other rights reserved.
14
15       Redistribution and use in source and binary forms, with or without modification,
16       are permitted provided that the following conditions are met:
17
18       * Redistributions of source code must retain the above copyright notice, this
19         list of conditions and the following disclaimer.
20       * Redistributions in binary form must reproduce the above copyright notice,
21         this list of conditions and the following disclaimer in the documentation and/or
22         other materials provided with the distribution.
23       * Neither the Members of the Open ROADM MSA Agreement nor the names of its
24         contributors may be used to endorse or promote products derived from this software
25         without specific prior written permission.
26
27       THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS''
28       AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
29       WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
30       IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT,
31       INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
32       NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA,
33       OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
34       WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35       ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36       POSSIBILITY OF SUCH DAMAGE";
37
38   revision 2019-11-29 {
39     description
40       "Version 6.1.0";
41   }
42   revision 2018-11-30 {
43     description
44       "Version 4.1.0";
45   }
46   revision 2018-03-30 {
47     description
48       "Version 3.0.0";
49   }
50
51   identity network-resource-types {
52     description
53       "base type for network resources";
54   }
55
56   identity network-resource-tp {
57     base network-resource-types;
58     description
59       "tp-id network resource";
60   }
61
62   identity network-resource-link {
63     base network-resource-types;
64     description
65       "link-id network resource";
66   }
67
68   grouping network-resource {
69     description
70       "This resource identifier is intended to provide a generic identifer
71        for any network resource that can be used without specific knowledge of
72        the resource.";
73     container network-resource {
74       choice network-resource {
75         case network-resource-tp {
76           uses network-tp-name;
77         }
78         case network-resource-link {
79           uses network-link-name;
80         }
81       }
82     }
83     leaf network-resource-type {
84       type identityref {
85         base network-resource-types;
86       }
87       mandatory true;
88     }
89   }
90
91   grouping network-tp-name {
92     leaf tp-network-id {
93       type string;
94       mandatory true;
95       description
96         "network-id from the network model.";
97     }
98     leaf tp-node-id {
99       type string;
100       mandatory true;
101       description
102         "node-id from the network model.";
103     }
104     leaf tp-id {
105       type string;
106       mandatory true;
107       description
108         "tp-id from the network model.";
109     }
110   }
111
112   grouping network-link-name {
113     leaf link-network-id {
114       type string;
115       mandatory true;
116       description
117         "network-id from the network model.";
118     }
119     leaf link-id {
120       type string;
121       mandatory true;
122       description
123         "link-id from the network model.";
124     }
125   }
126 }