This module defines data types (e.g., YANG identities) to support the OpenConfig component inventory model.
openconfig-types
openconfig-extensions
description:
A generic type reflecting whether a hardware component
is powered on or off
type: enumeration
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
description:
Records how the role switchover is triggered.
type: enumeration
description:
Base identity for hardware related components in a managed
device. Derived identities are partially based on contents
of the IANA Entity MIB.
description:
Chassis component, typically with multiple slots / shelves
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
Backplane component for aggregating traffic, typically
contained in a chassis component
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
Interconnect between ingress and egress ports on the
device (e.g., a crossbar switch).
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
Component that is supplying power to the device
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
Cooling fan, or could be some other heat-reduction component
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
Physical sensor, e.g., a temperature sensor in a chassis
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
Replaceable hardware component that does not have a more
specific defined schema.
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
Linecard component, typically inserted into a chassis slot
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
A type of linecard whose primary role is management or control
rather than data forwarding.
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
Physical port, e.g., for attaching pluggables and networking
cables
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
Pluggable module present in a port
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
Processing unit, e.g., a management processor
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
A storage subsystem on the device (disk, SSD, etc.)
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
A special purpose processing unit, typically for traffic
switching/forwarding (e.g., switching ASIC, NPU, forwarding
chip, etc.)
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
A device that attaches to a an Ethernet network and creates a wireless
local area network
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
Base identity for software-related components in a managed
device
description:
Operating system running on a component
base identity: OPENCONFIG_SOFTWARE_COMPONENT
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
description:
Legacy BIOS or UEFI firmware interface responsible for
initializing hardware components and first stage boot loader.
base identity: OPENCONFIG_SOFTWARE_COMPONENT
description:
Software layer responsible for loading and booting the
device OS or network OS.
base identity: OPENCONFIG_SOFTWARE_COMPONENT
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
description:
Current operational status of a platform component
description:
Component is enabled and active (i.e., up)
base identity: COMPONENT_OPER_STATUS
description:
Component is enabled but inactive (i.e., down)
base identity: COMPONENT_OPER_STATUS
description:
Component is administratively disabled.
base identity: COMPONENT_OPER_STATUS
description:
Base identity for FEC operational modes.
description:
FEC is administratively enabled.
base identity: FEC_MODE_TYPE
description:
FEC is administratively disabled.
base identity: FEC_MODE_TYPE
description:
System will determine whether to enable or disable
FEC on a transceiver.
base identity: FEC_MODE_TYPE
description:
Base identity for FEC operational statuses.
description:
FEC is operationally locked.
base identity: FEC_STATUS_TYPE
description:
FEC is operationally unlocked.
base identity: FEC_STATUS_TYPE
description:
Base entity for component reboot reasons.
description:
User initiated the reboot of the componenent.
base identity: COMPONENT_REBOOT_REASON
description:
The component reboots due to power failure.
base identity: COMPONENT_REBOOT_REASON
description:
The component reboots due to critical errors.
base identity: COMPONENT_REBOOT_REASON
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
openconfig-extensions
openconfig-types
openconfig-platform
description:
Base identity for identifying the line paths on an
automatic protection switch
description:
The primary line path connected to an automatic protection
switch port indicating the primary/preferred path
base identity: APS_PATHS
description:
The secondary line path connected to an automatic protection
switch port indicating the secondary path
base identity: APS_PATHS
description:
Top level grouping for automatic protection switch data
nodetype: container (rw)
description:
Enclosing container for list of automatic protection
switch modules
nodetype: container (rw)
description:
List of automatic protection switch modules present
in the device
nodetype: list (rw)
list keys: [name]
description:
Reference to the config name list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for an automatic protection
switch module
nodetype: container (rw)
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
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
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
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
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
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
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
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
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
description:
Explicitly set the switch to stay on a port regardless of
its operational condition
nodetype: leaf (rw)
type: enumeration
default: NONE
description:
Operational state data for an automatic protection
switch module
nodetype: container (ro)
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
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
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
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
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
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
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
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
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
description:
Explicitly set the switch to stay on a port regardless of
its operational condition
nodetype: leaf (ro)
type: enumeration
default: NONE
description:
Indicates which line path on the protection switch is
currently the active path connected to the common port
nodetype: leaf (ro)
type: identityref
description:
Top level grouping for automatic protection switch ports
nodetype: container (rw)
description:
Container for information related to the line primary
input port
nodetype: container (rw)
description:
Configuration data for the line primary input port
nodetype: container (rw)
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
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
description:
State data for the line primary input port
nodetype: container (ro)
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
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
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
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)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
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
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
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
description:
Container for information related to the line primary
output port
nodetype: container (rw)
description:
Configuration data for the line primary output port
nodetype: container (rw)
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
description:
State data for the line primary output port
nodetype: container (ro)
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
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
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)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
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
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
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
description:
Container for information related to the line secondary
input port
nodetype: container (rw)
description:
Configuration data for the line secondary input port
nodetype: container (rw)
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
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
description:
State data for the line secondary input port
nodetype: container (ro)
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
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
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
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)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
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
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
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
description:
Container for information related to the line secondary
output port
nodetype: container (rw)
description:
Configuration data for the line secondary output port
nodetype: container (rw)
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
description:
State data for the line secondary output port
nodetype: container (ro)
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
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
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)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
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
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
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
description:
Container for information related to the line common
input port
nodetype: container (rw)
description:
Configuration data for the line common input port
nodetype: container (rw)
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
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
description:
State data for the line common input port
nodetype: container (ro)
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
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
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
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)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
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
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
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
description:
Container for information related to the line common
output port
nodetype: container (rw)
description:
Configuration data for the line common output port
nodetype: container (rw)
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
description:
State data for the line common output port
nodetype: container (ro)
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
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
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)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dBm
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
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
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
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).
openconfig-platform-types
openconfig-extensions
openconfig-alarm-types
openconfig-yang-types
openconfig-types
description:
Enclosing container for the components in the system.
nodetype: container (rw)
description:
List of components, keyed by component name.
nodetype: list (rw)
list keys: [name]
description:
References the component name
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for each component
nodetype: container (rw)
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
description:
Operational state data for each component
nodetype: container (ro)
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
description:
Type of component as identified by the system
nodetype: leaf (ro)
type: union
type: identityref
type: identityref
description:
Unique identifier assigned by the system for the
component
nodetype: leaf (ro)
type: string
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
description:
System-supplied description of the component
nodetype: leaf (ro)
type: string
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
description:
System-supplied representation of the component's
manufacturing date.
nodetype: leaf (ro)
type: oc-yang:date
description:
For hardware components, this is the hardware revision of
the component.
nodetype: leaf (ro)
type: string
description:
For hardware components, this is the version of associated
firmware that is running on the component, if applicable.
nodetype: leaf (ro)
type: string
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
description:
System-assigned serial number of the component.
nodetype: leaf (ro)
type: string
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
description:
A human readable string describing the model of a component.
This string is optional and should only be populated if part-no
is also populated.
nodetype: leaf (ro)
type: string
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
description:
If true, this component is removable or is a field
replaceable unit
nodetype: leaf (ro)
type: boolean
description:
If applicable, this reports the current operational status
of the component.
nodetype: leaf (ro)
type: identityref
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
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
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
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)
description:
Records the generic triggers, e.g. user or system
initiated the switchover.
nodetype: leaf (ro)
type: component-redundant-role-switchover-reason-trigger
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
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
description:
This reports the reason of the last reboot of the component.
nodetype: leaf (ro)
type: identityref
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
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
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
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)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: celsius
description:
The arithmetic mean value of the statistic over the
sampling period.
nodetype: leaf (ro)
type: decimal64
units: celsius
description:
The minimum value of the statistic over the sampling
period
nodetype: leaf (ro)
type: decimal64
units: celsius
description:
The maximum value of the statistic over the sampling
period
nodetype: leaf (ro)
type: decimal64
units: celsius
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
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
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
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
description:
The threshold value that was crossed for this alarm.
nodetype: leaf (ro)
type: uint32
description:
The severity of the current alarm.
nodetype: leaf (ro)
type: identityref
description:
For components that have associated memory, these values
report information about available and utilized memory.
nodetype: container (ro)
description:
The available memory physically installed, or logically
allocated to the component.
nodetype: leaf (ro)
type: uint64
units: bytes
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
description:
Power allocated by the system for the component.
nodetype: leaf (ro)
type: uint32
units: watts
description:
Actual power used by the component.
nodetype: leaf (ro)
type: uint32
units: watts
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)
description:
The count of the fatal PCIe errors.
nodetype: container (ro)
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
description:
The count of the non-fatal PCIe errors.
nodetype: container (ro)
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
description:
The count of the correctable PCIe errors.
nodetype: container (ro)
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
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
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
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
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
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
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
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
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
description:
Enclosing container
nodetype: container (rw)
description:
List of system properties for the component
nodetype: list (rw)
list keys: [name]
description:
Reference to the property name.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for each property
nodetype: container (rw)
description:
System-supplied name of the property -- this is typically
non-configurable
nodetype: leaf (rw)
type: string
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
description:
Operational state data for each property
nodetype: container (ro)
description:
System-supplied name of the property -- this is typically
non-configurable
nodetype: leaf (ro)
type: string
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
description:
Indication whether the property is user-configurable
nodetype: leaf (ro)
type: boolean
description:
Enclosing container for subcomponent references
nodetype: container (rw)
description:
List of subcomponent references
nodetype: list (rw)
list keys: [name]
description:
Reference to the name list key
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for the subcomponent
nodetype: container (rw)
description:
Reference to the name of the subcomponent
nodetype: leaf (rw)
type: leafref
description:
Operational state data for the subcomponent
nodetype: container (ro)
description:
Reference to the name of the subcomponent
nodetype: leaf (ro)
type: leafref
description:
Data for chassis components
nodetype: container (rw)
description:
Configuration data for chassis components
nodetype: container (rw)
description:
Operational state data for chassis components
nodetype: container (ro)
description:
Resource utilization of the component.
nodetype: container (rw)
description:
Enclosing container for the resources in this component.
nodetype: container (rw)
description:
List of resources, keyed by resource name.
nodetype: list (rw)
list keys: [name]
description:
References the resource name.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for each resource.
nodetype: container (rw)
description:
Resource name within the component.
nodetype: leaf (rw)
type: string
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
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
description:
Operational state data for each resource.
nodetype: container (ro)
description:
Resource name within the component.
nodetype: leaf (ro)
type: string
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
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
description:
Number of entries currently in use for the resource.
nodetype: leaf (ro)
type: uint64
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
description:
Number of entries available to use.
nodetype: leaf (ro)
type: uint64
description:
Maximum number of entries available for the resource. The value
is the theoretical maximum resource utilization possible.
nodetype: leaf (ro)
type: uint64
description:
A watermark of highest number of entries used for this resource.
nodetype: leaf (ro)
type: uint64
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
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
description:
Data for physical port components
nodetype: container (rw)
description:
Configuration data for physical port components
nodetype: container (rw)
description:
Operational state data for physical port components
nodetype: container (ro)
description:
Data for power supply components
nodetype: container (rw)
description:
Configuration data for power supply components
nodetype: container (rw)
description:
Operational state data for power supply components
nodetype: container (ro)
description:
Data for fan components
nodetype: container (rw)
description:
Configuration data for fan components
nodetype: container (rw)
description:
Operational state data for fan components
nodetype: container (ro)
description:
Data for fabric components
nodetype: container (rw)
description:
Configuration data for fabric components
nodetype: container (rw)
description:
Operational state data for fabric components
nodetype: container (ro)
description:
Data for storage components
nodetype: container (rw)
description:
Configuration data for storage components
nodetype: container (rw)
description:
Operational state data for storage components
nodetype: container (ro)
description:
Data for cpu components
nodetype: container (rw)
description:
Configuration data for cpu components
nodetype: container (rw)
description:
Operational state data for cpu components
nodetype: container (ro)
description:
Data for chip components, such as ASIC, NPUs, etc.
nodetype: container (rw)
description:
Configuration data for chip components
nodetype: container (rw)
description:
Operational state data for chip components
nodetype: container (ro)
description:
Resource utilization of the component.
nodetype: container (rw)
description:
Enclosing container for the resources in this component.
nodetype: container (rw)
description:
List of resources, keyed by resource name.
nodetype: list (rw)
list keys: [name]
description:
References the resource name.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for each resource.
nodetype: container (rw)
description:
Resource name within the component.
nodetype: leaf (rw)
type: string
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
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
description:
Operational state data for each resource.
nodetype: container (ro)
description:
Resource name within the component.
nodetype: leaf (ro)
type: string
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
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
description:
Number of entries currently in use for the resource.
nodetype: leaf (ro)
type: uint64
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
description:
Number of entries available to use.
nodetype: leaf (ro)
type: uint64
description:
Maximum number of entries available for the resource. The value
is the theoretical maximum resource utilization possible.
nodetype: leaf (ro)
type: uint64
description:
A watermark of highest number of entries used for this resource.
nodetype: leaf (ro)
type: uint64
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
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
description:
Data for backplane components
nodetype: container (rw)
description:
Configuration data for backplane components
nodetype: container (rw)
description:
Operational state data for backplane components
nodetype: container (ro)
description:
Data for software module components, i.e., for components
with type=SOFTWARE_MODULE
nodetype: container (rw)
description:
Configuration data for software module components
nodetype: container (rw)
description:
Operational state data for software module components
nodetype: container (ro)
description:
Data for controller card components, i.e., for components
with type=CONTROLLER_CARD
nodetype: container (rw)
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)
description:
Operational state data for controller card components
nodetype: container (ro)