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-common-types {
10 prefix org-openroadm-common-types;
11 revision-date 2018-10-19;
13 import org-openroadm-common-link-types {
14 prefix org-openroadm-common-link-types;
16 import org-openroadm-common-optical-channel-types {
17 prefix org-openroadm-common-optical-channel-types;
19 import org-openroadm-otn-common-types {
20 prefix org-openroadm-otn-common-types;
25 "add pm-granularity from org-openroadm-pm-types";
29 "Replace leaf width in optical-renderer-input by mc-width and nmc-width";
33 "Replace olm-renderer-input by optical-rendrer-input.
34 Create optical-renderer-nodes and otn-renderer-nodes groupings";
38 "Update grouping olm-renderer-input, adding min, max frequencies
39 lower spectral slot number and higher spectral slot number
40 fix center-freq unit";
44 "Updated grouping olm-renderer-input to enable support for flex-grid";
48 "Add necessary parameters to consolidate OTN and address ONAP
49 MDONS use case, including grouping otn-renderer-input";
53 "Add grouping otn-renderer-input";
57 "Initial revision of TransportPCE common-types";
60 typedef pm-names-enum {
62 enum vendorExtension {
70 "Bit error rate (BER)";
72 enum opticalPowerOutput {
75 "Optical Power Output (OPOUT-OTS, OPOUT-OMS, OPT-OCH). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
77 enum opticalReturnLoss {
80 "Optical Return Loss (ORL-OTS) - at MW port(s) B";
82 enum opticalPowerInput {
85 "Optical Power Input (OPIN-OTS, OPIN-OMS, OPR-OCH). Total optical power";
90 "Code Violations (CV)";
95 "Errored Seconds (ES)";
97 enum severelyErroredSeconds {
100 "Severely Errored Seconds (SES)";
102 enum unavailableSeconds {
105 "Unavailable Seconds (UAS)";
110 "In frames (INFRAMES-E)";
112 enum inFramesErrored {
115 "In frames errored (INFRAMESERR-E)";
120 "Out frames (OUTFRAMES-E)";
122 enum erroredSecondsEthernet {
125 "Errored Seconds Ethernet (ES-E)";
127 enum severelyErroredSecondsEthernet {
130 "Severly Errored Seconds, Ethernet (SES-E)";
132 enum unavailableSecondsEthernet {
135 "Unavailable Seconds, Ethernet (UAS-E)";
137 enum erroredBlockCount {
140 "Errored block count";
145 "Number of frames between a DMValue toggle event and the received DMp signal value toggle event";
150 "Defect Seconds (DS)";
152 enum backwardIncomingAlignmentError {
155 "Backward Incoming Alignment Error (BIAE)";
157 enum incomingAlignmentError {
160 "Incoming Alignment Error (IAE)";
162 enum opticalPowerOutputMin {
165 "Minimum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
167 enum opticalPowerOutputMax {
170 "Maximum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
172 enum opticalPowerOutputAvg {
175 "Average Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
177 enum opticalPowerInputMin {
180 "Minimum Optical Power Input (OPIN-OTS). Total optical power";
182 enum opticalPowerInputMax {
185 "Maximum Optical Power Input (OPIN-OTS). Total optical power";
187 enum opticalPowerInputAvg {
190 "Average Optical Power Input (OPIN-OTS). Total optical power";
192 enum opticalPowerOutputOSC {
195 "OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
197 enum opticalPowerOutputOSCMin {
200 "Minimum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
202 enum opticalPowerOutputOSCMax {
205 "Maximum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
207 enum opticalPowerOutputOSCAvg {
210 "Average OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
212 enum opticalPowerInputOSC {
215 "OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
217 enum opticalPowerInputOSCMin {
220 "Minimum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
222 enum opticalPowerInputOSCMax {
225 "Maximum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
227 enum opticalPowerInputOSCAvg {
230 "Average OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
232 enum preFECCorrectedErrors {
235 "pFEC corrected Errors";
237 enum totalOpticalPowerInput {
240 "Total Optical Power Input.";
242 enum totalOpticalPowerInputMin {
245 "Minumun Total Optical Power Input.";
247 enum totalOpticalPowerInputMax {
250 "Maximum Total Optical Power Input.";
252 enum totalOpticalPowerInputAvg {
255 "Average Total Optical Power Input.";
257 enum FECCorrectableBlocks {
260 "FEC Correctable Blocks.";
262 enum FECUncorrectableBlocks {
265 "FEC Uncorrectable Blocks.";
267 enum BIPErrorCounter {
272 enum protectionSwitchingCount {
275 "Protection Switching Count (PSC)";
277 enum protectionSwitchingDuration {
280 "Protection Switching Duration in seconds (PSD)";
282 enum erroredBlockCountTCM1-up {
285 "errored Blocks Count on TCM1 up direction.";
287 enum erroredBlockCountTCM2-up {
290 "errored Blocks Count on TCM2 up direction.";
292 enum erroredBlockCountTCM3-up {
295 "errored Blocks Count on TCM3 up direction.";
297 enum erroredBlockCountTCM4-up {
300 "errored Blocks Count on TCM4 up direction.";
302 enum erroredBlockCountTCM5-up {
305 "errored Blocks Count on TCM5 up direction.";
307 enum erroredBlockCountTCM6-up {
310 "errored Blocks Count on TCM6 up direction.";
315 "Delay on TCM1 up direction.";
320 "Delay on TCM2 up direction.";
325 "Delay on TCM3 up direction.";
330 "Delay on TCM4 up direction.";
335 "Delay on TCM5 up direction.";
340 "Delay on TCM6 up direction.";
342 enum erroredBlockCountTCM1-down {
345 "errored Blocks Count on TCM1 down direction.";
347 enum erroredBlockCountTCM2-down {
350 "errored Blocks Count on TCM2 down direction.";
352 enum erroredBlockCountTCM3-down {
355 "errored Blocks Count on TCM3 down direction.";
357 enum erroredBlockCountTCM4-down {
360 "errored Blocks Count on TCM4 down direction.";
362 enum erroredBlockCountTCM5-down {
365 "errored Blocks Count on TCM5 down direction.";
367 enum erroredBlockCountTCM6-down {
370 "errored Blocks Count on TCM6 down direction.";
372 enum delayTCM1-down {
375 "Delay on TCM1 down direction.";
377 enum delayTCM2-down {
380 "Delay on TCM2 down direction.";
382 enum delayTCM3-down {
385 "Delay on TCM3 down direction.";
387 enum delayTCM4-down {
390 "Delay on TCM4 down direction.";
392 enum delayTCM5-down {
395 "Delay on TCM5 down direction.";
397 enum delayTCM6-down {
400 "Delay on TCM6 down direction.";
436 typedef pm-granularity {
438 "Granularity of PM bin";
440 enum "notApplicable" {
442 "This is for total statistic counters on devices that support
466 grouping optical-renderer-nodes {
473 "Gloabally unique identifier for the node";
479 "Source termination point ";
485 "Destination termination point ";
490 grouping otn-renderer-nodes {
497 "Globally unique identifier for the node";
502 "Source termination point ";
507 "Destination termination point for end nodes";
512 "Destination termination point for intermediate switch";
517 grouping optical-renderer-input {
519 "Type to be used by OLM and Renderer RPCs";
527 type org-openroadm-common-types:frequency-THz;
531 " Width of network media channel nmc";
532 type org-openroadm-common-types:frequency-GHz;
536 " Width of media channel (mc)";
537 type org-openroadm-common-types:frequency-GHz;
540 type org-openroadm-common-types:frequency-THz;
543 type org-openroadm-common-types:frequency-THz;
545 leaf lower-spectral-slot-number {
548 leaf higher-spectral-slot-number {
551 uses optical-renderer-nodes;
552 uses node-interfaces;
555 grouping otn-renderer-input {
557 "Type to be used by OLM and Renderer RPCs for OTN";
561 uses otn-renderer-nodes;
564 grouping olm-get-pm-input {
569 "Gloabally unique identifier
573 type org-openroadm-resource-types:resource-type-enum;
576 "Type of the PM resource";
578 container resource-identifier {
583 "Identifier of particular resource of given type";
585 leaf circuit-pack-name {
586 when "../../resource-type = 'port'";
590 "In case resource type is port, then particular resource is identified by port-name
591 (resource-name) and circuit-pack-name (this leaf).";
598 "Granularity of PM bin can be
599 notApplicable,15min,24Hour";
615 grouping node-interfaces {
616 list node-interface {
621 leaf-list och-interface-id {
624 leaf-list otu-interface-id {
627 leaf-list odu-interface-id {
630 leaf-list eth-interface-id {
633 leaf-list connection-id {
639 grouping otn-constraint {
640 container otn-constraints {
641 leaf trib-port-number {
644 "defines a trib-port that must be used at A or Z end";
646 leaf-list opu-trib-slots {
649 "defines a list of trib-slots that must be used at A or Z end";
651 leaf-list opucn-trib-slots {
654 "defines a list of opucn-trib-slots that must be used at A or
657 container imposed-api {
659 "defines constraints on access point identifier to be used by
660 local device when one end point of the path (service) is located
661 in a remote domain not handled by the controller. These parameters
662 are passed to the local controller (transportpce) for interoperability
664 SAPI : The source api (local domain) to be used by A
665 or Z end as expected by remote controller.
666 DAPI: defines the destination api (remote domain) to be used by A
667 or Z end as exposed in the remote domain. Used when the end of the path
668 is in an external domain, handled by a remote controller.
669 EXPECTED-SAPI : The api of the remote end of the path (in an external
670 domain) as expected to be received by A or Z end.
671 EXPECTED-DAPI : defines the destination api to be used by remote end
672 as exposed in the local domain. Used when the end of the path is in an
673 external domain, handled by a remote controller";
683 "The source api used by the node";
688 "the destination api of the other end of the path";
693 "The api of the remote end of the path as expected to be received
699 "api of the node itself, supposed to be used by remote end as
704 grouping service-result-rpc-common-parameters {
705 leaf central-frequency {
706 type org-openroadm-common-optical-channel-types:frequency-THz;
708 "Assigned central-frquency in THz";
711 type org-openroadm-common-optical-channel-types:frequency-GHz;
713 "Assigned frequency width (transponder/NMC)";
715 leaf optical-operational-mode {
718 "Operation mode ID selected by the PCE";
720 leaf rx-estimated-osnr {
721 type org-openroadm-common-link-types:ratio-dB;
723 "Estimated OSNR for the path";
725 leaf rx-estimated-gsnr {
726 type org-openroadm-common-link-types:ratio-dB;
728 "Estimated Generalized SNR (including non linear impairments) for the path";
730 leaf max-output-power {
731 type org-openroadm-common-link-types:ratio-dB;
733 "Maximum output-power";
735 leaf min-output-power {
736 type org-openroadm-common-link-types:ratio-dB;
738 "Minimum output-power";
741 type org-openroadm-otn-common-types:opucn-trib-slot-def;
743 "Minimum trib slots in the form of 'A.B',
744 where A and B correspond to port-number and trib-slots respectively";
747 type org-openroadm-otn-common-types:opucn-trib-slot-def;
749 "Maximum trib slots in the form of 'A.B',
750 where A and B correspond to port-number and trib-slots respectively";
756 leaf modulation-format {