1 module openconfig-transport-types {
6 namespace "http://openconfig.net/yang/transport-types";
10 import openconfig-platform-types { prefix oc-platform-types; }
11 import openconfig-extensions { prefix oc-ext; }
14 organization "OpenConfig working group";
17 "OpenConfig working group
21 "This module contains general type definitions and identities
22 for optical transport models.";
24 oc-ext:openconfig-version "0.5.0";
26 revision "2017-08-16" {
28 "Added ODU Cn protocol type";
32 revision "2016-12-22" {
34 "Fixes and additions for terminal optics model";
40 typedef frequency-type {
44 "Type for optical spectrum frequency values";
47 typedef admin-state-type {
51 "Sets the channel admin state to enabled";
55 "Sets the channel admin state to disabled";
59 "Sets the channel to maintenance / diagnostic mode";
62 description "Administrative state modes for
63 logical channels in the transponder model.";
66 typedef loopback-mode-type {
70 "No loopback is applied";
74 "A loopback which directs traffic normally transmitted
75 on the port back to the device as if received on the same
76 port from an external source.";
80 "A loopback which directs traffic received from an external
81 source on the port back out the transmit side of the same
87 "Loopback modes for transponder logical channels";
90 // grouping statements
92 grouping avg-min-max-instant-stats-precision2-ps-nm {
94 "Common grouping for recording picosecond per nanometer
95 values with 2 decimal precision. Values include the
96 instantaneous, average, minimum, and maximum statistics";
104 "The instantaneous value of the statistic.";
113 "The arithmetic mean value of the statistic over the
123 "The minimum value of the statistic over the sampling
133 "The maximum value of the statistic over the sampling
138 grouping avg-min-max-instant-stats-precision2-ps {
140 "Common grouping for recording picosecond values with
141 2 decimal precision. Values include the instantaneous,
142 average, minimum, and maximum statistics";
150 "The instantaneous value of the statistic.";
159 "The arithmetic mean value of the statistic over the
169 "The minimum value of the statistic over the sampling
179 "The maximum value of the statistic over the sampling
184 grouping avg-min-max-instant-stats-precision2-ps2 {
186 "Common grouping for recording picosecond^2 values with
187 2 decimal precision. Values include the instantaneous,
188 average, minimum, and maximum statistics";
196 "The instantaneous value of the statistic.";
205 "The arithmetic mean value of the statistic over the
215 "The minimum value of the statistic over the sampling
225 "The maximum value of the statistic over the sampling
230 grouping avg-min-max-instant-stats-precision18-ber {
232 "Common grouping for recording bit error rate (BER) values
233 with 18 decimal precision. Note that decimal64 supports
234 values as small as i x 10^-18 where i is an integer. Values
235 smaller than this should be reported as 0 to inidicate error
236 free or near error free performance. Values include the
237 instantaneous, average, minimum, and maximum statistics";
243 units bit-errors-per-second;
245 "The instantaneous value of the statistic.";
252 units bit-errors-per-second;
254 "The arithmetic mean value of the statistic over the
262 units bit-errors-per-second;
264 "The minimum value of the statistic over the sampling
272 units bit-errors-per-second;
274 "The maximum value of the statistic over the sampling
279 // identity statements
281 identity TRIBUTARY_PROTOCOL_TYPE {
283 "Base identity for protocol framing used by tributary
288 base TRIBUTARY_PROTOCOL_TYPE;
289 description "1G Ethernet protocol";
293 base TRIBUTARY_PROTOCOL_TYPE;
294 description "OC48 protocol";
297 identity PROT_STM16 {
298 base TRIBUTARY_PROTOCOL_TYPE;
299 description "STM 16 protocol";
302 identity PROT_10GE_LAN {
303 base TRIBUTARY_PROTOCOL_TYPE;
304 description "10G Ethernet LAN protocol";
307 identity PROT_10GE_WAN {
308 base TRIBUTARY_PROTOCOL_TYPE;
309 description "10G Ethernet WAN protocol";
312 identity PROT_OC192 {
313 base TRIBUTARY_PROTOCOL_TYPE;
314 description "OC 192 (9.6GB) port protocol";
317 identity PROT_STM64 {
318 base TRIBUTARY_PROTOCOL_TYPE;
319 description "STM 64 protocol";
323 base TRIBUTARY_PROTOCOL_TYPE;
324 description "OTU 2 protocol";
327 identity PROT_OTU2E {
328 base TRIBUTARY_PROTOCOL_TYPE;
329 description "OTU 2e protocol";
332 identity PROT_OTU1E {
333 base TRIBUTARY_PROTOCOL_TYPE;
334 description "OTU 1e protocol";
338 base TRIBUTARY_PROTOCOL_TYPE;
339 description "ODU 2 protocol";
342 identity PROT_ODU2E {
343 base TRIBUTARY_PROTOCOL_TYPE;
344 description "ODU 2e protocol";
348 base TRIBUTARY_PROTOCOL_TYPE;
349 description "40G Ethernet port protocol";
352 identity PROT_OC768 {
353 base TRIBUTARY_PROTOCOL_TYPE;
354 description "OC 768 protocol";
357 identity PROT_STM256 {
358 base TRIBUTARY_PROTOCOL_TYPE;
359 description "STM 256 protocol";
363 base TRIBUTARY_PROTOCOL_TYPE;
364 description "OTU 3 protocol";
368 base TRIBUTARY_PROTOCOL_TYPE;
369 description "ODU 3 protocol";
372 identity PROT_100GE {
373 base TRIBUTARY_PROTOCOL_TYPE;
374 description "100G Ethernet protocol";
377 identity PROT_100G_MLG {
378 base TRIBUTARY_PROTOCOL_TYPE;
379 description "100G MLG protocol";
383 base TRIBUTARY_PROTOCOL_TYPE;
384 description "OTU4 signal protocol (112G) for transporting
388 identity PROT_OTUCN {
389 base TRIBUTARY_PROTOCOL_TYPE;
390 description "OTU Cn protocol";
393 identity PROT_ODUCN {
394 base TRIBUTARY_PROTOCOL_TYPE;
395 description "ODU Cn protocol";
399 base TRIBUTARY_PROTOCOL_TYPE;
400 description "ODU 4 protocol";
403 identity TRANSCEIVER_FORM_FACTOR_TYPE {
405 "Base identity for identifying the type of pluggable optic
406 transceiver (i.e,. form factor) used in a port.";
410 base TRANSCEIVER_FORM_FACTOR_TYPE;
412 "C form-factor pluggable, that can support up to a
413 100 Gb/s signal with 10x10G or 4x25G physical channels";
417 base TRANSCEIVER_FORM_FACTOR_TYPE;
419 "1/2 C form-factor pluggable, that can support up to a
420 200 Gb/s signal with 10x10G, 4x25G, or 8x25G physical
425 base TRANSCEIVER_FORM_FACTOR_TYPE;
427 "CFP2 analog coherent optics transceiver, supporting
428 100 Gb, 200Gb, and 250 Gb/s signal.";
432 base TRANSCEIVER_FORM_FACTOR_TYPE;
434 "1/4 C form-factor pluggable, that can support up to a
435 100 Gb/s signal with 10x10G or 4x25G physical channels";
439 base TRANSCEIVER_FORM_FACTOR_TYPE;
441 "OriginalQuad Small Form-factor Pluggable transceiver that can
442 support 4x1G physical channels. Not commonly used.";
446 base TRANSCEIVER_FORM_FACTOR_TYPE;
448 "Quad Small Form-factor Pluggable transceiver that can support
449 up to 4x10G physical channels.";
453 base TRANSCEIVER_FORM_FACTOR_TYPE;
455 "QSFP pluggable optic with support for up to 4x28G physical
460 base TRANSCEIVER_FORM_FACTOR_TYPE;
462 "Cisco CPAK transceiver supporting 100 Gb/s.";
466 base TRANSCEIVER_FORM_FACTOR_TYPE;
468 "Small form-factor pluggable transceiver supporting up to
473 base TRANSCEIVER_FORM_FACTOR_TYPE;
475 "Enhanced small form-factor pluggable transceiver supporting
476 up to 16 Gb/s signals, including 10 GbE and OTU2";
480 base TRANSCEIVER_FORM_FACTOR_TYPE;
482 "10 Gigabit small form factor pluggable transceiver supporting
487 base TRANSCEIVER_FORM_FACTOR_TYPE;
489 "10 Gigabit small form factor pluggable transceiver supporting
490 10 GbE using a XAUI inerface and 4 data channels.";
493 identity NON_PLUGGABLE {
494 base TRANSCEIVER_FORM_FACTOR_TYPE;
496 "Represents a port that does not require a pluggable optic,
497 e.g., with on-board optics like COBO";
501 base TRANSCEIVER_FORM_FACTOR_TYPE;
503 "Represents a transceiver form factor not otherwise listed";
506 identity FIBER_CONNECTOR_TYPE {
508 "Type of optical fiber connector";
511 identity SC_CONNECTOR {
512 base FIBER_CONNECTOR_TYPE;
514 "SC type fiber connector";
517 identity LC_CONNECTOR {
518 base FIBER_CONNECTOR_TYPE;
520 "LC type fiber connector";
523 identity MPO_CONNECTOR {
524 base FIBER_CONNECTOR_TYPE;
526 "MPO (multi-fiber push-on/pull-off) type fiber connector
530 identity ETHERNET_PMD_TYPE {
532 "Ethernet compliance codes (PMD) supported by transceivers";
535 identity ETH_10GBASE_LRM {
536 base ETHERNET_PMD_TYPE;
537 description "Ethernet compliance code: 10GBASE_LRM";
540 identity ETH_10GBASE_LR {
541 base ETHERNET_PMD_TYPE;
542 description "Ethernet compliance code: 10GBASE_LR";
545 identity ETH_10GBASE_ZR {
546 base ETHERNET_PMD_TYPE;
547 description "Ethernet compliance code: 10GBASE_ZR";
550 identity ETH_10GBASE_ER {
551 base ETHERNET_PMD_TYPE;
552 description "Ethernet compliance code: 10GBASE_ER";
555 identity ETH_10GBASE_SR {
556 base ETHERNET_PMD_TYPE;
557 description "Ethernet compliance code: 10GBASE_SR";
560 identity ETH_40GBASE_CR4 {
561 base ETHERNET_PMD_TYPE;
562 description "Ethernet compliance code: 40GBASE_CR4";
565 identity ETH_40GBASE_SR4 {
566 base ETHERNET_PMD_TYPE;
567 description "Ethernet compliance code: 40GBASE_SR4";
570 identity ETH_40GBASE_LR4 {
571 base ETHERNET_PMD_TYPE;
572 description "Ethernet compliance code: 40GBASE_LR4";
575 identity ETH_40GBASE_ER4 {
576 base ETHERNET_PMD_TYPE;
577 description "Ethernet compliance code: 40GBASE_ER4";
580 identity ETH_40GBASE_PSM4 {
581 base ETHERNET_PMD_TYPE;
582 description "Ethernet compliance code: 40GBASE_PSM4";
585 identity ETH_4X10GBASE_LR {
586 base ETHERNET_PMD_TYPE;
587 description "Ethernet compliance code: 4x10GBASE_LR";
590 identity ETH_4X10GBASE_SR {
591 base ETHERNET_PMD_TYPE;
592 description "Ethernet compliance code: 4x10GBASE_SR";
595 identity ETH_100G_AOC {
596 base ETHERNET_PMD_TYPE;
597 description "Ethernet compliance code: 100G_AOC";
600 identity ETH_100G_ACC {
601 base ETHERNET_PMD_TYPE;
602 description "Ethernet compliance code: 100G_ACC";
605 identity ETH_100GBASE_SR10 {
606 base ETHERNET_PMD_TYPE;
607 description "Ethernet compliance code: 100GBASE_SR10";
610 identity ETH_100GBASE_SR4 {
611 base ETHERNET_PMD_TYPE;
612 description "Ethernet compliance code: 100GBASE_SR4";
615 identity ETH_100GBASE_LR4 {
616 base ETHERNET_PMD_TYPE;
617 description "Ethernet compliance code: 100GBASE_LR4";
620 identity ETH_100GBASE_ER4 {
621 base ETHERNET_PMD_TYPE;
622 description "Ethernet compliance code: 100GBASE_ER4";
625 identity ETH_100GBASE_CWDM4 {
626 base ETHERNET_PMD_TYPE;
627 description "Ethernet compliance code: 100GBASE_CWDM4";
630 identity ETH_100GBASE_CLR4 {
631 base ETHERNET_PMD_TYPE;
632 description "Ethernet compliance code: 100GBASE_CLR4";
635 identity ETH_100GBASE_PSM4 {
636 base ETHERNET_PMD_TYPE;
637 description "Ethernet compliance code: 100GBASE_PSM4";
640 identity ETH_100GBASE_CR4 {
641 base ETHERNET_PMD_TYPE;
642 description "Ethernet compliance code: 100GBASE_CR4";
645 identity ETH_UNDEFINED {
646 base ETHERNET_PMD_TYPE;
647 description "Ethernet compliance code: undefined";
650 identity SONET_APPLICATION_CODE {
652 "Supported SONET/SDH application codes";
655 identity VSR2000_3R2 {
656 base SONET_APPLICATION_CODE;
658 "SONET/SDH application code: VSR2000_3R2";
661 identity VSR2000_3R3 {
662 base SONET_APPLICATION_CODE;
664 "SONET/SDH application code: VSR2000_3R3";
667 identity VSR2000_3R5 {
668 base SONET_APPLICATION_CODE;
670 "SONET/SDH application code: VSR2000_3R5";
673 identity SONET_UNDEFINED {
674 base SONET_APPLICATION_CODE;
676 "SONET/SDH application code: undefined";
679 identity OTN_APPLICATION_CODE {
681 "Supported OTN application codes";
685 base OTN_APPLICATION_CODE;
687 "OTN application code: P1L1_2D1";
691 base OTN_APPLICATION_CODE;
693 "OTN application code: P1S1_2D2";
697 base OTN_APPLICATION_CODE;
699 "OTN application code: P1L1_2D2";
702 identity OTN_UNDEFINED {
703 base OTN_APPLICATION_CODE;
705 "OTN application code: undefined";
708 identity TRIBUTARY_RATE_CLASS_TYPE {
710 "Rate of tributary signal _- identities will typically reflect
714 identity TRIB_RATE_1G {
715 base TRIBUTARY_RATE_CLASS_TYPE;
717 "1G tributary signal rate";
720 identity TRIB_RATE_2.5G {
721 base TRIBUTARY_RATE_CLASS_TYPE;
723 "2.5G tributary signal rate";
726 identity TRIB_RATE_10G {
727 base TRIBUTARY_RATE_CLASS_TYPE;
729 "10G tributary signal rate";
732 identity TRIB_RATE_40G {
733 base TRIBUTARY_RATE_CLASS_TYPE;
735 "40G tributary signal rate";
738 identity TRIB_RATE_100G {
739 base TRIBUTARY_RATE_CLASS_TYPE;
741 "100G tributary signal rate";
744 identity TRIB_RATE_150G {
745 base TRIBUTARY_RATE_CLASS_TYPE;
747 "150G tributary signal rate";
750 identity TRIB_RATE_200G {
751 base TRIBUTARY_RATE_CLASS_TYPE;
753 "200G tributary signal rate";
756 identity TRIB_RATE_250G {
757 base TRIBUTARY_RATE_CLASS_TYPE;
759 "250G tributary signal rate";
762 identity TRIB_RATE_300G {
763 base TRIBUTARY_RATE_CLASS_TYPE;
765 "300G tributary signal rate";
768 identity TRIB_RATE_400G {
769 base TRIBUTARY_RATE_CLASS_TYPE;
771 "400G tributary signal rate";
774 identity LOGICAL_ELEMENT_PROTOCOL_TYPE {
776 "Type of protocol framing used on the logical channel or
780 identity PROT_ETHERNET {
781 base LOGICAL_ELEMENT_PROTOCOL_TYPE;
783 "Ethernet protocol framing";
787 base LOGICAL_ELEMENT_PROTOCOL_TYPE;
789 "OTN protocol framing";
792 identity OPTICAL_CHANNEL {
793 base oc-platform-types:OPENCONFIG_HARDWARE_COMPONENT;
795 "Optical channels act as carriers for transport traffic
796 directed over a line system. They are represented as
797 physical components in the physical inventory model.";