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 "Update grouping olm-renderer-input, adding min, max frequencies
21 lower spectral slot number and higher spectral slot number
22 fix center-freq unit";
26 "Updated grouping olm-renderer-input to enable support for flex-grid";
30 "Add necessary parameters to consolidate OTN and address ONAP
31 MDONS use case, including grouping otn-renderer-input";
35 "Add grouping otn-renderer-input";
39 "Initial revision of TransportPCE common-types";
42 typedef pm-names-enum {
44 enum vendorExtension {
52 "Bit error rate (BER)";
54 enum opticalPowerOutput {
57 "Optical Power Output (OPOUT-OTS, OPOUT-OMS, OPT-OCH). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
59 enum opticalReturnLoss {
62 "Optical Return Loss (ORL-OTS) - at MW port(s) B";
64 enum opticalPowerInput {
67 "Optical Power Input (OPIN-OTS, OPIN-OMS, OPR-OCH). Total optical power";
72 "Code Violations (CV)";
77 "Errored Seconds (ES)";
79 enum severelyErroredSeconds {
82 "Severely Errored Seconds (SES)";
84 enum unavailableSeconds {
87 "Unavailable Seconds (UAS)";
92 "In frames (INFRAMES-E)";
94 enum inFramesErrored {
97 "In frames errored (INFRAMESERR-E)";
102 "Out frames (OUTFRAMES-E)";
104 enum erroredSecondsEthernet {
107 "Errored Seconds Ethernet (ES-E)";
109 enum severelyErroredSecondsEthernet {
112 "Severly Errored Seconds, Ethernet (SES-E)";
114 enum unavailableSecondsEthernet {
117 "Unavailable Seconds, Ethernet (UAS-E)";
119 enum erroredBlockCount {
122 "Errored block count";
127 "Number of frames between a DMValue toggle event and the received DMp signal value toggle event";
132 "Defect Seconds (DS)";
134 enum backwardIncomingAlignmentError {
137 "Backward Incoming Alignment Error (BIAE)";
139 enum incomingAlignmentError {
142 "Incoming Alignment Error (IAE)";
144 enum opticalPowerOutputMin {
147 "Minimum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
149 enum opticalPowerOutputMax {
152 "Maximum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
154 enum opticalPowerOutputAvg {
157 "Average Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
159 enum opticalPowerInputMin {
162 "Minimum Optical Power Input (OPIN-OTS). Total optical power";
164 enum opticalPowerInputMax {
167 "Maximum Optical Power Input (OPIN-OTS). Total optical power";
169 enum opticalPowerInputAvg {
172 "Average Optical Power Input (OPIN-OTS). Total optical power";
174 enum opticalPowerOutputOSC {
177 "OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
179 enum opticalPowerOutputOSCMin {
182 "Minimum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
184 enum opticalPowerOutputOSCMax {
187 "Maximum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
189 enum opticalPowerOutputOSCAvg {
192 "Average OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
194 enum opticalPowerInputOSC {
197 "OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
199 enum opticalPowerInputOSCMin {
202 "Minimum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
204 enum opticalPowerInputOSCMax {
207 "Maximum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
209 enum opticalPowerInputOSCAvg {
212 "Average OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
214 enum preFECCorrectedErrors {
217 "pFEC corrected Errors";
219 enum totalOpticalPowerInput {
222 "Total Optical Power Input.";
224 enum totalOpticalPowerInputMin {
227 "Minumun Total Optical Power Input.";
229 enum totalOpticalPowerInputMax {
232 "Maximum Total Optical Power Input.";
234 enum totalOpticalPowerInputAvg {
237 "Average Total Optical Power Input.";
239 enum FECCorrectableBlocks {
242 "FEC Correctable Blocks.";
244 enum FECUncorrectableBlocks {
247 "FEC Uncorrectable Blocks.";
249 enum BIPErrorCounter {
254 enum protectionSwitchingCount {
257 "Protection Switching Count (PSC)";
259 enum protectionSwitchingDuration {
262 "Protection Switching Duration in seconds (PSD)";
264 enum erroredBlockCountTCM1-up {
267 "errored Blocks Count on TCM1 up direction.";
269 enum erroredBlockCountTCM2-up {
272 "errored Blocks Count on TCM2 up direction.";
274 enum erroredBlockCountTCM3-up {
277 "errored Blocks Count on TCM3 up direction.";
279 enum erroredBlockCountTCM4-up {
282 "errored Blocks Count on TCM4 up direction.";
284 enum erroredBlockCountTCM5-up {
287 "errored Blocks Count on TCM5 up direction.";
289 enum erroredBlockCountTCM6-up {
292 "errored Blocks Count on TCM6 up direction.";
297 "Delay on TCM1 up direction.";
302 "Delay on TCM2 up direction.";
307 "Delay on TCM3 up direction.";
312 "Delay on TCM4 up direction.";
317 "Delay on TCM5 up direction.";
322 "Delay on TCM6 up direction.";
324 enum erroredBlockCountTCM1-down {
327 "errored Blocks Count on TCM1 down direction.";
329 enum erroredBlockCountTCM2-down {
332 "errored Blocks Count on TCM2 down direction.";
334 enum erroredBlockCountTCM3-down {
337 "errored Blocks Count on TCM3 down direction.";
339 enum erroredBlockCountTCM4-down {
342 "errored Blocks Count on TCM4 down direction.";
344 enum erroredBlockCountTCM5-down {
347 "errored Blocks Count on TCM5 down direction.";
349 enum erroredBlockCountTCM6-down {
352 "errored Blocks Count on TCM6 down direction.";
354 enum delayTCM1-down {
357 "Delay on TCM1 down direction.";
359 enum delayTCM2-down {
362 "Delay on TCM2 down direction.";
364 enum delayTCM3-down {
367 "Delay on TCM3 down direction.";
369 enum delayTCM4-down {
372 "Delay on TCM4 down direction.";
374 enum delayTCM5-down {
377 "Delay on TCM5 down direction.";
379 enum delayTCM6-down {
382 "Delay on TCM6 down direction.";
418 grouping olm-renderer-input {
420 "Type to be used by OLM and Renderer RPCs";
428 type org-openroadm-common-types:frequency-THz;
433 type org-openroadm-common-types:frequency-GHz;
436 type org-openroadm-common-types:frequency-THz;
439 type org-openroadm-common-types:frequency-THz;
441 leaf lower-spectral-slot-number {
444 leaf higher-spectral-slot-number {
453 "Gloabally unique identifier for the node";
459 "Source termination point ";
465 "Destination termination point ";
468 list node-interface {
473 leaf-list och-interface-id {
476 leaf-list otu-interface-id {
479 leaf-list odu-interface-id {
482 leaf-list eth-interface-id {
485 leaf-list connection-id {
491 grouping otn-renderer-input {
493 "Type to be used by OLM and Renderer RPCs for OTN";
503 "Globally unique identifier for the node";
508 "Source termination point ";
513 "Destination termination point for end nodes";
519 "Destination termination point for intermediate switch";
524 grouping olm-get-pm-input {
529 "Gloabally unique identifier
533 type org-openroadm-resource-types:resource-type-enum;
536 "Type of the PM resource";
538 container resource-identifier {
543 "Identifier of particular resource of given type";
545 leaf circuit-pack-name {
546 when "../../resource-type = 'port'";
550 "In case resource type is port, then particular resource is identified by port-name
551 (resource-name) and circuit-pack-name (this leaf).";
555 type org-openroadm-pm-types:pm-granularity;
558 "Granularity of PM bin can be
559 notApplicable,15min,24Hour";
575 grouping node-interfaces {
576 list node-interface {
581 leaf-list och-interface-id {
584 leaf-list otu-interface-id {
587 leaf-list odu-interface-id {
590 leaf-list eth-interface-id {
593 leaf-list connection-id {
599 grouping otn-constraint {
600 container otn-constraints {
601 leaf trib-port-number {
604 "defines a trib-port that must be used at A or Z end";
606 leaf-list opu-trib-slots {
609 "defines a list of trib-slots that must be used at A or Z end";
611 leaf-list opucn-trib-slots {
614 "defines a list of opucn-trib-slots that must be used at A or
617 container imposed-api {
619 "defines constraints on access point identifier to be used by
620 local device when one end point of the path (service) is located
621 in a remote domain not handled by the controller. These parameters
622 are passed to the local controller (transportpce) for interoperability
624 SAPI : The source api (local domain) to be used by A
625 or Z end as expected by remote controller.
626 DAPI: defines the destination api (remote domain) to be used by A
627 or Z end as exposed in the remote domain. Used when the end of the path
628 is in an external domain, handled by a remote controller.
629 EXPECTED-SAPI : The api of the remote end of the path (in an external
630 domain) as expected to be received by A or Z end.
631 EXPECTED-DAPI : defines the destination api to be used by remote end
632 as exposed in the local domain. Used when the end of the path is in an
633 external domain, handled by a remote controller";
643 "The source api used by the node";
648 "the destination api of the other end of the path";
653 "The api of the remote end of the path as expected to be received
659 "api of the node itself, supposed to be used by remote end as