FLOW-METER-MIB: View SNMP OID List / Download MIB

MIB for the RTFM Traffic Flow Meter.

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.

Information about a particular RuleSet.

An index which selects an entry in the flowRuleSetInfoTable. Each such entry contains control information for a particular RuleSet which the meter may run.

Number of rules in this RuleSet. Setting this variable will cause the meter to allocate space for these rules.

Identifies the manager which 'owns' this RuleSet. A manager must set this variable when creating a row in this table.

Time this row's associated RuleSet was last changed.

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.

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.

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.

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

An array of information specific to each meter interface.

Information about a particular interface.

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.

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.

An array of information about meter readers which have registered their intent to collect flow data from this meter.

Information about a particular meter reader.

An index which selects an entry in the flowReaderInfoTable.

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.

Identifies the meter reader which created this row.

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.

Time this meter reader began the collection before last.

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.

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.

An array of information about managers which have registered their intent to run RuleSets on this meter.

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

An index which selects an entry in the flowManagerInfoTable.

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.

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.

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.

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. Enumeration: 'wrap': 1, 'scale': 2.

Identifies the manager which created this row.

Time this row was last changed by its manager.

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.

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

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.

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.

The number of flows which are currently in use.

The maximum number of flows allowed in the meter's flow table. At present this is determined when the meter is first started up.

Indicates that the meter has passed its FloodMark and is not running in its normal mode. When the manager notices this it should take action to remedy the problem which caused the flooding. It should then monitor flowActiveFlows so as to determine when the flood has receded. At that point the manager may set flowFloodMode to false(2) to resume normal operation.

The list of all flows being measured.

The flow data record for a particular flow.

Value of this flow data record's index within the meter's flow table.

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.

Status of this flow data record. Enumeration: 'current': 2, 'inactive': 1.

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.

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.

Address of the adjacent device on the path for the source for this flow.

1-bits in this mask indicate which bits must match when comparing the adjacent source address for this flow.

Peer address type of the source for this flow.

Address of the peer device for the source of this flow.

1-bits in this mask indicate which bits must match when comparing the source peer address for this flow.

Transport address type of the source for this flow. The value of this attribute will depend on the peer address type.

Transport address for the source of this flow.

1-bits in this mask indicate which bits must match when comparing the transport source address for this flow.

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.

Adjacent address type of the destination for this flow.

Address of the adjacent device on the path for the destination for this flow.

1-bits in this mask indicate which bits must match when comparing the adjacent destination address for this flow.

Peer address type of the destination for this flow.

Address of the peer device for the destination of this flow.

1-bits in this mask indicate which bits must match when comparing the destination peer type for this flow.

Transport address type of the destination for this flow. The value of this attribute will depend on the peer address type.

Transport address for the destination of this flow.

1-bits in this mask indicate which bits must match when comparing the transport destination address for this flow.

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.

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.

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.

The count of octets flowing from source to destination for this flow.

The count of packets flowing from source to destination for this flow.

The count of octets flowing from destination to source for this flow.

The count of packets flowing from destination to source for this flow.

The time at which this flow was first entered in the table

The last time this flow had activity, i.e. the time of arrival of the most recent PDU belonging to this flow.

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.

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.

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.

Source class for this flow. Determined by the rules, set by a PushRule action when this flow was entered in the table.

Destination class for this flow. Determined by the rules, set by a PushRule action when this flow was entered in the table.

Class for this flow. Determined by the rules, set by a PushRule action when this flow was entered in the table.

Source kind for this flow. Determined by the rules, set by a PushRule action when this flow was entered in the table.

Destination kind for this flow. Determined by the rules, set by a PushRule action when this flow was entered in the table.

Class for this flow. Determined by the rules, set by a PushRule action when this flow was entered in the table.

Index into the Flow Table. Allows a meter reader to retrieve a list containing the flow table indexes of flows which were last active at or after a given time, together with the values of a specified attribute for each such flow.

The Column Activity Entry for a particular attribute, activity time and flow.

Specifies the attribute for which values are required from active flows.

This variable is a copy of flowDataLastActiveTime in the flow data record identified by the flowColumnActivityIndex value of this flowColumnActivityTable entry.

Index of a flow table entry which was active at or after a specified flowColumnActivityTime.

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 }

Index into the Flow Table. Allows a meter reader to retrieve a sequence containing the values of a specified set of attributes for a flow which came from a specified RuleSet and which was last active at or after a given time.

The data package containing selected variables from active rows in the flow table.

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.

Specifies the index (in the flowRuleSetInfoTable) of the rule set which produced the required flow.

This variable is a copy of flowDataLastActiveTime in the flow data record identified by the flowPackageIndex value of this flowPackageTable entry.

Index of a flow table entry which was active at or after a specified flowPackageTime.

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

Contains all the RuleSets which may be used by the meter.

The rule record itself.

Selects a RuleSet from the array of RuleSets.

The index into the Rule table. N.B: These values will normally be consecutive, given the fall-through semantics of processing the table.

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.

The initial mask used to compute the desired value. If the mask is zero the rule's test will always succeed.

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.

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

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

The compliance statement for a Traffic Flow Meter.

The control group defines objects which are used to control an accounting meter.

The flow table group defines objects which provide the structure for the flow table, including the creation time and activity time indexes into it. In addition it defines objects which provide a base set of flow attributes for the adjacent, peer and transport layers, together with a flow's counters and times. Finally it defines a flow's class and kind attributes, which are set by rule actions.

The flow scale group defines objects which specify scale factors for counters.

The flow subscriber group defines objects which may be used to identify the end point(s) of a flow.

The flow column table group defines objects which can be used to collect part of a column of attribute values from the flow table.

The data package group defines objects which can be used to collect a specified set of attribute values from a row of the flow table.

The rule table group defines objects which hold the set(s) of rules specifying which traffic flows are to be accounted for.

The flow scale group defines objects which specify scale factors for counters. This group replaces the earlier version of flowDataScaleGroup above (now deprecated).

The control group defines objects which are used to control an accounting meter. It replaces the earlier version of flowControlGroup above (now deprecated).