1 module org-openroadm-resource-types {
2 namespace "http://org/openroadm/resource/types";
3 prefix org-openroadm-resource-types;
5 organization "Open ROADM MSA";
9 "YANG definitions of common resource types.
11 Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
12 AT&T Intellectual Property. All other rights reserved.
14 Redistribution and use in source and binary forms, with or without modification,
15 are permitted provided that the following conditions are met:
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.
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";
42 grouping resource-type {
44 type resource-type-enum;
53 typedef resource-type-enum {
58 "Resource of type not found in list.";
63 "device - ROAMD, Xponder, etc";
70 enum "shared-risk-group" {
80 enum "connection-map" {
95 enum "internal-link" {
100 enum "physical-link" {
125 "Device identifier. Unique within the Controller.";
128 "Node Id is a globally unique identifier for a device.
129 Same as leafref value in model, if applicable.";
134 grouping circuit-pack-name {
135 leaf circuit-pack-name {
137 "Circuit-Pack identifier. Unique within the context of a device.
138 Same as leafref value in model, if applicable.";
145 uses circuit-pack-name;
148 "Port identifier. Unique within the context of a circuit-pack.
149 Same as leafref value in model, if applicable.";
154 grouping physical-link-name {
155 leaf physical-link-name {
157 "Physical Link identifier. Unique within the context of a device.
158 Same as leafref value in model, if applicable.";
164 grouping internal-link-name {
165 leaf internal-link-name {
167 "Internal Link identifier. Unique within the context of a device.
168 Same as leafref value in model, if applicable.";
174 grouping connection-number {
175 leaf connection-number {
177 "Connection identifier. Unique within the context of a device.
178 Same as leafref value in model, if applicable.";
183 grouping degree-number {
186 "Degree identifier. Unique within the context of a device.
187 Same as leafref value in model, if applicable.";
192 grouping srg-number {
195 "Shared Risk Group identifier. Unique within the context of a device.
196 Same as leafref value in model, if applicable.";
201 grouping shelf-name {
204 "Shelf-id identifier. Unique within the context of a device.
205 Same as leafref value in model, if applicable.";
211 grouping service-name {
214 "Service identifier. Unique within the context of a network.
215 Same as leafref value in model, if applicable.";
221 grouping interface-name {
222 leaf interface-name {
224 "Interface identifier.";
230 typedef resource-notification-type {
232 "Type of notification about a resource";
234 enum "resourceCreation" {
237 "A new instance of a resource has been created.";
239 enum "resourceModification" {
242 "An exhisting instance of a resource has been modified. This shall be triggered by changes in configuration, state, status etc.
243 It shall not be triggered by changes in performance measurements, power and temperature readings or any other data that is highlyvolatile. ";
245 enum "resourceDeletion" {
248 "An exhisting instance of a resource has been removed.";