1 module org-openroadm-xponder {
3 namespace "http://org/openroadm/xponder";
6 import org-openroadm-network-types {
7 prefix org-openroadm-network-types;
8 revision-date 2020-05-29;
10 import org-openroadm-common-equipment-types {
11 prefix org-openroadm-common-equipment-types;
12 revision-date 2019-11-29;
14 import org-openroadm-common-state-types {
15 prefix org-openroadm-common-state-types;
16 revision-date 2019-11-29;
18 import org-openroadm-common-optical-channel-types {
19 prefix org-openroadm-common-optical-channel-types;
20 revision-date 2020-05-29;
22 import org-openroadm-otn-common-types {
23 prefix org-openroadm-otn-common-types;
24 revision-date 2020-03-27;
26 import org-openroadm-service-format {
27 prefix org-openroadm-service-format;
28 revision-date 2019-11-29;
36 "YANG definitions for xponder
38 Copyright of the Members of the Open ROADM MSA Agreement dated (c) 2016,
39 All other rights reserved.
41 Redistribution and use in source and binary forms, with or without modification,
42 are permitted provided that the following conditions are met:
44 * Redistributions of source code must retain the above copyright notice, this
45 list of conditions and the following disclaimer.
46 * Redistributions in binary form must reproduce the above copyright notice,
47 this list of conditions and the following disclaimer in the documentation and/or
48 other materials provided with the distribution.
49 * Neither the Members of the Open ROADM MSA Agreement nor the names of its
50 contributors may be used to endorse or promote products derived from this software
51 without specific prior written permission.
53 THIS SOFTWARE IS PROVIDED BY THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT ''AS IS''
54 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
55 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
56 IN NO EVENT THE MEMBERS OF THE OPEN ROADM MSA AGREEMENT BE LIABLE FOR ANY DIRECT,
57 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
58 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
59 OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
60 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
61 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
62 POSSIBILITY OF SUCH DAMAGE.";
100 revision 2018-03-30 {
104 revision 2017-12-15 {
108 revision 2017-09-29 {
112 revision 2017-07-28 {
114 "Version 2.0.1 - added revision-date to imports";
116 revision 2017-06-26 {
120 revision 2016-10-14 {
125 grouping xpdr-node-attributes {
129 "Owner of the xponder";
133 grouping xpdr-topo-node-attributes {
139 grouping xpdr-connection-attributes {
145 base org-openroadm-common-optical-channel-types:optical-rate-identity;
150 leaf modulation-format {
151 type org-openroadm-common-optical-channel-types:modulation-format;
154 type org-openroadm-common-equipment-types:optic-types;
157 type org-openroadm-common-state-types:state;
159 "A xponder can be in one of the following
164 grouping xpdr-port-connection-attributes {
165 container wavelength {
166 uses org-openroadm-network-types:flex-wave;
168 leaf tail-equipment {
171 "Type of equipment connected to the tail
172 for example packet box";
174 leaf tail-equipment-id {
177 "Identifier of equipment connected to the
178 tail for example client equipement ID";
185 grouping xpdr-otn-tp-attributes {
188 base org-openroadm-otn-common-types:odu-rate-identity;
191 "rate identity of the ODU. 'identityref' is used
192 to allow to extend for future higher rates";
198 base org-openroadm-otn-common-types:odtu-type-identity;
201 "ODTU type, part of the MSI (Multiplex Structure Identifier)";
206 "List of available Tributary Port Number (0-based), part of the MSI";
212 "List of available Tributary Slots used by port";
216 grouping xpdr-mode-attributes {
217 container supported-operational-modes {
218 list operational-mode {
221 "list of supported operational modes";
225 "Optical profile operational mode identifier";
227 leaf spectral-width {
228 type org-openroadm-common-optical-channel-types:frequency-GHz;
231 "The required minimum signal spectral width of signal at -22 dbm.";
235 leaf operational-mode {
239 "The provisioned operational-mode of the equipment.";
243 grouping supported-client-services {
244 container supported-client-services {
245 list supported-client-service {
246 key "service-format";
248 "Supported Client Services";
249 leaf service-format {
250 type org-openroadm-service-format:service-format;
252 "Format of the requested service: Ethernet, OTU, etc.";
254 leaf-list service-rate {
257 "Rate of the requested service in GBps. Not used when service-format=other.";
259 leaf-list other-service-format-and-rate {
262 "Used when service-format is set to other in the bookend xponder use case.
263 The use of other-service-format-and-rate is not standardized in the Open ROADM MSA
264 and intended to allow the controller to support non-Open ROADM service formats.
265 This value encodes both the service format and the rate supported.
266 This field should not be specified when service format != other.";
270 uses provisioned-client-service;
273 grouping provisioned-client-service {
274 leaf service-format {
275 type org-openroadm-service-format:service-format;
277 "Format of the provisioned service: Ethernet, OTU, etc.";
282 "Provisioned rate of the requested service in GBps. Not used when service-format=other.";
284 leaf other-service-format-and-rate {
287 "Used when service-format is set to other in the bookend xponder use case.
288 The use of other-service-format-and-rate is not standardized in the Open ROADM MSA
289 and intended to allow the controller to support non-Open ROADM service formats.
290 This value encodes the provisioned service format and the rate supported.
291 This field should not be specified when service format != other.";