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 3 }
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,
interfaceTopNValue64
CounterBasedGauge64
}
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
or interfaceTopNValue64, whichever applies,
until index N is assigned to the entry with the
lowest value of interfaceTopNValue /
interfaceTopNValue64 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.
For sorted values of variables belonging to the
IF-MIB, EtherLike-MIB or TOKENRING-MIB, this value
equals the ifIndex of the interface.
For sorted values of variables belonging to the
RMON-MIB, this value equals the interface corresponding
to the data source, pointed to by the value
of etherStatsDataSource.
For sorted values of variables belonging to the
BRIDGE-MIB, this value equals the interface corresponding
to the bridge port, pointed to by the value
of dot1dBasePortIfIndex."
::= { 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. This value may be normalized
if interfaceTopNNormalization required equals 'true'.
This value of this object will be computed for all
cases when interfaceTopNObjectVariable points to a
32-bit counter or Gauge or when
interfaceTopNObjectSampleType equals bandwidthPercentage(3),
and will be zero for all other cases."
::= { interfaceTopNEntry 3 }
interfaceTopNValue64 OBJECT-TYPE
SYNTAX CounterBasedGauge64
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. This value may be normalized
if interfaceTopNNormalization required equals 'true'.
This value of this object will be computed for all
cases when interfaceTopNObjectVariable points to
a 64-bit counter, and will be zero for all other cases."
::= { interfaceTopNEntry 4 }
--
-- 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 {
interfaceTopNCaps,
interfaceTopNObjectVariable,
interfaceTopNObjectSampleType,
interfaceTopNNormalizationReq,
interfaceTopNNormalizationFactor,
interfaceTopNTimeRemaining,
interfaceTopNDuration,
interfaceTopNRequestedSize,
interfaceTopNGrantedSize,
interfaceTopNStartTime,
interfaceTopNOwner,
interfaceTopNLastCompletionTime,
interfaceTopNRowStatus,
interfaceTopNDataSourceIndex,
interfaceTopNValue,
interfaceTopNValue64
}
STATUS current
DESCRIPTION
"A collection of objects providing interfaceTopN data for
a multiple interfaces device."
::= { interfaceTopNGroups 1 }
END
7. References
[RFC2571] Harrington, D., Presuhn, R., and B. Wijnen, "An Architecture
for Describing SNMP Management Frameworks", RFC2571, April
1999.
[RFC1155] Rose, M., and K. McCloghrie, "Structure and Identification
of Management Information for TCP/IP-based Internets", STD
16, RFC1155, May 1990.
[RFC1212] Rose, M., and K. McCloghrie, "Concise MIB Definitions", STD
16, RFC1212, March 1991.
[RFC1215] M. Rose, "A Convention for Defining Traps for use with the
SNMP", RFC1215, March 1991.
[RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
Rose, M., and S. Waldbusser, "Structure of Management
Information Version 2 (SMIv2)", STD 58, RFC2578, April
1999.
[RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
Rose, M., and S. Waldbusser, "Textual Conventions for
SMIv2", STD 58, RFC2579, April 1999.
[RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
Rose, M., and S. Waldbusser, "Conformance Statements for
SMIv2", STD 58, RFC2580, April 1999.
[RFC1157] Case, J., Fedor, M., Schoffstall, M., and J. Davin, "Simple
Network Management Protocol", STD 15, RFC1157, May 1990.
[RFC1901] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser,
"Introduction to Community-based SNMPv2", RFC1901, January
1996.
[RFC1906] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser,
"Transport Mappings for Version 2 of the Simple Network
Management Protocol (SNMPv2)", RFC1906, January 1996.
[RFC2572] Case, J., Harrington D., Presuhn R., and B. Wijnen, "Message
Processing and Dispatching for the Simple Network Management
Protocol (SNMP)", RFC2572, April 1999.
[RFC2574] Blumenthal, U., and B. Wijnen, "User-based Security Model
(USM) for version 3 of the Simple Network Management
Protocol (SNMPv3)", RFC2574, April 1999.
[RFC1905] Case, J., McCloghrie, K., Rose, M., and S. Waldbusser,
"Protocol Operations for Version 2 of the Simple Network
Management Protocol (SNMPv2)", RFC1905, January 1996.
[RFC2573] Levi, D., Meyer, P., and B. Stewart, "SNMPv3 Applications",
RFC2573, April 1999.
[RFC2575] Wijnen, B., Presuhn, R., and K. McCloghrie, "View-based
Access Control Model (VACM) for the Simple Network
Management Protocol (SNMP)", RFC2575, April 1999.
[RFC2570] Case, J., Mundy, R., Partain, D., and B. Stewart,
"Introduction to Version 3 of the Internet-standard Network
Management Framework", RFC2570, April 1999.
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC2119, March 1997.
[RFC2819] Waldbusser, S., "Remote Network Monitoring Management
Information Base", STD 59, RFC2819, May 2000.
[RFC2613] Waterman, R., Lahaye, B., Romascanu, D., and S. Waldbusser,
"Remote Network Monitoring MIB Extensions for Switched
Networks, Version 1.0", RFC2613, June 1999.
[RFC1213] McCloghrie, K., and M. Rose, Editors, "Management
Information Base for Network Management of TCP/IP-based
internets: MIB-II", STD 17, RFC1213, March 1991.
[RFC2863] McCloghrie, K., and Kastenholtz, F., "The Interfaces Group
MIB", RFC2863, June 2000.
[RFC2982] Kavasseri, R., Stewart B., "Distributed Management
Expression MIB", RFC2982, October 2000
[RFC2856] Bierman, A., McCloghrie, K., and Presuhn R., "Textual
Conventions for Additional High Capacity Data Types", RFC
2856, June 2000.
[RFC2665] Flick, J., and Johnson, J., "Definitions of Managed Objects
for the Ethernet-like Interface Types", RFC2665, August
1999.
[RFC1748] McCloghrie, K., and Decker E., "IEEE802.5 MIB Using SMIv2",
RFC1748, December 1994.
[RFC1493] E. Decker, P. Langille, A. Rijsinghani, and McCloghrie, K.,
"Definition of Managed Objects for Bridges", RFC1493, July
1993.
8. Intellectual Property
The IETF takes no position regarding the validity or scope of any
intellectual property or other rights that might be claimed to
pertain to the implementation or use of the technology described in
this document or the extent to which any license under such rights
might or might not be available; neither does it represent that it
has made any effort to identify any such rights. Information on the
IETF's procedures with respect to rights in standards-track and
standards-related documentation can be found in BCP-11. Copies of
claims of rights made available for publication and any assurances of
licenses to be made available, or the result of an attempt made to
obtain a general license or permission for the use of such
proprietary rights by implementors or users of this specification can
be obtained from the IETF Secretariat.
The IETF invites any interested party to bring to its attention any
copyrights, patents or patent applications, or other proprietary
rights which may cover technology that may be required to practice
this standard. Please address the information to the IETF Executive
Director.
9. Security Considerations
There are a number of management objects defined in this MIB that
have a MAX-ACCESS clause of read-write and/or read-create. Such
objects may be considered sensitive or vulnerable in some network
environments. The support for SET operations in a non-secure
environment without proper protection can have a negative effect on
network operations.
There are a number of managed objects in this MIB that may contain
sensitive information. These are:
interfaceTopNDataSourceIndex
interfaceTopNValue
It is thus important to control even GET access to these objects and
possibly to even encrypt the values of these object when sending them
over the network via SNMP. Not all versions of SNMP provide features
for such a secure environment.
SNMPv1 by itself is not a secure environment. Even if the network
itself is secure (for example by using IPSec), even then, there is no
control as to who on the secure network is allowed to access and
GET/SET (read/change/create/delete) the objects in this MIB.
It is RECOMMENDED that the implementers consider the security
features as provided by the SNMPv3 framework. Specifically, the use
of the User-based Security Model [RFC2274] and the View-based Access
Control Model [RFC2275] is RECOMMENDED.
It is then a customer/user responsibility to ensure that the SNMP
entity giving access to an instance of this MIB, is properly
configured to give access to the objects only to those principals
(users) that have legitimate rights to indeed GET or SET
(change/create/delete) them.
10. Author's Address
Dan Romascanu
Avaya Inc.
Atidim Technology Park, Bldg. #3
Tel Aviv, 61131
Israel
Phone: +972-3-645-8414
EMail: dromasca@avaya.com
11. Full Copyright Statement
Copyright (C) The Internet Society (2001). All Rights Reserved.
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.
Acknowledgement
Funding for the RFCEditor function is currently provided by the
Internet Society.