SCTE-HMS-COMMON-MIB
SCTEThis MIB contains common information about NEs. MIB items cover administrative information such as name, ID, model number, serial numbers vendor, and location; health indicators such as status and service state; and functional information such as power level and frequency range. Caution: a set of any object stored in non-volatile memory may result in an actual write to non-volatile memory, which typically has a finite lifetime. Excessive writing to these objects could shorten the usefule life of the device. Objects which are not present must not have the properties present either. Published in SCTE 38-3. Copyright 2002, 2008, 2012, 2017, 2022, 2025 SCTE All rights reserved.
snmptranslate -m SCTE-HMS-COMMON-MIB -Tpsnmpwalk -v2c -c <community> -m SCTE-HMS-COMMON-MIB <host> 1.3.6.1.4.1.5591.1.3Imports
| INET-ADDRESS-MIB | InetAddress, InetAddressType |
|---|---|
| SCTE-ROOT | scteHmsTree |
| SNMPv2-CONF | MODULE-COMPLIANCE, NOTIFICATION-GROUP |
| SNMPv2-SMI | Bits, Counter32, Integer32, IpAddress, MODULE-IDENTITY, MibIdentifier, NOTIFICATION-TYPE, OBJECT-IDENTITY, OBJECT-TYPE, TimeTicks, Unsigned32, iso |
| SNMPv2-TC | DisplayString, PhysAddress, TEXTUAL-CONVENTION |
OID tree
| Name | OID | Type | Access | Status | Example | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| !hmsColdStart | 1.3.6.1.4.1.5591.1.0.0 | ||||||||||||
notification · current A hmsColdStart trap signifies that the sending protocol entity is reinitializing itself such that the agent's configuration or the protocol entity implementation may be altered. This trap is only issued by the transponder once the registration has been completed successfully.
| |||||||||||||
| !hmsWarmStart | 1.3.6.1.4.1.5591.1.0.2 | ||||||||||||
notification · current A hmsWarmStart trap signifies that the sending protocol entity is reinitializing itself such that neither the agent's configuration nor the protocol entity implementation is altered. This trap is only issued by the transponder once the registration has been completed successfully.
| |||||||||||||
| IcommonIdent | 1.3.6.1.4.1.5591.1.3 | ||||||||||||
identity This MIB contains common information about NEs. MIB items cover administrative information such as name, ID, model number, serial numbers vendor, and location; health indicators such as status and service state; and functional information such as power level and frequency range. Caution: a set of any object stored in non-volatile memory may result in an actual write to non-volatile memory, which typically has a finite lifetime. Excessive writing to these objects could shorten the usefule life of the device. Objects which are not present must not have the properties present either. Published in SCTE 38-3. Copyright 2002, 2008, 2012, 2017, 2022, 2025 SCTE All rights reserved. | |||||||||||||
| NcommonAdminGroup | 1.3.6.1.4.1.5591.1.3.1 | ||||||||||||
| ScommonLogicalID | 1.3.6.1.4.1.5591.1.3.1.1 | OCTET STRING (SIZE (0..40)) | RW | ||||||||||
scalar · OCTET STRING (SIZE (0..40)) · read-write · current Specifies the logical ID for the network element used by network management systems. The ID will often remain with a specific location regardless of any specific network element's characteristics. The value for this object is maintained in non-volatile memory. | |||||||||||||
| ScommonVendor | 1.3.6.1.4.1.5591.1.3.1.2 | DisplayString (SIZE (0..255)) | RO | ||||||||||
scalar · DisplayString (SIZE (0..255)) · read-only · current Displays the manufacturer of the network element. Displayed in human-readable format. | |||||||||||||
| ScommonModelNumber | 1.3.6.1.4.1.5591.1.3.1.3 | DisplayString (SIZE (0..255)) | RO | Alpha Model DM3X | |||||||||
scalar · DisplayString (SIZE (0..255)) · read-only · current Displays the model number of the network element. Displayed in human-readable format. Example values from LibreNMS test devices
| |||||||||||||
| ScommonSerialNumber | 1.3.6.1.4.1.5591.1.3.1.4 | DisplayString (SIZE (0..255)) | RO | 1932F58N1996 | |||||||||
scalar · DisplayString (SIZE (0..255)) · read-only · current Returns the Serial Number of the Network Element. Displayed in human-readable format. Example values from LibreNMS test devices
| |||||||||||||
| ScommonVendorInfo | 1.3.6.1.4.1.5591.1.3.1.5 | DisplayString (SIZE (0..255)) | RO | DM3X-5.7.1mp1_02.30_02.30-NA | |||||||||
scalar · DisplayString (SIZE (0..255)) · read-only · current Returns vendor-specific information. Displayed in human-readable format. Example values from LibreNMS test devices
| |||||||||||||
| ScommonNEStatus | 1.3.6.1.4.1.5591.1.3.1.6 | OCTET STRING (SIZE (1)) | RO | ||||||||||
scalar · OCTET STRING (SIZE (1)) · read-only · current Bit mask, identical to that used in the Status field of
the STATRESP PDU. See SCTE 25-2 (formerly HMS004).
Bit 0: CHNLRQST
Bit 1: CNTNRM
Bit 2: CNTCUR
Bit 3: MAJOR ALARMS
Bit 4: MINOR ALARMS
Bit 5: NOTICE ALARMS
Bit 6: RSVD
Bit 7: RSVD | |||||||||||||
| ScommonReset | 1.3.6.1.4.1.5591.1.3.1.7 | INTEGER | RW | ||||||||||
scalar · INTEGER · read-write · current This object is used to reset the NE by writing 1 to it. Other values written to the object have no effect. Reading the object returns a 1, and has no effect on the unit.
| |||||||||||||
| ScommonAlarmDetectionControl | 1.3.6.1.4.1.5591.1.3.1.8 | INTEGER | RW | ||||||||||
scalar · INTEGER · read-write · current This object is used to control the detection of alarms in this NE. When a threshold from either the property table or the discrete property table is crossed in a manner described by that MIB, then an alarm is said to have occurred. When the alarm is detected, an entry is placed in the alarm log table, which serves as a log of the most recent alarm events. When an alarm is detected, then an alarm trap is also generated. A property which is not in the nominal state will have an entry in the currentAlarmTable. The detectionDisabled(1) value prevents the threshold detection process associated with the property table and discrete property table from running. The NE will not generate alarms. The contents of the alarmLogTable, currentAlarmTable, each instance of discreteAlarmState, and each instance of currentAlarmState remain in the state prior to detectionDisabled being applied. The detectionEnabled(2) value permits alarm detection to run. The detection process continues from the state the transponder was in prior to detectionEnabled 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 alarmLogTable and the currentAlarmTable. The detectionEnabledAndRegenerate(3) value is transient. When setting commonAlarmDetectionControl to detectionEnabledAndRegenerate(3), the response will contain detectionEnabledAndRegenerate(3). Subsequent reads of the object report detectionEnabled(2). The detectionDisabled(1) value does not affect the generation of hmsColdStart or hmsWarmStart traps. 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 for this object is maintained in non-volatile memory.
| |||||||||||||
| ScommonNetworkAddress | 1.3.6.1.4.1.5591.1.3.1.9 | IpAddress | RO | obsolete | |||||||||
scalar · IpAddress · read-only · obsolete This variable reports the network address (e.g., IP address) of the NE. This object was added to support the generation of traps. The value is retained in non-volatile memory. The value may be set during the registration process by a MAC level command or via a vendor's craft interface. With the introduction of IPv6 this object has been deprecated and commonNetworkIpAddress is to be used instead. See the description of commonNetworkIpAddress for details on how this object is to be used in conjunction with IPv6 addresses. | |||||||||||||
| ScommonCheckCode | 1.3.6.1.4.1.5591.1.3.1.10 | Integer32 | RW | ||||||||||
scalar · Integer32 · read-write · current This object reports the Check Code for the transponder's configuration. The check code is generated from objects which are stored in non-volatile memory as well as those objects which reports the transponder's physical configuration, including monitored devices. The algorithm used to generate the Check Code is vendor specific. Upon a restart of the transponder, the current value of the check code is compared against the value previous to the restart to determine if a hmsColdStart or a hmsWarmStart trap is to be generated. This requires that the value of the object be maintained in non-volatile memory for the comparison operation after a restart. When a value is written to this object, the check code is recalculated, and the new value is returned in the GetResponse returned for the SetRequest. Since this optimization is NOT SNMP compliant, the transponder MAY respond in the SNMP compliant manner. Since this object description may impact an SNMP manager, it is recommended that the value be subsequently retrieved with a GetRequest, to guarantee that the desired value has been obtained. In this case (on-demand recalculation), the hmsColdStart or hmsWarmStart traps are NOT generated. The value for this object is maintained in non-volatile memory. | |||||||||||||
| ScommonTrapCommunityString | 1.3.6.1.4.1.5591.1.3.1.11 | OCTET STRING (SIZE (0..64)) | RW | ||||||||||
scalar · OCTET STRING (SIZE (0..64)) · read-write · current This object defines the community string reported in a trap. The default value is 'public'. Use of this object does not preclude the use of enterprise specific mechanisms to define community string values. The value for this object is maintained in non-volatile memory. | |||||||||||||
| ScommonTamperStatus | 1.3.6.1.4.1.5591.1.3.1.12 | INTEGER | RO | ||||||||||
scalar · INTEGER · read-only · current Returns the status of the anti-tamper device of the network element. this object requires an entry in the Discrete Property Table. the intact(1) value represents ok, and the compromised(2) value indicates an alarm.
| |||||||||||||
| ScommonInternalTemperature | 1.3.6.1.4.1.5591.1.3.1.13 | Integer32 (-60..130) | RO | ||||||||||
scalar · Integer32 (-60..130) · read-only · current Measured temperature inside the NE's case/housing. Units degrees Celsius. This item requires an entry in the properties MIB. | |||||||||||||
| ScommonTime | 1.3.6.1.4.1.5591.1.3.1.14 | Integer32 | RO | ||||||||||
scalar · Integer32 · read-only · current All values are unsigned 32 bit integers. Time since the Epoch (00:00:00 UTC, January 1, 1970), measured in seconds(POSIX). | |||||||||||||
| ScommonVarBindings | 1.3.6.1.4.1.5591.1.3.1.15 | Integer32 | RO | ||||||||||
scalar · Integer32 · read-only · current This object indicates the maximum number of entries in the variable-binding list which can be accepted by the unit. A value of 0 indicates no specified limit. | |||||||||||||
| ScommonResetCause | 1.3.6.1.4.1.5591.1.3.1.16 | INTEGER | RO | powerup(2) | |||||||||
scalar · INTEGER · read-only · current This object reports the cause of the last reset.
Example values from LibreNMS test devices
| |||||||||||||
| ScommonCraftStatus | 1.3.6.1.4.1.5591.1.3.1.17 | INTEGER | RO | disconnected(1) | |||||||||
scalar · INTEGER · read-only · current This object reports the state of the craft interface. The status of this object does not imply any change to the transponder functionality through the MAC interface. Not all transponders support a craft interface. If the interface is not supported, the objects reports disconnected(2). This object requires an entry in the Discrete Property Table.
Example values from LibreNMS test devices
| |||||||||||||
| ScommonNetworkIpAddressType | 1.3.6.1.4.1.5591.1.3.1.18 | InetAddressType | RO | ||||||||||
scalar · InetAddressType · read-only · current Address mode of commonNetworkIpAddress. | |||||||||||||
| ScommonNetworkIpAddress | 1.3.6.1.4.1.5591.1.3.1.19 | InetAddress | RO | ||||||||||
scalar · InetAddress · read-only · current This variable reports the network address (e.g., IP address) of the NE. This object was added to support the generation of traps. The value is retained in non-volatile memory. The value may be set during the registration process by a MAC level command or via a vendor's craft interface. If commonNetworkAddress is also implemented in this agent, this object is tied to it. If this object contains an IPv4 address, commonNetworkAddress, if implemented, will return the same address. If this object contains an IPv6 address, commonNetworkAddress will return 0.0.0.0. | |||||||||||||
| NcommonMACGroup | 1.3.6.1.4.1.5591.1.3.2 | ||||||||||||
| ScommonBackoffPeriod | 1.3.6.1.4.1.5591.1.3.2.1 | Integer32 (0..16383) | RW | ||||||||||
scalar · Integer32 (0..16383) · read-write · current The backoff period in millseconds. This parameter is used as part of the random backoff period as defined by the Media Access Control Layer specification SCTE 25-2(formerly HMS004). Initial Power up default: 6 millseconds. The value for this object is maintained in non-volatile memory. | |||||||||||||
| ScommonACKTimeoutWindow | 1.3.6.1.4.1.5591.1.3.2.2 | Integer32 (0..255) | RW | ||||||||||
scalar · Integer32 (0..255) · read-write · current The Acknowledgement timeout window in milliseconds. Initial Power up default: 19 milliseconds. The value for this object is maintained in non-volatile memory. | |||||||||||||
| ScommonMaximumMACLayerRetries | 1.3.6.1.4.1.5591.1.3.2.3 | Integer32 (0..255) | RW | ||||||||||
scalar · Integer32 (0..255) · read-write · current The maximum number of retries a NE can make for a specific packet. This limit is intended to protect the network from a unit with a faulty receiver. Initial Power up default: 16. The value for this object is maintained in non-volatile memory. | |||||||||||||
| ScommonMaxPayloadSize | 1.3.6.1.4.1.5591.1.3.2.4 | Integer32 | RO | ||||||||||
scalar · Integer32 · read-only · current This object reports the maximum length of the payload supported for a packet on the reverse or forward channel. | |||||||||||||
| ScommonBackoffMinimumExponent | 1.3.6.1.4.1.5591.1.3.2.5 | Integer32 (0..15) | RW | ||||||||||
scalar · Integer32 (0..15) · read-write · current This object is used to define the minimum value of the exponent used for the Backoff Algorithm as defined by the Media Access Control Layer specification SCTE 25-2(formerly HMS004). The default value is 6. The value must be less than or equal to commonBackoffMaximumExponent The value for this object is maintained in non-volatile memory. | |||||||||||||
| ScommonBackoffMaximumExponent | 1.3.6.1.4.1.5591.1.3.2.6 | Integer32 (0..15) | RW | ||||||||||
scalar · Integer32 (0..15) · read-write · current This object is used to define the maximum value of the exponent used for the Backoff Algorithm as defined by the Media Access Control Layer specification SCTE 25-2(formerly HMS004). The default value is 15. The value must be greater than or equal to commonBackoffMinimumExponent. The value for this object is maintained in non-volatile memory. | |||||||||||||
| ScommonPhysAddress | 1.3.6.1.4.1.5591.1.3.2.7 | OCTET STRING | RO | ||||||||||
scalar · OCTET STRING · read-only · current This variable reports the media dependent 'physical' address of the NE. This object was added to support the generation of traps. | |||||||||||||
| NcommonMulticastGroup | 1.3.6.1.4.1.5591.1.3.3 | ||||||||||||
| ScommonMaxMulticastAddresses | 1.3.6.1.4.1.5591.1.3.3.1 | Integer32 (4..255) | RO | ||||||||||
scalar · Integer32 (4..255) · read-only · current Maximum number of multicast data link layer addresses supported by this NE. | |||||||||||||
| TcommonMulticastAddressTable | 1.3.6.1.4.1.5591.1.3.3.2 | NA | |||||||||||
table · not-accessible · current The table containing the multicast addresses. The value for all objects in this table are maintained in non-volatile memory. | |||||||||||||
| RcommonMulticastAddressEntry | 1.3.6.1.4.1.5591.1.3.3.2.1 | NA | |||||||||||
row · not-accessible · current A list of information for multicast addresses. | |||||||||||||
| CcommonMulticastAddressIndex | 1.3.6.1.4.1.5591.1.3.3.2.1.1 | Integer32 (1..255) | RO | ||||||||||
column · Integer32 (1..255) · read-only · current Index into commonMulticastAddressTable. | |||||||||||||
| CcommonMulticastAddressNumber | 1.3.6.1.4.1.5591.1.3.3.2.1.2 | OCTET STRING (SIZE (6)) | RW | ||||||||||
column · OCTET STRING (SIZE (6)) · read-write · current The multicast address. Only entries with the I/G bit set are accepted values. An empty entry is designated by setting the object to the broadcast address. | |||||||||||||
| NcommonStatsGroup | 1.3.6.1.4.1.5591.1.3.4 | ||||||||||||
| NcommonMacStats | 1.3.6.1.4.1.5591.1.3.4.1 | ||||||||||||
| ScommonForwardPathLOSEvents | 1.3.6.1.4.1.5591.1.3.4.1.1 | Counter32 | RW | ||||||||||
scalar · Counter32 · read-write · current Count of forward path loss of signal (LOS) events. Can be reset to 0. | |||||||||||||
| ScommonForwardPathFramingErrors | 1.3.6.1.4.1.5591.1.3.4.1.2 | Counter32 | RW | ||||||||||
scalar · Counter32 · read-write · current Count of framing errors on the forward path. Can be reset to 0. | |||||||||||||
| ScommonForwardPathCRCErrors | 1.3.6.1.4.1.5591.1.3.4.1.3 | Counter32 | RW | ||||||||||
scalar · Counter32 · read-write · current Count of CRC errors on the forward path. Can be reset to 0. | |||||||||||||
| ScommonInvalidMacCmds | 1.3.6.1.4.1.5591.1.3.4.1.4 | Counter32 | RW | ||||||||||
scalar · Counter32 · read-write · current Count of invalid MAC commands. Can be reset to 0. | |||||||||||||
| NcommonRfGroup | 1.3.6.1.4.1.5591.1.3.5 | ||||||||||||
| ScommonReturnPathFrequency | 1.3.6.1.4.1.5591.1.3.5.1 | Integer32 (0..1000000000) | RO | 33600000 | |||||||||
scalar · Integer32 (0..1000000000) · read-only · current Return path frequency. Units 1 Hz. The value for this object is maintained in non-volatile memory. Example values from LibreNMS test devices
| |||||||||||||
| ScommonForwardPathFrequency | 1.3.6.1.4.1.5591.1.3.5.2 | Integer32 (0..1000000000) | RO | 597000000 | |||||||||
scalar · Integer32 (0..1000000000) · read-only · current Forward path frequency. Units 1 Hz. The value for this object is maintained in non-volatile memory. Example values from LibreNMS test devices
| |||||||||||||
| ScommonProvisionedReturnPowerLevel | 1.3.6.1.4.1.5591.1.3.5.3 | Integer32 | RW | ||||||||||
scalar · Integer32 · read-write · current Return path power level to be used. Units 0.1 dBmV. The value used internally will be rounded to the nearest supported value. The object reports the requested value, not the rounded value. The value for this object is maintained in non-volatile memory. | |||||||||||||
| ScommonForwardPathReceiveLevel | 1.3.6.1.4.1.5591.1.3.5.4 | Integer32 (-1000..1000) | RO | 85 | |||||||||
scalar · Integer32 (-1000..1000) · read-only · current Returns the received forward path power level. Units 0.1 dBmV. Example values from LibreNMS test devices
| |||||||||||||
| ScommonMaxReturnPower | 1.3.6.1.4.1.5591.1.3.5.5 | Integer32 (200..600) | RW | ||||||||||
scalar · Integer32 (200..600) · read-write · current The maximum return path power to be used by the NE. Units 0.1 dBmV. The value for this object is maintained in non-volatile memory. | |||||||||||||
Traps / Notifications
- hmsColdStart
1.3.6.1.4.1.5591.1.0.0 - hmsWarmStart
1.3.6.1.4.1.5591.1.0.2