1 module org-openroadm-resource-types {
2 namespace "http://org/openroadm/resource/types";
3 prefix org-openroadm-resource-types;
5 import org-openroadm-common-types {
6 prefix org-openroadm-common-types;
7 revision-date 2017-12-15;
15 "YANG definitions of common resource types.
17 Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
18 AT&T Intellectual Property. All other rights reserved.
20 Redistribution and use in source and binary forms, with or without modification,
21 are permitted provided that the following conditions are met:
23 * Redistributions of source code must retain the above copyright notice, this
24 list of conditions and the following disclaimer.
25 * Redistributions in binary form must reproduce the above copyright notice,
26 this list of conditions and the following disclaimer in the documentation and/or
27 other materials provided with the distribution.
28 * Neither the Members of the Open ROADM MSA Agreement nor the names of its
29 contributors may be used to endorse or promote products derived from this software
30 without specific prior written permission.
32 THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT ''AS IS''
33 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
34 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
35 IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT BE LIABLE FOR ANY DIRECT,
36 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
37 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
38 OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
39 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 POSSIBILITY OF SUCH DAMAGE";
60 typedef resource-type-enum {
65 "Resource of type not found in list.";
70 "device - ROAMD, Xponder, etc";
77 enum "shared-risk-group" {
85 "connection - this is used by roadm-connection and odu-connection
86 since they are mutually exclusive in the model";
88 enum "connection-map" {
103 enum "internal-link" {
108 enum "physical-link" {
133 enum "line-amplifier" {
143 enum "versioned-service" {
148 enum "temp-service" {
156 typedef resource-notification-type {
158 enum "resourceCreation" {
161 "A new instance of a resource has been created.";
163 enum "resourceModification" {
166 "An exhisting instance of a resource has been modified. This shall be triggered by changes in configuration, state, status etc.
167 It shall not be triggered by changes in performance measurements, power and temperature readings or any other data that is highlyvolatile. ";
169 enum "resourceDeletion" {
172 "An exhisting instance of a resource has been removed.";
176 "Type of notification about a resource";
179 grouping resource-type {
181 type resource-type-enum;
192 "Device identifier. Unique within the Controller.";
194 type org-openroadm-common-types:node-id-type;
196 "Node Id is a globally unique identifier for a device.
197 Same as leafref value in model, if applicable.";
201 grouping circuit-pack-name {
202 leaf circuit-pack-name {
206 "Circuit-Pack identifier. Unique within the context of a device.
207 Same as leafref value in model, if applicable.";
212 uses circuit-pack-name;
216 "Port identifier. Unique within the context of a circuit-pack.
217 Same as leafref value in model, if applicable.";
221 grouping physical-link-name {
222 leaf physical-link-name {
226 "Physical Link identifier. Unique within the context of a device.
227 Same as leafref value in model, if applicable.";
231 grouping internal-link-name {
232 leaf internal-link-name {
236 "Internal Link identifier. Unique within the context of a device.
237 Same as leafref value in model, if applicable.";
241 grouping connection-name {
242 leaf connection-name {
245 "Connection name. Unique within the context of a device.
246 Same as leafref value in model, if applicable.";
250 grouping degree-number {
254 "Degree identifier. Unique within the context of a device.
255 Same as leafref value in model, if applicable.";
259 grouping srg-number {
263 "Shared Risk Group identifier. Unique within the context of a device.
264 Same as leafref value in model, if applicable.";
268 grouping shelf-name {
273 "Shelf-id identifier. Unique within the context of a device.
274 Same as leafref value in model, if applicable.";
278 grouping service-name {
283 "Service identifier. Unique within the context of a network.
284 Same as leafref value in model, if applicable.";
288 grouping versioned-service-name {
289 leaf versioned-service-name {
293 "Service identifier. Unique within the context of a network.
294 Same as leafref value in model, if applicable.";
296 leaf version-number {
300 "version-number of the service";
304 grouping temp-service-name {
309 "Service identifier. Unique within the context of a network.
310 Same as leafref value in model, if applicable.";
314 grouping interface-name {
315 leaf interface-name {
319 "Interface identifier.";
323 grouping other-resource-id {
324 leaf other-resource-id {
328 "resource-id for other.";
332 grouping odu-sncp-pg-name {
333 leaf odu-sncp-pg-name {
337 "name of the odu-snc-pg";
341 grouping amp-number {
346 "number of the line-amplifier";
350 grouping xpdr-number {
355 "number of the xponder";