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 "Updated grouping olm-renderer-input to enable support for flex-grid";
24 "Add necessary parameters to consolidate OTN and address ONAP
25 MDONS use case, including grouping otn-renderer-input";
29 "Add grouping otn-renderer-input";
33 "Initial revision of TransportPCE common-types";
36 typedef pm-names-enum {
38 enum vendorExtension {
46 "Bit error rate (BER)";
48 enum opticalPowerOutput {
51 "Optical Power Output (OPOUT-OTS, OPOUT-OMS, OPT-OCH). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
53 enum opticalReturnLoss {
56 "Optical Return Loss (ORL-OTS) - at MW port(s) B";
58 enum opticalPowerInput {
61 "Optical Power Input (OPIN-OTS, OPIN-OMS, OPR-OCH). Total optical power";
66 "Code Violations (CV)";
71 "Errored Seconds (ES)";
73 enum severelyErroredSeconds {
76 "Severely Errored Seconds (SES)";
78 enum unavailableSeconds {
81 "Unavailable Seconds (UAS)";
86 "In frames (INFRAMES-E)";
88 enum inFramesErrored {
91 "In frames errored (INFRAMESERR-E)";
96 "Out frames (OUTFRAMES-E)";
98 enum erroredSecondsEthernet {
101 "Errored Seconds Ethernet (ES-E)";
103 enum severelyErroredSecondsEthernet {
106 "Severly Errored Seconds, Ethernet (SES-E)";
108 enum unavailableSecondsEthernet {
111 "Unavailable Seconds, Ethernet (UAS-E)";
113 enum erroredBlockCount {
116 "Errored block count";
121 "Number of frames between a DMValue toggle event and the received DMp signal value toggle event";
126 "Defect Seconds (DS)";
128 enum backwardIncomingAlignmentError {
131 "Backward Incoming Alignment Error (BIAE)";
133 enum incomingAlignmentError {
136 "Incoming Alignment Error (IAE)";
138 enum opticalPowerOutputMin {
141 "Minimum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
143 enum opticalPowerOutputMax {
146 "Maximum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
148 enum opticalPowerOutputAvg {
151 "Average Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
153 enum opticalPowerInputMin {
156 "Minimum Optical Power Input (OPIN-OTS). Total optical power";
158 enum opticalPowerInputMax {
161 "Maximum Optical Power Input (OPIN-OTS). Total optical power";
163 enum opticalPowerInputAvg {
166 "Average Optical Power Input (OPIN-OTS). Total optical power";
168 enum opticalPowerOutputOSC {
171 "OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
173 enum opticalPowerOutputOSCMin {
176 "Minimum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
178 enum opticalPowerOutputOSCMax {
181 "Maximum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
183 enum opticalPowerOutputOSCAvg {
186 "Average OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
188 enum opticalPowerInputOSC {
191 "OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
193 enum opticalPowerInputOSCMin {
196 "Minimum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
198 enum opticalPowerInputOSCMax {
201 "Maximum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
203 enum opticalPowerInputOSCAvg {
206 "Average OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
208 enum preFECCorrectedErrors {
211 "pFEC corrected Errors";
213 enum totalOpticalPowerInput {
216 "Total Optical Power Input.";
218 enum totalOpticalPowerInputMin {
221 "Minumun Total Optical Power Input.";
223 enum totalOpticalPowerInputMax {
226 "Maximum Total Optical Power Input.";
228 enum totalOpticalPowerInputAvg {
231 "Average Total Optical Power Input.";
233 enum FECCorrectableBlocks {
236 "FEC Correctable Blocks.";
238 enum FECUncorrectableBlocks {
241 "FEC Uncorrectable Blocks.";
243 enum BIPErrorCounter {
248 enum protectionSwitchingCount {
251 "Protection Switching Count (PSC)";
253 enum protectionSwitchingDuration {
256 "Protection Switching Duration in seconds (PSD)";
258 enum erroredBlockCountTCM1-up {
261 "errored Blocks Count on TCM1 up direction.";
263 enum erroredBlockCountTCM2-up {
266 "errored Blocks Count on TCM2 up direction.";
268 enum erroredBlockCountTCM3-up {
271 "errored Blocks Count on TCM3 up direction.";
273 enum erroredBlockCountTCM4-up {
276 "errored Blocks Count on TCM4 up direction.";
278 enum erroredBlockCountTCM5-up {
281 "errored Blocks Count on TCM5 up direction.";
283 enum erroredBlockCountTCM6-up {
286 "errored Blocks Count on TCM6 up direction.";
291 "Delay on TCM1 up direction.";
296 "Delay on TCM2 up direction.";
301 "Delay on TCM3 up direction.";
306 "Delay on TCM4 up direction.";
311 "Delay on TCM5 up direction.";
316 "Delay on TCM6 up direction.";
318 enum erroredBlockCountTCM1-down {
321 "errored Blocks Count on TCM1 down direction.";
323 enum erroredBlockCountTCM2-down {
326 "errored Blocks Count on TCM2 down direction.";
328 enum erroredBlockCountTCM3-down {
331 "errored Blocks Count on TCM3 down direction.";
333 enum erroredBlockCountTCM4-down {
336 "errored Blocks Count on TCM4 down direction.";
338 enum erroredBlockCountTCM5-down {
341 "errored Blocks Count on TCM5 down direction.";
343 enum erroredBlockCountTCM6-down {
346 "errored Blocks Count on TCM6 down direction.";
348 enum delayTCM1-down {
351 "Delay on TCM1 down direction.";
353 enum delayTCM2-down {
356 "Delay on TCM2 down direction.";
358 enum delayTCM3-down {
361 "Delay on TCM3 down direction.";
363 enum delayTCM4-down {
366 "Delay on TCM4 down direction.";
368 enum delayTCM5-down {
371 "Delay on TCM5 down direction.";
373 enum delayTCM6-down {
376 "Delay on TCM6 down direction.";
412 grouping olm-renderer-input {
414 "Type to be used by OLM and Renderer RPCs";
422 type org-openroadm-common-types:frequency-GHz;
425 type org-openroadm-common-types:frequency-GHz;
433 "Gloabally unique identifier for the node";
439 "Source termination point ";
445 "Destination termination point ";
448 list node-interface {
453 leaf-list och-interface-id {
456 leaf-list otu-interface-id {
459 leaf-list odu-interface-id {
462 leaf-list eth-interface-id {
465 leaf-list connection-id {
471 grouping otn-renderer-input {
473 "Type to be used by OLM and Renderer RPCs for OTN";
483 "Globally unique identifier for the node";
488 "Source termination point ";
493 "Destination termination point for end nodes";
499 "Destination termination point for intermediate switch";
504 grouping olm-get-pm-input {
509 "Gloabally unique identifier
513 type org-openroadm-resource-types:resource-type-enum;
516 "Type of the PM resource";
518 container resource-identifier {
523 "Identifier of particular resource of given type";
525 leaf circuit-pack-name {
526 when "../../resource-type = 'port'";
530 "In case resource type is port, then particular resource is identified by port-name
531 (resource-name) and circuit-pack-name (this leaf).";
535 type org-openroadm-pm-types:pm-granularity;
538 "Granularity of PM bin can be
539 notApplicable,15min,24Hour";
555 grouping node-interfaces {
556 list node-interface {
561 leaf-list och-interface-id {
564 leaf-list otu-interface-id {
567 leaf-list odu-interface-id {
570 leaf-list eth-interface-id {
573 leaf-list connection-id {
579 grouping otn-constraint {
580 container otn-constraints {
581 leaf trib-port-number {
584 "defines a trib-port that must be used at A or Z end";
586 leaf-list opu-trib-slots {
589 "defines a list of trib-slots that must be used at A or Z end";
591 leaf-list opucn-trib-slots {
594 "defines a list of opucn-trib-slots that must be used at A or
597 container imposed-api {
599 "defines constraints on access point identifier to be used by
600 local device when one end point of the path (service) is located
601 in a remote domain not handled by the controller. These parameters
602 are passed to the local controller (transportpce) for interoperability
604 SAPI : The source api (local domain) to be used by A
605 or Z end as expected by remote controller.
606 DAPI: defines the destination api (remote domain) to be used by A
607 or Z end as exposed in the remote domain. Used when the end of the path
608 is in an external domain, handled by a remote controller.
609 EXPECTED-SAPI : The api of the remote end of the path (in an external
610 domain) as expected to be received by A or Z end.
611 EXPECTED-DAPI : defines the destination api to be used by remote end
612 as exposed in the local domain. Used when the end of the path is in an
613 external domain, handled by a remote controller";
623 "The source api used by the node";
628 "the destination api of the other end of the path";
633 "The api of the remote end of the path as expected to be received
639 "api of the node itself, supposed to be used by remote end as