MIBs Depot

CISCO-ENTITY-ALARM-MIB

Registered at
1.3.6.1.4.1.9.9.138
Last updated
1999-07-06 21:50
Organization
Cisco Systems, Inc.
Namespace
cisco
Source file
CISCO-ENTITY-ALARM-MIB
Digest
sha256:2b6358b7f50b8addf351339506bf91cfc86fe8c2c34d4ab2045d3f5aed2e1bfc

Description

This MIB module defines the managed objects that support the monitoring of alarms generated by physical entities contained by the system, including chassis, slots, modules, ports, power supplies, and fans. In order to monitor alarms generated by a physical entity, it must be represented by a row in the entPhysicalTable (see ENTITY-MIB).

Contact

Cisco Systems Customer Service Postal: 170 W Tasman Drive San Jose, CA 95134 Tel: +1 800 553-NETS E-mail: cs-dslam@cisco.com

Imports

FromSymbols
CISCO-SMIciscoMgmt
ENTITY-MIBPhysicalIndex, entPhysicalIndex
SNMP-FRAMEWORK-MIBSnmpAdminString
SNMPv2-CONFMODULE-COMPLIANCE, NOTIFICATION-GROUP, OBJECT-GROUP
SNMPv2-SMIGauge32, MODULE-IDENTITY, NOTIFICATION-TYPE, OBJECT-IDENTITY, OBJECT-TYPE, Unsigned32, iso
SNMPv2-TCAutonomousType, DisplayString, RowStatus, TEXTUAL-CONVENTION, TimeStamp, TruthValue

Imported by

Nothing in this corpus imports this module.

Load order

Every file a consumer needs in order to load this module, dependencies first.

CISCO-ENTITY-ALARM-MIB
CISCO-SMI
ENTITY-MIB
IANA-ENTITY-MIB
SNMP-FRAMEWORK-MIB
SNMPv2-CONF
SNMPv2-SMI
SNMPv2-TC
UUID-TC-MIB

Textual conventions

NameOIDSyntaxAccessStatus
AlarmFilterProfileType
TEXTUAL-CONVENTION
An integer value that uniquely identifies an alarm filter profile.
current
AlarmList
TEXTUAL-CONVENTION
For each unique type of physical entity (i.e., for each set of physical entities sharing a unique entPhysicalVendorType OID), there an exists unique alarm space. Observe that it is not necessary that all the alarms within a space be defined. An OCTET STRING represents an alarm list, in which each bit represents an alarm type. The bits in the first octet represent alarm types identified by the integer values 1 through 8, inclusive, The bits in the second octet represent alarm types identified by the integer values 9 through 16, inclusive, and so forth. The least significant bit of an octet represents the alarm type identified by the lowest integer value, and the most significant bit represents the alarm type identified by the highest integer value. The figure shown below illustrates the format of an alarm list. Octet 1 Octet 32 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0 +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ | |...| | +-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | +- Alarm 248 | | | | | | | | | | | | | | +--- Alarm 249 | | | | | | | | | | | | | +----- Alarm 250 | | | | | | | | | | | | +------- Alarm 251 | | | | | | | | | | | +--------- Alarm 252 | | | | | | | | | | +----------- Alarm 253 | | | | | | | | | +------------- Alarm 254 | | | | | | | | +--------------- Alarm 255 | | | | | | | | : | | | | | | | | : | | | | | | | +--------------------- Alarm 0 | | | | | | +----------------------- Alarm 1 | | | | | +------------------------- Alarm 2 | | | | +--------------------------- Alarm 3 | | | +----------------------------- Alarm 4 | | +------------------------------- Alarm 5 | +--------------------------------- Alarm 6 +----------------------------------- Alarm 7 An alarm list of length N, where N < 32, represents an alarm list for which alarms N*8 through 255 have the value of '0'. A special case is an alarm list having a length of '0', which represents an alarm list of all zeros.
current
AlarmSeverity
TEXTUAL-CONVENTION
Each alarm type defined by a vendor type employed by the system has an associated severity. Bellcore TR-NWT-000474 defines these severities as follows: 'critical' An alarm used to indicate a severe, service- affecting condition has occurred and that immediate corrective action is imperative, regardless of the time of day or day of the week. 'major' An alarm used for hardware or software conditions that indicate a serious disruption of service or the malfunctioning or failure of important hardware. These troubles require the immediate attention and response of a technician to restore or maintain system capability. The urgency is less than in critical situations because of a lesser immediate or impending effect on service or system performance. 'minor' An alarm used for troubles that do not have a serious effect on service to customers or for troubles in hardware that are not essential to the operation of the system. 'info' An indication used to raise attention to a condition that could possibly be an impending problem or to notify the customer of an event that improves operation.
current
AlarmSeverityOrZero
TEXTUAL-CONVENTION
A value of either '0' or a valid alarm severity.
current
AlarmType
TEXTUAL-CONVENTION
An arbitrary integer value that uniquely identifies an event relative to a physical entity contained by a system.
current

Objects

NameOIDSyntaxAccessStatus
ciscoEntityAlarmMIBObjects
OBJECT-IDENTITY
1.3.6.1.4.1.9.9.138.1
ceAlarmDescription
OBJECT-IDENTITY
1.3.6.1.4.1.9.9.138.1.1
ceAlarmDescrMapTable
OBJECT-TYPE
For each type of entity (represented entPhysicalVendorType OID), this table contains a mapping between a unique ceAlarmDescrIndex and entPhysicalvendorType OID.
1.3.6.1.4.1.9.9.138.1.1.1not-accessiblecurrent
ceAlarmDescrMapEntry
OBJECT-TYPE
A mapping between an alarm description and a vendor type.
1.3.6.1.4.1.9.9.138.1.1.1.1not-accessiblecurrent
ceAlarmDescrIndex
OBJECT-TYPE
This object uniquely identifies an alarm description.
1.3.6.1.4.1.9.9.138.1.1.1.1.1Unsigned32not-accessiblecurrent
ceAlarmDescrVendorType
OBJECT-TYPE
This object specifies an object identifier (typically an enterprise-specific OID) that uniquely identifies the vendor type of those physical entities that this alarm description applies to.
1.3.6.1.4.1.9.9.138.1.1.1.1.2AutonomousTyperead-onlycurrent
ceAlarmDescrTable
OBJECT-TYPE
This table contains a description for each alarm type defined by each vendor type employed by the system. Observe that this table is sparse in nature, as it is rarely the case that a physical entity type needs to define every alarm in its alarm space.
1.3.6.1.4.1.9.9.138.1.1.2not-accessiblecurrent
ceAlarmDescrEntry
OBJECT-TYPE
A collection of attributes that describe an alarm type.
1.3.6.1.4.1.9.9.138.1.1.2.1not-accessiblecurrent
ceAlarmDescrAlarmType
OBJECT-TYPE
This object specifies the alarm type being described.
1.3.6.1.4.1.9.9.138.1.1.2.1.1AlarmTypenot-accessiblecurrent
ceAlarmDescrSeverity
OBJECT-TYPE
This object specifies the severity associated with the alarm type. An implementation may chose to not allow dynamic severity assignment, in which case it would restrict access to this object to be read-only. If an implementation allows dynamic severity assignment, then a management client can revert to the default severity by writing the value '0' to this object. There exists a class of systems that should implement dynamic severity assignment. For example, consider a DSLAM (Digital Subscriber Loop Access Multiplexor) designed for both the central office and pedestal environments. A 'pedestal' is typically a dark-green metal box mounted on a concrete or stone foundation in which carrier-class companies house equipment. The central office typically controls the temperature and humidity of the environment, reducing reliance on a system's fans. Thus, the customer probably has a desire to reduce the severity of alarms indicating the failure of a fan. However, a pedestal environment has a much greater reliance on a system's fans. Thus, the customer probably has a desire to increase the severity of alarms indicating the failure of a fan.
1.3.6.1.4.1.9.9.138.1.1.2.1.2AlarmSeverityOrZeroread-writecurrent
ceAlarmDescrText
OBJECT-TYPE
This object specifies a human-readable message describing the alarm.
1.3.6.1.4.1.9.9.138.1.1.2.1.3SnmpAdminStringread-onlycurrent
ceAlarmMonitoring
OBJECT-IDENTITY
1.3.6.1.4.1.9.9.138.1.2
ceAlarmCriticalCount
OBJECT-TYPE
The value of this object specifies the number of alarms currently asserted with a severity of 'critical'.
1.3.6.1.4.1.9.9.138.1.2.1Gauge32read-onlycurrent
ceAlarmMajorCount
OBJECT-TYPE
The value of this object specifies the number of alarms currently asserted with a severity of 'major'.
1.3.6.1.4.1.9.9.138.1.2.2Gauge32read-onlycurrent
ceAlarmMinorCount
OBJECT-TYPE
The value of this object specifies the number of alarms currently asserted with a severity of 'minor'.
1.3.6.1.4.1.9.9.138.1.2.3Gauge32read-onlycurrent
ceAlarmCutOff
OBJECT-TYPE
If the management client writes a value of 'true' to this object, the agent stops signalling all external audible alarms under the control of the agent. Reading this object should always result in a value of 'false'. Observe that alarm cutoff does not have an effect on monitoring, history logging, generation of notifications, or syslog message generation. It also does not prevent the agent from signalling external audible alarms for alarms asserted after alarm-cutoff. This object emulates the 'alarm cut-off' mechanism typically installed in a central office (e.g., a big red button). Observe this object should neither affect external visual alarms under the control of the agent, nor should it affect the current state of alarms being asserted by the system.
1.3.6.1.4.1.9.9.138.1.2.4TruthValueread-writecurrent
ceAlarmTable
OBJECT-TYPE
This table specifies alarm control and status information related to each physical entity contained by the system, including the alarms currently being asserted by each physical entity capable of generating alarms.
1.3.6.1.4.1.9.9.138.1.2.5not-accessiblecurrent
ceAlarmEntry
OBJECT-TYPE
Alarm control and status information related to the corresponding physical entity, including a list of those alarms currently being asserted by that physical entity.
1.3.6.1.4.1.9.9.138.1.2.5.1not-accessiblecurrent
ceAlarmFilterProfile
OBJECT-TYPE
This object specifies the alarm filter profile associated with the corresponding physical entity. An alarm filter profile controls which alarm types the agent will monitor and signal for the corresponding physical entity. If the value of this object is '0', then the agent monitors and signals all alarms associated with the corresponding physical entity.
1.3.6.1.4.1.9.9.138.1.2.5.1.1AlarmFilterProfileTyperead-writecurrent
ceAlarmSeverity
OBJECT-TYPE
This object specifies the highest severity alarm currently being asserted by the corresponding physical entity. A value of '0' indicates that there the corresponding physical entity currently is not asserting any alarms.
1.3.6.1.4.1.9.9.138.1.2.5.1.2AlarmSeverityOrZeroread-onlycurrent
ceAlarmList
OBJECT-TYPE
This object specifies those alarms currently being asserted by the corresponding physical entity. Note, an alarm indicates a condition, not an event. An alarm has two states: 'asserted' Indicates that the condition described by the alarm exists. 'cleared' Indicates that the condition described by the alarm does not exist. For example, a slot in a chassis may define an alarm that specifies whether the slot contains a module. At the time of module insertion, the physical entity corresponding to the slot asserts this alarm, and the alarm remains asserted until the slot becomes empty. If an alarm is being asserted by the physical entity, then the corresponding bit in the alarm list is set to a one. Observe that if the physical entity is not currently asserting any alarms, then the list will have a length of zero.
1.3.6.1.4.1.9.9.138.1.2.5.1.3AlarmListread-onlycurrent
ceAlarmHistory
OBJECT-IDENTITY
1.3.6.1.4.1.9.9.138.1.3
ceAlarmHistTableSize
OBJECT-TYPE
This object specifies the number of entries that the ceAlarmHistTable can contain. When a physical entity generates an unfiltered alarm, and the capacity of the ceAlarmHistTable has reached the value specified by this object, then the agent deletes the oldest entity in order to accommodate the new entry. A value of '0' prevents any history from being retained.
1.3.6.1.4.1.9.9.138.1.3.1INTEGER (0..500)read-writecurrent
ceAlarmHistLastIndex
OBJECT-TYPE
This object specifies the value of the ceAlarmHistIndex object corresponding to the last entry added to the table by the agent. If the management client uses the notifications defined by this module, then it can poll this object to determine whether it has missed a notification sent by the agent.
1.3.6.1.4.1.9.9.138.1.3.2Unsigned32read-onlycurrent
ceAlarmHistTable
OBJECT-TYPE
This table contains a history of ceAlarmIndicate and ceAlarmClear traps generated by the agent.
1.3.6.1.4.1.9.9.138.1.3.3not-accessiblecurrent
ceAlarmHistEntry
OBJECT-TYPE
The information conveyed by a ceAlarmIndicate or ceAlarmClear trap.
1.3.6.1.4.1.9.9.138.1.3.3.1not-accessiblecurrent
ceAlarmHistIndex
OBJECT-TYPE
An integer value uniquely identifying the entry in the table. The value of this object starts at '1' and monotonically increases for each alarm condition transition monitored by the agent. If the value of this object is '4294967295', the agent will reset it to '1' upon monitoring the next alarm condition transition.
1.3.6.1.4.1.9.9.138.1.3.3.1.1Unsigned32not-accessiblecurrent
ceAlarmHistType
OBJECT-TYPE
This object specifies whether the agent created the entry as the result of an alarm being asserted or cleared.
1.3.6.1.4.1.9.9.138.1.3.3.1.2INTEGER {asserted(1), cleared(2)}read-onlycurrent
ceAlarmHistEntPhysicalIndex
OBJECT-TYPE
This object specifies the physical entity that generated the alarm.
1.3.6.1.4.1.9.9.138.1.3.3.1.3PhysicalIndexread-onlycurrent
ceAlarmHistAlarmType
OBJECT-TYPE
This object specifies the type of alarm generated.
1.3.6.1.4.1.9.9.138.1.3.3.1.4AlarmTyperead-onlycurrent
ceAlarmHistSeverity
OBJECT-TYPE
This object specifies the severity of the alarm generated.
1.3.6.1.4.1.9.9.138.1.3.3.1.5AlarmSeverityread-onlycurrent
ceAlarmHistTimeStamp
OBJECT-TYPE
This object specifies the value of the sysUpTime object at the time the alarm was generated.
1.3.6.1.4.1.9.9.138.1.3.3.1.6TimeStampread-onlycurrent
ceAlarmFiltering
OBJECT-IDENTITY
1.3.6.1.4.1.9.9.138.1.4
ceAlarmNotifiesEnable
OBJECT-TYPE
This object specifies a severity threshold governing the generation of ceAlarmAsserted and ceAlarmCleared notifications. For example, if the value of this object is set to 'major', then the agent generates these notifications if and only if the severity of the alarm being indicated is 'major' or 'critical'. The value of '0' disables the generation of notifications. Observe that this setting overrides the value of the ceAlarmFilterNotifiesEnabled object. This object affects notification generation only; that is, it does not affect monitoring, history logging, and syslog message generation.
1.3.6.1.4.1.9.9.138.1.4.1AlarmSeverityOrZeroread-writecurrent
ceAlarmSyslogEnable
OBJECT-TYPE
This object specifies a severity threshold governing the generation of syslog messages corresponding to alarms. For example, if the value of this object is set to 'major', then the agent generates these a syslog message if and only if the severity of the alarm being indicated is 'major' or 'critical'. The value of '0' disables the generation of syslog messages corresponding to alarms. Observe that this setting overrides the value of the ceAlarmFilterSyslogEnabled object. This object affects syslog message generation only; that is, it does not have an effect on monitoring, history logging, and generation of notifications.
1.3.6.1.4.1.9.9.138.1.4.2AlarmSeverityOrZeroread-writecurrent
ceAlarmFilterProfileIndexNext
OBJECT-TYPE
This object contains an appropriate value to be used for ceAlarmFilterIndex when creating entries in the ceAlarmFilterProfileTable. The value '0' indicates that no unassigned entries are available. To obtain a ceAlarmFilterIndex, the management client issues a get request. The agent has the responsibility of modifying the value of this object following each successful get request.
1.3.6.1.4.1.9.9.138.1.4.3AlarmFilterProfileTyperead-onlycurrent
ceAlarmFilterProfileTable
OBJECT-TYPE
This table contains a list of alarm filter profiles.
1.3.6.1.4.1.9.9.138.1.4.4not-accessiblecurrent
ceAlarmFilterProfileEntry
OBJECT-TYPE
When a physical entity asserts/clears an alarm AND the ceAlarmFilterProfile object is not '0', the agent applies the specified alarm filter profile in processing the alarm. The agent uses the following procedure in processing the transition of an alarm condition of a given type: 1) If the alarm list specified by the alarm filter profile's ceAlarmFilterAlarmsEnabled object specifies that the alarm type is disabled, then the agent performs no further processing. 2) The agent creates an entry in the ceAlarmHistTable. 3) If the alarm list specified by the alarm filter profile's ceAlarmFilterNotifiesEnabled object specifies that the alarm type is enabled, then the agent generates the appropriate notification. 4) If the alarm list specified by the alarm filter profile's ceAlarmFilterSyslogEnabled object specifies that the alarm type is enabled, then the agent generates the appropriate syslog message.
1.3.6.1.4.1.9.9.138.1.4.4.1not-accessiblecurrent
ceAlarmFilterIndex
OBJECT-TYPE
This object uniquely identifies the alarm filter profile.
1.3.6.1.4.1.9.9.138.1.4.4.1.1AlarmFilterProfileTypenot-accessiblecurrent
ceAlarmFilterStatus
OBJECT-TYPE
This object facilitates the creation, modification, or deletion of a conceptual row in this table. A management client can create a conceptual row in this table by setting this object to 'createAndWait' or 'createAndGo'. If a request to create a conceptual row in this table fails, then the system is not capable of supporting any more alarm filters. Before modifying a conceptual row in this table, the management client must set this object to 'notInService'. After modifying a conceptual row in this table, the management client must set this object to 'active'. This operation causes the modifications made to an alarm filter profile to take effect. An implementation should not allow a conceptual row in this table to be deleted if one or more physical entities reference it.
1.3.6.1.4.1.9.9.138.1.4.4.1.2RowStatusread-createcurrent
ceAlarmFilterAlias
OBJECT-TYPE
This object specifies an arbitrary name associated with the alarm filter profile by the management client, and provides a non-volatile 'handle' for the alarm filter profile. On the first instantiation of an alarm filter profile, the value of this object is a zero-length string. However, an agent may choose to set the value to a locally unique default value. If an implementation supports write access to this object, then the agent is responsible for ensuring the retention of any value written to this object until a management client deletes it. The level of retention must span reboots and reinitializations of the network management system, including those that result in different assignments to the value of the entPhysicalIndex associated with the physical entity.
1.3.6.1.4.1.9.9.138.1.4.4.1.3DisplayStringread-createcurrent
ceAlarmFilterAlarmsEnabled
OBJECT-TYPE
This object specifies a list of alarms that are enabled.
1.3.6.1.4.1.9.9.138.1.4.4.1.4AlarmListread-createcurrent
ceAlarmFilterNotifiesEnabled
OBJECT-TYPE
This object specifies a list of alarms for which notification generation is enabled.
1.3.6.1.4.1.9.9.138.1.4.4.1.5AlarmListread-createcurrent
ceAlarmFilterSyslogEnabled
OBJECT-TYPE
This object specifies a list of alarms for which syslog message generation is enabled.
1.3.6.1.4.1.9.9.138.1.4.4.1.6AlarmListread-createcurrent
ciscoEntityAlarmMIBNotificationsPrefix
OBJECT-IDENTITY
1.3.6.1.4.1.9.9.138.2
ciscoEntityAlarmMIBNotifications
OBJECT-IDENTITY
1.3.6.1.4.1.9.9.138.2.0
ciscoEntityAlarmMIBConformance
OBJECT-IDENTITY
1.3.6.1.4.1.9.9.138.3
ciscoEntityAlarmMIBCompliances
OBJECT-IDENTITY
1.3.6.1.4.1.9.9.138.3.1
ciscoEntityAlarmMIBGroups
OBJECT-IDENTITY
1.3.6.1.4.1.9.9.138.3.2

Notifications

NameOIDStatus
ceAlarmAsserted
NOTIFICATION-TYPE
The agent generates this trap when a physical entity asserts an alarm.
1.3.6.1.4.1.9.9.138.2.0.1current
ceAlarmCleared
NOTIFICATION-TYPE
The agent generates this trap when a physical entity clears a previously asserted alarm.
1.3.6.1.4.1.9.9.138.2.0.2current

Conformance

NameOIDStatus
ceAlarmMIBCompliance
MODULE-COMPLIANCE
The compliance statement for entities that implement the CISCO-ALARM-MIB. Implementation of this MIB module is strongly recommended for any platform targeted for a carrier-class environment.
1.3.6.1.4.1.9.9.138.3.1.1current
ceAlarmDescriptionGroup
OBJECT-GROUP
A collection of managed objects defining the description of alarms.
1.3.6.1.4.1.9.9.138.3.2.1current
ceAlarmGroup
OBJECT-GROUP
A collection of managed objects defining alarm reporting by physical entity.
1.3.6.1.4.1.9.9.138.3.2.2current
ceAlarmHistGroup
OBJECT-GROUP
A collection of managed objects defining alarm logging.
1.3.6.1.4.1.9.9.138.3.2.3current
ceAlarmFilterGroup
OBJECT-GROUP
A collection of managed objects that control the generation of all notifications and syslog messages.
1.3.6.1.4.1.9.9.138.3.2.4current
ceAlarmFilterProfileGroup
OBJECT-GROUP
A collection of managed objects that support alarm filtering.
1.3.6.1.4.1.9.9.138.3.2.5current