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.
This leaf is deprecated and replaced by install-position and
install-component.
nodetype: leaf (ro)
type: string
description:
System-supplied index to a position where this component is
installed. The position may be referred in device documenation
as a port, slot, bay, socket, etc. This string must only
indicate the name of the position, and not any indication of
the name of the parent component within the system. Instead,
parent component name should be present in the 'parent' leaf.
Typically the install-position is a number, but it is observed
that some devices may use letters or alphanumerics. The
position name should be the same name used to physically
identify the position in documentation or printed on the
device.
Any component which is removable is expected to have
an install-position and an install-component which points to
an ancestor component where the connection occurs.
For component types that have an explicit slot-id attribute,
such as LINECARD, the system should populate slot-id,
install-position and install-component. This will facilitate a
transition to deprecate slot-id.
nodetype: leaf (ro)
type: string
description:
This leaf contains the name of the ancestor component which
contains the 'install-position'. This creates a distinct
mapping between a removable component and the target component
it is installed into. Note there may be zero or more
intermediate components between the removable component and
the install-component.
For example, consider the component tree
PORT ['eth1/2']-> INTEGRATED_CIRCUIT ['npu1']-> LINECARD ['lc1'].
The PORT has an install-position of '2' and install-component named
'lc1'. The intermediate INTEGRATED-CIRCUIT component is not
present in either install-position or install-component leaves.
nodetype: leaf (ro)
type: leafref
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:
Model name that would be found in a catalog of stock keeping
units (SKU) and should be the orderable name of the
component.
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:
Records last power-off reason for a component.
nodetype: container (ro)
description:
Records the generic triggers for the last poweroff
event. Component power-off can be triggered
in various ways,
- USER_INITIATED
- SYSTEM_INITIATED
- POWER_FAILURE
This field is not updated during reboots; those are
tracked in the 'last-reboot-reason' leaf.
nodetype: leaf (ro)
type: component-last-poweroff-reason-trigger
description:
Provides a detailed reason for component power-off.
For system-initiated power-offs, this field can include
specific causes (e.g., critical errors resulting in a
controller-card bootloop).
nodetype: leaf (ro)
type: string
description:
This records the last time a component was directly powered
down. The value is a Unix Epoch timestamp (nanoseconds since
Jan 1, 1970 00:00:00 UTC). Component power-off can be:
- USER_INITIATED
- SYSTEM_INITIATED
- POWER_FAILURE
This field is not updated during reboots; those are tracked
in the 'last-reboot-time' leaf.
nodetype: leaf (ro)
type: oc-types:timeticks64
units: nanoseconds
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). This timer is not updated during
power shutdowns; those are tracked in 'last-poweroff-time' leaf.
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:
A unique numeric identifier assigned by the system to the
component. This identifier may be used to represent the
corresponding SNMP Entity MIB identifier.
nodetype: leaf (ro)
type: uint32
description:
If true, the hardware indicates that the component's physical equipment
has failed
nodetype: leaf (ro)
type: boolean
default: false
description:
If true, the hardware indicates that the component inserted into the
affected component's physical location is of a different type than what
is configured
nodetype: leaf (ro)
type: boolean
default: false
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:
Top-level container for port breakout-mode data.
nodetype: container (rw)
description:
Top level container for breakout groups data.
When a device has the capability to break a port into
interfaces of different speeds and different number of
physical channels, it can breakout a 400G OSFP port with
8 physical channels (with support for 25G NRZ, 50G PAM4
and 100G PAM4) into mixed speed interfaces. Particularly, to
break out into two 100G ports with different modulation, and a 200G
port, a user must configure 1 interface with 2 physical channels
1 interface with 4 physical channels and 1 interface with
2 physical channels. With this configuration the interface in
1st breakout group would use 50G PAM4 modulation, interface
in 2nd breakout group would use 25G NRZ modulation and the
interface in 3rd breakout group would use 100G PAM4 modulation
This configuration would result in 3 entries in the breakout
groups list. The example configuration for this case is shown below:
{
"groups": {
"group": [
{
"config": {
"breakout-speed": "SPEED_100GB",
"index": 0,
"num-breakouts": 1,
"num-physical-channels": 2
},
"index": 0
},
{
"config": {
"breakout-speed": "SPEED_100GB",
"index": 1,
"num-breakouts": 1,
"num-physical-channels": 4
},
"index": 1
},
{
"config": {
"breakout-speed": "SPEED_200GB",
"index": 2,
"num-breakouts": 1,
"num-physical-channels": 2
},
"index": 2
}
]
}
}
When a device does not have the capability to break a port
into interfaces of different speeds and different number of
physical channels, in order to breakout a 400G OSFP port with
8 physical channels into 50G breakout ports it would use 8 interfaces
with 1 physical channel each. This would result in 1 entry in the
breakout groups list. The example configuration for this case is
shown below:
{
"groups": {
"group": [
{
"config": {
"breakout-speed": "SPEED_50GB",
"index": 0,
"num-breakouts": 8,
"num-physical-channels": 1
},
"index": 0
}
]
}
}
Similarly, if a 400G-DR4 interface (8 electrical channels at 50Gbps)
is to be broken out into 4 100Gbps ports, the following configuration
is used:
{
"groups": {
"group": [
{
"config": {
"breakout-speed": "SPEED_100GB",
"index": 0,
"num-breakouts": 4,
"num-physical-channels": 2
},
"index": 0
}
]
}
}
nodetype: container (rw)
description:
List of breakout groups.
nodetype: list (rw)
list keys: [index]
description:
Index of the breakout group entry in the breakout groups list.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for breakout group.
nodetype: container (rw)
description:
Each index specifies breakouts that are identical in
terms of speed and the number of physical channels.
nodetype: leaf (rw)
type: uint8
description:
Sets the number of interfaces using this breakout group.
nodetype: leaf (rw)
type: uint8
description:
Speed of interfaces in this breakout group, supported
values are defined by the ETHERNET_SPEED identity.
nodetype: leaf (rw)
type: identityref
description:
Sets the number of lanes or physical channels assigned
to the interfaces in this breakout group. This leaf need
not be set if there is only one breakout group where all
the interfaces are of equal speed and have equal number
of physical channels.
The physical channels referred to by this leaf are
electrical channels towards the transceiver.
nodetype: leaf (rw)
type: uint8
description:
Operational state data for breakout group.
nodetype: container (ro)
description:
Each index specifies breakouts that are identical in
terms of speed and the number of physical channels.
nodetype: leaf (ro)
type: uint8
description:
Sets the number of interfaces using this breakout group.
nodetype: leaf (ro)
type: uint8
description:
Speed of interfaces in this breakout group, supported
values are defined by the ETHERNET_SPEED identity.
nodetype: leaf (ro)
type: identityref
description:
Sets the number of lanes or physical channels assigned
to the interfaces in this breakout group. This leaf need
not be set if there is only one breakout group where all
the interfaces are of equal speed and have equal number
of physical channels.
The physical channels referred to by this leaf are
electrical channels towards the transceiver.
nodetype: leaf (ro)
type: uint8
description:
Contains data specific to ports on optical transport
devices.
nodetype: container (rw)
description:
Operational config data for optical ports
nodetype: container (rw)
description:
Sets the admin state of the optical-port
nodetype: leaf (rw)
type: oc-opt-types:admin-state-type
description:
Operational state data for optical ports
nodetype: container (ro)
description:
Sets the admin state of the optical-port
nodetype: leaf (ro)
type: oc-opt-types:admin-state-type
description:
For physical ports belonging to optical transport
devices, this indicates the type of optical port. This is an
informational field that should be made available by the
device.
nodetype: leaf (ro)
type: identityref
description:
The total tilt measured on the port. This is applicable to
ports of type INGRESS and EGRESS.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
For line system device ports, this value indicates
the total input optical power of the port in units
of 0.01dBm. If avg/min/max statistics are not supported,
just supply the instant value
nodetype: container (ro)
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:
For line system device ports, this value indicates
the total output optical power of the port in units
of 0.01dBm. If avg/min/max statistics are not supported,
just supply the instant value
nodetype: container (ro)
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:
Data for power supply components
nodetype: container (rw)
description:
Configuration data for power supply components
nodetype: container (rw)
description:
Adminsitrative control on the on/off state of the power
supply unit.
nodetype: leaf (rw)
type: boolean
default: true
description:
Operational state data for power supply components
nodetype: container (ro)
description:
Adminsitrative control on the on/off state of the power
supply unit.
nodetype: leaf (ro)
type: boolean
default: true
description:
Maximum power capacity of the power supply.
nodetype: leaf (ro)
type: oc-types:ieeefloat32
units: watts
description:
The input current draw of the power supply.
nodetype: leaf (ro)
type: oc-types:ieeefloat32
units: amps
description:
Input voltage to the power supply.
nodetype: leaf (ro)
type: oc-types:ieeefloat32
units: volts
description:
The output current supplied by the power supply.
nodetype: leaf (ro)
type: oc-types:ieeefloat32
units: amps
description:
Output voltage supplied by the power supply.
nodetype: leaf (ro)
type: oc-types:ieeefloat32
units: volts
description:
Output power supplied by the power supply.
nodetype: leaf (ro)
type: oc-types:ieeefloat32
units: watts
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:
Current (instantaneous) fan speed
nodetype: leaf (ro)
type: uint32
units: rpm
description:
Data for fabric components
nodetype: container (rw)
description:
Configuration data for fabric components
nodetype: container (rw)
description:
When set to POWER_DISABLED, the component should be shut down by removing
electrical power. This is intended to be used to prevent the component
from becoming active even after a reboot of the system. A component
(if controller-card) may not honor power-admin-state depending on rules
defined in the description of the component config container.
nodetype: leaf (rw)
type: oc-platform-types:component-power-type
default: POWER_ENABLED
description:
Operational state data for fabric components
nodetype: container (ro)
description:
When set to POWER_DISABLED, the component should be shut down by removing
electrical power. This is intended to be used to prevent the component
from becoming active even after a reboot of the system. A component
(if controller-card) may not honor power-admin-state depending on rules
defined in the description of the component config container.
nodetype: leaf (ro)
type: oc-platform-types:component-power-type
default: POWER_ENABLED
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:
A collection of storage specific statistics entitites.
nodetype: container (ro)
description:
Uncorrected read errors reported to the operating system. SMART ID
201.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Count of reallocated sectors. The raw value represents a count of
the bad sectors that have been found and remapped. SMART ID 5.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Count of parity errors which occur in the data path to the media.
SMART ID 184.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total count of uncorrectable errors when reading/writing a
sector. SMART ID 198.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Indicates the approximate SSD life left, in terms of program/erase
cycles or available reserved blocks. A normalized value of 100
represents a new drive, with a threshold value at 10 indicating a need
for replacement. A value of 0 may mean that the drive is operating in
read-only mode to allow data recovery. SMART ID 231.
nodetype: leaf (ro)
type: uint8
description:
Contains a vendor specific estimate of the percentage of NVM
subsystem life used based on the actual usage and the manufacturer’s
prediction of NVM life. A value of 100 indicates that the estimated
endurance of the NVM in the NVM subsystem has been consumed, but may
not indicate an NVM subsystem failure. The value is allowed to exceed
100. Percentages greater than 254 shall be represented as 255.
nodetype: leaf (ro)
type: uint8
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:
Statistics representing CPU utilization of the
component.
nodetype: container (rw)
description:
Operational state variables relating to the utilization
of the CPU.
nodetype: container (ro)
description:
The instantaneous percentage value.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The arithmetic mean value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The minimum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
description:
The maximum value of the percentage measure of the
statistic over the time interval.
nodetype: leaf (ro)
type: oc-types:percentage
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:
Data for chip components, such as ASIC, NPUs, etc.
nodetype: container (rw)
description:
Configuration data for chip components
nodetype: container (rw)
description:
The numeric ID (device_id) used by the controller to address
the integrated circuit, which may be referred to as a 'device',
'node' or 'target' by the P4RT specification.
Each switching ASIC (i.e., node) is addressed by the external
entity based on its numeric identifier.
The node ID is specified in addition to the string identifier
assigned to the integrated circuit within the
/components/component list.
nodetype: leaf (rw)
type: uint64
description:
Operational state data for chip components
nodetype: container (ro)
description:
The numeric ID (device_id) used by the controller to address
the integrated circuit, which may be referred to as a 'device',
'node' or 'target' by the P4RT specification.
Each switching ASIC (i.e., node) is addressed by the external
entity based on its numeric identifier.
The node ID is specified in addition to the string identifier
assigned to the integrated circuit within the
/components/component list.
nodetype: leaf (ro)
type: uint64
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:
Top-level container for the packet, drop, and error counters for the
five NPU sub-blocks.
nodetype: container (ro)
description:
IC packet counters for all five NPU sub-blocks.
nodetype: container (ro)
description:
The IC interface subsystem connects the IC to the external PHY or
MAC.
nodetype: container (ro)
description:
State and counters corresponding to the interface subsystem of
the IC.
nodetype: container (ro)
description:
Incoming packets towards the integrated-circuit interface
subsystem block from the line interfaces or fabric.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing packets towards the line interfaces or fabric from the
integrated-circuit interface subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming bytes towards the integrated-circuit interface
subsystem block from the line interfaces or fabric.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing bytes towards the line interfaces or fabric from the
integrated-circuit interface subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The IC lookup subsystem perform the next hop lookup of the packet
and other forwarding features such as firewall filters.
nodetype: container (ro)
description:
State and counters corresponding to the lookup subsystem of the
IC.
nodetype: container (ro)
description:
The integrated-circuit lookup subsystem block utilization percentage.
nodetype: leaf (ro)
type: oc-types:percentage
description:
Incoming packets towards the integrated-circuit interface
subsystem block from the line interfaces or fabric.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing packets towards the line interfaces or fabric from the
integrated-circuit interface subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming bytes towards the integrated-circuit interface
subsystem block from the line interfaces or fabric.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing bytes towards the line interfaces or fabric from the
integrated-circuit interface subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total amount of memory available in the lookup subsystem.
nodetype: leaf (ro)
type: uint64
units: bytes
description:
The amount of memory used in the lookup subsystem.
nodetype: leaf (ro)
type: uint64
units: bytes
description:
The total amount of nexthop memory available in the lookup subsystem.
nodetype: leaf (ro)
type: uint64
units: bytes
description:
The amount of nexthops memory used in the lookup subsystem.
nodetype: leaf (ro)
type: uint64
units: bytes
description:
Total firewall or ACL memory counter measured in entries.
nodetype: leaf (ro)
type: uint64
description:
Amount of used firewall or ACL memory counter measured in entries.
The number of used entries must include the entries
that are 'allocated but free' if the memory reaping algorithm makes
these entries practically unusable.
nodetype: leaf (ro)
type: uint64
description:
Total firewall or ACL memory counter measured in bytes.
nodetype: leaf (ro)
type: uint64
units: bytes
description:
Amount of used firewall or ACL memory counter measured in bytes.
The number of used bytes must include the bytes
that are 'allocated but free' if the memory reaping algorithm makes
these bytes practically unusable
nodetype: leaf (ro)
type: uint64
units: bytes
description:
Total number of fragments generated by the CPU.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The IC queueing subsystem buffers the packet while processing it
and queues the packet for delivery to the next stage
nodetype: container (ro)
description:
State and counters corresponding to the queueing subsystem of
the IC.
nodetype: container (ro)
description:
Incoming packets towards the integrated-circuit interface
subsystem block from the line interfaces or fabric.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing packets towards the line interfaces or fabric from the
integrated-circuit interface subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming bytes towards the integrated-circuit interface
subsystem block from the line interfaces or fabric.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing bytes towards the line interfaces or fabric from the
integrated-circuit interface subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total amount of memory available in the queue subsystem.
nodetype: leaf (ro)
type: uint64
units: bytes
description:
The amount of memory used in the queue subsystem.
nodetype: leaf (ro)
type: uint64
units: bytes
description:
The number of packets in the loopback or re-circulate subsystem.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of bytes in the loopback or re-circulate subsystem.
nodetype: leaf (ro)
type: uint64
units: bytes
description:
The IC fabric block subsystem connects the IC to the external
systems fabric subsystem
nodetype: container (ro)
description:
State and counters corresponding to the fabric subsystem of the
IC.
nodetype: container (ro)
description:
Incoming cells towards the integrated-circuit fabric
subsystem block from the previous NPU sub block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing cells towards the fabric from the
integrated-circuit fabric subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming packets towards the integrated-circuit interface
subsystem block from the line interfaces or fabric.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing packets towards the line interfaces or fabric from the
integrated-circuit interface subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming bytes towards the integrated-circuit interface
subsystem block from the line interfaces or fabric.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing bytes towards the line interfaces or fabric from the
integrated-circuit interface subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming high priority cells towards the integrated-circuit fabric
subsystem block from the previous NPU sub block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing high priority cells towards the fabric from the
integrated-circuit fabric subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming low priority cells towards the integrated-circuit fabric
subsystem block from the previous NPU sub block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing low priority cells towards the fabric from the
integrated-circuit fabric subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming high priority packets towards the integrated-circuit
fabric subsystem block from the previous NPU sub block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing high priority packets towards the fabric from the
integrated-circuit fabric subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming low priority packets towards the integrated-circuit fabric
subsystem block from the previous NPU sub block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing low priority packets towards the fabric from the
integrated-circuit fabric subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The IC host interface block subsystem connects the IC to the
external systems host or control subsystem
nodetype: container (ro)
description:
State and counters corresponding to the host interface subsystem
of the IC.
nodetype: container (ro)
description:
Incoming packets towards the integrated-circuit interface
subsystem block from the line interfaces or fabric.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing packets towards the line interfaces or fabric from the
integrated-circuit interface subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming bytes towards the integrated-circuit interface
subsystem block from the line interfaces or fabric.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing bytes towards the line interfaces or fabric from the
integrated-circuit interface subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The packets that were successfully punted to CPU due to egress MTU
exceeded.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming high priority packets towards the integrated-circuit
fabric subsystem block from the previous NPU sub block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing high priority packets towards the fabric from the
integrated-circuit fabric subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming low priority packets towards the integrated-circuit fabric
subsystem block from the previous NPU sub block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing low priority packets towards the fabric from the
integrated-circuit fabric subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
IC drop counters for all five NPU sub-blocks.
nodetype: container (ro)
description:
State container for IC drop counters
nodetype: container (ro)
description:
This captures the aggregation of all counters where the switch is
unexpectedly dropping packets. Occurrence of these drops on a stable
(no recent hardware or config changes) and otherwise healthy
switch needs further investigation.
This leaf counts packet discarded as result of corrupted
programming state in an INTEGRATED_CIRCUIT or corrupted data
structures of packet descriptors.
Note: corrupted packets received on ingress interfaces should be counted
in `/interfaces/interface/state/counters/in-errors` and NOT counted as
adverse-aggregate. This is because incoming corrupted packets are NOT
a signal of adverse state of an INTEGRATED_CIRCUIT but rather of an
entity adjacent to the Interface, such as a cable or transceiver). Therefore
such drops SHOULD NOT be counted as adverse-aggregate to preserve
a clean signal of INTEGRATED_CIRCUIT adverse state.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
This tracks the aggregation of all counters where the expected
conditions of packet drops due to internal congestion in some block of
the hardware that may not be visible in through other congestion
indicators like interface discards or queue drop counters.
This leaf counts packet discarded as result of exceeding
performance limits of an INTEGRATED_CIRCUT, when it processes
non-corrupted packets using legitimate, non-corrupted programming
state of the INTEGRATED_CIRCUIT.
The typical example is overloading given IC with higher packet rate (pps)
then given chip can handle. For example, let's assume chip X can process
3.6Bpps of incoming traffic and 2000 Mpps. However if average incoming
packet size is 150B, at full ingress rate this become 3000Mpps. Hence
1/3 of packets would be cropped and should be counted against
congestion-aggregate.
Another example is the case when some INTEGRATED_CIRCUIT internal data bus is
too narrow/slow for handling traffic. For example let's assume chip X needs to send
3Tbps of traffic to an external buffer memory which has only 2Tbps access I/O. In
this case packets would be discarded, because of congestion of memory I/O bus
which is part of the INTEGRATED_CIRCUIT. Depending on the design of the
INTEGRATED_CIRCUIT, packets could be discarded even if interface queues are
not full, hence this scenario is NOT treated as QoS queue tail-drops nor WRED drops.
Yet another example is the case where extremely large and long
ACL/filter requires more cycles to process than the INTEGRATED_CIRCUIT
has budgeted.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
This aggregation of counters represents the conditions in which
packets are dropped due to legitimate forwarding decisions (ACL drops,
No Route etc.)
This counter counts packet discarded as result of processing
non-corrupted packet against legitimate, non-corrupted state
of INTEGRATED_CIRCUIT program (FIB content, ACL content, rate-limiting token-buckets)
which mandate packet drop. The examples of this class of discard are:
- dropping packets which destination address to no match any FIB entry
- dropping packets which destination address matches FIB entry pointing
to discard next-hop (e.g. route to null0)
- dropping packts due to ACL/packet filter decission
- dropping packets due to its TTL = 1
- dropping packets due to its size exceeds egress interface MTU and
packet can't be fragmented (IPv6 or do not fragment bit is set)
- dropping packets due to uRPF rules (note: packet is counted here and
in separate, urpf-aggregate counter simultaneously)
- etc
Note:The INTEGRATED_CIRCUIT is doing exactly what it is programmed
to do, and the packet is parsable.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
This aggregation of counters represents the conditions in which
packets are dropped due to failing uRPF lookup check. This counter
and the packet-processing-aggregate counter should be incremented
for each uRPF packet drop.
This counter counts packet discarded as result of Unicast Reverse
Path Forwarding verification.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
This aggregation of counters represents the conditions in which
packets are dropped due to no FIB entry for this ipv4 or ipv6 lookup.
This counter and the packet-processing-aggregate counter should be
incremented for each no-route packet drop.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The IC interface subsystem connects the IC to the external PHY or
MAC.
nodetype: container (ro)
description:
Drop counters corresponding to the interface subsystem of the
IC.
nodetype: container (ro)
description:
Number of packets dropped due to oversubscription of the
integrated-circuit subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming drops towards the integrated-circuit interface
subsystem block from the interfaces due to any reason.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing drops towards the interfaces from the
integrated-circuit interface subsystem block due to any reason.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The IC lookup subsystem perform the next hop lookup of the packet
and other forwarding features such as firewall filters.
nodetype: container (ro)
description:
Drop counters corresponding to the lookup subsystem of the IC.
nodetype: container (ro)
description:
Number of packets dropped due to oversubscription of the
integrated-circuit subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Packets dropped due to no FIB entry for this ipv4 or ipv6 lookup.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Packets dropped due to no FIB entry for this MPLS label.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Packets dropped due to no nexthop information - either the nexthop is
not programmed, or there is an invalid nexthop, or there is no ARP
information so the nexthop is in invalid state.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Packets dropped due to invalid packet format for ipv4, ipv6, or MPLS.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Packets dropped due to either a filter applied as part of a forwarding
policy or dropped due to a policy-based-routing policy lookup.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Packets dropped due to any incorrect or invalid software state of the
forwarding structures during lookup.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Packets dropped due to rate limiters - either user configured rate
limiters or system rate limiters in the forwarding path.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Total number of packets dropped that could not be fragmented by NPU
due to DF bit.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Packets dropped due to aggregate lookup drop counters - this counter
is sometimes referred to as Normal Discards or
ENQ_DISCARDED_PACKET_COUNTER.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Packets dropped due to firewall or acl terms.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The IC queueing subsystem buffers the packet while processing it
and queues the packet for delivery to the next stage
nodetype: container (ro)
description:
Drop counters corresponding to the queueing subsystem of the
IC.
nodetype: container (ro)
description:
Number of packets dropped due to oversubscription of the
integrated-circuit subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Packets dropped due to running out of the queue memory.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Packets dropped due to hardware of software incorrect state of VOQs,
or fabric queues, or interface queues.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Packets dropped in either the lookup or recirculation path.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The IC fabric block subsystem connects the IC to the external
systems fabric subsystem
nodetype: container (ro)
description:
Drop counters corresponding to the fabric subsystem of the IC.
nodetype: container (ro)
description:
Number of packets dropped due to oversubscription of the
integrated-circuit subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Fabric drops due to re-ordering, or due to packets arriving late, or
due to some loss in the fabric.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming high priority drops towards this integrated-circuit
subsystem block from the previous NPU sub-block or interface.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing high priority drops towards the fabric/interface from this
integrated-circuit subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming low priority drops towards this integrated-circuit
subsystem block from the previous NPU sub-block or interface.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing low priority drops towards the fabric/interface from this
integrated-circuit subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Aggregate of fabric-in and fabric-out drops.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The IC host interface block subsystem connects the IC to the
external systems host or control subsystem
nodetype: container (ro)
description:
Drop counters corresponding to the host interface subsystem of
the IC.
nodetype: container (ro)
description:
Number of packets dropped due to oversubscription of the
integrated-circuit subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Packet drops due to the rate limit in the integrated-circuit host
subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming high priority drops towards this integrated-circuit
subsystem block from the previous NPU sub-block or interface.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing high priority drops towards the fabric/interface from this
integrated-circuit subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Incoming low priority drops towards this integrated-circuit
subsystem block from the previous NPU sub-block or interface.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Outgoing low priority drops towards the fabric/interface from this
integrated-circuit subsystem block.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The packets that were failed to punt to CPU due to policing rate.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Aggregate of all the drops in the host path.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Counters within these containers are defined and augmented by vendors.
As each ASIC and vendor has different implementation and internal
parts where packets may be dropped at any point in time. Providing
specific hardware counters provides better visibility into traffic drop.
The recommended usage of this container is to create an augment at
.../pipeline-counter/drop/vendor that contains additional vendor/platform
specific containers.
e.g.
augment /components/component/integrated-circuit/pipeline-counter/drop/vendor {
container
nodetype: container (ro)
description:
IC errors for all five NPU sub-blocks.
nodetype: container (ro)
description:
The IC interface subsystem connects the IC to the external PHY or
MAC.
nodetype: container (ro)
description:
An individual error within the interface block. Each error counter
is uniquely identified by the name of the error.
nodetype: list (ro)
list keys: [name]
description:
Reference to the name of the error being described.
nodetype: leaf (list key) (ro)
type: leafref
description:
Errors corresponding to the interface subsystem of the IC.
nodetype: container (ro)
description:
Name of the interrupt, hardware error, or software error in the NPU.
nodetype: leaf (ro)
type: string
description:
Total count of errors of this type.
nodetype: leaf (ro)
type: uint64
description:
Number of errors before a recovery action is automatically
taken by the system.
nodetype: leaf (ro)
type: uint64
description:
Error actions that are taken by the system - log, linecard reboot,
linecard offline, NPU reset, NPU offline, gather diagnostic data,
raise an alarm.
nodetype: leaf-list (ro)
type: enumeration
description:
The error is currently in an active state. When the system detects
that the specified threshold is exceeded, this value should be set to
true.
nodetype: leaf (ro)
type: boolean
default: false
description:
The severity of the error that is being recorded by the system. This
value can be used by a consumer to determine the action when this error
is recorded.
nodetype: leaf (ro)
type: enumeration
description:
The IC lookup subsystem perform the next hop lookup of the packet
and other forwarding features such as firewall filters.
nodetype: container (ro)
description:
An individual error within the lookup block. Each error counter
is uniquely identified by the name of the error.
nodetype: list (ro)
list keys: [name]
description:
Reference to the name of the error being described.
nodetype: leaf (list key) (ro)
type: leafref
description:
Errors corresponding to the lookup subsystem of the IC.
nodetype: container (ro)
description:
Name of the interrupt, hardware error, or software error in the NPU.
nodetype: leaf (ro)
type: string
description:
Total count of errors of this type.
nodetype: leaf (ro)
type: uint64
description:
Number of errors before a recovery action is automatically
taken by the system.
nodetype: leaf (ro)
type: uint64
description:
Error actions that are taken by the system - log, linecard reboot,
linecard offline, NPU reset, NPU offline, gather diagnostic data,
raise an alarm.
nodetype: leaf-list (ro)
type: enumeration
description:
The error is currently in an active state. When the system detects
that the specified threshold is exceeded, this value should be set to
true.
nodetype: leaf (ro)
type: boolean
default: false
description:
The severity of the error that is being recorded by the system. This
value can be used by a consumer to determine the action when this error
is recorded.
nodetype: leaf (ro)
type: enumeration
description:
The IC queueing subsystem buffers the packet while processing it
and queues the packet for delivery to the next stage
nodetype: container (ro)
description:
An individual error within the queueing block. Each error counter
is uniquely identified by the name of the error.
nodetype: list (ro)
list keys: [name]
description:
Reference to the name of the error being described.
nodetype: leaf (list key) (ro)
type: leafref
description:
Errors corresponding to the queueing subsystem of the IC.
nodetype: container (ro)
description:
Name of the interrupt, hardware error, or software error in the NPU.
nodetype: leaf (ro)
type: string
description:
Total count of errors of this type.
nodetype: leaf (ro)
type: uint64
description:
Number of errors before a recovery action is automatically
taken by the system.
nodetype: leaf (ro)
type: uint64
description:
Error actions that are taken by the system - log, linecard reboot,
linecard offline, NPU reset, NPU offline, gather diagnostic data,
raise an alarm.
nodetype: leaf-list (ro)
type: enumeration
description:
The error is currently in an active state. When the system detects
that the specified threshold is exceeded, this value should be set to
true.
nodetype: leaf (ro)
type: boolean
default: false
description:
The severity of the error that is being recorded by the system. This
value can be used by a consumer to determine the action when this error
is recorded.
nodetype: leaf (ro)
type: enumeration
description:
The IC fabric block subsystem connects the IC to the external
systems fabric subsystem
nodetype: container (ro)
description:
An individual error within the fabric block. Each error counter
is uniquely identified by the name of the error.
nodetype: list (ro)
list keys: [name]
description:
Reference to the name of the error being described.
nodetype: leaf (list key) (ro)
type: leafref
description:
Errors corresponding to the fabric subsystem of the IC.
nodetype: container (ro)
description:
Name of the interrupt, hardware error, or software error in the NPU.
nodetype: leaf (ro)
type: string
description:
Total count of errors of this type.
nodetype: leaf (ro)
type: uint64
description:
Number of errors before a recovery action is automatically
taken by the system.
nodetype: leaf (ro)
type: uint64
description:
Error actions that are taken by the system - log, linecard reboot,
linecard offline, NPU reset, NPU offline, gather diagnostic data,
raise an alarm.
nodetype: leaf-list (ro)
type: enumeration
description:
The error is currently in an active state. When the system detects
that the specified threshold is exceeded, this value should be set to
true.
nodetype: leaf (ro)
type: boolean
default: false
description:
The severity of the error that is being recorded by the system. This
value can be used by a consumer to determine the action when this error
is recorded.
nodetype: leaf (ro)
type: enumeration
description:
The IC host interface block subsystem connects the IC to the
external systems host or control subsystem
nodetype: container (ro)
description:
An individual error within the host interface block. Each error
counter is uniquely identified by the name of the error.
nodetype: list (ro)
list keys: [name]
description:
Reference to the name of the error being described.
nodetype: leaf (list key) (ro)
type: leafref
description:
Errors corresponding to the host interface subsystem of
the IC.
nodetype: container (ro)
description:
Name of the interrupt, hardware error, or software error in the NPU.
nodetype: leaf (ro)
type: string
description:
Total count of errors of this type.
nodetype: leaf (ro)
type: uint64
description:
Number of errors before a recovery action is automatically
taken by the system.
nodetype: leaf (ro)
type: uint64
description:
Error actions that are taken by the system - log, linecard reboot,
linecard offline, NPU reset, NPU offline, gather diagnostic data,
raise an alarm.
nodetype: leaf-list (ro)
type: enumeration
description:
The error is currently in an active state. When the system detects
that the specified threshold is exceeded, this value should be set to
true.
nodetype: leaf (ro)
type: boolean
default: false
description:
The severity of the error that is being recorded by the system. This
value can be used by a consumer to determine the action when this error
is recorded.
nodetype: leaf (ro)
type: enumeration
description:
Counters that are related to traffic destined to the control-plane.
nodetype: container (ro)
description:
State container for control-plane traffic counters.
nodetype: container (ro)
description:
This captures the aggregation of all counters where the switch has enqueued
traffic related to the control-plane.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
This captures the aggregation of all counters in bytes where the switch has
enqueued traffic related to the control-plane.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
This captures the aggregation of all counters where the switch has dropped
traffic related to the control-plane.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
This captures the aggregation of all counters in bytes where the switch has
dropped traffic related to the control-plane.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Counters within these containers are defined and augmented by vendors.
As each ASIC and vendor has different implementation and internal
parts where packets may be dropped at any point in time. Providing
vendor-specific counters provides better visibility into control-plane traffic.
The recommended usage of this container is to create an augment at
.../pipeline-counter/control-plane-traffic/vendor that contains additional
vendor/platform specific containers.
e.g.
augment /components/component/integrated-circuit/pipeline-counter/control-plane-traffic/vendor {
container
nodetype: container (ro)
description:
This container allows a particular INTEGRATED_CIRCUIT to report its
available backplane-facing bandwidth. Where an integrated circuit is connected
by one or more links to the system's backplane, the capacity is the total cross-
sectional bandwidth available from the input ports of the integrated circuit
across the fabric. The capacity should also reflect the operational status of
the links.
nodetype: container (rw)
description:
Operational state parameters relating to backplane capacity.
nodetype: container (ro)
description:
Total backplane-facing capacity that is available in the presence
of no link failures or degradation.
nodetype: leaf (ro)
type: uint64
units: bits per second
description:
Total backplane-facing capacity that is currently available based
on the active links.
nodetype: leaf (ro)
type: uint64
units: bits per second
description:
Backplane-facing capacity that is consumed by front-panel ports that are connected
to the integrated circuit and are operationally up.
nodetype: leaf (ro)
type: uint64
units: bits per second
description:
Percentage of the total backplane-facing capacity that is currently available to the front
panel ports taking into account failures and/or degradation within the system.
In the case that there is more backplane-facing capacity available than the front-panel
ports consume, this value may be greater than 100%.
nodetype: leaf (ro)
type: uint16
description:
Container for integrated circuit memory.
nodetype: container (rw)
description:
Operational state parameters relating to integrated circuit memory.
nodetype: container (ro)
description:
Number of corrected parity errors. Single bit ECC errors can be
detected and corrected by most integrated circuits.
nodetype: leaf (ro)
type: uint64
description:
Number of uncorrected parity errors. Multi-bit ECC errors can be
detected but cannot be corrected by most integrated circuits.
nodetype: leaf (ro)
type: uint64
description:
Total number of parity errors. This includes both the corrected and
uncorrected parity errors.
nodetype: leaf (ro)
type: uint64
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:
Type of the software module
nodetype: leaf (ro)
type: identityref
description:
Data for controller card components, i.e., for components
with type=CONTROLLER_CARD
nodetype: container (rw)
description:
Configuration data for controller card components.
nodetype: container (rw)
description:
When set to POWER_DISABLED, the component should be shut down by removing
electrical power. This is intended to be used to prevent the component
from becoming active even after a reboot of the system. A component
(if controller-card) may not honor power-admin-state depending on rules
defined in the description of the component config container.
nodetype: leaf (rw)
type: oc-platform-types:component-power-type
default: POWER_ENABLED
description:
Operational state data for controller card components
nodetype: container (ro)
description:
When set to POWER_DISABLED, the component should be shut down by removing
electrical power. This is intended to be used to prevent the component
from becoming active even after a reboot of the system. A component
(if controller-card) may not honor power-admin-state depending on rules
defined in the description of the component config container.
nodetype: leaf (ro)
type: oc-platform-types:component-power-type
default: POWER_ENABLED
description:
Top-level container for client port transceiver data
nodetype: container (rw)
description:
Configuration data for client port transceivers
nodetype: container (rw)
description:
Turns power on / off to the transceiver -- provides a means
to power on/off the transceiver (in the case of SFP, SFP+,
QSFP,...) or enable high-power mode (in the case of CFP,
CFP2, CFP4) and is optionally supported (device can choose to
always enable). True = power on / high power, False =
powered off
nodetype: leaf (rw)
type: boolean
description:
Indicates the type of optical transceiver used on this
port. If the client port is built into the device and not
pluggable, then non-pluggable is the corresponding state. If
a device port supports multiple form factors (e.g. QSFP28
and QSFP+, then the value of the transceiver installed shall
be reported. If no transceiver is present, then the value of
the highest rate form factor shall be reported
(QSFP28, for example).
The form factor is included in configuration data to allow
pre-configuring a device with the expected type of
transceiver ahead of deployment. The corresponding state
leaf should reflect the actual transceiver type plugged into
the system.
nodetype: leaf (rw)
type: identityref
description:
The Ethernet PMD is a property of the optical transceiver
used on the port, indicating the type of physical connection.
It is included in configuration data to allow pre-configuring
a port/transceiver with the expected PMD. The actual PMD is
indicated by the ethernet-pmd state leaf.
nodetype: leaf (rw)
type: identityref
description:
The FEC mode indicates the mode of operation for the
transceiver's FEC. This defines typical operational modes
and does not aim to specify more granular FEC capabilities.
nodetype: leaf (rw)
type: identityref
description:
Indicates the module functional type which represents the
functional capability of the transceiver. For example, this
would specify the module is a digital coherent optic or a
standard grey optic that performs on-off keying.
nodetype: leaf (rw)
type: identityref
description:
Operational state data for client port transceivers
nodetype: container (ro)
description:
Turns power on / off to the transceiver -- provides a means
to power on/off the transceiver (in the case of SFP, SFP+,
QSFP,...) or enable high-power mode (in the case of CFP,
CFP2, CFP4) and is optionally supported (device can choose to
always enable). True = power on / high power, False =
powered off
nodetype: leaf (ro)
type: boolean
description:
Indicates the type of optical transceiver used on this
port. If the client port is built into the device and not
pluggable, then non-pluggable is the corresponding state. If
a device port supports multiple form factors (e.g. QSFP28
and QSFP+, then the value of the transceiver installed shall
be reported. If no transceiver is present, then the value of
the highest rate form factor shall be reported
(QSFP28, for example).
The form factor is included in configuration data to allow
pre-configuring a device with the expected type of
transceiver ahead of deployment. The corresponding state
leaf should reflect the actual transceiver type plugged into
the system.
nodetype: leaf (ro)
type: identityref
description:
The Ethernet PMD is a property of the optical transceiver
used on the port, indicating the type of physical connection.
It is included in configuration data to allow pre-configuring
a port/transceiver with the expected PMD. The actual PMD is
indicated by the ethernet-pmd state leaf.
nodetype: leaf (ro)
type: identityref
description:
The FEC mode indicates the mode of operation for the
transceiver's FEC. This defines typical operational modes
and does not aim to specify more granular FEC capabilities.
nodetype: leaf (ro)
type: identityref
description:
Indicates the module functional type which represents the
functional capability of the transceiver. For example, this
would specify the module is a digital coherent optic or a
standard grey optic that performs on-off keying.
nodetype: leaf (ro)
type: identityref
description:
Indicates whether a transceiver is present in
the specified client port.
nodetype: leaf (ro)
type: enumeration
description:
Indicates the type of optical transceiver used on this
port. If the client port is built into the device and not
pluggable, then non-pluggable is the corresponding state. If
a device port supports multiple form factors (e.g. QSFP28
and QSFP+, then the value of the transceiver installed shall
be reported. If no transceiver is present, then the value of
the highest rate form factor shall be reported
(QSFP28, for example).
nodetype: leaf (ro)
type: identityref
description:
Connector type used on this port
nodetype: leaf (ro)
type: identityref
description:
Full name of transceiver vendor. 16-octet field that
contains ASCII characters, left-aligned and padded on the
right with ASCII spaces (20h)
nodetype: leaf (ro)
type: string
description:
Transceiver vendor's part number. 16-octet field that
contains ASCII characters, left-aligned and padded on the
right with ASCII spaces (20h). If part number is undefined,
all 16 octets = 0h
nodetype: leaf (ro)
type: string
description:
Transceiver vendor's revision number. Field of 1 to 4 octets that
contains ASCII characters, left-aligned and padded on the
right with ASCII spaces (20h)
nodetype: leaf (ro)
type: string
description:
Ethernet PMD (physical medium dependent sublayer) that the
transceiver supports. The SFF/QSFP MSAs have registers for
this and CFP MSA has similar.
nodetype: leaf (ro)
type: identityref
description:
SONET/SDH application code supported by the port
nodetype: leaf (ro)
type: identityref
description:
OTN application code supported by the port
nodetype: leaf (ro)
type: identityref
description:
Transceiver serial number. 16-octet field that contains
ASCII characters, left-aligned and padded on the right with
ASCII spaces (20h). If part serial number is undefined, all
16 octets = 0h
nodetype: leaf (ro)
type: string
description:
Representation of the transceiver date code, typically
stored as YYMMDD. The time portion of the value is
undefined and not intended to be read.
nodetype: leaf (ro)
type: oc-yang:date-and-time
description:
Indicates if a fault condition exists in the transceiver
nodetype: leaf (ro)
type: boolean
description:
Operational status of FEC
nodetype: leaf (ro)
type: identityref
description:
The number of blocks that were uncorrectable by the FEC
nodetype: leaf (ro)
type: yang:counter64
description:
The number of words that were uncorrectable by the FEC
nodetype: leaf (ro)
type: yang:counter64
description:
The number of bytes that were corrected by the FEC
nodetype: leaf (ro)
type: yang:counter64
description:
The number of bits that were corrected by the FEC
nodetype: leaf (ro)
type: yang:counter64
description:
Bit error rate before forward error correction -- computed
value with 18 decimal precision. Note that decimal64
supports values as small as i x 10^-18 where i is an
integer. Values smaller than this should be reported as 0
to inidicate error free or near error free performance.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
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:
Bit error rate after forward error correction -- computed
value with 18 decimal precision. Note that decimal64
supports values as small as i x 10^-18 where i is an
integer. Values smaller than this should be reported as 0
to inidicate error free or near error free performance.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
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:
Supply voltage to the transceiver in volts with 2 decimal
precision. Values include the instantaneous, average, minimum,
and maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the instant
value.
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: volts
description:
The arithmetic mean value of the statistic over the
sampling period.
nodetype: leaf (ro)
type: decimal64
units: volts
description:
The minimum value of the statistic over the sampling
period
nodetype: leaf (ro)
type: decimal64
units: volts
description:
The maximum value of the statistic over the sampling
period
nodetype: leaf (ro)
type: decimal64
units: volts
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:
The output optical power of a physical channel in units
of 0.01dBm, which may be associated with individual
physical channels, or an aggregate of multiple physical
channels (i.e., for the overall transceiver). For an
aggregate, this may be a measurement from a photodetector
or a a calculation performed on the device by summing up
all of the related individual physical channels.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value. In some cases, such as when the physical
channel has a leafref to an optical channel component and the
module-functional-type is TYPE_DIGITAL_COHERENT_OPTIC this
grouping will NOT be used as the data will be within the
optical-channel
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:
The input optical power of a physical channel in units
of 0.01dBm, which may be associated with individual
physical channels, or an aggregate of multiple physical
channels (i.e., for the overall transceiver). For an
aggregate, this may be a measurement from a photodetector
or a a calculation performed on the device by summing up
all of the related individual physical channels.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value. When the physical channel has a leafref to
an optical channel component and the module-functional-type is
TYPE_DIGITAL_COHERENT_OPTIC this represents the aggregate
total optical power value (signal and noise) whereas
optical power value within the optical-channel represents
the signal power
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:
The current applied by the system to the transmit laser to
achieve the output power. The current is expressed in mA
with up to two decimal precision. Values include the
instantaneous, average, minimum, and maximum statistics.
If avg/min/max statistics are not supported, the target is
expected to just supply the instant value. In some cases,
such as when the physical channel has a leafref to an optical
channel component and the module-functional-type is
TYPE_DIGITAL_COHERENT_OPTIC this grouping will NOT be used
as the data will be within the optical-channel
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: mA
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: mA
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: mA
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: mA
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:
Enclosing container for client channels
nodetype: container (rw)
description:
List of client channels, keyed by index within a physical
client port. A physical port with a single channel would
have a single zero-indexed element
nodetype: list (rw)
list keys: [index]
description:
Reference to the index number of the channel
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for physical channels
nodetype: container (rw)
description:
Index of the physical channnel or lane within a physical
client port
nodetype: leaf (rw)
type: uint16
description:
A physical channel may reference an optical channel
component. If the physical channel does make this optional
reference, then a limited set of leaves will apply within
the physical channel to avoid duplication within the optical
channel.
nodetype: leaf (rw)
type: leafref
description:
Text description for the client physical channel
nodetype: leaf (rw)
type: string
description:
Enable (true) or disable (false) the transmit label for the
channel
nodetype: leaf (rw)
type: boolean
description:
Target output optical power level of the optical channel,
expressed in increments of 0.01 dBm (decibel-milliwats)
nodetype: leaf (rw)
type: decimal64
units: dBm
description:
Operational state data for channels
nodetype: container (ro)
description:
Index of the physical channnel or lane within a physical
client port
nodetype: leaf (ro)
type: uint16
description:
A physical channel may reference an optical channel
component. If the physical channel does make this optional
reference, then a limited set of leaves will apply within
the physical channel to avoid duplication within the optical
channel.
nodetype: leaf (ro)
type: leafref
description:
Text description for the client physical channel
nodetype: leaf (ro)
type: string
description:
Enable (true) or disable (false) the transmit label for the
channel
nodetype: leaf (ro)
type: boolean
description:
Target output optical power level of the optical channel,
expressed in increments of 0.01 dBm (decibel-milliwats)
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
Laser age (0% at beginning of life, 100% end of life) in integer
percentage. This term is defined by Common Management Interface
Specification (CMIS).
nodetype: leaf (ro)
type: oc-types:percentage
description:
Laser temperature for the cooled laser in degrees Celsius with 1
decimal precision. This term is defined by Common Management
Interface Specification (CMIS). Values include the instantaneous,
average, minimum, and maximum statistics. If avg/min/max statistics
are not supported, the target is expected to just supply the
instant value.
nodetype: container (ro)
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:
The difference in MHz with 1 decimal precision between the target
center frequency and the actual current center frequency . This term
is defined by Common Management Interface Specification (CMIS) and
referred to as laser frequency error or laser ferquency deviation.
Values include the instantaneous, average, minimum, and maximum
statistics. If avg/min/max statistics are not supported, the target
is expected to just supply the instant value.
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: MHz
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: MHz
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: MHz
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: MHz
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:
The amount of current flowing to the TC of a cooled laser in percentage
with 2 decimal precision. This term is defined by Common Management
Interface Specification (CMIS). Values include the instantaneous,
average, minimum, and maximum statistics. If avg/min/max statistics
are not supported, the target is expected to just supply the instant
value.
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
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:
Transmitter failure flag.
In earlier standards, including SFF-8436, SFF-8472, and QSFP-DD CMIS 4.0,
this flag was named Tx Fault.
nodetype: leaf (ro)
type: boolean
description:
Receiver loss-of-signal flag.
nodetype: leaf (ro)
type: boolean
description:
Receiver clock-and-data-recovery loss-of-lock flag.
nodetype: leaf (ro)
type: boolean
description:
The frequency in MHz of the individual physical channel
(e.g. ITU C50 - 195.0THz and would be reported as
195,000,000 MHz in this model). This attribute is not
configurable on most client ports In some cases, such as when
the physical channel has a leafref to an optical channel
component and the module-functional-type is
TYPE_DIGITAL_COHERENT_OPTIC this grouping will NOT be used
as the data will be within the optical-channel.
nodetype: leaf (ro)
type: oc-opt-types:frequency-type
description:
The output optical power of a physical channel in units
of 0.01dBm, which may be associated with individual
physical channels, or an aggregate of multiple physical
channels (i.e., for the overall transceiver). For an
aggregate, this may be a measurement from a photodetector
or a a calculation performed on the device by summing up
all of the related individual physical channels.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value. In some cases, such as when the physical
channel has a leafref to an optical channel component and the
module-functional-type is TYPE_DIGITAL_COHERENT_OPTIC this
grouping will NOT be used as the data will be within the
optical-channel
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:
The input optical power of a physical channel in units
of 0.01dBm, which may be associated with individual
physical channels, or an aggregate of multiple physical
channels (i.e., for the overall transceiver). For an
aggregate, this may be a measurement from a photodetector
or a a calculation performed on the device by summing up
all of the related individual physical channels.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value. When the physical channel has a leafref to
an optical channel component and the module-functional-type is
TYPE_DIGITAL_COHERENT_OPTIC this represents the aggregate
total optical power value (signal and noise) whereas
optical power value within the optical-channel represents
the signal power
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:
The current applied by the system to the transmit laser to
achieve the output power. The current is expressed in mA
with up to two decimal precision. Values include the
instantaneous, average, minimum, and maximum statistics.
If avg/min/max statistics are not supported, the target is
expected to just supply the instant value. In some cases,
such as when the physical channel has a leafref to an optical
channel component and the module-functional-type is
TYPE_DIGITAL_COHERENT_OPTIC this grouping will NOT be used
as the data will be within the optical-channel
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: mA
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: mA
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: mA
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: mA
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:
Enclosing container for host lanes.
nodetype: container (rw)
description:
List of electrical host lanes, keyed by lane number.
The host lanes of a transceiver constitute its electrical interface
with the host system.
nodetype: list (rw)
list keys: [lane-number]
description:
Reference to the host lane number.
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for host lanes.
nodetype: container (rw)
description:
Number identifying an electrical host lane carrying one serial
signal. Lanes are numbered starting with 1.
nodetype: leaf (rw)
type: uint8
description:
Operational state data for host lanes.
nodetype: container (ro)
description:
Number identifying an electrical host lane carrying one serial
signal. Lanes are numbered starting with 1.
nodetype: leaf (ro)
type: uint8
description:
Transmitter loss-of-signal flag.
nodetype: leaf (ro)
type: boolean
description:
Transmitter clock-and-data-recovery loss-of-lock flag.
nodetype: leaf (ro)
type: boolean
description:
Enclosing container for transceiver alarm thresholds.
nodetype: container (rw)
description:
List of transceiver alarm thresholds, indexed by
alarm severity.
nodetype: list (ro)
list keys: [severity]
description:
The severity applied to the group of thresholds.
An implementation's highest severity threshold
should be mapped to OpenConfig's `CRITICAL`
severity level.
nodetype: leaf (list key) (ro)
type: leafref
description:
Operational alarm thresholds for the transceiver.
nodetype: container (ro)
description:
The type of alarm to which the thresholds apply.
nodetype: leaf (ro)
type: identityref
description:
The upper temperature threshold for the laser temperature sensor.
This leaf value is compared to the instant value of
laser-temperature.
nodetype: leaf (ro)
type: decimal64
units: celsius
description:
The lower temperature threshold for the laser temperature sensor.
This leaf value is compared to the instant value of
laser-temperature.
nodetype: leaf (ro)
type: decimal64
units: celsius
description:
The upper power threshold for the laser output power. This threshold
applies to every physical-channel on the transceiver and does not
apply to the aggregate transceiver optical-output-power. This leaf
value is compared to the instant value of optical-output-power.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The lower power threshold for the laser output power. This threshold
applies to every physical-channel on the transceiver and does not
apply to the aggregate transceiver optical-output-power. This leaf
value is compared to the instant value of optical-output-power.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The upper power threshold for the laser input power. This threshold
applies to every physical-channel on the transceiver and does not
apply to the aggregate transceiver optical-input-power. This leaf
value is compared to the instant value of optical-input-power.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The lower power threshold for the laser input power. This threshold
applies to every physical-channel on the transceiver and does not
apply to the aggregate transceiver optical-input-power. This leaf
value is compared to the instant value of optical-input-power.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
The upper threshold for the laser bias current. This leaf value is
compared to the instant value of last-bias-current.
nodetype: leaf (ro)
type: decimal64
units: mA
description:
The lower threshold for the laser bias current. This leaf value is
compared to the instant value of last-bias-current.
nodetype: leaf (ro)
type: decimal64
units: mA
description:
The upper threshold for the transceiver supply voltage. This leaf
value is compared to the instant value of supply-voltage.
nodetype: leaf (ro)
type: decimal64
units: volts
description:
The lower threshold for the transceiver supply voltage. This leaf
value is compared to the instant value of supply-voltage.
nodetype: leaf (ro)
type: decimal64
units: volts
description:
The lower temperature threshold for the transceiver module. This
leaf value is compared to the instant value of module-temperature.
nodetype: leaf (ro)
type: decimal64
units: celsius
description:
The upper temperature threshold for the transceiver module. This
leaf value is compared to the instant value of module-temperature.
nodetype: leaf (ro)
type: decimal64
units: celsius
description:
Top-level container for linecard data
nodetype: container (rw)
description:
Configuration data for linecards
nodetype: container (rw)
description:
When set to POWER_DISABLED, the component should be shut down by removing
electrical power. This is intended to be used to prevent the component
from becoming active even after a reboot of the system. A component
(if controller-card) may not honor power-admin-state depending on rules
defined in the description of the component config container.
nodetype: leaf (rw)
type: oc-platform-types:component-power-type
default: POWER_ENABLED
description:
Operational state data for linecards
nodetype: container (ro)
description:
When set to POWER_DISABLED, the component should be shut down by removing
electrical power. This is intended to be used to prevent the component
from becoming active even after a reboot of the system. A component
(if controller-card) may not honor power-admin-state depending on rules
defined in the description of the component config container.
nodetype: leaf (ro)
type: oc-platform-types:component-power-type
default: POWER_ENABLED
description:
Identifier for the slot or chassis position in which the
linecard is installed.
This leaf is deprecated and will be replaced by install-position
and install-component leaves in a future major revision of this
model.
nodetype: leaf (ro)
type: string
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:
The health of the component. The paramaters within this
container indicate the status of the component beyond whether
it is operationally up or down. When a signal is received
that a component is in an unhealthy state the gNOI.Healthz
service can be used to retrieve further diagnostic information
relating to the component.
The contents of this directory relate only to the specific
component that it is associated with. In the case that child
components become unhealthy and this causes a parent component
to be unhealthy, the new unhealthy status should be reported at
both components, such that an interested system can take the
relevant actions (e.g., retrieve the Healthz output, or
apply mitigation actions).
nodetype: container (rw)
description:
Operational state parameters relating to component health.
nodetype: container (ro)
description:
The status of the component, indicating its current health.
nodetype: leaf (ro)
type: enumeration
description:
The time at which the component as last observed to be unhealthy
represented as nanoseconds since the Unix epoch. Unhealthy is defined
as the component being in a state other than HEALTHY.
nodetype: leaf (ro)
type: oc-types:timeticks64
description:
The number of status checks that have determined this component
to be in an unhealthy state. This counter should be incremented
when the component transitions from the HEALTHY to any other
state such that the value reflects the number of times the
component has become unhealthy.
nodetype: leaf (ro)
type: uint64
description:
Enclosing container for the list of optical channels
nodetype: container (rw)
description:
Configuration data for optical channels
nodetype: container (rw)
description:
Frequency of the optical channel, expressed in MHz
nodetype: leaf (rw)
type: oc-opt-types:frequency-type
description:
Target output optical power level of the optical channel,
expressed in increments of 0.01 dBm (decibel-milliwats)
nodetype: leaf (rw)
type: decimal64
units: dBm
description:
Vendor-specific mode identifier -- sets the operational
mode for the channel. The specified operational mode must
exist in the list of supported operational modes supplied
by the device
nodetype: leaf (rw)
type: uint16
description:
Reference to the line-side physical port that carries
this optical channel. The target port should be
a component in the physical inventory data model.
nodetype: leaf (rw)
type: leafref
description:
Operational state data for optical channels
nodetype: container (ro)
description:
Frequency of the optical channel, expressed in MHz
nodetype: leaf (ro)
type: oc-opt-types:frequency-type
description:
Target output optical power level of the optical channel,
expressed in increments of 0.01 dBm (decibel-milliwats)
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
Vendor-specific mode identifier -- sets the operational
mode for the channel. The specified operational mode must
exist in the list of supported operational modes supplied
by the device
nodetype: leaf (ro)
type: uint16
description:
Reference to the line-side physical port that carries
this optical channel. The target port should be
a component in the physical inventory data model.
nodetype: leaf (ro)
type: leafref
description:
If the device places constraints on which optical
channels must be managed together (e.g., transmitted on the
same line port), it can indicate that by setting the group-id
to the same value across related optical channels.
nodetype: leaf (ro)
type: uint32
description:
Reference to the logical channel that is directly assigned
to this optical channel if it is assigned to a logical channel.
The logical channel must also reference this optical channel at
logical-channel-assignments/assignment/state/optical-channel
nodetype: leaf (ro)
type: leafref
description:
The output optical power of a physical channel in units
of 0.01dBm, which may be associated with individual
physical channels, or an aggregate of multiple physical
channels (i.e., for the overall transceiver). For an
aggregate, this may be a measurement from a photodetector
or a a calculation performed on the device by summing up
all of the related individual physical channels.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value. In some cases, such as when the physical
channel has a leafref to an optical channel component and the
module-functional-type is TYPE_DIGITAL_COHERENT_OPTIC this
grouping will NOT be used as the data will be within the
optical-channel
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:
The input optical power of a physical channel in units
of 0.01dBm, which may be associated with individual
physical channels, or an aggregate of multiple physical
channels (i.e., for the overall transceiver). For an
aggregate, this may be a measurement from a photodetector
or a a calculation performed on the device by summing up
all of the related individual physical channels.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value. When the physical channel has a leafref to
an optical channel component and the module-functional-type is
TYPE_DIGITAL_COHERENT_OPTIC this represents the aggregate
total optical power value (signal and noise) whereas
optical power value within the optical-channel represents
the signal power
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:
The current applied by the system to the transmit laser to
achieve the output power. The current is expressed in mA
with up to two decimal precision. Values include the
instantaneous, average, minimum, and maximum statistics.
If avg/min/max statistics are not supported, the target is
expected to just supply the instant value. In some cases,
such as when the physical channel has a leafref to an optical
channel component and the module-functional-type is
TYPE_DIGITAL_COHERENT_OPTIC this grouping will NOT be used
as the data will be within the optical-channel
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: mA
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: mA
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: mA
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: mA
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:
Chromatic Dispersion of an optical channel in
picoseconds / nanometer (ps/nm) as reported by receiver
with two decimal precision. Values include the instantaneous,
average, minimum, and maximum statistics. If avg/min/max
statistics are not supported, the target is expected to just
supply the instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: ps-nm
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: ps-nm
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: ps-nm
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: ps-nm
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:
Polarization Mode Dispersion of an optical channel
in picosends (ps) as reported by receiver with two decimal
precision. Values include the instantaneous, average,
minimum, and maximum statistics. If avg/min/max statistics
are not supported, the target is expected to just supply the
instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: ps
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: ps
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: ps
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: ps
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:
Second Order Polarization Mode Dispersion of an optical
channel in picoseconds squared (ps^2) as reported by
receiver with two decimal precision. Values include the
instantaneous, average, minimum, and maximum statistics.
If avg/min/max statistics are not supported, the target
is expected to just supply the instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: ps^2
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: ps^2
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: ps^2
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: ps^2
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:
Polarization Dependent Loss of an optical channel
in dB as reported by receiver with two decimal precision.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dB
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:
The bias on in-phase path and Polarization X of
the coherent modulator. This is represented as a percentage
with 2 decimal precision. This term is defined by OIF
Implementation Agreement for Coherent CMIS. Values include
the instantaneous, average, minimum, and maximum statistics.
If avg/min/max statistics are not supported, the target is
expected to just supply the instant value.
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
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:
The bias on quadrature path and Polarization X of
the coherent modulator. This is represented as a percentage
with 2 decimal precision. This term is defined by OIF
Implementation Agreement for Coherent CMIS. Values include
the instantaneous, average, minimum, and maximum statistics.
If avg/min/max statistics are not supported, the target is
expected to just supply the instant value.
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
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:
The bias on in-phase path and Polarization Y of
the coherent modulator. This is represented as a percentage
with 2 decimal precision. This term is defined by OIF
Implementation Agreement for Coherent CMIS. Values include
the instantaneous, average, minimum, and maximum statistics.
If avg/min/max statistics are not supported, the target is
expected to just supply the instant value.
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
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:
The bias on quadrature path and Polarization Y of
the coherent modulator. This is represented as a percentage
with 2 decimal precision. This term is defined by OIF
Implementation Agreement for Coherent CMIS. Values include
the instantaneous, average, minimum, and maximum statistics.
If avg/min/max statistics are not supported, the target is
expected to just supply the instant value.
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
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:
The X-Phase bias of the coherent modulator. This is
represented as a percentage with 2 decimal precision. This
term is defined by OIF Implementation Agreement for
Coherent CMIS. Values include the instantaneous, average,
minimum, and maximum statistics. If avg/min/max statistics
are not supported, the target is expected to just supply
the instant value.
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
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:
The Y-Phase bias of the coherent modulator. This is
represented as a percentage with 2 decimal precision. This
term is defined by OIF Implementation Agreement for
Coherent CMIS. Values include the instantaneous, average,
minimum, and maximum statistics. If avg/min/max statistics
are not supported, the target is expected to just supply
the instant value.
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: percentage
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:
Optical signal to noise ratio at 12.5GHz noise bandwidth
in dB with two decimal precision. Values include the
instantaneous, average, minimum, and maximum statistics.
If avg/min/max statistics are not supported, the target
is expected to just supply the instant value.
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dB
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:
Carrier frequency offset in MHz with 1 decimal precision.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not supported,
the target is expected to just supply the instant value.
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: MHz
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: MHz
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: MHz
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: MHz
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:
State-of-polarization rate-of-change (SOP-ROC) in krad/s with 1
decimal precision. This term is defined by OIF Implementation
Agreement for Coherent CMIS. Values include the instantaneous,
average, minimum, and maximum statistics. If avg/min/max
statistics are not supported, the target is expected to just
supply the instant value.
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: krad/s
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: krad/s
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: krad/s
description:
The maximum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: krad/s
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:
Modulation error ratio in dB with two decimal precision. Values
include the instantaneous, average, minimum, and maximum statistics.
If avg/min/max statistics are not supported, the target is
expected to just supply the instant value.
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dB
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:
The number of blocks or frames that were uncorrectable by
the FEC
nodetype: leaf (ro)
type: yang:counter64
description:
Bit error rate before forward error correction -- computed
value with 18 decimal precision. Note that decimal64
supports values as small as i x 10^-18 where i is an
integer. Values smaller than this should be reported as 0
to inidicate error free or near error free performance.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
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:
Bit error rate after forward error correction -- computed
value with 18 decimal precision. Note that decimal64
supports values as small as i x 10^-18 where i is an
integer. Values smaller than this should be reported as 0
to inidicate error free or near error free performance.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
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:
Quality value (factor) in dB of a channel with two
decimal precision. Values include the instantaneous,
average, minimum, and maximum statistics. If avg/min/max
statistics are not supported, the target is expected
to just supply the instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dB
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:
Electrical signal to noise ratio. Baud rate
normalized signal to noise ratio based on
error vector magnitude in dB with two decimal
precision. Values include the instantaneous, average,
minimum, and maximum statistics. If avg/min/max
statistics are not supported, the target is expected
to just supply the instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dB
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 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:
Records how the last power-off was 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:
Contains multiple fans that work in unison to cool the router components.
base identity: OPENCONFIG_HARDWARE_COMPONENT
description:
Controls the fan trays.
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 module defines configuration and operational state data for transceivers (i.e., pluggable optics). The module should be used in conjunction with the platform model where other physical entity data are represented.
In the platform model, a component of type=TRANSCEIVER is expected to be a subcomponent of a PORT component. This module defines a concrete schema for the associated data for components with type=TRANSCEIVER.
A transceiver will always contain physical-channel(s), however when a line side optical-channel is present (i.e. ZR+ optics) the physical-channel will reference its optical-channel. In this case, the optical-channels components must be subcomponents of the transceiver. The relationship between the physical-channel and the optical-channel allows for multiple optical-channels to be associated with a transceiver in addition to ensuring certain leaves (i.e. output-power) are not duplicated in multiple components.
If a transceiver contains a digital signal processor (DSP), such as with ZR+ optics, the modeling will utilize hierarchical components as follows: PORT --> TRANSCEIVER --> OPTICAL_CHANNEL(s) The signal will then traverse through a series of terminal-device/logical-channels as required. The first logical-channel connected to the OPTICAL_CHANNEL will utilize the assignment/optical-channel leaf to create the relationship. At the conclusion of the series of logical-channels, the logical-channel will be associated to its host / client side based on: * If the TRANSCEIVER is directly within a router or switch, then it will use the logical-channel ingress leaf to specify the interface it is associated with. * If the TRANSCEIVER is within a dedicated terminal (Layer 1) device, then it will use the logical-channel ingress leaf to specify a physical-channel within a TRANSCEIVER component (i.e. gray optic) that it is associated with.
ietf-yang-types
openconfig-platform
openconfig-platform-types
openconfig-platform-port
openconfig-interfaces
openconfig-transport-types
openconfig-types
openconfig-extensions
openconfig-yang-types
openconfig-alarm-types
This module defines data related to LINECARD components in the openconfig-platform model
openconfig-platform
openconfig-extensions
This module defines data related to PORT components in the openconfig-platform model
openconfig-platform
openconfig-interfaces
openconfig-if-ethernet
openconfig-extensions
This module defines a schema for power supply components in the OpenConfig platform model.
openconfig-extensions
openconfig-types
openconfig-platform
This module defines data related to FAN components in the OpenConfig platform model.
openconfig-platform
openconfig-extensions
This module defines data related to FAN components in the OpenConfig platform model.
openconfig-platform
openconfig-types
openconfig-extensions
This module defines optional extensions to the OpenConfig platform model.
openconfig-platform
openconfig-extensions
This module defines data related to software components in the openconfig-platform model
openconfig-platform
openconfig-extensions
description:
Base identity for defining various types of software
modules.
description:
A collection of userspace software modules that are grouped, and
possibly versioned, together. A package bundle may have
subcomponents that represent individual elements in the bundle
and their properties.
base identity: SOFTWARE_MODULE_TYPE
description:
An individual software package that runs in user space. The
package may be part of a package bundle.
base identity: SOFTWARE_MODULE_TYPE
This module defines data related to STORAGE components in the OpenConfig platform model.
Portions of this code were derived from the following copyright holders. References to each copyright holder are mentioned where related content is used.
NVM Express Base Specification Revision 2.0a https://nvmexpress.org/wp-content/uploads/NVMe-NVM-Express-2.0a-2021.07.26-Ratified.pdf (c) Copyright 2007 to 2021 NVM Express, Inc. ALL RIGHTS RESERVED. This NVM Express Base Specification, revision 2.0a is proprietary to the NVM Express, Inc. (also referred to as “Company”) and/or its successors and assigns.
S.M.A.R.T. Attribute: Reallocated Sectors Count | Knowledge Base http://kb.acronis.com.
openconfig-platform
openconfig-extensions
openconfig-yang-types
This module defines data related to FABRIC components in the openconfig-platform model
openconfig-platform
openconfig-extensions
Provide fine grain, per-Integrated Circuit (IC), telemetry data streams that will identify the health, any packet drops, and any errors on the IC. With this additional telemetry, the health of the IC, packet drops and errors, can be explicitly monitored not only on a specific router, but also on a specific IC on a specific router. The IC is divided into 5 platform independent sub-blocks. 1. IC Interface Subsystem 2. Queueing Subsystem 3. Lookup Subsystem 4. Host Interface 5. Fabric Interface. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ | | | +---------------------------------------------------------------+ | | | Integrated +---------------------------------------+ | | | | Circuit | Host Interface | | | | | +---------------------------------------+ | | | | +------------+ | | | | +-----------+ | Lookup | +-------------+ | | | | | IC | | Subsystem | | Fabric | | | | | | Interface | | | | Interface | | | | | | Subsystem | +------------+ | | | | | | +-----------+ +-------------+ +-------------+ | | | | | Queueing | | | | | | Subsystem | | | | | +-------------+ | | | | | | | +---------------------------------------------------------------+ | | | +-------------------------------------------------------------------+ Each IC implementation inside forwarding engines may have a different set of counters. Some counters have different names but the same functionality and can be grouped together. Most counters are different between IC families and will have to be aggregated as generic counters. The aggregation could mean either a specific IC counter needs to be mapped to one of the values specified in this model, or it may require multiple IC counters aggregated to produce one of the values in this model. The following classes of counters will generalize the types of statistics that are provided from each of the above 5 blocks. A. Packet Counters B. Drop Counters C. Error Counters The advantage of grouping all the packet counters for all 5 blocks, all drop counters from all 5 blocks, and all error counters from all 5 blocks, is to have the abililty to receive all drop counters from all 5 blocks, for example, with one request.
openconfig-yang-types
openconfig-types
openconfig-extensions
openconfig-platform
This module defines extensions to the OpenConfig platform model that apply to integrated circuit (INTEGRATED_CIRCUIT) components. These components are generically forwarding NPUs or ASICs within the system for which configuration or state is applicable.
openconfig-platform
openconfig-extensions
This module defines data related to CONTROLLER_CARD components in the openconfig-platform model
openconfig-platform
openconfig-extensions
This model defines health-related variables for components within the openconfig-platform model (which defines the the /components hierarchy). It is designed to be used in conjunction with the gNOI Healthz service (see https://github.com/openconfig/gnoi/blob/main/healthz/README.md).
The health variables included in this model are streamed via telemetry interfaces, where gNOI.Healthz is used to retrieve further diagnostic and debugging informaton from a network device.
openconfig-extensions
openconfig-types
openconfig-platform
This module defines a set of extensions that provide P4Runtime (P4RT) specific extensions to the OpenConfig data models. Specifically, these parameters for configuration and state provide extensions that control the P4RT service, or allow it to be used alongside other OpenConfig data models.
The P4RT protocol specification is linked from https://p4.org/specs/ under the P4Runtime heading.
openconfig-extensions
openconfig-interfaces
openconfig-platform
openconfig-system-grpc
This module defines operational state data related to alarms that the device is reporting.
This model reuses some data items defined in the draft IETF YANG Alarm Module: https://tools.ietf.org/html/draft-vallin-netmod-alarm-module-02
Portions of this code were derived from the draft IETF YANG Alarm Module. Please reproduce this note if possible.
IETF code is subject to the following copyright and license: Copyright (c) IETF Trust and the persons identified as authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info).
openconfig-alarm-types
openconfig-extensions
openconfig-types
openconfig-platform
This module describes a terminal optics device model for managing the terminal systems (client and line side) in a DWDM transport network.
Elements of the model:
physical port: corresponds to a physical, pluggable client port on the terminal device. Examples includes 10G, 40G, 100G (e.g., 10x10G, 4x25G or 1x100G) and 400G/1T in the future. Physical client ports will have associated operational state or PMs.
physical channel: a physical lane or channel in the physical client port. Each physical client port has 1 or more channels. An example is 100GBASE-LR4 client physical port having 4x25G channels. Channels have their own optical PMs and can be monitored independently within a client physical port (e.g., channel power). Physical client channels are defined in the model as part of a physical client port, and are modeled primarily for reading their PMs.
logical channel: a logical grouping of logical grooming elements that may be assigned to subsequent grooming stages for multiplexing / de-multiplexing, or to an optical channel for line side transmission. The logical channels can represent, for example, an ODU/OTU logical packing of the client data onto the line side. Tributaries are similarly logical groupings of demand that can be represented in this structure and assigned to an optical channel. Note that different types of logical channels may be present, each with their corresponding PMs.
optical channel: corresponds to an optical carrier and is assigned a wavelength/frequency. Optical channels have PMs such as power, BER, and operational mode.
Directionality:
To maintain simplicity in the model, the configuration is described from client-to-line direction. The assumption is that equivalent reverse configuration is implicit, resulting in the same line-to-client configuration.
Physical layout:
The model does not assume a particular physical layout of client and line ports on the terminal device (e.g., such as number of ports per linecard, separate linecards for client and line ports, etc.).
openconfig-types
openconfig-transport-types
openconfig-if-ethernet
openconfig-interfaces
openconfig-platform
openconfig-platform-transceiver
openconfig-lldp
openconfig-extensions
ietf-yang-types
openconfig-yang-types
description:
Top-level container for the terminal device
nodetype: container (rw)
description:
Configuration data for global terminal-device
nodetype: container (rw)
description:
Operational state data for global terminal device
nodetype: container (ro)
description:
Enclosing container the list of logical channels
nodetype: container (rw)
description:
List of logical channels
nodetype: list (rw)
list keys: [index]
description:
Reference to the index of the logical channel
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for logical channels
nodetype: container (rw)
description:
Index of the current logical channel
nodetype: leaf (rw)
type: uint32
description:
Description of the logical channel
nodetype: leaf (rw)
type: string
description:
Sets the admin state of the logical channel
nodetype: leaf (rw)
type: oc-opt-types:admin-state-type
description:
Rounded bit rate of the tributary signal. Exact bit rate
will be refined by protocol selection.
nodetype: leaf (rw)
type: identityref
description:
Protocol framing of the tributary signal. If this
LogicalChannel is directly connected to a Client-Port or
Optical-Channel, this is the protocol of the associated port.
If the LogicalChannel is connected to other LogicalChannels,
the TributaryProtocol of the LogicalChannels will define a
specific mapping/demapping or multiplexing/demultiplexing
function.
Not all protocols are valid, depending on the value
of trib-rate-class. The expectation is that the NMS
will validate that a correct combination of rate class
and protocol are specfied. Basic combinations are:
rate class: 1G
protocols: 1GE
rate class: 2.5G
protocols: OC48, STM16
rate class: 10G
protocols: 10GE LAN, 10GE WAN, OC192, STM64, OTU2, OTU2e,
OTU1e, ODU2, ODU2e, ODU1e
rate class: 40G
protocols: 40GE, OC768, STM256, OTU3, ODU3
rate class: 100G
protocols: 100GE, 100G MLG, OTU4, OTUCn, ODU4
nodetype: leaf (rw)
type: identityref
description:
The type / stage of the logical element determines the
configuration and operational state parameters (PMs)
available for the logical element
nodetype: leaf (rw)
type: identityref
description:
Sets the loopback type on the logical channel. Setting the
mode to something besides NONE activates the loopback in
the specified mode.
nodetype: leaf (rw)
type: oc-opt-types:loopback-mode-type
description:
When enabled the logical channel's DSP will generate a pseudo
randmon bit stream (PRBS) which can be used during testing.
nodetype: leaf (rw)
type: boolean
description:
The client side mapping mode internal to the device that
specifies the number of client electrical interfaces and
the data rate of each client electrical interface. For
example, a ZR+ transceiver with an optical line rate of 400G
could be configured to break out into four 100G client
signals which might connect to an interface or a
physical-channel. This would be configured on the aggregate
logical channel as MODE_4X100G. This is only valid on the
aggregate logical channel that is connected directly to the
optical-channel.
nodetype: leaf (rw)
type: identityref
description:
Operational state data for logical channels
nodetype: container (ro)
description:
Index of the current logical channel
nodetype: leaf (ro)
type: uint32
description:
Description of the logical channel
nodetype: leaf (ro)
type: string
description:
Sets the admin state of the logical channel
nodetype: leaf (ro)
type: oc-opt-types:admin-state-type
description:
Rounded bit rate of the tributary signal. Exact bit rate
will be refined by protocol selection.
nodetype: leaf (ro)
type: identityref
description:
Protocol framing of the tributary signal. If this
LogicalChannel is directly connected to a Client-Port or
Optical-Channel, this is the protocol of the associated port.
If the LogicalChannel is connected to other LogicalChannels,
the TributaryProtocol of the LogicalChannels will define a
specific mapping/demapping or multiplexing/demultiplexing
function.
Not all protocols are valid, depending on the value
of trib-rate-class. The expectation is that the NMS
will validate that a correct combination of rate class
and protocol are specfied. Basic combinations are:
rate class: 1G
protocols: 1GE
rate class: 2.5G
protocols: OC48, STM16
rate class: 10G
protocols: 10GE LAN, 10GE WAN, OC192, STM64, OTU2, OTU2e,
OTU1e, ODU2, ODU2e, ODU1e
rate class: 40G
protocols: 40GE, OC768, STM256, OTU3, ODU3
rate class: 100G
protocols: 100GE, 100G MLG, OTU4, OTUCn, ODU4
nodetype: leaf (ro)
type: identityref
description:
The type / stage of the logical element determines the
configuration and operational state parameters (PMs)
available for the logical element
nodetype: leaf (ro)
type: identityref
description:
Sets the loopback type on the logical channel. Setting the
mode to something besides NONE activates the loopback in
the specified mode.
nodetype: leaf (ro)
type: oc-opt-types:loopback-mode-type
description:
When enabled the logical channel's DSP will generate a pseudo
randmon bit stream (PRBS) which can be used during testing.
nodetype: leaf (ro)
type: boolean
description:
The client side mapping mode internal to the device that
specifies the number of client electrical interfaces and
the data rate of each client electrical interface. For
example, a ZR+ transceiver with an optical line rate of 400G
could be configured to break out into four 100G client
signals which might connect to an interface or a
physical-channel. This would be configured on the aggregate
logical channel as MODE_4X100G. This is only valid on the
aggregate logical channel that is connected directly to the
optical-channel.
nodetype: leaf (ro)
type: identityref
description:
Link-state of the Ethernet protocol on the logical channel,
SONET / SDH framed signal, etc.
nodetype: leaf (ro)
type: enumeration
description:
Top level container for OTU configuration when logical
channel framing is using an OTU protocol, e.g., OTU1, OTU3,
etc.
nodetype: container (rw)
description:
Configuration data for OTN protocol framing
nodetype: container (rw)
description:
Trail trace identifier (TTI) message transmitted
nodetype: leaf (rw)
type: string
description:
Trail trace identifier (TTI) message expected
nodetype: leaf (rw)
type: string
description:
Trail trace identifier (TTI) transmit message automatically
created. If true, then setting a custom transmit message
would be invalid.
nodetype: leaf (rw)
type: boolean
description:
Granularity value of OPUk or OPUCn tributary slots for OTN
signal allocation. The currently defined values follow the
existing ITU-T G.709 standard, which can be extended as
needed in future.
nodetype: leaf (rw)
type: identityref
description:
Operational state data for OTN protocol PMs, statistics,
etc.
nodetype: container (ro)
description:
Trail trace identifier (TTI) message transmitted
nodetype: leaf (ro)
type: string
description:
Trail trace identifier (TTI) message expected
nodetype: leaf (ro)
type: string
description:
Trail trace identifier (TTI) transmit message automatically
created. If true, then setting a custom transmit message
would be invalid.
nodetype: leaf (ro)
type: boolean
description:
Granularity value of OPUk or OPUCn tributary slots for OTN
signal allocation. The currently defined values follow the
existing ITU-T G.709 standard, which can be extended as
needed in future.
nodetype: leaf (ro)
type: identityref
description:
Trail trace identifier (TTI) message received
nodetype: leaf (ro)
type: string
description:
Remote defect indication (RDI) message received
nodetype: leaf (ro)
type: string
description:
The number of seconds that at least one errored blocks
occurs, at least one code violation occurs, loss of sync is
detected or loss of signal is detected
nodetype: leaf (ro)
type: yang:counter64
description:
The number of seconds that loss of frame is detected OR
the number of errored blocks, code violations, loss of sync
or loss of signal is detected exceeds a predefined
threshold
nodetype: leaf (ro)
type: yang:counter64
description:
The number of seconds during which the link is unavailable
nodetype: leaf (ro)
type: yang:counter64
description:
For ethernet or fiberchannel links, the number of 8b/10b
coding violations. For SONET/SDH, the number of BIP (bit
interleaved parity) errors
nodetype: leaf (ro)
type: yang:counter64
description:
The number of errored blocks. Error detection codes are
capable to detect whether one or more errors have occurred
in a given sequence of bits – the block. It is normally not
possible to determine the exact number of errored bits within
the block.
nodetype: leaf (ro)
type: yang:counter64
description:
The number of words that were uncorrectable by the FEC
nodetype: leaf (ro)
type: yang:counter64
description:
The number of bytes that were corrected by the FEC
nodetype: leaf (ro)
type: yang:counter64
description:
The number of bits that were corrected by the FEC
nodetype: leaf (ro)
type: yang:counter64
description:
The number of background block errors
nodetype: leaf (ro)
type: yang:counter64
description:
The number of blocks or frames that were uncorrectable by
the FEC
nodetype: leaf (ro)
type: yang:counter64
description:
Bit error rate before forward error correction -- computed
value with 18 decimal precision. Note that decimal64
supports values as small as i x 10^-18 where i is an
integer. Values smaller than this should be reported as 0
to inidicate error free or near error free performance.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
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:
Bit error rate after forward error correction -- computed
value with 18 decimal precision. Note that decimal64
supports values as small as i x 10^-18 where i is an
integer. Values smaller than this should be reported as 0
to inidicate error free or near error free performance.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
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:
Quality value (factor) in dB of a channel with two
decimal precision. Values include the instantaneous,
average, minimum, and maximum statistics. If avg/min/max
statistics are not supported, the target is expected
to just supply the instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dB
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:
Electrical signal to noise ratio. Baud rate
normalized signal to noise ratio based on
error vector magnitude in dB with two decimal
precision. Values include the instantaneous, average,
minimum, and maximum statistics. If avg/min/max
statistics are not supported, the target is expected
to just supply the instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dB
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:
Top level container for data related to Ethernet framing
for the logical channel
nodetype: container (rw)
description:
Configuration data for Ethernet protocol framing on
logical channels
nodetype: container (rw)
description:
Sets the client port behavior that defines if the actions
of automatic laser shutdown (als), ethernet fault
propagation, or nothing will be done upon the detection
of a failure on the line port or the upstream remote
client port.
nodetype: leaf (rw)
type: enumeration
default: ETHERNET
description:
The timer to delay the client-als actions on the client
port when a local or remote fault is detected on the line
port. The delay will only be valid when the client-als is
set to LASER_SHUTDOWN
nodetype: leaf (rw)
type: uint32
default: 0
units: milliseconds
description:
Operational state data for Ethernet protocol framing
on logical channels
nodetype: container (ro)
description:
Sets the client port behavior that defines if the actions
of automatic laser shutdown (als), ethernet fault
propagation, or nothing will be done upon the detection
of a failure on the line port or the upstream remote
client port.
nodetype: leaf (ro)
type: enumeration
default: ETHERNET
description:
The timer to delay the client-als actions on the client
port when a local or remote fault is detected on the line
port. The delay will only be valid when the client-als is
set to LASER_SHUTDOWN
nodetype: leaf (ro)
type: uint32
default: 0
units: milliseconds
description:
MAC layer control frames received on the interface
nodetype: leaf (ro)
type: oc-yang:counter64
description:
MAC layer PAUSE frames received on the interface
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of frames received that were
longer than 1518 octets (excluding framing bits,
but including FCS octets) and were otherwise
well formed.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of frames received that were
less than 64 octets long (excluding framing bits,
but including FCS octets) and were otherwise well
formed.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of jabber frames received on the
interface. Jabber frames are typically defined as oversize
frames which also have a bad CRC. Implementations may use
slightly different definitions of what constitutes a jabber
frame. Often indicative of a NIC hardware problem.
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of frames received that were less than
64 octets in length (excluding framing bits but including
FCS octets) and had either a bad Frame Check Sequence
(FCS) with an integral number of octets (FCS Error) or a
bad FCS with a non-integral number of octets (Alignment
Error).
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of 802.1q tagged frames received on the interface
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number of frames received that
had a length (excluding framing bits, but
including FCS octets) of between 64 and 1518
octets, inclusive, but had either a bad
Frame Check Sequence (FCS) with an integral
number of octets (FCS Error) or a bad FCS with
a non-integral number of octets (Alignment Error)
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored blocks. Error detection codes
are capable of detecting whether one or more errors have
occurred in a given sequence of bits – the block. It is
normally not possible to determine the exact number of errored
bits within the block
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored frames due to a carrier issue.
The value refers to MIB counter for
dot3StatsCarrierSenseErrors
oid=1.3.6.1.2.1.10.7.2.1.11
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored frames due to interrupted
transmission issue. The value refers to MIB counter for
dot3StatsDeferredTransmissions
oid=1.3.6.1.2.1.10.7.2.1.7
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored frames due to late collision
issue. The value refers to MIB counter for
dot3StatsLateCollisions
oid=1.3.6.1.2.1.10.7.2.1.8
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored frames due to MAC errors
received. The value refers to MIB counter for
dot3StatsInternalMacReceiveErrors
oid=1.3.6.1.2.1.10.7.2.1.16
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored frames due to single collision
issue. The value refers to MIB counter for
dot3StatsSingleCollisionFrames
oid=1.3.6.1.2.1.10.7.2.1.4
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received errored frames due to symbol error.
The value refers to MIB counter for
in-symbol-error
oid=1.3.6.1.2.1.10.7.2.1.18
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The total number frames received that are well-formed but
dropped due to exceeding the maximum frame size on the interface
(e.g., MTU or MRU)
nodetype: leaf (ro)
type: oc-yang:counter64
description:
MAC layer control frames sent on the interface
nodetype: leaf (ro)
type: oc-yang:counter64
description:
MAC layer PAUSE frames sent on the interface
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of 802.1q tagged frames sent on the interface
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of sent errored frames due to MAC errors
transmitted. The value refers to MIB counter for
dot3StatsInternalMacTransmitErrors
oid=1.3.6.1.2.1.10.7.2.1.10
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of received bit interleaved parity (BIP) errors
at the physical coding sublayer (PCS). If the interface
consists of multiple lanes, this will be the sum of all
errors on the lane
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of seconds that physical coding sublayer (PCS)
errors have crossed a sytem defined threshold indicating the
link is erroring
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of seconds that physical coding sublayer (PCS)
errors have crossed a system defined threshold indicating the
link is severely erroring
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of seconds that physical coding sublayer (PCS)
errors have crossed a system defined threshold indicating the
link is unavailable
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of transmitted bit interleaved parity (BIP) errors
at the physical coding sublayer (PCS). If the interface
consists of multiple lanes, this will be the sum of all
errors on the lane
nodetype: leaf (ro)
type: oc-yang:counter64
description:
Number of FCS/CRC error check failures sent on the interface
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of transmitted errored blocks. Error detection
codes are capable of detecting whether one or more errors have
occurred in a given sequence of bits – the block. It is
normally not possible to determine the exact number of errored
bits within the block
nodetype: leaf (ro)
type: oc-yang:counter64
description:
The number of blocks or frames that were uncorrectable by
the FEC
nodetype: leaf (ro)
type: yang:counter64
description:
Bit error rate before forward error correction -- computed
value with 18 decimal precision. Note that decimal64
supports values as small as i x 10^-18 where i is an
integer. Values smaller than this should be reported as 0
to inidicate error free or near error free performance.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
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:
Bit error rate after forward error correction -- computed
value with 18 decimal precision. Note that decimal64
supports values as small as i x 10^-18 where i is an
integer. Values smaller than this should be reported as 0
to inidicate error free or near error free performance.
Values include the instantaneous, average, minimum, and
maximum statistics. If avg/min/max statistics are not
supported, the target is expected to just supply the
instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The minimum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
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:
Quality value (factor) in dB of a channel with two
decimal precision. Values include the instantaneous,
average, minimum, and maximum statistics. If avg/min/max
statistics are not supported, the target is expected
to just supply the instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dB
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:
Electrical signal to noise ratio. Baud rate
normalized signal to noise ratio based on
error vector magnitude in dB with two decimal
precision. Values include the instantaneous, average,
minimum, and maximum statistics. If avg/min/max
statistics are not supported, the target is expected
to just supply the instant value
nodetype: container (ro)
description:
The instantaneous value of the statistic.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The arithmetic mean value of the statistic over the
time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The minimum value of the statistic over the time interval.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
The maximum value of the statistic over the time
interval.
nodetype: leaf (ro)
type: decimal64
units: dB
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:
LLDP data for logical channels
nodetype: container (rw)
description:
LLDP configuration data for logical channels
nodetype: container (rw)
description:
Enable or disable the LLDP protocol on the logical channel.
nodetype: leaf (rw)
type: boolean
default: false
description:
If true, LLDP PDUs are only received and processed on
the logical-channel, but are not originated by the local
agent. The PDUs are not dropped by the logical channel after
processing, but relayed to the downstream link layer
neighbors. The snooping mode is valid only when LLDP is
enabled on the logical channel. The snooping mode is useful
when a logical channel does not want its link layer neighbors
to discover itself since, for example, it is a lower-layer
logical channel.
nodetype: leaf (rw)
type: boolean
default: false
description:
LLDP operational state data for logical channels
nodetype: container (ro)
description:
Enable or disable the LLDP protocol on the logical channel.
nodetype: leaf (ro)
type: boolean
default: false
description:
If true, LLDP PDUs are only received and processed on
the logical-channel, but are not originated by the local
agent. The PDUs are not dropped by the logical channel after
processing, but relayed to the downstream link layer
neighbors. The snooping mode is valid only when LLDP is
enabled on the logical channel. The snooping mode is useful
when a logical channel does not want its link layer neighbors
to discover itself since, for example, it is a lower-layer
logical channel.
nodetype: leaf (ro)
type: boolean
default: false
description:
LLDP counters on each interface
nodetype: container (ro)
description:
The number of lldp frames received.
nodetype: leaf (ro)
type: yang:counter64
description:
The number of frames transmitted out.
nodetype: leaf (ro)
type: yang:counter64
description:
The number of LLDP frames received with errors.
nodetype: leaf (ro)
type: yang:counter64
description:
The number of LLDP frames received and discarded.
nodetype: leaf (ro)
type: yang:counter64
description:
The number of TLV frames received and discarded.
nodetype: leaf (ro)
type: yang:counter64
description:
The number of frames received with unknown TLV.
nodetype: leaf (ro)
type: yang:counter64
description:
Indicates the last time the counters were
cleared.
nodetype: leaf (ro)
type: yang:date-and-time
description:
The number of frame transmit errors on the
interface.
nodetype: leaf (ro)
type: yang:counter64
description:
Enclosing container for list of LLDP neighbors on
a logical channel
nodetype: container (ro)
description:
List of LLDP neighbors. If the implementation only
supports one neighbor, this would always be a list with
one item. If the device and neighbor supported multiple
neighbors, which can be achieved via LLDP forwarding, then
this would be supported
nodetype: list (ro)
list keys: [id]
description:
System generated identifier for the neighbor on
the logical channel.
nodetype: leaf (list key) (ro)
type: leafref
description:
Configuration data
nodetype: container (ro)
description:
Operational state data
nodetype: container (ro)
description:
The system name field shall contain an alpha-numeric string
that indicates the system's administratively assigned name.
The system name should be the system's fully qualified domain
name. If implementations support IETF RFC 3418, the sysName
object should be used for this field.
nodetype: leaf (ro)
type: string
description:
The system description field shall contain an alpha-numeric
string that is the textual description of the network entity.
The system description should include the full name and
version identification of the system's hardware type,
software operating system, and networking software. If
implementations support IETF RFC 3418, the sysDescr object
should be used for this field.
nodetype: leaf (ro)
type: string
description:
The Chassis ID is a mandatory TLV which identifies the
chassis component of the endpoint identifier associated with
the transmitting LLDP agent
nodetype: leaf (ro)
type: string
description:
This field identifies the format and source of the chassis
identifier string. It is an enumerator defined by the
LldpChassisIdSubtype object from IEEE 802.1AB MIB.
nodetype: leaf (ro)
type: oc-lldp-types:chassis-id-type
description:
System generated identifier for the neighbor on the
interface.
nodetype: leaf (ro)
type: string
description:
Age since discovery
nodetype: leaf (ro)
type: uint64
units: seconds
description:
Seconds since last update received.
nodetype: leaf (ro)
type: int64
description:
The time-to-live (TTL) is a mandatory TLV which indicates
how long information from the neighbor should be considered
valid.
nodetype: leaf (ro)
type: uint16
units: seconds
description:
The Port ID is a mandatory TLV which identifies the port
component of the endpoint identifier associated with the
transmitting LLDP agent. If the specified port is an IEEE
802.3 Repeater port, then this TLV is optional.
nodetype: leaf (ro)
type: string
description:
This field identifies the format and source of the port
identifier string. It is an enumerator defined by the
PtopoPortIdType object from RFC2922.
nodetype: leaf (ro)
type: oc-lldp-types:port-id-type
description:
The binary string containing the actual port identifier for
the port which this LLDP PDU was transmitted. The source and
format of this field is defined by PtopoPortId from
RFC2922.
nodetype: leaf (ro)
type: string
description:
The Management Address is a mandatory TLV which identifies a
network address associated with the local LLDP agent, which
can be used to reach the agent on the port identified in the
Port ID TLV.
nodetype: leaf (ro)
type: string
description:
The enumerated value for the network address type
identified in this TLV. This enumeration is defined in the
'Assigned Numbers' RFC [RFC3232] and the
ianaAddressFamilyNumbers object.
nodetype: leaf (ro)
type: string
description:
Enclosing container for list of custom TLVs from a
neighbor
nodetype: container (ro)
description:
List of custom LLDP TLVs from a neighbor
nodetype: list (ro)
list keys: [type] [oui] [oui-subtype]
description:
Reference to type list key
nodetype: leaf (list key) (ro)
type: leafref
description:
Reference to oui list key
nodetype: leaf (list key) (ro)
type: leafref
description:
Reference to oui-subtype list key
nodetype: leaf (list key) (ro)
type: leafref
description:
Configuration data
nodetype: container (ro)
description:
Operational state data
nodetype: container (ro)
description:
The integer value identifying the type of information
contained in the value field.
nodetype: leaf (ro)
type: int32
description:
The organizationally unique identifier field shall contain
the organization's OUI as defined in Clause 9 of IEEE Std
802. The high-order octet is 0 and the low-order 3 octets
are the SMI Network Management Private Enterprise Code of
the Vendor in network byte order, as defined in the
'Assigned Numbers' RFC [RFC3232].
nodetype: leaf (ro)
type: string
description:
The organizationally defined subtype field shall contain a
unique subtype value assigned by the defining organization.
nodetype: leaf (ro)
type: string
description:
A variable-length octet-string containing the
instance-specific information for this TLV.
nodetype: leaf (ro)
type: binary
description:
Top-level container for specifying references to the
source of signal for the logical channel, either a
transceiver, individual physical channels, or an interface
nodetype: container (rw)
description:
Configuration data for the signal source for the
logical channel
nodetype: container (rw)
description:
Reference to the transceiver carrying the input signal
for the logical channel. If specific physical channels
are mapped to the logical channel (as opposed to all
physical channels carried by the transceiver), they can be
specified in the list of physical channel references.
nodetype: leaf (rw)
type: leafref
description:
This list should be populated with references
to the client physical channels that feed this logical
channel from the transceiver specified in the 'transceiver'
leaf, which must be specified. If this leaf-list is empty,
all physical channels in the transceiver are assumed to be
mapped to the logical channel.
nodetype: leaf-list (rw)
type: leafref
description:
Reference to the interface carrying the input signal
for the logical channel. The ingress will specify an interface
in the case of a transceiver being utilized directly in a
router and bypassing a dedicated terminal device. When
specified, the other leaves in the ingress config must be
empty.
nodetype: leaf (rw)
type: oc-if:base-interface-ref
description:
Operational state data for the signal source for the
logical channel
nodetype: container (ro)
description:
Reference to the transceiver carrying the input signal
for the logical channel. If specific physical channels
are mapped to the logical channel (as opposed to all
physical channels carried by the transceiver), they can be
specified in the list of physical channel references.
nodetype: leaf (ro)
type: leafref
description:
This list should be populated with references
to the client physical channels that feed this logical
channel from the transceiver specified in the 'transceiver'
leaf, which must be specified. If this leaf-list is empty,
all physical channels in the transceiver are assumed to be
mapped to the logical channel.
nodetype: leaf-list (ro)
type: leafref
description:
Reference to the interface carrying the input signal
for the logical channel. The ingress will specify an interface
in the case of a transceiver being utilized directly in a
router and bypassing a dedicated terminal device. When
specified, the other leaves in the ingress config must be
empty.
nodetype: leaf (ro)
type: oc-if:base-interface-ref
description:
Enclosing container for tributary assignments
nodetype: container (rw)
description:
Logical channel elements may be assigned directly to
optical channels for line-side transmission, or can be
further groomed into additional stages of logical channel
elements. The grooming can multiplex (i.e., split the
current element into multiple elements in the subsequent
stage) or de-multiplex (i.e., combine the current element
with other elements into the same element in the subsequent
stage) logical elements in each stage.
Note that to support the ability to groom the logical
elements, the list of logical channel elements should be
populated with an entry for the logical elements at
each stage, starting with the initial assignment from the
respective client physical port.
Each logical element assignment consists of a pointer to
an element in the next stage, or to an optical channel,
along with a bandwidth allocation for the corresponding
assignment (e.g., to split or combine signal).
nodetype: list (rw)
list keys: [index]
description:
Reference to the index for the current tributary
assignment
nodetype: leaf (list key) (rw)
type: leafref
description:
Configuration data for tributary assignments
nodetype: container (rw)
description:
Index of the current logical client channel to tributary
mapping
nodetype: leaf (rw)
type: uint32
description:
Name assigned to the logical client channel
nodetype: leaf (rw)
type: string
description:
Each logical channel element may be assigned to subsequent
stages of logical elements to implement further grooming, or
can be assigned to a line-side optical channel for
transmission. Each assignment also has an associated
bandwidth allocation.
nodetype: leaf (rw)
type: enumeration
description:
Reference to another stage of logical channel elements.
nodetype: leaf (rw)
type: leafref
description:
Reference to the line-side optical channel that should
carry the current logical channel element. Use this
reference to exit the logical element stage.
nodetype: leaf (rw)
type: leafref
description:
Allocation of the logical client channel to the tributary
or sub-channel, expressed in Gbps. Please note that if the
assignment is to an OTN logical channel, the allocation must
be an integer multiplication to tributary-slot-granularity
of the OTN logical channel.
nodetype: leaf (rw)
type: decimal64
units: Gbps
description:
Indicates the first tributary slot index allocated to the
client signal or logical channel in the assignment. Valid
only when the assignment is to an OTN logical channel.
nodetype: leaf (rw)
type: int32
description:
Logical channel mapping procedure. Valid only when the
assignment is to an OTN logical channel.
nodetype: leaf (rw)
type: identityref
description:
Operational state data for tributary assignments
nodetype: container (ro)
description:
Index of the current logical client channel to tributary
mapping
nodetype: leaf (ro)
type: uint32
description:
Name assigned to the logical client channel
nodetype: leaf (ro)
type: string
description:
Each logical channel element may be assigned to subsequent
stages of logical elements to implement further grooming, or
can be assigned to a line-side optical channel for
transmission. Each assignment also has an associated
bandwidth allocation.
nodetype: leaf (ro)
type: enumeration
description:
Reference to another stage of logical channel elements.
nodetype: leaf (ro)
type: leafref
description:
Reference to the line-side optical channel that should
carry the current logical channel element. Use this
reference to exit the logical element stage.
nodetype: leaf (ro)
type: leafref
description:
Allocation of the logical client channel to the tributary
or sub-channel, expressed in Gbps. Please note that if the
assignment is to an OTN logical channel, the allocation must
be an integer multiplication to tributary-slot-granularity
of the OTN logical channel.
nodetype: leaf (ro)
type: decimal64
units: Gbps
description:
Indicates the first tributary slot index allocated to the
client signal or logical channel in the assignment. Valid
only when the assignment is to an OTN logical channel.
nodetype: leaf (ro)
type: int32
description:
Logical channel mapping procedure. Valid only when the
assignment is to an OTN logical channel.
nodetype: leaf (ro)
type: identityref
description:
Enclosing container for list of operational modes
nodetype: container (rw)
description:
List of operational modes supported by the platform.
The operational mode provides a platform-defined summary
of information such as symbol rate, modulation, pulse
shaping, etc.
nodetype: list (ro)
list keys: [mode-id]
description:
Reference to mode-id
nodetype: leaf (list key) (ro)
type: leafref
description:
Configuration data for operational mode
nodetype: container (ro)
description:
Operational state data for the platform-defined
operational mode
nodetype: container (ro)
description:
Two-octet encoding of the vendor-defined operational
mode
nodetype: leaf (ro)
type: uint16
description:
Vendor-supplied textual description of the characteristics
of this operational mode to enable operators to select the
appropriate mode for the application.
nodetype: leaf (ro)
type: string
description:
Identifier to represent the vendor / supplier of the
platform and the associated operational mode information
nodetype: leaf (ro)
type: string
This module defines common data elements for OpenConfig data models for optical transport line system elements, such as amplifiers and ROADMs (wavelength routers).
iana-if-type
openconfig-extensions
openconfig-interfaces
openconfig-platform
openconfig-types
openconfig-transport-types
openconfig-platform-transceiver