| flowRuleInfoIndex |
.1.3.6.1.2.1.40.1.1.1.1 |
|
An index which selects an entry in the flowRuleSetInfoTable.
Each such entry contains control information for a particular
RuleSet which the meter may run.
|
| flowRuleInfoSize |
.1.3.6.1.2.1.40.1.1.1.2 |
|
Number of rules in this RuleSet. Setting this variable will
cause the meter to allocate space for these rules.
|
| flowRuleInfoOwner |
.1.3.6.1.2.1.40.1.1.1.3 |
|
Identifies the manager which 'owns' this RuleSet. A manager
must set this variable when creating a row in this table.
|
| flowRuleInfoTimeStamp |
.1.3.6.1.2.1.40.1.1.1.4 |
|
Time this row's associated RuleSet was last changed.
|
| flowRuleInfoStatus |
.1.3.6.1.2.1.40.1.1.1.5 |
|
The status of this flowRuleSetInfoEntry. If this value is
not active(1) the meter must not attempt to use the row's
associated RuleSet. Once its value has been set to active(1)
a manager may not change any of the other variables in the
row, nor the contents of the associated RuleSet. Any attempt
to do so should result in a notWritable(17) SNMP error-status
for such variables or objects.
To download a RuleSet, a manger could:
- Locate an open slot in the RuleSetInfoTable.
- Create a RuleSetInfoEntry by setting the status for this
open slot to createAndWait(5).
- Set flowRuleInfoSize and flowRuleInfoName as required.
- Download the rules into the row's rule table.
- Set flowRuleInfoStatus to active(1).
The RuleSet would then be ready to run. The manager is not
allowed to change the value of flowRuleInfoStatus from
active(1) if the associated RuleSet is being referenced by any
of the entries in the flowManagerInfoTable.
Setting RuleInfoStatus to destroy(6) destroys the associated
RuleSet together with any flow data collected by it.
|
| flowRuleInfoName |
.1.3.6.1.2.1.40.1.1.1.6 |
|
An alphanumeric identifier used by managers and readers to
identify a RuleSet. For example, a manager wishing to run a
RuleSet named WWW-FLOWS could search the flowRuleSetInfoTable
to see whether the WWW-FLOWS RuleSet is already available on
the meter.
Note that references to RuleSets in the flowManagerInfoTable
use indexes for their flowRuleSetInfoTable entries. These may
be different each time the RuleSet is loaded into a meter.
|
| flowRuleInfoRulesReady |
.1.3.6.1.2.1.40.1.1.1.7 |
|
Indicates whether the rules for this row's associated RuleSet
are ready for use. The meter will refuse to 'run' the RuleSet
unless this variable has been set to true(1).
While RulesReady is false(2), the manager may modify the
RuleSet, for example by downloading rules into it.
|
| flowRuleInfoFlowRecords |
.1.3.6.1.2.1.40.1.1.1.8 |
|
The number of entries in the flow table for this RuleSet.
These may be current (waiting for collection by one or more
meter readers) or idle (waiting for the meter to recover
their memory).
|
| flowInterfaceSampleRate |
.1.3.6.1.2.1.40.1.2.1.1 |
|
The parameter N for statistical counting on this interface.
Set to N to count 1/Nth of the packets appearing at this
interface. A sampling rate of 1 counts all packets.
A sampling rate of 0 results in the interface being ignored
by the meter.
A meter should choose its own algorithm to introduce variance
into the sampling so that exactly every Nth packet is counted.
The IPPM Working Group's RFC 'Framework for IP Performance
Metrics' [IPPM-FRM] explains why this should be done, and sets
out an algorithm for doing it.
|
| flowInterfaceLostPackets |
.1.3.6.1.2.1.40.1.2.1.2 |
|
The number of packets the meter has lost for this interface.
Such losses may occur because the meter has been unable to
keep up with the traffic volume.
|
| flowReaderIndex |
.1.3.6.1.2.1.40.1.3.1.1 |
|
An index which selects an entry in the flowReaderInfoTable.
|
| flowReaderTimeout |
.1.3.6.1.2.1.40.1.3.1.2 |
|
Specifies the maximum time (in seconds) between flow data
collections for this meter reader. If this time elapses
without a collection, the meter should assume that this meter
reader has stopped collecting, and delete this row from the
table. A value of zero indicates that this row should not be
timed out.
|
| flowReaderOwner |
.1.3.6.1.2.1.40.1.3.1.3 |
|
Identifies the meter reader which created this row.
|
| flowReaderLastTime |
.1.3.6.1.2.1.40.1.3.1.4 |
|
Time this meter reader began its most recent data collection.
This variable should be written by a meter reader as its first
step in reading flow data. The meter will set this LastTime
value to its current Uptime, and set its PreviousTime value
(below) to the old LastTime. This allows the meter to
recover flows which have been inactive since PreviousTime,
for these have been collected at least once.
If the meter reader fails to write flowLastReadTime, collection
may still proceed but the meter may not be able to recover
inactive flows until the flowReaderTimeout has been reached
for this entry.
|
| flowReaderPreviousTime |
.1.3.6.1.2.1.40.1.3.1.5 |
|
Time this meter reader began the collection before last.
|
| flowReaderStatus |
.1.3.6.1.2.1.40.1.3.1.6 |
|
The status of this FlowReaderInfoEntry. A value of active(1)
implies that the associated reader should be collecting data
from the meter. Once this variable has been set to active(1)
a manager may only change this row's flowReaderLastTime and
flowReaderTimeout variables.
|
| flowReaderRuleSet |
.1.3.6.1.2.1.40.1.3.1.7 |
|
An index to the array of RuleSets. Specifies a set of rules
of interest to this meter reader. The reader will attempt to
collect any data generated by the meter for this RuleSet, and
the meter will not recover the memory of any of the RuleSet's
flows until this collection has taken place. Note that a
reader may have entries in this table for several RuleSets.
|
| flowManagerIndex |
.1.3.6.1.2.1.40.1.4.1.1 |
|
An index which selects an entry in the flowManagerInfoTable.
|
| flowManagerCurrentRuleSet |
.1.3.6.1.2.1.40.1.4.1.2 |
|
Index to the array of RuleSets. Specifies which set of
rules is the 'current' one for this task. The meter will
be 'running' the current RuleSet if this row's
flowManagerRunningStandby value is false(2).
When the manager sets this variable the meter will stop using
the task's old current RuleSet and start using the new one.
Specifying RuleSet 0 (the empty set) stops flow measurement
for this task.
|
| flowManagerStandbyRuleSet |
.1.3.6.1.2.1.40.1.4.1.3 |
|
Index to the array of RuleSets. After reaching HighWaterMark
(see below) the manager will switch to using the task's
StandbyRuleSet in place of its CurrentRuleSet. For this to be
effective the designated StandbyRuleSet should have a coarser
reporting granularity then the CurrentRuleSet. The manager may
also need to decrease the meter reading interval so that the
meter can recover flows measured by this task's CurrentRuleSet.
|
| flowManagerHighWaterMark |
.1.3.6.1.2.1.40.1.4.1.4 |
|
A value expressed as a percentage, interpreted by the meter
as an indication of how full the flow table should be before
it should switch to the standby RuleSet (if one has been
specified) for this task. Values of 0% or 100% disable the
checking represented by this variable.
|
| flowManagerCounterWrap |
.1.3.6.1.2.1.40.1.4.1.5 |
|
Specifies whether PDU and octet counters should wrap when
they reach the top of their range (normal behaviour for
Counter64 objects), or whether their scale factors should
be used instead. The combination of counter and scale
factor allows counts to be returned as non-negative binary
floating point numbers, with 64-bit mantissas and 8-bit
exponents.
|
| flowManagerOwner |
.1.3.6.1.2.1.40.1.4.1.6 |
|
Identifies the manager which created this row.
|
| flowManagerTimeStamp |
.1.3.6.1.2.1.40.1.4.1.7 |
|
Time this row was last changed by its manager.
|
| flowManagerStatus |
.1.3.6.1.2.1.40.1.4.1.8 |
|
The status of this row in the flowManagerInfoTable. A value
of active(1) implies that this task may be activated, by
setting its CurrentRuleSet and StandbyRuleSet variables.
Its HighWaterMark and RunningStandby variables may also be
changed.
|
| flowManagerRunningStandby |
.1.3.6.1.2.1.40.1.4.1.9 |
|
Set to true(1) by the meter to indicate that it has switched
to runnning this task's StandbyRuleSet in place of its
CurrentRuleSet. To switch back to the CurrentRuleSet, the
manager may simply set this variable to false(2).
|
| flowDataRuleSet |
.1.3.6.1.2.1.40.2.1.1.26 |
|
The RuleSet number of the RuleSet which created this flow.
Allows a manager to use GetNext or GetBulk requests to find
flows belonging to a particular RuleSet.
|
| flowDataTimeMark |
.1.3.6.1.2.1.40.2.1.1.2 |
|
A TimeFilter for this entry. Allows GetNext and GetBulk
to find flow table rows which have changed since a specified
value of the meter's Uptime.
|
| flowDataIndex |
.1.3.6.1.2.1.40.2.1.1.1 |
|
Value of this flow data record's index within the meter's
flow table.
|
| flowDataStatus |
.1.3.6.1.2.1.40.2.1.1.3 |
|
Status of this flow data record.
|
| flowDataSourceInterface |
.1.3.6.1.2.1.40.2.1.1.4 |
|
Index of the interface associated with the source address
for this flow. It's value is one of those contained in the
ifIndex field of the meter's interfaces table.
|
| flowDataSourceAdjacentType |
.1.3.6.1.2.1.40.2.1.1.5 |
|
Adjacent address type of the source for this flow.
If metering is being performed at the network level,
AdjacentType will indicate the medium for the interface on
which the flow was observed and AdjacentAddress will be the
MAC address for that interface. This is the usual case.
If traffic is being metered inside a tunnel, AdjacentType will
be the peer type of the host at the end of the tunnel and
AdjacentAddress will be the peer address for that host.
|
| flowDataSourceAdjacentAddress |
.1.3.6.1.2.1.40.2.1.1.6 |
|
Address of the adjacent device on the path for the source
for this flow.
|
| flowDataSourceAdjacentMask |
.1.3.6.1.2.1.40.2.1.1.7 |
|
1-bits in this mask indicate which bits must match when
comparing the adjacent source address for this flow.
|
| flowDataSourcePeerType |
.1.3.6.1.2.1.40.2.1.1.8 |
|
Peer address type of the source for this flow.
|
| flowDataSourcePeerAddress |
.1.3.6.1.2.1.40.2.1.1.9 |
|
Address of the peer device for the source of this flow.
|
| flowDataSourcePeerMask |
.1.3.6.1.2.1.40.2.1.1.10 |
|
1-bits in this mask indicate which bits must match when
comparing the source peer address for this flow.
|
| flowDataSourceTransType |
.1.3.6.1.2.1.40.2.1.1.11 |
|
Transport address type of the source for this flow. The
value of this attribute will depend on the peer address type.
|
| flowDataSourceTransAddress |
.1.3.6.1.2.1.40.2.1.1.12 |
|
Transport address for the source of this flow.
|
| flowDataSourceTransMask |
.1.3.6.1.2.1.40.2.1.1.13 |
|
1-bits in this mask indicate which bits must match when
comparing the transport source address for this flow.
|
| flowDataDestInterface |
.1.3.6.1.2.1.40.2.1.1.14 |
|
Index of the interface associated with the dest address for
this flow. This value is one of the values contained in the
ifIndex field of the interfaces table.
|
| flowDataDestAdjacentType |
.1.3.6.1.2.1.40.2.1.1.15 |
|
Adjacent address type of the destination for this flow.
|
| flowDataDestAdjacentAddress |
.1.3.6.1.2.1.40.2.1.1.16 |
|
Address of the adjacent device on the path for the
destination for this flow.
|
| flowDataDestAdjacentMask |
.1.3.6.1.2.1.40.2.1.1.17 |
|
1-bits in this mask indicate which bits must match when
comparing the adjacent destination address for this flow.
|
| flowDataDestPeerType |
.1.3.6.1.2.1.40.2.1.1.18 |
|
Peer address type of the destination for this flow.
|
| flowDataDestPeerAddress |
.1.3.6.1.2.1.40.2.1.1.19 |
|
Address of the peer device for the destination of this flow.
|
| flowDataDestPeerMask |
.1.3.6.1.2.1.40.2.1.1.20 |
|
1-bits in this mask indicate which bits must match when
comparing the destination peer type for this flow.
|
| flowDataDestTransType |
.1.3.6.1.2.1.40.2.1.1.21 |
|
Transport address type of the destination for this flow. The
value of this attribute will depend on the peer address type.
|
| flowDataDestTransAddress |
.1.3.6.1.2.1.40.2.1.1.22 |
|
Transport address for the destination of this flow.
|
| flowDataDestTransMask |
.1.3.6.1.2.1.40.2.1.1.23 |
|
1-bits in this mask indicate which bits must match when
comparing the transport destination address for this flow.
|
| flowDataPDUScale |
.1.3.6.1.2.1.40.2.1.1.24 |
|
The scale factor applied to this particular flow. Indicates
the number of bits the PDU counter values should be moved left
to obtain the actual values.
|
| flowDataOctetScale |
.1.3.6.1.2.1.40.2.1.1.25 |
|
The scale factor applied to this particular flow. Indicates
the number of bits the octet counter values should be moved
left to obtain the actual values.
|
| flowDataToOctets |
.1.3.6.1.2.1.40.2.1.1.27 |
|
The count of octets flowing from source to destination
for this flow.
|
| flowDataToPDUs |
.1.3.6.1.2.1.40.2.1.1.28 |
|
The count of packets flowing from source to destination
for this flow.
|
| flowDataFromOctets |
.1.3.6.1.2.1.40.2.1.1.29 |
|
The count of octets flowing from destination to source
for this flow.
|
| flowDataFromPDUs |
.1.3.6.1.2.1.40.2.1.1.30 |
|
The count of packets flowing from destination to source
for this flow.
|
| flowDataFirstTime |
.1.3.6.1.2.1.40.2.1.1.31 |
|
The time at which this flow was first entered in the table
|
| flowDataLastActiveTime |
.1.3.6.1.2.1.40.2.1.1.32 |
|
The last time this flow had activity, i.e. the time of
arrival of the most recent PDU belonging to this flow.
|
| flowDataSourceSubscriberID |
.1.3.6.1.2.1.40.2.1.1.33 |
|
Subscriber ID associated with the source address for this
flow. A Subscriber ID is an unspecified text string, used
to ascribe traffic flows to individual users. At this time
the means by which a Subscriber ID may be associated with a
flow is unspecified.
|
| flowDataDestSubscriberID |
.1.3.6.1.2.1.40.2.1.1.34 |
|
Subscriber ID associated with the destination address for
this flow. A Subscriber ID is an unspecified text string,
used to ascribe traffic flows to individual users. At this
time the means by which a Subscriber ID may be associated
with a flow is unspecified.
|
| flowDataSessionID |
.1.3.6.1.2.1.40.2.1.1.35 |
|
Session ID for this flow. Such an ID might be allocated
by a network access server to distinguish a series of sessions
between the same pair of addresses, which would otherwise
appear to be parts of the same accounting flow.
|
| flowDataSourceClass |
.1.3.6.1.2.1.40.2.1.1.36 |
|
Source class for this flow. Determined by the rules, set by
a PushRule action when this flow was entered in the table.
|
| flowDataDestClass |
.1.3.6.1.2.1.40.2.1.1.37 |
|
Destination class for this flow. Determined by the rules, set
by a PushRule action when this flow was entered in the table.
|
| flowDataClass |
.1.3.6.1.2.1.40.2.1.1.38 |
|
Class for this flow. Determined by the rules, set by a
PushRule action when this flow was entered in the table.
|
| flowDataSourceKind |
.1.3.6.1.2.1.40.2.1.1.39 |
|
Source kind for this flow. Determined by the rules, set by
a PushRule action when this flow was entered in the table.
|
| flowDataDestKind |
.1.3.6.1.2.1.40.2.1.1.40 |
|
Destination kind for this flow. Determined by the rules, set
by a PushRule action when this flow was entered in the table.
|
| flowDataKind |
.1.3.6.1.2.1.40.2.1.1.41 |
|
Class for this flow. Determined by the rules, set by a
PushRule action when this flow was entered in the table.
|
| flowColumnActivityAttribute |
.1.3.6.1.2.1.40.2.2.1.1 |
|
Specifies the attribute for which values are required from
active flows.
|
| flowColumnActivityTime |
.1.3.6.1.2.1.40.2.2.1.2 |
|
This variable is a copy of flowDataLastActiveTime in the
flow data record identified by the flowColumnActivityIndex
value of this flowColumnActivityTable entry.
|
| flowColumnActivityIndex |
.1.3.6.1.2.1.40.2.2.1.3 |
|
Index of a flow table entry which was active at or after
a specified flowColumnActivityTime.
|
| flowColumnActivityData |
.1.3.6.1.2.1.40.2.2.1.4 |
|
Collection of attribute data for flows active after
flowColumnActivityTime. Within the OCTET STRING is a
sequence of { flow index, attribute value } pairs, one for
each active flow. The end of the sequence is marked by a
flow index value of 0, indicating that there are no more
rows in this column.
The format of objects inside flowColumnFlowData is as follows.
All numbers are unsigned. Numbers and strings appear with
their high-order bytes leading. Numbers are fixed size, as
specified by their SYNTAX in the flow table (above), i.e. one
octet for flowAddressType and small constants, and four octets
for Counter and TimeStamp. Strings are variable-length, with
the length given in a single leading octet.
The following is an attempt at an ASN.1 definition of
flowColumnActivityData:
flowColumnActivityData ::= SEQUENCE flowRowItemEntry
flowRowItemEntry ::= SEQUENCE {
flowRowNumber Integer32 (1..65535),
-- 0 indicates the end of this column
flowDataValue flowDataType -- Choice depends on attribute
}
flowDataType ::= CHOICE {
flowByteValue Integer32 (1..255),
flowShortValue Integer32 (1..65535),
flowLongValue Integer32,
flowStringValue OCTET STRING -- Length (n) in first byte,
-- n+1 bytes total length, trailing zeroes truncated
}
|
| flowPackageSelector |
.1.3.6.1.2.1.40.2.3.1.1 |
|
Specifies the attributes for which values are required from
an active flow. These are encoded as a sequence of octets
each containing a FlowAttribute number, preceded by an octet
giving the length of the sequence (not including the length
octet). For a flowPackageSelector to be valid, it must
contain at least one attribute.
|
| flowPackageRuleSet |
.1.3.6.1.2.1.40.2.3.1.2 |
|
Specifies the index (in the flowRuleSetInfoTable) of the rule
set which produced the required flow.
|
| flowPackageTime |
.1.3.6.1.2.1.40.2.3.1.3 |
|
This variable is a copy of flowDataLastActiveTime in the
flow data record identified by the flowPackageIndex
value of this flowPackageTable entry.
|
| flowPackageIndex |
.1.3.6.1.2.1.40.2.3.1.4 |
|
Index of a flow table entry which was active at or after
a specified flowPackageTime.
|
| flowPackageData |
.1.3.6.1.2.1.40.2.3.1.5 |
|
A collection of attribute values for a single flow, as
specified by this row's indexes. The attribute values are
contained within a BER-encoded sequence [ASN-1, ASN-BER],
in the order they appear in their flowPackageSelector.
For example, to retrieve a flowPackage containing values for
attributes 11, 18 and 29, for a flow in RuleSet 7, with flow
index 3447, one would GET the package whose Object Identifier
(OID) is
flowPackageData . 3.11.18.29 . 7. 0 . 3447
To get a package for the next such flow which had been
active since time 12345 one would GETNEXT the package whose
Object Identifier (OID) is
flowPackageData . 3.11.18.29 . 7. 12345 . 3447
|
| flowRuleSet |
.1.3.6.1.2.1.40.3.1.1.1 |
|
Selects a RuleSet from the array of RuleSets.
|
| flowRuleIndex |
.1.3.6.1.2.1.40.3.1.1.2 |
|
The index into the Rule table. N.B: These values will
normally be consecutive, given the fall-through semantics
of processing the table.
|
| flowRuleSelector |
.1.3.6.1.2.1.40.3.1.1.3 |
|
Indicates the attribute to be matched.
null(0) is a special case; null rules always succeed.
matchingStoD(50) is set by the meter's Packet Matching Engine.
Its value is true(1) if the PME is attempting to match the
packet with its addresses in Source-to-Destination order (i.e.
as they appear in the packet), and false(2) otherwise.
Details of how packets are matched are given in the 'Traffic
Flow Measurement: Architecture' document [RTFM-ARC].
v1(51), v2(52), v3(53), v4(54) and v5(55) select meter
variables, each of which can hold the name (i.e. selector
value) of an address attribute. When one of these is used
as a selector, its value specifies the attribute to be
tested. Variable values are set by an Assign action.
|
| flowRuleMask |
.1.3.6.1.2.1.40.3.1.1.4 |
|
The initial mask used to compute the desired value. If the
mask is zero the rule's test will always succeed.
|
| flowRuleMatchedValue |
.1.3.6.1.2.1.40.3.1.1.5 |
|
The resulting value to be matched for equality.
Specifically, if the attribute chosen by the flowRuleSelector
logically ANDed with the mask specified by the flowRuleMask
equals the value specified in the flowRuleMatchedValue, then
continue processing the table entry based on the action
specified by the flowRuleAction entry. Otherwise, proceed to
the next entry in the rule table.
|
| flowRuleAction |
.1.3.6.1.2.1.40.3.1.1.6 |
|
The action to be taken if this rule's test succeeds, or if
the meter's 'test' flag is off. Actions are opcodes for the
meter's Packet Matching Engine; details are given in the
'Traffic Flow Measurement: Architecture' document [RTFM-ARC].
|
| flowRuleParameter |
.1.3.6.1.2.1.40.3.1.1.7 |
|
A parameter value providing extra information for this rule's
action. Most of the actions use the parameter value to specify
which rule to execute after this rule's test has failed; details
are given in the 'Traffic Flow Measurement: Architecture'
document [RTFM-ARC].
|
