RFC 2021
Remote Network Monitoring Management Information Base Version 2 using SMIv2
6. Definitions RMON2-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Counter32, Integer32, Gauge32, IpAddress, TimeTicks FROM SNMPv2-SMI TEXTUAL-CONVENTION, RowStatus, DisplayString, TimeStamp FROM SNMPv2-TC MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF mib-2, ifIndex FROM RFC1213-MIB OwnerString, statistics, history, hosts, matrix, filter, etherStatsEntry, historyControlEntry, hostControlEntry, matrixControlEntry, filterEntry, channelEntry FROM RMON-MIB tokenRing, tokenRingMLStatsEntry, tokenRingPStatsEntry, ringStationControlEntry, sourceRoutingStatsEntry FROM TOKEN-RING-RMON-MIB; -- Remote Network Monitoring MIB rmon MODULE-IDENTITY LAST-UPDATED "9605270000Z" ORGANIZATION "IETF RMON MIB Working Group" CONTACT-INFO "Steve Waldbusser (WG Editor) Postal: International Network Services 650 Castro Street, Suite 260 Mountain View, CA 94041 Phone: +1 415 254 4251 Email: waldbusser@ins.com Andy Bierman (WG Chair) Phone: +1 805 648 2028 Email: abierman@west.net" DESCRIPTION "The MIB module for managing remote monitoring device implementations. This MIB module augments the original RMON MIB as specified in RFC 1757." ::= { mib-2 16 } -- { rmon 1 } through { rmon 10 } are defined in RMON and -- the Token Ring RMON MIB [RFC 1513]
protocolDir OBJECT IDENTIFIER ::= { rmon 11 }
protocolDist OBJECT IDENTIFIER ::= { rmon 12 }
addressMap OBJECT IDENTIFIER ::= { rmon 13 }
nlHost OBJECT IDENTIFIER ::= { rmon 14 }
nlMatrix OBJECT IDENTIFIER ::= { rmon 15 }
alHost OBJECT IDENTIFIER ::= { rmon 16 }
alMatrix OBJECT IDENTIFIER ::= { rmon 17 }
usrHistory OBJECT IDENTIFIER ::= { rmon 18 }
probeConfig OBJECT IDENTIFIER ::= { rmon 19 }
rmonConformance OBJECT IDENTIFIER ::= { rmon 20 }
-- Textual Conventions
ZeroBasedCounter32 ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This TC describes an object which counts events with the
following semantics: objects of this type will be set to
zero(0) on creation and will thereafter count appropriate
events, wrapping back to zero(0) when the value 2^32 is
reached.
Provided that an application discovers the new object within
the minimum time to wrap it can use the initial value as a
delta since it last polled the table of which this object is
part. It is important for a management station to be aware of
this minimum time and the actual time between polls, and to
discard data if the actual time is too long or there is no
defined minimum time.
Typically this TC is used in tables where the INDEX space is
constantly changing and/or the TimeFilter mechanism is in use."
SYNTAX Gauge32
LastCreateTime ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This TC describes an object that stores the last time its
entry was created.
This can be used for polling applications to determine that an
entry has been deleted and re-created between polls, causing
an otherwise undetectable discontinuity in the data."
SYNTAX TimeStamp
TimeFilter ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"To be used for the index to a table. Allows an application
to download only those rows changed since a particular time.
A row is considered changed if the value of any object in the
row changes or if the row is created or deleted.
When sysUpTime is equal to zero, this table shall be empty.
One entry exists for each past value of sysUpTime, except that
the whole table is purged should sysUpTime wrap.
As this basic row is updated new conceptual rows are created
(which still share the now updated object values with all
other instances). The number of instances which are created
is determined by the value of sysUpTime at which the basic row
was last updated. One instance will exist for each value of
sysUpTime at the last update time for the row. A new
timeMark instance is created for each new sysUpTime value.
Each new conceptual row will be associated with the timeMark
instance which was created at the value of sysUpTime with
which the conceptual row is to be associated.
By definition all conceptual rows were updated at or after
time zero and so at least one conceptual row (associated with
timeMark.0) must exist for each underlying (basic) row.
See the appendix for further discussion of this variable.
Consider the following fooTable:
fooTable ...
INDEX { fooTimeMark, fooIndex }
FooEntry {
fooTimeMark TimeFilter
fooIndex INTEGER,
fooCounts Counter
}
Should there be two basic rows in this table (fooIndex == 1,
fooIndex == 2) and row 1 was updated most recently at time 6,
while row 2 was updated most recently at time 8, and both rows
had been updated on several earlier occasions such that the
current values were 5 and 9 respectively then the following
fooCounts instances would exist.
fooCounts.0.1 5
fooCounts.0.2 9
fooCounts.1.1 5
fooCounts.1.2 9
fooCounts.2.1 5
fooCounts.2.2 9
fooCounts.3.1 5
fooCounts.3.2 9
fooCounts.4.1 5
fooCounts.4.2 9
fooCounts.5.1 5
fooCounts.5.2 9
fooCounts.6.1 5
fooCounts.6.2 9
fooCounts.7.2 9 -- note that row 1 doesn't exist for
fooCounts.8.2 9 -- times 7 and 8"
SYNTAX TimeTicks
DataSource ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Identifies the source of the data that the associated
function is configured to analyze. This source can be any
interface on this device.
In order to identify a particular interface, this
object shall identify the instance of the ifIndex
object, defined in [3,5], for the desired interface.
For example, if an entry were to receive data from
interface #1, this object would be set to ifIndex.1."
SYNTAX OBJECT IDENTIFIER
--
-- Protocol Directory Group
--
-- Lists the inventory of protocols the probe has the capability of
-- monitoring and allows the addition, deletion, and configuration of
-- entries in this list.
protocolDirLastChange OBJECT-TYPE
SYNTAX TimeStamp
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of sysUpTime at the time the protocol directory
was last modified, either through insertions or deletions,
or through modifications of either the
protocolDirAddressMapConfig, protocolDirHostConfig, or
protocolDirMatrixConfig."
::= { protocolDir 1 }
protocolDirTable OBJECT-TYPE
SYNTAX SEQUENCE OF ProtocolDirEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table lists the protocols that this agent has the
capability to decode and count. There is one entry in this
table for each such protocol. These protocols represent
different network layer, transport layer, and higher-layer
protocols. The agent should boot up with this table
preconfigured with those protocols that it knows about and
wishes to monitor. Implementations are strongly encouraged to
support protocols higher than the network layer (at least for
the protocol distribution group), even for implementations
that don't support the application layer groups."
::= { protocolDir 2 }
protocolDirEntry OBJECT-TYPE
SYNTAX ProtocolDirEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A conceptual row in the protocolDirTable.
An example of the indexing of this entry is
protocolDirLocalIndex.8.0.0.0.1.0.0.8.0.2.0.0, which is the
encoding of a length of 8, followed by 8 subids encoding the
protocolDirID of 1.2048, followed by a length of 2 and the
2 subids encoding zero-valued parameters."
INDEX { protocolDirID, protocolDirParameters }
::= { protocolDirTable 1 }
ProtocolDirEntry ::= SEQUENCE {
protocolDirID OCTET STRING,
protocolDirParameters OCTET STRING,
protocolDirLocalIndex Integer32,
protocolDirDescr DisplayString,
protocolDirType BITS,
protocolDirAddressMapConfig INTEGER,
protocolDirHostConfig INTEGER,
protocolDirMatrixConfig INTEGER,
protocolDirOwner OwnerString,
protocolDirStatus RowStatus
}
protocolDirID OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A unique identifier for a particular protocol. Standard
identifiers will be defined in a manner such that they
can often be used as specifications for new protocols - i.e.
a tree-structured assignment mechanism that matches the
protocol encapsulation `tree' and which has algorithmic
assignment mechanisms for certain subtrees. See RFC XXX for
more details.
Despite the algorithmic mechanism, the probe will only place
entries in here for those protocols it chooses to collect. In
other words, it need not populate this table with all of the
possible ethernet protocol types, nor need it create them on
the fly when it sees them. Whether or not it does these
things is a matter of product definition (cost/benefit,
usability), and is up to the designer of the product.
If an entry is written to this table with a protocolDirID that
the agent doesn't understand, either directly or
algorithmically, the SET request will be rejected with an
inconsistentName or badValue (for SNMPv1) error."
::= { protocolDirEntry 1 }
protocolDirParameters OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A set of parameters for the associated protocolDirID.
See the associated RMON2 Protocol Identifiers document
for a description of the possible parameters. There
will be one octet in this string for each sub-identifier in
the protocolDirID, and the parameters will appear here in the
same order as the associated sub-identifiers appear in the
protocolDirID.
Every node in the protocolDirID tree has a different, optional
set of parameters defined (that is, the definition of
parameters for a node is optional). The proper parameter
value for each node is included in this string. Note that the
inclusion of a parameter value in this string for each node is
not optional - what is optional is that a node may have no
parameters defined, in which case the parameter field for that
node will be zero."
::= { protocolDirEntry 2 }
protocolDirLocalIndex OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The locally arbitrary, but unique identifier associated
with this protocolDir entry.
The value for each supported protocol must remain constant at
least from one re-initialization of the entity's network
management system to the next re-initialization, except that
if a protocol is deleted and re-created, it must be re-created
with a new value that has not been used since the last
re-initialization.
The specific value is meaningful only within a given SNMP
entity. A protocolDirLocalIndex must not be re-used until the
next agent-restart in the event the protocol directory entry
is deleted."
::= { protocolDirEntry 3 }
protocolDirDescr OBJECT-TYPE
SYNTAX DisplayString (SIZE (1..64))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"A textual description of the protocol encapsulation.
A probe may choose to describe only a subset of the
entire encapsulation (e.g. only the highest layer).
This object is intended for human consumption only.
This object may not be modified if the associated
protocolDirStatus object is equal to active(1)."
::= { protocolDirEntry 4 }
protocolDirType OBJECT-TYPE
SYNTAX BITS {
extensible(0),
addressRecognitionCapable(1)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object describes 2 attributes of this protocol
directory entry.
The presence or absence of the `extensible' bit describes
whether or not this protocol directory entry can be extended
by the user by creating protocol directory entries which are
children of this protocol.
An example of an entry that will often allow extensibility is
`ip.udp'. The probe may automatically populate some children
of this node such as `ip.udp.snmp' and `ip.udp.dns'.
A probe administrator or user may also populate additional
children via remote SNMP requests that create entries in this
table. When a child node is added for a protocol for which the
probe has no built in support, extending a parent node (for
which the probe does have built in support),
that child node is not extendible. This is termed `limited
extensibility'.
When a child node is added through this extensibility
mechanism, the values of protocolDirLocalIndex and
protocolDirType shall be assigned by the agent.
The other objects in the entry will be assigned by the
manager who is creating the new entry.
This object also describes whether or not this agent can
recognize addresses for this protocol, should it be a network
level protocol. That is, while a probe may be able to
recognize packets of a particular network layer protocol and
count them, it takes additional logic to be able to recognize
the addresses in this protocol and to populate network layer
or application layer tables with the addresses in this
protocol. If this bit is set, the agent will recognize
network layer addresses for this protoocl and populate the
network and application layer host and matrix tables with
these protocols.
Note that when an entry is created, the agent will supply
values for the bits that match the capabilities of the agent
with respect to this protocol. Note that since row creations
usually exercise the limited extensibility feature, these
bits will usually be set to zero."
::= { protocolDirEntry 5 }
protocolDirAddressMapConfig OBJECT-TYPE
SYNTAX INTEGER {
notSupported(1),
supportedOff(2),
supportedOn(3)
}
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object describes and configures the probe's support for
address mapping for this protocol. When the probe creates
entries in this table for all protocols that it understands,
it will set the entry to notSupported(1) if it doesn't have
the capability to perform address mapping for the protocol or
if this protocol is not a network-layer protocol. When
an entry is created in this table by a management operation as
part of the limited extensibility feature, the probe must set
this value to notSupported(1), because limited extensibility
of the protocolDirTable does not extend to interpreting
addresses of the extended protocols.
If the value of this object is notSupported(1), the probe
will not perform address mapping for this protocol and
shall not allow this object to be changed to any other value.
If the value of this object is supportedOn(3), the probe
supports address mapping for this protocol and is configured
to perform address mapping for this protocol for all
addressMappingControlEntries and all interfaces.
If the value of this object is supportedOff(2), the probe
supports address mapping for this protocol but is configured
to not perform address mapping for this protocol for any
addressMappingControlEntries and all interfaces.
Whenever this value changes from supportedOn(3) to
supportedOff(2), the probe shall delete all related entries in
the addressMappingTable."
::= { protocolDirEntry 6 }
protocolDirHostConfig OBJECT-TYPE
SYNTAX INTEGER {
notSupported(1),
supportedOff(2),
supportedOn(3)
}
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object describes and configures the probe's support for
the network layer and application layer host tables for this
protocol. When the probe creates entries in this table for
all protocols that it understands, it will set the entry to
notSupported(1) if it doesn't have the capability to track the
nlHostTable for this protocol or if the alHostTable is
implemented but doesn't have the capability to track this
protocol. Note that if the alHostTable is implemented, the
probe may only support a protocol if it is supported in both
the nlHostTable and the alHostTable.
If the associated protocolDirType object has the
addressRecognitionCapable bit set, then this is a network
layer protocol for which the probe recognizes addresses, and
thus the probe will populate the nlHostTable and alHostTable
with addresses it discovers for this protocol.
If the value of this object is notSupported(1), the probe
will not track the nlHostTable or alHostTable for this
protocol and shall not allow this object to be changed to any
other value. If the value of this object is supportedOn(3),
the probe supports tracking of the nlHostTable and alHostTable
for this protocol and is configured to track both tables
for this protocol for all control entries and all interfaces.
If the value of this object is supportedOff(2), the probe
supports tracking of the nlHostTable and alHostTable for this
protocol but is configured to not track these tables
for any control entries or interfaces.
Whenever this value changes from supportedOn(3) to
supportedOff(2), the probe shall delete all related entries in
the nlHostTable and alHostTable.
Note that since each alHostEntry references 2 protocol
directory entries, one for the network address and one for the
type of the highest protocol recognized, that an entry will
only be created in that table if this value is supportedOn(3)
for both protocols."
::= { protocolDirEntry 7 }
protocolDirMatrixConfig OBJECT-TYPE
SYNTAX INTEGER {
notSupported(1),
supportedOff(2),
supportedOn(3)
}
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object describes and configures the probe's support for
the network layer and application layer matrix tables for this
protocol. When the probe creates entries in this table for
all protocols that it understands, it will set the entry to
notSupported(1) if it doesn't have the capability to track the
nlMatrixTables for this protocol or if the alMatrixTables are
implemented but don't have the capability to track this
protocol. Note that if the alMatrix tables are implemented,
the probe may only support a protocol if it is supported in
the the both of the nlMatrixTables and both of the
alMatrixTables.
If the associated protocolDirType object has the
addressRecognitionCapable bit set, then this is a network
layer protocol for which the probe recognizes addresses, and
thus the probe will populate both of the nlMatrixTables and
both of the alMatrixTables with addresses it discovers for
this protocol.
If the value of this object is notSupported(1), the probe
will not track either of the nlMatrixTables or the
alMatrixTables for this protocol and shall not allow this
object to be changed to any other value. If the value of this
object is supportedOn(3), the probe supports tracking of both
of the nlMatrixTables and (if implemented) both of the
alMatrixTables for this protocol and is configured to track
these tables for this protocol for all control entries and all
interfaces. If the value of this object is supportedOff(2),
the probe supports tracking of both of the nlMatrixTables and
(if implemented) both of the alMatrixTables for this protocol
but is configured to not track these tables for this
protocol for any control entries or interfaces.
Whenever this value changes from supportedOn(3) to
supportedOff(2), the probe shall delete all related entries in
the nlMatrixTables and the alMatrixTables.
Note that since each alMatrixEntry references 2 protocol
directory entries, one for the network address and one for the
type of the highest protocol recognized, that an entry will
only be created in that table if this value is supportedOn(3)
for both protocols."
::= { protocolDirEntry 8 }
protocolDirOwner OBJECT-TYPE
SYNTAX OwnerString
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The entity that configured this entry and is
therefore using the resources assigned to it."
::= { protocolDirEntry 9 }
protocolDirStatus OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The status of this protocol directory entry.
An entry may not exist in the active state unless all
objects in the entry have an appropriate value.
If this object is not equal to active(1), all associated
entries in the nlHostTable, nlMatrixSDTable, nlMatrixDSTable,
alHostTable, alMatrixSDTable, and alMatrixDSTable shall be
deleted."
::= { protocolDirEntry 10 }
--
-- Protocol Distribution Group (protocolDist)
--
-- Collects the relative amounts of octets and packets for the
-- different protocols detected on a network segment.
-- protocolDistControlTable,
-- protocolDistStatsTable
protocolDistControlTable OBJECT-TYPE
SYNTAX SEQUENCE OF ProtocolDistControlEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Controls the setup of protocol type distribution statistics
tables.
Implementations are encouraged to add an entry per monitored
interface upon initialization so that a default collection
of protocol statistics is available.
Rationale:
This table controls collection of very basic statistics
for any or all of the protocols detected on a given interface.
An NMS can use this table to quickly determine bandwidth
allocation utilized by different protocols.
A media-specific statistics collection could also
be configured (e.g. etherStats, trPStats) to easily obtain
total frame, octet, and droppedEvents for the same
interface."
::= { protocolDist 1 }
protocolDistControlEntry OBJECT-TYPE
SYNTAX ProtocolDistControlEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A conceptual row in the protocolDistControlTable.
An example of the indexing of this entry is
protocolDistControlDroppedFrames.7"
INDEX { protocolDistControlIndex }
::= { protocolDistControlTable 1 }
ProtocolDistControlEntry ::= SEQUENCE {
protocolDistControlIndex Integer32,
protocolDistControlDataSource DataSource,
protocolDistControlDroppedFrames Counter32,
protocolDistControlCreateTime LastCreateTime,
protocolDistControlOwner OwnerString,
protocolDistControlStatus RowStatus
}
protocolDistControlIndex OBJECT-TYPE
SYNTAX Integer32 (1..65535)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A unique index for this protocolDistControlEntry."
::= { protocolDistControlEntry 1 }
protocolDistControlDataSource OBJECT-TYPE
SYNTAX DataSource
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The source of data for the this protocol distribution.
The statistics in this group reflect all packets
on the local network segment attached to the
identified interface.
This object may not be modified if the associated
protocolDistControlStatus object is equal to active(1)."
::= { protocolDistControlEntry 2 }
protocolDistControlDroppedFrames OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of frames which were received by the probe
and therefore not accounted for in the *StatsDropEvents, but
for which the probe chose not to count for this entry for
whatever reason. Most often, this event occurs when the probe
is out of some resources and decides to shed load from this
collection.
This count does not include packets that were not counted
because they had MAC-layer errors.
Note that, unlike the dropEvents counter, this number is the
exact number of frames dropped."
::= { protocolDistControlEntry 3 }
protocolDistControlCreateTime OBJECT-TYPE
SYNTAX LastCreateTime
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of sysUpTime when this control entry was last
activated. This can be used by the management station to
ensure that the table has not been deleted and recreated
between polls."
::= { protocolDistControlEntry 4 }
protocolDistControlOwner OBJECT-TYPE
SYNTAX OwnerString
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The entity that configured this entry and is
therefore using the resources assigned to it."
::= { protocolDistControlEntry 5 }
protocolDistControlStatus OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The status of this row.
An entry may not exist in the active state unless all
objects in the entry have an appropriate value.
If this object is not equal to active(1), all associated
entries in the protocolDistStatsTable shall be deleted."
::= { protocolDistControlEntry 6 }
-- per interface protocol distribution statistics table
protocolDistStatsTable OBJECT-TYPE
SYNTAX SEQUENCE OF ProtocolDistStatsEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry is made in this table for every protocol in the
protocolDirTable which has been seen in at least one packet.
Counters are updated in this table for every protocol type
that is encountered when parsing a packet, but no counters are
updated for packets with MAC-layer errors.
Note that if a protocolDirEntry is deleted, all associated
entries in this table are removed."
::= { protocolDist 2 }
protocolDistStatsEntry OBJECT-TYPE
SYNTAX ProtocolDistStatsEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A conceptual row in the protocolDistStatsTable.
The index is composed of the protocolDistControlIndex of the
associated protocolDistControlEntry followed by the
protocolDirLocalIndex of the associated protocol that this
entry represents. In other words, the index identifies the
protocol distribution an entry is a part of as well as the
particular protocol that it represents.
An example of the indexing of this entry is
protocolDistStatsPkts.1.18"
INDEX { protocolDistControlIndex, protocolDirLocalIndex }
::= { protocolDistStatsTable 1 }
ProtocolDistStatsEntry ::= SEQUENCE {
protocolDistStatsPkts ZeroBasedCounter32,
protocolDistStatsOctets ZeroBasedCounter32
}
protocolDistStatsPkts OBJECT-TYPE
SYNTAX ZeroBasedCounter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of packets without errors received of this
protocol type. Note that this is the number of link-layer
packets, so if a single network-layer packet is fragmented
into several link-layer frames, this counter is incremented
several times."
::= { protocolDistStatsEntry 1 }
protocolDistStatsOctets OBJECT-TYPE
SYNTAX ZeroBasedCounter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of octets in packets received of this protocol
type since it was added to the protocolDistStatsTable
(excluding framing bits but including FCS octets), except for
those octets in packets that contained errors.
Note this doesn't count just those octets in the particular
protocol frames, but includes the entire packet that contained
the protocol."
::= { protocolDistStatsEntry 2 }
--
-- Address Map Group (addressMap)
--
-- Lists MAC address to network address bindings discovered by the
-- probe and what interface they were last seen on.
-- addressMapControlTable
-- addressMapTable
addressMapInserts OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of times an address mapping entry has been
inserted into the addressMapTable. If an entry is inserted,
then deleted, and then inserted, this counter will be
incremented by 2.
Note that the table size can be determined by subtracting
addressMapDeletes from addressMapInserts."
::= { addressMap 1 }
addressMapDeletes OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of times an address mapping entry has been
deleted from the addressMapTable (for any reason). If
an entry is deleted, then inserted, and then deleted, this
counter will be incremented by 2.
Note that the table size can be determined by subtracting
addressMapDeletes from addressMapInserts."
::= { addressMap 2 }
addressMapMaxDesiredEntries OBJECT-TYPE
SYNTAX Integer32 (-1..2147483647)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The maximum number of entries that are desired in the
addressMapTable. The probe will not create more than
this number of entries in the table, but may choose to create
fewer entries in this table for any reason including the lack
of resources.
If this object is set to a value less than the current number
of entries, enough entries are chosen in an
implementation-dependent manner and deleted so that the number
of entries in the table equals the value of this object.
If this value is set to -1, the probe may create any number
of entries in this table.
This object may be used to control how resources are allocated
on the probe for the various RMON functions."
::= { addressMap 3 }
addressMapControlTable OBJECT-TYPE
SYNTAX SEQUENCE OF AddressMapControlEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table to control the collection of network layer address to
physical address to interface mappings.
Note that this is not like the typical RMON
controlTable and dataTable in which each entry creates
its own data table. Each entry in this table enables the
discovery of addresses on a new interface and the placement
of address mappings into the central addressMapTable.
Implementations are encouraged to add an entry per monitored
interface upon initialization so that a default collection
of address mappings is available."
::= { addressMap 4 }
addressMapControlEntry OBJECT-TYPE
SYNTAX AddressMapControlEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A conceptual row in the addressMapControlTable.
An example of the indexing of this entry is
addressMapControlDroppedFrames.1"
INDEX { addressMapControlIndex }
::= { addressMapControlTable 1 }
AddressMapControlEntry ::= SEQUENCE {
addressMapControlIndex Integer32,
addressMapControlDataSource DataSource,
addressMapControlDroppedFrames Counter32,
addressMapControlOwner OwnerString,
addressMapControlStatus RowStatus
}
addressMapControlIndex OBJECT-TYPE
SYNTAX Integer32 (1..65535)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A unique index for this entry in the addressMapControlTable."
::= { addressMapControlEntry 1 }
addressMapControlDataSource OBJECT-TYPE
SYNTAX DataSource
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The source of data for this addressMapControlEntry."
::= { addressMapControlEntry 2 }
addressMapControlDroppedFrames OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of frames which were received by the probe
and therefore not accounted for in the *StatsDropEvents, but
for which the probe chose not to count for this entry for
whatever reason. Most often, this event occurs when the probe
is out of some resources and decides to shed load from this
collection.
This count does not include packets that were not counted
because they had MAC-layer errors.
Note that, unlike the dropEvents counter, this number is the
exact number of frames dropped."
::= { addressMapControlEntry 3 }
addressMapControlOwner OBJECT-TYPE
SYNTAX OwnerString
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The entity that configured this entry and is
therefore using the resources assigned to it."
::= { addressMapControlEntry 4 }
addressMapControlStatus OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The status of this addressMap control entry.
An entry may not exist in the active state unless all
objects in the entry have an appropriate value.
If this object is not equal to active(1), all associated
entries in the addressMapTable shall be deleted."
::= { addressMapControlEntry 5 }
addressMapTable OBJECT-TYPE
SYNTAX SEQUENCE OF AddressMapEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table of network layer address to physical address to
interface mappings.
The probe will add entries to this table based on the source
MAC and network addresses seen in packets without MAC-level
errors. The probe will populate this table for all protocols
in the protocol directory table whose value of
protocolDirAddressMapConfig is equal to supportedOn(3), and
will delete any entries whose protocolDirEntry is deleted or
has a protocolDirAddressMapConfig value of supportedOff(2)."
::= { addressMap 5 }
addressMapEntry OBJECT-TYPE
SYNTAX AddressMapEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A conceptual row in the addressMapTable.
The protocolDirLocalIndex in the index identifies the network
layer protocol of the addressMapNetworkAddress.
An example of the indexing of this entry is
addressMapSource.783495.18.4.128.2.6.6.11.1.3.6.1.2.1.2.2.1.1.1"
INDEX { addressMapTimeMark, protocolDirLocalIndex,
addressMapNetworkAddress, addressMapSource }
::= { addressMapTable 1 }
AddressMapEntry ::= SEQUENCE {
addressMapTimeMark TimeFilter,
addressMapNetworkAddress OCTET STRING,
addressMapSource OBJECT IDENTIFIER,
addressMapPhysicalAddress OCTET STRING,
addressMapLastChange TimeStamp
}
addressMapTimeMark OBJECT-TYPE
SYNTAX TimeFilter
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A TimeFilter for this entry. See the TimeFilter textual
convention to see how this works."
::= { addressMapEntry 1 }
addressMapNetworkAddress OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The network address for this relation.
This is represented as an octet string with
specific semantics and length as identified
by the protocolDirLocalIndex component of the
index.
For example, if the protocolDirLocalIndex indicates an
encapsulation of ip, this object is encoded as a length
octet of 4, followed by the 4 octets of the ip address,
in network byte order."
::= { addressMapEntry 2 }
addressMapSource OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The interface or port on which the associated network
address was most recently seen.
If this address mapping was discovered on an interface, this
object shall identify the instance of the ifIndex
object, defined in [3,5], for the desired interface.
For example, if an entry were to receive data from
interface #1, this object would be set to ifIndex.1.
If this address mapping was discovered on a port, this
object shall identify the instance of the rptrGroupPortIndex
object, defined in [RFC1516], for the desired port.
For example, if an entry were to receive data from
group #1, port #1, this object would be set to
rptrGroupPortIndex.1.1.
Note that while the dataSource associated with this entry
may only point to index objects, this object may at times
point to repeater port objects. This situation occurs when
the dataSource points to an interface which is a locally
attached repeater and the agent has additional information
about the source port of traffic seen on that repeater."
::= { addressMapEntry 3 }
addressMapPhysicalAddress OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The last source physical address on which the associated
network address was seen. If the protocol of the associated
network address was encapsulated inside of a network-level or
higher protocol, this will be the address of the next-lower
protocol with the addressRecognitionCapable bit enabled and
will be formatted as specified for that protocol."
::= { addressMapEntry 4 }
addressMapLastChange OBJECT-TYPE
SYNTAX TimeStamp
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of sysUpTime at the time this entry was last
created or the values of the physical address changed.
This can be used to help detect duplicate address problems, in
which case this object will be updated frequently."
::= { addressMapEntry 5 }
--
-- Network Layer Host Group
--
-- Counts the amount of traffic sent from and to each network address
-- discovered by the probe.
-- Note that while the hlHostControlTable also has objects that
-- control an optional alHostTable, implementation of the alHostTable is
-- not required to fully implement this group.
hlHostControlTable OBJECT-TYPE
SYNTAX SEQUENCE OF HlHostControlEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A list of higher layer (i.e. non-MAC) host table control entries.
These entries will enable the collection of the network and
application level host tables indexed by network addresses.
Both the network and application level host tables are
controlled by this table is so that they will both be created
and deleted at the same time, further increasing the ease with
which they can be implemented as a single datastore (note that
if an implementation stores application layer host records in
memory, it can derive network layer host records from them).
Entries in the nlHostTable will be created on behalf of each
entry in this table. Additionally, if this probe implements
the alHostTable, entries in the alHostTable will be created on
behalf of each entry in this table.
Implementations are encouraged to add an entry per monitored
interface upon initialization so that a default collection
of host statistics is available."
::= { nlHost 1 }
hlHostControlEntry OBJECT-TYPE
SYNTAX HlHostControlEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A conceptual row in the hlHostControlTable.
An example of the indexing of this entry is
hlHostControlNlDroppedFrames.1"
INDEX { hlHostControlIndex }
::= { hlHostControlTable 1 }
HlHostControlEntry ::= SEQUENCE {
hlHostControlIndex Integer32,
hlHostControlDataSource DataSource,
hlHostControlNlDroppedFrames Counter32,
hlHostControlNlInserts Counter32,
hlHostControlNlDeletes Counter32,
hlHostControlNlMaxDesiredEntries Integer32,
hlHostControlAlDroppedFrames Counter32,
hlHostControlAlInserts Counter32,
hlHostControlAlDeletes Counter32,
hlHostControlAlMaxDesiredEntries Integer32,
hlHostControlOwner OwnerString,
hlHostControlStatus RowStatus
}
hlHostControlIndex OBJECT-TYPE
SYNTAX Integer32 (1..65535)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An index that uniquely identifies an entry in the
hlHostControlTable. Each such entry defines
a function that discovers hosts on a particular
interface and places statistics about them in the
nlHostTable, and optionally in the alHostTable, on
behalf of this hlHostControlEntry."
::= { hlHostControlEntry 1 }
hlHostControlDataSource OBJECT-TYPE
SYNTAX DataSource
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The source of data for the associated host tables.
The statistics in this group reflect all packets
on the local network segment attached to the
identified interface.
This object may not be modified if the associated
hlHostControlStatus object is equal to active(1)."
::= { hlHostControlEntry 2 }
hlHostControlNlDroppedFrames OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of frames which were received by the probe
and therefore not accounted for in the *StatsDropEvents, but
for which the probe chose not to count for the associated
nlHost entries for whatever reason. Most often, this event
occurs when the probe is out of some resources and decides to
shed load from this collection.
This count does not include packets that were not counted
because they had MAC-layer errors.
Note that if the nlHostTable is inactive because no protocols
are enabled in the protocol directory, this value should be 0.
Note that, unlike the dropEvents counter, this number is the
exact number of frames dropped."
::= { hlHostControlEntry 3 }
hlHostControlNlInserts OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of times an nlHost entry has been
inserted into the nlHost table. If an entry is inserted, then
deleted, and then inserted, this counter will be incremented
by 2.
To allow for efficient implementation strategies, agents may
delay updating this object for short periods of time. For
example, an implementation strategy may allow internal
data structures to differ from those visible via SNMP for
short periods of time. This counter may reflect the internal
data structures for those short periods of time.
Note that the table size can be determined by subtracting
hlHostControlNlDeletes from hlHostControlNlInserts."
::= { hlHostControlEntry 4 }
hlHostControlNlDeletes OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of times an nlHost entry has been
deleted from the nlHost table (for any reason). If an entry
is deleted, then inserted, and then deleted, this counter will
be incremented by 2.
To allow for efficient implementation strategies, agents may
delay updating this object for short periods of time. For
example, an implementation strategy may allow internal
data structures to differ from those visible via SNMP for
short periods of time. This counter may reflect the internal
data structures for those short periods of time.
Note that the table size can be determined by subtracting
hlHostControlNlDeletes from hlHostControlNlInserts."
::= { hlHostControlEntry 5 }
hlHostControlNlMaxDesiredEntries OBJECT-TYPE
SYNTAX Integer32 (-1..2147483647)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The maximum number of entries that are desired in the
nlHostTable on behalf of this control entry. The probe will
not create more than this number of associated entries in the
table, but may choose to create fewer entries in this table
for any reason including the lack of resources.
If this object is set to a value less than the current number
of entries, enough entries are chosen in an
implementation-dependent manner and deleted so that the number
of entries in the table equals the value of this object.
If this value is set to -1, the probe may create any number
of entries in this table. If the associated
hlHostControlStatus object is equal to `active', this
object may not be modified.
This object may be used to control how resources are allocated
on the probe for the various RMON functions."
::= { hlHostControlEntry 6 }
hlHostControlAlDroppedFrames OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The total number of frames which were received by the probe
and therefore not accounted for in the *StatsDropEvents, but
for which the probe chose not to count for the associated
alHost entries for whatever reason. Most often, this event
occurs when the probe is out of some resources and decides to
shed load from this collection.
This count does not include packets that were not counted
because they had MAC-layer errors.
Note that if the alHostTable is not implemented or is inactive
because no protocols are enabled in the protocol directory,
this value should be 0.
Note that, unlike the dropEvents counter, this number is the
exact number of frames dropped."
::= { hlHostControlEntry 7 }
hlHostControlAlInserts OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of times an alHost entry has been
inserted into the alHost table. If an entry is inserted, then
deleted, and then inserted, this counter will be incremented
by 2.
To allow for efficient implementation strategies, agents may
delay updating this object for short periods of time. For
example, an implementation strategy may allow internal
data structures to differ from those visible via SNMP for
short periods of time. This counter may reflect the internal
data structures for those short periods of time.
Note that the table size can be determined by subtracting
hlHostControlAlDeletes from hlHostControlAlInserts."
::= { hlHostControlEntry 8 }
hlHostControlAlDeletes OBJECT-TYPE
SYNTAX Counter32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of times an alHost entry has been
deleted from the alHost table (for any reason). If an entry
is deleted, then inserted, and then deleted, this counter will
be incremented by 2.
To allow for efficient implementation strategies, agents may
delay updating this object for short periods of time. For
example, an implementation strategy may allow internal
data structures to differ from those visible via SNMP for
short periods of time. This counter may reflect the internal
data structures for those short periods of time.
Note that the table size can be determined by subtracting
hlHostControlAlDeletes from hlHostControlAlInserts."
::= { hlHostControlEntry 9 }
hlHostControlAlMaxDesiredEntries OBJECT-TYPE
SYNTAX Integer32 (-1..2147483647)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The maximum number of entries that are desired in the alHost
table on behalf of this control entry. The probe will not
create more than this number of associated entries in the
table, but may choose to create fewer entries in this table
for any reason including the lack of resources.
If this object is set to a value less than the current number
of entries, enough entries are chosen in an
implementation-dependent manner and deleted so that the number
of entries in the table equals the value of this object.
If this value is set to -1, the probe may create any number
of entries in this table. If the associated
hlHostControlStatus object is equal to `active', this
object may not be modified.
This object may be used to control how resources are allocated
on the probe for the various RMON functions."
::= { hlHostControlEntry 10 }
hlHostControlOwner OBJECT-TYPE
SYNTAX OwnerString
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The entity that configured this entry and is
therefore using the resources assigned to it."
::= { hlHostControlEntry 11 }
hlHostControlStatus OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The status of this hlHostControlEntry.
An entry may not exist in the active state unless all
objects in the entry have an appropriate value.
If this object is not equal to active(1), all associated
entries in the nlHostTable and alHostTable shall be deleted."
::= { hlHostControlEntry 12 }
nlHostTable OBJECT-TYPE
SYNTAX SEQUENCE OF NlHostEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A collection of statistics for a particular network layer
address that has been discovered on an interface of this
device.
The probe will populate this table for all network layer
protocols in the protocol directory table whose value of
protocolDirHostConfig is equal to supportedOn(3), and
will delete any entries whose protocolDirEntry is deleted or
has a protocolDirHostConfig value of supportedOff(2).
The probe will add to this table all addresses seen
as the source or destination address in all packets with no
MAC errors, and will increment octet and packet counts in the
table for all packets with no MAC errors."
::= { nlHost 2 }
nlHostEntry OBJECT-TYPE
SYNTAX NlHostEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A conceptual row in the nlHostTable.
The hlHostControlIndex value in the index identifies the
hlHostControlEntry on whose behalf this entry was created.
The protocolDirLocalIndex value in the index identifies the
network layer protocol of the nlHostAddress.
An example of the indexing of this entry is
nlHostOutPkts.1.783495.18.4.128.2.6.6."
INDEX { hlHostControlIndex, nlHostTimeMark,
protocolDirLocalIndex, nlHostAddress }
::= { nlHostTable 1 }
NlHostEntry ::= SEQUENCE {
nlHostTimeMark TimeFilter,
nlHostAddress OCTET STRING,
nlHostInPkts ZeroBasedCounter32,
nlHostOutPkts ZeroBasedCounter32,
nlHostInOctets ZeroBasedCounter32,
nlHostOutOctets ZeroBasedCounter32,
(next page on part 3)
