State¶

Leafs

• allocated_power
• description
• empty
• entity_id
• equipment_failure
• equipment_mismatch
• firmware_version
• hardware_version
• id
• location
• mfg_date
• mfg_name
• name
• oper_status
• parent_
• part_no
• removable
• serial_no
• software_version
• type
• used_power

Children

• memory
• temperature

class Components.Component.State¶

Bases: Entity

Class Hierarchy: Components Component State

This class represents state data.

Operational state data for each component

name¶

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

type: str

config: False

type¶

Type of component as identified by the system

type: union of the below types:

type: OPENCONFIGHARDWARECOMPONENT

type: OPENCONFIGSOFTWARECOMPONENT

config: False

id¶

Unique identifier assigned by the system for the component

type: str

config: False

location¶

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

type: str

config: False

description¶

System-supplied description of the component

type: str

config: False

mfg_name¶

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

type: str

config: False

mfg_date¶

System-supplied representation of the component’s manufacturing date

type: str

pattern: ^[0-9]{4}\-[0-9]{2}\-[0-9]{2}$

config: False

hardware_version¶

For hardware components, this is the hardware revision of the component

type: str

config: False

firmware_version¶

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

type: str

config: False

software_version¶

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

type: str

config: False

serial_no¶

System-assigned serial number of the component

type: str

config: False

part_no¶

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

type: str

config: False

removable¶

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

type: bool

config: False

oper_status¶

If applicable, this reports the current operational status of the component

type: one of the below values: ACTIVE

INACTIVE

DISABLED

config: False

empty¶

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)

type: bool

config: False

default value: false

parent_¶

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

type: str

refers to: name

config: False

temperature¶

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

type: Temperature

config: False

memory¶

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

type: Memory

config: False

allocated_power¶

Power allocated by the system for the component

type: int

range: 0..4294967295

config: False

units: watts

used_power¶

Actual power used by the component

type: int

range: 0..4294967295

config: False

units: watts

entity_id¶

A unique numeric identifier assigned by the system to the component. This identifier may be used to represent the corresponding SNMP Entity MIB identifier

type: int

range: 0..4294967295

config: False

equipment_failure¶

If true, the hardware indicates that the component’s physical equipment has failed

type: bool

config: False

default value: false

equipment_mismatch¶

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

type: bool

config: False

default value: false