-- extracted from draft-romascanu-rmonmib-iftopn-mib-00.txt -- at Mon Nov 15 17:11:32 1999 INTERFACETOPN-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Counter32, Integer32, Gauge32 FROM SNMPv2-SMI RowStatus, TimeStamp, TEXTUAL-CONVENTION FROM SNMPv2-TC rmon, OwnerString FROM RMON-MIB rmonConformance, probeConfig FROM RMON2-MIB MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF; interfaceTopNMIB MODULE-IDENTITY LAST-UPDATED "9905090000Z" ORGANIZATION "Lucent Technologies" CONTACT-INFO " Dan Romascanu Lucent Technologies Tel: +972-3-645-8414 Email: dromasca@lucent.com" DESCRIPTION "The MIB module for sorting device interfaces for RMON and SMON monitoring in a multiple device implementation." ::= { rmon 23 } interfaceTopNObjects OBJECT IDENTIFIER ::= { interfaceTopNMIB 1 } interfaceTopNNotifications OBJECT IDENTIFIER ::= { interfaceTopNMIB 2 } interfaceTopNConformance OBJECT IDENTIFIER ::= { interfaceTopNMIB 3 } -- The Interface Top N group is used to prepare reports that -- describe a list of interfaces (data sources) -- ordered by the values of one -- of the objects that apply to the interfaces of the respective device. -- Those objects may be part of the standard MIBs, enterprise specific -- extensions MIBs, or defined by means of the Expression MIB [21]. -- The objects must be elements in tables indexed only by an -- InterfaceIndex object. -- The objects chosen by the -- management station may be sampled over a management -- station-specified time interval, making the report rate based. -- The management station also specifies the number of interfaces -- that are reported. -- -- The interfaceTopNControlTable is used to initiate the generation -- of a report. The management station may select the parameters -- of such a report, such as which object, how -- many interfaces, and the start & stop times of the sampling. When -- the report is prepared, entries are created in the -- interfaceTopNTable associated with the relevant -- interfaceTopNControlEntry. These entries are static for -- each report after it has been prepared. interfaceTopNControlTable OBJECT-TYPE SYNTAX SEQUENCE OF InterfaceTopNControlEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A table of control records for reports on the top `N' interfaces for the value or rate of a selected object. The number of entries depends on the configuration of the agent. The maximum number of entries is implementation dependent." ::= { interfaceTopNObjects 1 } interfaceTopNControlEntry OBJECT-TYPE SYNTAX InterfaceTopNControlEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A set of parameters that control the creation of a report of the top N ports according to several metrics." INDEX { interfaceTopNControlIndex } ::= { interfaceTopNControlTable 1 } InterfaceTopNControlEntry ::= SEQUENCE { interfaceTopNControlIndex Integer32, interfaceTopNObjectVariable OBJECT IDENTIFIER, InterfaceTopNObjectSampleType INTEGER, interfaceTopNNormalization INTEGER, interfaceTopNNormalizationFactor INTEGER, interfaceTopNControlGeneratedReports Counter32, interfaceTopNTimeRemaining Integer32, interfaceTopNDuration Integer32, interfaceTopNRequestedSize Integer32, interfaceTopNGrantedSize Integer32, interfaceTopNStartTime TimeStamp, interfaceTopNOwner OwnerString, interfaceTopNRowStatus RowStatus } interfaceTopNControlIndex OBJECT-TYPE SYNTAX Integer32 (1 .. 65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION "An index that uniquely identifies an entry in the interfaceTopNControl table. Each such entry defines one top N report prepared for a probe." ::= { interfaceTopNControlEntry 1 } interfaceTopNObjectVariable OBJECT-TYPE SYNTAX OBJECT IDENTIFIER MAX-ACCESS read-create STATUS current DESCRIPTION "The object identifier of the particular variable to be sampled. Only variables that resolve to an ASN.1 primitive type of Integer32 (Integer32, Counter, Gauge, or TimeTicks) may be sampled. Only variables belonging to tables indexed uniquely by an object of the type InterfaceIndex may be sampled. Because SNMP access control is articulated entirely in terms of the contents of MIB views, no access control mechanism exists that can restrict the value of this object to identify only those objects that exist in a particular MIB view. Because there is thus no acceptable means of restricting the read access that could be obtained through the TopN mechanism, the probe must only grant write access to this object in those views that have read access to all objects on the probe. During a set operation, if the supplied variable name is not available in the selected MIB view, or does not conform the other conditions mentioned above, a badValue error must be returned. This object may not be modified if the associated interfaceTopNControlStatus object is equal to active(1)." ::= { interfaceTopNControlEntry 2 } interfaceTopNObjectSampleType OBJECT-TYPE SYNTAX INTEGER { absoluteValue(1), deltaValue(2) } MAX-ACCESS read-create STATUS current DESCRIPTION "The method of sampling the selected variable for storage in the interfaceTopNTable. If the value of this object is absoluteValue(1), the value of the selected variable will be copied directly into the topNValue. If the value of this object is deltaValue(2), the value of the selected variable at the last sample will be subtracted from the current value, and the difference will be stored in topNValue. This object may not be modified if the associated interfaceTopNControlStatus object is equal to active(1)." ::= { interfaceTopNObjectEntry 3 } interfaceTopNNormalization OBJECT-TYPE SYNTAX INTEGER { normalizationRequired(1), normalizationNotRequired(2) } MAX-ACCESS read-create STATUS current DESCRIPTION "The method of normalization in computation of the selected value. If the value of this object is normalizationRequired(1), the value of the selected variable will be multiplied by a factor equal to the effective speed of the interface divided by the value of interfaceTopNNormalizationFactor. If the value of this object is normalizationNot Required(2), the value of the selected variable will be taken 'as is' in the TopN computation. This object may not be modified if the associated interfaceTopNControlStatus object is equal to active(1)." ::= { interfaceTopNObjectEntry 4 } interfaceTopNNormalizationFactor OBJECT-TYPE SYNTAX INTEGER MAX-ACCESS read-create STATUS current DESCRIPTION "The value used for normalization if interfaceTopNNormalization has the value normalizationRequired(1)." DEFVAL { 1 } ::= { interfaceTopNObjectEntry 5 } interfaceTopNControlGeneratedReports OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of reports that have been generated by this entry." ::= { interfaceTopNControlEntry 6 } interfaceTopNTimeRemaining OBJECT-TYPE SYNTAX Integer32 (0..2147483647) MAX-ACCESS read-create STATUS current DESCRIPTION "The number of seconds left in the report currently being collected. When this object is modified by the management station, a new collection is started, possibly aborting a currently running report. The new value is used as the requested duration of this report, which is loaded into the associated interfaceTopNDuration object. When this object is set to a non-zero value, any associated interfaceTopNEntries shall be made inaccessible by the agent. While the value of this object is non-zero, it decrements by one per second until it reaches zero. During this time, all associated interfaceTopNEntries shall remain inaccessible. At the time that this object decrements to zero, the report is made accessible in the interfaceTopNTable. Thus, the interfaceTopN table needs to be created only at the end of the collection interval. If the value of this object is set to zero while the associated report is running, the running report is aborted and no associated interfaceTopNEntries are created." DEFVAL { 0 } ::= { interfaceTopNControlEntry 7 } interfaceTopNDuration OBJECT-TYPE SYNTAX Integer32 (0..2147483647) MAX-ACCESS read-only STATUS current DESCRIPTION "The number of seconds that this report has collected during the last sampling interval, or if this report is currently being collected, the number of seconds that this report is being collected during this sampling interval. When the associated interfaceTopNTimeRemaining object is set, this object shall be set by the agent to the same value and shall not be modified until the next time the interfaceTopNTimeRemaining is set. This value shall be zero if no reports have been requested for this interfaceTopNControlEntry." ::= { interfaceTopNControlEntry 8 } interfaceTopNRequestedSize OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-create STATUS current DESCRIPTION "The maximum number of interfaces requested for the Top N Table. When this object is created or modified, the agent should set interfaceTopNGrantedSize as close to this object as is possible for the particular implementation and available resources." DEFVAL { 10 } ::= { interfaceTopNControlEntry 9 } interfaceTopNGrantedSize OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-only STATUS current DESCRIPTION "The maximum number of interfaces in the top N table. When the associated interfaceTopNRequestedSize object is created or modified, the agent should set this object as closely to the requested value as is possible for the particular implementation and available resources. The agent must not lower this value except as a result of a set to the associated interfaceTopNRequestedSize object." ::= { interfaceTopNControlEntry 10 } interfaceTopNStartTime OBJECT-TYPE SYNTAX TimeStamp MAX-ACCESS read-only STATUS current DESCRIPTION "The value of sysUpTime when this top N report was last started. In other words, this is the time that the associated interfaceTopNTimeRemaining object was modified to start the requested report. If the report has not yet been started, the value of this object is zero." ::= { interfaceTopNControlEntry 11 } interfaceTopNOwner OBJECT-TYPE SYNTAX OwnerString MAX-ACCESS read-create STATUS current DESCRIPTION "The entity that configured this entry and is using the resources assigned to it." ::= { interfaceTopNControlEntry 12 } interfaceTopNRowStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The status of this row. If the value of this object is not equal to active(1), all associated entries in the interfaceTopNTable shall be deleted by the agent." ::= { interfaceTopNControlEntry 13 } -- Top "N" reports interfaceTopNTable OBJECT-TYPE SYNTAX SEQUENCE OF InterfaceTopNEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A table of reports for the top `N' ports based on setting of associated control table entries. The maximum number of entries depends on the number of entries in table interfaceTopNControlTable and the value of object interfaceTopNGrantedSize for each entry. For each entry in the interfaceTopNControlTable, interfaces with the highest value of interfaceTopNValue shall be placed in this table in decreasing order of that rate until there is no more room or until there are no more ports." ::= { interfaceTopNObjects 2 } interfaceTopNEntry OBJECT-TYPE SYNTAX InterfaceTopNEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "A set of statistics for an interface that is part of a top N report." INDEX { interfaceTopNControlIndex, interfaceTopNIndex } ::= { interfaceTopNTable 1 } InterfaceTopNEntry ::= SEQUENCE { interfaceTopNIndex Integer32, interfaceTopNDataSourceIndex Integer32, interfaceTopNValue Gauge32 } interfaceTopNIndex OBJECT-TYPE SYNTAX Integer32 (1..65535) MAX-ACCESS not-accessible STATUS current DESCRIPTION "An index that uniquely identifies an entry in the interfaceTopN table among those in the same report. This index is between 1 and N, where N is the number of entries in this report. Increasing values of interfaceTopNIndex shall be assigned to entries with decreasing values of interfaceTopNValue until index N is assigned to the entry with the lowest value of interfaceTopNValue or there are no more interfaceTopNEntries. No ports are included in a report where their value of interfaceTopNValue would be zero." ::= { interfaceTopNEntry 1 } interfaceTopNDataSourceIndex OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS read-only STATUS current DESCRIPTION "This object identifies the index corresponding to the dataSource for this entry." ::= { interfaceTopNEntry 2 } interfaceTopNValue OBJECT-TYPE SYNTAX Gauge32 MAX-ACCESS read-only STATUS current DESCRIPTION "The value at the end of the sampling interval, or the amount of change in the selected variable during this sampling interval for the identified interface. The selected variable is that interfaces's instance of the object selected by interfaceTopNObjectVariable." ::= { interfaceTopNEntry 3 } -- -- Notifications Section -- (none defined) -- -- -- Conformance Section -- interfaceTopNCompliances OBJECT IDENTIFIER ::= { interfaceTopNConformance 1 } interfaceTopNGroups OBJECT IDENTIFIER ::= { interfaceTopNConformance 2 } interfaceTopNCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "Describes the requirements for conformance to the InterfaceTopN MIB." MODULE -- this module MANDATORY-GROUPS { interfaceTopNGroup } ::= { interfaceTopNCompliances 1 } interfaceTopNGroup OBJECT-GROUP OBJECTS { interfaceTopNControlIndex, interfaceTopNObjectVariable, interfaceTopNObjectSampleType, interfaceTopNNormalization, interfaceTopNNormalizationFactor, interfaceTopNControlGeneratedReports, interfaceTopNTimeRemaining, interfaceTopNDuration, interfaceTopNRequestedSize, interfaceTopNGrantedSize, interfaceTopNStartTime, interfaceTopNOwner, interfaceTopNRowStatus, interfaceTopNIndex, interfaceTopNDataSourceIndex, interfaceTopNValue } STATUS current DESCRIPTION "A collection of objects providing interfaceTopN data for a multiple interfaces device." ::= { interfaceTopNGroups 1 } END -- -- This document and translations of it may be copied and furnished to -- others, and derivative works that comment on or otherwise explain it -- or assist in its implementation may be prepared, copied, published -- and distributed, in whole or in part, without restriction of any -- kind, provided that the above copyright notice and this paragraph are -- included on all such copies and derivative works. However, this -- document itself may not be modified in any way, such as by removing -- the copyright notice or references to the Internet Society or other -- Internet organizations, except as needed for the purpose of -- developing Internet standards in which case the procedures for -- copyrights defined in the Internet Standards process must be -- followed, or as required to translate it into languages other than -- English. -- -- The limited permissions granted above are perpetual and will not be -- revoked by the Internet Society or its successors or assigns. -- -- This document and the information contained herein is provided on an -- "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING -- TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING -- BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION -- HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF -- MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.