1 module org-openroadm-common-network {
3 namespace "http://org/openroadm/common/network";
8 revision-date 2018-02-26;
10 import ietf-network-topology {
12 revision-date 2018-02-26;
14 import org-openroadm-network-types {
15 prefix org-openroadm-network-types;
16 revision-date 2020-05-29;
18 import org-openroadm-common-state-types {
19 prefix org-openroadm-common-state-types;
20 revision-date 2019-11-29;
22 import org-openroadm-equipment-states-types {
23 prefix org-openroadm-equipment-states-types;
24 revision-date 2019-11-29;
32 "Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
33 All other rights reserved.
35 Redistribution and use in source and binary forms, with or without modification,
36 are permitted provided that the following conditions are met:
38 * Redistributions of source code must retain the above copyright notice, this
39 list of conditions and the following disclaimer.
40 * Redistributions in binary form must reproduce the above copyright notice,
41 this list of conditions and the following disclaimer in the documentation and/or
42 other materials provided with the distribution.
43 * Neither the Members of the Open ROADM MSA Agreement nor the names of its
44 contributors may be used to endorse or promote products derived from this software
45 without specific prior written permission.
47 THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT ''AS IS''
48 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
49 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
50 IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT BE LIABLE FOR ANY DIRECT,
51 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
52 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
53 OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
54 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
55 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
56 POSSIBILITY OF SUCH DAMAGE.";
99 augment "/nd:networks/nd:network/nd:network-types" {
101 "Introduce new network type for the Open ROADM common network";
102 container openroadm-common-network {
103 presence "indicates common network of Open ROADMs";
105 "The presence of the container node indicates Open ROADM common network";
109 augment "/nd:networks/nd:network/nd:node" {
110 when '../nd:network-types/cnet:openroadm-common-network';
112 "Augment the generic network node with Open ROADM common attributes.";
114 type org-openroadm-network-types:openroadm-node-type;
116 "A component of the network topology. Once the node-type is configured, it should not be modified.";
118 leaf lifecycle-state {
119 type org-openroadm-common-state-types:lifecycle-state;
121 "Lifecycle State of a node. Whether it is planned, deployed, in maintenance, etc.";
123 leaf operational-state {
124 type org-openroadm-common-state-types:state;
126 leaf administrative-state {
127 type org-openroadm-equipment-states-types:admin-states;
131 augment "/nd:networks/nd:network/nd:node/nwt:termination-point" {
132 when '../../nd:network-types/cnet:openroadm-common-network';
134 type org-openroadm-network-types:openroadm-tp-type;
136 "The type of a termination point in the ROADM topology.";
142 "Applies to Termination Points that map to physical ports or slots on circuit packs.
143 Set to True when the termination point maps to ports of an existing circuit-pack,
144 False, when mapped to a slot (pluggable optics Holder) --> virtual tp.
145 This attribute is not present for other Termination Points.";
147 leaf-list associated-connection-map-tp {
149 path "/nd:networks/nd:network/nd:node/nwt:termination-point/nwt:tp-id";
152 "Used to identify relationships between client and network ports in transponders and
153 uni-directional regens. Provides the list of tps the tp is connected to, as defined
154 in the device connection map.";
159 "Shared Risk Group identifier. All ports in a circuit-pack will have same srg-id";
161 leaf lifecycle-state {
162 type org-openroadm-common-state-types:lifecycle-state;
164 "Lifecycle State of a termination point. Whether it is planned, deployed, in maintenance, etc.";
166 leaf operational-state {
167 type org-openroadm-common-state-types:state;
169 leaf administrative-state {
170 type org-openroadm-equipment-states-types:admin-states;
174 augment "/nd:networks/nd:network/nwt:link" {
175 when '../nd:network-types/cnet:openroadm-common-network';
177 "This augmentation defines common link attributes in the Open ROADM common network";
179 type org-openroadm-network-types:openroadm-link-type;
186 path "../../nwt:link/nwt:link-id";
189 "optional - pointer to reverse link in case of bidirectional link. Supersedes opposite-link
190 originally defined in OMS-attributes container, to apply to any kind of link in the topology";
207 "defines a Traffic Engineering metric which could be used for any type of link.
208 Supersedes TE-metric originally defined in OMS-attributes grouping";
210 list link-concatenation {
215 "unique identifier for SRLG";
220 "fiber length in meters";
223 leaf administrative-group {
226 "according to RFC 3630 definition";
228 leaf operational-state {
229 type org-openroadm-common-state-types:state;
231 leaf administrative-state {
232 type org-openroadm-equipment-states-types:admin-states;
234 leaf lifecycle-state {
235 type org-openroadm-common-state-types:lifecycle-state;
237 "Lifecycle State of a link. Whether it is planned, deployed, in maintenance, etc.";