HPI-B0101-MIB: View SNMP OID List / Download MIB

HPI MIB for SAF-HPI B-01-01. When using this MIB it is strongly recommended to use the SNMPv3 protocol due to security concerns. Additionally if fine grain access configuration is desired, for example to manage access to individual columnar objects, the SNMP configuration should use VACM (View Based Access Control Model - RFC 2275). This MIB defines the HPI instrumentation based on 'Service Availability Forum Hardware Platform Interface' (SAI-HPI-B.01.01). This MIB module defines a set of objects that allow the management of entities on a variety of hardware platforms. The abstractions presented in this MIB are derived from the Service Availability Forum Hardware Platform Interface specification version SAI-HPI-B.01.01. The MIB views a hardware platform as a collections of physical entities that can be managed individually. A logical collection of entities comprises a management domain. Each entity has a common set of attributes reflected in the entity table. Entities may have additional categorical attributes that may exist in one or more of the hotswap table, control table, sensor table, watchdog table, inventory control table and config table. The hotswap table defines management attributes for an entity that supports hotswap, generally referred to as a FRU. The controls table defines variables for reading and setting controls associated with an entity. The sensors table defines variables for reading sensors associated with an entity as well as controlling event generation for that sensor. The watchdog table defines variables for reading watchdog associated with an entitry. The inventory control defines variables for reading inventory resources and changing the settings.

This scalar object provides the version of HPI this MIB is based on.

This scalar object provides the version of the HPI-MIB SNMP implementation.

This scalar object provides the Resource Id of the domain the HPI-MIB SNMP implementation is running on. This is to help prevent powering down the machine providing the SNMP service.

This scalar object forces the discovery of all resources and associated domains by the underlying management service.

The number of Domain entries present in the system.

This table represents the management attributes common to all Domains within the managed platform. The logical domain ID and the entity ID are used to address an entity.

Domain Info: This structure is used to store the information regarding the domain including information regarding the domain reference table (DRT) and the resource presence table (RPT). The DomainTag field is an informational value that supplies an HPI SNMP Manager with naming information for the domain. NOTE: Regarding timestamps - If the implementation cannot supply an absolute timestamp, then it may supply a timestamp relative to some system-defined epoch, such as system boot. The value SAHPI_TIME_UNSPECIFIED indicates that the time of the update cannot be determined. Otherwise, If the value is less than or equal to SAHPI_TIME_MAX_RELATIVE, then it is relative; if it is greater than SAHPI_TIME_MAX_RELATIVE, then it is absolute. See SaHpiTime textual convention for more details.

Domain identifier. The number is unique within the system.

Domain Capabilities This definition defines the capabilities of a given domain. A domain may support any number of capabilities , each capability seperated by a delimiter. See the textual convention. autoInsertReadOnly(1): Indicates that the domain auto insert timeout value is read-only and may not be modified using the saHpiAutoTimeoutForInsert columnar object. Bits: 'autoInsertReadOnly': 1, 'undefined': 0.

Indicates that this domain participates in a peer relationship. TRUE = Domain is peer. FALSE = Domain is not peer

Information tag associated with domain. See Definition for SaHpiTextType for more details.

Information tag associated with domain. See Definition for SaHpiTextLanguage for more details.

Information tag associated with domain. The type of data is specified by saHpiDomainTagTextType and saHpiDomainTagLanguage.

This count is incremented any time the DRT table is changed. It rolls over to zero when the maximum value (2^32) is reached.

This timestamp is set any time the DRT table is changed. Refer to SaHpiTime for full description.

This count is incremented any time the RPT is changed. It rolls over to zero when the maximum (2^32) value is reached

This timestamp is set any time the RPT table is changed. Refer to SaHpiTime for full description.

This count is incremented any time the DAT is changed. It rolls over to zero when the maximum value (2^32) is reached

This timestamp is set any time the DAT is changed. Refer to SaHpiTime for full description.

Count of active alarms in the DAT.

Count of active critical alarms in the DAT.

Count of active major alarms in the DAT.

Count of active minor alarms in the DAT.

Maximum User Alarms that can be added to DAT. 0=no fixed limit.

Set to True if there are one or more non-User Alarms that are missing from the DAT because of space limitations.

The GUID is used to uniquely identify a domain. A GUID value of zero is not valid and indicates that the domain does not have an associated GUID. GUID - Globally Unique Identifier A GUID value of zero is not valid and indicates that the domain does not have an associated GUID. See textual convention.

The number of DRT entries present in the saHpiDomainReferenceTable.

A table, provided by an HPI implementation, of additional domains related to the current domain.

The Domain Reference Table (DRT) which provides information about other domains associated with the domain. The two saHpiDomainId indices for this table are used to uniquely a domain and an associated domain, that are in a peer or tiered domain relationship. The DRT contains an entry for each associated domain, and HPI MIB Users may read these entries to discover the presence of additional domains within a 'System'. The discovered domains can, in turn, be used to discover additional resources and domains. The DRT is automatically built and maintained by the HPI implementation. Domain entries in the DRT may change over time if the 'System' configuration changes. There are two types of domain references: - A peer domain architecture, which consists of two or more domains that are expected to contain the same resources and domain references. Each domain in a peer relationship contains an RPT listing all resources present in each domain. - A tiered (child) domain architecture is used when all the resources in a 'system' cannot be accessed in a single domain. A 'parent' domain references one or more 'child' domains in its DRT. The 'child' domains may be simple domains containing only resources, or they may themselves be a 'parent' to other 'child' domains. Domains in a tiered relationship are disjointed and do not contain the same resources.

If a Peer or child domain exists this is the DomainID.

Indicates that this domain participates in a peer relationship. TRUE = Domain is peer. FALSE = Domain is not peer (is a child)

The number of DomainAlarm entries present in the system.

This table represents the management attributes common to all Domains within the managed platform. The logical domain ID and the entity ID are used to address an entity.

This table is used to store alarm information.

DomainAlarm Id

Time when alarm was added to the DAT table. Refer to SaHpiTime for full description.

Severity of alarm. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

Use this columnar object to acknowledge a specific Alarm. An HPI SNMP Manager acknowledges an alarm to indicate that it is aware of the alarm and to influence platform-specific alarm annunciation that may be provided by the implementation. Typically, an implementation ignores acknowledged alarms when announcing an alarm on annunciation devices such as audible sirens and dry contact closures. However, An acknowledged alarm will have the Acknowledged field in the alarm entry set to True. DomainAlarms are acknowledged by one of two ways: a single alarm entry by DomainAlarmId regardless of severity or as a group of alarm entries by Severity regardless of DomainAlarmId. To acknowledge all alarms contained within the DAT, set the Severity parameter to allSeverities(256), and set the DomainAlarmId parameter to SAHPI_ENTRY_UNSPECIFIED. To acknowledge all alarms of a specific severity contained within the DAT, set the Severity parameter to the appropriate value, and set the DomainAlarmId parameter to SAHPI_ENTRY_UNSPECIFIED. To acknowledge a single alarm entry, set the DomainAlarmId parameter to a value other than SAHPI_ENTRY_UNSPECIFIED. The DomainAlarmId must be a valid identifier for an alarm entry present in the DAT at the time of the function call. If an alarm has been previously acknowledged, acknowledging it again has no effect. However, this is not an error. If the DomainAlarmId parameter has a value other than SAHPI_ENTRY_UNSPECIFIED, the Severity parameter is ignored. If the DomainAlarmId parameter is passed as SAHPI_ENTRY_UNSPECIFIED, and no alarms are present that meet the requested Severity, this function will have no effect. However, this is not an error. SAHPI_ENTRY_UNSPECIFIED is defined as the same value as SAHPI_FIRST_ENTRY, so using either symbol will have the same effect. However, SAHPI_ENTRY_UNSPECIFIED should be used with this function for clarity.

Use this columnar object to acknowledge Alarms based on severity. An HPI SNMP Manager acknowledges an alarm to indicate that it is aware of the alarm and to influence platform-specific alarm annunciation that may be provided by the implementation. Typically, an implementation ignores acknowledged alarms when announcing an alarm on annunciation devices such as audible sirens and dry contact closures. However, alarm annunciation is implementation-specific. An acknowledged alarm will have the Acknowledged field in the alarm entry set to True. DomainAlarms are acknowledged by one of two ways: a single alarm entry by DomainAlarmId regardless of severity or as a group of alarm entries by Severity regardless of DomainAlarmId. To acknowledge all alarms contained within the DAT, set the Severity parameter to allSeverities(256), and set the DomainAlarmId parameter to SAHPI_ENTRY_UNSPECIFIED. To acknowledge all alarms of a specific severity contained within the DAT, set the Severity parameter to the appropriate value, and set the DomainAlarmId parameter to SAHPI_ENTRY_UNSPECIFIED. To acknowledge a single alarm entry, set the DomainAlarmId parameter to a value other than SAHPI_ENTRY_UNSPECIFIED. The DomainAlarmId must be a valid identifier for an alarm entry present in the DAT at the time of the function call. If an alarm has been previously acknowledged, acknowledging it again has no effect. However, this is not an error. If the DomainAlarmId parameter has a value other than SAHPI_ENTRY_UNSPECIFIED, the Severity parameter is ignored. If the DomainAlarmId parameter is passed as SAHPI_ENTRY_UNSPECIFIED, and no alarms are present that meet the requested Severity, this function will have no effect. However, this is not an error. SAHPI_ENTRY_UNSPECIFIED is defined as the same value as SAHPI_FIRST_ENTRY, so using either symbol will have the same effect. However, SAHPI_ENTRY_UNSPECIFIED should be used with this function for clarity.

Enumeration of status condition type. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

See Textual-Convention for details.

Sensor associated with status Only valid if saHpiDomainAlarmCondStatusCondType is sensor(1).

Sensor event state. Only valid if saHpiDomainAlarmCondStatusCondType is sensor(1).

AIS compatible identifier associated with Status condition. The Service Availability(TM) Forum Application Interface Specification standardizes the interface between Service Availability(TM) Forum compliant High Availability (HA) middleware and service applications. http://www.saforum.org

Manufacturer Id associated with status condition, required when saHpiDomainAlarmCondStatusCondType is oem(3).

Optional data associated with status condition associated with Domain. For more details, see textual definition and saHpiDomainAlarmCondDomainTextType and saHpiDomainAlarmCondDomainTextLanguage

Optional data associated with status condition. For more details, see textual definition

Optional data associated with status condition. The type of date is specified by saHpiDomainAlarmCondDomainAlarmaTextType and saHpiDomainAlarmCondDomainAlarmaTextLanguage.

This columnar object contains the status of the row and is also used to perform add and delete operations. The status column uses four defined values: - `active(1)', which indicates that the conceptual row is available for use by the managed device; - `notInService(2)', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device. - `createAndWait(5)', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device). This operation is used to add a User Alarm to the Domain Alarm Table. It also subsequently appears in the User Event Table (a duplicate). The row is created (and changes state to 'active' when the saHpiDomainAlarmSeverity has been set on) to a new instance of the conceptual row. The dis-allowed saHpiDomainAlarmSeverity values are minor(3), major(2), and critical(3). - `destroy(6)', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. This function allows the HPI MIB User to delete a single User Alarm or a group identified by severity (saHpiDomainAlarmSeverity) from the Domain Alarm Table. Note this has no efect on the 'User Event Table.' Only User Alarms added to the DAT can be deleted. To delete a single, specific alarm, set the saHpiDomainAlarmId parameter to a value representing an actual User Alarm ( all three indices must be valid) in the DAT. To delete a group of User Alarms by severity set saHpiDomainAlarmId == SAHPI_ENTRY_UNSPECIFIED (see textual convention for more details.)

The number of RPT entries present in the system. This field is used to determine if new resources have been added or existing removed.

The logical domain ID and the Resource ID are used to address a Resource.

A User access the Resource Presence Table (RPT) for each domain in the system. This table represents up-to-date information on the resources currently present in the domain with which it is associated. The ResourceCapabilities field defines the capabilities of the resource. This field must be non-zero for all valid resources. The ResourceTag field is an informational value. The HotSwapCapabilities field denotes the capabilities of the resource, specifically related to hot swap. This field is only valid if the resource supports managed hot swap, as indicated by the SAHPI_CAPABILITY_MANAGED_HOT_SWAP resource capability. All of the fields in the following table may or may not be used by a given resource.

Resource identifier. The SAHPI_UNSPECIFIED_RESOURCE_ID value is used to specify the Domain Event Log and to specify that there is no resource for such things as HPI User events/alarms. Note: SAHPI_UNSPECIFIED_RESOURCE_ID 0xFFFFFFFF

This index is here to help facilitate browsing a known resources RDR's. For example to find the first RDR's specify a value of SAHPI_FIRST_ENTRY. See textual-convention for further details.

See Texual-Convention for details.

Resource Capabilities This definition defines the capabilities of a given resource by using a bit values. One resource may support any number of capabilities using the bits. Because each entry in an Resource Table will have the resource(15) bit set; undefined(0) is not a valid value for the capability flag, and is thus would be used to indicate 'no resource present in' in some objects. resource(15) evtDeAsserts(14) Indicates that all sensors on the resource have the property that their Assertion and Deassertion event enable flags are the same. That is, for all event states whose assertion triggers an event, it is guaranteed that the deassertion of that event will also trigger an event. Thus, an HPI SNMP Manager may track the state of sensors on the resource by monitoring events rather than polling for state changes. aggregateStatus(13) configuration(12) managedHotSwap(11) Indicates that the resource supports the full managed hot swap model. Since hot swap only makes sense for field-replaceable units, the FRU capability string must also be set for this columnar object. watchdog(10) control(9) fru(8) Indicates that the resource is a field-replaceable unit; i.e., it is capable of being removed and replaced in a live system. If managedHotSwap(11) is also set, the resource supports the full hot swap model. If managedHotSwap(11) is not set, the resource supports the simplified hot swap model. annunciator(7) power(6) reset(5) inventoryData(4) eventLog(3) rdr(2) Indicates that a resource data record (RDR) repository is supplied by the resource. Since the existence of an RDR is mandatory for all management instruments, this capability must be asserted if the resource contains any annunciators, sensors, controls, watchdog timers , or inventory data repositories. sensor(1) See textual-convention for further definition. Bits: 'reset': 5, 'control': 9, 'configuration': 12, 'resource': 15, 'undefined': 0, 'eventLog': 3, 'rdr': 2, 'aggregateStatus': 13, 'managedHotSwap': 11, 'power': 6, 'fr': 8, 'watchdog': 10, 'annunciator': 7, 'sensor': 1, 'inventoryDate': 4, 'evtDeAsserts': 14.

This definition defines the managed hot swap capabilities of a given resource. autoExtractReadOnly(1) This capability indicates if the hot swap autoextract timer is read-only. indicatorSupported(2) Indicates whether or not the resource has a hot swap indicator. See textual convention for futher details. Bits: 'indicatorSupported': 2, 'undefined': 0, 'autoExtractReadOnly': 1.

Indicates the criticality that should be raised when the resource is not responding. Note: The enumerated named have +1 added as opposed to the SAI-HPI-B.01.01 spec for the same constants.

TRUE = Resource Not Functional. FALSE = Resource Functional

saHpiResourceInfo contains static configuration data concerning the management controller associated with the resource, or the resource itself. Note this information is used to describe the resource; that is, the piece of infrastructure which manages an entity (or multiple entities) - NOT the entities for which the resource provides management. The purpose of the saHpiResourceInfoT structure is to provide information that the HPI SNMP Manager may need in order to interact correctly with the resource (e.g., recognize a specific management controller which may have defined oem fields in sensors, oem controls, etc.

See saHpiResourceInfoResourceRev in SAI-HPI-B.01.01 for overview.

See saHpiResourceInfoResourceRev in SAI-HPI-B.01.01 for overview.

See saHpiResourceInfoResourceRev in SAI-HPI-B.01.01 for overview.

See saHpiResourceInfoResourceRev in SAI-HPI-B.01.01 for overview.

See saHpiResourceInfoResourceRev in SAI-HPI-B.01.01 for overview.

See saHpiResourceInfoResourceRev in SAI-HPI-B.01.01 for overview.

See saHpiResourceInfoResourceRev in SAI-HPI-B.01.01 for overview.

The GUID is used to uniquely identify a Resource. A GUID value of zero is not valid and indicates that the Resource does not have an associated GUID. See textual convention for more details.

This object contains the resource tag information. See textual convention for more information.

This object contains the resource tag text language enumeration. See textual convention for more information.

Resource tag. The type of data is specified by saHpiResourceTagTextType and saHpiResourceTagLanguage.

This object allows the user to save and restore parameters associated with a specific resource. Valid actions for this function include: undefined(0) - resource has no concept of configurations. restoreDefaultParm(1) - Restores factory default settings for a specific resource. Factory defaults include sensor thresholds and configurations, and resource-specific configuration parameters. saveParm(2) - Stores the resource configuration parameters in non-volatile storage. Resource configuration parameters stored in non-volatile storage will survive power cycles and resource resets. restoreParm(3) - Restores resource configuration parameters from non-volatile storage. Resource configuration parameters include sensor thresholds and sensor configurations, as well as resource-specific parameters. unsupported(4) - Specifies if the resource does not support parameter control. This value is not written but is read only. And states the above actions when written are not supported and if written a SNMP error code 'notWritable' will be generated. SNMP error codes should be checked to see of action written succeeded. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec. Enumeration: 'saveParm': 2, 'restoreParm': 3, 'undefined': 0, 'unsupported': 4, 'restoreDefaultParm': 1.

This function gets the reset state of an entity, allowing the HPI SNMP Manager to determine if the entity is being held with its reset asserted. If a resource manages multiple entities, this function will address the entity which is identified in the Resource Table entry for the resource. coldReset(1) and warmReset(2) are pulsed resets, and are not valid values to be returned in saHpiResetAction. If the entity is not being held in reset (using resetAssert(3)), the appropriate value is resetDeAssert(4). Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec. Enumeration: 'resetAssert': 3, 'undefined': 0, 'coldReset': 1, 'resetDeAssert': 4, 'warmReset': 2, 'unsupported': 5.

This function gets the power state of an entity, allowing the HPI SNMP Manager to determine if the entity is currently powered on or off. If a resource manages multiple entities, this function will address the entity which is identified in the RPT entry for the resource. cycle(3) is a pulsed power operation and is not a valid return for the power state. This function controls the hardware power on a FRU entity regardless of what hot-swap state the resource is in. For example, it is legal (and may be desirable) to cycle power on the FRU even while it is in ACTIVE state in order to attempt to clear a fault condition. Similarly, a resource could be instructed to power on a FRU even while it is in inactive(1) state, for example, in order to run off-line diagnostics. Not all resources supporting hot swap will necessarily support this function. In particular, resources that use the simplified hot swap model may not have the ability to control FRU power. This function may also be supported for non-FRU entities if power control is available for those entities. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec. Enumeration: 'on': 2, 'off': 1, 'undefined': 0, 'unsupported': 4, 'cycle': 3.

This columnar object, which is part of the index for every resource, determines if this resource is historical. Historical meaning not present in the system anymore, but only present in the event and as part of that. Note that this means that the implementation must in some way control how much data is persisted. Check with the implementation documentation for more details.

In support of HPI saHpiAutoInsertTimeoutGet, and saHpiAutoInsertTimeoutSet.

Table of domains with a timeout for how long to wait before the default auto-insertion policy is invoked on a resource within a specific domain.

This function allows the HPI SNMP Manager to configure a timeout for how long to wait before the default auto-insertion policy is invoked on a resource within a specific domain. This columnar object accepts a parameter instructing each resource to impose a delay before performing its default hot swap policy for auto-insertion. The parameter may be set to SAHPI_TIMEOUT_IMMEDIATE ( see SaHpiTime Textual-Convention for further details) to direct resources to proceed immediately to auto-insertion, or to SAHPI_TIMEOUT_BLOCK ( see SaHpiTime Textual-Convention for further details) to prevent auto-insertion from ever occurring. If the parameter is set to another value, then it defines the number of nanoseconds between the time a hot swap event with saHpiHotSwapState == insertionPending(5) is generated, and the time that the auto-insertion policy will be invoked for that resource. If, during this time period, a saHpiHotSwapPolicyCancel function call is processed, the timer will be stopped, and the auto-insertion policy will not be invoked. Each domain maintains a single auto-insert timeout value and it is applied to all contained resources upon insertion, which support managed hot swap. Once the auto-insertion process begins, the HPI SNMP Manager will not be allowed to take control of the insertion process; hence, the timeout should be set appropriately to allow for this condition. Note that the timeout period begins when the hot swap event with saHpiHotSwapState == insertionPending(5) is initially generated.

The number of HotSwap entries present in the system.

This table represents management attributes common to all hot swappable resources in the managed platform. The entries in this table are straight from the HPI spec. This table builds upon information present in the saHpiResourceTable.

An entry describing a particular hot swappable entity.

A FRU associated with a hot-swappable resource may include a hot swap indicator such as a blue LED. This indicator signifies that the FRU is ready for removal. This columnar object allows the HPI SNMP Manager to retrieve and set the state of this indicator. When retrieving the values, the valid states are either saHpiHotSwapIndicator == off(1) or saHpiHotSwapIndicator == on(2). This columnar object will return information, regardless of what hot swap state the resource is in. When setting the values, valid states include saHpiHotSwapIndicator == off(1) or saHpiHotSwapIndicator == on(2). This function will set the indicator regardless of what hot swap state the resource is in, though it is recommended that this function be used only in conjunction with moving the resource to the appropriate hot swap state. Enumeration: 'on': 2, 'off': 1, 'undefined': 0.

Refer to the textual convention for full details.

This function allows the HPI SNMP Manager to configure a timeout for how long to wait before the default auto-extraction policy is invoked. This function accepts a parameter instructing the resource to impose a delay before performing its default hot swap policy for auto-extraction. The parameter may be set to SAHPI_TIMEOUT_IMMEDIATE to direct the resource to proceed immediately to auto-extraction, or to SAHPI_TIMEOUT_BLOCK to prevent auto-extraction from ever occurring on a resource. If the parameter is set to another value, then it defines the number of nanoseconds between the time a hot swap event with saHpiHotSwapState = extractionPending(4) is generated and the time that the auto-extraction policy will be invoked for the resource. If, during this time period, a saHpiHotSwapPolicyCancel function call is processed, the timer will be stopped, and the auto-extraction policy will not be invoked. Once the auto-extraction process begins, the HPI SNMP Manager will not be allowed to take control of the extraction process; hence, the timeout should be set appropriately to allow for this condition. Note that the timeout period begins when the hot swap event with saHpiHotSwapState = extractionPending(4) is initially generated.

A resource supporting hot swap typically requires a physical action on the associated FRU to invoke an insertion or extraction process. An insertion process is invoked by physically inserting the FRU into a chassis. Physically opening an ejector latch or pressing a button invokes the extraction process. This columnar object allows the HPI SNMP Manager to invoke an insertion or extraction process via software. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec. Enumeration: 'extraction': 2, 'undefined': 0, 'insertion': 1.

A resource supporting hot swap typically supports default policies for insertion and extraction. On insertion, the default policy may be for the resource to turn the associated FRU~s local power on and to de-assert reset. On extraction, the default policy may be for the resource to immediately power off the FRU and turn on a hot swap indicator. This function allows an HPI SNMP Manager, after receiving a hot swap event with saHpiHotSwapState equal to INSERTION_PENDING or EXTRACTION_PENDING, to prevent the default policy from being executed. Once the resource transitions to either the ACTIVE or inactive(1) state, the default policies will once again execute, unless cancelled using saHpiHotSwapPolicyCancel. The default policy cannot be canceled once it has begun to execute. Because a resource that supports the simplified hot swap model will never transition into insertionPending(2) or extractionPending(4) states, this function is not applicable to those resources. Note: Enumerated values are increased by one value compared to SAI-HPI-B spec. Enumeration: 'cancel': 1, 'undefined': 0.

Depending on the values, the user can: - use this function to request a resource to return to the ACTIVE state from the extractionPending(4) state in order to reject an extraction request. Because a resource that supports the simplified hot swap model will never transition into insertionPending(2) or extractionPending(4) states, this function is not applicable to those resources. - use this function to request a resource to return to the inactive(1) state from the insertionPending(2) state to abort a hot-swap insertion action. Because a resource that supports the simplified hot swap model will never transition into insertionPending(2) or extractionPending(4) states, this function is not applicable to those resources. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec. Enumeration: 'setInActive': 2, 'undefined': 0, 'setActive': 1.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. 'saHpiEventLifetimeChanges' represents the sum of all events of all supported types that have occur in the system. Note saHpiDomainEventLifetimeChanges represents the subset of events that are Domain events. The same relationship exists for ResourceEvent, SensorEvent, SensorEnableChangeEvent, HotSwapEvent, WatchdogEvent, HpiSwEvent, OemEvent, UserEvent.

The number of events present in this table. 'saHpiEventCount' represents the total of all events types currently stored in the 'saHpiEventTable.' saHpiDomainEventCount represents the subset of events that are Domain events. The same relationship exists for ResourceEvent, SensorEvent, SensorEnableChangeEvent, HotSwapEvent, WatchdogEvent, HpiSwEvent, OemEvent, UserEvent.

Event Master table.

This table presents the list of all events which are present in the HPI system. The implementation decides how to manipulate the events as they reach a large number. This table is used as a master event table which an index that points to the specific sub-table which has more details on the event. Each time a new event is surfaced in the HPI system this table increases by a new row and its respective sub-event table too (saHpiResourceEventTable, saHpiOemEventTable, etc). Futhermore based on the type of event, an notification is generated as well.

OID value points to any of the other nine tables: saHpiResourceEventTable, saHpiDomainEventTable, saHpiSensorEventTable, saHpiSensorEnableChangeTable, saHpiHotSwapEventTable, saHpiWatchdogTable, saHpiSoftwareEventTable, saHpiOemEventTable, and saHpiUserEventTable.

Severity of event. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Event type. Note: The enumerated named have +1 added as opposed to the SAI-HPI-B.01.01 spec for the same constants. Enumeration: 'domain': 2, 'resource': 1, 'undefined': 0, 'hpiSw': 7, 'user': 9, 'oem': 8, 'watchdog': 6, 'hotswap': 5, 'sensor': 3, 'sensorEnableChange': 4.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are Resource Events.

This scalar object represents the subset of events that are Resource Events.

Event table.

Resource events.

Arbitrary table index.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Resource events are sent to indicate the failure or subsequent restoration of a resource. Resource events can also be used to announce the addition of a non-FRU resource to the RPT table. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec. Enumeration: 'resourceRestored': 2, 'resourceAdded': 3, 'undefined': 0, 'resourceFailure': 1.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are Domain events.

This scalar object represents the subset of events that are Domain events.

Event table.

Domain events.

This columnar object is an index for Domain Events in the table.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

This object defines the enumeration for the domain to announce the addition of domain references and the removal of domain references to the Domain Table. Enumeration: 'domainRefRemoved': 2, 'undefined': 0, 'domainRefAdded': 1.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are Sensor events.

This scalar object represents the subset of events that are Sensor Events.

Event table.

Sensor events.

Arbitrary table index.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Refer to the textual convention for more details.

Event category: See TEXTUAL-CONVENTION, SaHpiEventCategory.

Sensor Events and Sensor Event States: Each Event State may be asserted or deasserted. The set of Event States a sensor may support is defined by the sensor's 'Event Category.' A particular sensor, however, does not have to support all the Event States defined for its event category. The specific Event States that a particular sensor supports are indicated in the 'Events' field in the sensor's RDR. A sensor is not required to support any Event States. If no Event States are supported by a sensor, the 'Events' field will be 0x0000. A sensor may not support any Event States that are not defined for its event category. Each Event State is independent, although in some event categories the meaning assigned to the Event States will imply that certain Event States will be mutually exclusive. For example, a sensor that uses the limit(6) event category should only have one of the two Event States, SAHPI_ES_LIMIT_NOT_EXCEEDED or SAHPI_ES_LIMIT_EXCEEDED asserted at any one time. Except where mutual exclusion is implied, however, sensors may have multiple Event States asserted simultaneously. For example, the event category threshold(2) uses six different event states to report the relationship between the value currently measured by the sensor and up to six different 'threshold' values. Each threshold is independently examined, and each Event State that represents a threshold that has been 'crossed' will be asserted. Threshold values must be configured so that 'Minor', 'Major' and 'Critical' thresholds are increasingly extreme readings, such that when a 'Major' threshold has been crossed, the corresponding 'Minor' threshold will also have been crossed, and thus both Event States will be asserted. When a sensor Event State is asserted or deasserted, an event may be generated by the resource. The generated event identifies the sensor and the event state being asserted or deasserted. The HPI implementation may assign event severity levels for each event state assertion or deassertion on an individual sensor basis.

Refer to the textual convention for more details.

See textual convention aHpiOptionalData.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to SaHpiEventState textual convention for more details.

Reserved for Oem use.

Event Specific information.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are Sensor Enable ChangeEvents.

This scalar object represents the subset of events that are Sensor Enable ChangeEvents.

Event table.

Sensor Enable Change events.

Arbitrary table index.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Current sensor enable status.

Current event enable status.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

See textual convention SaHpiOptionalData.

Current set of asserted Event states.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are HotSwap Events.

This scalar object represents the subset of events that are HotSwap Events.

Event table.

Hot Swap events.

Arbitrary table index.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Refer to the textual convention for full details.

Refer to the textual convention for full details.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are Watchdog Events.

This scalar object represents the subset of events that are Watchdog Events.

Event table.

Watchdog events.

Arbitrary table index.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

These enumerations represent the possible actions to be taken upon watchdog timer timeout and the events that are generated for watchdog actions. Enumeration: 'reset': 2, 'powerCycle': 4, 'powerDown': 3, 'noAction': 1, 'timerInt': 9, 'undefined': 0.

These enumerations represent the possible types of interrupts that may be triggered by a watchdog pre-timer event. The actual meaning of these operations may differ depending on the hardware architecture.

Watchdog Timer Use These enumerations represent the possible watchdog users that may have caused the watchdog to expire. For instance, if watchdog is being used during power on self test (POST), and it expires, the biosPost(3) expiration type will be set. Most specific uses for Watchdog timer by users of HPI should indicate smsOs(5) if the use is to provide an OS-healthy heartbeat, or oem(6) if it is used for some other purpose.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are Software Events.

This scalar object represents the subset of events that are Software Events.

Event table.

Software events.

Arbitrary table index.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Refer to the textual convention for more details.

The following type defines the types of events that can be reported by the HPI software implementation. Audit events report a discrepancy in the audit process. Audits are typically performed by HA software to detect problems. Audits may look for such things as corrupted data stores, inconsistent RPT information, or improperly managed queues. Startup events report a failure to start-up properly, or inconsistencies in persisted data. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec. Enumeration: 'hpieOther': 3, 'undefined': 0, 'hpieAudit': 1, 'hpieStartup': 2.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are oem Events.

This scalar object represents the subset of events that are oem Events.

Event table.

Oem events.

Arbitrary table index.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are User Events.

This scalar object represents the subset of events that are User Events.

Event table.

User events.

Arbitrary table index.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Refer to SaHpiTextType for more details.

Refer to saHpiTextLanguage for more details.

Refer to saHpiText for more details.

This columnar object contains the status of the row and also perform add and delete operations. The status column uses three defined values: - `active(1)', which indicates that the conceptual row is available for use by the managed device; - `createAndWait(5)', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device). This function is used to add a User Alarm to this User Event Table and also to the to the Domain Alarm Table; The effect of creating a new row will also be reflected in the DAT - with a new row there. - `destroy(6)', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. This function allows the HPI MIB User to delete an User Event. Note a deletion of a row that is already in the 'active(1)' state is prohibited. HPI does not support deleting existing events. A row can only be deleted if its RowStatus value is 'createAndGo(4)'. Developers Note: Avoid creating duplicate entries here! 1. a manager would add an event to the User Event Table, 2. the Sub-agent would see this and call saHpiEventAdd(), 3. the event would go thru the HPI system and would be added to the HPI event queue, 4. the sub-agent would read the event queue as part of its normal operations, and when it sees this event it would know to ignore it, since it is already in the table (because the manager added it to the table to start this whole process).

The number of announcements present on this system.

Table of Announcements.

The table of announcements is used to provide a common interface to varied mechanisms for announcing conditions. Each announcement in an Annunciator's current set contains a severity level, details describing the specific condition that is being reported, an Acknowledged flag, a timestamp indicating when the announcement was added to the set, and an EntryId that uniquely identifies the particular status item within the set. EntryIds are assigned to announcements as they are added to the set as well as a Timestamp. After an announcement is deleted from the current set, its EntryId may be reused for a newly added announcement as long as the new announcement will have a different timestamp than any previously deleted announcement using the same EntryId. Thus, the EntryId and Timestamp together will uniquely identify any announcement, which was ever present in the Annunciator's set. The actual meaning of the Acknowledged flag is arbitrary, and the actions taken by the platform when announcements are flagged as 'acknowledged' or 'unacknowledged' are implementation-specific. The intended use of the flag is to indicate whether a particular announcement in the current set has been recognized by whomever or whatever is inspecting the LEDs, displays, etc., that are being driven by the Annunciator management instrument. Thus, when announcements are added to the current set, generally the flag should be set to indicate that the condition is 'unacknowledged'. Later, either as the result of an HPI SNMP Manager function call, or due to some implementation-dependent action (such as pressing an 'acknowledge' button on a front-panel display), the flag can be changed to indicate that the announcement is now 'acknowledged.' The ability to acknowledge announcements is not controlled by the Annunciator 'mode' setting (Auto, User, or Shared). Any announcement may be acknowledged by the HPI implementation, or via the saHpiAnnunciatorAcknowledge() function call, regardless of the current mode setting for the Annunciator. Over time, announcements are added to and deleted from an Annunciator`s current set of announcements. This may be done automatically by the HPI implementation to reflect platform fault conditions, or by the HPI SNMP Manager via the HPI interface. When announcements are added or deleted automatically by the HPI implementation, it is implementation-specific which announcements are added or removed.

Entry ID for record Table Related Type Definitions SAHPI_FIRST_ENTRY 0x00000000 SAHPI_LAST_ENTRY 0xFFFFFFFF

Annunciator number for the addressed Annunciator.

Time when announcement added to set.

True if added to set by HPI SNMP Manager, False if added automatically by HPI implementation.

Only used with DAT and Annunciator functions. This is not a valid severity for events or alarms.

Acknowledged flag.Use this columnar object to acknowledge a specific Announcement.

Use this columnar object to acknowledge all Announcements of a particular severity.

Status Condition Type.

See Textual-Convention for details.

Sensor associated with status Only valid if Type is SAHPI_STATUS_COND_TYPE_SENSOR.

Sensor event state. Only valid if Type is SAHPI_STATUS_COND_TYPE_SENSOR..

AIS compatible identifier associated with Status condition.

Manufacturer Id associated with status condition, required when type is SAHPI_STATUS_COND_TYPE_OEM.

Field Data. See Definition for SaHpiTextType for more details.

Field Data. See Definition for SaHpiTextLanguage for more details.

Field Data. The type of date is specified by saHpiResourceTagTextType and saHpiResourceTagLanguage.

This function allows the HPI SNMP Manager to delete a single announcement. Announcements may be deleted individually by specifying a specific index and setting this columnar object to destroy(6).

A table definining Event Log Information records.

Each resource has a Event Log Information record, which contains per resource pertinent logging information.

The number of active entries contained in the log.

The total number of entries the log is able to hold.

The UserEventMaxSize entry indicates the maximum size of the text buffer data field in an HPI SNMP Manager event that is supported by the Event Log implementation. If the implementation does not enforce a more restrictive data length, it should be set to SAHPI_MAX_TEXT_BUFFER_LENGTH (255).

The UpdateTimestamp entry denotes the time of the last update to the Event Log. Refer to SaHpiTime for full description.

The Time entry denotes the Event Log's idea of the current time; i.e the timestamp that would be placed on an entry if it was added now. Remarks: Entries placed in the Event Log after this function is called will have Event Log timestamps (i.e., the Timestamp field in the SaHpiEventLogEntryT structure) based on the new time. Setting the clock does not affect existing Event Log entries. If the time is set to a relative time, subsequent entries placed in the Event Log will have an Event Log timestamp expressed as a relative time; if the time is set to an absolute time, subsequent entries will have an Event Log timestamp expressed as an absolute time. This function only sets the Event Log time clock and does not have any direct bearing on the timestamps placed on events (i.e., the Timestamp field in the SaHpiEventT structure), or the timestamps placed in the domain RPT info record. Setting the clocks used to generate timestamps other than Event Log timestamps is implementation-dependent, and should be documented by the HPI implementation provider. Some underlying implementations may not be able to handle the same relative and absolute time ranges, as those defined in HPI. Such limitations will be documented in implementation-specific documentation. When a time value is set in a region that is not supported by the implementation, an error code of SNMP_GENERROR will be returned. Refer to SaHpiTime for full description.

The Enabled entry indicates whether the log is enabled. If the event log is 'disabled' no events generated within the HPI implementation will be added to the event log. User events may still be added to the event log. When the event log is 'enabled' events may be automatically added to the event log as they are generated in a resource or a domain, however, it is implementation-specific which events are automatically added to any event log.

The OverflowFlag entry indicates the log has overflowed. Events have been dropped or overwritten due to a table overflow.

Indicates if the the overflow falg can be cleared by calling saHpiEventLogInfoOverflowReset.

The OverflowAction entry indicates the behavior of the event log when an overflow occurs. drop(1) New entries are dropped when log is full overwrite(2) Event Log overwrites existing entries when Event Log is full Enumeration: 'drop': 1, 'undefined': 0, 'overwrite': 2.

This function resets the OverflowFlag in the Event Log info record of the specified Event Log. Enumeration: 'resetOverflowFlag': 1, 'undefined': 0.

This function erases the contents of the specified Event Log. TRUE clears the event log of the resource specified. FALSE has no effect. NOTE: The OverflowFlag field in the Event Log info record will be reset when this function is called.

When reading this value, true indicates that the Event Log is enabled; False indicates that it is disabled. When writing this value, true indicates that the Event Log is to be enabled; False indicates that it is to be disabled. This node enables an HPI SNMP Manager to set/get the Event Log state. If the Event Log is disabled no events generated within the HPI implementation will be added to the Event Log. Events may still be added to the Event Log. When the Event Log is enabled events may be automatically added to the Event Log as they are generated in a resource or a domain, however, it is implementation-specific which events are automatically added to any Event Log.

A table definining Event Log records.

This section defines the types associated with the SEL.

Entry ID for record Reserved values for event log entry IDs OLDEST_ENTRY 0x00000000 NEWEST_ENTRY 0xFFFFFFFF NO_MORE_ENTRIES 0xFFFFFFFE

The type of event. Note: The enumerated named have +1 added as opposed to the SA HPI spec for the same constants. Enumeration: 'domain': 2, 'resource': 1, 'undefined': 0, 'hpiSoftware': 7, 'user': 9, 'oem': 8, 'watchdog': 6, 'hotswap': 5, 'sensor': 3, 'sensorEnableChange': 4.

Refer to SaHpiTime for full description.

Pointer to the event.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are Resource Events.

This scalar object represents the subset of events that are Resource Events.

Event table.

Resource events.

Table Index.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Resource events are sent to indicate the failure or subsequent restoration of a resource. Resource events can also be used to announce the addition of a non-FRU resource to the RPT table. Note: Enumerated values are increased by one value compared to SAI-HPI-B spec. Enumeration: 'resourceRestored': 2, 'resourceAdded': 3, 'undefined': 0, 'resourceFailure': 1.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are Domain events.

This scalar object represents the subset of events that are Domain events.

Event table.

Domain events.

This columnar object is an index for Domain Events in the table.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Domain events are used to announce the addition of domain references and the removal of domain references to the DRT. Enumeration: 'domainRefRemoved': 2, 'undefined': 0, 'domainRefAdded': 1.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are Sensor events.

This scalar object represents the subset of events that are Sensor Events.

Event table.

Sensor events.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Refer to the textual convention for more details.

Event category: See TEXTUAL-CONVENTION, SaHpiEventCategory.

Sensor Events and Sensor Event States: Each Event State may be asserted or deasserted. The set of Event States a sensor may support is defined by the sensor's 'Event Category.' A particular sensor, however, does not have to support all the Event States defined for its event category. The specific Event States that a particular sensor supports are indicated in the 'Events' field in the sensor's RDR. A sensor is not required to support any Event States. If no Event States are supported by a sensor, the 'Events' field will be 0x0000. A sensor may not support any Event States that are not defined for its event category. Each Event State is independent, although in some event categories the meaning assigned to the Event States will imply that certain Event States will be mutually exclusive. For example, a sensor that uses the limit(6) event category should only have one of the two Event States, SAHPI_ES_LIMIT_NOT_EXCEEDED or SAHPI_ES_LIMIT_EXCEEDED asserted at any one time. Except where mutual exclusion is implied, however, sensors may have multiple Event States asserted simultaneously. For example, the event category threshold(2) uses six different event states to report the relationship between the value currently measured by the sensor and up to six different 'threshold' values. Each threshold is independently examined, and each Event State that represents a threshold that has been 'crossed' will be asserted. Threshold values must be configured so that 'Minor', 'Major' and 'Critical' thresholds are increasingly extreme readings, such that when a 'Major' threshold has been crossed, the corresponding 'Minor' threshold will also have been crossed, and thus both Event States will be asserted. When a sensor Event State is asserted or deasserted, an event may be generated by the resource. The generated event identifies the sensor and the event state being asserted or deasserted. The HPI implementation may assign event severity levels for each event state assertion or deassertion on an individual sensor basis.

Refer to the textual convention for more details.

See textual convention aHpiOptionalData.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to SaHpiEventState textual convention for more details.

Reserved for Oem use.

Event log specific data.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are Sensor Enable ChangeEvents.

This scalar object represents the subset of events that are Sensor Enable ChangeEvents.

Event table.

Sensor Enable Change events.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Current sensor enable status.

Current event enable status.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

See textual convention SaHpiOptionalData.

Current set of asserted Event states.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are HotSwap Events.

This scalar object represents the subset of events that are HotSwap Events.

Event table.

Hot Swap events.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Refer to the textual convention for full details.

Refer to the textual convention for full details.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are Watchdog Events.

This scalar object represents the subset of events that are Watchdog Events.

Event table.

Watchdog events.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

These enumerations represent the possible actions to be taken upon watchdog timer timeout and the events that are generated for watchdog actions. Enumeration: 'reset': 2, 'powerCycle': 4, 'powerDown': 3, 'noAction': 1, 'timerInt': 9, 'undefined': 0.

These enumerations represent the possible types of interrupts that may be triggered by a watchdog pre-timer event. The actual meaning of these operations may differ depending on the hardware architecture.

Watchdog Timer Use These enumerations represent the possible watchdog users that may have caused the watchdog to expire. For instance, if watchdog is being used during power on self test (POST), and it expires, the biosPost(3) expiration type will be set. Most specific uses for Watchdog timer by users of HPI should indicate smsOs(5) if the use is to provide an OS-healthy heartbeat, or oem(6) if it is used for some other purpose.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are Software Events.

This scalar object represents the subset of events that are Software Events.

Event table.

Software events.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Refer to the textual convention for more details.

The following type defines the types of events that can be reported by the HPI software implementation. Audit events report a discrepancy in the audit process. Audits are typically performed by HA software to detect problems. Audits may look for such things as corrupted data stores, inconsistent RPT information, or improperly managed queues. Startup events report a failure to start-up properly, or inconsistencies in persisted data. Note: Enumerated values are increased by one value compared to SAI-HPI-B spec. Enumeration: 'hpieOther': 3, 'undefined': 0, 'hpieAudit': 1, 'hpieStartup': 2.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are Oem Events.

This scalar object represents the subset of events that are Oem Events.

Event table.

Oem events.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Refer to the textual convention for more details.

Use this value to determine table activity. It is incremented each time an event is registered in this table. It is also incremented whenever an event is removed or the entire table is cleared. The number of events registered in this table over the lifetime of the table. If the underlying management system is restarted this count is reset. Use this node to determine table activity. This scalar object represents the subset of events that are User Events.

This scalar object represents the subset of events that are User Events.

Event table.

User events.

Refer to textual convention for SaHpiTime for more details. The value is Equal to TIME_UNSPECIFIED if time is not available; Absolute time if greater than TIME_MAX_RELATIVE, Relative time if less than or equal to TIME_MAX_RELATIVE.

Refer to SaHpiTextType for more details.

Refer to saHpiTextLanguage for more details.

Refer to saHpiText for more details.

This columnar object contains the status of the row and also perform add and delete operations. The status column uses four defined values: - `active(1)', which indicates that the conceptual row is available for use by the managed device; - `createAndGo(4)', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device). This function is used to add a User Alarm to this User Event Table and also to the to the Domain Alarm Table; The effect of creating a new row will also be reflected in the DAT - with a new row there. Developers Note: Avoid creating duplicate entries here! 1. a manager would add an event to the User Event Table, 2. the Sub-agent would see this and call saHpiEventLogAdd(), 3. the event would go thru the HPI system and would be added to the HPI event queue, 4. the sub-agent would read the event queue as part of its normal operations, and when it sees this event it would know to ignore it, since it is already in the table (because the manager added it to the table to start this whole process).

Number of resource data records in this system.

A table definining Resource Data Records (RDR) records.

The following describes the different types of records that exist within a Resource Data Repository and the RDR super-structure to all of the specific RDR types (sensor, inventory data, watchdog, etc.).

Id of the Resource Data Repository (RDR) entry.

ID of the next Resource Data Repository (RDR) entry. Use this to aid in walking just the RDRs for a given ResourceId. For example If you know the DomainId and ResourceId use SAHPI_FIRST_ENTRY to retrieve this columnar object. Now you have the saHpiRdrEntryId for the next RDR owned by the Resource in question. When the value of saHpiRdrNextEntryId is SAHPI_LAST_ENTRY it means the index specified represents the last valid RDR represented by the Resource in question.

Type of Resource Data Repository entry. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec. Enumeration: 'undefined': 0, 'ctrlRdr': 2, 'sensorRdr': 3, 'watchdogRdr': 5, 'annunciatorRdr': 6, 'inventoryRdr': 4, 'noRecord': 1.

See Textual-Convention for details.

Entity is a FRU. This field is Only valid if the Entity path given in the 'Entity' field is different from the Entity path in the RPT entry for the resource.

Forward pointer to one of the four types of tables: saHpiCtrlRec saHpiSensorRec saHpiInventoryRec saHpiWatchdogRec

Forward pointer to the Resource Presence Table (RPT) entry.

The resource text definition. See textual definition for more information.

The resource text language type. See textual definition for more information.

ID String of the Resource Data Repository entry.

The number of watchdogs present on this system.

Table of static and dynamic watchdog information including watchdog RDR data. The dynamic data portion is necessary for control and operation of the watchdog timers.

When the 'Watchdog' capability is set in a resource, a watchdog with an identifier of SAHPI_DEFAULT_WATCHDOG_NUM(0), that is defined as 0, is required. All watchdogs shall be represented with an entry in saHpiWatchdogTable, including the initial watchdog with an identifier of SAHPI_DEFAULT_WATCHDOG_NUM(0).

RPT entry for a resource indicates that it supports watchdog timers, then there must be at least one watchdog timer hosted by the resource, with the watchdog number of SAHPI_DEFAULT_WATCHDOG_NUM (0x00000). If additional watchdog timers are hosted by the resource, they may have any watchdog number, and may be located by watchdog records in the RDR repository. Note: The SAHPI_DEFAULT_WATCHDOG_NUM is defined as 0x0000000.

If you read this object, it means: Log - indicates whether or not the Watchdog is configured to issue an event when it next times out. TRUE=event will be issued on timeout. If you set this object, it means: Log - indicates whether or not the Watchdog should issue an event when it next times out. TRUE=event will be issued on timeout. Setting this object will NOT take effect on the Watchdog until the object SaHpiWatchdogRunning is set to true(1).

If you read this object, it means: Running - indicates whether or not the Watchdog is currently running or stopped. TRUE=Watchdog is running. If you set this object, it means: Running - indicates whether or not the Watchdog should be stopped before updating. TRUE = Watchdog is not stopped. If it is already stopped, it will remain stopped, but if it is running, it will continue to run, with the countdown timer reset to the new InitialCount. Note that there is a race condition possible with this setting, so it should be used with care. FALSE = Watchdog is stopped. After this object is called, a subsequent write to saHpiWatchdogTimerReset is required to start the timer.

If you read this object, it means: TimerUse - indicates the current use of the timer; one of five preset uses which was included on the last SET object request, or through some other implementation-dependent means to start the Watchdog timer. If you set this object, it means: TimerUse - indicates the current use of the timer. Will control which saHpiWatchdogTimerUseExpFlags is set if the timer expires Setting this object will NOT take effect on the Watchdog until the object SaHpiWatchdogRunning is set to true(1).

Indicates what action will be taken when the Watchdog times out. Setting this object will NOT take effect on the Watchdog until the object SaHpiWatchdogRunning is set to true(1). Note: Enumerated values are increased by one value compared to SAI-HPI-B spec. Enumeration: 'reset': 2, 'powerDown': 3, 'powerCycle': 4, 'undefined': 0, 'noAction': 1.

PretimerInterrupt - indicates which action will be taken 'PreTimeoutInterval' seconds prior to Watchdog timer expiration. Setting this object will NOT take effect on the Watchdog until the object SaHpiWatchdogRunning is set to true(1).

PreTimeoutInterval indicates how many milliseconds prior to timer time out the PretimerInterrupt action will be taken. If 'PreTimeoutInterval' = 0, the PretimerInterrupt action will occur concurrently with 'TimerAction.' HPI implementations may not be able to support millisecond resolution and may have a maximum value restriction. These restrictions should be documented by the provider of the HPI interface. Setting this object will NOT take effect on the Watchdog until the object SaHpiWatchdogRunning is set to true(1).

Set of values seperated by a delimiter. For each value set, the corresponding Timer Use Expiration Flag will be CLEARED. Generally, a program should only clear the Timer Use Expiration Flag corresponding to its own TimerUse, so that other software, which may have used the timer for another purpose in the past can still read its TimerUseExpFlag to determine whether or not the timer expired during that use. The values are: EXP_BIOS_FRB2 EXP_BIOS_POST EXP_OS_LOAD EXP_SMS_OS EXP_OEM Setting this object will NOT take effect on the Watchdog until the object SaHpiWatchdogRunning is set to true(1).

InitialCount - The time, in milliseconds, before the timer will time out after a SaHpiWatchdogTimerReset() function call is made, or some other implementation-dependent strobe is sent to the Watchdog. HPI implementations may not be able to support millisecond resolution and may have a maximum value restriction. These restrictions should be documented by the provider of the HPI interface. Setting this object will NOT take effect on the Watchdog until the object SaHpiWatchdogRunning is set to true(1).

PresentCount - The remaining time in milliseconds before the timer will time out unless a SaHpiWatchdogTimerReset() function call is made, or some other implementation- dependent strobe is sent to the Watchdog. HPI implementations may not be able to support millisecond resolution on watchdog timers, but will return the number of clock ticks remaining times the number of milliseconds between each tick. Setting this object will NOT take effect on the Watchdog until the object SaHpiWatchdogRunning is set to true(1).

This object provides a method to start or restart the watchdog timer from the initial countdown value. Setting this to true(1) will 'strobe' the counter and reset to the initial countdown value as specified in saHpiWatchdogTimerInitialCount. Setting this object will NOT take effect on the Watchdog until the object SaHpiWatchdogRunning is set to true(1).

Reserved for Oem use

Forward pointer to the Resource Data Repository OID.

The number of annunciators present on this system.

Table of static Annunciator resource data record information and dynamic control data. The columnar object 'saHpiAnnunciatorMode' is in support of SAI-HPI-B.01.01 sections 7.6.6 and 7.6.7 and is representative of the dynamic control data found in this table.

The Annunciator table is used to control the set of annunciators associated with a resource. An Annunciator management instrument holds a set of individual announcements. The function of the Annunciator is to communicate the contents of its current set via whatever platform-specific mechanism is associated with that particular Annunciator management instrument. For example, if announcements are to be communicated via lighting a set of LEDs on a front-panel display, the Annunciator management instrument may analyze its current set of announcements and turn on a single LED reflecting the most severe condition found, or turn on a 'System Ok' LED if there are currently no items in the set. A different Annunciator may continuously scroll each announcement in its set on a text display, as well as turning on LEDs and setting dry-contact relays to reflect the severity of conditions present. A third Annunciator may announce items in its set by sending messages to a proprietary management system, or by sending emails or pages to a system technician. The Annunciator provides a common interface to these varied mechanisms for announcing conditions, so the HPI SNMP Manager is not burdened by platform-to-platform differences. However, the current content of any annunciator management instrument is not defined by the HPI standard in the same way that the contents of the DAT are defined. Thus, the HPI implementation and HPI SNMP Manager's can exert more control over what conditions should be announced. Further, a platform can contain multiple Annunciator management instruments, each reflecting a different physical announcement device in the platform. By exposing each separately, HPI SNMP Manager's and the HPI implementation can control which conditions are handled by each announcement device. An Annunciator management instrument may be implemented using other HPI controls that are in 'auto' mode; for example, digital controls to turn LEDs on and off, stream controls to sound audible alerts, and/or text controls to display detailed information. However, Annunciators may also operate directly to report conditions using mechanisms that are not themselves visible directly in the HPI interface. Over time, announcements are added to and deleted from an Annunciator`s current set of announcements. This may be done automatically by the HPI implementation to reflect platform fault conditions, or by the HPI SNMP Manager via the HPI interface. When announcements are added or deleted automatically by the HPI implementation, it is implementation-specific which announcements are added or removed.

Unique Number identifying each annunciator.

The following enumerated type defines the possible output types which can be associated with an Annunciator Management Instrument. Note: Enumerated values are increased by one value compared to SAI-HPI-B spec. Enumeration: 'led': 1, 'undefined': 0, 'composite': 6, 'dryContactClosure': 2, 'oem': 7, 'message': 5, 'lcdDisplay': 4, 'audible': 3.

if True, Mode may not be changed by HPI SNMP Manager.

Maximum number of conditions that can be held in current set. 0 means no fixed limit.

The Annunciator management instrument has a current mode that indicates whether announcements are added and removed automatically by the HPI implementation, by the HPI SNMP Manager, or both. The mode may be set to one of three values, with the following meanings: auto(1) - the HPI implementation automatically adds and deletes announcements; the HPI SNMP Manager is not permitted to add or delete announcements. user(2) - the HPI SNMP Manager may add and delete announcements; the HPI implementation will not automatically add or delete announcements. shared(3) - the HPI implementation automatically adds and deletes announcements, and the HPI SNMP Manager may also add and delete announcements. The initial mode of each Annunciator is implementation-specific. The HPI User may change the mode of Annunciators with the saHpiAnnunciatorMode object. However, the mode may be configured to be Read-only, in which case the HPI User will not be able to change the mode. When the mode is user(2) or shared(3), HPI SNMP Managers may add or delete any types of announcements in the Annunciator's current set - not just HPI SNMP Manager announcements. This is allowed so that the HPI SNMP Manager can exert complete control over what conditions are being announced, if that is required. Note that this is less restrictive than the similar operations on the DAT. To distinguish between announcements added to an Annunciator automatically and those added by an HPI SNMP Manager, an saHpiAddedByUser field in the announcement indicates the source of the announcement in the set. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec. Enumeration: 'shared': 3, 'auto': 1, 'undefined': 0, 'user': 2.

Maximum number of conditions that can be held in current set. 0 means no fixed limit. if True, Mode may not be changed by HPI SNMP Manager.

Forward pointer to the Resource Data Repository OID.

The number of digital controls in the system.

A table of digital controls and its states.

Definition of the digital control table.

This index element is here to help facilitate browsing of digital controls based on resource id. For example to find the first digital control from the domain 1, for the resource 3, construct the index tuple to be 1.3.0. See textual convention for further details.

The control number

Refer to the textual convention for more details on the enumerations. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

This object describes the default method the control is managed. The control may be managed automatically by the implementation (auto mode). Or it may be managed by the HPI SNMP Manager (manual mode). Some controls allow their modes to be changed, allowing the HPI SNMP Manager to determine if they will manage the control, or relinquish the management to the implementation. But, other controls do not allow the mode to be changed. These static-mode controls are indicated with the saHpiCtrlDigitalReadOnly flag set as part of the default control mode. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

This object describes how the control is managed. The control may be managed automatically by the implementation (auto mode). Or it may be managed by the HPI SNMP Manager (manual mode). Some controls allow their modes to be changed, allowing the HPI SNMP Manager to determine if they will manage the control, or relinquish the management to the implementation. But, other controls do not allow the mode to be changed. These static-mode controls are indicated with the saHpiCtrlDigitalReadOnly flag set as part of the default control mode. When the mode is set to auto(1), the state input is ignored. Ignored state inputs are not checked by the implementation. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

Indicates if mode is read-only

Indicates if Control is write-only

This object represents the default digital control state. Refer to the textual convention for more details on the enumerations.

This object represents the current digital state of the control. Write to this object to change the digital state. You may not change the state of the control unless the Mode is set to manual(2). If a write is attempted when the mode is set to auto(1), SNMP will return an error-status of inconsistentValue. Refer to the textual convention for more details on the enumerations. Note that the SNMP errors that are returned are mapped to the HPI errors that could be returned (errors above the value 6 are SNMPv2 or v3 protocol and are converted to genErr(1) for v1 protocol). SA_ERR_HPI_ERROR genErr(5) SA_ERR_HPI_UNSUPPORTED_API genErr(5) SA_ERR_HPI_BUSY genErr(5) SA_ERR_HPI_INTERNAL_ERROR genErr(5) SA_ERR_HPI_INVALID_CMD genErr(5) SA_ERR_HPI_TIMEOUT genErr(5) SA_ERR_HPI_OUT_OF_SPACE genErr(5) SA_ERR_HPI_OUT_OF_MEMORY genErr(5) SA_ERR_HPI_INVALID_PARAMS genErr(5) SA_ERR_HPI_INVALID_DATA wrongValue(10) SA_ERR_HPI_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_NO_RESPONSE genErr(5) SA_ERR_HPI_DUPLICATE genErr(5) SA_ERR_HPI_INVALID_SESSION genErr(5) SA_ERR_HPI_INVALID_DOMAIN inconsistentName(18) SA_ERR_HPI_INVALID_RESOURCE inconsistentName(18) SA_ERR_HPI_INVALID_REQUEST genErr(5) SA_ERR_HPI_ENTITY_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_READ_ONLY notWritable(9) SA_ERR_HPI_CAPABILITY genErr(5) SA_ERR_HPI_UNKNOWN genErr(5)

Reserved for Oem use

Pointer to Resource Table for this digital control.

The number of discrete controls in the system.

A table of discrete controls and its states.

Definition of the discrete control table.

This index element is here to help facilitate browsing of digital controls based on resource id. For example to find the first digital control from the domain 1, for the resource 3, construct the index tuple to be 1.3.0. See textual convention for further details.

The control number

Refer to the textual convention for more details on the enumerations. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

This object describes the default method the control is managed. The control may be managed automatically by the implementation (auto mode). Or it may be managed by the HPI SNMP Manager (manual mode). Some controls allow their modes to be changed, allowing the HPI SNMP Manager to determine if they will manage the control, or relinquish the management to the implementation. Other controls do not allow the mode to be changed. These static-mode controls are indicated with the saHpiCtrlDiscreteReadOnly flag set as part of the default control mode. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

This object describes how the control is managed. The control may be managed automatically by the implementation (auto mode). Or it may be managed by the HPI SNMP Manager (manual mode). Some controls allow their modes to be changed, allowing the HPI SNMP Manager to determine if they will manage the control, or relinquish the management to the implementation. But, other controls do not allow the mode to be changed. These static-mode controls are indicated with the saHpiCtrlDiscreteReadOnly flag set as part of the default control mode. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

Indicates if mode is read-only

Indicates if Control is write-only

This object represents the default value of the discrete control resource. Refer to the textual convention for more details on the enumerations.

This object represents the current discrete state of the control. Write to this object to change the values of the state. You may not change the state of the control unless the Mode is set to manual(2). If a write is attempted when the mode is set to auto(1), SNMP will return an error-status of inconsistentValue. Note that the SNMP errors that are returned are mapped to the HPI errors that could be returned (errors above the value 6 are SNMPv2 or v3 protocol and are converted to genErr(1) for v1 protocol). SA_ERR_HPI_ERROR genErr(5) SA_ERR_HPI_UNSUPPORTED_API genErr(5) SA_ERR_HPI_BUSY genErr(5) SA_ERR_HPI_INTERNAL_ERROR genErr(5) SA_ERR_HPI_INVALID_CMD genErr(5) SA_ERR_HPI_TIMEOUT genErr(5) SA_ERR_HPI_OUT_OF_SPACE genErr(5) SA_ERR_HPI_OUT_OF_MEMORY genErr(5) SA_ERR_HPI_INVALID_PARAMS genErr(5) SA_ERR_HPI_INVALID_DATA wrongValue(10) SA_ERR_HPI_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_NO_RESPONSE genErr(5) SA_ERR_HPI_DUPLICATE genErr(5) SA_ERR_HPI_INVALID_SESSION genErr(5) SA_ERR_HPI_INVALID_DOMAIN inconsistentName(18) SA_ERR_HPI_INVALID_RESOURCE inconsistentName(18) SA_ERR_HPI_INVALID_REQUEST genErr(5) SA_ERR_HPI_ENTITY_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_READ_ONLY notWritable(9) SA_ERR_HPI_CAPABILITY genErr(5) SA_ERR_HPI_UNKNOWN genErr(5)

Reserved for Oem use

Pointer to Resource Table for this discrete control entry.

The number of analog controls in the system.

A table of analog controls and its states.

Definition of the analog control table.

This index element is here to help facilitate browsing of digital controls based on resource id. For example to find the first digital control from the domain 1, for the resource 3, construct the index tuple to be 1.3.0. See textual convention for further details.

The control number

Refer to the textual convention for more details on the enumerations. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

This object describes the default method control is managed. The control may be managed automatically by the implementation (auto mode). Or it may be managed by the HPI SNMP Manager (manual mode). Some controls allow their modes to be changed, allowing the HPI SNMP Manager to determine if they will manage the control, or relinquish the management to the implementation. But, other controls do not allow the mode to be changed. These static-mode controls are indicated with the saHpiCtrlAnalogReadOnly flag set as part of the default control mode. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

This object describes how the control is managed. The control may be managed automatically by the implementation (auto mode). Or it may be managed by the HPI SNMP Manager (manual mode). Some controls allow their modes to be changed, allowing the HPI SNMP Manager to determine if they will manage the control, or relinquish the management to the implementation. But, other controls do not allow the mode to be changed. These static-mode controls are indicated with the saHpiCtrlAnalogReadOnly flag set as part of the default control mode. When the mode is set to auto(1), the state input is ignored. Ignored state inputs are not checked by the implementation. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

Indicates if mode is read-only

Indicates if Control is write-only

This object represents the default minimum value of this analog control.

This object represents the default maximum value of this analog control.

This object represents the default value of this analog control.

This object represents the current state of the analog control. Write to this object to change the state. You may not change the state of the control unless the Mode is set to manual(2). If a write is attempted when the mode is set to auto(1), SNMP will return an error-status of inconsistentValue. Note that the SNMP errors that are returned are mapped to the HPI errors that could be returned (errors above the value 6 are SNMPv2 or v3 protocol and are converted to genErr(1) for v1 protocol). SA_ERR_HPI_ERROR genErr(5) SA_ERR_HPI_UNSUPPORTED_API genErr(5) SA_ERR_HPI_BUSY genErr(5) SA_ERR_HPI_INTERNAL_ERROR genErr(5) SA_ERR_HPI_INVALID_CMD genErr(5) SA_ERR_HPI_TIMEOUT genErr(5) SA_ERR_HPI_OUT_OF_SPACE genErr(5) SA_ERR_HPI_OUT_OF_MEMORY genErr(5) SA_ERR_HPI_INVALID_PARAMS genErr(5) SA_ERR_HPI_INVALID_DATA wrongValue(10) SA_ERR_HPI_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_NO_RESPONSE genErr(5) SA_ERR_HPI_DUPLICATE genErr(5) SA_ERR_HPI_INVALID_SESSION genErr(5) SA_ERR_HPI_INVALID_DOMAIN inconsistentName(18) SA_ERR_HPI_INVALID_RESOURCE inconsistentName(18) SA_ERR_HPI_INVALID_REQUEST genErr(5) SA_ERR_HPI_ENTITY_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_READ_ONLY notWritable(9) SA_ERR_HPI_CAPABILITY genErr(5) SA_ERR_HPI_UNKNOWN genErr(5)

Reserved for Oem use

Pointer to Resource Table for this analog control.

The number of stream controls in the system.

A table of stream controls and its states.

Definition of the stream control table.

This index element is here to help facilitate browsing of digital controls based on resource id. For example to find the first digital control from the domain 1, for the resource 3, construct the index tuple to be 1.3.0. See textual convention for further details.

The control number

Refer to the textual convention for more details on the enumerations. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

This object describes the default method the control is managed. The control may be managed automatically by the implementation (auto mode). Or it may be managed by the HPI SNMP Manager (manual mode). Some controls allow their modes to be changed, allowing the HPI SNMP Manager to determine if they will manage the control, or relinquish the management to the implementation. But, other controls do not allow the mode to be changed. These static-mode controls are indicated with the saHpiCtrlReadOnly flag set as part of the default control mode. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

This object describes how the control is managed. The control may be managed automatically by the implementation (auto mode). Or it may be managed by the HPI SNMP Manager (manual mode). Some controls allow their modes to be changed, allowing the HPI SNMP Manager to determine if they will manage the control, or relinquish the management to the implementation. But, other controls do not allow the mode to be changed. These static-mode controls are indicated with the saHpiCtrlReadOnly flag set as part of the default control mode. When the mode is set to auto(1), the state input is ignored. Ignored state inputs are not checked by the implementation. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

Indicates if mode is read-only

Indicates if Control is write-only

This object represents the default repeat flag of stream control.

This object represents the default value of the stream control.

This object represents the current repeat flag of the stream control. Write to this object to change the repeat value of the stream data. You may not change the state of the control unless the Mode is set to manual(2). If a write is attempted when the mode is set to auto(1), SNMP will return an error-status of inconsistentValue. Note that the SNMP errors that are returned are mapped to the HPI errors that could be returned (errors above the value 6 are SNMPv2 or v3 protocol and are converted to genErr(1) for v1 protocol). SA_ERR_HPI_ERROR genErr(5) SA_ERR_HPI_UNSUPPORTED_API genErr(5) SA_ERR_HPI_BUSY genErr(5) SA_ERR_HPI_INTERNAL_ERROR genErr(5) SA_ERR_HPI_INVALID_CMD genErr(5) SA_ERR_HPI_TIMEOUT genErr(5) SA_ERR_HPI_OUT_OF_SPACE genErr(5) SA_ERR_HPI_OUT_OF_MEMORY genErr(5) SA_ERR_HPI_INVALID_PARAMS genErr(5) SA_ERR_HPI_INVALID_DATA wrongValue(10) SA_ERR_HPI_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_NO_RESPONSE genErr(5) SA_ERR_HPI_DUPLICATE genErr(5) SA_ERR_HPI_INVALID_SESSION * genErr(5) SA_ERR_HPI_INVALID_DOMAIN inconsistentName(18) SA_ERR_HPI_INVALID_RESOURCE inconsistentName(18) SA_ERR_HPI_INVALID_REQUEST genErr(5) SA_ERR_HPI_ENTITY_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_READ_ONLY notWritable(9) SA_ERR_HPI_CAPABILITY genErr(5) SA_ERR_HPI_UNKNOWN genErr(5)

This object represents the current state of the stream control. Write to this object to change the state of the stream control. You may not change the state of the control unless the Mode is set to manual(2). If a write is attempted when the mode is set to auto(1), SNMP will return an error-status of inconsistentValue. Note that the SNMP errors that are returned are mapped to the HPI errors that could be returned (errors above the value 6 are SNMPv2 or v3 protocol and are converted to genErr(1) for v1 protocol). SA_ERR_HPI_ERROR genErr(5) SA_ERR_HPI_UNSUPPORTED_API genErr(5) SA_ERR_HPI_BUSY genErr(5) SA_ERR_HPI_INTERNAL_ERROR genErr(5) SA_ERR_HPI_INVALID_CMD genErr(5) SA_ERR_HPI_TIMEOUT genErr(5) SA_ERR_HPI_OUT_OF_SPACE genErr(5) SA_ERR_HPI_OUT_OF_MEMORY genErr(5) SA_ERR_HPI_INVALID_PARAMS genErr(5) SA_ERR_HPI_INVALID_DATA wrongValue(10) SA_ERR_HPI_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_NO_RESPONSE genErr(5) SA_ERR_HPI_DUPLICATE genErr(5) SA_ERR_HPI_INVALID_SESSION genErr(5) SA_ERR_HPI_INVALID_DOMAIN inconsistentName(18) SA_ERR_HPI_INVALID_RESOURCE inconsistentName(18) SA_ERR_HPI_INVALID_REQUEST genErr(5) SA_ERR_HPI_ENTITY_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_READ_ONLY notWritable(9) SA_ERR_HPI_CAPABILITY genErr(5) SA_ERR_HPI_UNKNOWN genErr(5)

Reserved for Oem use

Pointer to Resource Table for this stream control.

The number of text controls in the system.

A table of text controls and its states.

Definition of the text control table.

This index element is here to help facilitate browsing of digital controls based on resource id. For example to find the first digital control from the domain 1, for the resource 3, construct the index tuple to be 1.3.0. See textual convention for further details.

The control number

Refer to the textual convention for more details on the enumerations. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

This object describes the default method the control is managed. The control may be managed automatically by the implementation (auto mode). Or it may be managed by the HPI User (manual mode). Some controls allow their modes to be changed, allowing the HPI User to determine if they will manage the control, or relinquish the management to the implementation. But, other controls do not allow the mode to be changed. These static-mode controls are indicated with the saHpiCtrlReadOnly flag set as part of the default control mode. When the mode is set to auto(1), the state input is ignored. Ignored state inputs are not checked by the implementation. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

This object describes how the control is managed. The control may be managed automatically by the implementation (auto mode). Or it may be managed by the HPI User (manual mode). Some controls allow their modes to be changed, allowing the HPI User to determine if they will manage the control, or relinquish the management to the implementation. But, other controls do not allow the mode to be changed. These static-mode controls are indicated with the saHpiCtrlReadOnly flag set as part of the default control mode. When the mode is set to auto(1), the state input is ignored. Ignored state inputs are not checked by the implementation. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

Indicates if mode is read-only

Indicates if Control is write-only

This object represents the maximum characters per line for this text control. Note: If the saHpiCtrlTextType is unicode(1), there will be two bytes required for each character. This field reports the number of characters per line- not the number of bytes. saHpiCtrlTextMaxChars must not be larger than the number of characters that can be placed in a saHpiTextState columnar object.

This object represents the maximum number of lines of the text control.

This object represents the default text language setting of the control text.

This represents the current text setting of the control.

This object represents the default line number of text represented in saHpiCtrlTextDefault object. If the line is 255, then saHpiCtrlTextDefault columnar object will containt the entire text of the control, or as much of it as will fit in a single columnar object. This value will consist of the text of all the lines concatenated, using the maximum number of characters for each line (no trimming of trailing blanks). Note that depending on the data type and language, the text may be encoded in 2-byte Unicode, which requires two bytes of data per character. Note that the number of lines and columns in a text control can be obtained from the saHpiCtrlTextMaxLines and saHpiCtrlTextMaxChars.

The default text of a control text resource. Refer to saHpiCtrlTextDefaultLine for the line number, saHpiCtrlTextLanguage for the language setting and saHpiCtrlTextType for the text type.

The current line number of text. Refer to saHpiCtrlTextState for usage examples. If the line number passed in is 255, then saHpiCtrlTextState columnar object will containt the entire text of the control, or as much of it as will fit in a single columnar object. This value will consist of the text of all the lines concatenated, using the maximum number of characters for each line (no trimming of trailing blanks). Note that depending on the data type and language, the text may be encoded in 2-byte Unicode, which requires two bytes of data per character. Note that the number of lines and columns in a text control can be obtained from the saHpiCtrlTextMaxLines and saHpiCtrlTextMaxChars. Note that the SNMP errors that are returned are mapped to the HPI errors that could be returned (errors above the value 6 are SNMPv2 or v3 protocol and are converted to genErr(1) for v1 protocol). SA_ERR_HPI_ERROR genErr(5) SA_ERR_HPI_UNSUPPORTED_API genErr(5) SA_ERR_HPI_BUSY genErr(5) SA_ERR_HPI_INTERNAL_ERROR genErr(5) SA_ERR_HPI_INVALID_CMD genErr(5) SA_ERR_HPI_TIMEOUT genErr(5) SA_ERR_HPI_OUT_OF_SPACE genErr(5) SA_ERR_HPI_OUT_OF_MEMORY genErr(5) SA_ERR_HPI_INVALID_PARAMS genErr(5) SA_ERR_HPI_INVALID_DATA wrongValue(10) SA_ERR_HPI_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_NO_RESPONSE genErr(5) SA_ERR_HPI_DUPLICATE genErr(5) SA_ERR_HPI_INVALID_SESSION genErr(5) SA_ERR_HPI_INVALID_DOMAIN inconsistentName(18) SA_ERR_HPI_INVALID_RESOURCE inconsistentName(18) SA_ERR_HPI_INVALID_REQUEST genErr(5) SA_ERR_HPI_ENTITY_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_READ_ONLY notWritable(9) SA_ERR_HPI_CAPABILITY genErr(5) SA_ERR_HPI_UNKNOWN genErr(5)

This columnar object can be used to write to the text controls. To do so, first set the line number in saHpiCtrlTextLine and then write to this object. The first line of the text control is line number 1 . If less than a full line of data is written, the control will clear all spaces beyond those written on the line. Thus writing a zero-length string will clear the addressed line. It is also possible to include more characters in the text passed in this columnar object than will fit on one line; in this case, the control will wrap to the next line (still clearing the trailing characters on the last line written). Thus, there are two ways to write multiple lines to a text control: (a) set saHpiCtrlTextState repeatedly for each line, or (b) set saHpiCtrlTextState once and send more characters than will fit on one line. An HPI SNMP Manager should not assume any cursor positioning characters are available to use, but rather should always write full lines and allow wrapping to occur. When calling this object, an HPI SNMP Manager may set the line number to 255; in this case, the entire control will be cleared, and the data will be written starting on line 1. (This is different from simply writing at line 1, which only alters the lines written to.) This feature may be used to clear the entire control, which can be accomplished by setting: saHpiCtrlTextLine = 255; saHpiCtrlState = ''; Note that the number of lines and columns in a text control can be obtained from the saHpiCtrlTextMaxLines and saHpiCtrlTextMaxChars. Note that the saHpiCtrlTextLanguage object has the language setting and saHpiCtrlTextType object has the text type. Note that the SNMP errors that are returned are mapped to the HPI errors that could be returned (errors above the value 6 are SNMPv2 or v3 protocol and are converted to genErr(1) for v1 protocol). SA_ERR_HPI_ERROR genErr(5) SA_ERR_HPI_UNSUPPORTED_API genErr(5) SA_ERR_HPI_BUSY genErr(5) SA_ERR_HPI_INTERNAL_ERROR genErr(5) SA_ERR_HPI_INVALID_CMD genErr(5) SA_ERR_HPI_TIMEOUT genErr(5) SA_ERR_HPI_OUT_OF_SPACE genErr(5) SA_ERR_HPI_OUT_OF_MEMORY genErr(5) SA_ERR_HPI_INVALID_PARAMS genErr(5) SA_ERR_HPI_INVALID_DATA wrongValue(10) SA_ERR_HPI_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_NO_RESPONSE genErr(5) SA_ERR_HPI_DUPLICATE genErr(5) SA_ERR_HPI_INVALID_SESSION genErr(5) SA_ERR_HPI_INVALID_DOMAIN inconsistentName(18) SA_ERR_HPI_INVALID_RESOURCE inconsistentName(18) SA_ERR_HPI_INVALID_REQUEST genErr(5) SA_ERR_HPI_ENTITY_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_READ_ONLY notWritable(9) SA_ERR_HPI_CAPABILITY genErr(5) SA_ERR_HPI_UNKNOWN genErr(5)

Reserved for Oem use

Pointer to Resource Table for this text control.

The number of Oem controls in the system.

A table of Oem controls and its states.

Definition of the Oem control table.

This index element is here to help facilitate browsing of digital controls based on resource id. For example to find the first digital control from the domain 1, for the resource 3, construct the index tuple to be 1.3.0. See textual convention for further details.

The control number

Refer to the textual convention for more details on the enumerations. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

This object describes the default method the control is managed. The control may be managed automatically by the implementation (auto mode). Or it may be managed by the HPI User (manual mode). Some controls allow their modes to be changed, allowing the HPI User to determine if they will manage the control, or relinquish the management to the implementation. But, other controls do not allow the mode to be changed. These static-mode controls are indicated with the saHpiCtrlReadOnly flag set as part of the default control mode. When the mode is set to auto(1), the state input is ignored. Ignored state inputs are not checked by the implementation. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

This object describes how the control is managed. The control may be managed automatically by the implementation (auto mode). Or it may be managed by the HPI User (manual mode). Some controls allow their modes to be changed, allowing the HPI User to determine if they will manage the control, or relinquish the management to the implementation. But, other controls do not allow the mode to be changed. These static-mode controls are indicated with the saHpiCtrlReadOnly flag set as part of the default control mode. When the mode is set to auto(1), the state input is ignored. Ignored state inputs are not checked by the implementation. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec.

Indicates if mode is read-only

Indicates if Control is write-only

This object represents the Oem's manufacturer ID for this Oem control. Refer to the textual convention for more details.

This object represents the Oem control configuration data.

This object represents the Oem's manufacturer ID for this Oem control resource. Refer to the textual convention for more details.

This represents the Oem control state setting.

This object allows to write to the Oem control state setting. You may not change the state of the control unless the Mode is set to manual(2). If a write is attempted when the mode is set to auto(1), SNMP will return an error-status of inconsistentValue. Note that the SNMP errors that are returned are mapped to the HPI errors that could be returned (errors above the value 6 are SNMPv2 or v3 protocol and are converted to genErr(1) for v1 protocol). SA_ERR_HPI_ERROR genErr(5) SA_ERR_HPI_UNSUPPORTED_API genErr(5) SA_ERR_HPI_BUSY genErr(5) SA_ERR_HPI_INTERNAL_ERROR genErr(5) SA_ERR_HPI_INVALID_CMD genErr(5) SA_ERR_HPI_TIMEOUT genErr(5) SA_ERR_HPI_OUT_OF_SPACE genErr(5) SA_ERR_HPI_OUT_OF_MEMORY genErr(5) SA_ERR_HPI_INVALID_PARAMS genErr(5) SA_ERR_HPI_INVALID_DATA wrongValue(10) SA_ERR_HPI_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_NO_RESPONSE genErr(5) SA_ERR_HPI_DUPLICATE genErr(5) SA_ERR_HPI_INVALID_SESSION genErr(5) SA_ERR_HPI_INVALID_DOMAIN inconsistentName(18) SA_ERR_HPI_INVALID_RESOURCE inconsistentName(18) SA_ERR_HPI_INVALID_REQUEST genErr(5) SA_ERR_HPI_ENTITY_NOT_PRESENT inconsistentName(18) SA_ERR_HPI_READ_ONLY notWritable(9) SA_ERR_HPI_CAPABILITY genErr(5) SA_ERR_HPI_UNKNOWN genErr(5)

Reserved for Oem use

Pointer to Resource Table for this Oem control.

The number of inventory resource data records managed by the underlying management system.

Table defining static data associated with Inventory Repository Data Repository.

These structures are used to read and write inventory data to Inventory entity Data Repository (IDR). Each table row represents an IDR. All inventory data contained in an inventory data repository (IDR) must be represented in the RDR repository as an RDR record.

See TEXTUAL-CONVENTION 'SaHpiInstrumentId'

True indicates that updates to IDR are automatically and immediately persistent. False indicates that updates are not immediately persistent; but optionally may be persisted via saHpiParmControl function, as defined in implementation documentation.

Oem value for the inventory record. This is manufacturer' specific value.

The count is incremented any time the IDR is changed.

Describes if the IDR is read-only. If 'IsReadOnly is 'TRUE' then all 'areas' and 'fields' associated with Inventory Data Repository are also flagged as 'Read Only' in thier repsective columnar objects tracking this capability. An IDR with read-only elements does not allow additions, deletetions, or modifications of its elements.

Number of Area(s) contained in IDR

Pointer to resource data record for this particular inventory resource data record

The number of inventory data records present on this system.

Table defining inventory data respository data area records.

These structures are used to read and write inventory data respository data area records. The four-tuple index value consits of: - saHpiDomainId, which is the domain of the resource - saHpiResourceId, the id value for the resource - saHpiIdrId, the id value of entity inventory - saHpiAreaId, the id value of inventory data area. SAI-HPI-B.01.01, section 7.4.

This is the HPI management user specified AreaId value. It is this value that is used in row 'createAndWait' function, which is synonomous with adding a new IDR 'Area.' See saHpiAreaRowStatus. See TEXTUAL-CONVENTION 'SaHpiInstrumentId.'

This columnar object is the value generated and utilized by the underlying system management implementation. This is the SAI-HPI-b.01.01 AreaId. See TEXTUAL-CONVENTION 'SaHpiInstrumentId'

The type of Area. New Area's are Created when 'saHpiIdrAreaType' is written with the appropriate index values's. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 spec. Enumeration: 'undefined': 0, 'unspecified': 256, 'productInfo': 180, 'internalUse': 177, 'oem': 193, 'chassisInfo': 178, 'boardInfo': 179.

This columnar object is informational only. Describes if an area is read-only. If it is set to 'FASLE' then a user can 'delete' this 'area' and add new 'fields.' If the 'IsReadOnly' is 'TRUE' then 'area' cannot be deleted nor have 'fields' added. Additionally, if an 'IsReadOnly' may be FALSE and a delete still may not be possibly if one or more of the 'area's' fields are flagged as read-only. If 'IsReadOnly' is 'FASLE' then all area 'fields' are flagged as 'read-only' as well.

This columnar object contains the status of the row and also perform add and delete operations. The status column uses three defined values: - `active(1)', which indicates that the conceptual row is available for use by the managed device; - `notInService(2)', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device. - `createAndWait(5)', which is supplied by a management station wishing to create a new instance of a conceptual row (but not make it available for use by the managed device). This function is used to add an Area to the specified Inventory Data Repository. The row is created (and changes state to 'active' when the saHpiAreaType has been correctly set) to a new instance of the conceptual row. The dis-allowed saHpiAreaType value is undefined(0) and unspecified(256). It is the responsibility of the caller to specify an AreadId that has not been previously assigned. The user specifies AreaId may or maynot be the same value as the under lying HPI system management service. The HPI assigned ID will be reflected in the columnar object 'saHpiAreaIdIndex'. - `destroy(6)', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. This function allows the HPI MIB User to delete an Inventory Data Area, including the Area header and all fields contained with the area, from a particular Inventory Data Repository. In some implementations, certain Areas are intrinsically read-only. The saHpiAreaIsReadOnly flag, indicates if the Area is read-only. If the Inventory Data Area is not read-only, but contains a Field that is read-only, the Area cannot be deleted. An attempt to delete an Area that contains a read-only Field will return an error.

Number of Fields contained in Area

The number of inventory data repository field records.

Table defining inventory data repository field records.

These structures are used to read and write inventory data repository field records.

See TEXTUAL-CONVENTION 'SaHpiInstrumentId'. SubAgent created and maintained Index value. Do not confuse this with saHpiFieldIdIndex that is created and maintained by the underlying HPI library. See next column.

See TEXTUAL-CONVENTION 'SaHpiInstrumentId', Used to store the HPI generated AreaId, very important.

Inventory Data Field type definitions. Note: Enumerated values are increased by one value compared to SAI-HPI-B spec. Enumeration: 'mfgDatetime': 2, 'custom': 10, 'undefined': 0, 'assetTag': 9, 'serialNumber': 6, 'unspecified': 256, 'productName': 4, 'productVersion': 5, 'chassisType': 1, 'partNumber': 7, 'fileId': 8, 'manufacturer': 3.

Describes if an field is read-only. All field headers in a read-only IDR are flagged as read-only as well.

Field Data. See Definition for SaHpiTextType for more details.

Field Data. See Definition for SaHpiTextLanguage for more details.

Field Data. The type of date is specified by saHpiResourceTagTextType and saHpiResourceTagLanguage.

This object provides a method to create and delete a Data Inventory Field. Supported states are: active(1), notInService(2), createAndWait(5), destroy(6) The status column has four defined values: - `active(1)', which indicates that the conceptual row is available for use by the managed device. For it to be in such state, the columnar objects: saHpiFieldType, saHpiFieldTextType, saHpiTextLanguage, and saHpiFieldText must have valid values. - `notInService(2)', which indicates that the conceptual row exists in the agent, but is unavailable for use by the managed device (see NOTE below); 'notInService' has no implication regarding the internal consistency of the row, availability of resources, or consistency with the current state of the managed device. - `createAndWait(5)', which is supplied by a management station wishing to create a new instance of a conceptual row. After setting this value, the management station is responsible of providing valid values to the columnar objects: saHpiFieldIsReadOnly, saHpiFieldType, saHpiFieldTextType, saHpiTextLanguage and saHpiFieldText. - `destroy(6)', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row.

The number of sensor resource data records in the system.

A table defining the static Sensor data found in the Sensor Resource Data Repository.

This is the sensor resource data record which describes all of the static data associated with a sensor.

The sensor number.

Refer to the textual convention for more details.

Sensors category. Sensor events contain an event category and event state. Depending on the event category, the event states take on different meanings for events generated by specific sensors. The generic(128) category can be used for discrete sensors which have state meanings other than those identified with other event categories.

True if HPI SNMP Manager can enable or disable sensor via saHpiSensorEnableSet.

This columnar object represents the sensor category control of events. The possible states are: perEvent - Event message control per event, or by entire sensor; sensor event enable status can be changed, and assert/deassert masks can be changed readOnlyMasks - Control for entire sensor only; sensor event enable status can be changed, but assert/deassert masks cannot be changed readOnly - Event control not supported; sensor event enable status cannot be changed and assert/deassert masks cannot be changed. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 section 8.5. Enumeration: 'readOnlyMasks': 2, 'readOnly': 3, 'undefined': 0, 'perEvent': 1.

Set of event states supported. For format and possible types, refer to SaHpiEventState.

Indicates if sensor data readings are supported.

Type of value for sensor reading.

This columnar object provides the sensor data base units, (meters, etc.)

This columnar object provides the sensor data modifier unit(s). Example unit = second, etc. Also see modifier use columnar object saHpiSensorModifierUse for further insight.

Modifier Unit Use (m/sec, etc.). This type defines how the modifier unit is used. For example: base unit == meter, modifier unit == seconds, and modifier unit use == basicOverModifier(1). The resulting unit would be meters per second. Note: Enumerated values are increased by one value compared to SAI-HPI-B.01.01 section 8.5. Enumeration: 'none': 1, 'undefined': 0, 'basicOverModifier': 2, 'basicTimesModifier': 3.

Is the value a percentage.

Defines which range flags the sensor supports. The string tokens are MIN, MAX, NOMINAL, NORMAL_MAX, NORMAL_MIN, or nothing (NULL) if the sensor does not support any ranges. If more than one range is supported then the strings tokens are comma (',') or semicolon (';') delimited

The Accuracy Factor is expressed as a floating point percentage (e.g. 0.05 = 5%) and represents statistically how close the measured reading is to the actual value. It is an interpreted value that figures in all sensor accuracies, resolutions, and tolerances.

Reserved for Oem use.

Forward pointer to the Resource Data Repository OID.

A table definining current sensor readings and settings of a sensor.

This is the sensor dynamic data associated with sensors readings and event states.

reading(1) - This table contains only the sensor reading values. Refer to saHpiCurrentSensorStateType and saHpiCurrentSensorStateValue. SAI-HPI-b.01.01 IsSupported is set when a sensor reading/threshold value is available. eventState(2) - The sensor does not support reading values, instead events are available. Refer to saHpiCurrentSensorStateEventState. readingAndEventState(3) - The sensor supports both reading current values and events. Refer to saHpiCurrentSensorStateType, saHpiCurrentSensorStateValue, saHpiCurrentSensorStateEventState. noData(4) - The sensor does not support reading current values nor events. See SAI-HPI-B.01.01 SaHpiSensorReadingT, this columnar node is analogous to field 'IsSupported' in SaHpiSensorReadingT. 'IsSupported' is set when a sensor reading/threshold value is available. Otherwise, if no reading or threshold is supported, this flag is set to False. Enumeration: 'noData': 4, 'reading': 1, 'readingAndEventState': 3, 'undefined': 0, 'eventState': 2.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

When reading, this object returns the current sensor enable status for an addressed sensor. When writing this object sets the sensor enable status for an addressed sensor. If a sensor is disabled, the rows in saHpiCurrentSensorState for that sensor will not be present, and no events will be generated for the sensor.

When reading, this object returns the current sensor event enable status for an addressed sensor. When writing this object sets the sensor event enable status for an addressed sensor. If event generation for a sensor is disabled, no events will be generated as a result of the assertion or deassertion of any event state, regardless of the setting of the assert or deassert event masks for the sensor. If event generation for a sensor is enabled, events will be generated when event states are asserted or deasserted, according to the settings of the assert and deassert event masks for the sensor. Event states may still be read for a sensor even if event generation is disabled, by reading the saHpiCurrentSensorState table.

A string values separated by a delimiter (see SaHpiEventState for more details) is returned by this object. A string value, seperated by a delimiter in the saHpiSesnorAssertEventMask indicates that an event will be generated by the sensor when the corresponding event state for that sensor changes from deasserted to asserted. Events will only be generated by the sensor if the appropriate saHpiSensorAssertEventMask or saHpiSensorDeassertEventMask events is set, sensor events are enabled, and the sensor is enabled. Remarks For sensors hosted by a resource that has the evtDeAsserts(14) flag set in its Resource Table , the assert and deassert event masks cannot be independently configured. Only this object can be set, and the saHpiSensorAssertEventMask values are used to determine which values to set or clear in both the assert event mask and deassert event mask for the sensor. If the sensor assert event masks change as a result of writing to this object , an event will be generated.

A string values seperated by a delimiter (see SaHpiEventState for more details) is returned by this object. A string value, separated by a delimiter in the saHpiSesnorAssertEventMask indicates that an event will be generated by the sensor when the corresponding event state for that sensor changes from deasserted to asserted. Events will only be generated by the sensor if the appropriate saHpiSensorAssertEventMask or saHpiSensorDeassertEventMask events is set, sensor events are enabled, and the sensor is enabled. Remarks For sensors hosted by a resource that has the evtDeAsserts(14) flag set in its Resource Table , the assert and deassert event masks cannot be independently configured. Only this object can be set, and the saHpiSensorAssertEventMask values are used to determine which values to set or clear in both the assert event mask and deassert event mask for the sensor. If the sensor assert event masks change as a result of writing to this object , an event will be generated.

A string values seperated by a delimiter (see SaHpiEventState for more details) is returned by this object. A string value, seperated by a delimiter in the saHpiSensorDeassertEventMask indicates that an event will be generated by the sensor when the corresponding event state for that sensor changes from asserted to deasserted. Events will only be generated by the sensor if the appropriate saHpiSensorAssertEventMask or saHpiSensorDeassertEventMask events is set, sensor events are enabled, and the sensor is enabled. Remarks For sensors hosted by a resource that has the evtDeAsserts(14) flag set in its Repository Table , the assert and deassert event masks cannot be independently configured. Only saHpiSensorAssertEventMask object can set, and the saHpiAssertEventMask values are used to determine which values to set or clear in both the assert event mask and deassert event mask for the sensor. If the sensor deassert event masks change as a result of writing to this object , an event will be generated.

A string values seperated by a delimiter (see SaHpiEventState for more details) is returned by this object. A string value, seperated by a delimiter in the saHpiSensorDeassertEventMask indicates that an event will be generated by the sensor when the corresponding event state for that sensor changes from asserted to deasserted. Events will only be generated by the sensor if the appropriate saHpiSensorAssertEventMask or saHpiSensorDeassertEventMask events is set, sensor events are enabled, and the sensor is enabled. Remarks For sensors hosted by a resource that has the evtDeAsserts(14) flag set in its Repository Table , the assert and deassert event masks cannot be independently configured. Only saHpiSensorAssertEventMask object can set, and the saHpiAssertEventMask values are used to determine which values to set or clear in both the assert event mask and deassert event mask for the sensor. If the sensor deassert event masks change as a result of writing to this object , an event will be generated.

A table definining maximum sensor readings as defined in the sensor Resource Data Repository

This table contains the fields used to define the sensor SAHPI_SRF_MAX values. It is representative of the static data found in the SAI-HPI-B.01.01 sensor RDR records.

IsSupported is set when a sensor reading/threshold value is available. Otherwise, if no reading or threshold is supported, this flag is set to False.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

A table definining minimum sensor readings as defined in the sensor Resource Data Repository.

This table contains the fields used to define the sensor SAHPI_SRF_MIN values. It is representative of the static data found in the SAI-HPI-B.01.01 sensor RDR records.

IsSupported is set when a sensor reading/threshold value is available. Otherwise, if no reading or threshold is supported, this flag is set to False.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

A table definining nominal sensor readings.

This table contains the fields used to define the sensor SAHPI_SRF_NOMINAL values. It is representative of the static data found in the SAI-HPI-B.01.01 sensor RDR records.

IsSupported is set when a sensor reading/threshold value is available. Otherwise, if no reading or threshold is supported, this flag is set to False.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

A table definining normal maximum sensor readings.

This table contains the fields used to define the sensor SAHPI_SRF_NORMAL_MAX values. It is representative of the static data found in the SAI-HPI-B.01.01 sensor RDR records.

IsSupported is set when a sensor reading/threshold value is available. Otherwise, if no reading or threshold is supported, this flag is set to False.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

A table definining normal minimum sensor readings.

This table contains the fields used to define the sensor SAHPI_SRF_NORMAL_MIN values. It is representative of the static data found in the SAI-HPI-B.01.01 sensor RDR records.

IsSupported is set when a sensor reading/threshold value is available. Otherwise, if no reading or threshold is supported, this flag is set to False.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

A table definining the lower critical threshold value. If SAI-HPI-B.01.01 SaHpiSensorThdDefnT field IsAccessible == FALSE then no threshold record is created. Also see saHpiCurrentSensorStateDataPresent for dependencies.

This is the sensor threshold data for lower critical thresholds.

Defines if sensor threshold information can be read.

Defines if sensor threshold information can be written.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

This columnar object flag is set, hysteresis values are calculated at the nominal sensor value.

A table definining the lower major threshold value. If SAI-HPI-B.01.01 SaHpiSensorThdDefnT field IsAccessible == FALSE then no threshold record is created. Also see saHpiCurrentSensorStateDataPresent for dependencies.

This is the sensor threshold data for lower major thresholds.

Defines if sensor threshold information can be read.

Defines if sensor threshold information can be written. If set to 'false(2)' writting to saHpiSensorThdLowMajorRaw and saHpiSensorThdLowMajorInterpreted will not change the threshold values.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

This columnar object flag is set, hysteresis values are calculated at the nominal sensor value.

A table definining the lower minor threshold value. If SAI-HPI-B.01.01 SaHpiSensorThdDefnT field IsAccessible == FALSE then no threshold record is created. Also see saHpiCurrentSensorStateDataPresent for dependencies.

Sensor threshold data for lower minor thresholds.

Defines if sensor threshold information can be read.

Defines if sensor threshold information can be written.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

This columnar object flag is set, hysteresis values are calculated at the nominal sensor value.

A table definining the upper critical threshold value. If SAI-HPI-B.01.01 SaHpiSensorThdDefnT field IsAccessible == FALSE then no threshold record is created. Also see saHpiCurrentSensorStateDataPresent for dependencies.

Sensor threshold data for upper critical thresholds.

Defines if sensor threshold information can be read.

Defines if sensor threshold information can be written.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

This columnar object flag is set, hysteresis values are calculated at the nominal sensor value.

A table definining the upper major threshold value. If SAI-HPI-B.01.01 SaHpiSensorThdDefnT field IsAccessible == FALSE then no threshold record is created. Also see saHpiCurrentSensorStateDataPresent for dependencies.

Sensor threshold data for upper major thresholds.

Defines if sensor threshold information can be read

Defines if sensor threshold information can be written.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

This columnar object flag is set, hysteresis values are calculated at the nominal sensor value.

A table definining the upper minor threshold value. If SAI-HPI-B.01.01 SaHpiSensorThdDefnT field IsAccessible == FALSE then no threshold record is created. Also see saHpiCurrentSensorStateDataPresent for dependencies.

Sensor threshold data for upper minor thresholds.

Defines if sensor threshold information can be read.

Defines if sensor threshold information can be written.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

This columnar object flag is set, hysteresis values are calculated at the nominal sensor value.

A table definining the positive going hysteresis upper bound.

This is the sensor hysteresis data which defines hysteresis values at the positive upper bound.

Defines if sensor hysteresis information can be read.

Defines if sensor hysteresis information can be written.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

This columnar object flag is set, hysteresis values are calculated at the nominal sensor value.

A table definining the negative going hysteresis lower bound.

This is the sensor hysteresis data which defines hysteresis values at the negative lower bound for a given sensor.

Defines if sensor hysteresis information can be read.

Defines if sensor hysteresis information can be written.

See Definition in TEXTUAL-CONVENTION.

See Definition in TEXTUAL-CONVENTION.

This columnar object flag is set, hysteresis values are calculated at the nominal sensor value.

Sensor event notification.

Sensor enable change event notification.

Resource failure/restoration event notifications.

Domain events are used to announce the addition of domain references and the removal of domain references to the DRT.

Watchdog notification.

Hot swap notification.

Audit events report a discrepancy in the audit process. Audits are typically performed by HA software to detect problems. Audits may look for such things as corrupted data stores, inconsistent RPT information, or improperly managed queues. Startup events report a failure to start-up properly, or inconsistencies in persisted data.

Oem event notifications.

User events may be used for storing custom events created by an HPI User when injecting events into the Event Log using saHpiEventLogEntryAdd().

saHpiDomainInfo table.

saHpiDomainReference table.

saHpiDomainAlarm table.

saHpiResource table.

saHpiAutoInsertTimeout table.

saHpiHotSwap table.

saHpiEvent table.

saHpiResourceEvent table.

saHpiDomainEvent table.

saHpiSensorEvent table.

saHpiSensorEnableChangeEvent table.

saHpiHotSwapEvent table.

saHpiWatchdogEvent table.

saHpiSoftwareEvent table.

saHpiOemEvent table.

saHpiUserEvent table.

saHpiAnnouncement table.

saHpiEventLogInfo table.

saHpiEventLog table.

saHpiResourceEventLog table.

saHpiDomainEventLog table.

saHpiSensorEventLog table.

saHpiSensorEnableChangeEventLog table.

saHpiHotSwapEventLog table.

saHpiWatchdogEventLog table.

saHpiSoftwareEventLog table.

saHpiOemEventLog table.

saHpiUserEventLog table.

saHpiRdr table.

saHpiCtrlDigital table.

saHpiCtrlDiscrete table.

saHpiCtrlAnalog table.

saHpiCtrlStream table.

saHpiCtrlText table.

saHpiCtrlOem table.

saHpiSensor table.

saHpiCurrentSensorState table.

saHpiSensorReadingMax table.

saHpiSensorReadingMin table.

saHpiSensorReadingNominal table.

saHpiSensorReadingNormalMax table.

saHpiSensorReadingNormalMin table.

saHpiSensorThdLowCritical table.

saHpiSensorThdLowMajor table.

saHpiSensorThdLowMinor table.

saHpiSensorThdUpCritical table.

saHpiSensorThdUpMajor table.

saHpiSensorThdUpMinor table.

saHpiSensorThdPosHysteresis table.

saHpiSensorThdNegHysteresis table.

saHpiInventory table.

saHpiArea table.

saHpiField table.

saHpiWatchdog table.

saHpiAnnunciator table.

Notification group.

Administration group.

The compliance statement for SNMP hardware platform entities.