draft-ietf-rtfm-meter-mib-02.txt   draft-ietf-rtfm-meter-mib-03.txt 
Internet Engineering Task Force Nevil Brownlee Internet Engineering Task Force Nevil Brownlee
INTERNET-DRAFT The University of Auckland INTERNET-DRAFT The University of Auckland
September 1997 November 1997
Traffic Flow Measurement: Meter MIB Traffic Flow Measurement: Meter MIB
<draft-ietf-rtfm-meter-mib-02.txt> <draft-ietf-rtfm-meter-mib-03.txt>
Status of this Memo Status of this Memo
This document is an Internet Draft. Internet Drafts are working This document is an Internet-Draft. Internet-Drafts are working
documents of the Internet Engineering Task Force (IETF), its Areas, and documents of the Internet Engineering Task Force (IETF), its Areas, and
its Working Groups. Note that other groups may also distribute working its Working Groups. Note that other groups may also distribute working
documents as Internet Drafts. This Internet Draft is a product of the documents as Internet-Drafts. This Internet Draft is a product of the
Realtime Traffic Flow Measurement Working Group of the IETF. Realtime Traffic Flow Measurement Working Group of the IETF.
Internet Drafts are draft documents valid for a maximum of six months. Internet Drafts are draft documents valid for a maximum of six months.
Internet Drafts may be updated, replaced, or obsoleted by other Internet Drafts may be updated, replaced, or obsoleted by other
documents at any time. It is not appropriate to use Internet Drafts as documents at any time. It is not appropriate to use Internet Drafts as
reference material or to cite them other than as a "working draft" or reference material or to cite them other than as a "working draft" or
"work in progress." "work in progress."
Please check the I-D abstract listing contained in the internet-drafts To view the entire list of current Internet-Drafts, please check the
Shadow Directories on nic.ddn.mil, nnsc.nsf.net, nic.nordu.net, "1id-abstracts.txt" listing contained in the Internet-Drafts Shadow
ftp.nisc.sri.com or munnari.oz.au to learn the current status of this or Directories on ftp.is.co.za (Africa), ftp.nordu.net (Europe),
any other Internet Draft. munnari.oz.au (Pacific Rim), ds.internic.net (US East Coast), or
ftp.isi.edu (US West Coast).
Abstract Abstract
A 'Traffic Meter' collects data relating to traffic flows within a A 'Traffic Meter' collects data relating to traffic flows within a
network. This document defines a Management Information Base (MIB) for network. This document defines a Management Information Base (MIB) for
use in controlling a traffic meter, in particular for specifying the use in controlling a traffic meter, in particular for specifying the
flows to be measured. It also provides an efficient mechanism for flows to be measured. It also provides an efficient mechanism for
retrieving flow data from the meter using SNMP. Security issues retrieving flow data from the meter using SNMP. Security issues
concerning the operation of traffic meters are summarised. concerning the operation of traffic meters are summarised.
Contents Contents
1 Introduction 1 1 Introduction 2
2 The Network Management Framework 2 2 The Network Management Framework 2
3 Objects 3
3.1 Format of Definitions . . . . . . . . . . . . . . . . . . . . 4
3 Objects 2 4 Overview 4
3.1 Format of Definitions . . . . . . . . . . . . . . . . . . . . 3
4 Overview 3
4.1 Scope of Definitions, Textual Conventions . . . . . . . . . . 4 4.1 Scope of Definitions, Textual Conventions . . . . . . . . . . 4
4.2 Usage of the MIB variables . . . . . . . . . . . . . . . . . . 4 4.2 Usage of the MIB variables . . . . . . . . . . . . . . . . . . 5
5 Changes Introduced Since RFC 2064 6 5 Changes Introduced Since RFC 2064 6
6 Definitions 7 6 Definitions 7
7 Security Considerations 42 7 Security Considerations 43
8 Acknowledgements 43 8 Acknowledgements 44
9 References 43 9 References 44
10 Author's Address 45 10Author's Address 46
1 Introduction 1 Introduction
This memo defines a portion of the Management Information Base (MIB) for This memo defines a portion of the Management Information Base (MIB) for
use with network management protocols in the Internet community. In use with network management protocols in the Internet community. In
particular, it describes objects for managing and collecting data from particular, it describes objects for managing and collecting data from
network Realtime Traffic Flow Meters, as described in [9]. network Realtime Traffic Flow Meters, as described in [9].
The MIB is 'basic' in the sense that it provides more than enough The MIB is 'basic' in the sense that it provides more than enough
information for everyday traffic measurment. Furthermore, it can be information for everyday traffic measurment. Furthermore, it can be
skipping to change at page 6, line 20 skipping to change at page 6, line 23
The decision as to which manager is the 'master' must be made by the The decision as to which manager is the 'master' must be made by the
network operations personnel responsible; this MIB does not attempt to network operations personnel responsible; this MIB does not attempt to
define any interaction between managers. define any interaction between managers.
There are three other groups of control variables, arranged into tables There are three other groups of control variables, arranged into tables
in the same way as in the RMON2 MIB [10]. They are used as follows: in the same way as in the RMON2 MIB [10]. They are used as follows:
- RULE SET INFO: Before attempting to download a RuleSet, a manager - RULE SET INFO: Before attempting to download a RuleSet, a manager
must create a row in the flowRuleSetInfoTable and set its must create a row in the flowRuleSetInfoTable and set its
flowRuleInfoSize to a value large enough to hold the RuleSet. When flowRuleInfoSize to a value large enough to hold the RuleSet. When
the rule set is ready the manager must set flowRuleInfoStatus to the rule set is ready the manager must set flowRuleInfoRulesReady
'active,' indicating that the rule set is ready for use (but not to 'true,' indicating that the rule set is ready for use (but not
yet 'running'). yet 'running').
- METER READER INFO: Any meter reader wishing to collect data - METER READER INFO: Any meter reader wishing to collect data
reliably for all flows from a RuleSet should first create a row in reliably for all flows from a RuleSet should first create a row in
the flowReaderInfoTable with flowReaderRuleSet set to that the flowReaderInfoTable with flowReaderRuleSet set to that
RuleSet's index in the flowRuleSetInfoTable. It should write that RuleSet's index in the flowRuleSetInfoTable. It should write that
row's flowReaderLastTime object each time it starts a collection row's flowReaderLastTime object each time it starts a collection
pass through the flow table. The meter will not recover a flow's pass through the flow table. The meter will not recover a flow's
memory until every meter reader holding a row for that flow's memory until every meter reader holding a row for that flow's
RuleSet has collected the flow's data. RuleSet has collected the flow's data.
skipping to change at page 15, line 35 skipping to change at page 15, line 35
::= { flowRuleSetInfoEntry 4 } ::= { flowRuleSetInfoEntry 4 }
flowRuleInfoStatus OBJECT-TYPE flowRuleInfoStatus OBJECT-TYPE
SYNTAX RowStatus SYNTAX RowStatus
MAX-ACCESS read-create MAX-ACCESS read-create
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The status of this flowRuleSetInfoEntry. If this value is "The status of this flowRuleSetInfoEntry. If this value is
not active(1) the meter must not attempt to use the row's not active(1) the meter must not attempt to use the row's
associated rule set. Once its value has been set to active(1) associated rule set. Once its value has been set to active(1)
a manager may only change this row's flowRuleInfoSize, a manager may not change any of the other variables in the
flowRuleInfoName and floeRuleInfoRulesReady variables." row, nor the contents of the associated rule set.
To download a rule set, 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 rule set 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
rule set together with any flow data collected by it."
::= { flowRuleSetInfoEntry 5 } ::= { flowRuleSetInfoEntry 5 }
flowRuleInfoName OBJECT-TYPE flowRuleInfoName OBJECT-TYPE
SYNTAX OCTET STRING SYNTAX OCTET STRING
MAX-ACCESS read-create MAX-ACCESS read-create
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"An alphanumeric identifier used by managers and readers to "An alphanumeric identifier used by managers and readers to
identify a rule set. For example, a manager wishing to run a identify a rule set. For example, a manager wishing to run a
rule set named WWW-FLOWS could search the flowRuleSetInfoTable rule set named WWW-FLOWS could search the flowRuleSetInfoTable
skipping to change at page 16, line 12 skipping to change at page 16, line 28
be different each time the rule set is loaded into a meter." be different each time the rule set is loaded into a meter."
::= { flowRuleSetInfoEntry 6 } ::= { flowRuleSetInfoEntry 6 }
flowRuleInfoRulesReady OBJECT-TYPE flowRuleInfoRulesReady OBJECT-TYPE
SYNTAX TruthValue SYNTAX TruthValue
MAX-ACCESS read-create MAX-ACCESS read-create
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"Indicates whether the rules for this row's associated rule set "Indicates whether the rules for this row's associated rule set
are ready for use. The meter will refuse to 'run' the rule set are ready for use. The meter will refuse to 'run' the rule set
unless this variable has been set to true(1)." unless this variable has been set to true(1).
While RulesReady is false(2), the manager may modify the rule
set, for example by downloading rules into it."
::= { flowRuleSetInfoEntry 7 } ::= { flowRuleSetInfoEntry 7 }
flowRuleInfoFlowRecords OBJECT-TYPE flowRuleInfoFlowRecords OBJECT-TYPE
SYNTAX Integer32 SYNTAX Integer32
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"The number of entries in the flow table for this rule set. "The number of entries in the flow table for this rule set.
These may be current (waiting for collection by one or more These may be current (waiting for collection by one or more
meter readers) or idle (waiting for the meter to recover meter readers) or idle (waiting for the meter to recover
skipping to change at page 21, line 26 skipping to change at page 21, line 44
flowManagerCurrentRuleSet OBJECT-TYPE flowManagerCurrentRuleSet OBJECT-TYPE
SYNTAX Integer32 SYNTAX Integer32
MAX-ACCESS read-create MAX-ACCESS read-create
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"Index to the array of rule sets. Specifies which set of "Index to the array of rule sets. Specifies which set of
rules is the 'current' one for this task. The meter will rules is the 'current' one for this task. The meter will
be 'running' the current ruleset if this row's be 'running' the current ruleset if this row's
flowManagerRunningStandby value is false(2). flowManagerRunningStandby value is false(2).
When the manager sets this variable the meter will close the When the manager sets this variable the meter will stop using
task's old current rule set and start using the new one. the task's old current rule set and start using the new one.
Specifying rule set 0 (the empty set) stops flow measurement Specifying rule set 0 (the empty set) stops flow measurement
by this manager. Flows created by the old rule set remain for this task."
in memory, orphaned until their data has been read."
::= { flowManagerInfoEntry 2 } ::= { flowManagerInfoEntry 2 }
flowManagerStandbyRuleSet OBJECT-TYPE flowManagerStandbyRuleSet OBJECT-TYPE
SYNTAX Integer32 SYNTAX Integer32
MAX-ACCESS read-create MAX-ACCESS read-create
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"Index to the array of rule sets. After reaching HighWaterMark "Index to the array of rule sets. After reaching HighWaterMark
(see below) the manager will switch to using the task's (see below) the manager will switch to using the task's
StandbyRuleSet in place of its CurrentRuleSet. For this to be StandbyRuleSet in place of its CurrentRuleSet. For this to be
effective the designated StandbyRuleSet should have a coarser effective the designated StandbyRuleSet should have a coarser
reporting granularity then the CurrentRuleSet. The manager may reporting granularity then the CurrentRuleSet. The manager may
also need to decrease the meter reading interval so that the also need to decrease the meter reading interval so that the
meter can recover flows measured by the CurrentRuleSet." meter can recover flows measured by this task's CurrentRuleSet."
DEFVAL { 0 } -- No standby DEFVAL { 0 } -- No standby
::= { flowManagerInfoEntry 3 } ::= { flowManagerInfoEntry 3 }
flowManagerHighWaterMark OBJECT-TYPE flowManagerHighWaterMark OBJECT-TYPE
SYNTAX Integer32 (0..100) SYNTAX Integer32 (0..100)
MAX-ACCESS read-create MAX-ACCESS read-create
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"A value expressed as a percentage, interpreted by the meter "A value expressed as a percentage, interpreted by the meter
as an indication of how full the flow table should be before as an indication of how full the flow table should be before
skipping to change at page 33, line 38 skipping to change at page 34, line 5
-- --
-- The Activity Column Table -- The Activity Column Table
-- --
flowColumnActivityTable OBJECT-TYPE flowColumnActivityTable OBJECT-TYPE
SYNTAX SEQUENCE OF FlowColumnActivityEntry SYNTAX SEQUENCE OF FlowColumnActivityEntry
MAX-ACCESS not-accessible MAX-ACCESS not-accessible
STATUS deprecated STATUS deprecated
DESCRIPTION DESCRIPTION
"Index into the Flow Table. Allows a meter reader to retrieve "Index into the Flow Table. Allows a meter reader to retrieve
a list containing the flow table indeces of flows which were a list containing the flow table indexes of flows which were
last active at or after a given time, together with the values last active at or after a given time, together with the values
of a specified attribute for each such flow." of a specified attribute for each such flow."
::= { flowData 2 } ::= { flowData 2 }
flowColumnActivityEntry OBJECT-TYPE flowColumnActivityEntry OBJECT-TYPE
SYNTAX FlowColumnActivityEntry SYNTAX FlowColumnActivityEntry
MAX-ACCESS not-accessible MAX-ACCESS not-accessible
STATUS deprecated STATUS deprecated
DESCRIPTION DESCRIPTION
"The Column Activity Entry for a particular attribute, "The Column Activity Entry for a particular attribute,
skipping to change at page 36, line 18 skipping to change at page 36, line 35
flowPackageSelector OBJECT-TYPE flowPackageSelector OBJECT-TYPE
SYNTAX OCTET STRING SYNTAX OCTET STRING
MAX-ACCESS not-accessible MAX-ACCESS not-accessible
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"Specifies the attributes for which values are required from "Specifies the attributes for which values are required from
an active flow. These are encoded as a sequence of octets an active flow. These are encoded as a sequence of octets
each containing a FlowAttribute number, preceded by an octet each containing a FlowAttribute number, preceded by an octet
giving the length of the sequence (not including the length giving the length of the sequence (not including the length
octet)." octet). For a flowPackageSelector to be valid, it must
contain at least one attribute."
::= { flowDataPackageEntry 1 } ::= { flowDataPackageEntry 1 }
flowPackageRuleSet OBJECT-TYPE flowPackageRuleSet OBJECT-TYPE
SYNTAX Integer32 (1..255) SYNTAX Integer32 (1..255)
MAX-ACCESS not-accessible MAX-ACCESS not-accessible
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"Specifies the index (in the flowRuleSetInfoTable) of the rule "Specifies the index (in the flowRuleSetInfoTable) of the rule
set which produced the required flow." set which produced the required flow."
::= { flowDataPackageEntry 2 } ::= { flowDataPackageEntry 2 }
skipping to change at page 36, line 54 skipping to change at page 37, line 21
DESCRIPTION DESCRIPTION
"Index of a flow table entry which was active at or after "Index of a flow table entry which was active at or after
a specified flowPackageTime." a specified flowPackageTime."
::= { flowDataPackageEntry 4 } ::= { flowDataPackageEntry 4 }
flowPackageData OBJECT-TYPE flowPackageData OBJECT-TYPE
SYNTAX OCTET STRING SYNTAX OCTET STRING
MAX-ACCESS read-only MAX-ACCESS read-only
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"A Collection of attribute values for a single flow, as "A collection of attribute values for a single flow, as
specified by this row's indeces. The attribute values are specified by this row's indexes. The attribute values are
contained within a BER-encoded sequence [7], in the order contained within a BER-encoded sequence [7], in the order
they appear in their flowPackageSelector. For example, to they appear in their flowPackageSelector.
retrieve a flowPackage containing values for attributes 11,
18 and 29, for flows in rule set 7, active since uptime 12345, For example, to retrieve a flowPackage containing values for
beginning with the first row after row 3447, one would request attributes 11, 18 and 29, for a flow in rule set 7, with flow
the package whose Object Identifier (OID) is index 3447, one would GET the package whose Object Identifier
(OID) was
flowPackageData . 3.11.18.29 . 7. 0 . 3447
To retrieve a flowPackage for the next such flow, which had
been active since time 12345, one would GETNEXT the package
whose Object Identifier (OID) was
flowPackageData . 3.11.18.29 . 7. 12345 . 3447 " flowPackageData . 3.11.18.29 . 7. 12345 . 3447 "
::= { flowDataPackageEntry 5 } ::= { flowDataPackageEntry 5 }
-- --
-- The Rule Table -- The Rule Table
-- --
-- This is an array of rule sets; the 'running' ones are indicated
-- by the entries in the meter's flowManagerInfoTable. Several rule -- by the entries in the meter's flowManagerInfoTable. Several rule
-- sets can be held in a meter so that the manager can change the
-- running rule sets easily, for example with time of day. Note that
-- a manager may not change the rules in any rule set currently
-- referenced within the flowManagerInfoTable (either as 'current' or
-- 'standby')! See the 'Traffic Flow Measurement: Architecture'
-- document [9] for details of rules and how they are used.
-- --
-- Space for a rule table is allocated by setting the value of -- Space for a rule table is allocated by setting the value of
-- flowRuleInfoSize in the rule table's flowRuleSetInfoTable row. -- flowRuleInfoSize in the rule table's flowRuleSetInfoTable row.
flowRuleTable OBJECT-TYPE flowRuleTable OBJECT-TYPE
SYNTAX SEQUENCE OF FlowRuleEntry SYNTAX SEQUENCE OF FlowRuleEntry
MAX-ACCESS not-accessible MAX-ACCESS not-accessible
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"Contains all the rule sets which may be used by the meter." "Contains all the rule sets which may be used by the meter."
skipping to change at page 38, line 7 skipping to change at page 38, line 33
flowRuleSet Integer32, flowRuleSet Integer32,
flowRuleIndex Integer32, flowRuleIndex Integer32,
flowRuleSelector RuleAttributeNumber, flowRuleSelector RuleAttributeNumber,
flowRuleMask RuleAddress, flowRuleMask RuleAddress,
flowRuleMatchedValue RuleAddress, flowRuleMatchedValue RuleAddress,
flowRuleAction ActionNumber, flowRuleAction ActionNumber,
flowRuleParameter Integer32 flowRuleParameter Integer32
} }
flowRuleSet OBJECT-TYPE flowRuleSet OBJECT-TYPE
SYNTAX Integer32 (1..255) SYNTAX Integer32 (1..2147483647)
MAX-ACCESS not-accessible MAX-ACCESS not-accessible
STATUS current STATUS current
DESCRIPTION DESCRIPTION
"Selects a rule set from the array of rule sets." "Selects a rule set from the array of rule sets."
::= { flowRuleEntry 1 } ::= { flowRuleEntry 1 }
flowRuleIndex OBJECT-TYPE flowRuleIndex OBJECT-TYPE
SYNTAX Integer32 (1..65535) SYNTAX Integer32 (1..65535)
MAX-ACCESS not-accessible MAX-ACCESS not-accessible
STATUS current STATUS current
 End of changes. 26 change blocks. 
38 lines changed or deleted 69 lines changed or added

This html diff was produced by rfcdiff 1.34. The latest version is available from http://tools.ietf.org/tools/rfcdiff/