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-transport-line-common

openconfig-version: 0.6.0

Description

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

Imports

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

Data elements

openconfig-optical-amplifier

openconfig-version: 0.5.0

Description

This model describes configuration and operational state data for optical amplifiers, deployed as part of a transport line system.

Imports

openconfig-platform
openconfig-transport-line-common
openconfig-types
openconfig-extensions

Identities

base: OPTICAL_AMPLIFIER_TYPE

description:
Type definition for different types of optical amplifiers

EDFA

description:
Erbium doped fiber amplifer (EDFA)

base identity: OPTICAL_AMPLIFIER_TYPE

FORWARD_RAMAN

description:
Forward pumping Raman amplifier

base identity: OPTICAL_AMPLIFIER_TYPE

BACKWARD_RAMAN

description:
Backward pumping Raman amplifier

base identity: OPTICAL_AMPLIFIER_TYPE

HYBRID

description:
Hybrid backward pumping Raman + EDFA amplifier

base identity: OPTICAL_AMPLIFIER_TYPE

base: GAIN_RANGE

description:
Base type for expressing the gain range for a switched gain amplifier. The gain range is expressed as a generic setting, e.g., LOW/MID/HIGH. The actual db range will be determined by the implementation.

LOW_GAIN_RANGE

description:
LOW gain range setting

base identity: GAIN_RANGE

MID_GAIN_RANGE

description:
MID gain range setting

base identity: GAIN_RANGE

HIGH_GAIN_RANGE

description:
HIGH gain range setting

base identity: GAIN_RANGE

FIXED_GAIN_RANGE

description:
Fixed or non-switched gain amplfier

base identity: GAIN_RANGE

base: OPTICAL_AMPLIFIER_MODE

description:
Type definition for different types of optical amplifier operating modes

CONSTANT_POWER

description:
Constant power mode. In constant power mode, the amplifier will maintain a constant output power by adjusting the amplifier gain and/or related variable optical attenuators

base identity: OPTICAL_AMPLIFIER_MODE

CONSTANT_GAIN

description:
Constant gain mode. In constant gain mode, the amplifier will maintain a constant amplifier gain

base identity: OPTICAL_AMPLIFIER_MODE

DYNAMIC_GAIN

description:
Dynamic gain mode. In dynamic gain mode, the amplifier will automatically adjust gain to stay within parameters defined by: - target-gain - min-gain - max-gain

base identity: OPTICAL_AMPLIFIER_MODE

base: FIBER_TYPE_PROFILE

description:
Type definition for different profiles of fiber types

DSF

description:
Dispersion shifted fiber

base identity: FIBER_TYPE_PROFILE

LEAF

description:
Large effective area fiber

base identity: FIBER_TYPE_PROFILE

SSMF

description:
Standard single mode fiber

base identity: FIBER_TYPE_PROFILE

TWC

description:
True wave classic

base identity: FIBER_TYPE_PROFILE

TWRS

description:
True wave reduced slope

base identity: FIBER_TYPE_PROFILE

Data elements

/
optical-amplifier

description:
Enclosing container for amplifiers and supervisory channels

nodetype: container (rw)

/optical-amplifier/
amplifiers

description:
Enclosing container for list of amplifiers

nodetype: container (rw)

/optical-amplifier/amplifiers/
amplifier

description:
List of optical amplifiers present in the device

nodetype: list (rw)

list keys: [name]

/optical-amplifier/amplifiers/amplifier/
name

description:
Reference to the name of the amplifier

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/optical-amplifier/amplifiers/amplifier/
config

description:
Configuration data for the amplifier

nodetype: container (rw)

/optical-amplifier/amplifiers/amplifier/config/
name

description:
User-defined name assigned to identify a specific amplifier in the device

nodetype: leaf (rw)

type: string

/optical-amplifier/amplifiers/amplifier/config/
type

description:
Type of the amplifier

nodetype: leaf (rw)

type: identityref

  • base: OPTICAL_AMPLIFIER_TYPE

/optical-amplifier/amplifiers/amplifier/config/
target-gain

description:
Positive gain applied by the amplifier. This is used when the amp-mode is in CONSTANT_GAIN or DYNAMIC_GAIN mode to set the target gain that the amplifier should achieve.

nodetype: leaf (rw)

type: decimal64

units: dB

/optical-amplifier/amplifiers/amplifier/config/
min-gain

description:
The minimum allowed gain of the amplifier. This is used when the amp-mode is in CONSTANT_POWER or DYNAMIC_GAIN mode to prevent the gain from dropping below a desired threshold. If left empty, the platform will apply a minimum gain based on hardware specifications.

nodetype: leaf (rw)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/config/
max-gain

description:
The maximum allowed gain of the amplifier. This is used when the amp-mode is in CONSTANT_POWER or DYNAMIC_GAIN mode to prevent the gain from exceeding a desired threshold. If left empty, the platform will apply a maximum gain based on hardware specifications.

nodetype: leaf (rw)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/config/
target-gain-tilt

description:
Gain tilt control

nodetype: leaf (rw)

type: decimal64

units: dB

/optical-amplifier/amplifiers/amplifier/config/
gain-range

description:
Selected gain range. The gain range is a platform-defined value indicating the switched gain amplifier setting

nodetype: leaf (rw)

type: identityref

  • base: GAIN_RANGE

/optical-amplifier/amplifiers/amplifier/config/
amp-mode

description:
The operating mode of the amplifier

nodetype: leaf (rw)

type: identityref

  • base: OPTICAL_AMPLIFIER_MODE

/optical-amplifier/amplifiers/amplifier/config/
target-output-power

description:
Output optical power of the amplifier.

nodetype: leaf (rw)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/config/
max-output-power

description:
The maximum optical output power of the amplifier. This may be used to prevent the output power from exceeding a desired threshold.

nodetype: leaf (rw)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/config/
enabled

description:
Turns power on / off to the amplifiers gain module.

nodetype: leaf (rw)

type: boolean

/optical-amplifier/amplifiers/amplifier/config/
fiber-type-profile

description:
The fiber type profile specifies details about the fiber type which are needed to accurately determine the gain and perform efficient amplification. This is only needed for Raman type amplifiers.

nodetype: leaf (rw)

type: identityref

  • base: FIBER_TYPE_PROFILE

/optical-amplifier/amplifiers/amplifier/
state

description:
Operational state data for the amplifier

nodetype: container (ro)

/optical-amplifier/amplifiers/amplifier/state/
name

description:
User-defined name assigned to identify a specific amplifier in the device

nodetype: leaf (ro)

type: string

/optical-amplifier/amplifiers/amplifier/state/
type

description:
Type of the amplifier

nodetype: leaf (ro)

type: identityref

  • base: OPTICAL_AMPLIFIER_TYPE

/optical-amplifier/amplifiers/amplifier/state/
target-gain

description:
Positive gain applied by the amplifier. This is used when the amp-mode is in CONSTANT_GAIN or DYNAMIC_GAIN mode to set the target gain that the amplifier should achieve.

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-amplifier/amplifiers/amplifier/state/
min-gain

description:
The minimum allowed gain of the amplifier. This is used when the amp-mode is in CONSTANT_POWER or DYNAMIC_GAIN mode to prevent the gain from dropping below a desired threshold. If left empty, the platform will apply a minimum gain based on hardware specifications.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/
max-gain

description:
The maximum allowed gain of the amplifier. This is used when the amp-mode is in CONSTANT_POWER or DYNAMIC_GAIN mode to prevent the gain from exceeding a desired threshold. If left empty, the platform will apply a maximum gain based on hardware specifications.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/
target-gain-tilt

description:
Gain tilt control

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-amplifier/amplifiers/amplifier/state/
gain-range

description:
Selected gain range. The gain range is a platform-defined value indicating the switched gain amplifier setting

nodetype: leaf (ro)

type: identityref

  • base: GAIN_RANGE

/optical-amplifier/amplifiers/amplifier/state/
amp-mode

description:
The operating mode of the amplifier

nodetype: leaf (ro)

type: identityref

  • base: OPTICAL_AMPLIFIER_MODE

/optical-amplifier/amplifiers/amplifier/state/
target-output-power

description:
Output optical power of the amplifier.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/
max-output-power

description:
The maximum optical output power of the amplifier. This may be used to prevent the output power from exceeding a desired threshold.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/
enabled

description:
Turns power on / off to the amplifiers gain module.

nodetype: leaf (ro)

type: boolean

/optical-amplifier/amplifiers/amplifier/state/
fiber-type-profile

description:
The fiber type profile specifies details about the fiber type which are needed to accurately determine the gain and perform efficient amplification. This is only needed for Raman type amplifiers.

nodetype: leaf (ro)

type: identityref

  • base: FIBER_TYPE_PROFILE

/optical-amplifier/amplifiers/amplifier/state/
component

description:
Reference to the system-supplied physical component that the amplifier gain block is contained within. Multiple amplifier gain blocks may be contained within the same physical component.

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/optical-amplifier/amplifiers/amplifier/state/
ingress-port

description:
Reference to system-supplied name of the amplifier ingress port. This leaf is only valid for ports of type INGRESS.

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/optical-amplifier/amplifiers/amplifier/state/
egress-port

description:
Reference to system-supplied name of the amplifier egress port. This leaf is only valid for ports of type EGRESS.

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/optical-amplifier/amplifiers/amplifier/state/
actual-gain

description:
The actual gain applied by the amplifier in units of 0.01dB. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/optical-amplifier/amplifiers/amplifier/state/actual-gain/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-amplifier/amplifiers/amplifier/state/actual-gain/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-amplifier/amplifiers/amplifier/state/actual-gain/
min

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

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-amplifier/amplifiers/amplifier/state/actual-gain/
max

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

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-amplifier/amplifiers/amplifier/state/actual-gain/
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

/optical-amplifier/amplifiers/amplifier/state/actual-gain/
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

/optical-amplifier/amplifiers/amplifier/state/actual-gain/
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

/optical-amplifier/amplifiers/amplifier/state/
actual-gain-tilt

description:
The actual tilt applied by the amplifier in units of 0.01dB. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/optical-amplifier/amplifiers/amplifier/state/actual-gain-tilt/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-amplifier/amplifiers/amplifier/state/actual-gain-tilt/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-amplifier/amplifiers/amplifier/state/actual-gain-tilt/
min

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

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-amplifier/amplifiers/amplifier/state/actual-gain-tilt/
max

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

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-amplifier/amplifiers/amplifier/state/actual-gain-tilt/
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

/optical-amplifier/amplifiers/amplifier/state/actual-gain-tilt/
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

/optical-amplifier/amplifiers/amplifier/state/actual-gain-tilt/
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

/optical-amplifier/amplifiers/amplifier/state/
input-power-total

description:
The total input optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/optical-amplifier/amplifiers/amplifier/state/input-power-total/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/input-power-total/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/input-power-total/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/input-power-total/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/input-power-total/
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

/optical-amplifier/amplifiers/amplifier/state/input-power-total/
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

/optical-amplifier/amplifiers/amplifier/state/input-power-total/
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

/optical-amplifier/amplifiers/amplifier/state/
input-power-c-band

description:
The C band (consisting of approximately 191 to 195 THz or 1530nm to 1565 nm) input optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/optical-amplifier/amplifiers/amplifier/state/input-power-c-band/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/input-power-c-band/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/input-power-c-band/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/input-power-c-band/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/input-power-c-band/
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

/optical-amplifier/amplifiers/amplifier/state/input-power-c-band/
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

/optical-amplifier/amplifiers/amplifier/state/input-power-c-band/
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

/optical-amplifier/amplifiers/amplifier/state/
input-power-l-band

description:
The L band (consisting of approximately 184 to 191 THz or 1565 to 1625 nm) input optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/optical-amplifier/amplifiers/amplifier/state/input-power-l-band/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/input-power-l-band/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/input-power-l-band/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/input-power-l-band/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/input-power-l-band/
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

/optical-amplifier/amplifiers/amplifier/state/input-power-l-band/
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

/optical-amplifier/amplifiers/amplifier/state/input-power-l-band/
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

/optical-amplifier/amplifiers/amplifier/state/
output-power-total

description:
The total output optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/optical-amplifier/amplifiers/amplifier/state/output-power-total/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/output-power-total/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/output-power-total/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/output-power-total/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/output-power-total/
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

/optical-amplifier/amplifiers/amplifier/state/output-power-total/
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

/optical-amplifier/amplifiers/amplifier/state/output-power-total/
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

/optical-amplifier/amplifiers/amplifier/state/
output-power-c-band

description:
The C band (consisting of approximately 191 to 195 THz or 1530nm to 1565 nm)output optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/optical-amplifier/amplifiers/amplifier/state/output-power-c-band/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/output-power-c-band/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/output-power-c-band/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/output-power-c-band/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/output-power-c-band/
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

/optical-amplifier/amplifiers/amplifier/state/output-power-c-band/
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

/optical-amplifier/amplifiers/amplifier/state/output-power-c-band/
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

/optical-amplifier/amplifiers/amplifier/state/
output-power-l-band

description:
The L band (consisting of approximately 184 to 191 THz or 1565 to 1625 nm)output optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/optical-amplifier/amplifiers/amplifier/state/output-power-l-band/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/output-power-l-band/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/output-power-l-band/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/output-power-l-band/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/output-power-l-band/
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

/optical-amplifier/amplifiers/amplifier/state/output-power-l-band/
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

/optical-amplifier/amplifiers/amplifier/state/output-power-l-band/
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

/optical-amplifier/amplifiers/amplifier/state/
laser-bias-current

description:
The current applied by the system to the transmit laser to achieve the output power. The current is expressed in mA with up to two decimal precision. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/optical-amplifier/amplifiers/amplifier/state/laser-bias-current/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: mA

/optical-amplifier/amplifiers/amplifier/state/laser-bias-current/
avg

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

nodetype: leaf (ro)

type: decimal64

units: mA

/optical-amplifier/amplifiers/amplifier/state/laser-bias-current/
min

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

nodetype: leaf (ro)

type: decimal64

units: mA

/optical-amplifier/amplifiers/amplifier/state/laser-bias-current/
max

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

nodetype: leaf (ro)

type: decimal64

units: mA

/optical-amplifier/amplifiers/amplifier/state/laser-bias-current/
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

/optical-amplifier/amplifiers/amplifier/state/laser-bias-current/
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

/optical-amplifier/amplifiers/amplifier/state/laser-bias-current/
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

/optical-amplifier/amplifiers/amplifier/state/
optical-return-loss

description:
The optical return loss (ORL) is the ratio of the light reflected back into the port to the light launched out of the port. ORL is in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/optical-amplifier/amplifiers/amplifier/state/optical-return-loss/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/optical-return-loss/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/optical-return-loss/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/optical-return-loss/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/amplifiers/amplifier/state/optical-return-loss/
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

/optical-amplifier/amplifiers/amplifier/state/optical-return-loss/
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

/optical-amplifier/amplifiers/amplifier/state/optical-return-loss/
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

/optical-amplifier/
supervisory-channels

description:
Enclosing container for list of supervisory channels

nodetype: container (rw)

/optical-amplifier/supervisory-channels/
supervisory-channel

description:
List of supervisory channels

nodetype: list (rw)

list keys: [interface]

/optical-amplifier/supervisory-channels/supervisory-channel/
interface

description:
Reference to the interface of the supervisory channel

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/interface

/optical-amplifier/supervisory-channels/supervisory-channel/
config

description:
Configuration data for OSCs

nodetype: container (rw)

/optical-amplifier/supervisory-channels/supervisory-channel/config/
interface

description:
Reference to an OSC interface

nodetype: leaf (rw)

type: oc-if:base-interface-ref

/optical-amplifier/supervisory-channels/supervisory-channel/
state

description:
Operational state data for OSCs

nodetype: container (ro)

/optical-amplifier/supervisory-channels/supervisory-channel/state/
interface

description:
Reference to an OSC interface

nodetype: leaf (ro)

type: oc-if:base-interface-ref

/optical-amplifier/supervisory-channels/supervisory-channel/state/
input-power

description:
The input optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/optical-amplifier/supervisory-channels/supervisory-channel/state/input-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/supervisory-channels/supervisory-channel/state/input-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/supervisory-channels/supervisory-channel/state/input-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/supervisory-channels/supervisory-channel/state/input-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/supervisory-channels/supervisory-channel/state/input-power/
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

/optical-amplifier/supervisory-channels/supervisory-channel/state/input-power/
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

/optical-amplifier/supervisory-channels/supervisory-channel/state/input-power/
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

/optical-amplifier/supervisory-channels/supervisory-channel/state/
output-power

description:
The output optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/optical-amplifier/supervisory-channels/supervisory-channel/state/output-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/supervisory-channels/supervisory-channel/state/output-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/supervisory-channels/supervisory-channel/state/output-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/supervisory-channels/supervisory-channel/state/output-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-amplifier/supervisory-channels/supervisory-channel/state/output-power/
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

/optical-amplifier/supervisory-channels/supervisory-channel/state/output-power/
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

/optical-amplifier/supervisory-channels/supervisory-channel/state/output-power/
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

/optical-amplifier/supervisory-channels/supervisory-channel/state/
laser-bias-current

description:
The current applied by the system to the transmit laser to achieve the output power. The current is expressed in mA with up to one decimal precision. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/optical-amplifier/supervisory-channels/supervisory-channel/state/laser-bias-current/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: mA

/optical-amplifier/supervisory-channels/supervisory-channel/state/laser-bias-current/
avg

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

nodetype: leaf (ro)

type: decimal64

units: mA

/optical-amplifier/supervisory-channels/supervisory-channel/state/laser-bias-current/
min

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

nodetype: leaf (ro)

type: decimal64

units: mA

/optical-amplifier/supervisory-channels/supervisory-channel/state/laser-bias-current/
max

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

nodetype: leaf (ro)

type: decimal64

units: mA

/optical-amplifier/supervisory-channels/supervisory-channel/state/laser-bias-current/
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

/optical-amplifier/supervisory-channels/supervisory-channel/state/laser-bias-current/
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

/optical-amplifier/supervisory-channels/supervisory-channel/state/laser-bias-current/
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

/optical-amplifier/supervisory-channels/supervisory-channel/state/
output-frequency

description:
The frequency in MHz of the individual physical channel (e.g. ITU C50 - 195.0THz and would be reported as 195,000,000 MHz in this model). This attribute is not configurable on most client ports.

nodetype: leaf (ro)

type: oc-opt-types:frequency-type

openconfig-channel-monitor

openconfig-version: 0.4.0

Description

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

Imports

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

Data elements

/
channel-monitors

description:
Top-level container for optical channel monitors

nodetype: container (rw)

/channel-monitors/
channel-monitor

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

nodetype: list (rw)

list keys: [name]

/channel-monitors/channel-monitor/
name

description:
References the optical channel monitor name

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/channel-monitors/channel-monitor/
config

description:
Configuration data

nodetype: container (rw)

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

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

nodetype: leaf (rw)

type: leafref

  • path reference: /components/component/name

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

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

nodetype: leaf (rw)

type: leafref

  • path reference: /components/component/name

/channel-monitors/channel-monitor/
state

description:
Operational state data

nodetype: container (ro)

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

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

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

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

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

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/channel-monitors/channel-monitor/
channels

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

nodetype: container (rw)

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

description:
List of tuples describing the spectrum power distribution

nodetype: list (ro)

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

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

description:
Reference to the list key

nodetype: leaf (list key) (ro)

type: leafref

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

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

description:
Reference to the list key

nodetype: leaf (list key) (ro)

type: leafref

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

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

description:
Operational state data for spectrum power

nodetype: container (ro)

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

description:
Lower frequency of the specified spectrum power

nodetype: leaf (ro)

type: oc-opt-types:frequency-type

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

description:
Upper frequency of the specified spectrum power

nodetype: leaf (ro)

type: oc-opt-types:frequency-type

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

description:
Average measured optical power over the specified spectrum

nodetype: leaf (ro)

type: decimal64

units: dBm

openconfig-platform

openconfig-version: 0.22.0

Description

This module defines a data model for representing a system component inventory, which can include hardware or software elements arranged in an arbitrary structure. The primary relationship supported by the model is containment, e.g., components containing subcomponents.

It is expected that this model reflects every field replacable unit on the device at a minimum (i.e., additional information may be supplied about non-replacable components).

Every element in the inventory is termed a 'component' with each component expected to have a unique name and type, and optionally a unique system-assigned identifier and FRU number. The uniqueness is guaranteed by the system within the device.

Components may have properties defined by the system that are modeled as a list of key-value pairs. These may or may not be user-configurable. The model provides a flag for the system to optionally indicate which properties are user configurable.

Each component also has a list of 'subcomponents' which are references to other components. Appearance in a list of subcomponents indicates a containment relationship as described above. For example, a linecard component may have a list of references to port components that reside on the linecard.

This schema is generic to allow devices to express their own platform-specific structure. It may be augmented by additional component type-specific schemas that provide a common structure for well-known component types. In these cases, the system is expected to populate the common component schema, and may optionally also represent the component and its properties in the generic structure.

The properties for each component may include dynamic values, e.g., in the 'state' part of the schema. For example, a CPU component may report its utilization, temperature, or other physical properties. The intent is to capture all platform- specific physical data in one location, including inventory (presence or absence of a component) and state (physical attributes or status).

Imports

openconfig-platform-types
openconfig-extensions
openconfig-alarm-types
openconfig-yang-types
openconfig-types

Data elements

/
components

description:
Enclosing container for the components in the system.

nodetype: container (rw)

/components/
component

description:
List of components, keyed by component name.

nodetype: list (rw)

list keys: [name]

/components/component/
name

description:
References the component name

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/components/component/
config

description:
Configuration data for each component

nodetype: container (rw)

/components/component/config/
name

description:
Device name for the component -- this may not be a configurable parameter on many implementations. Where component preconfiguration is supported, for example, the component name may be configurable.

nodetype: leaf (rw)

type: string

/components/component/
state

description:
Operational state data for each component

nodetype: container (ro)

/components/component/state/
name

description:
Device name for the component -- this may not be a configurable parameter on many implementations. Where component preconfiguration is supported, for example, the component name may be configurable.

nodetype: leaf (ro)

type: string

/components/component/state/
type

description:
Type of component as identified by the system

nodetype: leaf (ro)

type: union

    type: identityref

    • base: oc-platform-types:OPENCONFIG_HARDWARE_COMPONENT

    type: identityref

    • base: oc-platform-types:OPENCONFIG_SOFTWARE_COMPONENT

/components/component/state/
id

description:
Unique identifier assigned by the system for the component

nodetype: leaf (ro)

type: string

/components/component/state/
location

description:
System-supplied description of the location of the component within the system. This could be a bay position, slot number, socket location, etc. For component types that have an explicit slot-id attribute, such as linecards, the system should populate the more specific slot-id.

nodetype: leaf (ro)

type: string

/components/component/state/
description

description:
System-supplied description of the component

nodetype: leaf (ro)

type: string

/components/component/state/
mfg-name

description:
System-supplied identifier for the manufacturer of the component. This data is particularly useful when a component manufacturer is different than the overall device vendor.

nodetype: leaf (ro)

type: string

/components/component/state/
mfg-date

description:
System-supplied representation of the component's manufacturing date.

nodetype: leaf (ro)

type: oc-yang:date

/components/component/state/
hardware-version

description:
For hardware components, this is the hardware revision of the component.

nodetype: leaf (ro)

type: string

/components/component/state/
firmware-version

description:
For hardware components, this is the version of associated firmware that is running on the component, if applicable.

nodetype: leaf (ro)

type: string

/components/component/state/
software-version

description:
For software components such as operating system or other software module, this is the version of the currently running software.

nodetype: leaf (ro)

type: string

/components/component/state/
serial-no

description:
System-assigned serial number of the component.

nodetype: leaf (ro)

type: string

/components/component/state/
part-no

description:
System-assigned part number for the component. This should be present in particular if the component is also an FRU (field replaceable unit)

nodetype: leaf (ro)

type: string

/components/component/state/
clei-code

description:
Common Language Equipment Identifier (CLEI) code of the component. This should be present in particular if the component is also an FRU (field replaceable unit)

nodetype: leaf (ro)

type: string

/components/component/state/
removable

description:
If true, this component is removable or is a field replaceable unit

nodetype: leaf (ro)

type: boolean

/components/component/state/
oper-status

description:
If applicable, this reports the current operational status of the component.

nodetype: leaf (ro)

type: identityref

  • base: oc-platform-types:COMPONENT_OPER_STATUS

/components/component/state/
empty

description:
The empty leaf may be used by the device to indicate that a component position exists but is not populated. Using this flag, it is possible for the management system to learn how many positions are available (e.g., occupied vs. empty linecard slots in a chassis).

nodetype: leaf (ro)

type: boolean

default: false

/components/component/state/
parent

description:
Reference to the name of the parent component. Note that this reference must be kept synchronized with the corresponding subcomponent reference from the parent component.

nodetype: leaf (ro)

type: leafref

  • path reference: ../../../component/config/name

/components/component/state/
redundant-role

description:
For components that have redundant roles (e.g. two supervisors in a device, one as primary the other as secondary), this reports the role of the component.

nodetype: leaf (ro)

type: oc-platform-types:component-redundant-role

/components/component/state/
last-switchover-reason

description:
For components that have redundant roles (e.g. two supervisors in a device, one as primary the other as secondary), this reports the reason of the last change of the component's role.

nodetype: container (ro)

/components/component/state/last-switchover-reason/
trigger

description:
Records the generic triggers, e.g. user or system initiated the switchover.

nodetype: leaf (ro)

type: component-redundant-role-switchover-reason-trigger

/components/component/state/last-switchover-reason/
details

description:
Records detailed description of why the switchover happens. For example, when system initiated the switchover, this leaf can be used to record the specific reason, e.g. due to critical errors of the routing daemon in the primary role.

nodetype: leaf (ro)

type: string

/components/component/state/
last-switchover-time

description:
For components that have redundant roles (e.g. two supervisors in a device, one as primary the other as secondary), this reports the time of the last change of the component's role. 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

units: nanoseconds

/components/component/state/
last-reboot-reason

description:
This reports the reason of the last reboot of the component.

nodetype: leaf (ro)

type: identityref

  • base: oc-platform-types:COMPONENT_REBOOT_REASON

/components/component/state/
last-reboot-time

description:
This reports the time of the last reboot of the component. 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

units: nanoseconds

/components/component/state/
switchover-ready

description:
For components that have redundant roles, this reports a value that indicates if the component is ready to support failover. The components with a redundant-role should reflect the overall system's switchover status. For example, two supervisors in a device, one as primary and the other as secondary, should both report the same value.

nodetype: leaf (ro)

type: boolean

/components/component/state/
base-mac-address

description:
This is a MAC address representing the root or primary MAC address for a component. Components such as CHASSIS and CONTROLLER_CARD are expected to provide a base-mac-address. The base mac-address for CHASSIS and a PRIMARY CONTROLLER_CARD may contain the same value.

nodetype: leaf (ro)

type: oc-yang:mac-address

/components/component/state/
temperature

description:
Temperature in degrees Celsius of the component. 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)

/components/component/state/temperature/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/state/temperature/
avg

description:
The arithmetic mean value of the statistic over the sampling period.

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/state/temperature/
min

description:
The minimum value of the statistic over the sampling period

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/state/temperature/
max

description:
The maximum value of the statistic over the sampling period

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/state/temperature/
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

/components/component/state/temperature/
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

/components/component/state/temperature/
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

/components/component/state/temperature/
alarm-status

description:
A value of true indicates the alarm has been raised or asserted. The value should be false when the alarm is cleared.

nodetype: leaf (ro)

type: boolean

/components/component/state/temperature/
alarm-threshold

description:
The threshold value that was crossed for this alarm.

nodetype: leaf (ro)

type: uint32

/components/component/state/temperature/
alarm-severity

description:
The severity of the current alarm.

nodetype: leaf (ro)

type: identityref

  • base: oc-alarm-types:OPENCONFIG_ALARM_SEVERITY

/components/component/state/
memory

description:
For components that have associated memory, these values report information about available and utilized memory.

nodetype: container (ro)

/components/component/state/memory/
available

description:
The available memory physically installed, or logically allocated to the component.

nodetype: leaf (ro)

type: uint64

units: bytes

/components/component/state/memory/
utilized

description:
The memory currently in use by processes running on the component, not considering reserved memory that is not available for use.

nodetype: leaf (ro)

type: uint64

units: bytes

/components/component/state/
allocated-power

description:
Power allocated by the system for the component.

nodetype: leaf (ro)

type: uint32

units: watts

/components/component/state/
used-power

description:
Actual power used by the component.

nodetype: leaf (ro)

type: uint32

units: watts

/components/component/state/
pcie

description:
Components that are connected to the system over the Peripheral Component Interconnect Express (PCIe), report the fatal, non-fatal and correctable PCIe error counts.

nodetype: container (ro)

/components/component/state/pcie/
fatal-errors

description:
The count of the fatal PCIe errors.

nodetype: container (ro)

/components/component/state/pcie/fatal-errors/
total-errors

description:
Total number of uncorrectable errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
undefined-errors

description:
Number of undefined errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

description:
Number of data-link errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
surprise-down-errors

description:
Number of unexpected link down errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
poisoned-tlp-errors

description:
Number of poisoned TLP errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
flow-control-protocol-errors

description:
Number of flow control protocol errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
completion-timeout-errors

description:
Number of completion timeout errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
completion-abort-errors

description:
Number of completion abort errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
unexpected-completion-errors

description:
Number of unexpected completion errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
receiver-overflow-errors

description:
Number of receiver overflow errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
malformed-tlp-errors

description:
Number of malformed TLP errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
ecrc-errors

description:
Number of ECRC errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
unsupported-request-errors

description:
Number of unsupported request errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
acs-violation-errors

description:
Number of access control errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
internal-errors

description:
Number of internal errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
blocked-tlp-errors

description:
Number of blocked TLP errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
atomic-op-blocked-errors

description:
Number of atomic operation blocked errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/fatal-errors/
tlp-prefix-blocked-errors

description:
Number of TLP prefix blocked errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/
non-fatal-errors

description:
The count of the non-fatal PCIe errors.

nodetype: container (ro)

/components/component/state/pcie/non-fatal-errors/
total-errors

description:
Total number of uncorrectable errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
undefined-errors

description:
Number of undefined errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

description:
Number of data-link errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
surprise-down-errors

description:
Number of unexpected link down errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
poisoned-tlp-errors

description:
Number of poisoned TLP errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
flow-control-protocol-errors

description:
Number of flow control protocol errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
completion-timeout-errors

description:
Number of completion timeout errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
completion-abort-errors

description:
Number of completion abort errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
unexpected-completion-errors

description:
Number of unexpected completion errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
receiver-overflow-errors

description:
Number of receiver overflow errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
malformed-tlp-errors

description:
Number of malformed TLP errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
ecrc-errors

description:
Number of ECRC errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
unsupported-request-errors

description:
Number of unsupported request errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
acs-violation-errors

description:
Number of access control errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
internal-errors

description:
Number of internal errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
blocked-tlp-errors

description:
Number of blocked TLP errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
atomic-op-blocked-errors

description:
Number of atomic operation blocked errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/non-fatal-errors/
tlp-prefix-blocked-errors

description:
Number of TLP prefix blocked errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/
correctable-errors

description:
The count of the correctable PCIe errors.

nodetype: container (ro)

/components/component/state/pcie/correctable-errors/
total-errors

description:
Total number of correctable errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
receiver-errors

description:
Number of receiver errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
bad-tlp-errors

description:
Number of TLPs with bad LCRC detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
bad-dllp-errors

description:
Number of DLLPs with bad LCRC detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
relay-rollover-errors

description:
Number of relay rollover errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
replay-timeout-errors

description:
Number of replay timeout errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
advisory-non-fatal-errors

description:
Number of advisory non fatal errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
internal-errors

description:
Number of internal errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/state/pcie/correctable-errors/
hdr-log-overflow-errors

description:
Number of header log overflow errors detected by PCIe device since the system booted, according to PCIe AER driver.

nodetype: leaf (ro)

type: oc-yang:counter64

/components/component/
properties

description:
Enclosing container

nodetype: container (rw)

/components/component/properties/
property

description:
List of system properties for the component

nodetype: list (rw)

list keys: [name]

/components/component/properties/property/
name

description:
Reference to the property name.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/components/component/properties/property/
config

description:
Configuration data for each property

nodetype: container (rw)

/components/component/properties/property/config/
name

description:
System-supplied name of the property -- this is typically non-configurable

nodetype: leaf (rw)

type: string

/components/component/properties/property/config/
value

description:
Property values can take on a variety of types. Signed and unsigned integer types may be provided in smaller sizes, e.g., int8, uint16, etc.

nodetype: leaf (rw)

type: union

    type: string

    type: boolean

    type: int64

    type: uint64

    type: decimal64

/components/component/properties/property/
state

description:
Operational state data for each property

nodetype: container (ro)

/components/component/properties/property/state/
name

description:
System-supplied name of the property -- this is typically non-configurable

nodetype: leaf (ro)

type: string

/components/component/properties/property/state/
value

description:
Property values can take on a variety of types. Signed and unsigned integer types may be provided in smaller sizes, e.g., int8, uint16, etc.

nodetype: leaf (ro)

type: union

    type: string

    type: boolean

    type: int64

    type: uint64

    type: decimal64

/components/component/properties/property/state/
configurable

description:
Indication whether the property is user-configurable

nodetype: leaf (ro)

type: boolean

/components/component/
subcomponents

description:
Enclosing container for subcomponent references

nodetype: container (rw)

/components/component/subcomponents/
subcomponent

description:
List of subcomponent references

nodetype: list (rw)

list keys: [name]

/components/component/subcomponents/subcomponent/
name

description:
Reference to the name list key

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/components/component/subcomponents/subcomponent/
config

description:
Configuration data for the subcomponent

nodetype: container (rw)

/components/component/subcomponents/subcomponent/config/
name

description:
Reference to the name of the subcomponent

nodetype: leaf (rw)

type: leafref

  • path reference: ../../../../../component/config/name

/components/component/subcomponents/subcomponent/
state

description:
Operational state data for the subcomponent

nodetype: container (ro)

/components/component/subcomponents/subcomponent/state/
name

description:
Reference to the name of the subcomponent

nodetype: leaf (ro)

type: leafref

  • path reference: ../../../../../component/config/name

/components/component/
chassis

description:
Data for chassis components

nodetype: container (rw)

/components/component/chassis/
config

description:
Configuration data for chassis components

nodetype: container (rw)

/components/component/chassis/
state

description:
Operational state data for chassis components

nodetype: container (ro)

/components/component/chassis/
utilization

description:
Utilization of the component.

nodetype: container (rw)

/components/component/chassis/utilization/
resources

description:
Enclosing container for the resources in this component.

nodetype: container (rw)

/components/component/chassis/utilization/resources/
resource

description:
List of resources, keyed by resource name.

nodetype: list (rw)

list keys: [name]

/components/component/chassis/utilization/resources/resource/
name

description:
References the resource name.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/components/component/chassis/utilization/resources/resource/
config

description:
Configuration data for each resource.

nodetype: container (rw)

/components/component/chassis/utilization/resources/resource/config/
name

description:
Resource name within the component.

nodetype: leaf (rw)

type: string

/components/component/chassis/utilization/resources/resource/config/
used-threshold-upper

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'true'.

nodetype: leaf (rw)

type: oc-types:percentage

/components/component/chassis/utilization/resources/resource/config/
used-threshold-upper-clear

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'false'.

nodetype: leaf (rw)

type: oc-types:percentage

/components/component/chassis/utilization/resources/resource/
state

description:
Operational state data for each resource.

nodetype: container (ro)

/components/component/chassis/utilization/resources/resource/state/
name

description:
Resource name within the component.

nodetype: leaf (ro)

type: string

/components/component/chassis/utilization/resources/resource/state/
used-threshold-upper

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'true'.

nodetype: leaf (ro)

type: oc-types:percentage

/components/component/chassis/utilization/resources/resource/state/
used-threshold-upper-clear

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'false'.

nodetype: leaf (ro)

type: oc-types:percentage

/components/component/chassis/utilization/resources/resource/state/
used

description:
Number of entries currently in use for the resource.

nodetype: leaf (ro)

type: uint64

/components/component/chassis/utilization/resources/resource/state/
committed

description:
Number of entries currently reserved for this resource. This is only relevant to tables which allocate a block of resource for a given feature.

nodetype: leaf (ro)

type: uint64

/components/component/chassis/utilization/resources/resource/state/
free

description:
Number of entries available to use.

nodetype: leaf (ro)

type: uint64

/components/component/chassis/utilization/resources/resource/state/
max-limit

description:
Maximum number of entries available for the resource. The value is the theoretical maximum resource utilization possible.

nodetype: leaf (ro)

type: uint64

/components/component/chassis/utilization/resources/resource/state/
high-watermark

description:
A watermark of highest number of entries used for this resource.

nodetype: leaf (ro)

type: uint64

/components/component/chassis/utilization/resources/resource/state/
last-high-watermark

description:
The timestamp when the high-watermark was last updated. 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

/components/component/chassis/utilization/resources/resource/state/
used-threshold-upper-exceeded

description:
This value is set to true when the used percentage value (used / (used + free) * 100) has crossed the used-threshold-upper for this resource and false when the used percentage value has crossed the configured used-threshold-upper-clear value for this resource.

nodetype: leaf (ro)

type: boolean

/components/component/
port

description:
Data for physical port components

nodetype: container (rw)

/components/component/port/
config

description:
Configuration data for physical port components

nodetype: container (rw)

/components/component/port/
state

description:
Operational state data for physical port components

nodetype: container (ro)

/components/component/port/
breakout-mode

description:
Top-level container for port breakout-mode data.

nodetype: container (rw)

/components/component/port/breakout-mode/
groups

description:
Top level container for breakout groups data. When a device has the capability to break a port into interfaces of different speeds and different number of physical channels, it can breakout a 400G OSFP port with 8 physical channels (with support for 25G NRZ, 50G PAM4 and 100G PAM4) in the following configuration: 100G + 100G + 200G -> 1 interface with 2 physical channels and 1 interface with 4 physical channels and 1 interface with 2 physical channels. With this configuration the interface in 1st breakout group would use 50G PAM4 modulation, interface in 2nd breakout group would use 25G NRZ modulation and the interface in 3rd breakout group would use 100G PAM4 modulation This configuration would result in 3 entries in the breakout groups list. When a device does not have the capability to break a port into interfaces of different speeds and different number of physical channels, it would breakout a 400G OSFP port with 8 physical channels in the following configuration: 50G -> 8 interfaces with 1 physical channel each, this would result in 1 entry in the breakout groups list.

nodetype: container (rw)

/components/component/port/breakout-mode/groups/
group

description:
List of breakout groups.

nodetype: list (rw)

list keys: [index]

/components/component/port/breakout-mode/groups/group/
index

description:
Index of the breakout group entry in the breakout groups list.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/index

/components/component/port/breakout-mode/groups/group/
config

description:
Configuration data for breakout group.

nodetype: container (rw)

/components/component/port/breakout-mode/groups/group/config/
index

description:
Each index specifies breakouts that are identical in terms of speed and the number of physical channels.

nodetype: leaf (rw)

type: uint8

/components/component/port/breakout-mode/groups/group/config/
num-breakouts

description:
Sets the number of interfaces using this breakout group.

nodetype: leaf (rw)

type: uint8

/components/component/port/breakout-mode/groups/group/config/
breakout-speed

description:
Speed of interfaces in this breakout group, supported values are defined by the ETHERNET_SPEED identity.

nodetype: leaf (rw)

type: identityref

  • base: oc-eth:ETHERNET_SPEED

/components/component/port/breakout-mode/groups/group/config/
num-physical-channels

description:
Sets the number of lanes or physical channels assigned to the interfaces in this breakout group. This leaf need not be set if there is only one breakout group where all the interfaces are of equal speed and have equal number of physical channels

nodetype: leaf (rw)

type: uint8

/components/component/port/breakout-mode/groups/group/
state

description:
Operational state data for breakout group.

nodetype: container (ro)

/components/component/port/breakout-mode/groups/group/state/
index

description:
Each index specifies breakouts that are identical in terms of speed and the number of physical channels.

nodetype: leaf (ro)

type: uint8

/components/component/port/breakout-mode/groups/group/state/
num-breakouts

description:
Sets the number of interfaces using this breakout group.

nodetype: leaf (ro)

type: uint8

/components/component/port/breakout-mode/groups/group/state/
breakout-speed

description:
Speed of interfaces in this breakout group, supported values are defined by the ETHERNET_SPEED identity.

nodetype: leaf (ro)

type: identityref

  • base: oc-eth:ETHERNET_SPEED

/components/component/port/breakout-mode/groups/group/state/
num-physical-channels

description:
Sets the number of lanes or physical channels assigned to the interfaces in this breakout group. This leaf need not be set if there is only one breakout group where all the interfaces are of equal speed and have equal number of physical channels

nodetype: leaf (ro)

type: uint8

/components/component/port/
optical-port

description:
Contains data specific to ports on optical transport devices.

nodetype: container (rw)

/components/component/port/optical-port/
config

description:
Operational config data for optical ports

nodetype: container (rw)

/components/component/port/optical-port/config/
admin-state

description:
Sets the admin state of the optical-port

nodetype: leaf (rw)

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

/components/component/port/optical-port/
state

description:
Operational state data for optical ports

nodetype: container (ro)

/components/component/port/optical-port/state/
admin-state

description:
Sets the admin state of the optical-port

nodetype: leaf (ro)

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

/components/component/port/optical-port/state/
optical-port-type

description:
For physical ports belonging to optical transport devices, this indicates the type of optical port. This is an informational field that should be made available by the device.

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:OPTICAL_PORT_TYPE

/components/component/port/optical-port/state/
tilt

description:
The total tilt measured on the port. This is applicable to ports of type INGRESS and EGRESS.

nodetype: leaf (ro)

type: decimal64

units: dB

/components/component/port/optical-port/state/
input-power

description:
For line system device ports, this value indicates the total input optical power of the port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/components/component/port/optical-port/state/input-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/port/optical-port/state/input-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/port/optical-port/state/input-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/port/optical-port/state/input-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/port/optical-port/state/input-power/
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

/components/component/port/optical-port/state/input-power/
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

/components/component/port/optical-port/state/input-power/
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

/components/component/port/optical-port/state/
output-power

description:
For line system device ports, this value indicates the total output optical power of the port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/components/component/port/optical-port/state/output-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/port/optical-port/state/output-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/port/optical-port/state/output-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/port/optical-port/state/output-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/port/optical-port/state/output-power/
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

/components/component/port/optical-port/state/output-power/
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

/components/component/port/optical-port/state/output-power/
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

/components/component/
power-supply

description:
Data for power supply components

nodetype: container (rw)

/components/component/power-supply/
config

description:
Configuration data for power supply components

nodetype: container (rw)

/components/component/power-supply/
state

description:
Operational state data for power supply components

nodetype: container (ro)

/components/component/
fan

description:
Data for fan components

nodetype: container (rw)

/components/component/fan/
config

description:
Configuration data for fan components

nodetype: container (rw)

/components/component/fan/
state

description:
Operational state data for fan components

nodetype: container (ro)

/components/component/
fabric

description:
Data for fabric components

nodetype: container (rw)

/components/component/fabric/
config

description:
Configuration data for fabric components

nodetype: container (rw)

/components/component/fabric/
state

description:
Operational state data for fabric components

nodetype: container (ro)

/components/component/
storage

description:
Data for storage components

nodetype: container (rw)

/components/component/storage/
config

description:
Configuration data for storage components

nodetype: container (rw)

/components/component/storage/
state

description:
Operational state data for storage components

nodetype: container (ro)

/components/component/
cpu

description:
Data for cpu components

nodetype: container (rw)

/components/component/cpu/
config

description:
Configuration data for cpu components

nodetype: container (rw)

/components/component/cpu/
state

description:
Operational state data for cpu components

nodetype: container (ro)

/components/component/
integrated-circuit

description:
Data for chip components, such as ASIC, NPUs, etc.

nodetype: container (rw)

/components/component/integrated-circuit/
config

description:
Configuration data for chip components

nodetype: container (rw)

/components/component/integrated-circuit/
state

description:
Operational state data for chip components

nodetype: container (ro)

/components/component/integrated-circuit/
utilization

description:
Utilization of the component.

nodetype: container (rw)

/components/component/integrated-circuit/utilization/
resources

description:
Enclosing container for the resources in this component.

nodetype: container (rw)

/components/component/integrated-circuit/utilization/resources/
resource

description:
List of resources, keyed by resource name.

nodetype: list (rw)

list keys: [name]

/components/component/integrated-circuit/utilization/resources/resource/
name

description:
References the resource name.

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/components/component/integrated-circuit/utilization/resources/resource/
config

description:
Configuration data for each resource.

nodetype: container (rw)

/components/component/integrated-circuit/utilization/resources/resource/config/
name

description:
Resource name within the component.

nodetype: leaf (rw)

type: string

/components/component/integrated-circuit/utilization/resources/resource/config/
used-threshold-upper

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'true'.

nodetype: leaf (rw)

type: oc-types:percentage

/components/component/integrated-circuit/utilization/resources/resource/config/
used-threshold-upper-clear

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'false'.

nodetype: leaf (rw)

type: oc-types:percentage

/components/component/integrated-circuit/utilization/resources/resource/
state

description:
Operational state data for each resource.

nodetype: container (ro)

/components/component/integrated-circuit/utilization/resources/resource/state/
name

description:
Resource name within the component.

nodetype: leaf (ro)

type: string

/components/component/integrated-circuit/utilization/resources/resource/state/
used-threshold-upper

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'true'.

nodetype: leaf (ro)

type: oc-types:percentage

/components/component/integrated-circuit/utilization/resources/resource/state/
used-threshold-upper-clear

description:
The used percentage value (used / (used + free) * 100) that when crossed will set utilization-threshold-exceeded to 'false'.

nodetype: leaf (ro)

type: oc-types:percentage

/components/component/integrated-circuit/utilization/resources/resource/state/
used

description:
Number of entries currently in use for the resource.

nodetype: leaf (ro)

type: uint64

/components/component/integrated-circuit/utilization/resources/resource/state/
committed

description:
Number of entries currently reserved for this resource. This is only relevant to tables which allocate a block of resource for a given feature.

nodetype: leaf (ro)

type: uint64

/components/component/integrated-circuit/utilization/resources/resource/state/
free

description:
Number of entries available to use.

nodetype: leaf (ro)

type: uint64

/components/component/integrated-circuit/utilization/resources/resource/state/
max-limit

description:
Maximum number of entries available for the resource. The value is the theoretical maximum resource utilization possible.

nodetype: leaf (ro)

type: uint64

/components/component/integrated-circuit/utilization/resources/resource/state/
high-watermark

description:
A watermark of highest number of entries used for this resource.

nodetype: leaf (ro)

type: uint64

/components/component/integrated-circuit/utilization/resources/resource/state/
last-high-watermark

description:
The timestamp when the high-watermark was last updated. 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

/components/component/integrated-circuit/utilization/resources/resource/state/
used-threshold-upper-exceeded

description:
This value is set to true when the used percentage value (used / (used + free) * 100) has crossed the used-threshold-upper for this resource and false when the used percentage value has crossed the configured used-threshold-upper-clear value for this resource.

nodetype: leaf (ro)

type: boolean

/components/component/
backplane

description:
Data for backplane components

nodetype: container (rw)

/components/component/backplane/
config

description:
Configuration data for backplane components

nodetype: container (rw)

/components/component/backplane/
state

description:
Operational state data for backplane components

nodetype: container (ro)

/components/component/
software-module

description:
Data for software module components, i.e., for components with type=SOFTWARE_MODULE

nodetype: container (rw)

/components/component/software-module/
config

description:
Configuration data for software module components

nodetype: container (rw)

/components/component/software-module/
state

description:
Operational state data for software module components

nodetype: container (ro)

/components/component/
controller-card

description:
Data for controller card components, i.e., for components with type=CONTROLLER_CARD

nodetype: container (rw)

/components/component/controller-card/
config

description:
Configuration data for controller card components. Note that disabling power to the primary supervisor should be rejected, and the operator is required to perform a switchover first.

nodetype: container (rw)

/components/component/controller-card/
state

description:
Operational state data for controller card components

nodetype: container (ro)

/components/component/
transceiver

description:
Top-level container for client port transceiver data

nodetype: container (rw)

/components/component/transceiver/
config

description:
Configuration data for client port transceivers

nodetype: container (rw)

/components/component/transceiver/config/
enabled

description:
Turns power on / off to the transceiver -- provides a means to power on/off the transceiver (in the case of SFP, SFP+, QSFP,...) or enable high-power mode (in the case of CFP, CFP2, CFP4) and is optionally supported (device can choose to always enable). True = power on / high power, False = powered off

nodetype: leaf (rw)

type: boolean

/components/component/transceiver/config/
form-factor-preconf

description:
Indicates the type of optical transceiver used on this port. If the client port is built into the device and not pluggable, then non-pluggable is the corresponding state. If a device port supports multiple form factors (e.g. QSFP28 and QSFP+, then the value of the transceiver installed shall be reported. If no transceiver is present, then the value of the highest rate form factor shall be reported (QSFP28, for example). The form factor is included in configuration data to allow pre-configuring a device with the expected type of transceiver ahead of deployment. The corresponding state leaf should reflect the actual transceiver type plugged into the system.

nodetype: leaf (rw)

type: identityref

  • base: oc-opt-types:TRANSCEIVER_FORM_FACTOR_TYPE

/components/component/transceiver/config/
ethernet-pmd-preconf

description:
The Ethernet PMD is a property of the optical transceiver used on the port, indicating the type of physical connection. It is included in configuration data to allow pre-configuring a port/transceiver with the expected PMD. The actual PMD is indicated by the ethernet-pmd state leaf.

nodetype: leaf (rw)

type: identityref

  • base: oc-opt-types:ETHERNET_PMD_TYPE

/components/component/transceiver/config/
fec-mode

description:
The FEC mode indicates the mode of operation for the transceiver's FEC. This defines typical operational modes and does not aim to specify more granular FEC capabilities.

nodetype: leaf (rw)

type: identityref

  • base: oc-platform-types:FEC_MODE_TYPE

/components/component/transceiver/config/
module-functional-type

description:
Indicates the module functional type which represents the functional capability of the transceiver. For example, this would specify the module is a digital coherent optic or a standard grey optic that performs on-off keying.

nodetype: leaf (rw)

type: identityref

  • base: oc-opt-types:TRANSCEIVER_MODULE_FUNCTIONAL_TYPE

/components/component/transceiver/
state

description:
Operational state data for client port transceivers

nodetype: container (ro)

/components/component/transceiver/state/
enabled

description:
Turns power on / off to the transceiver -- provides a means to power on/off the transceiver (in the case of SFP, SFP+, QSFP,...) or enable high-power mode (in the case of CFP, CFP2, CFP4) and is optionally supported (device can choose to always enable). True = power on / high power, False = powered off

nodetype: leaf (ro)

type: boolean

/components/component/transceiver/state/
form-factor-preconf

description:
Indicates the type of optical transceiver used on this port. If the client port is built into the device and not pluggable, then non-pluggable is the corresponding state. If a device port supports multiple form factors (e.g. QSFP28 and QSFP+, then the value of the transceiver installed shall be reported. If no transceiver is present, then the value of the highest rate form factor shall be reported (QSFP28, for example). The form factor is included in configuration data to allow pre-configuring a device with the expected type of transceiver ahead of deployment. The corresponding state leaf should reflect the actual transceiver type plugged into the system.

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:TRANSCEIVER_FORM_FACTOR_TYPE

/components/component/transceiver/state/
ethernet-pmd-preconf

description:
The Ethernet PMD is a property of the optical transceiver used on the port, indicating the type of physical connection. It is included in configuration data to allow pre-configuring a port/transceiver with the expected PMD. The actual PMD is indicated by the ethernet-pmd state leaf.

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:ETHERNET_PMD_TYPE

/components/component/transceiver/state/
fec-mode

description:
The FEC mode indicates the mode of operation for the transceiver's FEC. This defines typical operational modes and does not aim to specify more granular FEC capabilities.

nodetype: leaf (ro)

type: identityref

  • base: oc-platform-types:FEC_MODE_TYPE

/components/component/transceiver/state/
module-functional-type

description:
Indicates the module functional type which represents the functional capability of the transceiver. For example, this would specify the module is a digital coherent optic or a standard grey optic that performs on-off keying.

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:TRANSCEIVER_MODULE_FUNCTIONAL_TYPE

/components/component/transceiver/state/
present

description:
Indicates whether a transceiver is present in the specified client port.

nodetype: leaf (ro)

type: enumeration

  • PRESENT
    Transceiver is present on the port
  • NOT_PRESENT
    Transceiver is not present on the port

/components/component/transceiver/state/
form-factor

description:
Indicates the type of optical transceiver used on this port. If the client port is built into the device and not pluggable, then non-pluggable is the corresponding state. If a device port supports multiple form factors (e.g. QSFP28 and QSFP+, then the value of the transceiver installed shall be reported. If no transceiver is present, then the value of the highest rate form factor shall be reported (QSFP28, for example).

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:TRANSCEIVER_FORM_FACTOR_TYPE

/components/component/transceiver/state/
connector-type

description:
Connector type used on this port

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:FIBER_CONNECTOR_TYPE

/components/component/transceiver/state/
vendor

description:
Full name of transceiver vendor. 16-octet field that contains ASCII characters, left-aligned and padded on the right with ASCII spaces (20h)

nodetype: leaf (ro)

type: string

/components/component/transceiver/state/
vendor-part

description:
Transceiver vendor's part number. 16-octet field that contains ASCII characters, left-aligned and padded on the right with ASCII spaces (20h). If part number is undefined, all 16 octets = 0h

nodetype: leaf (ro)

type: string

/components/component/transceiver/state/
vendor-rev

description:
Transceiver vendor's revision number. 2-octet field that contains ASCII characters, left-aligned and padded on the right with ASCII spaces (20h)

nodetype: leaf (ro)

type: string

/components/component/transceiver/state/
ethernet-pmd

description:
Ethernet PMD (physical medium dependent sublayer) that the transceiver supports. The SFF/QSFP MSAs have registers for this and CFP MSA has similar.

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:ETHERNET_PMD_TYPE

/components/component/transceiver/state/
sonet-sdh-compliance-code

description:
SONET/SDH application code supported by the port

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:SONET_APPLICATION_CODE

/components/component/transceiver/state/
otn-compliance-code

description:
OTN application code supported by the port

nodetype: leaf (ro)

type: identityref

  • base: oc-opt-types:OTN_APPLICATION_CODE

/components/component/transceiver/state/
serial-no

description:
Transceiver serial number. 16-octet field that contains ASCII characters, left-aligned and padded on the right with ASCII spaces (20h). If part serial number is undefined, all 16 octets = 0h

nodetype: leaf (ro)

type: string

/components/component/transceiver/state/
date-code

description:
Representation of the transceiver date code, typically stored as YYMMDD. The time portion of the value is undefined and not intended to be read.

nodetype: leaf (ro)

type: oc-yang:date-and-time

/components/component/transceiver/state/
fault-condition

description:
Indicates if a fault condition exists in the transceiver

nodetype: leaf (ro)

type: boolean

/components/component/transceiver/state/
fec-status

description:
Operational status of FEC

nodetype: leaf (ro)

type: identityref

  • base: oc-platform-types:FEC_STATUS_TYPE

/components/component/transceiver/state/
fec-uncorrectable-blocks

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

nodetype: leaf (ro)

type: yang:counter64

/components/component/transceiver/state/
fec-uncorrectable-words

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

nodetype: leaf (ro)

type: yang:counter64

/components/component/transceiver/state/
fec-corrected-bytes

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

nodetype: leaf (ro)

type: yang:counter64

/components/component/transceiver/state/
fec-corrected-bits

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

nodetype: leaf (ro)

type: yang:counter64

/components/component/transceiver/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)

/components/component/transceiver/state/pre-fec-ber/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/components/component/transceiver/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

/components/component/transceiver/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

/components/component/transceiver/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

/components/component/transceiver/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

/components/component/transceiver/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

/components/component/transceiver/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

/components/component/transceiver/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)

/components/component/transceiver/state/post-fec-ber/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: bit-errors-per-second

/components/component/transceiver/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

/components/component/transceiver/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

/components/component/transceiver/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

/components/component/transceiver/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

/components/component/transceiver/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

/components/component/transceiver/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

/components/component/transceiver/state/
supply-voltage

description:
Supply voltage to the transceiver in volts with 2 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)

/components/component/transceiver/state/supply-voltage/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: volts

/components/component/transceiver/state/supply-voltage/
avg

description:
The arithmetic mean value of the statistic over the sampling period.

nodetype: leaf (ro)

type: decimal64

units: volts

/components/component/transceiver/state/supply-voltage/
min

description:
The minimum value of the statistic over the sampling period

nodetype: leaf (ro)

type: decimal64

units: volts

/components/component/transceiver/state/supply-voltage/
max

description:
The maximum value of the statistic over the sampling period

nodetype: leaf (ro)

type: decimal64

units: volts

/components/component/transceiver/state/supply-voltage/
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

/components/component/transceiver/state/supply-voltage/
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

/components/component/transceiver/state/supply-voltage/
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

/components/component/transceiver/state/
output-power

description:
The output optical power of a physical channel in units of 0.01dBm, which may be associated with individual physical channels, or an aggregate of multiple physical channels (i.e., for the overall transceiver). For an aggregate, this may be a measurement from a photodetector or a a calculation performed on the device by summing up all of the related individual physical channels. 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)

/components/component/transceiver/state/output-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/state/output-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/state/output-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/state/output-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/state/output-power/
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

/components/component/transceiver/state/output-power/
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

/components/component/transceiver/state/output-power/
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

/components/component/transceiver/state/
input-power

description:
The input optical power of a physical channel in units of 0.01dBm, which may be associated with individual physical channels, or an aggregate of multiple physical channels (i.e., for the overall transceiver). For an aggregate, this may be a measurement from a photodetector or a a calculation performed on the device by summing up all of the related individual physical channels. 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)

/components/component/transceiver/state/input-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/state/input-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/state/input-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/state/input-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/state/input-power/
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

/components/component/transceiver/state/input-power/
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

/components/component/transceiver/state/input-power/
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

/components/component/transceiver/state/
laser-bias-current

description:
The current applied by the system to the transmit laser to achieve the output power. The current is expressed in mA with up to 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)

/components/component/transceiver/state/laser-bias-current/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: mA

/components/component/transceiver/state/laser-bias-current/
avg

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

nodetype: leaf (ro)

type: decimal64

units: mA

/components/component/transceiver/state/laser-bias-current/
min

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

nodetype: leaf (ro)

type: decimal64

units: mA

/components/component/transceiver/state/laser-bias-current/
max

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

nodetype: leaf (ro)

type: decimal64

units: mA

/components/component/transceiver/state/laser-bias-current/
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

/components/component/transceiver/state/laser-bias-current/
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

/components/component/transceiver/state/laser-bias-current/
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

/components/component/transceiver/
physical-channels

description:
Enclosing container for client channels

nodetype: container (rw)

/components/component/transceiver/physical-channels/
channel

description:
List of client channels, keyed by index within a physical client port. A physical port with a single channel would have a single zero-indexed element

nodetype: list (rw)

list keys: [index]

/components/component/transceiver/physical-channels/channel/
index

description:
Reference to the index number of the channel

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/index

/components/component/transceiver/physical-channels/channel/
config

description:
Configuration data for physical channels

nodetype: container (rw)

/components/component/transceiver/physical-channels/channel/config/
index

description:
Index of the physical channnel or lane within a physical client port

nodetype: leaf (rw)

type: uint16

  • range: 0..max

/components/component/transceiver/physical-channels/channel/config/
associated-optical-channel

description:
A physical channel may reference an optical channel component. If the physical channel does make this optional reference, then a limited set of leaves will apply within the physical channel to avoid duplication within the optical channel.

nodetype: leaf (rw)

type: leafref

  • path reference: /components/component/name

/components/component/transceiver/physical-channels/channel/config/
description

description:
Text description for the client physical channel

nodetype: leaf (rw)

type: string

/components/component/transceiver/physical-channels/channel/config/
tx-laser

description:
Enable (true) or disable (false) the transmit label for the channel

nodetype: leaf (rw)

type: boolean

/components/component/transceiver/physical-channels/channel/config/
target-output-power

description:
Target output optical power level of the optical channel, expressed in increments of 0.01 dBm (decibel-milliwats)

nodetype: leaf (rw)

type: decimal64

units: dBm

/components/component/transceiver/physical-channels/channel/
state

description:
Operational state data for channels

nodetype: container (ro)

/components/component/transceiver/physical-channels/channel/state/
index

description:
Index of the physical channnel or lane within a physical client port

nodetype: leaf (ro)

type: uint16

  • range: 0..max

/components/component/transceiver/physical-channels/channel/state/
associated-optical-channel

description:
A physical channel may reference an optical channel component. If the physical channel does make this optional reference, then a limited set of leaves will apply within the physical channel to avoid duplication within the optical channel.

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/components/component/transceiver/physical-channels/channel/state/
description

description:
Text description for the client physical channel

nodetype: leaf (ro)

type: string

/components/component/transceiver/physical-channels/channel/state/
tx-laser

description:
Enable (true) or disable (false) the transmit label for the channel

nodetype: leaf (ro)

type: boolean

/components/component/transceiver/physical-channels/channel/state/
target-output-power

description:
Target output optical power level of the optical channel, expressed in increments of 0.01 dBm (decibel-milliwats)

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/physical-channels/channel/state/
laser-age

description:
Laser age (0% at beginning of life, 100% end of life) in integer percentage. This term is defined by Common Management Interface Specification (CMIS).

nodetype: leaf (ro)

type: oc-types:percentage

/components/component/transceiver/physical-channels/channel/state/
laser-temperature

description:
Laser temperature for the cooled laser in degrees Celsius with 1 decimal precision. This term is defined by Common Management Interface Specification (CMIS). 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)

/components/component/transceiver/physical-channels/channel/state/laser-temperature/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/transceiver/physical-channels/channel/state/laser-temperature/
avg

description:
The arithmetic mean value of the statistic over the sampling period.

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/transceiver/physical-channels/channel/state/laser-temperature/
min

description:
The minimum value of the statistic over the sampling period

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/transceiver/physical-channels/channel/state/laser-temperature/
max

description:
The maximum value of the statistic over the sampling period

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/transceiver/physical-channels/channel/state/laser-temperature/
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

/components/component/transceiver/physical-channels/channel/state/laser-temperature/
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

/components/component/transceiver/physical-channels/channel/state/laser-temperature/
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

/components/component/transceiver/physical-channels/channel/state/
target-frequency-deviation

description:
The difference in MHz with 1 decimal precision between the target center frequency and the actual current center frequency . This term is defined by Common Management Interface Specification (CMIS) and referred to as laser frequency error or laser ferquency deviation. 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)

/components/component/transceiver/physical-channels/channel/state/target-frequency-deviation/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: MHz

/components/component/transceiver/physical-channels/channel/state/target-frequency-deviation/
avg

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

nodetype: leaf (ro)

type: decimal64

units: MHz

/components/component/transceiver/physical-channels/channel/state/target-frequency-deviation/
min

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

nodetype: leaf (ro)

type: decimal64

units: MHz

/components/component/transceiver/physical-channels/channel/state/target-frequency-deviation/
max

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

nodetype: leaf (ro)

type: decimal64

units: MHz

/components/component/transceiver/physical-channels/channel/state/target-frequency-deviation/
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

/components/component/transceiver/physical-channels/channel/state/target-frequency-deviation/
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

/components/component/transceiver/physical-channels/channel/state/target-frequency-deviation/
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

/components/component/transceiver/physical-channels/channel/state/
tec-current

description:
The amount of current flowing to the TC of a cooled laser in percentage with 2 decimal precision. This term is defined by Common Management Interface Specification (CMIS). 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)

/components/component/transceiver/physical-channels/channel/state/tec-current/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: percentage

/components/component/transceiver/physical-channels/channel/state/tec-current/
avg

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

nodetype: leaf (ro)

type: decimal64

units: percentage

/components/component/transceiver/physical-channels/channel/state/tec-current/
min

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

nodetype: leaf (ro)

type: decimal64

units: percentage

/components/component/transceiver/physical-channels/channel/state/tec-current/
max

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

nodetype: leaf (ro)

type: decimal64

units: percentage

/components/component/transceiver/physical-channels/channel/state/tec-current/
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

/components/component/transceiver/physical-channels/channel/state/tec-current/
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

/components/component/transceiver/physical-channels/channel/state/tec-current/
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

/components/component/transceiver/physical-channels/channel/state/
output-frequency

description:
The frequency in MHz of the individual physical channel (e.g. ITU C50 - 195.0THz and would be reported as 195,000,000 MHz in this model). This attribute is not configurable on most client ports.

nodetype: leaf (ro)

type: oc-opt-types:frequency-type

/components/component/transceiver/physical-channels/channel/state/
output-power

description:
The output optical power of a physical channel in units of 0.01dBm, which may be associated with individual physical channels, or an aggregate of multiple physical channels (i.e., for the overall transceiver). For an aggregate, this may be a measurement from a photodetector or a a calculation performed on the device by summing up all of the related individual physical channels. 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)

/components/component/transceiver/physical-channels/channel/state/output-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/physical-channels/channel/state/output-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/physical-channels/channel/state/output-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/physical-channels/channel/state/output-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/physical-channels/channel/state/output-power/
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

/components/component/transceiver/physical-channels/channel/state/output-power/
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

/components/component/transceiver/physical-channels/channel/state/output-power/
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

/components/component/transceiver/physical-channels/channel/state/
input-power

description:
The input optical power of a physical channel in units of 0.01dBm, which may be associated with individual physical channels, or an aggregate of multiple physical channels (i.e., for the overall transceiver). For an aggregate, this may be a measurement from a photodetector or a a calculation performed on the device by summing up all of the related individual physical channels. 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)

/components/component/transceiver/physical-channels/channel/state/input-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/physical-channels/channel/state/input-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/physical-channels/channel/state/input-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/physical-channels/channel/state/input-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/physical-channels/channel/state/input-power/
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

/components/component/transceiver/physical-channels/channel/state/input-power/
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

/components/component/transceiver/physical-channels/channel/state/input-power/
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

/components/component/transceiver/physical-channels/channel/state/
laser-bias-current

description:
The current applied by the system to the transmit laser to achieve the output power. The current is expressed in mA with up to 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)

/components/component/transceiver/physical-channels/channel/state/laser-bias-current/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: mA

/components/component/transceiver/physical-channels/channel/state/laser-bias-current/
avg

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

nodetype: leaf (ro)

type: decimal64

units: mA

/components/component/transceiver/physical-channels/channel/state/laser-bias-current/
min

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

nodetype: leaf (ro)

type: decimal64

units: mA

/components/component/transceiver/physical-channels/channel/state/laser-bias-current/
max

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

nodetype: leaf (ro)

type: decimal64

units: mA

/components/component/transceiver/physical-channels/channel/state/laser-bias-current/
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

/components/component/transceiver/physical-channels/channel/state/laser-bias-current/
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

/components/component/transceiver/physical-channels/channel/state/laser-bias-current/
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

/components/component/transceiver/
thresholds

description:
Enclosing container for transceiver alarm thresholds.

nodetype: container (rw)

/components/component/transceiver/thresholds/
threshold

description:
List of transceiver alarm thresholds, indexed by alarm severity.

nodetype: list (ro)

list keys: [severity]

/components/component/transceiver/thresholds/threshold/
severity

description:
The severity applied to the group of thresholds. An implementation's highest severity threshold should be mapped to OpenConfig's `CRITICAL` severity level.

nodetype: leaf (list key) (ro)

type: leafref

  • path reference: ../state/severity

/components/component/transceiver/thresholds/threshold/
state

description:
Operational alarm thresholds for the transceiver.

nodetype: container (ro)

/components/component/transceiver/thresholds/threshold/state/
severity

description:
The type of alarm to which the thresholds apply.

nodetype: leaf (ro)

type: identityref

  • base: oc-alarm-types:OPENCONFIG_ALARM_SEVERITY

/components/component/transceiver/thresholds/threshold/state/
laser-temperature-upper

description:
The upper temperature threshold for the laser temperature sensor.

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/transceiver/thresholds/threshold/state/
laser-temperature-lower

description:
The lower temperature threshold for the laser temperature sensor.

nodetype: leaf (ro)

type: decimal64

units: celsius

/components/component/transceiver/thresholds/threshold/state/
output-power-upper

description:
The upper power threshold for the laser output power.

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/thresholds/threshold/state/
output-power-lower

description:
The lower power threshold for the laser output power.

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/thresholds/threshold/state/
input-power-upper

description:
The upper power threshold for the laser input power.

nodetype: leaf (ro)

type: decimal64

units: dBm

/components/component/transceiver/thresholds/threshold/state/
input-power-lower

description:
The lower power threshold for the laser input power.

nodetype: leaf (ro)

type: decimal64

units: dBm