SCTE-HMS-HE-COMMON-MIB

All MIBs › SCTE-HMS-HE-COMMON-MIB

Organization: SCTE HMS Working Group

Last Updated: 2003-02-17

Category: SCTE HMS Cable Headend

Description: Defines SCTE HMS headend common management objects shared across cable headend equipment.

Start monitoring vendor-neutral, standards-based MIB, any SNMPv3-capable network device (SNMP engine identity/boot/clock status) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

What Is SCTE-HMS-HE-COMMON-MIB?

SCTE-HMS-HE-COMMON-MIB is a SCTE (Society of Cable Telecommunications Engineers) Hybrid Fiber-Coax Management Standard (HMS) MIB defining common management objects shared across cable headend/indoor optical equipment, part of a family of standardized MIBs for cable-plant hardware. It exposes environmental and status data — device time, temperature — plus alarm-detection control and an internal event log table for tracking historical alarm/status changes. This is directly a hardware-monitoring MIB: heCommonTemperature lets an operator watch for headend equipment overheating, heCommonSoftwareReset supports remote reboot for recovery, and heCommonLogTable/heCommonLogEntry (keyed by heCommonLogIndex, referencing heCommonLogOID) provides a historical audit trail of alarm and status events for post-incident diagnosis. It is a vendor-neutral SCTE/ANSI standards MIB, designed to be implemented consistently by multiple headend equipment vendors alongside other SCTE-HMS family MIBs for specific equipment types. Typical deployment context is cable headend or hub-site optical/RF equipment, where the SCTE-HMS-HE-COMMON-MIB MIB is monitored centrally by a cable operator's HMS-compliant network management system.

IPNetwork Monitor allows you to monitor SNMP objects defined in SCTE-HMS-HE-COMMON-MIB. Use the built-in SNMP Monitoring Browser to explore available variables, view their current values and descriptions, and select the objects you want to monitor. You can then create SNMP monitors, configure thresholds, and receive alerts when monitored values change.

Supported Devices

vendor-neutral, SCTE HMS standards-based MIB, not tied to a specific manufacturer
cable headend/hub-site optical and RF equipment

Monitoring Examples

An operator would poll heCommonTemperature on each piece of headend gear to catch overheating before it causes a failure, and check heCommonAlarmDetectionControl to confirm alarm reporting is enabled on that unit. heCommonLogTable/heCommonLogEntry, walked via heCommonLogIndex, would be reviewed after an outage to see the sequence of heCommonLogOID-referenced events leading up to the failure, using heCommonLogNumberOfEntries and heCommonLogLastIndex to know how much history is retained. heCommonTime confirms the device's clock is synchronized, which matters for correlating log timestamps across headend equipment from different vendors.

What Can Be Monitored

equipment temperature
device clock/time
alarm detection enable state
historical alarm/event log
software reset control

Imported Objects

From ENTITY-MIB

entPhysicalIndex

OBJECT-TYPE

From SCTE-HMS-HEADENDIDENT-MIB

HeTenthCentigrade
heCommon	OBJECT-IDENTITY

From SCTE-ROOT

scteHmsTree

OBJECT-IDENTITY

From SNMPv2-CONF

MODULE-COMPLIANCE
NOTIFICATION-GROUP
OBJECT-GROUP

From SNMPv2-SMI

Integer32
MODULE-IDENTITY
NOTIFICATION-TYPE
OBJECT-TYPE

From SNMPv2-TC

DateAndTime
DisplayString

How to Use in IPNetwork Monitor

Example using heCommonLogNumberOfEntries OID:

Select a device implementing SCTE-HMS-HE-COMMON-MIB as the target host to create a monitor — the SNMP service should be up and running on it. Click New Monitor, then check SNMP Custom on the Favorites tab, click Next, and confirm the host. On the next page, click Select... to open the built-in SNMP MIB Browser and type heCommonLogNumberOfEntries into the Find box to locate it in the OID tree, then select it and click OK. The current number of entries in the heCommonLogTable. On the monitor's Main parameters page you can set the target's SNMP port (default 161), credentials, polling interval, and other settings — see the SNMP Monitor help for details. On the State conditions and Alerting tabs, configure when the monitor should change state and trigger an alert; since this is an Integer32-type OID, Value bounds is the most useful condition here — trigger an alert if the count changes from its expected baseline, since that would indicate the underlying set of items changed unexpectedly. Click Finish to create the monitor; you can adjust any parameter later.

OIDs

OID symbolic	OID numeric	Type	Access	Description
heCommonTrapPrefix	1.3.6.1.4.1.5591.1.0
NTF heCommonAlarmEvent	1.3.6.1.4.1.5591.1.0.5			The SNMP trap that is generated when an alarm event is found. At the option of the unit, the heCommonLogText variable may be reported as a fifth varbind, for those instances where an additional text field is supported.
heCommonMib	1.3.6.1.4.1.5591.1.11.2.1.1			The MIB module is for representing general information about optical equipment present in the headend (or indoor) and is supported by an SNMP agent.
heCommonObjects	1.3.6.1.4.1.5591.1.11.2.1.1.1
heCommonParams	1.3.6.1.4.1.5591.1.11.2.1.1.1.1
heCommonTable	1.3.6.1.4.1.5591.1.11.2.1.1.1.1.1		not-accessible	A table containing information about headend (or indoor) equipment.
heCommonEntry	1.3.6.1.4.1.5591.1.11.2.1.1.1.1.1.1		not-accessible	Information about particular headend equipment.
DAT heCommonTime	1.3.6.1.4.1.5591.1.11.2.1.1.1.1.1.1.1	DateAndTime	read-write	Real time clock.
HET heCommonTemperature	1.3.6.1.4.1.5591.1.11.2.1.1.1.1.1.1.2	HeTenthCentigrade	read-only	Temperature measured inside the headend equipment. This object must provide for the alarm management capabilities with a corresponding entry in the propertyTable of SCTE-HMS-PROPERTY-MIB (HMS026). An alarm shall be recorded as an entry in the currentAlarmTable of SCTE-HMS-PROPERTY-MIB (HMS026). A log record shall be added as an entry in the heCommonLogTable. An heCommonAlarmEvent notification shall be sent.
INT heCommonSoftwareReset	1.3.6.1.4.1.5591.1.11.2.1.1.1.1.1.1.3	INTEGER	read-write	This object is used to reset software of the headend physical entity. A SET request with the value reset(1) only shall reset the software application. The reset implementation is vendor specific. A GET request shall always return the value reset(1) and shall have no effect on the entity.
INT heCommonAlarmDetectionControl	1.3.6.1.4.1.5591.1.11.2.1.1.1.1.1.1.4	INTEGER	read-write	This object is used to control the detection of alarms in this headend entity. Each headend entity may provide for the alarm management capabilities. The provisions shall be done by means of the propertyTable and/or the discretePropertyTable of SCTE-HMS-PROPERTY-MIB (HMS026). When a threshold from either the propertyTable or the discretePropertyTable is crossed in a manner described by SCTE-HMS-PROPERTY-MIB (HMS026), then an alarm is said to have occurred. When the alarm is detected, then (1) an entry is placed in the heCommonLogTable, which serves as a log of the most recent alarm events; (2) an heCommonAlarmEvent trap is generated; (3) a property which is not in the nominal state will have an entry in the currentAlarmTable of SCTE-HMS-PROPERTY-MIB. The detectionDisabled(1) value prevents the threshold detection process associated with the property table and discrete property table from running. The headend entity shall not generate alarms. The contents of the heCommonLogTable, currentAlarmTable, each instance of discreteAlarmState, and each instance of currentAlarmState shall remain in the state prior to detectionDisabled(1) being applied. The detectionEnabled(2) value permits alarm detection to run. The detection process continues from the state the headend entity was in prior to detectionEnabled(2) being set. The detectionEnabledAndRegenerate(3) value clears all alarm information and permits alarm detection to run. All alarm properties, both discrete and analog, are restored to the nominal value before alarm detection runs. Any properties that are in an alarm state SHALL NOT produce a 'return to normal' alarm as part of the process. Setting this value clears the heCommonLogTable and the currentAlarmTable. The detectionEnabledAndRegenerate(3) value is transient, that is a SET request with a value detectionEnabledAndRegnerate(3) shall return the same value detectionEnabledAndRegnerate(3). Subsequent GET requests shall return a value detectionEnabled(2). The detectionDisabled(1) value shall affect the generation of heCommonAlarmEvent trap only. Traps added in the future are assumed to be unaffected by this object, unless stated in the description of that trap. This object has a default value of detectionEnabled(2). The value shall be maintained in non-volatile memory.
heCommonLog	1.3.6.1.4.1.5591.1.11.2.1.1.1.2
I32 heCommonLogNumberOfEntriesEx	1.3.6.1.4.1.5591.1.11.2.1.1.1.2.1	Integer32	read-only	The current number of entries in the heCommonLogTable. Before the very first wrap-around condition occurs for heCommonLogIndex, heCommonLogNumberOfEntries will return the total number of entries logged in heCommonLogTable, since the unit was powered up. After the first wrap-around condition has occured for for the value of the MIB variable heCommonLogIndex, heCommonLogNumberOfEntries will return the maximum number of rows the heCommonLogTable can hold.
I32 heCommonLogLastIndex	1.3.6.1.4.1.5591.1.11.2.1.1.1.2.2	Integer32	read-only	Index of the most recent alarm entry logged in the heCommonLogTable. The value of this variable can be used as the value of heCommonLogIndex to retrieve the most recent logged entry.
heCommonLogTable	1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3		not-accessible	A list of alarms that have been logged. Agent should generate the SNMP HMS notification every time a new alarm entry is logged. This table should support a minimum of 16 entries.
heCommonLogEntry	1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1		not-accessible	A set of data describing an alarm event that has been logged.
I32 heCommonLogIndex	1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1.1	Integer32	not-accessible	An index that uniquely identifies an entry in the log table. Indexes are assigned beginning with 1 and increased by one with each new log entry up to 65535. The next entry after 65535 is one. The agent may choose to delete the oldest instances of heCommonLogEntry as required because of lack of memory. It is an implementation-specific matter as to when this deletion may occur. Note - The wrap-around for the heCommonLogIndex variable MUST occur after 65535 regardless of the implementation specific size of the hlCommonLogTable.
OID heCommonLogOID	1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1.2	OBJECT IDENTIFIER	read-only	This is the OID of the object that has changed alarm state.
I32 heCommonLogValue	1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1.3	Integer32	read-only	This is the value of the object at the time it changed alarm state.
INT heCommonLogState	1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1.4	INTEGER	read-only	The new alarm state of the object which caused the event to be recorded into the log.
DAT heCommonLogTime	1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1.5	DateAndTime	read-only	This is the time when the alarm change for the object occured.
STR heCommonLogText	1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1.6	DisplayString	read-only	This is a text field describing the alarm. This field could be a zero length string in certain agent implementations.
heCommonTraps	1.3.6.1.4.1.5591.1.11.2.1.1.2
heCommonConformance	1.3.6.1.4.1.5591.1.11.2.1.1.3
heCommonCompliances	1.3.6.1.4.1.5591.1.11.2.1.1.3.1
heCommonCompliance	1.3.6.1.4.1.5591.1.11.2.1.1.3.1.1			The compliance statement for SNMP entities which implement this MIB.
heCommonGroups	1.3.6.1.4.1.5591.1.11.2.1.1.3.2
heCommonParamsGroup	1.3.6.1.4.1.5591.1.11.2.1.1.3.2.1			The collection of objects which are used to represent the common parameters of the headend managed entities.
heCommonLogGroup	1.3.6.1.4.1.5591.1.11.2.1.1.3.2.2			The collection of objects which are used to record an alarm event into the headend agent log.
heCommonNotificationsGroup	1.3.6.1.4.1.5591.1.11.2.1.1.3.2.3			The collection of notifications used by the headend agent to report the exceptional conditions to the management application.

RFC description

Represents general information about optical equipment in cable headends including temperature and time.

Start monitoring vendor-neutral, SCTE HMS standards-based MIB, cable headend/hub-site optical and RF equipment (temperature/alarm log) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

Download SCTE-HMS-HE-COMMON-MIB