Connected: An Internet Encyclopedia
3.2. The Event Group
Up:
Connected: An Internet Encyclopedia
Up:
Requests For Comments
Up:
RFC 1451
Up:
3. Definitions
Prev: 3.1.1. Alarm-Related Notifications
Next: 3.3. Conformance Information
3.2. The Event Group
3.2. The Event Group
-- the event group
--
-- a collection of objects allowing the description and
-- configuration of events from a SNMPv2 entity acting
-- in a dual role.
snmpEvent OBJECT IDENTIFIER ::= { snmpM2MObjects 2 }
-- The snmpEvent table defines the set of events generated on
-- a SNMPv2 entity acting in a dual role. Each entry in the
-- snmpEventTable associates an event type with the
-- notification method and associated parameters. Some
-- snmpEvent entries are fired by an associated condition in
-- the snmpAlarmTable. Others are fired on behalf of
-- conditions defined in the NOTIFICATION-TYPE macro. The
-- snmpNotificationTable defines notifications that should
-- occur when an associated event is fired.
snmpEventNextIndex OBJECT-TYPE
SYNTAX INTEGER (0..65535)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The index number of the next appropriate
unassigned entry in the snmpEventTable. The value
0 indicates that no unassigned entries are
available.
A management station should create new entries in
the snmpEventTable using this algorithm: first,
issue a management protocol retrieval operation to
determine the value of snmpEventNextIndex; and,
second, issue a management protocol set operation
to create an instance of the snmpEventStatus
object setting its value to `createAndWait' or
'createAndGo'."
::= { snmpEvent 1 }
snmpEventTable OBJECT-TYPE
SYNTAX SEQUENCE OF SnmpEventEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A list of events."
::= { snmpEvent 2 }
snmpEventEntry OBJECT-TYPE
SYNTAX SnmpEventEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A set of parameters that describe an event that
is generated when certain conditions are met."
INDEX { snmpEventIndex }
::= { snmpEventTable 1 }
SnmpEventEntry ::= SEQUENCE {
snmpEventIndex INTEGER,
snmpEventID OBJECT IDENTIFIER,
snmpEventDescription DisplayString,
snmpEventEvents Counter32,
snmpEventLastTimeSent TimeStamp,
snmpEventStatus RowStatus
}
snmpEventIndex OBJECT-TYPE
SYNTAX INTEGER (1..65535)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An index that uniquely identifies an entry in the
snmpEvent table. Each such entry defines an event
generated when the appropriate conditions occur."
::= { snmpEventEntry 1 }
snmpEventID OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The authoritative identification of the event
type generated by this entry. This variable
occurs as the second varbind of an InformRequest-
PDU. If this OBJECT IDENTIFIER maps to a
NOTIFICATION-TYPE the sender will place the
objects listed in the NOTIFICATION-TYPE in the
varbind list."
::= { snmpEventEntry 2 }
snmpEventDescription OBJECT-TYPE
SYNTAX DisplayString (SIZE (0..127))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"A comment describing this snmpEvent entry."
::= { snmpEventEntry 3 }
snmpEventEvents OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of events caused by event generators
associated with this snmpEvent entry."
::= { snmpEventEntry 4 }
snmpEventLastTimeSent OBJECT-TYPE
SYNTAX TimeStamp
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of sysUpTime at the time this snmpEvent
entry last generated an event. If this entry has
not generated any events, this value will be
zero."
DEFVAL { 0 }
::= { snmpEventEntry 5 }
snmpEventStatus OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The status of this snmpEvent entry. This object
may not be set to `active' unless the following
columnar objects exist in this row: snmpEventID,
snmpEventDescription, snmpEventEvents, and
snmpEventLastTimeSent.
Setting an instance of this object to the value
'destroy' has the effect of invalidating any/all
entries in the snmpEventTable, and the
snmpEventNotifyTable which reference the
corresponding snmpEventEntry."
::= { snmpEventEntry 6 }
snmpEventNotifyMinInterval OBJECT-TYPE
SYNTAX Integer32
UNITS "seconds"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The minimum interval that the SNMPv2 entity
acting in a dual role will wait before
retransmitting an InformRequest-PDU. This object
specifies the minimal value supported by the
SNMPv2 entity acting in a dual role, based on
resource or implementation constraints.
For a particular entry in the
snmpEventNotifyTable, if the associated
snmpEventNotifyIntervalRequested variable is
greater than this object, the
snmpEventNotifyIntervalRequested value shall be
used as the minimum interval for retransmissions
of InformRequest-PDUs sent on behalf of that
entry."
::= { snmpEvent 3 }
snmpEventNotifyMaxRetransmissions OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The maximum number of time that the SNMPv2 entity
acting in a dual role will retransmit an
InformRequest-PDU. This object specifies the
maximal value supported by the SNMPv2 entity
acting in a dual role, based on resource or
implementation constraints.
For a particular entry in the
snmpEventNotifyTable, if the associated
snmpEventNotifyRetransmissionsRequested variable
is less than this object, the
snmpEventNotifyRetransmissionsRequested value
shall be used as the retransmission count for
InformRequest-PDUs sent on behalf of that entry."
::= { snmpEvent 4 }
-- The snmpEventNotifyTable is used to configure the
-- destination and type of notifications sent by a SNMPv2
-- entity acting in a manager role when a particular event
-- is triggered.
snmpEventNotifyTable OBJECT-TYPE
SYNTAX SEQUENCE OF SnmpEventNotifyEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A list of protocol configuration entries for
event notifications from this entity."
::= { snmpEvent 5 }
snmpEventNotifyEntry OBJECT-TYPE
SYNTAX SnmpEventNotifyEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A set of parameters that describe the type and
destination of InformRequest-PDUs sent for a
particular event. The snmpEventIndex in this
entry's INDEX clause identifies the snmpEventEntry
which, when triggered, will generate a
notification as configured in this entry. The
contextIdentity in this entry's INDEX clause
identifies the context to which a notification
will be sent."
INDEX { snmpEventIndex, contextIdentity }
::= { snmpEventNotifyTable 1 }
SnmpEventNotifyEntry ::= SEQUENCE {
snmpEventNotifyIntervalRequested Integer32,
snmpEventNotifyRetransmissionsRequested Integer32,
snmpEventNotifyLifetime Integer32,
snmpEventNotifyStatus RowStatus
}
snmpEventNotifyIntervalRequested OBJECT-TYPE
SYNTAX Integer32
UNITS "seconds"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The requested interval for retransmission of
Inform PDUs generated on the behalf of this entry.
This variable will be the actual interval used
unless the snmpEventNotifyMinInterval is greater
than this object, in which case the interval shall
be equal to snmpEventNotifyMinInterval."
DEFVAL { 30 }
::= { snmpEventNotifyEntry 1 }
snmpEventNotifyRetransmissionsRequested OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The requested number of retransmissions of an
InformRequest-PDU generated on behalf of this
entry.
This variable will be the actual number of
retransmissions used unless the
snmpEventNotifyMaxRetransmissions is less than
this object, in which case the retransmission
count shall be equal to
snmpEventNotifyMaxRetransmissions."
DEFVAL { 5 }
::= { snmpEventNotifyEntry 2 }
snmpEventNotifyLifetime OBJECT-TYPE
SYNTAX Integer32
UNITS "seconds"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The number of seconds this entry shall live until
the corresponding instance of
snmpEventNotifyStatus is set to 'destroy'. This
value shall count down to zero, at which time the
corresponding instance of snmpEventNotifyStatus
will be set to 'destroy'. Any management station
that is using this entry must periodically refresh
this value to ensure the continued delivery of
events."
DEFVAL { 86400 }
::= { snmpEventNotifyEntry 3 }
snmpEventNotifyStatus OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The state of this snmpEventNotifyEntry. This
object may not be set to `active' unless the
following columnar objects exist in this row:
snmpEventNotifyIntervalRequested,
snmpEventNotifyRetransmissionsRequested, and
snmpEventNotifyLifetime."
::= { snmpEventNotifyEntry 4 }
Next: 3.3. Conformance Information
Connected: An Internet Encyclopedia
3.2. The Event Group