Physical Entity

• Descr

  This is a text string containing the known name for the resource. This name is typically the name used to describe the resource in product documentation, on product legends or, possibly, the name stored in firmware.

• IsFRU

  This is a boolean representing whether the resource is a field-replaceable unit. Only hardware resources of the class sunPlatCircuitPack are considered to be FRUs.

• HardwareRev

  This is a text string containing the manufacturer's hardware revision information for the resource. Not all hardware resources have associated hardware revision information.

• Name

  This is a text string containing the logical name by which the resource is known to the operating system and associated utilities. This name can be a device node or a defined name used by system utilities, where applicable. Not all resources have a device name.

• ModelName

  This is a text string containing the manufacturer's customer-visible part number or part definition. Not all hardware resources have associated part numbers or definitions.

• SerialNum

  This is a text string containing the manufacturer's serial number for the resource. Not all hardware resources have associated serial numbers.

• MfgName

  This is a text string containing the manufacturer's name for the resource. Not all hardware resources have an associated manufacturer’s name.

The Physical Entity table also contains attributes that are used for describing the hierarchy of hardware resources:

• Class

  This enumerated type contains an indication of the general hardware type of a particular physical resource. The supported values of this class are defined by the ENTITY-MIB. This attribute can be used as an indication of the relevant table extensions for the managed object. The mapping between the ENTITY-MIB classes and the sunPlat classes are as shown in the following table.

  
  

  entPhysicalClass	sunPlat Class
  chassis(3)	sunPlatChassis
  backplane(4)	Not implemented
  container(5)	sunPlatEquipmentHolder
  powerSupply(6)	sunPlatPowerSupply
  sensor(8)	sunPlatSensor, plus other tables
  module(9)	sunPlatCircuitPack
  port(10)	Not implemented
  stack(11)	Not implemented
  other(1)	sunPlatEquipment, plus other tables
  unknown(2)	Not implemented

  
  

• Index

  This integer uniquely identifies the entry in the Physical Entity Table that identifies the managed object. Values are not preallocated and might vary on each invocation of the agent.

• ContainedIn

  This integer represents the INDEX attribute of the physical entity containing this physical entity. The attribute therefore models the relationship between the physical entities.

  
  

  ---

  Note - The object at the root of the physical containment hierarchy (typically a chassis) is not physically contained within another entity represented in the table. To indicate this, its entPhysicalContainedIn value is set to 0.

  ---

  
  

• FirmwareRev

  This is a text string containing the manufacturer's firmware revision information for the resource. Not all hardware resources have associated firmware revision information.

• SoftwareRev

  This is a text string containing the manufacturer's software revision information for the resource. Not all hardware resources have associated software revision information.

The sunPlat Equipment Table

The sunPlat Equipment table represents the characteristics that are generic to all hardware resources. This table contains attributes representing configuration and generic health status information.

The sunPlat Equipment table has the following attributes:

• AdministrativeState

  This read-write attribute takes one of the following enumerated values representing the current administrative state of the resource:

  • locked(1)

  • unlocked(2)

  • shuttingDown(3)

• OperationalState

  This read-only attribute is an enumerated type indicating whether the resource is physically installed and capable of providing service. The attribute contributes to the state of the managed object and can take the values shown in the following table.

  
  

  Attribute Values	Description
  disabled(1)	The resource is totally inoperable and unable to provide service to the user.
  enabled(2)	The resource is partially or fully operable and available for use.

  
  

• AlarmStatus

  This read-only attribute takes an enumerated value representing the current alarm state of the resource. It indicates the highest severity of any alarm outstanding on the managed object. The attribute can take the following values:

  • critical(1)

  • major(2)

  • minor(3)

  • indeterminate(4)

  • warning(5)

  • pending(6)

  • cleared(7)

• UnknownStatus

  This read-only attribute indicates if the other state attributes might not reflect the true state of the resource. The attribute takes a boolean value representing whether the managed object is able to report accurately faults against the resource. If the resource is unable, truthfully, to reflect its state, this attribute is set to true.

• LocationName

  This read-only attribute contains a locator for the resource. For resources contained directly within the chassis, this attribute correlates with legends on slots and product documentation, or provides a geographical indication of the position of the resource within the chassis. Other hardware resources typically have a location corresponding to the name of the managed object for the resource in which it is contained.

The sunPlat Circuit Pack Table

The sunPlat Circuit Pack table represents the characteristics that are generic to a replaceable resource or FRU. A replaceable resource is defined as a hardware module whose purpose is to package internal hardware components into a recognized form-factor. Typically, a FRU has a defined form-factor and physical appearance. It can be a pluggable removable unit, which is plugged into a connector, it can be more permanently sited within a bay, or it can fit into a drawer, rack, or shelf.

This class has the entPhysicalClass module(9)

The sunPlat Circuit Pack class has the following attributes:

• Type

  This read-only attribute is a text string used for assessing the resource's compatibility with its container. This attribute can identify functionality and form-factor characteristics of the resource.

• AvailabilityStatus

  This read-only attribute further qualifies the Operational State of the managed object. It is an object expressed in BITS Syntax, and can take zero or more of the set of values shown in the following table. See the Glossary for a description of BITS Syntax. Not all of these values are applicable to every class of managed object. This attribute contributes to the State of the managed object.

  
  

  Attribute Values	Bit No.	Hex.	Description
  inTest(0)	0	80	The resource is undergoing a test procedure.
  failed(1)	1	40	The resource has an internal fault that prevents it from operating. Operational State is disabled(1).
  powerOff(2)	2	20	The resource requires power to be applied and is not powered on.
  offLine(3)	3	10	The resource requires a routine operation to be performed to place it online and make it available for use. Operational State is disabled(1).
  offDuty(4)	4	08	The resource has been made inactive by an internal control process.
  dependency(5)	5	04	The resource cannot operate because some other resource on which it depends is unavailable. Operational State is disabled(1).
  degraded(6)	6	02	The service available from the resource is degraded in some respect, such as in speed or operating capability. However, the resource remains available for service. Operational State is enabled(2).
  notInstalled(7)	7	01	The resource represented by the managed object is not present, or is incomplete. Operational State is disabled(1).

  
  

• Replaceable

  This read-only attribute takes a boolean value indicating whether the resource is a replaceable unit.

• HotSwappable

  This read-only attribute takes a boolean value indicating whether the replaceable resource is hot-swappable.

The sunPlat Equipment Holder

The sunPlat Equipment Holder table represents the characteristics of hardware resources that are capable of holding removable hardware resources.

This class has the entPhysicalClass container(5).

The sunPlat Equipment Holder table has the following attributes:

• Type

  This read-only attribute is an enumerated type representing the holder type of the resource, as shown in the following table.

  
  

  Attribute Values	Description
  bay(1)	A bay is typically a unit of vertical space within a rack that contains shelves or drawers for holding telecommunications equipment. The sunPlat table interprets its use within a chassis as a physical receptacle requiring cables for signal connections.
  shelf(2)	A horizontal support or subrack for holding telecommunications equipment within a rack.
  drawer(3)	A horizontal enclosure for holding telecommunications equipment within a rack.
  slot(4)	A physical receptacle with an integral connector for signal connections for removable equipment.
  rack(5)	A rack is the support infrastructure for holding telecommunications equipment, holders, and cable management systems within a self-contained enclosure.

  
  

• AcceptableTypes

  This read-only attribute is a list of text strings representing the types of removable resource (circuit pack) that are supported by the holder. These types are tested for compatibility with the removable resource's Type attribute.

• Status

  This read-only attribute is an enumerated type indicating the status of the holder with regards to any replaceable hardware resources (circuit packs) that it might contain, as shown in the following table.

  
  

  Attribute Values	Description
  holderEmpty(1)	There is no removable resource in the holder.
  inTheAcceptableList(2)	The holder contains a removable resource that is one of the types in the AcceptableTypes list
  notInTheAcceptableList(3)	The holder contains a removable resource recognizable by the network element; but not one of the types in the AcceptableTypes list.
  unknownType(4)	The holder contains an unrecognizable removable resource.

  
  

• Powered

  This read-write attribute is an enumerated type indicating the power state of the resource. The possible values are:

  • other(1)

  • unknown(2)

  • powerOff(3)

  • powerOn(4)

The sunPlat Power Supply

The sunPlat Power Supply table represents a power supply. It does not extend the characteristics of the sunPlat Equipment class. A power supply typically contains sensors representing monitored properties, for example voltages, current, and temperature. It can also contain other hardware resources, such as fans. This is modeled using relationships between the managed objects.

If a power supply is a removable resource, it is modeled within a managed object of the sunPlat Circuit Pack table.

This table has the entPhysicalClass powerSupply(6).

The sunPlat Power Supply class has the following attribute:

• Class

  This read-only attribute is an enumerated type indicating the class of the power supply, and takes the following values:

  • other(1)

  • powerSupply(2)

  • battery(3)

• Status

  This read-only attribute is an enumerated type indicating the status of the power supply and takes the following values:

  • input1Unplugged(2)

  • input2Unplugged(3)

  • nonRedundancy(4)

  • predictFail(5)

  • overtemp(6)

  • underspeed(7)

  • genericFault(8)

  • undervolt(9)

  • overVolt(10)

  • overCurrent(11)

The sunPlat Alarm

The sunPlat Alarm table represents the characteristics of hardware resources that emit indications relating to problem situations, for instance buzzers, LEDs, relays, vibrators, and software alarms.

This class has the entPhsicalClass other(1) and the sunPlatPhysicalClass alarm(2).

The sunPlat Alarm table has the following attributes:

• Type

  This read-only attribute is an enumerated type representing the means by which the alarm condition is communicated. The possible values are shown in the following table.

  
  

  Attribute Values	Description
  other(1)	The alarm device type is not one of the following.
  audible(2)	The alarm causes an audible change on the device.
  visible(3)	The alarm causes a visible change on the device.
  motion(4)	The alarm causes motion of the device.
  switch(5)	The alarm causes an electrical signal change.

  
  

• State

  This read-write attribute is an enumerated type representing the state of the alarm The possible values are shown in the following table.

  
  

  Attribute Value	Description
  unknown(1)	The state of the alarm is undefined or unobservable.
  off(2)	The alarm is inactive.
  steady(3)	The alarm is active.
  alternating(4)	The alarm is cycling between its inactive and active states.

  
  

• Urgency

  This read-write attribute is an enumerated type indicating the relative frequency at which the alarm flashes, vibrates or emits audible tones. The possible values are:

  • other(1)

  • unknown(2)

  • notSupported(3)

  • informational(4)

  • nonCritical(5)

  • critical(6)

  • unrecoverable(7)

The sunPlat Sensor

The sunPlat Sensor table represents the generic characteristics of hardware resources that measure properties of other hardware resources.

This table has the entPhysicalClass sensor(8).

The sunPlat Sensor table has the following attributes:

• Class

  This read-only attribute is an enumerated type indicating the class of the sensor, and takes the following values:

  • binary(1)

  • numeric(2)

  • discrete(3)

• Type

  This read-only attribute is an enumerated type identifying the property that the sensor measures. Some of the possible values of Type are shown in the following table.

  
  

  Type	Description
  temperature(3)	A sensor for measuring the environmental temperature.
  voltage(4)	A sensor for measuring the electrical voltage.
  current(5)	A sensor for measuring the electrical current.
  tachometer(6)	A sensor for measuring the speed and revolutions of a device.
  counter(7)	A general purpose sensor, which counts defined events.

  
  

• Latency

  This read-only attribute indicates the following:

  • When the sensor is polled, this integer represents the update interval measured in milliseconds.

  • When the sensor is event-driven, this value represents the maximum expected latency in processing that event.

The sunPlat Binary Sensor

A sunPlat Binary Sensor table represents the characteristics of sensors that return binary output. It augments the sunPlatSensor table to provide the attributes that are specific to binary sensors.

This table has the entPhysicalClass sensor(8) and the sunPlatSensorClass binary(1).

The sunPlat Binary Sensor table has the following attributes:

• Current

  This read-only attribute takes a boolean value indicating the most recent value of the sensor.

• Expected

  This read-only attribute takes a boolean value indicating the anticipated value of the sensor.

• InterpretTrue

  This read-only attribute is a text string indicating the interpretation of a true value from the sensor.

• InterpretFalse

  This read-only attribute is a text string indicating the interpretation of a false value from the sensor.

The sunPlat Numeric Sensor

A sunPlat Numeric Sensor table represent the characteristics of sensors which can return numeric readings. The numeric sensor values are qualified by a unit of measurement defined as follows:

Unit of Measurement = Base Unit * 10^Exponent

This qualification allows for units of measurement such as milliamperes and microvolts. If a rate unit is defined, the unit of measurement is further refined as follows:

Unit of Measurement = Base Unit * 10^Exponent per Rate Unit

This qualification allows for units of measurement such as revolutions per minute (rpm) and kilometers per hour (km/hr).

This table has the entPhysicalClass sensor(8) and the sunPlatSensorClass numeric(2).

The sunPlat Numeric Sensor class has the following attributes:

• BaseUnits

  This read-only attribute is an enumerated type indicating the unit of measurement, prior to qualification as defined above. Examples of values of this type are:

  • degC(3)

  • volts(6)

  • amps(7)

• Exponent

  This read-only attribute is an integer used to scale the Base Unit by some power of 10. For example, if sunPlatNumericSensorBaseUnits is set to volts and sunPlatNumericSensorExponent is set to -6, the units of the values returned are microVolts.

• RateUnits

  This read-only attribute is an enumerated type that indicates whether the sensor is measuring an absolute value (when the value is none) or a rate. In the latter case, the unit specified in sunPlatNumericSensorBaseUnits is expressed as per unit of time. For example, if sunPlatNumericSensorBaseUnits is set to degC and sunPlatNumericSensorRateUnits is set to perSecond, the value represented has the units degC/second.

  Examples of values of this type are:

  • perMicrosecond(2)

  • perMillisecond(3)

  • perSecond(4)

  • perMinute(5)

  • perHour(6)

  • none(1)

• Current

  This read-only attribute is an integer indicating the most recent value of the sensor.

• NormalMin

  This read-only attribute is an integer indicating the defined threshold below which the sensor reading is not expected to fall. This value is expressed in terms of the units of measurement as defined above. The attribute might not be applicable to some sensors.

• NormalMax

  This read-only attribute is an integer indicating the defined threshold above which the sensor reading is not expected to rise. This value is expressed in terms of the units of measurement as defined above. The attribute might not be applicable to some sensors.

• Accuracy

  This read-only attribute is an integer indicating the degree of error of the sensor for the measured property as a percentage to two decimal places. The value can vary depending on whether the sensor reading is linear over its dynamic range.

• LowerNonCriticalThreshold

  This read-only attribute is an integer indicating the lower threshold at which a nonCritical condition occurs.

• UpperNonCriticalThreshold

  This read-only attribute is an integer indicating the upper threshold at which a nonCritical condition occurs.

• LowerCriticalThreshold

  This read-only attribute is an integer indicating the lower threshold at which a critical condition occurs.

• UpperCriticalThreshold

  This read-only attribute is an integer indicating the upper threshold at which a critical condition occurs.

• LowerFatalThreshold

  This read-only attribute is an integer indicating the lower threshold at which a fatal condition occurs.

• UpperFatalThreshold

  This read-only attribute is an integer indicating the upper threshold at which a fatal condition occurs.

• Hysteresis

  This read-only attribute describes the hysteresis, the retardation of an effect when the forces acting upon a body are changed, around the threshold values.

• EnabledThresholds

  This is read-only attribute that, when written to, resets the sensors to their default values.

The sunPlat Discrete Sensor

The sunPlat Discrete Sensor class is used for sensors that cannot be represented by the sunPlat Numeric Sensor or sunPlat Binary Sensor classes.

This class has the entPhysicalClass sensor(8) and the sunPlatSensorClass discrete(3).

The class comprises two tables. The sunPlatDiscreteSensorTable has one attribute, sunPlatDiscreteSensorCurrent, which indicates the current state of the sensor expressed as an index in the sunPlatDiscreteSensorStatesTable.

The sunPlat Discrete Sensor class has the following attributes:

• Index

  This read-only attribute takes a number that represents the index of a row in the sunPlatDiscreteSensorStatesTable, which identifies this sensor state.

• Interpretation

  This read-only attribute is a string describing the state represented by the corresponding row of the sunPlatDiscreteSensorStatesTable.

• Acceptable

  This read-only attribute takes a boolean value that indicates whether the state represented by this row of the table is considered acceptable.