1 module transportpce-common-types {
2 namespace "http://org/transportpce/common-types";
3 prefix org-transportpce-common-types;
5 import org-openroadm-resource-types {
6 prefix org-openroadm-resource-types;
7 revision-date 2016-10-14;
9 import org-openroadm-pm-types {
10 prefix org-openroadm-pm-types;
11 revision-date 2016-10-14;
13 import org-openroadm-common-types {
14 prefix org-openroadm-common-types;
15 revision-date 2018-10-19;
20 "Replace olm-renderer-input by optical-rendrer-input.
21 Create optical-renderer-nodes and otn-renderer-nodes groupings";
25 "Update grouping olm-renderer-input, adding min, max frequencies
26 lower spectral slot number and higher spectral slot number
27 fix center-freq unit";
31 "Updated grouping olm-renderer-input to enable support for flex-grid";
35 "Add necessary parameters to consolidate OTN and address ONAP
36 MDONS use case, including grouping otn-renderer-input";
40 "Add grouping otn-renderer-input";
44 "Initial revision of TransportPCE common-types";
47 typedef pm-names-enum {
49 enum vendorExtension {
57 "Bit error rate (BER)";
59 enum opticalPowerOutput {
62 "Optical Power Output (OPOUT-OTS, OPOUT-OMS, OPT-OCH). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
64 enum opticalReturnLoss {
67 "Optical Return Loss (ORL-OTS) - at MW port(s) B";
69 enum opticalPowerInput {
72 "Optical Power Input (OPIN-OTS, OPIN-OMS, OPR-OCH). Total optical power";
77 "Code Violations (CV)";
82 "Errored Seconds (ES)";
84 enum severelyErroredSeconds {
87 "Severely Errored Seconds (SES)";
89 enum unavailableSeconds {
92 "Unavailable Seconds (UAS)";
97 "In frames (INFRAMES-E)";
99 enum inFramesErrored {
102 "In frames errored (INFRAMESERR-E)";
107 "Out frames (OUTFRAMES-E)";
109 enum erroredSecondsEthernet {
112 "Errored Seconds Ethernet (ES-E)";
114 enum severelyErroredSecondsEthernet {
117 "Severly Errored Seconds, Ethernet (SES-E)";
119 enum unavailableSecondsEthernet {
122 "Unavailable Seconds, Ethernet (UAS-E)";
124 enum erroredBlockCount {
127 "Errored block count";
132 "Number of frames between a DMValue toggle event and the received DMp signal value toggle event";
137 "Defect Seconds (DS)";
139 enum backwardIncomingAlignmentError {
142 "Backward Incoming Alignment Error (BIAE)";
144 enum incomingAlignmentError {
147 "Incoming Alignment Error (IAE)";
149 enum opticalPowerOutputMin {
152 "Minimum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
154 enum opticalPowerOutputMax {
157 "Maximum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
159 enum opticalPowerOutputAvg {
162 "Average Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
164 enum opticalPowerInputMin {
167 "Minimum Optical Power Input (OPIN-OTS). Total optical power";
169 enum opticalPowerInputMax {
172 "Maximum Optical Power Input (OPIN-OTS). Total optical power";
174 enum opticalPowerInputAvg {
177 "Average Optical Power Input (OPIN-OTS). Total optical power";
179 enum opticalPowerOutputOSC {
182 "OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
184 enum opticalPowerOutputOSCMin {
187 "Minimum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
189 enum opticalPowerOutputOSCMax {
192 "Maximum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
194 enum opticalPowerOutputOSCAvg {
197 "Average OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
199 enum opticalPowerInputOSC {
202 "OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
204 enum opticalPowerInputOSCMin {
207 "Minimum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
209 enum opticalPowerInputOSCMax {
212 "Maximum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
214 enum opticalPowerInputOSCAvg {
217 "Average OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
219 enum preFECCorrectedErrors {
222 "pFEC corrected Errors";
224 enum totalOpticalPowerInput {
227 "Total Optical Power Input.";
229 enum totalOpticalPowerInputMin {
232 "Minumun Total Optical Power Input.";
234 enum totalOpticalPowerInputMax {
237 "Maximum Total Optical Power Input.";
239 enum totalOpticalPowerInputAvg {
242 "Average Total Optical Power Input.";
244 enum FECCorrectableBlocks {
247 "FEC Correctable Blocks.";
249 enum FECUncorrectableBlocks {
252 "FEC Uncorrectable Blocks.";
254 enum BIPErrorCounter {
259 enum protectionSwitchingCount {
262 "Protection Switching Count (PSC)";
264 enum protectionSwitchingDuration {
267 "Protection Switching Duration in seconds (PSD)";
269 enum erroredBlockCountTCM1-up {
272 "errored Blocks Count on TCM1 up direction.";
274 enum erroredBlockCountTCM2-up {
277 "errored Blocks Count on TCM2 up direction.";
279 enum erroredBlockCountTCM3-up {
282 "errored Blocks Count on TCM3 up direction.";
284 enum erroredBlockCountTCM4-up {
287 "errored Blocks Count on TCM4 up direction.";
289 enum erroredBlockCountTCM5-up {
292 "errored Blocks Count on TCM5 up direction.";
294 enum erroredBlockCountTCM6-up {
297 "errored Blocks Count on TCM6 up direction.";
302 "Delay on TCM1 up direction.";
307 "Delay on TCM2 up direction.";
312 "Delay on TCM3 up direction.";
317 "Delay on TCM4 up direction.";
322 "Delay on TCM5 up direction.";
327 "Delay on TCM6 up direction.";
329 enum erroredBlockCountTCM1-down {
332 "errored Blocks Count on TCM1 down direction.";
334 enum erroredBlockCountTCM2-down {
337 "errored Blocks Count on TCM2 down direction.";
339 enum erroredBlockCountTCM3-down {
342 "errored Blocks Count on TCM3 down direction.";
344 enum erroredBlockCountTCM4-down {
347 "errored Blocks Count on TCM4 down direction.";
349 enum erroredBlockCountTCM5-down {
352 "errored Blocks Count on TCM5 down direction.";
354 enum erroredBlockCountTCM6-down {
357 "errored Blocks Count on TCM6 down direction.";
359 enum delayTCM1-down {
362 "Delay on TCM1 down direction.";
364 enum delayTCM2-down {
367 "Delay on TCM2 down direction.";
369 enum delayTCM3-down {
372 "Delay on TCM3 down direction.";
374 enum delayTCM4-down {
377 "Delay on TCM4 down direction.";
379 enum delayTCM5-down {
382 "Delay on TCM5 down direction.";
384 enum delayTCM6-down {
387 "Delay on TCM6 down direction.";
434 grouping optical-renderer-nodes {
441 "Gloabally unique identifier for the node";
447 "Source termination point ";
453 "Destination termination point ";
458 grouping otn-renderer-nodes {
465 "Globally unique identifier for the node";
470 "Source termination point ";
475 "Destination termination point for end nodes";
480 "Destination termination point for intermediate switch";
485 grouping optical-renderer-input {
487 "Type to be used by OLM and Renderer RPCs";
495 type org-openroadm-common-types:frequency-THz;
500 type org-openroadm-common-types:frequency-GHz;
503 type org-openroadm-common-types:frequency-THz;
506 type org-openroadm-common-types:frequency-THz;
508 leaf lower-spectral-slot-number {
511 leaf higher-spectral-slot-number {
514 uses optical-renderer-nodes;
515 uses node-interfaces;
518 grouping otn-renderer-input {
520 "Type to be used by OLM and Renderer RPCs for OTN";
524 uses otn-renderer-nodes;
527 grouping olm-get-pm-input {
532 "Gloabally unique identifier
536 type org-openroadm-resource-types:resource-type-enum;
539 "Type of the PM resource";
541 container resource-identifier {
546 "Identifier of particular resource of given type";
548 leaf circuit-pack-name {
549 when "../../resource-type = 'port'";
553 "In case resource type is port, then particular resource is identified by port-name
554 (resource-name) and circuit-pack-name (this leaf).";
558 type org-openroadm-pm-types:pm-granularity;
561 "Granularity of PM bin can be
562 notApplicable,15min,24Hour";
578 grouping node-interfaces {
579 list node-interface {
584 leaf-list och-interface-id {
587 leaf-list otu-interface-id {
590 leaf-list odu-interface-id {
593 leaf-list eth-interface-id {
596 leaf-list connection-id {
602 grouping otn-constraint {
603 container otn-constraints {
604 leaf trib-port-number {
607 "defines a trib-port that must be used at A or Z end";
609 leaf-list opu-trib-slots {
612 "defines a list of trib-slots that must be used at A or Z end";
614 leaf-list opucn-trib-slots {
617 "defines a list of opucn-trib-slots that must be used at A or
620 container imposed-api {
622 "defines constraints on access point identifier to be used by
623 local device when one end point of the path (service) is located
624 in a remote domain not handled by the controller. These parameters
625 are passed to the local controller (transportpce) for interoperability
627 SAPI : The source api (local domain) to be used by A
628 or Z end as expected by remote controller.
629 DAPI: defines the destination api (remote domain) to be used by A
630 or Z end as exposed in the remote domain. Used when the end of the path
631 is in an external domain, handled by a remote controller.
632 EXPECTED-SAPI : The api of the remote end of the path (in an external
633 domain) as expected to be received by A or Z end.
634 EXPECTED-DAPI : defines the destination api to be used by remote end
635 as exposed in the local domain. Used when the end of the path is in an
636 external domain, handled by a remote controller";
646 "The source api used by the node";
651 "the destination api of the other end of the path";
656 "The api of the remote end of the path as expected to be received
662 "api of the node itself, supposed to be used by remote end as