SCTE-HMS-HE-COMMON-MIB

File: SCTE-HMS-HE-COMMON-MIB.mib (15746 bytes)

Imported modules

SNMPv2-SMI SNMPv2-TC SNMPv2-CONF
ENTITY-MIB SCTE-ROOT SCTE-HMS-HEADENDIDENT-MIB

Imported symbols

Integer32 MODULE-IDENTITY OBJECT-TYPE
NOTIFICATION-TYPE DisplayString DateAndTime
MODULE-COMPLIANCE OBJECT-GROUP NOTIFICATION-GROUP
entPhysicalIndex scteHmsTree heCommon
HeTenthCentigrade

Defined Types

HeCommonEntry  
SEQUENCE    
  heCommonTime DateAndTime
  heCommonTemperature HeTenthCentigrade
  heCommonSoftwareReset INTEGER
  heCommonAlarmDetectionControl INTEGER

HeCommonLogEntry  
SEQUENCE    
  heCommonLogIndex Integer32
  heCommonLogOID OBJECT IDENTIFIER
  heCommonLogValue Integer32
  heCommonLogState INTEGER
  heCommonLogTime DateAndTime
  heCommonLogText DisplayString

Defined Values

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.
MODULE-IDENTITY    

heCommonObjects 1.3.6.1.4.1.5591.1.11.2.1.1.1
OBJECT IDENTIFIER    

heCommonParams 1.3.6.1.4.1.5591.1.11.2.1.1.1.1
OBJECT IDENTIFIER    

heCommonLog 1.3.6.1.4.1.5591.1.11.2.1.1.1.2
OBJECT IDENTIFIER    

heCommonTable 1.3.6.1.4.1.5591.1.11.2.1.1.1.1.1
A table containing information about headend (or indoor) equipment.
Status: current Access: not-accessible
OBJECT-TYPE    
  SEQUENCE OF  
    HeCommonEntry

heCommonEntry 1.3.6.1.4.1.5591.1.11.2.1.1.1.1.1.1
Information about particular headend equipment.
Status: current Access: not-accessible
OBJECT-TYPE    
  HeCommonEntry  

heCommonTime 1.3.6.1.4.1.5591.1.11.2.1.1.1.1.1.1.1
Real time clock.
Status: current Access: read-write
OBJECT-TYPE    
  DateAndTime  

heCommonTemperature 1.3.6.1.4.1.5591.1.11.2.1.1.1.1.1.1.2
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.
Status: current Access: read-only
OBJECT-TYPE    
  HeTenthCentigrade  

heCommonSoftwareReset 1.3.6.1.4.1.5591.1.11.2.1.1.1.1.1.1.3
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.
Status: current Access: read-write
OBJECT-TYPE    
  INTEGER reset(1)  

heCommonAlarmDetectionControl 1.3.6.1.4.1.5591.1.11.2.1.1.1.1.1.1.4
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.
Status: current Access: read-write
OBJECT-TYPE    
  INTEGER detectionDisabled(1), detectionEnabled(2), detectionEnabledAndRegenerate(3)  

heCommonLogNumberOfEntries 1.3.6.1.4.1.5591.1.11.2.1.1.1.2.1
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.
Status: current Access: read-only
OBJECT-TYPE    
  Integer32 0..65535  

heCommonLogLastIndex 1.3.6.1.4.1.5591.1.11.2.1.1.1.2.2
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.
Status: current Access: read-only
OBJECT-TYPE    
  Integer32 0..65535  

heCommonLogTable 1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3
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.
Status: current Access: not-accessible
OBJECT-TYPE    
  SEQUENCE OF  
    HeCommonLogEntry

heCommonLogEntry 1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1
A set of data describing an alarm event that has been logged.
Status: current Access: not-accessible
OBJECT-TYPE    
  HeCommonLogEntry  

heCommonLogIndex 1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1.1
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.
Status: current Access: not-accessible
OBJECT-TYPE    
  Integer32 1..65535  

heCommonLogOID 1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1.2
This is the OID of the object that has changed alarm state.
Status: current Access: read-only
OBJECT-TYPE    
  OBJECT IDENTIFIER  

heCommonLogValue 1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1.3
This is the value of the object at the time it changed alarm state.
Status: current Access: read-only
OBJECT-TYPE    
  Integer32 -2147483648..2147483647  

heCommonLogState 1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1.4
The new alarm state of the object which caused the event to be recorded into the log.
Status: current Access: read-only
OBJECT-TYPE    
  INTEGER heCommonNominal(1), heCommonHIHI(2), heCommonHI(3), heCommonLO(4), heCommonLOLO(5), heCommonDiscreteMajor(6), heCommonDiscreteMinor(7)  

heCommonLogTime 1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1.5
This is the time when the alarm change for the object occured.
Status: current Access: read-only
OBJECT-TYPE    
  DateAndTime  

heCommonLogText 1.3.6.1.4.1.5591.1.11.2.1.1.1.2.3.1.6
This is a text field describing the alarm. This field could be a zero length string in certain agent implementations.
Status: current Access: read-only
OBJECT-TYPE    
  DisplayString  

heCommonTraps 1.3.6.1.4.1.5591.1.11.2.1.1.2
OBJECT IDENTIFIER    

heCommonTrapPrefix 1.3.6.1.4.1.5591.1.0
OBJECT IDENTIFIER    

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.
Status: current Access: read-only
NOTIFICATION-TYPE    

heCommonConformance 1.3.6.1.4.1.5591.1.11.2.1.1.3
OBJECT IDENTIFIER    

heCommonCompliances 1.3.6.1.4.1.5591.1.11.2.1.1.3.1
OBJECT IDENTIFIER    

heCommonGroups 1.3.6.1.4.1.5591.1.11.2.1.1.3.2
OBJECT IDENTIFIER    

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.
Status: current Access: not-accessible
MODULE-COMPLIANCE    

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.
Status: current Access: not-accessible
OBJECT-GROUP    

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.
Status: current Access: not-accessible
OBJECT-GROUP    

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.
Status: current Access: not-accessible
NOTIFICATION-GROUP