Sync Common folder
[transportpce.git] / ordmodels / device / src / main / yang / org-openroadm-device-resource-types@2016-10-14.yang
1 module org-openroadm-device-resource-types {
2   namespace "http://org/openroadm/de/device-resource-types";
3   prefix org-openroadm-device-resource-types;
4
5   organization "Open ROADM MSA";
6   contact
7     "OpenROADM.org";
8   description
9     "YANG definitions of resource types.
10      
11      Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016, 
12      AT&T Intellectual Property.  All other rights reserved.
13      
14      Redistribution and use in source and binary forms, with or without modification, 
15      are permitted provided that the following conditions are met:
16      
17      * Redistributions of source code must retain the above copyright notice, this 
18        list of conditions and the following disclaimer.
19      * Redistributions in binary form must reproduce the above copyright notice, 
20        this list of conditions and the following disclaimer in the documentation and/or 
21        other materials provided with the distribution.
22      * Neither the Members of the Open ROADM MSA Agreement nor the names of its 
23        contributors may be used to endorse or promote products derived from this software 
24        without specific prior written permission.
25      
26      THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT ''AS IS'' 
27      AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
28      WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
29      IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA  AGREEMENT BE LIABLE FOR ANY DIRECT, 
30      INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
31      NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;  LOSS OF USE, DATA, 
32      OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
33      WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
34      ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
35      POSSIBILITY OF SUCH DAMAGE.";
36
37   revision 2016-10-14 {
38     description
39       "Version 1.2";
40   }
41
42 /* Currently not used; if used later, needs to move to org-openroadm-device.yang so leafref can be resolved.
43   grouping device-id {
44     description
45       "Device identifier. Unique within the Controller.";
46     leaf node-id {
47       description
48         "Node Id. Globally unique identifier for a device.";
49       type leafref {
50         path "/org-openroadm-device/info/node-id";
51       }
52       mandatory true;
53     }
54   }
55 */
56
57 /* Currently not used; if used later, needs to move to org-openroadm-device.yang so leafref can be resolved.
58   grouping shelf-name {
59     leaf shelf-name {
60       description
61         "Shelf identifier. Unique within the context of a device.";
62       type leafref {
63         path "/org-openroadm-device/shelves/shelf-name";
64       }
65       mandatory true;
66       config false;
67     }
68   }
69 */
70
71 /* Currently not used; if used later, needs to move to org-openroadm-device.yang so leafref can be resolved.
72   grouping physical-link-name {
73     leaf physical-link-name {
74       description
75         "Physical Link identifier. Unique within the context of a device.";
76       type leafref {
77         path "/org-openroadm-device/physical-link/physical-link-name";
78       }
79       mandatory true;
80       config false;
81     }
82   }
83 */
84
85 /* Currently not used; if used later, needs to move to org-openroadm-device.yang so leafref can be resolved.
86   grouping internal-link-name {
87     uses org-openroadm-device:circuit-pack-name;
88     leaf internal-link-name {
89       description
90         "Internal Link identifier. Unique within the context of a circuit pack.";
91       type leafref {
92         path "/org-openroadm-device/internal-link/internal-link-name";
93       }
94       mandatory true;
95       config false;
96     }
97   }
98 */
99
100 /* Currently not used; if used later, needs to move to org-openroadm-device.yang so leafref can be resolved.
101   grouping connection-number {
102     leaf connection-number {
103       description
104         "Connection identifier. Unique within the context of a device.";
105       type leafref {
106         path "/org-openroadm-device/connections/connection-number";
107       }
108     }
109   }
110 */
111
112 /* Currently not used; if used later, needs to move to org-openroadm-device.yang so leafref can be resolved.
113   grouping this-will-test-ids {
114     uses device-id;
115     container shelf {
116       uses shelf-name;
117     }
118     container circuit-pack {
119       uses org-openroadm-device:circuit-pack-name;
120     }
121     container port {
122       uses org-openroadm-device:port-name;
123     }
124     uses internal-link-name;
125     uses physical-link-name;
126     uses connection-number;
127     uses org-openroadm-device:srg-number;
128     uses org-openroadm-device:degree-number;
129   }
130 */
131
132 /* Currently not used; if used later, needs to move to org-openroadm-device.yang so leafref can be resolved.
133   grouping xponder-device-id {
134     description
135       "Xponder identifier. Unique within the Controller.";
136     leaf node-id {
137       description
138         "Xponder Id. Globally unique identifier for the device";
139       type leafref {
140         path "/org-openroadm-device/info/node-id";
141       }
142       mandatory true;
143     }
144   }
145 */
146
147 /* Currently not used; if used later, needs to move to org-openroadm-device.yang so leafref can be resolved.
148   grouping xponder-number {
149     leaf xponder-number {
150       description
151         "Xponder identifier. Unique within the context of a device.";
152       type leafref {
153         path "/org-openroadm-device/xponders/xponder-number";
154       }
155       config false;
156     }
157   }
158 */
159
160 /* Currently not used; if used later, needs to move to org-openroadm-device.yang so leafref can be resolved.
161   grouping xponder-shelf-name {
162     uses xponder-number;
163     leaf shelf-name {
164       description
165         "Shelf identifier. Unique within the context of a device.";
166       type leafref {
167         path "/org-openroadm-device/xponders[xponder-number=current()/../xponder-number]/shelves/shelf-name";
168       }
169       mandatory true;
170       config false;
171     }
172   }
173 */
174
175 /* Currently not used; if used later, needs to move to org-openroadm-device.yang so leafref can be resolved.
176   grouping xponder-circuit-pack-name {
177     uses xponder-number;
178     leaf circuit-pack-name {
179       description
180         "Circuit Pack identifier. Unique within the context of a xponder.";
181       type leafref {
182         path "/org-openroadm-device/circuit-packs/circuit-pack-name";
183       }
184       config false;
185     }
186   }
187 */
188
189 /* Currently not used; if used later, needs to move to org-openroadm-device.yang so leafref can be resolved.
190   grouping xponder-port-name {
191     uses xponder-circuit-pack-name;
192     leaf port-name {
193       description
194         "Port identifier. Unique within the context of a circuit-pack.";
195       type leafref {
196         path "/org-openroadm-device/circuit-packs[circuit-pack-name=current()/../circuit-pack-name]/ports/port-name";
197       }
198       config false;
199     }
200   }
201 */
202
203 /* Currently not used; if used later, needs to move to org-openroadm-device.yang so leafref can be resolved.
204   grouping this-will-test-xponder-ids {
205     uses xponder-device-id;
206     container shelf {
207       uses xponder-shelf-name;
208     }
209     container circuit-pack {
210       uses xponder-circuit-pack-name;
211     }
212     container port {
213       uses xponder-port-name;
214     }
215   }
216 */
217 }