C H A P T E R 10

Physical Model

This chapter describes the sunPlat physical class hierarchy and how the managed physical object classes defined in the sunPlat model are represented by the
SUN-PLATFORM-MIB.

The chapter contains the following sections:

sunPlat Physical Class Hierarchy

sunPlat Class Definitions

sunPlat Physical Class Hierarchy

FIGURE 10-1 shows the inheritance hierarchy of the sunPlat classes used to model hardware resources within the Sun SNMP Management Agent.

The Physical Entity superclass provides an attribute for defining the relationship between managed objects. It also provides standard SNMP attributes that correspond to attributes in the Equipment class.

The sunPlat Equipment class is derived from the Physical Entity superclass to provide the additional attributes defined in the corresponding classes that are applicable for fault monitoring.

The sunPlat Equipment Holder and sunPlat Circuit Pack classes are derived from the sunPlat Equipment superclass to represent receptacles and the components that plug into them, respectively.

The sunPlat Equipment class is then further specialized to provide the DMTF-derived classes.

FIGURE 10-1 The sunPlat Physical Resource Inheritance Class Diagram

sunPlat Class Definitions

The attributes of the sunPlat classes are used to represent the characteristics of hardware resources. The availability and operability of the resource to the manager are represented by the state of the managed object. Different sunPlat classes have a variety of attributes that express aspects of the managed object's state.

Physical Entity

The Physical Entity superclass is used to represent the characteristics that are generic to all resources.

Note - The entPhysical prefix has been omitted from the following attribute names for clarity.

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.

Note - The SNMP agent mistakenly reports the following items as having an incorrect entPhysicalIsFRU property:
Motherboard
CPUs
CPU fans
This error can be ignored. The Sun Fire V440/V445 and Netra 440 systems are excluded.

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 superclass 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 TABLE 10-1:

TABLE 10-1 Physical Entity Superclass `Class' Attribute Mapping
entPhysicalClass	sunPlat Class
chassis(3)	`sunPlatChassis`
backplane(4)	Not implemented
container(5)	`sunPlatEquipmentHolder`
powerSupply(6)	`sunPlatPowerSupply`
fan(7)	`sunPlatFan`
sensor(8)	`sunPlatSensor`, plus subclasses
module(9)	`sunPlatCircuitPack`
port(10)	Not implemented
stack(11)	Not implemented
other(1)	`sunPlatEquipment`, plus subclasses
unknown(2)	Not implemented

Index

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

ContainedIn

This integer represents the Index attribute of the managed object containing this managed object. The attribute therefore models the relationship between the managed objects.

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.

sunPlat Equipment Class

The sunPlat Equipment class is used to represent the characteristics that are generic to all hardware resources. This class contains attributes representing configuration and generic health status information. This class is further subclassed to provide more detail configuration information and monitoring data for particular types of resources.

The entPhysicalClass is dependent on the subclass being represented.

The sunPlat Equipment class has the following attributes:

Note - The sunPlatEquipment prefix has been omitted from the following attribute names for clarity.

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 TABLE 10-2.

TABLE 10-2 Operational State Attribute Values
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.

sunPlat Circuit Pack Class

The sunPlat Circuit Pack class is used to represent 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 will have 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:

Note - The sunPlatCircuitPack prefix has been omitted from the following attribute names for clarity.

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 using BITS syntax, and can take zero or more of the set of values shown in TABLE 10-3. Not all of these are applicable to every class of managed object. This attribute contributes to the state of the managed object.

TABLE 10-3 Availability Status Attribute Values
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.

sunPlat Equipment Holder

The sunPlat Equipment Holder class is used to represent the characteristics of hardware resources that are capable of holding removable hardware resources.

This class has the entPhysicalClass container(5).

The sunPlat Equipment Holder class has the following attributes:

Note - The sunPlatEquipmentHolder prefix has been omitted from the following attribute names for clarity.

Type

This read-only attribute is an enumerated type representing the holder type of the resource, as shown in TABLE 10-4:

TABLE 10-4 Equipment Holder Type Attribute Values
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. sunPlat 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 may contain, as shown in TABLE 10-5.

TABLE 10-5 Equipment Holder Status Attribute Values
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)

sunPlat Power Supply

The sunPlat Power Supply class is used to represent 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 sunPlat Circuit Pack class.

This class has the entPhysicalClass powerSupply(6).

The sunPlat Power Supply class has the following attribute:

Note - The sunPlatPowerSupply prefix has been omitted from the following attribute name for clarity.

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)

sunPlat Battery

The sunPlat Battery class is used to represent a power supply that supplies power from a battery.

This class has the entPhysicalClass powerSupply(6) and the sunPlatPowerSupplyClass battery(3).

The sunPlat Battery class has the following attribute:

Note - The sunPlatBattery prefix has been omitted from the following attribute name for clarity.

StatusThis read-only attribute is an enumerated type that indicates the status of the battery, and takes the following values:

other(1)

unknown(2)

fullyCharged(3)

low(4)

critical(5)

charging(6)

chargingAndHigh(7)

chargingAndLow(8)

chargingAndCritical(9)

undefined(10)

partiallyCharged(11)

sunPlat Watchdog

The sunPlat Watchdog class is used to represent the characteristics of timer hardware resources that allow the hardware to monitor the state of the operating system or applications.

This class has the entPhysicalClass other(1) and the sunPlatPhysicalClass watchdog(3).

The sunPlat Watchdog class has the following attributes:

Note - The sunPlatWatchdog prefix has been omitted from the following attribute names for clarity.

Timeout

This read-only attribute is an integer indicating the interval in milliseconds after which the watchdog will timeout if not reset.

Action

This read-only attribute is an enumerated type representing the action taken by the watchdog if it is not reset within the period specified by the Timeout. The possible values are shown in TABLE 10-6.

TABLE 10-6 Watchdog Action Attribute Values
Action	Description
`statusOnly(1)`	The watchdog is readable by software, but performs no action.
`systemInterrupt(2)`	The watchdog generates a hardware interrupt to the system being monitored.
`systemReset(3)`	The watchdog resets the system being monitored.
`systemPowerOff(4)`	The watchdog powers off the system being monitored.
`systemPowerCycle(5)`	The watchdog powers off, and then on, the system being monitored.

LastExpired

This read-only attribute indicates the date and time at which the watchdog last expired.

MonitoredEntity

This read-only attribute is an enumerated type representing the entities that can be monitored by the watchdog. The possible values are:

unknown(1)

other(2)

operatingSystem(3)

operatingSystemBootProcess(4)

operatingSystemShutdownProcess(5)

firmwareBootProcess(6)

biosBootProcess(7)

application(8)

serviceProcessors(9)

sunPlat Alarm

The sunPlat Alarm class is used to represent 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 class has the following attributes:

Note - The sunPlatAlarm prefix has been omitted from the following attribute names for clarity.

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 TABLE 10-7.

TABLE 10-7 Alarm Type Attribute Values
Attribute Values	Description
`other(1)`	The alarm device type is not one of the following.
`audible(2)`	The alarm device is 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 TABLE 10-8.

TABLE 10-8 Alarm State Attribute Values
Attribute Values	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 and/or emits audible tones. The possible values are:

other(1)

unknown(2)

notSupported(3)

informational(4)

nonCritical(5)

critical(6)

unrecoverable(7)

sunPlat Fan

The sunPlat Fan class is used to represent the characteristics of active cooling devices. A fan typically contains a sensor representing the speed of rotation. This is modeled using a physical containment relationship between the sunPlat Fan managed object and a tachometer managed object of class sunPlatSensor.

This class has the entPhysicalClass fan(7).

The sunPlat Fan class has the following attribute:

Note - The sunPlatFan prefix has been omitted from the following attribute name for clarity.

Class

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

other(1)

fan(2)

refrigeration(3)

heatPipe(4)

sunPlat Sensor

The sunPlat Sensor superclass is used to represent the generic characteristics of hardware resources that measure properties of other hardware resources.

This class has the entPhysicalClass sensor(8).

The sunPlat Sensor class has the following attributes:

Note - The sunPlatSensor prefix has been omitted from the following attribute names for clarity.

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 TABLE 10-9.

TABLE 10-9 Sensor Type Attribute Values
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/revolutions of a device.
`counter(7)`	A general purpose sensor which counts defined events.

Latency

This read-only attribute indicates the following:

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

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

sunPlat Binary Sensor

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

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

The sunPlat Binary Sensor class has the following attributes:

Note - The sunPlatBinarySensor prefix has been omitted from the following attribute names for clarity.

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.

sunPlat Numeric Sensor

A sunPlat Numeric Sensor class is used to represent the characteristics of sensors which can return numeric readings. The numeric sensor values are qualified by a Unit of Measurement as defined below:

Unit of Measurement = Base Unit * 10Exponent

This qualification allows for units of measurement such as milliamps and microvolts. If a Rate Unit is defined, the Unit of Measurement is further refined as below:

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

This qualification allows for units of measurement such as rpm and km/hr.

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

The sunPlat Numeric Sensor class has the following attributes:

Note - The sunPlatNumericSensor prefix has been omitted from the following attribute names for clarity.

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 that 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 may 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 may 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 around the threshold values.

EnabledThresholds

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

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:

Note - The sunPlatDiscreteSensorState prefix has been omitted from the following attribute names for clarity.

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.

sunPlat Chassis

The sunPlat Chassis class is used to represent the primary enclosure. It does not extend the characteristics of the sunPlat Equipment class. The chassis contains all the modeled hardware resources, and is not contained within any other resource.

This class has the entPhysicalClass chassis(3).