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-platform-types

openconfig-version: 1.5.0

Description

This module defines data types (e.g., YANG identities) to support the OpenConfig component inventory model.

Imports

openconfig-types
openconfig-extensions

Defined types

component-power-type

description:
A generic type reflecting whether a hardware component is powered on or off

type: enumeration

  • POWER_ENABLED
    Enable power on the component
  • POWER_DISABLED
    Disable power on the component

component-redundant-role

description:
A generic type reflecting the component's redundanty role. For example, a device might have dual supervisors components for redundant purpose, with one being the primary and the other secondary.

type: enumeration

  • PRIMARY
    Component is acting the primary role.
  • SECONDARY
    Component is acting the secondary role.

component-redundant-role-switchover-reason-trigger

description:
Records how the role switchover is triggered.

type: enumeration

  • USER_INITIATED
    User initiated the switchover, e.g. via command line.
  • SYSTEM_INITIATED
    The system initiated the switchover, e.g. due to critical errors in the component of the primar role.

Identities

base: OPENCONFIG_HARDWARE_COMPONENT

description:
Base identity for hardware related components in a managed device. Derived identities are partially based on contents of the IANA Entity MIB.

CHASSIS

description:
Chassis component, typically with multiple slots / shelves

base identity: OPENCONFIG_HARDWARE_COMPONENT

BACKPLANE

description:
Backplane component for aggregating traffic, typically contained in a chassis component

base identity: OPENCONFIG_HARDWARE_COMPONENT

FABRIC

description:
Interconnect between ingress and egress ports on the device (e.g., a crossbar switch).

base identity: OPENCONFIG_HARDWARE_COMPONENT

POWER_SUPPLY

description:
Component that is supplying power to the device

base identity: OPENCONFIG_HARDWARE_COMPONENT

FAN

description:
Cooling fan, or could be some other heat-reduction component

base identity: OPENCONFIG_HARDWARE_COMPONENT

SENSOR

description:
Physical sensor, e.g., a temperature sensor in a chassis

base identity: OPENCONFIG_HARDWARE_COMPONENT

FRU

description:
Replaceable hardware component that does not have a more specific defined schema.

base identity: OPENCONFIG_HARDWARE_COMPONENT

LINECARD

description:
Linecard component, typically inserted into a chassis slot

base identity: OPENCONFIG_HARDWARE_COMPONENT

CONTROLLER_CARD

description:
A type of linecard whose primary role is management or control rather than data forwarding.

base identity: OPENCONFIG_HARDWARE_COMPONENT

PORT

description:
Physical port, e.g., for attaching pluggables and networking cables

base identity: OPENCONFIG_HARDWARE_COMPONENT

TRANSCEIVER

description:
Pluggable module present in a port

base identity: OPENCONFIG_HARDWARE_COMPONENT

CPU

description:
Processing unit, e.g., a management processor

base identity: OPENCONFIG_HARDWARE_COMPONENT

STORAGE

description:
A storage subsystem on the device (disk, SSD, etc.)

base identity: OPENCONFIG_HARDWARE_COMPONENT

INTEGRATED_CIRCUIT

description:
A special purpose processing unit, typically for traffic switching/forwarding (e.g., switching ASIC, NPU, forwarding chip, etc.)

base identity: OPENCONFIG_HARDWARE_COMPONENT

base: OPENCONFIG_SOFTWARE_COMPONENT

description:
Base identity for software-related components in a managed device

OPERATING_SYSTEM

description:
Operating system running on a component

base identity: OPENCONFIG_SOFTWARE_COMPONENT

OPERATING_SYSTEM_UPDATE

description:
An operating system update - which should be a subcomponent of the `OPERATING_SYSTEM` running on a component. An update is defined to be a set of software changes that are atomically installed (and uninstalled) together. Multiple updates may be present for the Operating System. A system should not list all installed software packages using this type -- but rather updates that are bundled together as a single installable item

base identity: OPENCONFIG_SOFTWARE_COMPONENT

BIOS

description:
Legacy BIOS or UEFI firmware interface responsible for initializing hardware components and first stage boot loader.

base identity: OPENCONFIG_SOFTWARE_COMPONENT

BOOT_LOADER

description:
Software layer responsible for loading and booting the device OS or network OS.

base identity: OPENCONFIG_SOFTWARE_COMPONENT

SOFTWARE_MODULE

description:
A base identity for software modules installed and/or running on the device. Modules include user-space programs and kernel modules that provide specific functionality. A component with type SOFTWARE_MODULE should also have a module type that indicates the specific type of software module

base identity: OPENCONFIG_SOFTWARE_COMPONENT

base: COMPONENT_OPER_STATUS

description:
Current operational status of a platform component

ACTIVE

description:
Component is enabled and active (i.e., up)

base identity: COMPONENT_OPER_STATUS

INACTIVE

description:
Component is enabled but inactive (i.e., down)

base identity: COMPONENT_OPER_STATUS

DISABLED

description:
Component is administratively disabled.

base identity: COMPONENT_OPER_STATUS

base: FEC_MODE_TYPE

description:
Base identity for FEC operational modes.

FEC_ENABLED

description:
FEC is administratively enabled.

base identity: FEC_MODE_TYPE

FEC_DISABLED

description:
FEC is administratively disabled.

base identity: FEC_MODE_TYPE

FEC_AUTO

description:
System will determine whether to enable or disable FEC on a transceiver.

base identity: FEC_MODE_TYPE

base: FEC_STATUS_TYPE

description:
Base identity for FEC operational statuses.

FEC_STATUS_LOCKED

description:
FEC is operationally locked.

base identity: FEC_STATUS_TYPE

FEC_STATUS_UNLOCKED

description:
FEC is operationally unlocked.

base identity: FEC_STATUS_TYPE

base: COMPONENT_REBOOT_REASON

description:
Base entity for component reboot reasons.

REBOOT_USER_INITIATED

description:
User initiated the reboot of the componenent.

base identity: COMPONENT_REBOOT_REASON

REBOOT_POWER_FAILURE

description:
The component reboots due to power failure.

base identity: COMPONENT_REBOOT_REASON

REBOOT_CRITICAL_ERROR

description:
The component reboots due to critical errors.

base identity: COMPONENT_REBOOT_REASON

Data elements

openconfig-terminal-device

openconfig-version: 1.9.0

Description

This module describes a terminal optics device model for managing the terminal systems (client and line side) in a DWDM transport network.

Elements of the model:

physical port: corresponds to a physical, pluggable client port on the terminal device. Examples includes 10G, 40G, 100G (e.g., 10x10G, 4x25G or 1x100G) and 400G/1T in the future. Physical client ports will have associated operational state or PMs.

physical channel: a physical lane or channel in the physical client port. Each physical client port has 1 or more channels. An example is 100GBASE-LR4 client physical port having 4x25G channels. Channels have their own optical PMs and can be monitored independently within a client physical port (e.g., channel power). Physical client channels are defined in the model as part of a physical client port, and are modeled primarily for reading their PMs.

logical channel: a logical grouping of logical grooming elements that may be assigned to subsequent grooming stages for multiplexing / de-multiplexing, or to an optical channel for line side transmission. The logical channels can represent, for example, an ODU/OTU logical packing of the client data onto the line side. Tributaries are similarly logical groupings of demand that can be represented in this structure and assigned to an optical channel. Note that different types of logical channels may be present, each with their corresponding PMs.

optical channel: corresponds to an optical carrier and is assigned a wavelength/frequency. Optical channels have PMs such as power, BER, and operational mode.

Directionality:

To maintain simplicity in the model, the configuration is described from client-to-line direction. The assumption is that equivalent reverse configuration is implicit, resulting in the same line-to-client configuration.

Physical layout:

The model does not assume a particular physical layout of client and line ports on the terminal device (e.g., such as number of ports per linecard, separate linecards for client and line ports, etc.).

Imports

openconfig-types
openconfig-transport-types
openconfig-if-ethernet
openconfig-interfaces
openconfig-platform
openconfig-platform-transceiver
openconfig-lldp
openconfig-extensions
ietf-yang-types
openconfig-yang-types

Data elements

/
terminal-device

description:
Top-level container for the terminal device

nodetype: container (rw)

/terminal-device/
config

description:
Configuration data for global terminal-device

nodetype: container (rw)

/terminal-device/
state

description:
Operational state data for global terminal device

nodetype: container (ro)

/terminal-device/
logical-channels

description:
Enclosing container the list of logical channels

nodetype: container (rw)

/terminal-device/logical-channels/
channel

description:
List of logical channels

nodetype: list (rw)

list keys: [index]

/terminal-device/logical-channels/channel/
index

description:
Reference to the index of the logical channel

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/index

/terminal-device/logical-channels/channel/
config

description:
Configuration data for logical channels

nodetype: container (rw)

/terminal-device/logical-channels/channel/config/
index

description:
Index of the current logical channel

nodetype: leaf (rw)

type: uint32

/terminal-device/logical-channels/channel/config/
description

description:
Description of the logical channel

nodetype: leaf (rw)

type: string

/terminal-device/logical-channels/channel/config/
admin-state

description:
Sets the admin state of the logical channel

nodetype: leaf (rw)

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

/terminal-device/logical-channels/channel/config/
rate-class

description:
Rounded bit rate of the tributary signal. Exact bit rate will be refined by protocol selection.

nodetype: leaf (rw)

type: identityref

  • base: oc-opt-types:TRIBUTARY_RATE_CLASS_TYPE

/terminal-device/logical-channels/channel/config/
trib-protocol

description:
Protocol framing of the tributary signal. If this LogicalChannel is directly connected to a Client-Port or Optical-Channel, this is the protocol of the associated port. If the LogicalChannel is connected to other LogicalChannels, the TributaryProtocol of the LogicalChannels will define a specific mapping/demapping or multiplexing/demultiplexing function. Not all protocols are valid, depending on the value of trib-rate-class. The expectation is that the NMS will validate that a correct combination of rate class and protocol are specfied. Basic combinations are: rate class: 1G protocols: 1GE rate class: 2.5G protocols: OC48, STM16 rate class: 10G protocols: 10GE LAN, 10GE WAN, OC192, STM64, OTU2, OTU2e, OTU1e, ODU2, ODU2e, ODU1e rate class: 40G protocols: 40GE, OC768, STM256, OTU3, ODU3 rate class: 100G protocols: 100GE, 100G MLG, OTU4, OTUCn, ODU4

nodetype: leaf (rw)

type: identityref

  • base: oc-opt-types:TRIBUTARY_PROTOCOL_TYPE

/terminal-device/logical-channels/channel/config/
logical-channel-type

description:
The type / stage of the logical element determines the configuration and operational state parameters (PMs) available for the logical element

nodetype: leaf (rw)

type: identityref

  • base: oc-opt-types:LOGICAL_ELEMENT_PROTOCOL_TYPE

/terminal-device/logical-channels/channel/config/
loopback-mode

description:
Sets the loopback type on the logical channel. Setting the mode to something besides NONE activates the loopback in the specified mode.

nodetype: leaf (rw)

type: oc-opt-types:loopback-mode-type

/terminal-device/logical-channels/channel/config/
test-signal

description:
When enabled the logical channel's DSP will generate a pseudo randmon bit stream (PRBS) which can be used during testing.

nodetype: leaf (rw)

type: boolean

/terminal-device/logical-channels/channel/config/
client-mapping-mode

description:
The client side mapping mode internal to the device that specifies the number of client electrical interfaces and the data rate of each client electrical interface. For example, a ZR+ transceiver with an optical line rate of 400G could be configured to break out into four 100G client signals which might connect to an interface or a physical-channel. This would be configured on the aggregate logical channel as MODE_4X100G. This is only valid on the aggregate logical channel that is connected directly to the optical-channel.

nodetype: leaf (rw)

type: identityref

  • base: oc-opt-types:CLIENT_MAPPING_MODE

/terminal-device/logical-channels/channel/
state

description:
Operational state data for logical channels

nodetype: container (ro)

/terminal-device/logical-channels/channel/state/
index

description:
Index of the current logical channel

nodetype: leaf (ro)

type: uint32

/terminal-device/logical-channels/channel/state/
description

description:
Description of the logical channel

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/state/
admin-state

description:
Sets the admin state of the logical channel

nodetype: leaf (ro)

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

/terminal-device/logical-channels/channel/state/
rate-class

description:
Rounded bit rate of the tributary signal. Exact bit rate will be refined by protocol selection.

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:TRIBUTARY_RATE_CLASS_TYPE

/terminal-device/logical-channels/channel/state/
trib-protocol

description:
Protocol framing of the tributary signal. If this LogicalChannel is directly connected to a Client-Port or Optical-Channel, this is the protocol of the associated port. If the LogicalChannel is connected to other LogicalChannels, the TributaryProtocol of the LogicalChannels will define a specific mapping/demapping or multiplexing/demultiplexing function. Not all protocols are valid, depending on the value of trib-rate-class. The expectation is that the NMS will validate that a correct combination of rate class and protocol are specfied. Basic combinations are: rate class: 1G protocols: 1GE rate class: 2.5G protocols: OC48, STM16 rate class: 10G protocols: 10GE LAN, 10GE WAN, OC192, STM64, OTU2, OTU2e, OTU1e, ODU2, ODU2e, ODU1e rate class: 40G protocols: 40GE, OC768, STM256, OTU3, ODU3 rate class: 100G protocols: 100GE, 100G MLG, OTU4, OTUCn, ODU4

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:TRIBUTARY_PROTOCOL_TYPE

/terminal-device/logical-channels/channel/state/
logical-channel-type

description:
The type / stage of the logical element determines the configuration and operational state parameters (PMs) available for the logical element

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:LOGICAL_ELEMENT_PROTOCOL_TYPE

/terminal-device/logical-channels/channel/state/
loopback-mode

description:
Sets the loopback type on the logical channel. Setting the mode to something besides NONE activates the loopback in the specified mode.

nodetype: leaf (ro)

type: oc-opt-types:loopback-mode-type

/terminal-device/logical-channels/channel/state/
test-signal

description:
When enabled the logical channel's DSP will generate a pseudo randmon bit stream (PRBS) which can be used during testing.

nodetype: leaf (ro)

type: boolean

/terminal-device/logical-channels/channel/state/
client-mapping-mode

description:
The client side mapping mode internal to the device that specifies the number of client electrical interfaces and the data rate of each client electrical interface. For example, a ZR+ transceiver with an optical line rate of 400G could be configured to break out into four 100G client signals which might connect to an interface or a physical-channel. This would be configured on the aggregate logical channel as MODE_4X100G. This is only valid on the aggregate logical channel that is connected directly to the optical-channel.

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:CLIENT_MAPPING_MODE

description:
Link-state of the Ethernet protocol on the logical channel, SONET / SDH framed signal, etc.

nodetype: leaf (ro)

type: enumeration

  • UP
    Logical channel is operationally up
  • DOWN
    Logical channel is operationally down
  • TESTING
    Logical channel is under test as a result of enabling test-signal

/terminal-device/logical-channels/channel/
otn

description:
Top level container for OTU configuration when logical channel framing is using an OTU protocol, e.g., OTU1, OTU3, etc.

nodetype: container (rw)

/terminal-device/logical-channels/channel/otn/
config

description:
Configuration data for OTN protocol framing

nodetype: container (rw)

/terminal-device/logical-channels/channel/otn/config/
tti-msg-transmit

description:
Trail trace identifier (TTI) message transmitted

nodetype: leaf (rw)

type: string

/terminal-device/logical-channels/channel/otn/config/
tti-msg-expected

description:
Trail trace identifier (TTI) message expected

nodetype: leaf (rw)

type: string

/terminal-device/logical-channels/channel/otn/config/
tti-msg-auto

description:
Trail trace identifier (TTI) transmit message automatically created. If true, then setting a custom transmit message would be invalid.

nodetype: leaf (rw)

type: boolean

/terminal-device/logical-channels/channel/otn/config/
tributary-slot-granularity

description:
Granularity value of OPUk or OPUCn tributary slots for OTN signal allocation. The currently defined values follow the existing ITU-T G.709 standard, which can be extended as needed in future.

nodetype: leaf (rw)

type: identityref

  • base: oc-opt-types:TRIBUTARY_SLOT_GRANULARITY

/terminal-device/logical-channels/channel/otn/
state

description:
Operational state data for OTN protocol PMs, statistics, etc.

nodetype: container (ro)

/terminal-device/logical-channels/channel/otn/state/
tti-msg-transmit

description:
Trail trace identifier (TTI) message transmitted

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/otn/state/
tti-msg-expected

description:
Trail trace identifier (TTI) message expected

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/otn/state/
tti-msg-auto

description:
Trail trace identifier (TTI) transmit message automatically created. If true, then setting a custom transmit message would be invalid.

nodetype: leaf (ro)

type: boolean

/terminal-device/logical-channels/channel/otn/state/
tributary-slot-granularity

description:
Granularity value of OPUk or OPUCn tributary slots for OTN signal allocation. The currently defined values follow the existing ITU-T G.709 standard, which can be extended as needed in future.

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:TRIBUTARY_SLOT_GRANULARITY

/terminal-device/logical-channels/channel/otn/state/
tti-msg-recv

description:
Trail trace identifier (TTI) message received

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/otn/state/
rdi-msg

description:
Remote defect indication (RDI) message received

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/otn/state/
errored-seconds

description:
The number of seconds that at least one errored blocks occurs, at least one code violation occurs, loss of sync is detected or loss of signal is detected

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/otn/state/
severely-errored-seconds

description:
The number of seconds that loss of frame is detected OR the number of errored blocks, code violations, loss of sync or loss of signal is detected exceeds a predefined threshold

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/otn/state/
unavailable-seconds

description:
The number of seconds during which the link is unavailable

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/otn/state/
code-violations

description:
For ethernet or fiberchannel links, the number of 8b/10b coding violations. For SONET/SDH, the number of BIP (bit interleaved parity) errors

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/otn/state/
errored-blocks

description:
The number of errored blocks. Error detection codes are capable to detect whether one or more errors have occurred in a given sequence of bits – the block. It is normally not possible to determine the exact number of errored bits within the block.

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/otn/state/
fec-uncorrectable-words

description:
The number of words that were uncorrectable by the FEC

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/otn/state/
fec-corrected-bytes

description:
The number of bytes that were corrected by the FEC

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/otn/state/
fec-corrected-bits

description:
The number of bits that were corrected by the FEC

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/otn/state/
background-block-errors

description:
The number of background block errors

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/otn/state/
fec-uncorrectable-blocks

description:
The number of blocks or frames that were uncorrectable by the FEC

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/otn/state/
pre-fec-ber

description:
Bit error rate before forward error correction -- computed value with 18 decimal precision. Note that decimal64 supports values as small as i x 10^-18 where i is an integer. Values smaller than this should be reported as 0 to inidicate error free or near error free performance. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/terminal-device/logical-channels/channel/otn/state/pre-fec-ber/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/otn/state/pre-fec-ber/
avg

description:
The arithmetic mean value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/otn/state/pre-fec-ber/
min

description:
The minimum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/otn/state/pre-fec-ber/
max

description:
The maximum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/otn/state/pre-fec-ber/
interval

description:
If supported by the system, this reports the time interval over which the min/max/average statistics are computed by the system.

nodetype: leaf (ro)

type: oc-types:stat-interval

/terminal-device/logical-channels/channel/otn/state/pre-fec-ber/
min-time

description:
The absolute time at which the minimum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/otn/state/pre-fec-ber/
max-time

description:
The absolute time at which the maximum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/otn/state/
post-fec-ber

description:
Bit error rate after forward error correction -- computed value with 18 decimal precision. Note that decimal64 supports values as small as i x 10^-18 where i is an integer. Values smaller than this should be reported as 0 to inidicate error free or near error free performance. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/terminal-device/logical-channels/channel/otn/state/post-fec-ber/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/otn/state/post-fec-ber/
avg

description:
The arithmetic mean value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/otn/state/post-fec-ber/
min

description:
The minimum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/otn/state/post-fec-ber/
max

description:
The maximum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/otn/state/post-fec-ber/
interval

description:
If supported by the system, this reports the time interval over which the min/max/average statistics are computed by the system.

nodetype: leaf (ro)

type: oc-types:stat-interval

/terminal-device/logical-channels/channel/otn/state/post-fec-ber/
min-time

description:
The absolute time at which the minimum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/otn/state/post-fec-ber/
max-time

description:
The absolute time at which the maximum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/otn/state/
q-value

description:
Quality value (factor) in dB of a channel with two decimal precision. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/terminal-device/logical-channels/channel/otn/state/q-value/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/otn/state/q-value/
avg

description:
The arithmetic mean value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/otn/state/q-value/
min

description:
The minimum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/otn/state/q-value/
max

description:
The maximum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/otn/state/q-value/
interval

description:
If supported by the system, this reports the time interval over which the min/max/average statistics are computed by the system.

nodetype: leaf (ro)

type: oc-types:stat-interval

/terminal-device/logical-channels/channel/otn/state/q-value/
min-time

description:
The absolute time at which the minimum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/otn/state/q-value/
max-time

description:
The absolute time at which the maximum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/otn/state/
esnr

description:
Electrical signal to noise ratio. Baud rate normalized signal to noise ratio based on error vector magnitude in dB with two decimal precision. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/terminal-device/logical-channels/channel/otn/state/esnr/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/otn/state/esnr/
avg

description:
The arithmetic mean value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/otn/state/esnr/
min

description:
The minimum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/otn/state/esnr/
max

description:
The maximum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/otn/state/esnr/
interval

description:
If supported by the system, this reports the time interval over which the min/max/average statistics are computed by the system.

nodetype: leaf (ro)

type: oc-types:stat-interval

/terminal-device/logical-channels/channel/otn/state/esnr/
min-time

description:
The absolute time at which the minimum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/otn/state/esnr/
max-time

description:
The absolute time at which the maximum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/
ethernet

description:
Top level container for data related to Ethernet framing for the logical channel

nodetype: container (rw)

/terminal-device/logical-channels/channel/ethernet/
config

description:
Configuration data for Ethernet protocol framing on logical channels

nodetype: container (rw)

/terminal-device/logical-channels/channel/ethernet/config/
client-als

description:
Sets the client port behavior that defines if the actions of automatic laser shutdown (als), ethernet fault propagation, or nothing will be done upon the detection of a failure on the line port or the upstream remote client port.

nodetype: leaf (rw)

type: enumeration

  • NONE
    The client port will do nothing when a failure is detected on the line port or the remote client port
  • LASER_SHUTDOWN
    The client port will shut down the laser to notify the subtending Ethernet equipment of the failure detected on the line port or the remote client port.
  • ETHERNET
    The client port will propagate the local fault or remote fault signal to the subtending Ethernet equipment.

default: ETHERNET

/terminal-device/logical-channels/channel/ethernet/config/
als-delay

description:
The timer to delay the client-als actions on the client port when a local or remote fault is detected on the line port. The delay will only be valid when the client-als is set to LASER_SHUTDOWN

nodetype: leaf (rw)

type: uint32

default: 0

units: milliseconds

/terminal-device/logical-channels/channel/ethernet/
state

description:
Operational state data for Ethernet protocol framing on logical channels

nodetype: container (ro)

/terminal-device/logical-channels/channel/ethernet/state/
client-als

description:
Sets the client port behavior that defines if the actions of automatic laser shutdown (als), ethernet fault propagation, or nothing will be done upon the detection of a failure on the line port or the upstream remote client port.

nodetype: leaf (ro)

type: enumeration

  • NONE
    The client port will do nothing when a failure is detected on the line port or the remote client port
  • LASER_SHUTDOWN
    The client port will shut down the laser to notify the subtending Ethernet equipment of the failure detected on the line port or the remote client port.
  • ETHERNET
    The client port will propagate the local fault or remote fault signal to the subtending Ethernet equipment.

default: ETHERNET

/terminal-device/logical-channels/channel/ethernet/state/
als-delay

description:
The timer to delay the client-als actions on the client port when a local or remote fault is detected on the line port. The delay will only be valid when the client-als is set to LASER_SHUTDOWN

nodetype: leaf (ro)

type: uint32

default: 0

units: milliseconds

/terminal-device/logical-channels/channel/ethernet/state/
in-mac-control-frames

description:
MAC layer control frames received on the interface

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-mac-pause-frames

description:
MAC layer PAUSE frames received on the interface

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-oversize-frames

description:
The total number of frames received that were longer than 1518 octets (excluding framing bits, but including FCS octets) and were otherwise well formed.

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-undersize-frames

description:
The total number of frames received that were less than 64 octets long (excluding framing bits, but including FCS octets) and were otherwise well formed.

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-jabber-frames

description:
Number of jabber frames received on the interface. Jabber frames are typically defined as oversize frames which also have a bad CRC. Implementations may use slightly different definitions of what constitutes a jabber frame. Often indicative of a NIC hardware problem.

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-fragment-frames

description:
The total number of frames received that were less than 64 octets in length (excluding framing bits but including FCS octets) and had either a bad Frame Check Sequence (FCS) with an integral number of octets (FCS Error) or a bad FCS with a non-integral number of octets (Alignment Error).

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-8021q-frames

description:
Number of 802.1q tagged frames received on the interface

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-crc-errors

description:
The total number of frames received that had a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets, inclusive, but had either a bad Frame Check Sequence (FCS) with an integral number of octets (FCS Error) or a bad FCS with a non-integral number of octets (Alignment Error)

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-block-errors

description:
The number of received errored blocks. Error detection codes are capable of detecting whether one or more errors have occurred in a given sequence of bits – the block. It is normally not possible to determine the exact number of errored bits within the block

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-carrier-errors

description:
The number of received errored frames due to a carrier issue. The value refers to MIB counter for dot3StatsCarrierSenseErrors oid=1.3.6.1.2.1.10.7.2.1.11

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-interrupted-tx

description:
The number of received errored frames due to interrupted transmission issue. The value refers to MIB counter for dot3StatsDeferredTransmissions oid=1.3.6.1.2.1.10.7.2.1.7

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-late-collision

description:
The number of received errored frames due to late collision issue. The value refers to MIB counter for dot3StatsLateCollisions oid=1.3.6.1.2.1.10.7.2.1.8

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-mac-errors-rx

description:
The number of received errored frames due to MAC errors received. The value refers to MIB counter for dot3StatsInternalMacReceiveErrors oid=1.3.6.1.2.1.10.7.2.1.16

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-single-collision

description:
The number of received errored frames due to single collision issue. The value refers to MIB counter for dot3StatsSingleCollisionFrames oid=1.3.6.1.2.1.10.7.2.1.4

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-symbol-error

description:
The number of received errored frames due to symbol error. The value refers to MIB counter for in-symbol-error oid=1.3.6.1.2.1.10.7.2.1.18

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-maxsize-exceeded

description:
The total number frames received that are well-formed but dropped due to exceeding the maximum frame size on the interface (e.g., MTU or MRU)

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
out-mac-control-frames

description:
MAC layer control frames sent on the interface

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
out-mac-pause-frames

description:
MAC layer PAUSE frames sent on the interface

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
out-8021q-frames

description:
Number of 802.1q tagged frames sent on the interface

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
out-mac-errors-tx

description:
The number of sent errored frames due to MAC errors transmitted. The value refers to MIB counter for dot3StatsInternalMacTransmitErrors oid=1.3.6.1.2.1.10.7.2.1.10

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-pcs-bip-errors

description:
The number of received bit interleaved parity (BIP) errors at the physical coding sublayer (PCS). If the interface consists of multiple lanes, this will be the sum of all errors on the lane

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-pcs-errored-seconds

description:
The number of seconds that physical coding sublayer (PCS) errors have crossed a sytem defined threshold indicating the link is erroring

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-pcs-severely-errored-seconds

description:
The number of seconds that physical coding sublayer (PCS) errors have crossed a system defined threshold indicating the link is severely erroring

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
in-pcs-unavailable-seconds

description:
The number of seconds that physical coding sublayer (PCS) errors have crossed a system defined threshold indicating the link is unavailable

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
out-pcs-bip-errors

description:
The number of transmitted bit interleaved parity (BIP) errors at the physical coding sublayer (PCS). If the interface consists of multiple lanes, this will be the sum of all errors on the lane

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
out-crc-errors

description:
Number of FCS/CRC error check failures sent on the interface

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
out-block-errors

description:
The number of transmitted errored blocks. Error detection codes are capable of detecting whether one or more errors have occurred in a given sequence of bits – the block. It is normally not possible to determine the exact number of errored bits within the block

nodetype: leaf (ro)

type: oc-yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
fec-uncorrectable-blocks

description:
The number of blocks or frames that were uncorrectable by the FEC

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/ethernet/state/
pre-fec-ber

description:
Bit error rate before forward error correction -- computed value with 18 decimal precision. Note that decimal64 supports values as small as i x 10^-18 where i is an integer. Values smaller than this should be reported as 0 to inidicate error free or near error free performance. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/terminal-device/logical-channels/channel/ethernet/state/pre-fec-ber/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/ethernet/state/pre-fec-ber/
avg

description:
The arithmetic mean value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/ethernet/state/pre-fec-ber/
min

description:
The minimum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/ethernet/state/pre-fec-ber/
max

description:
The maximum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/ethernet/state/pre-fec-ber/
interval

description:
If supported by the system, this reports the time interval over which the min/max/average statistics are computed by the system.

nodetype: leaf (ro)

type: oc-types:stat-interval

/terminal-device/logical-channels/channel/ethernet/state/pre-fec-ber/
min-time

description:
The absolute time at which the minimum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/ethernet/state/pre-fec-ber/
max-time

description:
The absolute time at which the maximum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/ethernet/state/
post-fec-ber

description:
Bit error rate after forward error correction -- computed value with 18 decimal precision. Note that decimal64 supports values as small as i x 10^-18 where i is an integer. Values smaller than this should be reported as 0 to inidicate error free or near error free performance. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/terminal-device/logical-channels/channel/ethernet/state/post-fec-ber/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/ethernet/state/post-fec-ber/
avg

description:
The arithmetic mean value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/ethernet/state/post-fec-ber/
min

description:
The minimum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/ethernet/state/post-fec-ber/
max

description:
The maximum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/terminal-device/logical-channels/channel/ethernet/state/post-fec-ber/
interval

description:
If supported by the system, this reports the time interval over which the min/max/average statistics are computed by the system.

nodetype: leaf (ro)

type: oc-types:stat-interval

/terminal-device/logical-channels/channel/ethernet/state/post-fec-ber/
min-time

description:
The absolute time at which the minimum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/ethernet/state/post-fec-ber/
max-time

description:
The absolute time at which the maximum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/ethernet/state/
q-value

description:
Quality value (factor) in dB of a channel with two decimal precision. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/terminal-device/logical-channels/channel/ethernet/state/q-value/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/ethernet/state/q-value/
avg

description:
The arithmetic mean value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/ethernet/state/q-value/
min

description:
The minimum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/ethernet/state/q-value/
max

description:
The maximum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/ethernet/state/q-value/
interval

description:
If supported by the system, this reports the time interval over which the min/max/average statistics are computed by the system.

nodetype: leaf (ro)

type: oc-types:stat-interval

/terminal-device/logical-channels/channel/ethernet/state/q-value/
min-time

description:
The absolute time at which the minimum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/ethernet/state/q-value/
max-time

description:
The absolute time at which the maximum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/ethernet/state/
esnr

description:
Electrical signal to noise ratio. Baud rate normalized signal to noise ratio based on error vector magnitude in dB with two decimal precision. Values include the instantaneous, average, minimum, and maximum statistics. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/terminal-device/logical-channels/channel/ethernet/state/esnr/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/ethernet/state/esnr/
avg

description:
The arithmetic mean value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/ethernet/state/esnr/
min

description:
The minimum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/ethernet/state/esnr/
max

description:
The maximum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/terminal-device/logical-channels/channel/ethernet/state/esnr/
interval

description:
If supported by the system, this reports the time interval over which the min/max/average statistics are computed by the system.

nodetype: leaf (ro)

type: oc-types:stat-interval

/terminal-device/logical-channels/channel/ethernet/state/esnr/
min-time

description:
The absolute time at which the minimum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/ethernet/state/esnr/
max-time

description:
The absolute time at which the maximum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/terminal-device/logical-channels/channel/ethernet/
lldp

description:
LLDP data for logical channels

nodetype: container (rw)

/terminal-device/logical-channels/channel/ethernet/lldp/
config

description:
LLDP configuration data for logical channels

nodetype: container (rw)

/terminal-device/logical-channels/channel/ethernet/lldp/config/
enabled

description:
Enable or disable the LLDP protocol on the logical channel.

nodetype: leaf (rw)

type: boolean

default: false

/terminal-device/logical-channels/channel/ethernet/lldp/config/
snooping

description:
If true, LLDP PDUs are only received and processed on the logical-channel, but are not originated by the local agent. The PDUs are not dropped by the logical channel after processing, but relayed to the downstream link layer neighbors. The snooping mode is valid only when LLDP is enabled on the logical channel. The snooping mode is useful when a logical channel does not want its link layer neighbors to discover itself since, for example, it is a lower-layer logical channel.

nodetype: leaf (rw)

type: boolean

default: false

/terminal-device/logical-channels/channel/ethernet/lldp/
state

description:
LLDP operational state data for logical channels

nodetype: container (ro)

/terminal-device/logical-channels/channel/ethernet/lldp/state/
enabled

description:
Enable or disable the LLDP protocol on the logical channel.

nodetype: leaf (ro)

type: boolean

default: false

/terminal-device/logical-channels/channel/ethernet/lldp/state/
snooping

description:
If true, LLDP PDUs are only received and processed on the logical-channel, but are not originated by the local agent. The PDUs are not dropped by the logical channel after processing, but relayed to the downstream link layer neighbors. The snooping mode is valid only when LLDP is enabled on the logical channel. The snooping mode is useful when a logical channel does not want its link layer neighbors to discover itself since, for example, it is a lower-layer logical channel.

nodetype: leaf (ro)

type: boolean

default: false

/terminal-device/logical-channels/channel/ethernet/lldp/state/
counters

description:
LLDP counters on each interface

nodetype: container (ro)

/terminal-device/logical-channels/channel/ethernet/lldp/state/counters/
frame-in

description:
The number of lldp frames received.

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/ethernet/lldp/state/counters/
frame-out

description:
The number of frames transmitted out.

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/ethernet/lldp/state/counters/
frame-error-in

description:
The number of LLDP frames received with errors.

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/ethernet/lldp/state/counters/
frame-discard

description:
The number of LLDP frames received and discarded.

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/ethernet/lldp/state/counters/
tlv-discard

description:
The number of TLV frames received and discarded.

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/ethernet/lldp/state/counters/
tlv-unknown

description:
The number of frames received with unknown TLV.

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/ethernet/lldp/state/counters/
last-clear

description:
Indicates the last time the counters were cleared.

nodetype: leaf (ro)

type: yang:date-and-time

/terminal-device/logical-channels/channel/ethernet/lldp/state/counters/
frame-error-out

description:
The number of frame transmit errors on the interface.

nodetype: leaf (ro)

type: yang:counter64

/terminal-device/logical-channels/channel/ethernet/lldp/
neighbors

description:
Enclosing container for list of LLDP neighbors on a logical channel

nodetype: container (ro)

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/
neighbor

description:
List of LLDP neighbors. If the implementation only supports one neighbor, this would always be a list with one item. If the device and neighbor supported multiple neighbors, which can be achieved via LLDP forwarding, then this would be supported

nodetype: list (ro)

list keys: [id]

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/
id

description:
System generated identifier for the neighbor on the logical channel.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/id

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/
config

description:
Configuration data

nodetype: container (ro)

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/
state

description:
Operational state data

nodetype: container (ro)

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/state/
system-name

description:
The system name field shall contain an alpha-numeric string that indicates the system's administratively assigned name. The system name should be the system's fully qualified domain name. If implementations support IETF RFC 3418, the sysName object should be used for this field.

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/state/
system-description

description:
The system description field shall contain an alpha-numeric string that is the textual description of the network entity. The system description should include the full name and version identification of the system's hardware type, software operating system, and networking software. If implementations support IETF RFC 3418, the sysDescr object should be used for this field.

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/state/
chassis-id

description:
The Chassis ID is a mandatory TLV which identifies the chassis component of the endpoint identifier associated with the transmitting LLDP agent

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/state/
chassis-id-type

description:
This field identifies the format and source of the chassis identifier string. It is an enumerator defined by the LldpChassisIdSubtype object from IEEE 802.1AB MIB.

nodetype: leaf (ro)

type: oc-lldp-types:chassis-id-type

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/state/
id

description:
System generated identifier for the neighbor on the interface.

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/state/
age

description:
Age since discovery

nodetype: leaf (ro)

type: uint64

units: seconds

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/state/
last-update

description:
Seconds since last update received.

nodetype: leaf (ro)

type: int64

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/state/
ttl

description:
The time-to-live (TTL) is a mandatory TLV which indicates how long information from the neighbor should be considered valid.

nodetype: leaf (ro)

type: uint16

units: seconds

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/state/
port-id

description:
The Port ID is a mandatory TLV which identifies the port component of the endpoint identifier associated with the transmitting LLDP agent. If the specified port is an IEEE 802.3 Repeater port, then this TLV is optional.

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/state/
port-id-type

description:
This field identifies the format and source of the port identifier string. It is an enumerator defined by the PtopoPortIdType object from RFC2922.

nodetype: leaf (ro)

type: oc-lldp-types:port-id-type

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/state/
port-description

description:
The binary string containing the actual port identifier for the port which this LLDP PDU was transmitted. The source and format of this field is defined by PtopoPortId from RFC2922.

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/state/
management-address

description:
The Management Address is a mandatory TLV which identifies a network address associated with the local LLDP agent, which can be used to reach the agent on the port identified in the Port ID TLV.

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/state/
management-address-type

description:
The enumerated value for the network address type identified in this TLV. This enumeration is defined in the 'Assigned Numbers' RFC [RFC3232] and the ianaAddressFamilyNumbers object.

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/
custom-tlvs

description:
Enclosing container for list of custom TLVs from a neighbor

nodetype: container (ro)

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/custom-tlvs/
tlv

description:
List of custom LLDP TLVs from a neighbor

nodetype: list (ro)

list keys: [type] [oui] [oui-subtype]

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/custom-tlvs/tlv/
type

description:
Reference to type list key

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/type

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/custom-tlvs/tlv/
oui

description:
Reference to oui list key

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/oui

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/custom-tlvs/tlv/
oui-subtype

description:
Reference to oui-subtype list key

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/oui-subtype

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/custom-tlvs/tlv/
config

description:
Configuration data

nodetype: container (ro)

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/custom-tlvs/tlv/
state

description:
Operational state data

nodetype: container (ro)

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/custom-tlvs/tlv/state/
type

description:
The integer value identifying the type of information contained in the value field.

nodetype: leaf (ro)

type: int32

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/custom-tlvs/tlv/state/
oui

description:
The organizationally unique identifier field shall contain the organization's OUI as defined in Clause 9 of IEEE Std 802. The high-order octet is 0 and the low-order 3 octets are the SMI Network Management Private Enterprise Code of the Vendor in network byte order, as defined in the 'Assigned Numbers' RFC [RFC3232].

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/custom-tlvs/tlv/state/
oui-subtype

description:
The organizationally defined subtype field shall contain a unique subtype value assigned by the defining organization.

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/ethernet/lldp/neighbors/neighbor/custom-tlvs/tlv/state/
value

description:
A variable-length octet-string containing the instance-specific information for this TLV.

nodetype: leaf (ro)

type: binary

/terminal-device/logical-channels/channel/
ingress

description:
Top-level container for specifying references to the source of signal for the logical channel, either a transceiver, individual physical channels, or an interface

nodetype: container (rw)

/terminal-device/logical-channels/channel/ingress/
config

description:
Configuration data for the signal source for the logical channel

nodetype: container (rw)

/terminal-device/logical-channels/channel/ingress/config/
transceiver

description:
Reference to the transceiver carrying the input signal for the logical channel. If specific physical channels are mapped to the logical channel (as opposed to all physical channels carried by the transceiver), they can be specified in the list of physical channel references.

nodetype: leaf (rw)

type: leafref

  • path reference: /components/component/name

/terminal-device/logical-channels/channel/ingress/config/
physical-channel

description:
This list should be populated with references to the client physical channels that feed this logical channel from the transceiver specified in the 'transceiver' leaf, which must be specified. If this leaf-list is empty, all physical channels in the transceiver are assumed to be mapped to the logical channel.

nodetype: leaf-list (rw)

type: leafref

  • path reference: /components/component/transceiver/physical-channels/channel/index

/terminal-device/logical-channels/channel/ingress/config/
interface

description:
Reference to the interface carrying the input signal for the logical channel. The ingress will specify an interface in the case of a transceiver being utilized directly in a router and bypassing a dedicated terminal device. When specified, the other leaves in the ingress config must be empty.

nodetype: leaf (rw)

type: oc-if:base-interface-ref

/terminal-device/logical-channels/channel/ingress/
state

description:
Operational state data for the signal source for the logical channel

nodetype: container (ro)

/terminal-device/logical-channels/channel/ingress/state/
transceiver

description:
Reference to the transceiver carrying the input signal for the logical channel. If specific physical channels are mapped to the logical channel (as opposed to all physical channels carried by the transceiver), they can be specified in the list of physical channel references.

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/terminal-device/logical-channels/channel/ingress/state/
physical-channel

description:
This list should be populated with references to the client physical channels that feed this logical channel from the transceiver specified in the 'transceiver' leaf, which must be specified. If this leaf-list is empty, all physical channels in the transceiver are assumed to be mapped to the logical channel.

nodetype: leaf-list (ro)

type: leafref

  • path reference: /components/component/transceiver/physical-channels/channel/index

/terminal-device/logical-channels/channel/ingress/state/
interface

description:
Reference to the interface carrying the input signal for the logical channel. The ingress will specify an interface in the case of a transceiver being utilized directly in a router and bypassing a dedicated terminal device. When specified, the other leaves in the ingress config must be empty.

nodetype: leaf (ro)

type: oc-if:base-interface-ref

/terminal-device/logical-channels/channel/
logical-channel-assignments

description:
Enclosing container for tributary assignments

nodetype: container (rw)

/terminal-device/logical-channels/channel/logical-channel-assignments/
assignment

description:
Logical channel elements may be assigned directly to optical channels for line-side transmission, or can be further groomed into additional stages of logical channel elements. The grooming can multiplex (i.e., split the current element into multiple elements in the subsequent stage) or de-multiplex (i.e., combine the current element with other elements into the same element in the subsequent stage) logical elements in each stage. Note that to support the ability to groom the logical elements, the list of logical channel elements should be populated with an entry for the logical elements at each stage, starting with the initial assignment from the respective client physical port. Each logical element assignment consists of a pointer to an element in the next stage, or to an optical channel, along with a bandwidth allocation for the corresponding assignment (e.g., to split or combine signal).

nodetype: list (rw)

list keys: [index]

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/
index

description:
Reference to the index for the current tributary assignment

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/index

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/
config

description:
Configuration data for tributary assignments

nodetype: container (rw)

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/config/
index

description:
Index of the current logical client channel to tributary mapping

nodetype: leaf (rw)

type: uint32

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/config/
description

description:
Name assigned to the logical client channel

nodetype: leaf (rw)

type: string

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/config/
assignment-type

description:
Each logical channel element may be assigned to subsequent stages of logical elements to implement further grooming, or can be assigned to a line-side optical channel for transmission. Each assignment also has an associated bandwidth allocation.

nodetype: leaf (rw)

type: enumeration

  • LOGICAL_CHANNEL
    Subsequent channel is a logical channel
  • OPTICAL_CHANNEL
    Subsequent channel is a optical channel / carrier

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/config/
logical-channel

description:
Reference to another stage of logical channel elements.

nodetype: leaf (rw)

type: leafref

  • path reference: /terminal-device/logical-channels/channel/index

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/config/
optical-channel

description:
Reference to the line-side optical channel that should carry the current logical channel element. Use this reference to exit the logical element stage.

nodetype: leaf (rw)

type: leafref

  • path reference: /components/component/name

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/config/
allocation

description:
Allocation of the logical client channel to the tributary or sub-channel, expressed in Gbps. Please note that if the assignment is to an OTN logical channel, the allocation must be an integer multiplication to tributary-slot-granularity of the OTN logical channel.

nodetype: leaf (rw)

type: decimal64

units: Gbps

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/config/
tributary-slot-index

description:
Indicates the first tributary slot index allocated to the client signal or logical channel in the assignment. Valid only when the assignment is to an OTN logical channel.

nodetype: leaf (rw)

type: int32

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/config/
mapping

description:
Logical channel mapping procedure. Valid only when the assignment is to an OTN logical channel.

nodetype: leaf (rw)

type: identityref

  • base: oc-opt-types:FRAME_MAPPING_PROTOCOL

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/
state

description:
Operational state data for tributary assignments

nodetype: container (ro)

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/state/
index

description:
Index of the current logical client channel to tributary mapping

nodetype: leaf (ro)

type: uint32

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/state/
description

description:
Name assigned to the logical client channel

nodetype: leaf (ro)

type: string

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/state/
assignment-type

description:
Each logical channel element may be assigned to subsequent stages of logical elements to implement further grooming, or can be assigned to a line-side optical channel for transmission. Each assignment also has an associated bandwidth allocation.

nodetype: leaf (ro)

type: enumeration

  • LOGICAL_CHANNEL
    Subsequent channel is a logical channel
  • OPTICAL_CHANNEL
    Subsequent channel is a optical channel / carrier

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/state/
logical-channel

description:
Reference to another stage of logical channel elements.

nodetype: leaf (ro)

type: leafref

  • path reference: /terminal-device/logical-channels/channel/index

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/state/
optical-channel

description:
Reference to the line-side optical channel that should carry the current logical channel element. Use this reference to exit the logical element stage.

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/state/
allocation

description:
Allocation of the logical client channel to the tributary or sub-channel, expressed in Gbps. Please note that if the assignment is to an OTN logical channel, the allocation must be an integer multiplication to tributary-slot-granularity of the OTN logical channel.

nodetype: leaf (ro)

type: decimal64

units: Gbps

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/state/
tributary-slot-index

description:
Indicates the first tributary slot index allocated to the client signal or logical channel in the assignment. Valid only when the assignment is to an OTN logical channel.

nodetype: leaf (ro)

type: int32

/terminal-device/logical-channels/channel/logical-channel-assignments/assignment/state/
mapping

description:
Logical channel mapping procedure. Valid only when the assignment is to an OTN logical channel.

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:FRAME_MAPPING_PROTOCOL

/terminal-device/
operational-modes

description:
Enclosing container for list of operational modes

nodetype: container (rw)

/terminal-device/operational-modes/
mode

description:
List of operational modes supported by the platform. The operational mode provides a platform-defined summary of information such as symbol rate, modulation, pulse shaping, etc.

nodetype: list (ro)

list keys: [mode-id]

/terminal-device/operational-modes/mode/
mode-id

description:
Reference to mode-id

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/mode-id

/terminal-device/operational-modes/mode/
config

description:
Configuration data for operational mode

nodetype: container (ro)

/terminal-device/operational-modes/mode/
state

description:
Operational state data for the platform-defined operational mode

nodetype: container (ro)

/terminal-device/operational-modes/mode/state/
mode-id

description:
Two-octet encoding of the vendor-defined operational mode

nodetype: leaf (ro)

type: uint16

/terminal-device/operational-modes/mode/state/
description

description:
Vendor-supplied textual description of the characteristics of this operational mode to enable operators to select the appropriate mode for the application.

nodetype: leaf (ro)

type: string

/terminal-device/operational-modes/mode/state/
vendor-id

description:
Identifier to represent the vendor / supplier of the platform and the associated operational mode information

nodetype: leaf (ro)

type: string

openconfig-platform-transceiver

openconfig-version: 0.10.0

Description

This module defines configuration and operational state data for transceivers (i.e., pluggable optics). The module should be used in conjunction with the platform model where other physical entity data are represented.

In the platform model, a component of type=TRANSCEIVER is expected to be a subcomponent of a PORT component. This module defines a concrete schema for the associated data for components with type=TRANSCEIVER.

A transceiver will always contain physical-channel(s), however when a line side optical-channel is present (i.e. ZR+ optics) the physical-channel will reference its optical-channel. In this case, the optical-channels components must be subcomponents of the transceiver. The relationship between the physical-channel and the optical-channel allows for multiple optical-channels to be associated with a transceiver in addition to ensuring certain leaves (i.e. output-power) are not duplicated in multiple components.

If a transceiver contains a digital signal processor (DSP), such as with ZR+ optics, the modeling will utilize hierarchical components as follows: PORT --> TRANSCEIVER --> OPTICAL_CHANNEL(s) The signal will then traverse through a series of terminal-device/logical-channels as required. The first logical-channel connected to the OPTICAL_CHANNEL will utilize the assignment/optical-channel leaf to create the relationship. At the conclusion of the series of logical-channels, the logical-channel will be associated to its host / client side based on: * If the TRANSCEIVER is directly within a router or switch, then it will use the logical-channel ingress leaf to specify the interface it is associated with. * If the TRANSCEIVER is within a dedicated terminal (Layer 1) device, then it will use the logical-channel ingress leaf to specify a physical-channel within a TRANSCEIVER component (i.e. gray optic) that it is associated with.

Imports

ietf-yang-types
openconfig-platform
openconfig-platform-types
openconfig-platform-port
openconfig-interfaces
openconfig-transport-types
openconfig-types
openconfig-extensions
openconfig-yang-types
openconfig-alarm-types

Data elements