-- extracted from draft-ietf-psamp-mib-00.txt -- at Fri Jun 27 06:13:40 2003 PSAMP-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Integer32, mib-2 FROM SNMPv2-SMI -- RFC2578 TEXTUAL-CONVENTION FROM SNMPv2-TC -- RFC2579 MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF -- RFC2580 InterfaceIndex -- RFC2863 FROM IF-MIB InetAddressType, InetAddress FROM INET-ADDRESS-MIB; -- RFC3291 psampMIB MODULE-IDENTITY LAST-UPDATED "200306222314Z" -- 22 June 2003 ORGANIZATION "IETF Packet Sampling Working Group" CONTACT-INFO "Thomas Dietz NEC Europe Ltd. Network Laboratories Kurfuersten-Anlage 36 69115 Heidelberg Germany Phone: +49 6221 90511-28 Email: quittek@ccrle.nec.de" DESCRIPTION "The PSAMP MIB defines managed objects for packet sampling. These objects provide information about managed nodes supporting packet sampling, including packet sampling capabilities, configuration and statistics. They also allow to configure packet sampling concerning the IP interface at which packets are sampled, the packet selections methods used for sampling, and the collector to which packet samples are exported." -- Revision history REVISION "200306222314Z" -- 22 June 2003 DESCRIPTION "Initial version." ::= { mib-2 333 } -- XXX to be assigned by IANA. -- Textual Conventions PsampMethodAvailability ::= TEXTUAL-CONVENTION STATUS current DESCRIPTION "Used to report the availability of a packet selection method: available(1) - the method is supported and can be used notAvailable(2) - the mothos is not available" SYNTAX INTEGER { available(1), notAvailable(2) } -- Top level structure of the MIB psampObjects OBJECT IDENTIFIER ::= { psampMIB 1 } psampConformance OBJECT IDENTIFIER ::= { psampMIB 2 } -- Packet selection methods group of objects psampMethods OBJECT IDENTIFIER ::= { psampObjects 1 } -- Method 0: Selecting All Packets psampSelectingAll OBJECT IDENTIFIER ::= { psampMethods 0 } psampSelectingAllAvailability OBJECT-TYPE SYNTAX PsampMethodAvailability MAX-ACCESS read-only STATUS current DESCRIPTION "When retrieved, this object indicates the availability of the trivial method of selecting all packets." DEFVAL { available } ::= { psampSelectingAll 1 } -- Method 1: Systematic Count-based Sampling psampSystematicCountBasedSampling OBJECT IDENTIFIER ::= { psampMethods 1 } psampSystematicCountBasedSamplingAvailability OBJECT-TYPE SYNTAX PsampMethodAvailability MAX-ACCESS read-only STATUS current DESCRIPTION "When retrieved, this object indicates the availability of systematic count-based sampling at the managed node." DEFVAL { notAvailable } ::= { psampSystematicCountBasedSampling 1 } psampSystematicCountBasedSamplingCapabilities OBJECT IDENTIFIER ::= { psampSystematicCountBasedSampling 2 } psampSystematicCountBasedSamplingMaxInterval OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "When retrieved, this object indicates the the maximum number that can be specified for the sampling interval." ::= { psampSystematicCountBasedSamplingCapabilities 1 } psampSystematicCountBasedSamplingMaxSpacing OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "When retrieved, this object indicates the the maximum number that can be specified for the sampling spacing." ::= { psampSystematicCountBasedSamplingCapabilities 2 } psampSystematicCountBasedSamplingParameterSetTable OBJECT-TYPE SYNTAX SEQUENCE OF PsampSystematicCountBasedSamplingParameterSetEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table lists configurations of systematic count- based packet sampling. A parameter set describing a configuration contains two parameters: the sampling interval length and the spacing." ::= { psampSystematicCountBasedSampling 3 } psampSystematicCountBasedSamplingParameterSetEntry OBJECT-TYPE SYNTAX PsampSystematicCountBasedSamplingParameterSetEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Defines an entry in the psampSystematicCountBasedSamplingParameterSetTable." INDEX { psampSystematicCountBasedSamplingIndex } ::= { psampSystematicCountBasedSamplingParameterSetTable 1 } PsampSystematicCountBasedSamplingParameterSetEntry ::= SEQUENCE { psampSystematicCountBasedSamplingIndex Integer32, psampSystematicCountBasedSamplingInterval Integer32, psampSystematicCountBasedSamplingSpacing Integer32 } psampSystematicCountBasedSamplingIndex OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The index of this parameter set in the psampSystematicCountBasedSamplingParameterSetTable. It is used in entries of the psampInstanceTable as reference to this parameter set." ::= { psampSystematicCountBasedSamplingParameterSetEntry 1 } psampSystematicCountBasedSamplingInterval OBJECT-TYPE SYNTAX Integer32 UNITS "number of packets" MAX-ACCESS read-create STATUS current DESCRIPTION "When retrieved, this object specifies the sampling interval for systematic count-based sampling." REFERENCE "draft-ietf-psamp-sample-tech-01.txt, Section 5.1" ::= { psampSystematicCountBasedSamplingParameterSetEntry 2 } psampSystematicCountBasedSamplingSpacing OBJECT-TYPE SYNTAX Integer32 UNITS "number of packets" MAX-ACCESS read-create STATUS current DESCRIPTION "When retrieved, this object specifies the sampling spacing for systematic count-based sampling." REFERENCE "draft-ietf-psamp-sample-tech-01.txt, Section 5.1" ::= { psampSystematicCountBasedSamplingParameterSetEntry 3 } -- Method 2: Systematic Time-based Sampling psampSystematicTimeBasedSampling OBJECT IDENTIFIER ::= { psampMethods 2 } psampSystematicTimeBasedSamplingAvailability OBJECT-TYPE SYNTAX PsampMethodAvailability MAX-ACCESS read-only STATUS current DESCRIPTION "When retrieved, this object indicates the availability of systematic time-based sampling at the managed node." DEFVAL { notAvailable } ::= { psampSystematicTimeBasedSampling 1 } psampSystematicTimeBasedSamplingCapabilities OBJECT IDENTIFIER ::= { psampSystematicTimeBasedSampling 2 } psampSystematicTimeBasedSamplingMaxInterval OBJECT-TYPE SYNTAX Integer32 UNITS "microseconds" MAX-ACCESS read-only STATUS current DESCRIPTION "When retrieved, this object indicates the the maximum number that can be specified for the sampling interval." ::= { psampSystematicTimeBasedSamplingCapabilities 1 } psampSystematicTimeBasedSamplingMaxSpacing OBJECT-TYPE SYNTAX Integer32 UNITS "microseconds" MAX-ACCESS read-only STATUS current DESCRIPTION "When retrieved, this object indicates the the maximum number that can be specified for the sampling spacing." ::= { psampSystematicTimeBasedSamplingCapabilities 2 } psampSystematicTimeBasedSamplingParameterSetTable OBJECT-TYPE SYNTAX SEQUENCE OF PsampSystematicTimeBasedSamplingParameterSetEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table lists configurations of systematic time- based packet sampling. A parameter set describing a configuration contains two parameters: the sampling interval length and the spacing." ::= { psampSystematicTimeBasedSampling 3 } psampSystematicTimeBasedSamplingParameterSetEntry OBJECT-TYPE SYNTAX PsampSystematicTimeBasedSamplingParameterSetEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Defines an entry in the psampSystematicTimeBasedSamplingParameterSetTable." INDEX { psampSystematicTimeBasedSamplingIndex } ::= { psampSystematicTimeBasedSamplingParameterSetTable 1 } PsampSystematicTimeBasedSamplingParameterSetEntry ::= SEQUENCE { psampSystematicTimeBasedSamplingIndex Integer32, psampSystematicTimeBasedSamplingInterval Integer32, psampSystematicTimeBasedSamplingSpacing Integer32 } psampSystematicTimeBasedSamplingIndex OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The index of this parameter set in the psampSystematicTimeBasedSamplingParameterSetTable. It is used in entries of the psampInstanceTable as reference to this parameter set." ::= { psampSystematicTimeBasedSamplingParameterSetEntry 1 } psampSystematicTimeBasedSamplingInterval OBJECT-TYPE SYNTAX Integer32 UNITS "microseconds" -- might still be too coarse grained MAX-ACCESS read-create STATUS current DESCRIPTION "When retrieved, this object specifies a sampling interval for systematic time-based sampling." REFERENCE "draft-ietf-psamp-sample-tech-01.txt, Section 5.1" ::= { psampSystematicTimeBasedSamplingParameterSetEntry 2 } psampSystematicTimeBasedSamplingSpacing OBJECT-TYPE SYNTAX Integer32 UNITS "microseconds" -- might still be too coarse grained MAX-ACCESS read-create STATUS current DESCRIPTION "When retrieved, this object specifies a sampling spacing for systematic time-based sampling." REFERENCE "draft-ietf-psamp-sample-tech-01.txt, Section 5.1" ::= { psampSystematicTimeBasedSamplingParameterSetEntry 3 } -- Method 3: Random n-out-of-N Sampling psampRandomOutOfNSampling OBJECT IDENTIFIER ::= { psampMethods 3 } psampRandomOutOfNSamplingAvailability OBJECT-TYPE SYNTAX PsampMethodAvailability MAX-ACCESS read-only STATUS current DESCRIPTION "When retrieved, this object indicates the availability of random n-out-of-N sampling at the managed node." DEFVAL { notAvailable } ::= { psampRandomOutOfNSampling 1 } psampRandomOutOfNSamplingCapabilities OBJECT IDENTIFIER ::= { psampRandomOutOfNSampling 2 } -- No capabilities defined, yet. psampRandomOutOfNSamplingParameterSetTable OBJECT-TYPE SYNTAX SEQUENCE OF PsampRandomOutOfNSamplingParameterSetEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table lists configurations of random n-out-of-N sampling. A parameter set describing a configuration contains a single parameter only: the sampling rate." ::= { psampRandomOutOfNSampling 3 } psampRandomOutOfNSamplingParameterSetEntry OBJECT-TYPE SYNTAX PsampRandomOutOfNSamplingParameterSetEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Defines an entry in the psampRandomOutOfNSamplingParameterSetTable." INDEX { psampRandomOutOfNSamplingIndex } ::= { psampRandomOutOfNSamplingParameterSetTable 1 } PsampRandomOutOfNSamplingParameterSetEntry ::= SEQUENCE { psampRandomOutOfNSamplingIndex Integer32, psampRandomOutOfNSamplingRate Integer32 } psampRandomOutOfNSamplingIndex OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The index of this parameter set in the psampRandomOutOfNSamplingParameterSetTable. It is used in entries of the psampInstanceTable as reference to this parameter set." ::= { psampRandomOutOfNSamplingParameterSetEntry 1 } psampRandomOutOfNSamplingRate OBJECT-TYPE SYNTAX Integer32 UNITS "1/1000000" MAX-ACCESS read-create STATUS current DESCRIPTION "When retrieved, this object specifies a sampling rate for random n-out-of-N sampling." REFERENCE "draft-ietf-psamp-sample-tech-01.txt, Section 5.2" ::= { psampRandomOutOfNSamplingParameterSetEntry 2 } -- Method 4: Random Probabilistic Sampling psampRandomProbabilisticSampling OBJECT IDENTIFIER ::= { psampMethods 4 } psampRandomProbabilisticSamplingAvailability OBJECT-TYPE SYNTAX PsampMethodAvailability MAX-ACCESS read-only STATUS current DESCRIPTION "When retrieved, this object indicates the availability of random probabilisticf sampling at the managed node." DEFVAL { notAvailable } ::= { psampRandomProbabilisticSampling 1 } psampRandomProbabilisticSamplingCapabilities OBJECT IDENTIFIER ::= { psampRandomProbabilisticSampling 2 } -- No capabilities defined, yet. psampRandomProbabilisticSamplingParameterSetTable OBJECT-TYPE SYNTAX SEQUENCE OF PsampRandomProbabilisticSamplingParameterSetEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table lists configurations of random probabilistic sampling. A parameter set describing a configuration contains a single parameter only: the sampling rate." ::= { psampRandomProbabilisticSampling 3 } psampRandomProbabilisticSamplingParameterSetEntry OBJECT-TYPE SYNTAX PsampRandomProbabilisticSamplingParameterSetEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Defines an entry in the psampRandomProbabilisticSamplingParameterSetTable." INDEX { psampRandomProbabilisticSamplingIndex } ::= { psampRandomProbabilisticSamplingParameterSetTable 1 } PsampRandomProbabilisticSamplingParameterSetEntry ::= SEQUENCE { psampRandomProbabilisticSamplingIndex Integer32, psampRandomProbabilisticSamplingRate Integer32 } psampRandomProbabilisticSamplingIndex OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The index of this parameter set in the psampRandomProbabilisticSamplingParameterSetTable. It is used in entries of the psampInstanceTable as reference to this parameter set." ::= { psampRandomProbabilisticSamplingParameterSetEntry 1 } psampRandomProbabilisticSamplingRate OBJECT-TYPE SYNTAX Integer32 UNITS "1/1000000" MAX-ACCESS read-create STATUS current DESCRIPTION "When retrieved, this object specifies a sampling rate for random probabilistic sampling." REFERENCE "draft-ietf-psamp-sample-tech-01.txt, Section 5.2" ::= { psampRandomProbabilisticSamplingParameterSetEntry 2 } -- Reporting Group psampReporting OBJECT IDENTIFIER ::= { psampObjects 2 } psampCollectorTable OBJECT-TYPE SYNTAX SEQUENCE OF PsampCollectorEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table lists collectors to which sampled packets are exported." ::= { psampReporting 1 } psampCollectorEntry OBJECT-TYPE SYNTAX PsampCollectorEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Defines an entry in the psampCollectorTable." INDEX { psampCollectorIndex } ::= { psampCollectorTable 1 } PsampCollectorEntry ::= SEQUENCE { psampCollectorIndex Integer32, psampCollectorTargetIpAddressType InetAddressType, psampCollectorTargetIpAddress InetAddress, psampCollectorTargetProtocol Integer32, psampCollectorTargetPort Integer32, psampCollectorReportsSent Integer32 } psampCollectorIndex OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The locally arbitrary, but unique identifier of a collector. The value is expected to remain constant at least from one re-initialization of the entity's network management system to the next re-initialization." ::= { psampCollectorEntry 1 } psampCollectorTargetIpAddressType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-create STATUS current DESCRIPTION "The IP address type of the collector." ::= { psampCollectorEntry 2 } psampCollectorTargetIpAddress OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-create STATUS current DESCRIPTION "The IP address of the collector." ::= { psampCollectorEntry 3 } psampCollectorTargetProtocol OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-create STATUS current DESCRIPTION "The transport protocol used for exporting sampled packets to the collector. Allowed values are ... " ::= { psampCollectorEntry 4 } psampCollectorTargetPort OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-create STATUS current DESCRIPTION "The port number of the collector." ::= { psampCollectorEntry 5 } psampCollectorReportsSent OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of reports sent to the collector." ::= { psampCollectorEntry 6 } -- Instance Group psampInstances OBJECT IDENTIFIER ::= { psampObjects 3 } psampInstanceTable OBJECT-TYPE SYNTAX SEQUENCE OF PsampInstanceEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table lists active instances of packet sampling at the managed node." ::= { psampInstances 1 } psampInstanceEntry OBJECT-TYPE SYNTAX PsampInstanceEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Defines an entry in the psampInstanceTable." INDEX { psampInstanceIndex } ::= { psampInstanceTable 1 } PsampInstanceEntry ::= SEQUENCE { psampInstanceIndex Integer32, psampInstanceIfIndex InterfaceIndex, psampInstanceParameterSet1 OBJECT IDENTIFIER, psampInstanceParameterSet2 OBJECT IDENTIFIER, psampInstanceCollectorIndex Integer32, psampInstancePacketsObserved1 Integer32, psampInstancePacketsObserved2 Integer32, psampInstanceReportsSent Integer32 } psampInstanceIndex OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "The locally arbitrary, but unique identifier of an instance. The value is expected to remain constant at least from one re-initialization of the entity's network management system to the next re-initialization." ::= { psampInstanceEntry 1 } psampInstanceIfIndex OBJECT-TYPE SYNTAX InterfaceIndex MAX-ACCESS read-create STATUS current DESCRIPTION "Index of the IP interface at which the packet stream is observed by packet selection method 1." ::= { psampInstanceEntry 2 } psampInstanceParameterSet1 OBJECT-TYPE SYNTAX OBJECT IDENTIFIER MAX-ACCESS read-create STATUS current DESCRIPTION "The OID of a parameter set in one of the method-specific tables in the Methods group. The identified method is applied to the stream of packets observed at the interface." ::= { psampInstanceEntry 3 } psampInstanceParameterSet2 OBJECT-TYPE SYNTAX OBJECT IDENTIFIER MAX-ACCESS read-create STATUS current DESCRIPTION "The OID of a parameter set in one of the method-specific tables in the Methods group. The identified method is applied to the stream of packets sampled by the method identified by parameter set 1." ::= { psampInstanceEntry 4 } psampInstanceCollectorIndex OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-create STATUS current DESCRIPTION "The index of the collector to which packet reports are sent." ::= { psampInstanceEntry 5 } psampInstancePacketsObserved1 OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of packets observed by method 1 before selecting packets." ::= { psampInstanceEntry 6 } psampInstancePacketsObserved2 OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of packets observed by method 2 before selecting packets. This is the number of packets sampled by method 1." ::= { psampInstanceEntry 7 } psampInstanceReportsSent OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of reports on sampled packets sent to the collector." ::= { psampInstanceEntry 8 } -- Conformance information -- Compliance statements psampCompliances OBJECT IDENTIFIER ::= { psampConformance 1 } psampGroups OBJECT IDENTIFIER ::= { psampConformance 2 } -- Compliance statements psampCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for the PSAMP-MIB." MODULE -- this module MANDATORY-GROUPS { psampGroup } ::= { psampCompliances 1 } -- MIB groupings psampGroup OBJECT-GROUP OBJECTS { psampSelectingAllAvailability, psampSystematicCountBasedSamplingAvailability, psampSystematicCountBasedSamplingMaxInterval, psampSystematicCountBasedSamplingMaxSpacing, psampSystematicCountBasedSamplingInterval, psampSystematicCountBasedSamplingSpacing, psampSystematicTimeBasedSamplingAvailability, psampSystematicTimeBasedSamplingMaxInterval, psampSystematicTimeBasedSamplingMaxSpacing, psampSystematicTimeBasedSamplingInterval, psampSystematicTimeBasedSamplingInterval, psampSystematicTimeBasedSamplingSpacing, psampRandomOutOfNSamplingAvailability, psampRandomOutOfNSamplingRate, psampRandomProbabilisticSamplingAvailability, psampRandomProbabilisticSamplingRate, psampCollectorTargetIpAddressType, psampCollectorTargetIpAddress, psampCollectorTargetProtocol, psampCollectorTargetPort, psampCollectorReportsSent, psampInstanceIfIndex, psampInstanceParameterSet1, psampInstanceParameterSet2, psampInstanceCollectorIndex, psampInstancePacketsObserved1, psampInstancePacketsObserved2, psampInstanceReportsSent } STATUS current DESCRIPTION "The group of all accessible objects of the PSAMP MIB." ::= { psampGroups 1 } END -- -- Copyright (C) The Internet Society (2003). 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 implmentation 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.