openconfig-platform-types

openconfig-version: 1.6.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

WIFI_ACCESS_POINT

description:
A device that attaches to a an Ethernet network and creates a wireless local area network

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-protection

openconfig-version: 0.4.1

Description

This model describes configuration and operational state data for optical line protection elements, deployed as part of a transport line system. An Automatic Protection Switch (APS) is typically installed in the same device as the amplifiers and wave-router, however an APS can also be a standalone device. In both scenarios, it serves the same purpose of providing protection using two dark fiber pairs to ensure the amplifiers can still receive a signal if one of the two fiber pairs is broken. The APS port details and directionality are shown below. The three major attributes, together with their modifiers, define the behavior of the APS and can be prioritized in the descending order as shown in the following table

Imports

openconfig-extensions
openconfig-types
openconfig-platform

Identities

base: APS_PATHS

description:
Base identity for identifying the line paths on an automatic protection switch

PRIMARY

description:
The primary line path connected to an automatic protection switch port indicating the primary/preferred path

base identity: APS_PATHS

SECONDARY

description:
The secondary line path connected to an automatic protection switch port indicating the secondary path

base identity: APS_PATHS

Data elements

/
aps

description:
Top level grouping for automatic protection switch data

nodetype: container (rw)

/aps/
aps-modules

description:
Enclosing container for list of automatic protection switch modules

nodetype: container (rw)

/aps/aps-modules/
aps-module

description:
List of automatic protection switch modules present in the device

nodetype: list (rw)

list keys: [name]

/aps/aps-modules/aps-module/
name

description:
Reference to the config name list key

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/aps/aps-modules/aps-module/
config

description:
Configuration data for an automatic protection switch module

nodetype: container (rw)

/aps/aps-modules/aps-module/config/
name

description:
Reference to the component name (in the platform model) corresponding to this automatic protection switch module in the device

nodetype: leaf (rw)

type: leafref

  • path reference: /components/component/name

/aps/aps-modules/aps-module/config/
revertive

description:
Revertive behavior of the module. If True, then automatically revert after protection switch once the fault is restored. This leaf is not valid when the relative-switch-threshold is in effect

nodetype: leaf (rw)

type: boolean

/aps/aps-modules/aps-module/config/
wait-to-restore-time

description:
The time that must elapse before an APS path that has recovered from an signal failure (SF) or signal degradation (SD) condition can be used again to transport the normal traffic signal. During this time period, an SF or SD condition shall override the wait-to-restore time period. This leaf can only take effect when the revertive leaf equals true

nodetype: leaf (rw)

type: uint32

units: milliseconds

/aps/aps-modules/aps-module/config/
hold-off-time

description:
The time delay between the declaration of an SF or SD condition and the initiation of the protection switching algorithm

nodetype: leaf (rw)

type: uint32

units: milliseconds

/aps/aps-modules/aps-module/config/
primary-switch-threshold

description:
The threshold at which the primary line port will switch to the opposite line port in increments of 0.01 dBm. If the hardware supports only one switch threshold for primary and and secondary ports then it is recommended to set both primary-switch-threshold and secondary-switch-threshold to the same value to be explicit. When the relative switch threshold is enabled, i.e. set to a non-zero value, the primary switch threshold will be overridden

nodetype: leaf (rw)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/config/
primary-switch-hysteresis

description:
The delta in dB between the primary-switch-threshold and the signal received on the primary APS_PATH before initiating a switch from the secondary APS_PATH to the primary APS_PATH, in order to prevent toggling between ports when an input signal is very close to the threshold. A zero value means the switch hysteresis is disabled.

nodetype: leaf (rw)

type: decimal64

default: 0

units: dB

/aps/aps-modules/aps-module/config/
secondary-switch-threshold

description:
The threshold at which the secondary line port will switch to the opposite line port in increments of 0.01 dBm. If the hardware supports only one switch threshold for primary and and secondary ports then it is recommended to set both primary-switch-threshold and secondary-switch-threshold to the same value to be explicit. When the relative switch threshold is enabled, i.e. set to a non-zero value, the secondary switch threshold will be overridden

nodetype: leaf (rw)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/config/
relative-switch-threshold

description:
The delta threshold in dB at which the current line port will switch to the opposite line port. It can be set to the value of 0dB. When set to 0dB, the threshold is ignored and the system automatically applies the primary and secondary switch thresholds. When set to a non-zero value, it overrides the primary and secondary switch thresholds

nodetype: leaf (rw)

type: decimal64

default: 0

units: dB

/aps/aps-modules/aps-module/config/
relative-switch-threshold-offset

description:
The offset of the relative switch threshold that compensates the normal difference of receiving power between the primary and secondary line ports. A negative offset corresponds to the situation where the secondary line port receives a higher power than the primary line port in normal condition´╝î and a positive offset means the opposite. The offset will only work when the relative switch threshold is set to a non-zero value

nodetype: leaf (rw)

type: decimal64

default: 0

units: dB

/aps/aps-modules/aps-module/config/
force-to-port

description:
Explicitly set the switch to stay on a port regardless of its operational condition

nodetype: leaf (rw)

type: enumeration

  • NONE
    Do not force the switch to stay on any line port
  • PRIMARY
    Force the switch to stay on the primary line port
  • SECONDARY
    Force the switch to stay on the secondary line port

default: NONE

/aps/aps-modules/aps-module/
state

description:
Operational state data for an automatic protection switch module

nodetype: container (ro)

/aps/aps-modules/aps-module/state/
name

description:
Reference to the component name (in the platform model) corresponding to this automatic protection switch module in the device

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/aps/aps-modules/aps-module/state/
revertive

description:
Revertive behavior of the module. If True, then automatically revert after protection switch once the fault is restored. This leaf is not valid when the relative-switch-threshold is in effect

nodetype: leaf (ro)

type: boolean

/aps/aps-modules/aps-module/state/
wait-to-restore-time

description:
The time that must elapse before an APS path that has recovered from an signal failure (SF) or signal degradation (SD) condition can be used again to transport the normal traffic signal. During this time period, an SF or SD condition shall override the wait-to-restore time period. This leaf can only take effect when the revertive leaf equals true

nodetype: leaf (ro)

type: uint32

units: milliseconds

/aps/aps-modules/aps-module/state/
hold-off-time

description:
The time delay between the declaration of an SF or SD condition and the initiation of the protection switching algorithm

nodetype: leaf (ro)

type: uint32

units: milliseconds

/aps/aps-modules/aps-module/state/
primary-switch-threshold

description:
The threshold at which the primary line port will switch to the opposite line port in increments of 0.01 dBm. If the hardware supports only one switch threshold for primary and and secondary ports then it is recommended to set both primary-switch-threshold and secondary-switch-threshold to the same value to be explicit. When the relative switch threshold is enabled, i.e. set to a non-zero value, the primary switch threshold will be overridden

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/state/
primary-switch-hysteresis

description:
The delta in dB between the primary-switch-threshold and the signal received on the primary APS_PATH before initiating a switch from the secondary APS_PATH to the primary APS_PATH, in order to prevent toggling between ports when an input signal is very close to the threshold. A zero value means the switch hysteresis is disabled.

nodetype: leaf (ro)

type: decimal64

default: 0

units: dB

/aps/aps-modules/aps-module/state/
secondary-switch-threshold

description:
The threshold at which the secondary line port will switch to the opposite line port in increments of 0.01 dBm. If the hardware supports only one switch threshold for primary and and secondary ports then it is recommended to set both primary-switch-threshold and secondary-switch-threshold to the same value to be explicit. When the relative switch threshold is enabled, i.e. set to a non-zero value, the secondary switch threshold will be overridden

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/state/
relative-switch-threshold

description:
The delta threshold in dB at which the current line port will switch to the opposite line port. It can be set to the value of 0dB. When set to 0dB, the threshold is ignored and the system automatically applies the primary and secondary switch thresholds. When set to a non-zero value, it overrides the primary and secondary switch thresholds

nodetype: leaf (ro)

type: decimal64

default: 0

units: dB

/aps/aps-modules/aps-module/state/
relative-switch-threshold-offset

description:
The offset of the relative switch threshold that compensates the normal difference of receiving power between the primary and secondary line ports. A negative offset corresponds to the situation where the secondary line port receives a higher power than the primary line port in normal condition´╝î and a positive offset means the opposite. The offset will only work when the relative switch threshold is set to a non-zero value

nodetype: leaf (ro)

type: decimal64

default: 0

units: dB

/aps/aps-modules/aps-module/state/
force-to-port

description:
Explicitly set the switch to stay on a port regardless of its operational condition

nodetype: leaf (ro)

type: enumeration

  • NONE
    Do not force the switch to stay on any line port
  • PRIMARY
    Force the switch to stay on the primary line port
  • SECONDARY
    Force the switch to stay on the secondary line port

default: NONE

/aps/aps-modules/aps-module/state/
active-path

description:
Indicates which line path on the protection switch is currently the active path connected to the common port

nodetype: leaf (ro)

type: identityref

  • base: APS_PATHS

/aps/aps-modules/aps-module/
ports

description:
Top level grouping for automatic protection switch ports

nodetype: container (rw)

/aps/aps-modules/aps-module/ports/
line-primary-in

description:
Container for information related to the line primary input port

nodetype: container (rw)

/aps/aps-modules/aps-module/ports/line-primary-in/
config

description:
Configuration data for the line primary input port

nodetype: container (rw)

/aps/aps-modules/aps-module/ports/line-primary-in/config/
enabled

description:
This leaf contains the configured, desired state of the port. Disabling the port turns off alarm reporting for the port

nodetype: leaf (rw)

type: boolean

default: true

/aps/aps-modules/aps-module/ports/line-primary-in/config/
target-attenuation

description:
Target attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB.

nodetype: leaf (rw)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/line-primary-in/
state

description:
State data for the line primary input port

nodetype: container (ro)

/aps/aps-modules/aps-module/ports/line-primary-in/state/
enabled

description:
This leaf contains the configured, desired state of the port. Disabling the port turns off alarm reporting for the port

nodetype: leaf (ro)

type: boolean

default: true

/aps/aps-modules/aps-module/ports/line-primary-in/state/
target-attenuation

description:
Target attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB.

nodetype: leaf (ro)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/line-primary-in/state/
attenuation

description:
The attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB.

nodetype: leaf (ro)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/line-primary-in/state/
optical-power

description:
The optical input power of this port in units of 0.01dBm. Optical input power represents the signal traversing from an external destination into the module. The power is measured before any attenuation. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/aps/aps-modules/aps-module/ports/line-primary-in/state/optical-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-primary-in/state/optical-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-primary-in/state/optical-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-primary-in/state/optical-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-primary-in/state/optical-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

/aps/aps-modules/aps-module/ports/line-primary-in/state/optical-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

/aps/aps-modules/aps-module/ports/line-primary-in/state/optical-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

/aps/aps-modules/aps-module/ports/
line-primary-out

description:
Container for information related to the line primary output port

nodetype: container (rw)

/aps/aps-modules/aps-module/ports/line-primary-out/
config

description:
Configuration data for the line primary output port

nodetype: container (rw)

/aps/aps-modules/aps-module/ports/line-primary-out/config/
target-attenuation

description:
Target attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB

nodetype: leaf (rw)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/line-primary-out/
state

description:
State data for the line primary output port

nodetype: container (ro)

/aps/aps-modules/aps-module/ports/line-primary-out/state/
target-attenuation

description:
Target attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB

nodetype: leaf (ro)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/line-primary-out/state/
attenuation

description:
The attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB

nodetype: leaf (ro)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/line-primary-out/state/
optical-power

description:
The optical output power of this port in units of 0.01dBm. Optical output power represents the signal traversing from the module to an external destination. The power is measured after any attenuation. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/aps/aps-modules/aps-module/ports/line-primary-out/state/optical-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-primary-out/state/optical-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-primary-out/state/optical-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-primary-out/state/optical-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-primary-out/state/optical-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

/aps/aps-modules/aps-module/ports/line-primary-out/state/optical-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

/aps/aps-modules/aps-module/ports/line-primary-out/state/optical-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

/aps/aps-modules/aps-module/ports/
line-secondary-in

description:
Container for information related to the line secondary input port

nodetype: container (rw)

/aps/aps-modules/aps-module/ports/line-secondary-in/
config

description:
Configuration data for the line secondary input port

nodetype: container (rw)

/aps/aps-modules/aps-module/ports/line-secondary-in/config/
enabled

description:
This leaf contains the configured, desired state of the port. Disabling the port turns off alarm reporting for the port

nodetype: leaf (rw)

type: boolean

default: true

/aps/aps-modules/aps-module/ports/line-secondary-in/config/
target-attenuation

description:
Target attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB.

nodetype: leaf (rw)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/line-secondary-in/
state

description:
State data for the line secondary input port

nodetype: container (ro)

/aps/aps-modules/aps-module/ports/line-secondary-in/state/
enabled

description:
This leaf contains the configured, desired state of the port. Disabling the port turns off alarm reporting for the port

nodetype: leaf (ro)

type: boolean

default: true

/aps/aps-modules/aps-module/ports/line-secondary-in/state/
target-attenuation

description:
Target attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB.

nodetype: leaf (ro)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/line-secondary-in/state/
attenuation

description:
The attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB.

nodetype: leaf (ro)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/line-secondary-in/state/
optical-power

description:
The optical input power of this port in units of 0.01dBm. Optical input power represents the signal traversing from an external destination into the module. The power is measured before any attenuation. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/aps/aps-modules/aps-module/ports/line-secondary-in/state/optical-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-secondary-in/state/optical-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-secondary-in/state/optical-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-secondary-in/state/optical-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-secondary-in/state/optical-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

/aps/aps-modules/aps-module/ports/line-secondary-in/state/optical-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

/aps/aps-modules/aps-module/ports/line-secondary-in/state/optical-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

/aps/aps-modules/aps-module/ports/
line-secondary-out

description:
Container for information related to the line secondary output port

nodetype: container (rw)

/aps/aps-modules/aps-module/ports/line-secondary-out/
config

description:
Configuration data for the line secondary output port

nodetype: container (rw)

/aps/aps-modules/aps-module/ports/line-secondary-out/config/
target-attenuation

description:
Target attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB

nodetype: leaf (rw)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/line-secondary-out/
state

description:
State data for the line secondary output port

nodetype: container (ro)

/aps/aps-modules/aps-module/ports/line-secondary-out/state/
target-attenuation

description:
Target attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB

nodetype: leaf (ro)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/line-secondary-out/state/
attenuation

description:
The attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB

nodetype: leaf (ro)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/line-secondary-out/state/
optical-power

description:
The optical output power of this port in units of 0.01dBm. Optical output power represents the signal traversing from the module to an external destination. The power is measured after any attenuation. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/aps/aps-modules/aps-module/ports/line-secondary-out/state/optical-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-secondary-out/state/optical-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-secondary-out/state/optical-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-secondary-out/state/optical-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/line-secondary-out/state/optical-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

/aps/aps-modules/aps-module/ports/line-secondary-out/state/optical-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

/aps/aps-modules/aps-module/ports/line-secondary-out/state/optical-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

/aps/aps-modules/aps-module/ports/
common-in

description:
Container for information related to the line common input port

nodetype: container (rw)

/aps/aps-modules/aps-module/ports/common-in/
config

description:
Configuration data for the line common input port

nodetype: container (rw)

/aps/aps-modules/aps-module/ports/common-in/config/
enabled

description:
This leaf contains the configured, desired state of the port. Disabling the port turns off alarm reporting for the port

nodetype: leaf (rw)

type: boolean

default: true

/aps/aps-modules/aps-module/ports/common-in/config/
target-attenuation

description:
Target attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB.

nodetype: leaf (rw)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/common-in/
state

description:
State data for the line common input port

nodetype: container (ro)

/aps/aps-modules/aps-module/ports/common-in/state/
enabled

description:
This leaf contains the configured, desired state of the port. Disabling the port turns off alarm reporting for the port

nodetype: leaf (ro)

type: boolean

default: true

/aps/aps-modules/aps-module/ports/common-in/state/
target-attenuation

description:
Target attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB.

nodetype: leaf (ro)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/common-in/state/
attenuation

description:
The attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB.

nodetype: leaf (ro)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/common-in/state/
optical-power

description:
The optical input power of this port in units of 0.01dBm. Optical input power represents the signal traversing from an external destination into the module. The power is measured before any attenuation. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/aps/aps-modules/aps-module/ports/common-in/state/optical-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/common-in/state/optical-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/common-in/state/optical-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/common-in/state/optical-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/common-in/state/optical-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

/aps/aps-modules/aps-module/ports/common-in/state/optical-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

/aps/aps-modules/aps-module/ports/common-in/state/optical-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

/aps/aps-modules/aps-module/ports/
common-output

description:
Container for information related to the line common output port

nodetype: container (rw)

/aps/aps-modules/aps-module/ports/common-output/
config

description:
Configuration data for the line common output port

nodetype: container (rw)

/aps/aps-modules/aps-module/ports/common-output/config/
target-attenuation

description:
Target attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB

nodetype: leaf (rw)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/common-output/
state

description:
State data for the line common output port

nodetype: container (ro)

/aps/aps-modules/aps-module/ports/common-output/state/
target-attenuation

description:
Target attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB

nodetype: leaf (ro)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/common-output/state/
attenuation

description:
The attenuation of the variable optical attenuator associated with the port in increments of 0.01 dB

nodetype: leaf (ro)

type: decimal64

units: dB

/aps/aps-modules/aps-module/ports/common-output/state/
optical-power

description:
The optical output power of this port in units of 0.01dBm. Optical output power represents the signal traversing from the module to an external destination. The power is measured after any attenuation. If avg/min/max statistics are not supported, the target is expected to just supply the instant value

nodetype: container (ro)

/aps/aps-modules/aps-module/ports/common-output/state/optical-power/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/common-output/state/optical-power/
avg

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/common-output/state/optical-power/
min

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/common-output/state/optical-power/
max

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

nodetype: leaf (ro)

type: decimal64

units: dBm

/aps/aps-modules/aps-module/ports/common-output/state/optical-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

/aps/aps-modules/aps-module/ports/common-output/state/optical-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

/aps/aps-modules/aps-module/ports/common-output/state/optical-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

openconfig-platform

openconfig-version: 0.23.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:
Resource 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/
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:
Resource 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)