PKTC-EVENT-MIB
File:
PKTC-EVENT-MIB.mib (43619 bytes)
Imported modules
Imported symbols
Defined Types
SyslogSeverityMask |
|
This textual convention represents a bit mask representing
the severity of the events that can be generated by an MTA.
It corresponds to the various severity levels associated
with syslog messages, as specified in The syslog Protocol,
[RFCAAA].
emergency(0) - A condition that makes the system
unusable.
alert(1) - A service-affecting condition for which
immediate action must be taken.
critical(2) - A service-affecting critical condition.
error(3) - An error condition.
warning(4) - A warning condition.
notice(5) - A normal but significant condition.
info(6) - An informational message.
debug(7) - A debug message. |
TEXTUAL-CONVENTION |
|
|
|
|
BITS |
emergency(0), alert(1), critical(2), error(3), warning(4), notice(5), info(6), debug(7) |
|
PktcEventClassReportEntry |
|
SEQUENCE |
|
|
|
|
pktcEventClassIndex |
Unsigned32 |
|
|
pktcEventClassName |
SnmpAdminString |
|
|
pktcEventClassReportStatus |
TruthValue |
|
|
pktcEventClassSeverityLevel |
SyslogSeverityMask |
|
PktcEventDescrEntry |
|
SEQUENCE |
|
|
|
|
pktcEventDescrOrg |
Unsigned32 |
|
|
pktcEventDescrId |
Unsigned32 |
|
|
pktcEventDescrFacility |
INTEGER |
|
|
pktcEventDescrSeverityLevel |
SyslogSeverity |
|
|
pktcEventDescrReporting |
BITS |
|
|
pktcEventDescrText |
SnmpAdminString |
|
|
pktcEventDescrClass |
SnmpAdminString |
|
PktcEventLogEntry |
|
SEQUENCE |
|
|
|
|
pktcEventLogIndex |
Unsigned32 |
|
|
pktcEventLogTime |
DateAndTime |
|
|
pktcEventLogOrg |
Unsigned32 |
|
|
pktcEventLogId |
Unsigned32 |
|
|
pktcEventLogText |
SnmpAdminString |
|
|
pktcEventLogEndpointName |
SnmpAdminString |
|
|
pktcEventLogType |
BITS |
|
|
pktcEventLogTargetInfo |
SnmpAdminString |
|
|
pktcEventLogCorrelationId |
Unsigned32 |
|
|
pktcEventLogAdditionalInfo |
SnmpAdminString |
|
Defined Values
pktcEventMib |
1.3.6.1.2.1.1 |
This MIB module specifies the basic management objects
for managing events generated by the Multimedia
Terminal Adapter devices compliant with the PacketCable
and IPCablecom requirements.
Copyright (C) The IETF Trust (2007). This version
of this MIB module is part of RFC nnnn; see the RFC
itself for full legal notices. |
MODULE-IDENTITY |
|
|
|
pktcEventReset |
1.3.6.1.2.1.1.1.1.1 |
This MIB object allows a management station to
clear the local log of generated events, reset the
management event descriptions, or both.
MTAs generate management events. These events are stored
in the MIB table 'pktcEventLogTable'. If a management
station needs to clear all the current entries (e.g.,
after a troubleshooting operation is complete), it can
do so by setting the resetEvLogTable(0) bit to a value
of '1'.
The MTA is pre-configured with the events that it can
generate. This is stored in the MIB table
'pktcEventDescrTable'. This table also contains the
descriptions associated with these events. These
descriptions can be modified by a management station.
However, if the management station wishes to reset the
descriptions (to factory defaults), it can do so by
setting the resetEvDescrTable(1) bit to a value of '1'.
The MTA actions are summarized below:
Bit resetEvLogTable(0) set to a value of '1'
- delete all entries in pktcEventLogTable;
- reset the value of pktcEventLogIndex to '0'.
Bit resetEvDescrTable(1) set to a value of '1'
- reset the pktcEventDescrTable to the
factory default values.
Bits resetEvLogTable(0) and resetEvDescrTable(1)
set to a value of '1'
- perform the above actions as though they were
performed individually (in any order).
Setting a reset bit to a value of '0' MUST not
result in any action.
The MTA MUST perform the above actions regardless of
persistence (i.e. storage in non-volatile memory).
The MTA MUST always return a value of '00' when
this MIB Object is read. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
BITS |
resetEvLogTable(0), resetEvDescrTable(1) |
|
pktcEventSyslogCapabilities |
1.3.6.1.2.1.1.1.1.2.1 |
This MIB Object contains the MTA capabilities
for supporting the Syslog protocol.
The MTA is allowed to support two Syslog message
formats, the BSD syslog message formats specified
in RFC 3164 (formatBSDSyslog), and the IETF
syslog protocol per [RFCAAA] (formatSyslogProtocol).
The MTA MUST support formatBSDSyslog. The MTA
SHOULD support the IETF syslog standard.
BSD syslog protocol specifies UDP as the transport
protocol, and the IETF syslog protocol allows
for multiple transport protocols. This MIB module
supports two transport protocols: UDP and TLS (the
latter is only applicable when
formatSyslogProtocol(2) is supported).
The MTA MUST support UDP transport. The MTA MAY
support TLS for transport if it supports the IETF
syslog protocol.
The MTA MUST set the appropriate bits, based on
its implementation. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
BITS |
formatBSDSyslog(0), formatSyslogProtocol(1), transportUDP(2), transportTLS(3) |
|
pktcEventSyslogAddressType |
1.3.6.1.2.1.1.1.1.2.2 |
This MIB Object defines the Internet address type of
the syslog server specified by the MIB Object
'pktcEventSyslogAddress' . |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
InetAddressType |
|
|
pktcEventSyslogAddress |
1.3.6.1.2.1.1.1.1.2.3 |
This MIB Object contains the IP address of the
syslog server to which the MTA can transmit a syslog
message upon the generation of a management event.
If this MIB Object is set to a value other than
a routable unicast address ('0.0.0.0' or
255.255.255.255 for IPv4), the MTA MUST
suspend the transmission of Syslog messages.
The use of FQDNs is syntactically allowed, but
not recommended since a failure to resolve them in a
timely manner may leave the device without access to
the syslog daemon during critical network events.
The type of address this object represents is defined
by the MIB Object pktDevEvsyslogAddressType.
The format of the syslog message is specified by the
MIB Object 'pktcEventSyslogMsgFormat'. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
InetAddress |
|
|
pktcEventSyslogTransport |
1.3.6.1.2.1.1.1.1.2.4 |
This MIB Object specifies the transport to be
used to transmit syslog messages to the syslog
server contained in the MIB Object
'pktcEventSyslogAddress'.
Two possible transports are supported: UDP, and TLS.
If the MTA does not support TLS, then an SNMP SET
operation to set the value to tls(2) MUST result in
an 'inconsistentValue' response. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
INTEGER |
udp(1), tls(2) |
|
pktcEventSyslogPort |
1.3.6.1.2.1.1.1.1.2.5 |
This MIB Object contains the port number of the
syslog Server to which the syslog messages are to
be transmitted.
The MTA MUST use the specified value to transmit
to the syslog Server. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
InetPortNumber |
|
|
pktcEventClassReportTable |
1.3.6.1.2.1.1.1.1.3 |
This MIB table allows for management events that can be
generated by an MTA to be classified into categories,
or 'event classes'. For example, all the configuration
related events can be associated with an event class
titled 'configuration'. Such as a classification allows
for a management station to affect changes on a common
group of events, at once. Two operations are specified
on an event class: enabling or disabling of all the
events in an event class, and selective enabling or
disabling based on the severity level. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
PktcEventClassReportEntry |
|
pktcEventClassReportEntry |
1.3.6.1.2.1.1.1.1.3.1 |
Each entry in this table specifies an event class as
identified by the MTA manufacturer, based on the events
supported.
The MTA MUST create one entry (index=100) for the event
class titled 'generic'. This event class MUST contain
all the events that do not belong to a vendor specified
event class.
In the case of events belonging to multiple categories,
event classes with lower indices take priority over
others. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
PktcEventClassReportEntry |
|
|
pktcEventClassIndex |
1.3.6.1.2.1.1.1.1.3.1.1 |
This MIB Object is an index into the event
class table. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
1..100 |
|
pktcEventClassName |
1.3.6.1.2.1.1.1.1.3.1.2 |
This MIB Object contains the event class
name of an event class supported by the device.
Vendors MAY define different event classes
(e.g. DHCP, SNMP, DEBUG) to group together
management events of a particular category. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
SnmpAdminString |
Size(1..100) |
|
pktcEventClassReportStatus |
1.3.6.1.2.1.1.1.1.3.1.3 |
This MIB Object indicates if events belonging
to a particular event class are to be enabled
or disabled for event reporting.
Setting this object to a value of 'true' enables
reporting of all the events in the event class.
When enabled, the means of reporting is specified
by the MIB Object 'pktcEventDescrReporting'.
Setting this object to a value of 'false' disables
any reporting, irrespective of the value of the
MIB Object 'pktcEventDescrReporting' for a specific
event.
The default value of this MIB Object is vendor
specific. However, the vendor SHOULD enable all
event categories defined by PacketCable or
IPCableCom, by default. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
TruthValue |
|
|
pktcEventClassSeverityLevel |
1.3.6.1.2.1.1.1.1.3.1.4 |
This MIB Object defines the severity level
of events belonging to a specific event class,
that are enabled for event reporting.
This MIB Object has no effect on the event
reporting unless the MIB Object
'pktcEventClassReportStatus' is set to a value
of 'true', for the corresponding event class.
Setting a bit to a value of '1' implies that
events corresponding to that severity level MUST be
reported as defined by the corresponding
value of 'pktcEventDescrReporting' for events
in the event class.
Setting a bit to a value of '0' implies that
events corresponding to that level MUST NOT be
reported, irrespective of the corresponding
value of 'pktcEventDescrReporting' for events
in the event class.
It is recommended that the bits corresponding
to emergency(0), alert(1), critical(2) and error(3)
always be set to a value of '1'. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
SyslogSeverityMask |
|
|
pktcEventThrottleAdminStatus |
1.3.6.1.2.1.1.1.2.1 |
This MIB Object controls the throttling of the
transmitted messages upon generation of an event
(SNMP/syslog).
A value of unconstrained(1) causes event messages
to be transmitted without regard to the threshold
settings.
A value of maintainBelowThreshold(2) causes event
messages to be suppressed if the number of transmissions
would otherwise exceed the threshold.
A value of stopAtThreshold(3) causes event message
transmission to cease at the threshold, and not
resume until directed to do so.
A value of inhibited(4) causes all event message
Transmission to be suppressed.
An event causing both an SNMP and a syslog message
is still treated as a single event.
Writing to this object resets the thresholding state.
Refer to MIB Objects pktcEventThrottleThreshold and
pktcEventThrottleInterval for information on
throttling. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
INTEGER |
unconstrained(1), maintainBelowThreshold(2), stopAtThreshold(3), inhibited(4) |
|
pktcEventThrottleThreshold |
1.3.6.1.2.1.1.1.2.2 |
This MIB Object contains the number of events per
pktcEventThrottleInterval to be transmitted before
throttling.
An event causing both an SNMP and a syslog message is
still treated as a single event. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
pktcEventThrottleInterval |
1.3.6.1.2.1.1.1.2.3 |
This MIB Object contains the interval over which
the throttle threshold applies. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
pktcEventTransmissionStatus |
1.3.6.1.2.1.1.1.3.1 |
This MIB Object reflects the status of the event
transmissions.
If a bit corresponding to a state is set to a value
of:
'1', it indicates that the state is true
'0', it indicates that the state is false
'Event throttling' is based on thresholds and the
current setting of pktcEventThrottleAdminStatus.
'Server/Manager' indicators must be based on the
availability of valid syslog server/SNMP managers.
'Transmit Errors' must only be used in cases where the
MTA can identify unavailable servers. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
BITS |
syslogThrottled(0), snmpThrottled(1), validsyslogServerAbsent(2), validSnmpManagerAbsent(3), syslogTransmitError(4), snmpTransmitError(5) |
|
pktcEventDescrTable |
1.3.6.1.2.1.1.1.4.1 |
This MIB table contains all possible management events
that can be generated by the device. This includes
both PacketCable and IPCableCom defined, and
vendor-specific events. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
PktcEventDescrEntry |
|
pktcEventDescrEntry |
1.3.6.1.2.1.1.1.4.1.1 |
An entry in this table is created for each
event the MTA implementing this MIB is
capable of reporting. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
PktcEventDescrEntry |
|
|
pktcEventDescrOrg |
1.3.6.1.2.1.1.1.4.1.1.1 |
This MIB Object provides the IANA enterprise number of
the Organization defining the event. Thus, all
PacketCable or IPCableCom defined events will contain
the PacketCable or IPCableCom IANA enterprise
number and for vendor-specific events it will contain
the IANA enterprise number of the defining
organization. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
1..4294967295 |
|
pktcEventDescrId |
1.3.6.1.2.1.1.1.4.1.1.2 |
This MIB Object contains the event identifier for the
specific event to which the priority and display
strings belong. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
1..4294967295 |
|
pktcEventDescrFacility |
1.3.6.1.2.1.1.1.4.1.1.3 |
This MIB Object contains the facility
for the event.
For PacketCable, IPCableCom or ETSI events
this MUST be set to a value of local0(16). |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
SyslogFacility |
|
|
pktcEventDescrReporting |
1.3.6.1.2.1.1.1.4.1.1.5 |
This MIB Object defines the action to be taken on
occurrence of this event. Bit local(0) refers to local
logging of events, bit sylog(1) refers to the
transmission of events using syslog, bit snmpTrap(2)
refers to the transmission of events using SNMP Traps
(SNMPv2-Trap-PDU) and bit snmpInform(3)refers to the
transmission of events using SNMP INFORMs.
Setting a bit to a value of '1' indicates that the
corresponding action will be taken upon occurrence of
this event. If none of the bits are set then no action
is taken upon occurrence of the event. The success of
transmission using syslog and SNMP depends on the
MTA configuration. For example, a valid syslog server
address is required for syslog message transmission.
Specification of a management event does not necessarily
include the actions to be taken upon its generation,
i.e., it does not need to specify if a generated event
needs to be transmitted via SNMP, syslog or locally
stored.
Thus, certain default values of this MIB OBject is
are specified, based on the event's severity level
(refer to the MIB Object 'pktcEventDescrSeverityLevel'.)
If the severity level of an event is emergency(0),
alert(1), critical(2) or error(3), the MTA MUST set the
bits for local(0), syslog(1) and snmpInform(3) to a
value of '1', and the remaining bits to a value of '0'.
For an event with any other severity level the MTA MUST
set the bits for local(0) and syslog(1) to a value of
'1' and the rest of the bits to a value of '0'. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
BITS |
local(0), syslog(1), snmpTrap(2), snmpInform(3) |
|
pktcEventDescrText |
1.3.6.1.2.1.1.1.4.1.1.6 |
This MIB Object provides a human-readable description
of the event. |
Status: current |
Access: read-write |
OBJECT-TYPE |
|
|
|
|
SnmpAdminString |
Size(0..127) |
|
pktcEventDescrClass |
1.3.6.1.2.1.1.1.4.1.1.7 |
This MIB Object represents an event class
associated with the corresponding event.
See the MIB table 'pktcEventClassReportTable'
for a description of event classes and usage.
If the event is not categorized into a specific
vendor-specified event class, it will be
associated with the event class 'generic'. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
SnmpAdminString |
Size(1..100) |
|
pktcEventLogTable |
1.3.6.1.2.1.1.1.5.1 |
This MIB table contains a log of the events
generated by the MTA.
A description of all the events that can be
generated by the device can be obtained from the
MIB table 'pktcEventDescrTable'.
The contents of this table MAY persist in non-volatile
memory. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
SEQUENCE OF |
|
|
|
|
PktcEventLogEntry |
|
pktcEventLogEntry |
1.3.6.1.2.1.1.1.5.1.1 |
Each entry in this table describes an event that
has occurred, indexed in the chronological order of
generation. The details of the event are borrowed
from the parameters associated with the corresponding
event entry in 'pktcEventDescrTable', at the
time of the event generation.
While all entries created as such can be cleared using
the MIB Object pktcEventReset, the Event entries
themselves cannot be individually deleted. |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
PktcEventLogEntry |
|
|
pktcEventLogIndex |
1.3.6.1.2.1.1.1.5.1.1.1 |
This MIB Object provides relative ordering of the
objects in the event log.
This object will always increase except when
(a) the log is reset via pktcEventReset,
(b) the device reboots and does not implement
non-volatile storage for this log,
(c) it reaches the value 2^31.
In all the above, newer events will be stored starting
with an index value of '1' (cyclic rotation). |
Status: current |
Access: not-accessible |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
1..4294967295 |
|
pktcEventLogTime |
1.3.6.1.2.1.1.1.5.1.1.2 |
This MIB Object provides a human-readable description
of the time at which the event occurred. The actual time
used SHOULD be defined by the architecture using this
MIB definition. If unspecified, this MUST be the local
time. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
DateAndTime |
|
|
pktcEventLogOrg |
1.3.6.1.2.1.1.1.5.1.1.3 |
This MIB Object provides the IANA enterprise number of
the Organization defining the event. Thus, all
PacketCable or IPCableCom defined events will contain
the CableLabs or IPCableCom IANA enterprise number and
for vendor-specific events it will contain the IANA
enterprise number of the defining organization. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
1..4294967295 |
|
pktcEventLogId |
1.3.6.1.2.1.1.1.5.1.1.4 |
This MIB Object contains the event identifier for the
specific event to which the priority and display strings
belong. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
pktcEventLogText |
1.3.6.1.2.1.1.1.5.1.1.5 |
This MIB Object contains the contents of
the MIB Object 'pktcEventDescrText', corresponding
to the event, at the moment of generation. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
SnmpAdminString |
|
|
pktcEventLogEndpointName |
1.3.6.1.2.1.1.1.5.1.1.6 |
This MIB Object provides the endpoint identifier
followed by the PacketCable MTA's Fully Qualified
Domain Name (FQDN) and the IP Address (IP)
of the PacketCable MTA device.
This will be denoted as follows:
aaln/n:/, where 'n' is the Endpoint number.
or
/ if it is not specific to an endpoint. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
SnmpAdminString |
|
|
pktcEventLogType |
1.3.6.1.2.1.1.1.5.1.1.7 |
This MIB Object contains the kind of actions taken by
the MTA when the event occurred.
A bit with a value of '1' indicates the corresponding
action was taken. Setting it to a value of '0'
indicates that the corresponding action was not taken.
An event may trigger one or more actions (e.g.: syslog
and SNMP) or may remain as a local event since
transmissions could be disabled or inhibited as defined
by the Throttle MIB Objects. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
BITS |
local(0), syslog(1), trap(2), inform(3) |
|
pktcEventLogTargetInfo |
1.3.6.1.2.1.1.1.5.1.1.8 |
This MIB Object contains a comma separated list of the
actions taken for external notifications, along with the
target IP address for the generated events. Locally
stored events must not be recorded in this MIB Object.
The syntax is as:
,,
Where is to be denoted as follows:
For syslog events:
syslog/
For SNMP traps:
snmpTrap/
For SNMP INFORMS:
snmpInform/
If there are multiple targets for the same type (SNMP
Traps sent to multiple IP addresses) or if there are
multiple messages sent to the same IP (syslog and SNMP
sent to the same IP address) they need to be reported
individually. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
SnmpAdminString |
|
|
pktcEventLogCorrelationId |
1.3.6.1.2.1.1.1.5.1.1.9 |
This MIB Object contains the correlation ID
generated by the MTA during the initiation of the
last provisioning flow, within or following which
the event occurred.
Although a Correlation-ID, once generated after MTA
reset, does not change until next MTA reset, the
value of this object will differ for the events
preserved across MTA resets in case of a persistent
pktcEventLogTable.
For more information on the generation of correlation
ids, refer to the corresponding PacketCable/IPCableCom
Device Provisioning specifications. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
Unsigned32 |
|
|
pktcEventLogAdditionalInfo |
1.3.6.1.2.1.1.1.5.1.1.10 |
This MIB Object contains additional, useful
information in relation to the corresponding event that
an MTA might wish to report (for example: parameterized
data or debugging information). The format is
vendor-specific.
If MTA cannot provide any additional information for
the particular event generated, it MUST populate this
MIB Object with a string of zero-length. |
Status: current |
Access: read-only |
OBJECT-TYPE |
|
|
|
|
SnmpAdminString |
|
|
pktcEventTrap |
1.3.6.1.2.1.1.0.2 |
This Notification MIB Objects contains the SNMP Trap
(SNMPv2-Trap-PDU) contents for event reporting.
It contains the event log time, the organization
ID, the event identifier, the endpoint identifier,
the correlation id, and the MTA MAC address. |
Status: current |
Access: read-only |
NOTIFICATION-TYPE |
|
|
|
pktcEventBasicCompliance |
1.3.6.1.2.1.1.2.1.3 |
The compliance statement for devices that implement
Event reporting feature. |
Status: current |
Access: read-only |
MODULE-COMPLIANCE |
|
|
|
pktcEventGroup |
1.3.6.1.2.1.1.2.2.1 |
Group of MIB objects for PacketCable Management Event
MIB. |
Status: current |
Access: read-only |
OBJECT-GROUP |
|
|
|
pktcEventNotificationGroup |
1.3.6.1.2.1.1.2.2.2 |
Group of MIB objects for notifications related to
change in status of the MTA Device. |
Status: current |
Access: read-only |
NOTIFICATION-GROUP |
|
|
|