FLOW-METER-MIB DEFINITIONS ::= BEGIN

IMPORTS

    MODULE-IDENTITY, OBJECT-TYPE,

    Counter32, Counter64, Integer32, mib-2

        FROM SNMPv2-SMI

    TEXTUAL-CONVENTION, RowStatus, TimeStamp, TruthValue

        FROM SNMPv2-TC

    OBJECT-GROUP, MODULE-COMPLIANCE

        FROM SNMPv2-CONF

    ifIndex

        FROM IF-MIB

    TimeFilter

        FROM RMON2-MIB;

flowMIB MODULE-IDENTITY

    LAST-UPDATED "9910250000Z" -- October 25, 1999

    ORGANIZATION "IETF Realtime Traffic Flow Measurement Working Group"

    CONTACT-INFO

        "Nevil Brownlee, The University of Auckland

        Postal: Information Technology Sytems & Services

                The University of Auckland

                Private Bag 92-019

                Auckland, New Zealand

        Phone:  +64 9 373 7599 x8941

        E-mail: n.brownlee@auckland.ac.nz"

    DESCRIPTION

        "MIB for the RTFM Traffic Flow Meter."

    REVISION "9910250000Z"

    DESCRIPTION

        "Initial Version, published as RFC 2720."

     REVISION "9908301250Z"

     DESCRIPTION

         "UTF8OwnerString Textual Convention added, and used to

         replace OwnerString.  Conceptually the same as OwnerString,

         but facilitating internationalisation by using UTF-8

         encoding for its characters rather than US-ASCII."

    REVISION "9908191010Z"

    DESCRIPTION

        "Changes to SIZE specification for two variables:

          - flowRuleInfoName SIZE specified as (0..127)

          - flowRuleIndex SIZE increased to (1..2147483647)"

    REVISION "9712230937Z"

    DESCRIPTION

        "Two further variables deprecated:

          - flowRuleInfoRulesReady (use flowRuleInfoStatus intead)

          - flowDataStatus (contains no useful information)"

    REVISION "9707071715Z"

    DESCRIPTION

        "Significant changes since RFC 2064 include:

          - flowDataPackageTable added

          - flowColumnActivityTable deprecated

          - flowManagerCounterWrap deprecated"

    REVISION "9603080208Z"

    DESCRIPTION

        "Initial version of this MIB (RFC 2064)"

    ::= { mib-2 40 }

flowControl         OBJECT IDENTIFIER ::= { flowMIB 1 }

flowData            OBJECT IDENTIFIER ::= { flowMIB 2 }

flowRules           OBJECT IDENTIFIER ::= { flowMIB 3 }

flowMIBConformance  OBJECT IDENTIFIER ::= { flowMIB 4 }

-- Textual Conventions

UTF8OwnerString ::= TEXTUAL-CONVENTION

    DISPLAY-HINT "127t"

    STATUS  current

    DESCRIPTION

        "An administratively assigned name for the owner of a

        resource, conceptually the same as OwnerString in the RMON

        MIB [RMON-MIB].

        To facilitate internationalisation, this name information

        is represented using the ISO/IEC IS 10646-1 character set,

        encoded as an octet string using the UTF-8 transformation

        format described in the UTF-8 standard [UTF-8]."

    SYNTAX  OCTET STRING (SIZE (0..127))

PeerType ::= TEXTUAL-CONVENTION

    STATUS  current

    DESCRIPTION

        "Indicates the type of a PeerAddress (see below).  The values

        used are from the 'Address Family Numbers' section of the

        Assigned Numbers RFC [ASG-NBR].  Peer types from other address

        families may also be used, provided only that they are

        identified by their assigned Address Family numbers."

    SYNTAX  INTEGER {

        ipv4(1),

        ipv6(2),

        nsap(3),

        ipx(11),

        appletalk(12),

        decnet(13) }

PeerAddress ::= TEXTUAL-CONVENTION

    STATUS  current

    DESCRIPTION

        "Specifies the value of a peer address for various network

        protocols.  Address format depends on the actual protocol,

        as indicated below:

        IPv4:        ipv4(1)

            4-octet IpAddress  (defined in the SNMPv2 SMI [RFC2578])

        IPv6:        ipv6(2)

            16-octet IpAddress  (defined in the

                                    IPv6 Addressing RFC [V6-ADDR])

        CLNS:        nsap(3)

            NsapAddress  (defined in the SNMPv2 SMI [RFC2578])

        Novell:      ipx(11)

            4-octet Network number,

            6-octet Host number (MAC address)

        AppleTalk:   appletalk(12)

            2-octet Network number (sixteen bits),

            1-octet Host number (eight bits)

        DECnet:      decnet(13)

            1-octet Area number (in low-order six bits),

            2-octet Host number (in low-order ten bits)

        "

    SYNTAX OCTET STRING (SIZE (3..20))

AdjacentType ::= TEXTUAL-CONVENTION

    STATUS  current

    DESCRIPTION

        "Indicates the type of an adjacent address.  May be a medium

        type or (if metering is taking place inside a tunnel) a

        PeerType (see above).

        The values used for IEEE 802 medium types are from the 'Network

        Management Parameters (ifType definitions)' section of the

        Assigned Numbers RFC [ASG-NBR].  Other medium types may also

        be used, provided only that they are identified by their

        assigned ifType numbers."

    SYNTAX  INTEGER {

        ip(1),

        nsap(3),

        ethernet(7),  -- ethernet-like [ENET-OBJ],

                      --    includes ethernet-csmacd(6)

        tokenring(9),

        ipx(11),

        appletalk(12),

        decnet(13),

        fddi(15) }

AdjacentAddress ::= TEXTUAL-CONVENTION

    STATUS  current

    DESCRIPTION

        "Specifies the value of an adjacent address.  May be a Medium

        Access Control (MAC) address or (if metering is taking place

        inside a tunnel) a PeerAddress (see above).

        MAC Address format depends on the actual medium, as follows:

        Ethernet:     ethernet(7)

            6-octet 802.3 MAC address in 'canonical' order

        Token Ring:   tokenring(9)

            6-octet 802.5 MAC address in 'canonical' order

        FDDI:         fddi(15)

            FddiMACLongAddress, i.e. a 6-octet MAC address

            in 'canonical' order  (defined in [FDDI-MIB])

        "

    SYNTAX OCTET STRING (SIZE (3..20))

TransportType ::= TEXTUAL-CONVENTION

    STATUS  current

    DESCRIPTION

        "Indicates the type of a TransportAddress (see below).  Values

        will depend on the actual protocol; for IP they will be those

        given in the 'Protocol Numbers' section of the  Assigned Numbers

        RFC [ASG-NBR], including icmp(1), tcp(6) and udp(17)."

    SYNTAX  Integer32 (1..255)

TransportAddress ::= TEXTUAL-CONVENTION

    STATUS  current

    DESCRIPTION

        "Specifies the value of a transport address for various

        network protocols.  Format as follows:

        IP:

            2-octet UDP or TCP port number

        Other protocols:

            2-octet port number

        "

    SYNTAX OCTET STRING (SIZE (2))

RuleAddress ::= TEXTUAL-CONVENTION

    STATUS  current

    DESCRIPTION

        "Specifies the value of an address.  Is a superset of

        MediumAddress, PeerAddress and TransportAddress."

    SYNTAX OCTET STRING (SIZE (2..20))

FlowAttributeNumber ::= TEXTUAL-CONVENTION

    STATUS  current

    DESCRIPTION

        "Uniquely identifies an attribute within a flow data record."

    SYNTAX  INTEGER {

        flowIndex(1),

        flowStatus(2),

        flowTimeMark(3),

        sourceInterface(4),

        sourceAdjacentType(5),

        sourceAdjacentAddress(6),

        sourceAdjacentMask(7),

        sourcePeerType(8),

        sourcePeerAddress(9),

        sourcePeerMask(10),

        sourceTransType(11),

        sourceTransAddress(12),

        sourceTransMask(13),

        destInterface(14),

        destAdjacentType(15),

        destAdjacentAddress(16),

        destAdjacentMask(17),

        destPeerType(18),

        destPeerAddress(19),

        destPeerMask(20),

        destTransType(21),

        destTransAddress(22),

        destTransMask(23),

        pduScale(24),

        octetScale(25),

        ruleSet(26),

        toOctets(27),             -- Source-to-Dest

        toPDUs(28),

        fromOctets(29),           -- Dest-to-Source

        fromPDUs(30),

        firstTime(31),            -- Activity times

        lastActiveTime(32),

        sourceSubscriberID(33),   -- Subscriber ID

        destSubscriberID(34),

        sessionID(35),

        sourceClass(36),          -- Computed attributes

        destClass(37),

        flowClass(38),

        sourceKind(39),

        destKind(40),

        flowKind(41) }

RuleAttributeNumber ::= TEXTUAL-CONVENTION

    STATUS  current

    DESCRIPTION

        "Uniquely identifies an attribute which may be tested in

        a rule.  These include attributes whose values come directly

        from (or are computed from) the flow's packets, and the five

        'meter' variables used to hold an Attribute Number."

    SYNTAX  INTEGER {

        null(0),

        sourceInterface(4),       -- Source Address

        sourceAdjacentType(5),

        sourceAdjacentAddress(6),

        sourcePeerType(8),

        sourcePeerAddress(9),

        sourceTransType(11),

        sourceTransAddress(12),

        destInterface(14),        -- Dest Address

        destAdjacentType(15),

        destAdjacentAddress(16),

        destPeerType(18),

        destPeerAddress(19),

        destTransType(21),

        destTransAddress(22),

        sourceSubscriberID(33),   -- Subscriber ID

        destSubscriberID(34),

        sessionID(35),

        sourceClass(36),          -- Computed attributes

        destClass(37),

        flowClass(38),

        sourceKind(39),

        destKind(40),

        flowKind(41),

        matchingStoD(50),         -- Packet matching

        v1(51),                   -- Meter variables

        v2(52),

        v3(53),

        v4(54),

        v5(55) }

ActionNumber ::= TEXTUAL-CONVENTION

    STATUS  current

    DESCRIPTION

        "Uniquely identifies the action of a rule, i.e. the Pattern

        Matching Engine's opcode number.  Details of the opcodes

        are given in the 'Traffic Flow Measurement: Architecture'

        document [RTFM-ARC]."

    SYNTAX  INTEGER {

        ignore(1),

        noMatch(2),

        count(3),

        countPkt(4),

        return(5),

        gosub(6),

        gosubAct(7),

        assign(8),

        assignAct(9),

        goto(10),

        gotoAct(11),

        pushRuleTo(12),

        pushRuleToAct(13),

        pushPktTo(14),

        pushPktToAct(15),

        popTo(16),

        popToAct(17) }

--

-- Control Group:  RuleSet Info Table

--

flowRuleSetInfoTable OBJECT-TYPE

    SYNTAX  SEQUENCE OF FlowRuleSetInfoEntry

    MAX-ACCESS  not-accessible

    STATUS  current

    DESCRIPTION

        "An array of information about the RuleSets held in the

        meter.

        Any manager may configure a new RuleSet for the meter by

        creating a row in this table with status active(1), and setting

        values for all the objects in its rules.  At this stage the new

        RuleSet is available but not 'running', i.e. it is not being

        used by the meter to produce entries in the flow table.

        To actually 'run' a RuleSet a manager must create a row in

        the flowManagerInfoTable, set it's flowManagerStatus to

        active(1), and set either its CurrentRuleSet or StandbyRuleSet

        to point to the RuleSet to be run.

        Once a RuleSet is running a manager may not change any of the

        objects within the RuleSet itself.  Any attempt to do so should

        result in a notWritable(17) SNMP error-status for such objects.

        A manager may stop a RuleSet running by removing all

        references to it in the flowManagerInfoTable (i.e. by setting

        CurrentRuleSet and StandbyRuleSet values to 0).  This provides

        a way to stop RuleSets left running if a manager fails.

        For example, when a manager is started, it could search the

        meter's flowManager table and stop all RuleSets having a

        specified value of flowRuleInfoOwner.

        To prevent a manager from interfering with variables belonging

        to another manager, the meter should use MIB views [RFC2575] so

        as to limit each manager's access to the meter's variables,

        effectively dividing the single meter into several virtual

        meters, one for each independent manager."

    ::= { flowControl 1 }

flowRuleSetInfoEntry OBJECT-TYPE

    SYNTAX  FlowRuleSetInfoEntry

    MAX-ACCESS  not-accessible

    STATUS  current

    DESCRIPTION

        "Information about a particular RuleSet."

    INDEX  { flowRuleInfoIndex }

    ::= { flowRuleSetInfoTable 1 }

FlowRuleSetInfoEntry ::= SEQUENCE {

    flowRuleInfoIndex         Integer32,

    flowRuleInfoSize          Integer32,

    flowRuleInfoOwner         UTF8OwnerString,

    flowRuleInfoTimeStamp     TimeStamp,

    flowRuleInfoStatus        RowStatus,

    flowRuleInfoName          OCTET STRING,

    flowRuleInfoRulesReady    TruthValue,

    flowRuleInfoFlowRecords   Integer32

    }

flowRuleInfoIndex OBJECT-TYPE

    SYNTAX  Integer32 (1..2147483647)

    MAX-ACCESS  not-accessible

    STATUS  current

    DESCRIPTION

        "An index which selects an entry in the flowRuleSetInfoTable.

        Each such entry contains control information for a particular

        RuleSet which the meter may run."

    ::= { flowRuleSetInfoEntry 1 }

flowRuleInfoSize OBJECT-TYPE

    SYNTAX  Integer32

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "Number of rules in this RuleSet.  Setting this variable will

        cause the meter to allocate space for these rules."

    ::= { flowRuleSetInfoEntry 2 }

flowRuleInfoOwner OBJECT-TYPE

    SYNTAX  UTF8OwnerString

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "Identifies the manager which 'owns' this RuleSet.  A manager

        must set this variable when creating a row in this table."

    ::= { flowRuleSetInfoEntry 3 }

flowRuleInfoTimeStamp OBJECT-TYPE

    SYNTAX  TimeStamp

    MAX-ACCESS  read-only

    STATUS  current

    DESCRIPTION

        "Time this row's associated RuleSet was last changed."

    ::= { flowRuleSetInfoEntry 4 }

flowRuleInfoStatus OBJECT-TYPE

    SYNTAX  RowStatus

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "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."

    ::= { flowRuleSetInfoEntry 5 }

flowRuleInfoName OBJECT-TYPE

    SYNTAX  OCTET STRING (SIZE (0..127))

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "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."

    ::= { flowRuleSetInfoEntry 6 }

flowRuleInfoRulesReady OBJECT-TYPE

    SYNTAX  TruthValue

    MAX-ACCESS  read-create

    STATUS  deprecated

    DESCRIPTION

        "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."

    ::= { flowRuleSetInfoEntry 7 }

flowRuleInfoFlowRecords OBJECT-TYPE

    SYNTAX  Integer32

    MAX-ACCESS  read-only

    STATUS  current

    DESCRIPTION

        "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)."

    ::= { flowRuleSetInfoEntry 8 }

--

-- Control Group:  Interface Info Table

--

flowInterfaceTable OBJECT-TYPE

    SYNTAX  SEQUENCE OF FlowInterfaceEntry

    MAX-ACCESS  not-accessible

    STATUS  current

    DESCRIPTION

        "An array of information specific to each meter interface."

    ::= { flowControl 2 }

flowInterfaceEntry OBJECT-TYPE

    SYNTAX  FlowInterfaceEntry

    MAX-ACCESS  not-accessible

    STATUS  current

    DESCRIPTION

        "Information about a particular interface."

    INDEX   { ifIndex }

    ::= { flowInterfaceTable 1 }

FlowInterfaceEntry ::= SEQUENCE {

    flowInterfaceSampleRate   Integer32,

    flowInterfaceLostPackets  Counter32

    }

flowInterfaceSampleRate OBJECT-TYPE

    SYNTAX  Integer32

    MAX-ACCESS  read-write

    STATUS  current

    DESCRIPTION

        "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."

    DEFVAL { 1 }

    ::= { flowInterfaceEntry 1 }

flowInterfaceLostPackets OBJECT-TYPE

    SYNTAX  Counter32

    MAX-ACCESS  read-only

    STATUS  current

    DESCRIPTION

        "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."

    ::= { flowInterfaceEntry 2 }

--

-- Control Group:  Meter Reader Info Table

--

-- Any meter reader wishing to collect data reliably for flows

-- should first create a row in this table.  It should write that

-- row's flowReaderLastTime object each time it starts a collection

-- pass through the flow table.

-- If a meter reader (MR) does not create a row in this table, e.g.

-- because its MIB view [RFC2575] did not allow MR create access to

-- flowReaderStatus, collection can still proceed but the meter will

-- not be aware of meter reader MR.  This could lead the meter to

-- recover flows before they have been collected by MR.

flowReaderInfoTable OBJECT-TYPE

    SYNTAX  SEQUENCE OF FlowReaderInfoEntry

    MAX-ACCESS  not-accessible

    STATUS  current

    DESCRIPTION

        "An array of information about meter readers which have

        registered their intent to collect flow data from this meter."

    ::= { flowControl 3 }

flowReaderInfoEntry OBJECT-TYPE

    SYNTAX  FlowReaderInfoEntry

    MAX-ACCESS  not-accessible

    STATUS  current

    DESCRIPTION

        "Information about a particular meter reader."

    INDEX  { flowReaderIndex }

    ::= { flowReaderInfoTable 1 }

FlowReaderInfoEntry ::= SEQUENCE {

    flowReaderIndex            Integer32,

    flowReaderTimeout          Integer32,

    flowReaderOwner            UTF8OwnerString,

    flowReaderLastTime         TimeStamp,

    flowReaderPreviousTime     TimeStamp,

    flowReaderStatus           RowStatus,

    flowReaderRuleSet          Integer32

    }

flowReaderIndex OBJECT-TYPE

    SYNTAX  Integer32 (1..2147483647)

    MAX-ACCESS  not-accessible

    STATUS  current

    DESCRIPTION

        "An index which selects an entry in the flowReaderInfoTable."

    ::= { flowReaderInfoEntry 1 }

flowReaderTimeout OBJECT-TYPE

    SYNTAX  Integer32

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "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."

    ::= { flowReaderInfoEntry 2 }

flowReaderOwner OBJECT-TYPE

    SYNTAX  UTF8OwnerString

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "Identifies the meter reader which created this row."

    ::= { flowReaderInfoEntry 3 }

flowReaderLastTime OBJECT-TYPE

    SYNTAX  TimeStamp

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "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."

    ::= { flowReaderInfoEntry 4 }

flowReaderPreviousTime OBJECT-TYPE

    SYNTAX  TimeStamp

    MAX-ACCESS  read-only

    STATUS  current

    DESCRIPTION

        "Time this meter reader began the collection before last."

    ::= { flowReaderInfoEntry 5 }

flowReaderStatus OBJECT-TYPE

    SYNTAX  RowStatus

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "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."

    ::= { flowReaderInfoEntry 6 }

flowReaderRuleSet OBJECT-TYPE

    SYNTAX  Integer32 (1..2147483647)

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "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."

    ::= { flowReaderInfoEntry 7 }

--

-- Control Group:  Manager Info Table

--

-- Any manager wishing to run a RuleSet must create a row in this

-- table.  Once it has a table row, the manager may set the control

-- variables in its row so as to cause the meter to run any valid

-- RuleSet held by the meter.

-- A single manager may run several RuleSets; it must create a row

-- in this table for each of them.  In short, each row of this table

-- describes (and controls) a 'task' which the meter is executing.

flowManagerInfoTable OBJECT-TYPE

    SYNTAX  SEQUENCE OF FlowManagerInfoEntry

    MAX-ACCESS  not-accessible

    STATUS  current

    DESCRIPTION

        "An array of information about managers which have

        registered their intent to run RuleSets on this meter."

    ::= { flowControl 4 }

flowManagerInfoEntry OBJECT-TYPE

    SYNTAX  FlowManagerInfoEntry

    MAX-ACCESS  not-accessible

    STATUS  current

    DESCRIPTION

        "Information about a particular meter 'task.'  By creating

        an entry in this table and activating it, a manager requests

        that the meter 'run' the indicated RuleSet.

        The entry also specifies a HighWaterMark and a StandbyRuleSet.

        If the meter's flow table usage exceeds this task's

        HighWaterMark the meter will stop running the task's

        CurrentRuleSet and switch to its StandbyRuleSet.

        If the value of the task's StandbyRuleSet is 0 when its

        HighWaterMark is exceeded, the meter simply stops running the

        task's CurrentRuleSet.  By careful selection of HighWaterMarks

        for the various tasks a manager can ensure that the most

        critical RuleSets are the last to stop running as the number

        of flows increases.

        When a manager has determined that the demand for flow table

        space has abated, it may cause the task to switch back to its

        CurrentRuleSet by setting its flowManagerRunningStandby

        variable to false(2)."

    INDEX  { flowManagerIndex }

    ::= { flowManagerInfoTable 1 }

FlowManagerInfoEntry ::= SEQUENCE {

    flowManagerIndex           Integer32,

    flowManagerCurrentRuleSet  Integer32,

    flowManagerStandbyRuleSet  Integer32,

    flowManagerHighWaterMark   Integer32,

    flowManagerCounterWrap     INTEGER,

    flowManagerOwner           UTF8OwnerString,

    flowManagerTimeStamp       TimeStamp,

    flowManagerStatus          RowStatus,

    flowManagerRunningStandby  TruthValue

    }

flowManagerIndex OBJECT-TYPE

    SYNTAX  Integer32 (1..2147483647)

    MAX-ACCESS  not-accessible

    STATUS  current

    DESCRIPTION

        "An index which selects an entry in the flowManagerInfoTable."

    ::= { flowManagerInfoEntry 1 }

flowManagerCurrentRuleSet OBJECT-TYPE

    SYNTAX  Integer32

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "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."

    ::= { flowManagerInfoEntry 2 }

flowManagerStandbyRuleSet OBJECT-TYPE

    SYNTAX  Integer32

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "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."

    DEFVAL { 0 }  -- No standby

    ::= { flowManagerInfoEntry 3 }

flowManagerHighWaterMark OBJECT-TYPE

    SYNTAX  Integer32 (0..100)

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "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."

    ::= { flowManagerInfoEntry 4 }

flowManagerCounterWrap OBJECT-TYPE

    SYNTAX  INTEGER { wrap(1), scale(2) }

    MAX-ACCESS  read-create

    STATUS  deprecated

    DESCRIPTION

        "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."

    DEFVAL { wrap }

    ::= { flowManagerInfoEntry 5 }

flowManagerOwner OBJECT-TYPE

    SYNTAX  UTF8OwnerString

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "Identifies the manager which created this row."

    ::= { flowManagerInfoEntry 6 }

flowManagerTimeStamp OBJECT-TYPE

    SYNTAX  TimeStamp

    MAX-ACCESS  read-only

    STATUS  current

    DESCRIPTION

        "Time this row was last changed by its manager."

    ::= { flowManagerInfoEntry 7 }

flowManagerStatus OBJECT-TYPE

    SYNTAX  RowStatus

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "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."

    ::= { flowManagerInfoEntry 8 }

flowManagerRunningStandby OBJECT-TYPE

    SYNTAX  TruthValue

    MAX-ACCESS  read-create

    STATUS  current

    DESCRIPTION

        "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)."

    DEFVAL { false }

    ::= { flowManagerInfoEntry 9 }

--

-- Control Group:  General Meter Control Variables

--

flowFloodMark OBJECT-TYPE

    SYNTAX  Integer32 (0..100)

    MAX-ACCESS  read-write

    STATUS  current

    DESCRIPTION

        "A value expressed as a percentage, interpreted by the meter

        as an indication of how full the flow table should be before

        it should take some action to avoid running out of resources

        to handle new flows, as discussed in section 4.6 (Handling

        Increasing Traffic Levels) of the RTFM Architecture RFC

        [RTFM-ARC].

        Values of 0% or 100% disable the checking represented by

        this variable."

    DEFVAL { 95 } -- Enabled by default.

    ::= { flowControl 5 }

flowInactivityTimeout OBJECT-TYPE

    SYNTAX  Integer32

    MAX-ACCESS  read-write

    STATUS  current

    DESCRIPTION

        "The time in seconds since the last packet seen, after which

        a flow becomes 'idle.'  Note that although a flow may be

        idle, it will not be discarded (and its memory recovered)

        until after its data has been collected by all the meter

        readers registered for its RuleSet."

    DEFVAL { 600 } -- 10 minutes

    ::= { flowControl 6 }