EZ5 MIB Catalog

CISCO-ENTITY-ALARM-MIB

1999-07-06

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).

Download CISCO-ENTITY-ALARM-MIB.txt Open CISCO-ENTITY-ALARM-MIB.txt in a new tab

SCALARS (9) · TABLES (5) · TRAPS (2)

Scalars (9)

NameOID
ceAlarmCriticalCount1.3.6.1.4.1.9.9.138.1.2.1
ceAlarmMajorCount1.3.6.1.4.1.9.9.138.1.2.2
ceAlarmMinorCount1.3.6.1.4.1.9.9.138.1.2.3
ceAlarmCutOff1.3.6.1.4.1.9.9.138.1.2.4
ceAlarmHistTableSize1.3.6.1.4.1.9.9.138.1.3.1
ceAlarmHistLastIndex1.3.6.1.4.1.9.9.138.1.3.2
ceAlarmNotifiesEnable1.3.6.1.4.1.9.9.138.1.4.1
ceAlarmSyslogEnable1.3.6.1.4.1.9.9.138.1.4.2
ceAlarmFilterProfileIndexNext1.3.6.1.4.1.9.9.138.1.4.3

Tables (5)

NameOID
ceAlarmDescrMapTable1.3.6.1.4.1.9.9.138.1.1.1
ceAlarmDescrTable1.3.6.1.4.1.9.9.138.1.1.2
ceAlarmTable1.3.6.1.4.1.9.9.138.1.2.5
ceAlarmHistTable1.3.6.1.4.1.9.9.138.1.3.3
ceAlarmFilterProfileTable1.3.6.1.4.1.9.9.138.1.4.4

Traps (2)

NameOID
ceAlarmAsserted1.3.6.1.4.1.9.9.138.2.0.1
ceAlarmCleared1.3.6.1.4.1.9.9.138.2.0.2

END OF TOC

Scalar details

ceAlarmCriticalCount

1.3.6.1.4.1.9.9.138.1.2.1

Gauge32

The value of this object specifies the number of alarms currently asserted with a severity of 'critical'.

ceAlarmMajorCount

1.3.6.1.4.1.9.9.138.1.2.2

Gauge32

The value of this object specifies the number of alarms currently asserted with a severity of 'major'.

ceAlarmMinorCount

1.3.6.1.4.1.9.9.138.1.2.3

Gauge32

The value of this object specifies the number of alarms currently asserted with a severity of 'minor'.

ceAlarmCutOff

1.3.6.1.4.1.9.9.138.1.2.4

TruthValue1 = true2 = falseRepresents a boolean value. · Integer32

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.

ceAlarmHistTableSize

1.3.6.1.4.1.9.9.138.1.3.1

INTEGER (0..500) · Integer32

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.

ceAlarmHistLastIndex

1.3.6.1.4.1.9.9.138.1.3.2

Unsigned32

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.

ceAlarmNotifiesEnable

1.3.6.1.4.1.9.9.138.1.4.1

AlarmSeverityOrZeroA value of either '0' or a valid alarm severity. (0..4) · Integer32

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.

ceAlarmSyslogEnable

1.3.6.1.4.1.9.9.138.1.4.2

AlarmSeverityOrZeroA value of either '0' or a valid alarm severity. (0..4) · Integer32

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.

ceAlarmFilterProfileIndexNext

1.3.6.1.4.1.9.9.138.1.4.3

AlarmFilterProfileTypeAn integer value that uniquely identifies an alarm filter profile. · Unsigned32

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.

Table details

ceAlarmDescrMapTable

1.3.6.1.4.1.9.9.138.1.1.1

Index: ceAlarmDescrIndex

For each type of entity (represented entPhysicalVendorType OID), this table contains a mapping between a unique ceAlarmDescrIndex and entPhysicalvendorType OID.

ceAlarmDescrIndex

1.3.6.1.4.1.9.9.138.1.1.1.1.1

Unsigned32

This object uniquely identifies an alarm description.

ceAlarmDescrVendorType

1.3.6.1.4.1.9.9.138.1.1.1.1.2

AutonomousTypeRepresents an independently extensible type identification value. It may, for example, indicate a particular sub-tree with further MIB definitions, or define a particular type of protocol or hardware. · OBJECT IDENTIFIER

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.

ceAlarmDescrTable

1.3.6.1.4.1.9.9.138.1.1.2

Index: ceAlarmDescrIndex · ceAlarmDescrAlarmType

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.

ceAlarmDescrAlarmType

1.3.6.1.4.1.9.9.138.1.1.2.1.1

AlarmTypeAn arbitrary integer value that uniquely identifies an event relative to a physical entity contained by a system. (0..255) · Integer32

This object specifies the alarm type being described.

ceAlarmDescrSeverity

1.3.6.1.4.1.9.9.138.1.1.2.1.2

AlarmSeverityOrZeroA value of either '0' or a valid alarm severity. (0..4) · Integer32

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.

ceAlarmDescrText

1.3.6.1.4.1.9.9.138.1.1.2.1.3

SnmpAdminStringAn octet string containing administrative information, preferably in human-readable form. To facilitate internationalization, this information is represented using the ISO/IEC IS 10646-1 character set, encoded as an octet string using the UTF-8 transformation format described in [RFC2279]. Since additional code points are added by amendments to the 10646 standard from time to time, implementations must be prepared to encounter any code point from 0x00000000 to 0x7fffffff. Byte sequences that do not correspond to the valid UTF-8 encoding of a code point or are outside this range are prohibited. The use of control codes should be avoided. When it is necessary to represent a newline, the control code sequence CR LF should be used. The use of leading or trailing white space should be avoided. For code points not directly supported by user interface hardware or software, an alternative means of entry and display, such as hexadecimal, may be provided. For information encoded in 7-bit US-ASCII, the UTF-8 encoding is identical to the US-ASCII encoding. UTF-8 may require multiple bytes to represent a single character / code point; thus the length of this object in octets may be different from the number of characters encoded. Similarly, size constraints refer to the number of encoded octets, not the number of characters represented by an encoding. Note that when this TC is used for an object that is used or envisioned to be used as an index, then a SIZE restriction MUST be specified so that the number of sub-identifiers for any object instance does not exceed the limit of 128, as defined by [RFC3416]. Note that the size of an SnmpAdminString object is measured in octets, not characters. SIZE (0..255) · OCTET STRING · hint 255t

This object specifies a human-readable message describing the alarm.

ceAlarmTable

1.3.6.1.4.1.9.9.138.1.2.5

Index: entPhysicalIndex

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.

from ENTITY-MIB

entPhysicalIndex

PhysicalIndexAn arbitrary value that uniquely identifies the physical entity. The value should be a small positive integer. Index values for different physical entities are not necessarily contiguous. (1..2147483647) · Integer32 · hint d

The index for this entry.

ceAlarmFilterProfile

1.3.6.1.4.1.9.9.138.1.2.5.1.1

AlarmFilterProfileTypeAn integer value that uniquely identifies an alarm filter profile. · Unsigned32

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.

ceAlarmSeverity

1.3.6.1.4.1.9.9.138.1.2.5.1.2

AlarmSeverityOrZeroA value of either '0' or a valid alarm severity. (0..4) · Integer32

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.

ceAlarmList

1.3.6.1.4.1.9.9.138.1.2.5.1.3

AlarmListFor 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. SIZE (0..32) · OCTET STRING

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.

ceAlarmHistTable

1.3.6.1.4.1.9.9.138.1.3.3

Index: ceAlarmHistIndex

This table contains a history of ceAlarmIndicate and ceAlarmClear traps generated by the agent.

ceAlarmHistIndex

1.3.6.1.4.1.9.9.138.1.3.3.1.1

Unsigned32

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.

ceAlarmHistType

1.3.6.1.4.1.9.9.138.1.3.3.1.2

INTEGER1 = asserted2 = cleared · Integer32

This object specifies whether the agent created the entry as the result of an alarm being asserted or cleared.

ceAlarmHistEntPhysicalIndex

1.3.6.1.4.1.9.9.138.1.3.3.1.3

PhysicalIndexAn arbitrary value that uniquely identifies the physical entity. The value should be a small positive integer. Index values for different physical entities are not necessarily contiguous. (1..2147483647) · Integer32 · hint d

This object specifies the physical entity that generated the alarm.

ceAlarmHistAlarmType

1.3.6.1.4.1.9.9.138.1.3.3.1.4

AlarmTypeAn arbitrary integer value that uniquely identifies an event relative to a physical entity contained by a system. (0..255) · Integer32

This object specifies the type of alarm generated.

ceAlarmHistSeverity

1.3.6.1.4.1.9.9.138.1.3.3.1.5

AlarmSeverity1 = critical2 = major3 = minor4 = infoEach 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.Reference: Bellcore Technical Reference TR-NWT-000474 Issue 4, December 1993, OTGR Section 4. Network Maintenance: Alarm and Control - Network Element. · Integer32

This object specifies the severity of the alarm generated.

ceAlarmHistTimeStamp

1.3.6.1.4.1.9.9.138.1.3.3.1.6

TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks

This object specifies the value of the sysUpTime object at the time the alarm was generated.

ceAlarmFilterProfileTable

1.3.6.1.4.1.9.9.138.1.4.4

Index: ceAlarmFilterIndex

This table contains a list of alarm filter profiles.

ceAlarmFilterIndex

1.3.6.1.4.1.9.9.138.1.4.4.1.1

AlarmFilterProfileTypeAn integer value that uniquely identifies an alarm filter profile. · Unsigned32

This object uniquely identifies the alarm filter profile.

ceAlarmFilterStatus

1.3.6.1.4.1.9.9.138.1.4.4.1.2

RowStatus1 = active2 = notInService3 = notReady4 = createAndGo5 = createAndWait6 = destroyThe RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of [2].) The status column has six defined values: - `active', which indicates that the conceptual row is available for use by the managed device; - `notInService', 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; - `notReady', which indicates that the conceptual row exists in the agent, but is missing information necessary in order to be available for use by the managed device (i.e., one or more required columns in the conceptual row have not been instanciated); - `createAndGo', which is supplied by a management station wishing to create a new instance of a conceptual row and to have its status automatically set to active, making it available for use by the managed device; - `createAndWait', 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); and, - `destroy', which is supplied by a management station wishing to delete all of the instances associated with an existing conceptual row. Whereas five of the six values (all except `notReady') may be specified in a management protocol set operation, only three values will be returned in response to a management protocol retrieval operation: `notReady', `notInService' or `active'. That is, when queried, an existing conceptual row has only three states: it is either available for use by the managed device (the status column has value `active'); it is not available for use by the managed device, though the agent has sufficient information to attempt to make it so (the status column has value `notInService'); or, it is not available for use by the managed device, and an attempt to make it so would fail because the agent has insufficient information (the state column has value `notReady'). NOTE WELL This textual convention may be used for a MIB table, irrespective of whether the values of that table's conceptual rows are able to be modified while it is active, or whether its conceptual rows must be taken out of service in order to be modified. That is, it is the responsibility of the DESCRIPTION clause of the status column to specify whether the status column must not be `active' in order for the value of some other column of the same conceptual row to be modified. If such a specification is made, affected columns may be changed by an SNMP set PDU if the RowStatus would not be equal to `active' either immediately before or after processing the PDU. In other words, if the PDU also contained a varbind that would change the RowStatus value, the column in question may be changed if the RowStatus was not equal to `active' as the PDU was received, or if the varbind sets the status to a value other than 'active'. Also note that whenever any elements of a row exist, the RowStatus column must also exist. To summarize the effect of having a conceptual row with a status column having a SYNTAX clause value of RowStatus, consider the following state diagram: STATE +--------------+-----------+-------------+------------- | A | B | C | D | |status col.|status column| |status column | is | is |status column ACTION |does not exist| notReady | notInService| is active --------------+--------------+-----------+-------------+------------- set status |noError ->D|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndGo |inconsistent- | | | | Value| | | --------------+--------------+-----------+-------------+------------- set status |noError see 1|inconsist- |inconsistent-|inconsistent- column to | or | entValue| Value| Value createAndWait |wrongValue | | | --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError column to | Value| entValue| | active | | | | | | or | | | | | | | |see 2 ->D|see 8 ->D| ->D --------------+--------------+-----------+-------------+------------- set status |inconsistent- |inconsist- |noError |noError ->C column to | Value| entValue| | notInService | | | | | | or | | or | | | | | |see 3 ->C| ->C|see 6 --------------+--------------+-----------+-------------+------------- set status |noError |noError |noError |noError ->A column to | | | | or destroy | ->A| ->A| ->A|see 7 --------------+--------------+-----------+-------------+------------- set any other |see 4 |noError |noError |see 5 column to some| | | | value | | see 1| ->C| ->D --------------+--------------+-----------+-------------+------------- (1) goto B or C, depending on information available to the agent. (2) if other variable bindings included in the same PDU, provide values for all columns which are missing but required, and all columns have acceptable values, then return noError and goto D. (3) if other variable bindings included in the same PDU, provide legal values for all columns which are missing but required, then return noError and goto C. (4) at the discretion of the agent, the return value may be either: inconsistentName: because the agent does not choose to create such an instance when the corresponding RowStatus instance does not exist, or inconsistentValue: if the supplied value is inconsistent with the state of some other MIB object's value, or noError: because the agent chooses to create the instance. If noError is returned, then the instance of the status column must also be created, and the new state is B or C, depending on the information available to the agent. If inconsistentName or inconsistentValue is returned, the row remains in state A. (5) depending on the MIB definition for the column/table, either noError or inconsistentValue may be returned. (6) the return value can indicate one of the following errors: wrongValue: because the agent does not support notInService (e.g., an agent which does not support createAndWait), or inconsistentValue: because the agent is unable to take the row out of service at this time, perhaps because it is in use and cannot be de-activated. (7) the return value can indicate the following error: inconsistentValue: because the agent is unable to remove the row at this time, perhaps because it is in use and cannot be de-activated. (8) the transition to D can fail, e.g., if the values of the conceptual row are inconsistent, then the error code would be inconsistentValue. NOTE: Other processing of (this and other varbinds of) the set request may result in a response other than noError being returned, e.g., wrongValue, noCreation, etc. Conceptual Row Creation There are four potential interactions when creating a conceptual row: selecting an instance-identifier which is not in use; creating the conceptual row; initializing any objects for which the agent does not supply a default; and, making the conceptual row available for use by the managed device. Interaction 1: Selecting an Instance-Identifier The algorithm used to select an instance-identifier varies for each conceptual row. In some cases, the instance- identifier is semantically significant, e.g., the destination address of a route, and a management station selects the instance-identifier according to the semantics. In other cases, the instance-identifier is used solely to distinguish conceptual rows, and a management station without specific knowledge of the conceptual row might examine the instances present in order to determine an unused instance-identifier. (This approach may be used, but it is often highly sub-optimal; however, it is also a questionable practice for a naive management station to attempt conceptual row creation.) Alternately, the MIB module which defines the conceptual row might provide one or more objects which provide assistance in determining an unused instance-identifier. For example, if the conceptual row is indexed by an integer-value, then an object having an integer-valued SYNTAX clause might be defined for such a purpose, allowing a management station to issue a management protocol retrieval operation. In order to avoid unnecessary collisions between competing management stations, `adjacent' retrievals of this object should be different. Finally, the management station could select a pseudo-random number to use as the index. In the event that this index was already in use and an inconsistentValue was returned in response to the management protocol set operation, the management station should simply select a new pseudo-random number and retry the operation. A MIB designer should choose between the two latter algorithms based on the size of the table (and therefore the efficiency of each algorithm). For tables in which a large number of entries are expected, it is recommended that a MIB object be defined that returns an acceptable index for creation. For tables with small numbers of entries, it is recommended that the latter pseudo-random index mechanism be used. Interaction 2: Creating the Conceptual Row Once an unused instance-identifier has been selected, the management station determines if it wishes to create and activate the conceptual row in one transaction or in a negotiated set of interactions. Interaction 2a: Creating and Activating the Conceptual Row The management station must first determine the column requirements, i.e., it must determine those columns for which it must or must not provide values. Depending on the complexity of the table and the management station's knowledge of the agent's capabilities, this determination can be made locally by the management station. Alternately, the management station issues a management protocol get operation to examine all columns in the conceptual row that it wishes to create. In response, for each column, there are three possible outcomes: - a value is returned, indicating that some other management station has already created this conceptual row. We return to interaction 1. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it should supply a value for this column when the conceptual row is to be created. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. Once the column requirements have been determined, a management protocol set operation is accordingly issued. This operation also sets the new instance of the status column to `createAndGo'. When the agent processes the set operation, it verifies that it has sufficient information to make the conceptual row available for use by the managed device. The information available to the agent is provided by two sources: the management protocol set operation which creates the conceptual row, and, implementation-specific defaults supplied by the agent (note that an agent must provide implementation-specific defaults for at least those objects which it implements as read-only). If there is sufficient information available, then the conceptual row is created, a `noError' response is returned, the status column is set to `active', and no further interactions are necessary (i.e., interactions 3 and 4 are skipped). If there is insufficient information, then the conceptual row is not created, and the set operation fails with an error of `inconsistentValue'. On this error, the management station can issue a management protocol retrieval operation to determine if this was because it failed to specify a value for a required column, or, because the selected instance of the status column already existed. In the latter case, we return to interaction 1. In the former case, the management station can re-issue the set operation with the additional information, or begin interaction 2 again using `createAndWait' in order to negotiate creation of the conceptual row. NOTE WELL Regardless of the method used to determine the column requirements, it is possible that the management station might deem a column necessary when, in fact, the agent will not allow that particular columnar instance to be created or written. In this case, the management protocol set operation will fail with an error such as `noCreation' or `notWritable'. In this case, the management station decides whether it needs to be able to set a value for that particular columnar instance. If not, the management station re-issues the management protocol set operation, but without setting a value for that particular columnar instance; otherwise, the management station aborts the row creation algorithm. Interaction 2b: Negotiating the Creation of the Conceptual Row The management station issues a management protocol set operation which sets the desired instance of the status column to `createAndWait'. If the agent is unwilling to process a request of this sort, the set operation fails with an error of `wrongValue'. (As a consequence, such an agent must be prepared to accept a single management protocol set operation, i.e., interaction 2a above, containing all of the columns indicated by its column requirements.) Otherwise, the conceptual row is created, a `noError' response is returned, and the status column is immediately set to either `notInService' or `notReady', depending on whether it has sufficient information to (attempt to) make the conceptual row available for use by the managed device. If there is sufficient information available, then the status column is set to `notInService'; otherwise, if there is insufficient information, then the status column is set to `notReady'. Regardless, we proceed to interaction 3. Interaction 3: Initializing non-defaulted Objects The management station must now determine the column requirements. It issues a management protocol get operation to examine all columns in the created conceptual row. In the response, for each column, there are three possible outcomes: - a value is returned, indicating that the agent implements the object-type associated with this column and had sufficient information to provide a value. For those columns to which the agent provides read-create access (and for which the agent allows their values to be changed after their creation), a value return tells the management station that it may issue additional management protocol set operations, if it desires, in order to change the value associated with this column. - the exception `noSuchInstance' is returned, indicating that the agent implements the object-type associated with this column, and that this column in at least one conceptual row would be accessible in the MIB view used by the retrieval were it to exist. However, the agent does not have sufficient information to provide a value, and until a value is provided, the conceptual row may not be made available for use by the managed device. For those columns to which the agent provides read-create access, the `noSuchInstance' exception tells the management station that it must issue additional management protocol set operations, in order to provide a value associated with this column. - the exception `noSuchObject' is returned, indicating that the agent does not implement the object-type associated with this column or that there is no conceptual row for which this column would be accessible in the MIB view used by the retrieval. As such, the management station can not issue any management protocol set operations to create an instance of this column. If the value associated with the status column is `notReady', then the management station must first deal with all `noSuchInstance' columns, if any. Having done so, the value of the status column becomes `notInService', and we proceed to interaction 4. Interaction 4: Making the Conceptual Row Available Once the management station is satisfied with the values associated with the columns of the conceptual row, it issues a management protocol set operation to set the status column to `active'. If the agent has sufficient information to make the conceptual row available for use by the managed device, the management protocol set operation succeeds (a `noError' response is returned). Otherwise, the management protocol set operation fails with an error of `inconsistentValue'. NOTE WELL A conceptual row having a status column with value `notInService' or `notReady' is unavailable to the managed device. As such, it is possible for the managed device to create its own instances during the time between the management protocol set operation which sets the status column to `createAndWait' and the management protocol set operation which sets the status column to `active'. In this case, when the management protocol set operation is issued to set the status column to `active', the values held in the agent supersede those used by the managed device. If the management station is prevented from setting the status column to `active' (e.g., due to management station or network failure) the conceptual row will be left in the `notInService' or `notReady' state, consuming resources indefinitely. The agent must detect conceptual rows that have been in either state for an abnormally long period of time and remove them. It is the responsibility of the DESCRIPTION clause of the status column to indicate what an abnormally long period of time would be. This period of time should be long enough to allow for human response time (including `think time') between the creation of the conceptual row and the setting of the status to `active'. In the absence of such information in the DESCRIPTION clause, it is suggested that this period be approximately 5 minutes in length. This removal action applies not only to newly-created rows, but also to previously active rows which are set to, and left in, the notInService state for a prolonged period exceeding that which is considered normal for such a conceptual row. Conceptual Row Suspension When a conceptual row is `active', the management station may issue a management protocol set operation which sets the instance of the status column to `notInService'. If the agent is unwilling to do so, the set operation fails with an error of `wrongValue' or `inconsistentValue'. Otherwise, the conceptual row is taken out of service, and a `noError' response is returned. It is the responsibility of the DESCRIPTION clause of the status column to indicate under what circumstances the status column should be taken out of service (e.g., in order for the value of some other column of the same conceptual row to be modified). Conceptual Row Deletion For deletion of conceptual rows, a management protocol set operation is issued which sets the instance of the status column to `destroy'. This request may be made regardless of the current value of the status column (e.g., it is possible to delete conceptual rows which are either `notReady', `notInService' or `active'.) If the operation succeeds, then all instances associated with the conceptual row are immediately removed. · Integer32

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.

ceAlarmFilterAlias

1.3.6.1.4.1.9.9.138.1.4.4.1.3

DisplayStringRepresents textual information taken from the NVT ASCII character set, as defined in pages 4, 10-11 of RFC 854. To summarize RFC 854, the NVT ASCII repertoire specifies: - the use of character codes 0-127 (decimal) - the graphics characters (32-126) are interpreted as US ASCII - NUL, LF, CR, BEL, BS, HT, VT and FF have the special meanings specified in RFC 854 - the other 25 codes have no standard interpretation - the sequence 'CR LF' means newline - the sequence 'CR NUL' means carriage-return - an 'LF' not preceded by a 'CR' means moving to the same column on the next line. - the sequence 'CR x' for any x other than LF or NUL is illegal. (Note that this also means that a string may end with either 'CR LF' or 'CR NUL', but not with CR.) Any object defined using this syntax may not exceed 255 characters in length. SIZE (0..255) · OCTET STRING · hint 255a

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.

ceAlarmFilterAlarmsEnabled

1.3.6.1.4.1.9.9.138.1.4.4.1.4

AlarmListFor 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. SIZE (0..32) · OCTET STRING

This object specifies a list of alarms that are enabled.

ceAlarmFilterNotifiesEnabled

1.3.6.1.4.1.9.9.138.1.4.4.1.5

AlarmListFor 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. SIZE (0..32) · OCTET STRING

This object specifies a list of alarms for which notification generation is enabled.

ceAlarmFilterSyslogEnabled

1.3.6.1.4.1.9.9.138.1.4.4.1.6

AlarmListFor 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. SIZE (0..32) · OCTET STRING

This object specifies a list of alarms for which syslog message generation is enabled.

Trap details

ceAlarmAsserted

1.3.6.1.4.1.9.9.138.2.0.1

The agent generates this trap when a physical entity asserts an alarm.

ceAlarmHistEntPhysicalIndex

1.3.6.1.4.1.9.9.138.1.3.3.1.3

PhysicalIndexAn arbitrary value that uniquely identifies the physical entity. The value should be a small positive integer. Index values for different physical entities are not necessarily contiguous. (1..2147483647) · Integer32 · hint d

This object specifies the physical entity that generated the alarm.

ceAlarmHistAlarmType

1.3.6.1.4.1.9.9.138.1.3.3.1.4

AlarmTypeAn arbitrary integer value that uniquely identifies an event relative to a physical entity contained by a system. (0..255) · Integer32

This object specifies the type of alarm generated.

ceAlarmHistSeverity

1.3.6.1.4.1.9.9.138.1.3.3.1.5

AlarmSeverity1 = critical2 = major3 = minor4 = infoEach 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.Reference: Bellcore Technical Reference TR-NWT-000474 Issue 4, December 1993, OTGR Section 4. Network Maintenance: Alarm and Control - Network Element. · Integer32

This object specifies the severity of the alarm generated.

ceAlarmHistTimeStamp

1.3.6.1.4.1.9.9.138.1.3.3.1.6

TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks

This object specifies the value of the sysUpTime object at the time the alarm was generated.

ceAlarmCleared

1.3.6.1.4.1.9.9.138.2.0.2

The agent generates this trap when a physical entity clears a previously asserted alarm.

ceAlarmHistEntPhysicalIndex

1.3.6.1.4.1.9.9.138.1.3.3.1.3

PhysicalIndexAn arbitrary value that uniquely identifies the physical entity. The value should be a small positive integer. Index values for different physical entities are not necessarily contiguous. (1..2147483647) · Integer32 · hint d

This object specifies the physical entity that generated the alarm.

ceAlarmHistAlarmType

1.3.6.1.4.1.9.9.138.1.3.3.1.4

AlarmTypeAn arbitrary integer value that uniquely identifies an event relative to a physical entity contained by a system. (0..255) · Integer32

This object specifies the type of alarm generated.

ceAlarmHistSeverity

1.3.6.1.4.1.9.9.138.1.3.3.1.5

AlarmSeverity1 = critical2 = major3 = minor4 = infoEach 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.Reference: Bellcore Technical Reference TR-NWT-000474 Issue 4, December 1993, OTGR Section 4. Network Maintenance: Alarm and Control - Network Element. · Integer32

This object specifies the severity of the alarm generated.

ceAlarmHistTimeStamp

1.3.6.1.4.1.9.9.138.1.3.3.1.6

TimeStampThe value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset to zero as a result of a re- initialization of the network management (sub)system, then the values of all TimeStamp objects are also reset. However, after approximately 497 days without a re- initialization, the sysUpTime object will reach 2^^32-1 and then increment around to zero; in this case, existing values of TimeStamp objects do not change. This can lead to ambiguities in the value of TimeStamp objects. · TimeTicks

This object specifies the value of the sysUpTime object at the time the alarm was generated.

↑ To TOC