alarmSampleType INTEGER,
alarmValue INTEGER,
alarmStartupAlarm INTEGER,
alarmRisingThreshold INTEGER,
alarmFallingThreshold INTEGER,
alarmRisingEventIndex INTEGER (1..65535),
alarmFallingEventIndex INTEGER (1..65535),
alarmOwner OwnerString,
alarmStatus INTEGER
}
alarmIndex OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"An index that uniquely identifies an entry in the
alarm table. Each such entry defines a
diagnostic sample at a particular interval
for an object on the device."
::= { alarmEntry 1 }
alarmInterval OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The interval in seconds over which the data is
sampled and compared with the rising and falling
thresholds. When setting this variable, care
should be given to ensure that the variable being
monitored will not exceed 2^31 - 1 and roll
over the alarmValue object during the interval.
This object may not be modified if the associated
alarmStatus object is equal to valid(1)."
::= { alarmEntry 2 }
alarmVariable OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The object identifier of the particular variable to
be sampled. Only variables that resolve to an ASN.1
primitive type of INTEGER (INTEGER, Counter, Gauge,
or TimeTicks) may be sampled.
Because SNMP access control is articulated entirely
in terms of the contents of MIB views, no access
control mechanism exists that can restrict the value of
this object to identify only those objects that exist
in a particular MIB view. Because there is thus no
acceptable means of restricting the read access that
could be obtained through the alarm mechanism, the
probe must only grant write access to this object in
those views that have read access to all objects on
the probe.
During a set operation, if the supplied variable
name is not available in the selected MIB view, a
badValue error must be returned. If at any time
the variable name of an established alarmEntry is
no longer available in the selected MIB view, the
probe must change the status of this alarmEntry
to invalid(4).
This object may not be modified if the associated
alarmStatus object is equal to valid(1)."
::= { alarmEntry 3 }
alarmSampleType OBJECT-TYPE
SYNTAX INTEGER {
absoluteValue(1),
deltaValue(2)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The method of sampling the selected variable and
calculating the value to be compared against the
thresholds. If the value of this object is
absoluteValue(1), the value of the selected variable
will be compared directly with the thresholds at the
end of the sampling interval. If the value of this
object is deltaValue(2), the value of the selected
variable at the last sample will be subtracted from
the current value, and the difference compared with
the thresholds.
This object may not be modified if the associated
alarmStatus object is equal to valid(1)."
::= { alarmEntry 4 }
alarmValue OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The value of the statistic during the last sampling
period. The value during the current sampling period
is not made available until the period is completed."
::= { alarmEntry 5 }
alarmStartupAlarm OBJECT-TYPE
SYNTAX INTEGER {
risingAlarm(1),
fallingAlarm(2),
risingOrFallingAlarm(3)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The alarm that may be sent when this entry is first
set to valid. If the first sample after this entry
becomes valid is greater than or equal to the
risingThreshold and alarmStartupAlarm is equal to
risingAlarm(1) or risingOrFallingAlarm(3), then a
single rising alarm will be generated. If the first
sample after this entry becomes valid is less than
or equal to the fallingThreshold and
alarmStartupAlarm is equal to fallingAlarm(2) or
risingOrFallingAlarm(3), then a single falling
alarm will be generated.
This object may not be modified if the associated
alarmStatus object is equal to valid(1)."
::= { alarmEntry 6 }
alarmRisingThreshold OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-write
STATUS mandatory
DESCRIPTION
"A threshold for the sampled statistic. When the
current sampled value is greater than or equal to
this threshold, and the value at the last sampling
interval was less than this threshold, a single
event will be generated.
A single event will also be generated if the first
sample after this entry becomes valid is greater
than or equal to this threshold and the associated
alarmStartupAlarm is equal to risingAlarm(1) or
risingOrFallingAlarm(3).
After a rising event is generated, another such event
will not be generated until the sampled value
falls below this threshold and reaches the
alarmFallingThreshold.
This object may not be modified if the associated
alarmStatus object is equal to valid(1)."
::= { alarmEntry 7 }
alarmFallingThreshold OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-write
STATUS mandatory
DESCRIPTION
"A threshold for the sampled statistic. When the
current sampled value is less than or equal to
this threshold, and the value at the last sampling
interval was greater than this threshold, a single
event will be generated.
A single event will also be generated if the first
sample after this entry becomes valid is less than or
equal to this threshold and the associated
alarmStartupAlarm is equal to fallingAlarm(2) or
risingOrFallingAlarm(3).
After a falling event is generated, another such event
will not be generated until the sampled value
rises above this threshold and reaches the
alarmRisingThreshold.
This object may not be modified if the associated
alarmStatus object is equal to valid(1)."
::= { alarmEntry 8 }
alarmRisingEventIndex OBJECT-TYPE
SYNTAX INTEGER (0..65535)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The index of the eventEntry that is
used when a rising threshold is crossed. The
eventEntry identified by a particular value of
this index is the same as identified by the same value
of the eventIndex object. If there is no
corresponding entry in the eventTable, then
no association exists. In particular, if this value
is zero, no associated event will be generated, as
zero is not a valid event index.
This object may not be modified if the associated
alarmStatus object is equal to valid(1)."
::= { alarmEntry 9 }
alarmFallingEventIndex OBJECT-TYPE
SYNTAX INTEGER (0..65535)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The index of the eventEntry that is
used when a falling threshold is crossed. The
eventEntry identified by a particular value of
this index is the same as identified by the same value
of the eventIndex object. If there is no
corresponding entry in the eventTable, then
no association exists. In particular, if this value
is zero, no associated event will be generated, as
zero is not a valid event index.
This object may not be modified if the associated
alarmStatus object is equal to valid(1)."
::= { alarmEntry 10 }
alarmOwner OBJECT-TYPE
SYNTAX OwnerString
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The entity that configured this entry and is
therefore using the resources assigned to it."
::= { alarmEntry 11 }
alarmStatus OBJECT-TYPE
SYNTAX EntryStatus
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The status of this alarm entry."
::= { alarmEntry 12 }
-- The Host Group
-- Implementation of the Host group is optional.
--
-- The host group discovers new hosts on the network by
-- keeping a list of source and destination MAC Addresses seen
-- in good packets. For each of these addresses, the host
-- group keeps a set of statistics. The hostControlTable
-- controls which interfaces this function is performed on,
-- and contains some information about the process. On
-- behalf of each hostControlEntry, data is collected on an
-- interface and placed both the hostTable and the
-- hostTimeTable. If the monitoring device finds itself
-- short of resources, it may delete entries as needed. It
-- is suggested that the device delete the least recently
-- used entries first.
-- The hostTable contains entries for each address
-- discovered on a particular interface. Each entry
-- contains statistical data about that host. This table
-- is indexed by the MAC address of the host, through
-- which a random access may be achieved.
-- The hostTimeTable contains data in the same format as the
-- hostTable, and must contain the same set of hosts, but is
-- indexed using hostTimeCreationOrder rather than hostAddress.
-- The hostTimeCreationOrder is an integer which reflects
-- the relative order in which a particular entry was
-- discovered and thus inserted into the table. As this
-- order, and thus index, is among those entries currently
-- in the table, the index for a particular entry may change
-- if an (earlier) entry is deleted. Thus the association
-- between hostTimeCreationOrder and hostTimeEntry may be
-- broken at any time.
-- The hostTimeTable has two important uses. The first is the
-- fast download of this potentially large table. Because the
-- index of this table runs from 1 to the size of the table,
-- inclusive, its values are predictable. This allows very
-- efficient packing of variables into SNMP PDU's and allows
-- a table transfer to have multiple packets outstanding.
-- These benefits increase transfer rates tremendously.
-- The second use of the hostTimeTable is the efficient
-- discovery by the management station of new entries added
-- to the table. After the management station has
-- downloaded the entire table, it knows that new entries
-- will be added immediately after the end of the current
-- table. It can thus detect new entries there
-- and retrieve them easily.
-- Because the association between hostTimeCreationOrder and
-- hostTimeEntry may be broken at any time, the management
-- station must monitor the related hostControlLastDeleteTime
-- object. When the management station thus detects a deletion,
-- it must assume that any such associations have been broken,
-- and invalidate any it has stored locally. This includes
-- restarting any download of the hostTimeTable that may have
-- been in progress, as well as rediscovering the end of the
-- hostTimeTable so that it may detect new entries. If the
-- management station does not detect the broken association,
-- it may continue to refer to a particular host by its
-- creationOrder while unwittingly retrieving the data
-- associated with another host entirely. If this happens
-- while downloading the host table, the management station
-- may fail to download all of the entries in the table.
hostControlTable OBJECT-TYPE
SYNTAX SEQUENCE OF HostControlEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A list of host table control entries."
::= { hosts 1 }
hostControlEntry OBJECT-TYPE
SYNTAX HostControlEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A list of parameters that set up the discovery of
hosts on a particular interface and the collection
of statistics about these hosts."
INDEX { hostControlIndex }
::= { hostControlTable 1 }
HostControlEntry ::= SEQUENCE {
hostControlIndex INTEGER (1..65535),
hostControlDataSource OBJECT IDENTIFIER,
hostControlTableSize INTEGER,
hostControlLastDeleteTime TimeTicks,
hostControlOwner OwnerString,
hostControlStatus INTEGER
}
hostControlIndex OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"An index that uniquely identifies an entry in the
hostControl table. Each such entry defines
a function that discovers hosts on a particular
interface and places statistics about them in the
hostTable and the hostTimeTable on behalf of this
hostControlEntry."
::= { hostControlEntry 1 }
hostControlDataSource OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This object identifies the source of the data for
this instance of the host function. 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 [4,6], for the desired interface. For example,
if an entry were to receive data from interface #1,
this object would be set to ifIndex.1.
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
hostControlStatus object is equal to valid(1)."
::= { hostControlEntry 2 }
hostControlTableSize OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of hostEntries in the hostTable and the
hostTimeTable associated with this hostControlEntry."
::= { hostControlEntry 3 }
hostControlLastDeleteTime OBJECT-TYPE
SYNTAX TimeTicks
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The value of sysUpTime when the last entry
was deleted from the portion of the hostTable
associated with this hostControlEntry. If no
deletions have occurred, this value shall be zero."
::= { hostControlEntry 4 }
hostControlOwner OBJECT-TYPE
SYNTAX OwnerString
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The entity that configured this entry and is
therefore using the resources assigned to it."
::= { hostControlEntry 5 }
hostControlStatus OBJECT-TYPE
SYNTAX EntryStatus
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The status of this hostControl entry.
If this object is not equal to valid(1), all
associated entries in the hostTable,
hostTimeTable, and the hostTopNTable shall be
deleted by the agent."
::= { hostControlEntry 6 }
hostTable OBJECT-TYPE
SYNTAX SEQUENCE OF HostEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A list of host entries."
::= { hosts 2 }
hostEntry OBJECT-TYPE
SYNTAX HostEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A collection of statistics for a particular host
that has been discovered on an interface of this
device."
INDEX { hostIndex, hostAddress }
::= { hostTable 1 }
HostEntry ::= SEQUENCE {
hostAddress OCTET STRING,
hostCreationOrder INTEGER (1..65535),
hostIndex INTEGER (1..65535),
hostInPkts Counter,
hostOutPkts Counter,
hostInOctets Counter,
hostOutOctets Counter,
hostOutErrors Counter,
hostOutBroadcastPkts Counter,
hostOutMulticastPkts Counter
}
hostAddress OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The physical address of this host."
::= { hostEntry 1 }
hostCreationOrder OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"An index that defines the relative ordering of
the creation time of hosts captured for a
particular hostControlEntry. This index shall
be between 1 and N, where N is the value of
the associated hostControlTableSize. The ordering
of the indexes is based on the order of each entry's
insertion into the table, in which entries added
earlier have a lower index value than entries added
later.
It is important to note that the order for a
particular entry may change as an (earlier) entry
is deleted from the table. Because this order may
change, management stations should make use of the
hostControlLastDeleteTime variable in the
hostControlEntry associated with the relevant
portion of the hostTable. By observing
this variable, the management station may detect
the circumstances where a previous association
between a value of hostCreationOrder
and a hostEntry may no longer hold."
::= { hostEntry 2 }
hostIndex OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The set of collected host statistics of which
this entry is a part. The set of hosts
identified by a particular value of this
index is associated with the hostControlEntry
as identified by the same value of hostControlIndex."
::= { hostEntry 3 }
hostInPkts OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of packets without errors transmitted to
this address since it was added to the hostTable."
::= { hostEntry 4 }
hostOutPkts OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of packets including errors transmitted
by this address since it was added to the hostTable."
::= { hostEntry 5 }
hostInOctets OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of octets transmitted to this address
since it was added to the hostTable (excluding
framing bits but including FCS octets), except for
those octets in packets that contained errors."
::= { hostEntry 6 }
hostOutOctets OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of octets transmitted by this address
since it was added to the hostTable (excluding
framing bits but including FCS octets), including
those octets in packets that contained errors."
::= { hostEntry 7 }
hostOutErrors OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of error packets transmitted by this
address since this host was added to the hostTable."
::= { hostEntry 8 }
hostOutBroadcastPkts OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of good packets transmitted by this
address that were directed to the broadcast address
since this host was added to the hostTable."
::= { hostEntry 9 }
hostOutMulticastPkts OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of good packets transmitted by this
address that were directed to a multicast address
since this host was added to the hostTable.
Note that this number does not include packets
directed to the broadcast address."
::= { hostEntry 10 }
-- host Time Table
hostTimeTable OBJECT-TYPE
SYNTAX SEQUENCE OF HostTimeEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A list of time-ordered host table entries."
::= { hosts 3 }
hostTimeEntry OBJECT-TYPE
SYNTAX HostTimeEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A collection of statistics for a particular host
that has been discovered on an interface of this
device. This collection includes the relative
ordering of the creation time of this object."
INDEX { hostTimeIndex, hostTimeCreationOrder }
::= { hostTimeTable 1 }
HostTimeEntry ::= SEQUENCE {
hostTimeAddress OCTET STRING,
hostTimeCreationOrder INTEGER (1..65535),
hostTimeIndex INTEGER (1..65535),
hostTimeInPkts Counter,
hostTimeOutPkts Counter,
hostTimeInOctets Counter,
hostTimeOutOctets Counter,
hostTimeOutErrors Counter,
hostTimeOutBroadcastPkts Counter,
hostTimeOutMulticastPkts Counter
}
hostTimeAddress OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The physical address of this host."
::= { hostTimeEntry 1 }
hostTimeCreationOrder OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"An index that uniquely identifies an entry in
the hostTime table among those entries associated
with the same hostControlEntry. This index shall
be between 1 and N, where N is the value of
the associated hostControlTableSize. The ordering
of the indexes is based on the order of each entry's
insertion into the table, in which entries added
earlier have a lower index value than entries added
later. Thus the management station has the ability
to learn of new entries added to this table without
downloading the entire table.
It is important to note that the index for a
particular entry may change as an (earlier) entry
is deleted from the table. Because this order may
change, management stations should make use of the
hostControlLastDeleteTime variable in the
hostControlEntry associated with the relevant
portion of the hostTimeTable. By observing
this variable, the management station may detect
the circumstances where a download of the table
may have missed entries, and where a previous
association between a value of hostTimeCreationOrder
and a hostTimeEntry may no longer hold."
::= { hostTimeEntry 2 }
hostTimeIndex OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The set of collected host statistics of which
this entry is a part. The set of hosts
identified by a particular value of this
index is associated with the hostControlEntry
as identified by the same value of hostControlIndex."
::= { hostTimeEntry 3 }
hostTimeInPkts OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of packets without errors transmitted to
this address since it was added to the hostTimeTable."
::= { hostTimeEntry 4 }
hostTimeOutPkts OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of packets including errors transmitted
by this address since it was added to the
hostTimeTable."
::= { hostTimeEntry 5 }
hostTimeInOctets OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of octets transmitted to this address
since it was added to the hostTimeTable (excluding
framing bits but including FCS octets), except for
those octets in packets that contained errors."
::= { hostTimeEntry 6 }
hostTimeOutOctets OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of octets transmitted by this address since
it was added to the hostTimeTable (excluding framing
bits but including FCS octets), including those
octets in packets that contained errors."
::= { hostTimeEntry 7 }
hostTimeOutErrors OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of error packets transmitted by this
address since this host was added to the
hostTimeTable."
::= { hostTimeEntry 8 }
hostTimeOutBroadcastPkts OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of good packets transmitted by this
address that were directed to the broadcast address
since this host was added to the hostTimeTable."
::= { hostTimeEntry 9 }
hostTimeOutMulticastPkts OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of good packets transmitted by this
address that were directed to a multicast address
since this host was added to the hostTimeTable.
Note that this number does not include packets
directed to the broadcast address."
::= { hostTimeEntry 10 }
-- The Host Top "N" Group
-- Implementation of the Host Top N group is optional.
--
-- The Host Top N group requires the implementation of the
-- host group.
--
-- The Host Top N group is used to prepare reports that
-- describe the hosts that top a list ordered by one of
-- their statistics. The available statistics are samples
-- of one of their base statistics, over an interval
-- specified by the management station. Thus, these
-- statistics are rate based. The management
-- station also selects how many such hosts are reported.
-- The hostTopNControlTable is used to initiate the generation
-- of such a report. The management station may select the
-- parameters of such a report, such as which interface,
-- which statistic, how many hosts, and the start and stop
-- times of the sampling. When the report is prepared,
-- entries are created in the hostTopNTable associated with
-- the relevant hostTopNControlEntry. These entries are
-- static for each report after it has been prepared.
hostTopNControlTable OBJECT-TYPE
SYNTAX SEQUENCE OF HostTopNControlEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A list of top N host control entries."
::= { hostTopN 1 }
hostTopNControlEntry OBJECT-TYPE
SYNTAX HostTopNControlEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A set of parameters that control the creation of a
report of the top N hosts according to several
metrics."
INDEX { hostTopNControlIndex }
::= { hostTopNControlTable 1 }
HostTopNControlEntry ::= SEQUENCE {
hostTopNControlIndex INTEGER (1..65535),
hostTopNHostIndex INTEGER (1..65535),
hostTopNRateBase INTEGER,
hostTopNTimeRemaining INTEGER,
hostTopNDuration INTEGER,
hostTopNRequestedSize INTEGER,
hostTopNGrantedSize INTEGER,
hostTopNStartTime TimeTicks,
hostTopNOwner OwnerString,
hostTopNStatus INTEGER
}
hostTopNControlIndex OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"An index that uniquely identifies an entry
in the hostTopNControl table. Each such
entry defines one top N report prepared for
one interface."
::= { hostTopNControlEntry 1 }
hostTopNHostIndex OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The host table for which a top N report will be
prepared on behalf of this entry. The host table
identified by a particular value of this index is
associated with the same host table as identified
by the same value of hostIndex.
This object may not be modified if the associated
hostTopNStatus object is equal to valid(1)."
::= { hostTopNControlEntry 2 }
hostTopNRateBase OBJECT-TYPE
SYNTAX INTEGER {
hostTopNInPkts(1),
hostTopNOutPkts(2),
hostTopNInOctets(3),
hostTopNOutOctets(4),
hostTopNOutErrors(5),
hostTopNOutBroadcastPkts(6),
hostTopNOutMulticastPkts(7)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The variable for each host that the hostTopNRate
variable is based upon.
This object may not be modified if the associated
hostTopNStatus object is equal to valid(1)."
::= { hostTopNControlEntry 3 }
hostTopNTimeRemaining OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The number of seconds left in the report currently
being collected. When this object is modified by
the management station, a new collection is started,
possibly aborting a currently running report. The
new value is used as the requested duration of this
report, which is loaded into the associated
hostTopNDuration object.
When this object is set to a non-zero value, any
associated hostTopNEntries shall be made
inaccessible by the monitor. While the value of this
object is non-zero, it decrements by one per second
until it reaches zero. During this time, all
associated hostTopNEntries shall remain
inaccessible. At the time that this object
decrements to zero, the report is made
accessible in the hostTopNTable. Thus, the hostTopN
table needs to be created only at the end of the
collection interval."
DEFVAL { 0 }
::= { hostTopNControlEntry 4 }
hostTopNDuration OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of seconds that this report has collected
during the last sampling interval, or if this
report is currently being collected, the number
of seconds that this report is being collected
during this sampling interval.
When the associated hostTopNTimeRemaining object is
set, this object shall be set by the probe to the
same value and shall not be modified until the next
time the hostTopNTimeRemaining is set.
This value shall be zero if no reports have been
requested for this hostTopNControlEntry."
DEFVAL { 0 }
::= { hostTopNControlEntry 5 }
hostTopNRequestedSize OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The maximum number of hosts requested for the top N
table.
When this object is created or modified, the probe
should set hostTopNGrantedSize as closely to this
object as is possible for the particular probe
implementation and available resources."
DEFVAL { 10 }
::= { hostTopNControlEntry 6 }
hostTopNGrantedSize OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The maximum number of hosts in the top N table.
When the associated hostTopNRequestedSize object is
created or modified, the probe should set this
object as closely to the requested value as is
possible for the particular implementation and
available resources. The probe must not lower this
value except as a result of a set to the associated
hostTopNRequestedSize object.
Hosts with the highest value of hostTopNRate shall be
placed in this table in decreasing order of this rate
until there is no more room or until there are no more
hosts."
::= { hostTopNControlEntry 7 }
hostTopNStartTime OBJECT-TYPE
SYNTAX TimeTicks
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The value of sysUpTime when this top N report was
last started. In other words, this is the time that
the associated hostTopNTimeRemaining object was
modified to start the requested report."
::= { hostTopNControlEntry 8 }
hostTopNOwner OBJECT-TYPE
SYNTAX OwnerString
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The entity that configured this entry and is
therefore using the resources assigned to it."
::= { hostTopNControlEntry 9 }
hostTopNStatus OBJECT-TYPE
SYNTAX EntryStatus
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The status of this hostTopNControl entry.
If this object is not equal to valid(1), all
associated hostTopNEntries shall be deleted by
the agent."
::= { hostTopNControlEntry 10 }
hostTopNTable OBJECT-TYPE
SYNTAX SEQUENCE OF HostTopNEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A list of top N host entries."
::= { hostTopN 2 }
hostTopNEntry OBJECT-TYPE
SYNTAX HostTopNEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A set of statistics for a host that is part of a
top N report."
INDEX { hostTopNReport, hostTopNIndex }
::= { hostTopNTable 1 }
HostTopNEntry ::= SEQUENCE {
hostTopNReport INTEGER (1..65535),
hostTopNIndex INTEGER (1..65535),
hostTopNAddress OCTET STRING,
hostTopNRate INTEGER
}
hostTopNReport OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object identifies the top N report of which
this entry is a part. The set of hosts
identified by a particular value of this
object is part of the same report as identified
by the same value of the hostTopNControlIndex object."
::= { hostTopNEntry 1 }
hostTopNIndex OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"An index that uniquely identifies an entry in
the hostTopN table among those in the same report.
This index is between 1 and N, where N is the
number of entries in this table. Increasing values
of hostTopNIndex shall be assigned to entries with
decreasing values of hostTopNRate until index N
is assigned to the entry with the lowest value of
hostTopNRate or there are no more hostTopNEntries."
::= { hostTopNEntry 2 }
hostTopNAddress OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The physical address of this host."
::= { hostTopNEntry 3 }
hostTopNRate OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The amount of change in the selected variable
during this sampling interval. The selected
variable is this host's instance of the object
selected by hostTopNRateBase."
::= { hostTopNEntry 4 }
-- The Matrix Group
-- Implementation of the Matrix group is optional.
--
-- The Matrix group consists of the matrixControlTable,
-- matrixSDTable and the matrixDSTable. These tables
-- store statistics for a particular conversation between
-- two addresses. As the device detects a new conversation,
-- including those to a non-unicast address, it creates a
-- new entry in both of the matrix tables.
-- It must only create new entries based on information
-- received in good packets. If the monitoring device finds
-- itself short of resources, it may delete entries as needed.
-- It is suggested that the device delete the least recently
-- used entries first.
matrixControlTable OBJECT-TYPE
SYNTAX SEQUENCE OF MatrixControlEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A list of information entries for the
traffic matrix on each interface."
::= { matrix 1 }
matrixControlEntry OBJECT-TYPE
SYNTAX MatrixControlEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"Information about a traffic matrix on a
particular interface."
INDEX { matrixControlIndex }
::= { matrixControlTable 1 }
MatrixControlEntry ::= SEQUENCE {
matrixControlIndex INTEGER (1..65535),
matrixControlDataSource OBJECT IDENTIFIER,
matrixControlTableSize INTEGER,
matrixControlLastDeleteTime TimeTicks,
matrixControlOwner OwnerString,
matrixControlStatus INTEGER
}
matrixControlIndex OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"An index that uniquely identifies an entry in the
matrixControl table. Each such entry defines
a function that discovers conversations on a particular
interface and places statistics about them in the
matrixSDTable and the matrixDSTable on behalf of this
matrixControlEntry."
::= { matrixControlEntry 1 }
matrixControlDataSource OBJECT-TYPE
SYNTAX OBJECT IDENTIFIER
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This object identifies the source of
the data from which this entry creates a traffic matrix.
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 [4,6], for the desired interface. For
example, if an entry were to receive data from
interface #1, this object would be set to ifIndex.1.
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
matrixControlStatus object is equal to valid(1)."
::= { matrixControlEntry 2 }
matrixControlTableSize OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of matrixSDEntries in the matrixSDTable
for this interface. This must also be the value of
the number of entries in the matrixDSTable for this
interface."
::= { matrixControlEntry 3 }
matrixControlLastDeleteTime OBJECT-TYPE
SYNTAX TimeTicks
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The value of sysUpTime when the last entry
was deleted from the portion of the matrixSDTable
or matrixDSTable associated with this
matrixControlEntry.
If no deletions have occurred, this value shall be
zero."
::= { matrixControlEntry 4 }
matrixControlOwner OBJECT-TYPE
SYNTAX OwnerString
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The entity that configured this entry and is
therefore using the resources assigned to it."
::= { matrixControlEntry 5 }
matrixControlStatus OBJECT-TYPE
SYNTAX EntryStatus
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The status of this matrixControl entry.
If this object is not equal to valid(1), all
associated entries in the matrixSDTable and the
matrixDSTable shall be deleted by the agent."
::= { matrixControlEntry 6 }
matrixSDTable OBJECT-TYPE
SYNTAX SEQUENCE OF MatrixSDEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A list of traffic matrix entries indexed by
source and destination MAC address."
::= { matrix 2 }
matrixSDEntry OBJECT-TYPE
SYNTAX MatrixSDEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A collection of statistics for communications between
two addresses on a particular interface."
INDEX { matrixSDIndex,
matrixSDSourceAddress, matrixSDDestAddress }
::= { matrixSDTable 1 }
MatrixSDEntry ::= SEQUENCE {
matrixSDSourceAddress OCTET STRING,
matrixSDDestAddress OCTET STRING,
matrixSDIndex INTEGER (1..65535),
matrixSDPkts Counter,
matrixSDOctets Counter,
matrixSDErrors Counter
}
matrixSDSourceAddress OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The source physical address."
::= { matrixSDEntry 1 }
matrixSDDestAddress OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The destination physical address."
::= { matrixSDEntry 2 }
matrixSDIndex OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The set of collected matrix statistics of which
this entry is a part. The set of matrix statistics
identified by a particular value of this index
is associated with the same matrixControlEntry
as identified by the same value of matrixControlIndex."
::= { matrixSDEntry 3 }
matrixSDPkts OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of packets transmitted from the source
address to the destination address (this number
includes error packets)."
::= { matrixSDEntry 4 }
matrixSDOctets OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of octets (excluding framing bits but
including FCS octets) contained in all packets
transmitted from the source address to the
destination address."
::= { matrixSDEntry 5 }
matrixSDErrors OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of error packets transmitted from
the source address to the destination address."
::= { matrixSDEntry 6 }
-- Traffic matrix tables from destination to source
matrixDSTable OBJECT-TYPE
SYNTAX SEQUENCE OF MatrixDSEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A list of traffic matrix entries indexed by
destination and source MAC address."
::= { matrix 3 }
matrixDSEntry OBJECT-TYPE
SYNTAX MatrixDSEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A collection of statistics for communications between
two address on a particular interface."
INDEX { matrixDSIndex,
matrixDSDestAddress, matrixDSSourceAddress }
::= { matrixDSTable 1 }
MatrixDSEntry ::= SEQUENCE {
matrixDSSourceAddress OCTET STRING,
matrixDSDestAddress OCTET STRING,
matrixDSIndex INTEGER (1..65535),
matrixDSPkts Counter,
matrixDSOctets Counter,
matrixDSErrors Counter
}
matrixDSSourceAddress OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The source physical address."
::= { matrixDSEntry 1 }
matrixDSDestAddress OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The destination physical address."
::= { matrixDSEntry 2 }
matrixDSIndex OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The set of collected matrix statistics of which
this entry is a part. The set of matrix statistics
identified by a particular value of this index
is associated with the same matrixControlEntry
as identified by the same value of matrixControlIndex."
::= { matrixDSEntry 3 }
matrixDSPkts OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of packets transmitted from the source
address to the destination address (this number
includes error packets)."
::= { matrixDSEntry 4 }
matrixDSOctets OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of octets (excluding framing bits
but including FCS octets) contained in all packets
transmitted from the source address to the
destination address."
::= { matrixDSEntry 5 }
matrixDSErrors OBJECT-TYPE
SYNTAX Counter
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The number of error packets transmitted from
the source address to the destination address."
::= { matrixDSEntry 6 }
-- The Filter Group
-- Implementation of the Filter group is optional.
--
-- The Filter group allows packets to be captured with an
-- arbitrary filter expression. A logical data and
-- event stream or "channel" is formed by the packets
-- that match the filter expression.
--
-- This filter mechanism allows the creation of an arbitrary
-- logical expression with which to filter packets. Each
-- filter associated with a channel is OR'ed with the others.
-- Within a filter, any bits checked in the data and status are
-- AND'ed with respect to other bits in the same filter. The
-- NotMask also allows for checking for inequality. Finally,
-- the channelAcceptType object allows for inversion of the
-- whole equation.
--
-- The channel can be turned on or off, and can also
-- generate events when packets pass through it.
filterTable OBJECT-TYPE
SYNTAX SEQUENCE OF FilterEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A list of packet filter entries."
::= { filter 1 }
filterEntry OBJECT-TYPE
SYNTAX FilterEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A set of parameters for a packet filter applied on a
particular interface."
INDEX { filterIndex }
::= { filterTable 1 }
FilterEntry ::= SEQUENCE {
filterIndex INTEGER (1..65535),
filterChannelIndex INTEGER (1..65535),
filterPktDataOffset INTEGER,
filterPktData OCTET STRING,
filterPktDataMask OCTET STRING,
filterPktDataNotMask OCTET STRING,
filterPktStatus INTEGER,
filterPktStatusMask INTEGER,
filterPktStatusNotMask INTEGER,
filterOwner OwnerString,
filterStatus INTEGER
}
filterIndex OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-only
STATUS mandatory
DESCRIPTION
"An index that uniquely identifies an entry
in the filter table. Each such entry defines
one filter that is to be applied to every packet
received on an interface."
::= { filterEntry 1 }
filterChannelIndex OBJECT-TYPE
SYNTAX INTEGER (1..65535)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"This object identifies the channel of which this
filter is a part. The filters identified by a
particular value of this object are associated
with the same channel as identified by the same
value of the channelIndex object."
::= { filterEntry 2 }
filterPktDataOffset OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The offset from the beginning of each packet where
a match of packet data will be attempted. This offset
is measured from the point in the physical layer
packet after the framing bits, if any. For example,
in an Ethernet frame, this point is at the beginning
of the destination MAC address.
This object may not be modified if the associated
filterStatus object is equal to valid(1)."
DEFVAL { 0 }
::= { filterEntry 3 }
filterPktData OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The data that is to be matched with the input packet.
For each packet received, this filter and the
accompanying filterPktDataMask and
filterPktDataNotMask will be adjusted for the
offset. The only bits relevant to this
match algorithm are those that have the corresponding
filterPktDataMask bit equal to one. The following
three rules are then applied to every packet:
(1) If the packet is too short and does not have data
corresponding to part of the filterPktData, the
packet will fail this data match.
(2) For each relevant bit from the packet with the
corresponding filterPktDataNotMask bit set to
zero, if the bit from the packet is not equal to
the corresponding bit from the filterPktData,
then the packet will fail this data match.
(3) If for every relevant bit from the packet with the
corresponding filterPktDataNotMask bit set to one,
the bit from the packet is equal to the
corresponding bit from the filterPktData, then
the packet will fail this data match.
Any packets that have not failed any of the three
matches above have passed this data match.
This object may not be modified if the associated
filterStatus object is equal to valid(1)."
::= { filterEntry 4 }
filterPktDataMask OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The mask that is applied to the match process.
After adjusting this mask for the offset, only those
bits in the received packet that correspond to bits
set in this mask are relevant for further processing
by the match algorithm. The offset is applied to
filterPktDataMask in the same way it is applied to
the filter. For the purposes of the matching
algorithm, if the associated filterPktData object
is longer than this mask, this mask is conceptually
extended with '1' bits until it reaches the
length of the filterPktData object.
This object may not be modified if the associated
filterStatus object is equal to valid(1)."
::= { filterEntry 5 }
filterPktDataNotMask OBJECT-TYPE
SYNTAX OCTET STRING
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The inversion mask that is applied to the match
process. After adjusting this mask for the offset,
those relevant bits in the received packet that
correspond to bits cleared in this mask must all
be equal to their corresponding bits in the
filterPktData object for the packet to be accepted.
In addition, at least one of those relevant
bits in the received packet that correspond to bits
set in this mask must be different to its
corresponding bit in the filterPktData object.
For the purposes of the matching algorithm, if
the associated filterPktData object is longer than
this mask, this mask is conceptually extended with
'0' bits until it reaches the length of the
filterPktData object.
This object may not be modified if the associated
filterStatus object is equal to valid(1)."
::= { filterEntry 6 }
filterPktStatus OBJECT-TYPE
SYNTAX INTEGER
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The status that is to be matched with the input
packet. The only bits relevant to this match
algorithm are those that have the corresponding
filterPktStatusMask bit equal to one.
The following two rules are then applied to every
packet:
(1) For each relevant bit from the packet status
with the corresponding filterPktStatusNotMask
bit set to zero, if the bit from the packet
status is not equal to the corresponding bit
from the filterPktStatus, then the packet will
fail this status match.
(2) If for every relevant bit from the packet status
with the corresponding filterPktStatusNotMask
bit set to one, the bit from the packet status
is equal to the corresponding bit from the
filterPktStatus, then the packet will fail
this status match.
Any packets that have not failed either of the two
matches above have passed this status match.
The value of the packet status is a sum. This sum
initially takes the value zero. Then, for each
error, E, that has been discovered in this packet,
2 raised to a value representing E is added to the sum.
The errors and the bits that represent them are
dependent on the media type of the interface that
this channel is receiving packets from.