openconfig-transport-types

openconfig-version: 0.17.1

Description

This module contains general type definitions and identities for optical transport models.

Imports

openconfig-platform-types
openconfig-extensions
openconfig-types

Defined types

frequency-type

description:
Type for optical spectrum frequency values

type: uint64

units: MHz

admin-state-type

description:
Administrative state modes for logical channels in the transponder model.

type: enumeration

  • ENABLED
    Sets the channel admin state to enabled
  • DISABLED
    Sets the channel admin state to disabled
  • MAINT
    Sets the channel to maintenance / diagnostic mode

loopback-mode-type

description:
Loopback modes for transponder logical channels

type: enumeration

  • NONE
    No loopback is applied
  • FACILITY
    A loopback which directs traffic normally transmitted on the port back to the device as if received on the same port from an external source.
  • TERMINAL
    A loopback which directs traffic received from an external source on the port back out the transmit side of the same port.

default: NONE

Identities

base: FRAME_MAPPING_PROTOCOL

description:
Base identity for frame mapping protocols that can be used when mapping Ethernet, OTN or other client signals to OTN logical channels.

AMP

description:
Asynchronous Mapping Procedure

base identity: FRAME_MAPPING_PROTOCOL

GMP

description:
Generic Mapping Procedure

base identity: FRAME_MAPPING_PROTOCOL

BMP

description:
Bit-synchronous Mapping Procedure

base identity: FRAME_MAPPING_PROTOCOL

CBR

description:
Constant Bit Rate Mapping Procedure

base identity: FRAME_MAPPING_PROTOCOL

GFP_T

description:
Transparent Generic Framing Protocol

base identity: FRAME_MAPPING_PROTOCOL

GFP_F

description:
Framed-Mapped Generic Framing Protocol

base identity: FRAME_MAPPING_PROTOCOL

base: TRIBUTARY_SLOT_GRANULARITY

description:
Base identity for tributary slot granularity for OTN logical channels.

TRIB_SLOT_1.25G

description:
The tributary slot with a bandwidth of approximately 1.25 Gb/s as defined in ITU-T G.709 standard.

base identity: TRIBUTARY_SLOT_GRANULARITY

TRIB_SLOT_2.5G

description:
The tributary slot with a bandwidth of approximately 2.5 Gb/s as defined in ITU-T G.709 standard.

base identity: TRIBUTARY_SLOT_GRANULARITY

TRIB_SLOT_5G

description:
The tributary slot with a bandwidth of approximately 5 Gb/s as defined in ITU-T G.709 standard.

base identity: TRIBUTARY_SLOT_GRANULARITY

base: TRIBUTARY_PROTOCOL_TYPE

description:
Base identity for protocol framing used by tributary signals.

PROT_1GE

description:
1G Ethernet protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_OC48

description:
OC48 protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_STM16

description:
STM 16 protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_10GE_LAN

description:
10G Ethernet LAN protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_10GE_WAN

description:
10G Ethernet WAN protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_OC192

description:
OC 192 (9.6GB) port protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_STM64

description:
STM 64 protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_OTU2

description:
OTU 2 protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_OTU2E

description:
OTU 2e protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_OTU1E

description:
OTU 1e protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_ODU2

description:
ODU 2 protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_ODU2E

description:
ODU 2e protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_40GE

description:
40G Ethernet port protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_OC768

description:
OC 768 protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_STM256

description:
STM 256 protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_OTU3

description:
OTU 3 protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_ODU3

description:
ODU 3 protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_100GE

description:
100G Ethernet protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_100G_MLG

description:
100G MLG protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_OTU4

description:
OTU4 signal protocol (112G) for transporting 100GE signal

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_OTUCN

description:
OTU Cn protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_ODUCN

description:
ODU Cn protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_ODU4

description:
ODU 4 protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_400GE

description:
400G Ethernet protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_OTSIG

description:
Optical tributary signal group protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_ODUFLEX_CBR

description:
ODU Flex with CBR protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

PROT_ODUFLEX_GFP

description:
ODU Flex with GFP protocol

base identity: TRIBUTARY_PROTOCOL_TYPE

base: TRANSCEIVER_FORM_FACTOR_TYPE

description:
Base identity for identifying the type of pluggable optic transceiver (i.e,. form factor) used in a port.

CFP

description:
C form-factor pluggable, that can support up to a 100 Gb/s signal with 10x10G or 4x25G physical channels

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

CFP2

description:
1/2 C form-factor pluggable, that can support up to a 200 Gb/s signal with 10x10G, 4x25G, or 8x25G physical channels

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

CFP2_ACO

description:
CFP2 analog coherent optics transceiver, supporting 100 Gb, 200Gb, and 250 Gb/s signal.

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

CFP4

description:
1/4 C form-factor pluggable, that can support up to a 100 Gb/s signal with 10x10G or 4x25G physical channels

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

QSFP

description:
OriginalQuad Small Form-factor Pluggable transceiver that can support 4x1G physical channels. Not commonly used.

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

QSFP_PLUS

description:
Quad Small Form-factor Pluggable transceiver that can support up to 4x10G physical channels.

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

QSFP28

description:
QSFP pluggable optic with support for up to 4x28G physical channels

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

QSFP56_DD_TYPE1

description:
QSFP DD pluggable optic with support for up to 8x56G physical channels. Type 1 uses eight optical and electrical signals.

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

QSFP56_DD_TYPE2

description:
QSFP DD pluggable optic with support for up to 4x112G physical channels. Type 2 uses four optical and eight electrical signals.

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

CPAK

description:
Cisco CPAK transceiver supporting 100 Gb/s.

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

SFP

description:
Small form-factor pluggable transceiver supporting up to 10 Gb/s signal

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

SFP_PLUS

description:
Enhanced small form-factor pluggable transceiver supporting up to 16 Gb/s signals, including 10 GbE and OTU2

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

SFP28

description:
Small form-factor pluggable transceiver supporting up to 25 Gb/s signal

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

SFP56

description:
Small form-factor pluggable transceiver supporting up to 50 Gb/s signal

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

XFP

description:
10 Gigabit small form factor pluggable transceiver supporting 10 GbE and OTU2

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

X2

description:
10 Gigabit small form factor pluggable transceiver supporting 10 GbE using a XAUI inerface and 4 data channels.

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

OSFP

description:
Octal small form factor pluggable transceiver supporting 400 Gb/s.

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

NON_PLUGGABLE

description:
Represents a port that does not require a pluggable optic, e.g., with on-board optics like COBO

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

OTHER

description:
Represents a transceiver form factor not otherwise listed

base identity: TRANSCEIVER_FORM_FACTOR_TYPE

base: FIBER_CONNECTOR_TYPE

description:
Type of optical fiber connector

SC_CONNECTOR

description:
SC type fiber connector

base identity: FIBER_CONNECTOR_TYPE

LC_CONNECTOR

description:
LC type fiber connector

base identity: FIBER_CONNECTOR_TYPE

MPO_CONNECTOR

description:
MPO (multi-fiber push-on/pull-off) type fiber connector 1x12 fibers

base identity: FIBER_CONNECTOR_TYPE

AOC_CONNECTOR

description:
AOC (active optical cable) type fiber connector

base identity: FIBER_CONNECTOR_TYPE

DAC_CONNECTOR

description:
DAC (direct attach copper) type fiber connector

base identity: FIBER_CONNECTOR_TYPE

base: ETHERNET_PMD_TYPE

description:
Ethernet compliance codes (PMD) supported by transceivers

ETH_10GBASE_LRM

description:
Ethernet compliance code: 10GBASE_LRM

base identity: ETHERNET_PMD_TYPE

ETH_10GBASE_LR

description:
Ethernet compliance code: 10GBASE_LR

base identity: ETHERNET_PMD_TYPE

ETH_10GBASE_ZR

description:
Ethernet compliance code: 10GBASE_ZR

base identity: ETHERNET_PMD_TYPE

ETH_10GBASE_ER

description:
Ethernet compliance code: 10GBASE_ER

base identity: ETHERNET_PMD_TYPE

ETH_10GBASE_SR

description:
Ethernet compliance code: 10GBASE_SR

base identity: ETHERNET_PMD_TYPE

ETH_40GBASE_CR4

description:
Ethernet compliance code: 40GBASE_CR4

base identity: ETHERNET_PMD_TYPE

ETH_40GBASE_SR4

description:
Ethernet compliance code: 40GBASE_SR4

base identity: ETHERNET_PMD_TYPE

ETH_40GBASE_LR4

description:
Ethernet compliance code: 40GBASE_LR4

base identity: ETHERNET_PMD_TYPE

ETH_40GBASE_ER4

description:
Ethernet compliance code: 40GBASE_ER4

base identity: ETHERNET_PMD_TYPE

ETH_40GBASE_PSM4

description:
Ethernet compliance code: 40GBASE_PSM4

base identity: ETHERNET_PMD_TYPE

ETH_4X10GBASE_LR

description:
Ethernet compliance code: 4x10GBASE_LR

base identity: ETHERNET_PMD_TYPE

ETH_4X10GBASE_SR

description:
Ethernet compliance code: 4x10GBASE_SR

base identity: ETHERNET_PMD_TYPE

ETH_100G_AOC

description:
Ethernet compliance code: 100G_AOC

base identity: ETHERNET_PMD_TYPE

ETH_100G_ACC

description:
Ethernet compliance code: 100G_ACC

base identity: ETHERNET_PMD_TYPE

ETH_100GBASE_SR10

description:
Ethernet compliance code: 100GBASE_SR10

base identity: ETHERNET_PMD_TYPE

ETH_100GBASE_SR4

description:
Ethernet compliance code: 100GBASE_SR4

base identity: ETHERNET_PMD_TYPE

ETH_100GBASE_LR4

description:
Ethernet compliance code: 100GBASE_LR4

base identity: ETHERNET_PMD_TYPE

ETH_100GBASE_ER4

description:
Ethernet compliance code: 100GBASE_ER4

base identity: ETHERNET_PMD_TYPE

ETH_100GBASE_CWDM4

description:
Ethernet compliance code: 100GBASE_CWDM4

base identity: ETHERNET_PMD_TYPE

ETH_100GBASE_CLR4

description:
Ethernet compliance code: 100GBASE_CLR4

base identity: ETHERNET_PMD_TYPE

ETH_100GBASE_PSM4

description:
Ethernet compliance code: 100GBASE_PSM4

base identity: ETHERNET_PMD_TYPE

ETH_100GBASE_CR4

description:
Ethernet compliance code: 100GBASE_CR4

base identity: ETHERNET_PMD_TYPE

ETH_100GBASE_FR

description:
Ethernet compliance code: 100GBASE_FR

base identity: ETHERNET_PMD_TYPE

ETH_400GBASE_ZR

description:
Ethernet compliance code: 400GBASE_ZR

base identity: ETHERNET_PMD_TYPE

ETH_400GBASE_LR4

description:
Ethernet compliance code: 400GBASE_LR4

base identity: ETHERNET_PMD_TYPE

ETH_400GBASE_FR4

description:
Ethernet compliance code: 400GBASE_FR4

base identity: ETHERNET_PMD_TYPE

ETH_400GBASE_LR8

description:
Ethernet compliance code: 400GBASE_LR8

base identity: ETHERNET_PMD_TYPE

ETH_400GBASE_DR4

description:
Ethernet compliance code: 400GBASE_DR4

base identity: ETHERNET_PMD_TYPE

ETH_400GMSA_PSM4

description:
Ethernet compliance code: 400GMSA_PSM4

base identity: ETHERNET_PMD_TYPE

ETH_UNDEFINED

description:
Ethernet compliance code: undefined

base identity: ETHERNET_PMD_TYPE

base: SONET_APPLICATION_CODE

description:
Supported SONET/SDH application codes

VSR2000_3R2

description:
SONET/SDH application code: VSR2000_3R2

base identity: SONET_APPLICATION_CODE

VSR2000_3R3

description:
SONET/SDH application code: VSR2000_3R3

base identity: SONET_APPLICATION_CODE

VSR2000_3R5

description:
SONET/SDH application code: VSR2000_3R5

base identity: SONET_APPLICATION_CODE

SONET_UNDEFINED

description:
SONET/SDH application code: undefined

base identity: SONET_APPLICATION_CODE

base: OTN_APPLICATION_CODE

description:
Supported OTN application codes

P1L1_2D1

description:
OTN application code: P1L1_2D1

base identity: OTN_APPLICATION_CODE

P1S1_2D2

description:
OTN application code: P1S1_2D2

base identity: OTN_APPLICATION_CODE

P1L1_2D2

description:
OTN application code: P1L1_2D2

base identity: OTN_APPLICATION_CODE

OTN_UNDEFINED

description:
OTN application code: undefined

base identity: OTN_APPLICATION_CODE

base: TRIBUTARY_RATE_CLASS_TYPE

description:
Rate of tributary signal _- identities will typically reflect rounded bit rate.

TRIB_RATE_1G

description:
1G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_2.5G

description:
2.5G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_10G

description:
10G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_40G

description:
40G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_100G

description:
100G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_150G

description:
150G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_200G

description:
200G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_250G

description:
250G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_300G

description:
300G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_350G

description:
350G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_400G

description:
400G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_450G

description:
450G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_500G

description:
500G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_550G

description:
550G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_600G

description:
600G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_650G

description:
650G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_700G

description:
700G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_750G

description:
750G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_800G

description:
800G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_850G

description:
850G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_900G

description:
900G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_950G

description:
950G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_1000G

description:
1000G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_1050G

description:
1050G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_1100G

description:
1100G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_1150G

description:
1150G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_1200G

description:
1200G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_1250G

description:
1250G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_1300G

description:
1300G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_1350G

description:
1350G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_1400G

description:
1400G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_1450G

description:
1450G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_1500G

description:
1500G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_1550G

description:
1550G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

TRIB_RATE_1600G

description:
1600G tributary signal rate

base identity: TRIBUTARY_RATE_CLASS_TYPE

base: LOGICAL_ELEMENT_PROTOCOL_TYPE

description:
Type of protocol framing used on the logical channel or tributary

PROT_ETHERNET

description:
Ethernet protocol framing

base identity: LOGICAL_ELEMENT_PROTOCOL_TYPE

PROT_OTN

description:
OTN protocol framing

base identity: LOGICAL_ELEMENT_PROTOCOL_TYPE

base: FIBER_JUMPER_TYPE

description:
Types of fiber jumpers used for connecting device ports

FIBER_JUMPER_SIMPLEX

description:
Simplex fiber jumper

base identity: FIBER_JUMPER_TYPE

FIBER_JUMPER_MULTI_FIBER_STRAND

description:
One strand of a fiber jumper which contains multiple fibers within it, such as an MPO based fiber jumper

base identity: FIBER_JUMPER_TYPE

base: OPTICAL_PORT_TYPE

description:
Type definition for optical transport port types

INGRESS

description:
Ingress port, corresponding to a signal entering a line system device such as an amplifier or wavelength router.

base identity: OPTICAL_PORT_TYPE

EGRESS

description:
Egress port, corresponding to a signal exiting a line system device such as an amplifier or wavelength router.

base identity: OPTICAL_PORT_TYPE

ADD

description:
Add port, corresponding to a signal injected at a wavelength router.

base identity: OPTICAL_PORT_TYPE

DROP

description:
Drop port, corresponding to a signal dropped at a wavelength router.

base identity: OPTICAL_PORT_TYPE

MONITOR

description:
Monitor port, corresponding to a signal used by an optical channel monitor. This is used to represent the connection that a channel monitor port is connected to, typically on a line system device. This connection may be via physical cable and faceplate ports or internal to the device

base identity: OPTICAL_PORT_TYPE

TERMINAL_CLIENT

description:
Client-facing port on a terminal optics device (e.g., transponder or muxponder).

base identity: OPTICAL_PORT_TYPE

TERMINAL_LINE

description:
Line-facing port on a terminal optics device (e.g., transponder or muxponder).

base identity: OPTICAL_PORT_TYPE

base: CLIENT_MAPPING_MODE

description:
Type definition for optical transport client mapping modes.

MODE_1X100G

description:
1 x 100G client mapping mode.

base identity: CLIENT_MAPPING_MODE

MODE_1X200G

description:
1 x 200G client mapping mode.

base identity: CLIENT_MAPPING_MODE

MODE_1X400G

description:
1 x 400G client mapping mode.

base identity: CLIENT_MAPPING_MODE

MODE_2X100G

description:
2 x 100G client mapping mode.

base identity: CLIENT_MAPPING_MODE

MODE_2X200G

description:
2 x 200G client mapping mode.

base identity: CLIENT_MAPPING_MODE

MODE_3X100G

description:
3 x 100G client mapping mode.

base identity: CLIENT_MAPPING_MODE

MODE_4X100G

description:
4 x 100G client mapping mode.

base identity: CLIENT_MAPPING_MODE

base: TRANSCEIVER_MODULE_FUNCTIONAL_TYPE

description:
Type definition for transceiver module functional types.

TYPE_STANDARD_OPTIC

description:
Standard optic using a grey wavelength (i.e. 1310, 1550, etc.) and on-off-keying (OOK) modulation.

base identity: TRANSCEIVER_MODULE_FUNCTIONAL_TYPE

TYPE_DIGITAL_COHERENT_OPTIC

description:
Digital coherent module which transmits a phase / amplitude modulated signal and uses a digital signal processor to receive and decode the received signal.

base identity: TRANSCEIVER_MODULE_FUNCTIONAL_TYPE

Data elements

openconfig-transport-line-common

openconfig-version: 0.6.0

Description

This module defines common data elements for OpenConfig data models for optical transport line system elements, such as amplifiers and ROADMs (wavelength routers).

Imports

iana-if-type
openconfig-extensions
openconfig-interfaces
openconfig-platform
openconfig-types
openconfig-transport-types
openconfig-platform-transceiver

Data elements

openconfig-wavelength-router

openconfig-version: 1.1.0

Description

This model describes configuration and operational state data for an optical transport line system node, or ROADM (incl. CDC ROADMs, WSS, Dynamic Gain Equalizer/DGE).

Nodes are modeled as a configurable switching element with ingress and egress ports, as well as a number of add/drop ports that can be set up to direct portions of the optical spectrum to the appropriate degrees.

In relation to configuring target spectrum powers, there are two, non-overlapping, configuration possibilities that are supported. 1. Non-noise loaded wavelength router: - The target spectrum powers are configured on each media channel. 2. Noise-loaded wavelength router: - The target spectrum power values will be configured as a target spectrum power profile over the full spectrum instead of individual media channels.

Imports

openconfig-extensions
openconfig-platform
openconfig-transport-types

Identities

base: ATTENUATION_CONTROL_MODE

description:
The definition for different types of attenutation control modes on a media channel

ATTENUATION_FIXED_LOSS

description:
The attenuation applied across a media channel will be calculated based on the target input and output powers as well as the internal losses of the wavelength router. The target power levels are configured using port-spectrum-power-profiles of the two ports

base identity: ATTENUATION_CONTROL_MODE

ATTENUATION_DYNAMIC_LOSS

description:
The attenuation applied across a media channel is dynamically controlled by the device by attempting to meet the target output power as defined in the output port's port-spectrum-power-profile

base identity: ATTENUATION_CONTROL_MODE

ATTENUATION_DYNAMIC_LOSS_DAMPED

description:
The attenuation applied across a media channel is dynamically controlled by the device by attempting to meet the target output power as defined in the output port's port-spectrum-power-profile. In this mode, convergence to the target output power occurs gradually to minimize any power oscillations across the line system. These changes will happen within the order of minutes

base identity: ATTENUATION_CONTROL_MODE

base: ASE_CONTROL_MODE

description:
The definition for different types of ASE control modes on a media channel

ASE_ENABLED

description:
The media channel will immediately have ASE noise injected

base identity: ASE_CONTROL_MODE

ASE_DISABLED

description:
Removes any ASE noise injection that may be present on the media channel

base identity: ASE_CONTROL_MODE

AUTO_ASE_ON_FAILURE

description:
The media channel will automatically be injected with noise if the media channel target spectrum power drops below the provided threshdold. In this mode, at time of a failure, the media channel is removed from the system and would need to be reconfigured to restore traffic. In addition, unprovisioned spectrum will be injected with noise

base identity: ASE_CONTROL_MODE

AUTO_ASE_FAILURE_AND_RESTORE

description:
The media channel will automatically be injected with noise if the media channel target spectrum power drops below the provided threshold. When the original signal is restored above the threshold the ASE noise injection will be automatically removed. In addition, unprovisioned spectrum will be injected with noise

base identity: ASE_CONTROL_MODE

Data elements

/
wavelength-router

description:
Top-level container for wavelength router device

nodetype: container (rw)

/wavelength-router/
media-channels

description:
Enclosing container for media channel list

nodetype: container (rw)

/wavelength-router/media-channels/
channel

description:
List of media channels

nodetype: list (rw)

list keys: [index]

/wavelength-router/media-channels/channel/
index

description:
Reference to index number of the media channel

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/index

/wavelength-router/media-channels/channel/
config

description:
Configuration data

nodetype: container (rw)

/wavelength-router/media-channels/channel/config/
index

description:
Identifier for the defined media channel

nodetype: leaf (rw)

type: uint32

/wavelength-router/media-channels/channel/config/
name

description:
The user supplied name of the media channel

nodetype: leaf (rw)

type: string

/wavelength-router/media-channels/channel/config/
lower-frequency

description:
The lower frequency for the spectrum defined by this media channel

nodetype: leaf (rw)

type: oc-opt-types:frequency-type

/wavelength-router/media-channels/channel/config/
upper-frequency

description:
The upper frequency for the spectrum defined by this media channel

nodetype: leaf (rw)

type: oc-opt-types:frequency-type

/wavelength-router/media-channels/channel/config/
admin-status

description:
Sets the admin status of the media channel

nodetype: leaf (rw)

type: oc-opt-types:admin-state-type

/wavelength-router/media-channels/channel/config/
super-channel

description:
True if the media channel is a super channel which contains multiple media channels within it. The contained media channels should fall within the boundaries of the super channel. The device should raise an error if a media channel crosses a super channel boundary. When using super channels, spectrum power targets should be defined in either the: - port-spectrum-power-profiles for the port which matches the source port of the media channel representing the super channel - media channels that are contained within the super channel, but not on the super channel itself

nodetype: leaf (rw)

type: boolean

/wavelength-router/media-channels/channel/config/
super-channel-parent

description:
If the media channel is contained within a super channel this would specify the index of the super channel parent

nodetype: leaf (rw)

type: leafref

  • path reference: ../../../channel/config/index

/wavelength-router/media-channels/channel/config/
ase-control-mode

description:
Sets the ASE control mode for the media channel. The control mode defines if and when ASE noise is injected on the media channel

nodetype: leaf (rw)

type: identityref

  • base: ASE_CONTROL_MODE

/wavelength-router/media-channels/channel/config/
ase-injection-mode

description:
When specified, defines the mode used to determine whether ASE noise should be injected on the media channel.

nodetype: leaf (rw)

type: enumeration

  • MODE_THRESHOLD
    When set ASE noise will be injected when a defined threshold is crossed.
  • MODE_DELTA
    When set ASE noise will be injected when a defined delta in optical power occurs.

/wavelength-router/media-channels/channel/config/
ase-injection-threshold

description:
Defines the optical power threshold value below which ASE noise should be injected on the media channel. This or ase-injection-delta is required if an ase-control-mode is configured

nodetype: leaf (rw)

type: decimal64

units: dBm

/wavelength-router/media-channels/channel/config/
ase-injection-delta

description:
Defines the optical power loss from the configured spectrum power profile, which would indicate that ASE noise should be injected on the media channel. This or ase-injection-threshold is required if an ase-control-mode is configured

nodetype: leaf (rw)

type: decimal64

units: dB

/wavelength-router/media-channels/channel/config/
attenuation-control-mode

description:
Sets the attenuation control mode for the media channel. The control mode defines the behavior of how the attenuation across a media channel is set

nodetype: leaf (rw)

type: identityref

  • base: ATTENUATION_CONTROL_MODE

/wavelength-router/media-channels/channel/
state

description:
Operational state data

nodetype: container (ro)

/wavelength-router/media-channels/channel/state/
index

description:
Identifier for the defined media channel

nodetype: leaf (ro)

type: uint32

/wavelength-router/media-channels/channel/state/
name

description:
The user supplied name of the media channel

nodetype: leaf (ro)

type: string

/wavelength-router/media-channels/channel/state/
lower-frequency

description:
The lower frequency for the spectrum defined by this media channel

nodetype: leaf (ro)

type: oc-opt-types:frequency-type

/wavelength-router/media-channels/channel/state/
upper-frequency

description:
The upper frequency for the spectrum defined by this media channel

nodetype: leaf (ro)

type: oc-opt-types:frequency-type

/wavelength-router/media-channels/channel/state/
admin-status

description:
Sets the admin status of the media channel

nodetype: leaf (ro)

type: oc-opt-types:admin-state-type

/wavelength-router/media-channels/channel/state/
super-channel

description:
True if the media channel is a super channel which contains multiple media channels within it. The contained media channels should fall within the boundaries of the super channel. The device should raise an error if a media channel crosses a super channel boundary. When using super channels, spectrum power targets should be defined in either the: - port-spectrum-power-profiles for the port which matches the source port of the media channel representing the super channel - media channels that are contained within the super channel, but not on the super channel itself

nodetype: leaf (ro)

type: boolean

/wavelength-router/media-channels/channel/state/
super-channel-parent

description:
If the media channel is contained within a super channel this would specify the index of the super channel parent

nodetype: leaf (ro)

type: leafref

  • path reference: ../../../channel/config/index

/wavelength-router/media-channels/channel/state/
ase-control-mode

description:
Sets the ASE control mode for the media channel. The control mode defines if and when ASE noise is injected on the media channel

nodetype: leaf (ro)

type: identityref

  • base: ASE_CONTROL_MODE

/wavelength-router/media-channels/channel/state/
ase-injection-mode

description:
When specified, defines the mode used to determine whether ASE noise should be injected on the media channel.

nodetype: leaf (ro)

type: enumeration

  • MODE_THRESHOLD
    When set ASE noise will be injected when a defined threshold is crossed.
  • MODE_DELTA
    When set ASE noise will be injected when a defined delta in optical power occurs.

/wavelength-router/media-channels/channel/state/
ase-injection-threshold

description:
Defines the optical power threshold value below which ASE noise should be injected on the media channel. This or ase-injection-delta is required if an ase-control-mode is configured

nodetype: leaf (ro)

type: decimal64

units: dBm

/wavelength-router/media-channels/channel/state/
ase-injection-delta

description:
Defines the optical power loss from the configured spectrum power profile, which would indicate that ASE noise should be injected on the media channel. This or ase-injection-threshold is required if an ase-control-mode is configured

nodetype: leaf (ro)

type: decimal64

units: dB

/wavelength-router/media-channels/channel/state/
attenuation-control-mode

description:
Sets the attenuation control mode for the media channel. The control mode defines the behavior of how the attenuation across a media channel is set

nodetype: leaf (ro)

type: identityref

  • base: ATTENUATION_CONTROL_MODE

/wavelength-router/media-channels/channel/state/
oper-status

description:
Operational state of the media channel

nodetype: leaf (ro)

type: enumeration

  • UP
    Media channel is operationally up
  • DOWN
    Media channel is operationally down

/wavelength-router/media-channels/channel/state/
ase-status

description:
Status of injected ASE noise on the media channel

nodetype: leaf (ro)

type: enumeration

  • PRESENT
    Media channel has injected ASE noise present
  • NOT_PRESENT
    Media channel does not have injected ASE noise present

/wavelength-router/media-channels/channel/
source

description:
Top-level container for media channel source

nodetype: container (rw)

/wavelength-router/media-channels/channel/source/
config

description:
Configuration data for the media channel source

nodetype: container (rw)

/wavelength-router/media-channels/channel/source/config/
port-name

description:
Reference to the corresponding node port

nodetype: leaf (rw)

type: leafref

  • path reference: /components/component/name

/wavelength-router/media-channels/channel/source/
state

description:
Operational state data for the media channel source

nodetype: container (ro)

/wavelength-router/media-channels/channel/source/state/
port-name

description:
Reference to the corresponding node port

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/wavelength-router/media-channels/channel/
dest

description:
Top-level container for media channel destination

nodetype: container (rw)

/wavelength-router/media-channels/channel/dest/
config

description:
Configuration data for the media channel destination

nodetype: container (rw)

/wavelength-router/media-channels/channel/dest/config/
port-name

description:
Reference to the corresponding node port

nodetype: leaf (rw)

type: leafref

  • path reference: /components/component/name

/wavelength-router/media-channels/channel/dest/
state

description:
Operational state data for the media channel destination

nodetype: container (ro)

/wavelength-router/media-channels/channel/dest/state/
port-name

description:
Reference to the corresponding node port

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/wavelength-router/media-channels/channel/
spectrum-power-profile

description:
Enclosing container for the list of values describing the target spectrum powers

nodetype: container (rw)

/wavelength-router/media-channels/channel/spectrum-power-profile/
distribution

description:
List of tuples describing the target spectrum power distribution

nodetype: list (rw)

list keys: [lower-frequency] [upper-frequency]

/wavelength-router/media-channels/channel/spectrum-power-profile/distribution/
lower-frequency

description:
Reference to the list key

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/lower-frequency

/wavelength-router/media-channels/channel/spectrum-power-profile/distribution/
upper-frequency

description:
Reference to the list key

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/upper-frequency

/wavelength-router/media-channels/channel/spectrum-power-profile/distribution/
config

description:
Configuration data for target spectrum power

nodetype: container (rw)

/wavelength-router/media-channels/channel/spectrum-power-profile/distribution/config/
lower-frequency

description:
Lower frequency of the specified target spectrum power

nodetype: leaf (rw)

type: oc-opt-types:frequency-type

/wavelength-router/media-channels/channel/spectrum-power-profile/distribution/config/
upper-frequency

description:
Upper frequency of the specified target spectrum power

nodetype: leaf (rw)

type: oc-opt-types:frequency-type

/wavelength-router/media-channels/channel/spectrum-power-profile/distribution/config/
target-power

description:
Target average power to achieve within the specified spectrum

nodetype: leaf (rw)

type: decimal64

units: dBm

/wavelength-router/media-channels/channel/spectrum-power-profile/distribution/
state

description:
Operational state data for target spectrum power

nodetype: container (ro)

/wavelength-router/media-channels/channel/spectrum-power-profile/distribution/state/
lower-frequency

description:
Lower frequency of the specified target spectrum power

nodetype: leaf (ro)

type: oc-opt-types:frequency-type

/wavelength-router/media-channels/channel/spectrum-power-profile/distribution/state/
upper-frequency

description:
Upper frequency of the specified target spectrum power

nodetype: leaf (ro)

type: oc-opt-types:frequency-type

/wavelength-router/media-channels/channel/spectrum-power-profile/distribution/state/
target-power

description:
Target average power to achieve within the specified spectrum

nodetype: leaf (ro)

type: decimal64

units: dBm

/wavelength-router/
port-spectrum-power-profiles

description:
Enclosing container for wavelength-router port spectrum power profiles

nodetype: container (rw)

/wavelength-router/port-spectrum-power-profiles/
port

description:
List of ports, keyed by port name

nodetype: list (rw)

list keys: [name]

/wavelength-router/port-spectrum-power-profiles/port/
name

description:
References the port name

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/wavelength-router/port-spectrum-power-profiles/port/
config

description:
Configuration data for each port

nodetype: container (rw)

/wavelength-router/port-spectrum-power-profiles/port/config/
name

description:
Reference to system-supplied name of the wavelength-router port component.

nodetype: leaf (rw)

type: leafref

  • path reference: /components/component/name

/wavelength-router/port-spectrum-power-profiles/port/
state

description:
Operational state data for each port spectrum profile.

nodetype: container (ro)

/wavelength-router/port-spectrum-power-profiles/port/state/
name

description:
Reference to system-supplied name of the wavelength-router port component.

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/wavelength-router/port-spectrum-power-profiles/port/
spectrum-power-profile

description:
Enclosing container for the list of values describing the target spectrum powers

nodetype: container (rw)

/wavelength-router/port-spectrum-power-profiles/port/spectrum-power-profile/
distribution

description:
List of tuples describing the target spectrum power distribution

nodetype: list (rw)

list keys: [lower-frequency] [upper-frequency]

/wavelength-router/port-spectrum-power-profiles/port/spectrum-power-profile/distribution/
lower-frequency

description:
Reference to the list key

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/lower-frequency

/wavelength-router/port-spectrum-power-profiles/port/spectrum-power-profile/distribution/
upper-frequency

description:
Reference to the list key

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/upper-frequency

/wavelength-router/port-spectrum-power-profiles/port/spectrum-power-profile/distribution/
config

description:
Configuration data for target spectrum power

nodetype: container (rw)

/wavelength-router/port-spectrum-power-profiles/port/spectrum-power-profile/distribution/config/
lower-frequency

description:
Lower frequency of the specified target spectrum power

nodetype: leaf (rw)

type: oc-opt-types:frequency-type

/wavelength-router/port-spectrum-power-profiles/port/spectrum-power-profile/distribution/config/
upper-frequency

description:
Upper frequency of the specified target spectrum power

nodetype: leaf (rw)

type: oc-opt-types:frequency-type

/wavelength-router/port-spectrum-power-profiles/port/spectrum-power-profile/distribution/config/
target-power

description:
Target average power to achieve within the specified spectrum

nodetype: leaf (rw)

type: decimal64

units: dBm

/wavelength-router/port-spectrum-power-profiles/port/spectrum-power-profile/distribution/
state

description:
Operational state data for target spectrum power

nodetype: container (ro)

/wavelength-router/port-spectrum-power-profiles/port/spectrum-power-profile/distribution/state/
lower-frequency

description:
Lower frequency of the specified target spectrum power

nodetype: leaf (ro)

type: oc-opt-types:frequency-type

/wavelength-router/port-spectrum-power-profiles/port/spectrum-power-profile/distribution/state/
upper-frequency

description:
Upper frequency of the specified target spectrum power

nodetype: leaf (ro)

type: oc-opt-types:frequency-type

/wavelength-router/port-spectrum-power-profiles/port/spectrum-power-profile/distribution/state/
target-power

description:
Target average power to achieve within the specified spectrum

nodetype: leaf (ro)

type: decimal64

units: dBm

openconfig-channel-monitor

openconfig-version: 0.4.0

Description

This model describes operational state data for an optical channel monitor (OCM) for optical transport line system elements such as wavelength routers (ROADMs) and amplifiers.

Imports

openconfig-extensions
openconfig-interfaces
openconfig-platform
openconfig-transport-types

Data elements

/
channel-monitors

description:
Top-level container for optical channel monitors

nodetype: container (rw)

/channel-monitors/
channel-monitor

description:
List of channel monitors, keyed by channel monitor name.

nodetype: list (rw)

list keys: [name]

/channel-monitors/channel-monitor/
name

description:
References the optical channel monitor name

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/channel-monitors/channel-monitor/
config

description:
Configuration data

nodetype: container (rw)

/channel-monitors/channel-monitor/config/
name

description:
Reference to system-supplied name of the port on the optical channel monitor (OCM). If this port is embedded in another card (i.e. an amplifier card) the device should still define a port representing the OCM even if it is internal and not physically present on the faceplate of the card

nodetype: leaf (rw)

type: leafref

  • path reference: /components/component/name

/channel-monitors/channel-monitor/config/
monitor-port

description:
Reference to system-supplied name of the port that the channel monitor is physically connected to. This port will be of type MONITOR. This port is a tap off of the monitored-port and would be in the same card as the monitored port. If this port is embedded in another card (i.e. an amplifier card) the device should still define a port representing the monitor port if it is internal and not physically present on the faceplate of the card

nodetype: leaf (rw)

type: leafref

  • path reference: /components/component/name

/channel-monitors/channel-monitor/
state

description:
Operational state data

nodetype: container (ro)

/channel-monitors/channel-monitor/state/
name

description:
Reference to system-supplied name of the port on the optical channel monitor (OCM). If this port is embedded in another card (i.e. an amplifier card) the device should still define a port representing the OCM even if it is internal and not physically present on the faceplate of the card

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/channel-monitors/channel-monitor/state/
monitor-port

description:
Reference to system-supplied name of the port that the channel monitor is physically connected to. This port will be of type MONITOR. This port is a tap off of the monitored-port and would be in the same card as the monitored port. If this port is embedded in another card (i.e. an amplifier card) the device should still define a port representing the monitor port if it is internal and not physically present on the faceplate of the card

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/channel-monitors/channel-monitor/
channels

description:
Enclosing container for the list of values describing the spectrum power distribution

nodetype: container (rw)

/channel-monitors/channel-monitor/channels/
channel

description:
List of tuples describing the spectrum power distribution

nodetype: list (ro)

list keys: [lower-frequency] [upper-frequency]

/channel-monitors/channel-monitor/channels/channel/
lower-frequency

description:
Reference to the list key

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/lower-frequency

/channel-monitors/channel-monitor/channels/channel/
upper-frequency

description:
Reference to the list key

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/upper-frequency

/channel-monitors/channel-monitor/channels/channel/
state

description:
Operational state data for spectrum power

nodetype: container (ro)

/channel-monitors/channel-monitor/channels/channel/state/
lower-frequency

description:
Lower frequency of the specified spectrum power

nodetype: leaf (ro)

type: oc-opt-types:frequency-type

/channel-monitors/channel-monitor/channels/channel/state/
upper-frequency

description:
Upper frequency of the specified spectrum power

nodetype: leaf (ro)

type: oc-opt-types:frequency-type

/channel-monitors/channel-monitor/channels/channel/state/
power

description:
Average measured optical power over the specified spectrum

nodetype: leaf (ro)

type: decimal64

units: dBm