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-otn-common-types {
14 prefix org-openroadm-otn-common-types;
15 revision-date 2018-11-30;
18 revision "2020-01-28" {
19 description "Add necessary parameters to consolidate OTN and address ONAP
20 MDONS use case, including grouping otn-renderer-input";
22 revision "2019-12-12" {
23 description "Add grouping otn-renderer-input";
26 revision "2017-09-07" {
27 description "Initial revision of TransportPCE common-types";
30 grouping olm-renderer-input {
42 description "Gloabally unique identifier for the node";
46 description "Source termination point ";
51 description "Destination termination point ";
56 "Type to be used by OLM and Renderer RPCs";
62 leaf-list och-interface-id {
65 leaf-list otu-interface-id {
68 leaf-list odu-interface-id {
71 leaf-list eth-interface-id {
74 leaf-list connection-id {
81 grouping otn-renderer-input {
90 description "Globally unique identifier for the node";
94 description "Source termination point ";
98 description "Destination termination point for end nodes";
103 description "Destination termination point for intermediate switch";
106 description "Type to be used by OLM and Renderer RPCs for OTN";
109 grouping olm-get-pm-input {
112 description "Gloabally unique identifier
117 type org-openroadm-resource-types:resource-type-enum;
118 description "Type of the PM resource";
121 container resource-identifier {
124 description "Identifier of particular resource of given type";
127 leaf circuit-pack-name {
128 when "../../resource-type = 'port'";
130 description "In case resource type is port, then particular resource is identified by port-name
131 (resource-name) and circuit-pack-name (this leaf).";
137 type org-openroadm-pm-types:pm-granularity;
138 description "Granularity of PM bin can be
139 notApplicable,15min,24Hour";
156 grouping node-interfaces {
157 list node-interface {
162 leaf-list och-interface-id {
165 leaf-list otu-interface-id {
168 leaf-list odu-interface-id {
171 leaf-list eth-interface-id {
174 leaf-list connection-id {
180 grouping otn-constraint {
181 container otn-constraints {
182 leaf trib-port-number {
185 "defines a trib-port that must be used at A or Z end";
187 leaf-list opu-trib-slots {
190 "defines a list of trib-slots that must be used at A or Z end";
192 leaf-list opucn-trib-slots {
195 "defines a list of opucn-trib-slots that must be used at A or
198 container imposed-api {
199 description "defines constraints on access point identifier to be used by
200 local device when one end point of the path (service) is located
201 in a remote domain not handled by the controller. These parameters
202 are passed to the local controller (transportpce) for interoperability
204 SAPI : The source api (local domain) to be used by A
205 or Z end as expected by remote controller.
206 DAPI: defines the destination api (remote domain) to be used by A
207 or Z end as exposed in the remote domain. Used when the end of the path
208 is in an external domain, handled by a remote controller.
209 EXPECTED-SAPI : The api of the remote end of the path (in an external
210 domain) as expected to be received by A or Z end.
211 EXPECTED-DAPI : defines the destination api to be used by remote end
212 as exposed in the local domain. Used when the end of the path is in an
213 external domain, handled by a remote controller";
223 "The source api used by the node";
228 "the destination api of the other end of the path";
233 "The api of the remote end of the path as expected to be received
239 "api of the node itself, supposed to be used by remote end as
244 typedef pm-names-enum {
246 enum "vendorExtension" {
251 enum "bitErrorRate" {
254 "Bit error rate (BER)";
256 enum "opticalPowerOutput" {
259 "Optical Power Output (OPOUT-OTS, OPOUT-OMS, OPT-OCH). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
261 enum "opticalReturnLoss" {
264 "Optical Return Loss (ORL-OTS) - at MW port(s) B";
266 enum "opticalPowerInput" {
269 "Optical Power Input (OPIN-OTS, OPIN-OMS, OPR-OCH). Total optical power";
271 enum "codeViolations" {
274 "Code Violations (CV)";
276 enum "erroredSeconds" {
279 "Errored Seconds (ES)";
281 enum "severelyErroredSeconds" {
284 "Severely Errored Seconds (SES)";
286 enum "unavailableSeconds" {
289 "Unavailable Seconds (UAS)";
294 "In frames (INFRAMES-E)";
296 enum "inFramesErrored" {
299 "In frames errored (INFRAMESERR-E)";
304 "Out frames (OUTFRAMES-E)";
306 enum "erroredSecondsEthernet" {
309 "Errored Seconds Ethernet (ES-E)";
311 enum "severelyErroredSecondsEthernet" {
314 "Severly Errored Seconds, Ethernet (SES-E)";
316 enum "unavailableSecondsEthernet" {
319 "Unavailable Seconds, Ethernet (UAS-E)";
321 enum "erroredBlockCount" {
324 "Errored block count";
329 "Number of frames between a DMValue toggle event and the received DMp signal value toggle event";
331 enum "defectSeconds" {
334 "Defect Seconds (DS)";
336 enum "backwardIncomingAlignmentError" {
339 "Backward Incoming Alignment Error (BIAE)";
341 enum "incomingAlignmentError" {
344 "Incoming Alignment Error (IAE)";
346 enum "opticalPowerOutputMin" {
349 "Minimum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
351 enum "opticalPowerOutputMax" {
354 "Maximum Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
356 enum "opticalPowerOutputAvg" {
359 "Average Optical Power Output (OPOUT-OTS). Total optical power includes Variable Optical Attenuator (VOA) attenuation";
361 enum "opticalPowerInputMin" {
364 "Minimum Optical Power Input (OPIN-OTS). Total optical power";
366 enum "opticalPowerInputMax" {
369 "Maximum Optical Power Input (OPIN-OTS). Total optical power";
371 enum "opticalPowerInputAvg" {
374 "Average Optical Power Input (OPIN-OTS). Total optical power";
376 enum "opticalPowerOutputOSC" {
379 "OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
381 enum "opticalPowerOutputOSCMin" {
384 "Minimum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
386 enum "opticalPowerOutputOSCMax" {
389 "Maximum OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
391 enum "opticalPowerOutputOSCAvg" {
394 "Average OSC Optical Power Output (OPT-OSC). OSC Transmit power on MW port";
396 enum "opticalPowerInputOSC" {
399 "OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
401 enum "opticalPowerInputOSCMin" {
404 "Minimum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
406 enum "opticalPowerInputOSCMax" {
409 "Maximum OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
411 enum "opticalPowerInputOSCAvg" {
414 "Average OSC Optical Power Input (OPR-OSC). OSC Receive power on MW port";
416 enum "preFECCorrectedErrors" {
419 "pFEC corrected Errors";
421 enum "totalOpticalPowerInput" {
424 "Total Optical Power Input.";
426 enum "totalOpticalPowerInputMin" {
429 "Minumun Total Optical Power Input.";
431 enum "totalOpticalPowerInputMax" {
434 "Maximum Total Optical Power Input.";
436 enum "totalOpticalPowerInputAvg" {
439 "Average Total Optical Power Input.";
441 enum "FECCorrectableBlocks" {
444 "FEC Correctable Blocks.";
446 enum "FECUncorrectableBlocks" {
449 "FEC Uncorrectable Blocks.";
451 enum "BIPErrorCounter" {
456 enum "protectionSwitchingCount" {
459 "Protection Switching Count (PSC)";
461 enum "protectionSwitchingDuration" {
464 "Protection Switching Duration in seconds (PSD)";
466 enum "erroredBlockCountTCM1-up" {
469 "errored Blocks Count on TCM1 up direction.";
471 enum "erroredBlockCountTCM2-up" {
474 "errored Blocks Count on TCM2 up direction.";
476 enum "erroredBlockCountTCM3-up" {
479 "errored Blocks Count on TCM3 up direction.";
481 enum "erroredBlockCountTCM4-up" {
484 "errored Blocks Count on TCM4 up direction.";
486 enum "erroredBlockCountTCM5-up" {
489 "errored Blocks Count on TCM5 up direction.";
491 enum "erroredBlockCountTCM6-up" {
494 "errored Blocks Count on TCM6 up direction.";
496 enum "delayTCM1-up" {
499 "Delay on TCM1 up direction.";
501 enum "delayTCM2-up" {
504 "Delay on TCM2 up direction.";
506 enum "delayTCM3-up" {
509 "Delay on TCM3 up direction.";
511 enum "delayTCM4-up" {
514 "Delay on TCM4 up direction.";
516 enum "delayTCM5-up" {
519 "Delay on TCM5 up direction.";
521 enum "delayTCM6-up" {
524 "Delay on TCM6 up direction.";
526 enum "erroredBlockCountTCM1-down" {
529 "errored Blocks Count on TCM1 down direction.";
531 enum "erroredBlockCountTCM2-down" {
534 "errored Blocks Count on TCM2 down direction.";
536 enum "erroredBlockCountTCM3-down" {
539 "errored Blocks Count on TCM3 down direction.";
541 enum "erroredBlockCountTCM4-down" {
544 "errored Blocks Count on TCM4 down direction.";
546 enum "erroredBlockCountTCM5-down" {
549 "errored Blocks Count on TCM5 down direction.";
551 enum "erroredBlockCountTCM6-down" {
554 "errored Blocks Count on TCM6 down direction.";
556 enum "delayTCM1-down" {
559 "Delay on TCM1 down direction.";
561 enum "delayTCM2-down" {
564 "Delay on TCM2 down direction.";
566 enum "delayTCM3-down" {
569 "Delay on TCM3 down direction.";
571 enum "delayTCM4-down" {
574 "Delay on TCM4 down direction.";
576 enum "delayTCM5-down" {
579 "Delay on TCM5 down direction.";
581 enum "delayTCM6-down" {
584 "Delay on TCM6 down direction.";
591 enum "notApplicable" {
610 enum "bidirectional" {
613 enum "notApplicable" {