-- extracted from draft-kobayashi-ipfix-concentrator-mib-01.txt -- at Sat Mar 4 06:10:53 2006 IPFIX-COLLECTOR-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Integer32, Counter32, mib-2 FROM SNMPv2-SMI -- RFC2578 TEXTUAL-CONVENTION, RowStatus, DateAndTime FROM SNMPv2-TC -- RFC2579 MODULE-COMPLIANCE, OBJECT-GROUP FROM SNMPv2-CONF -- RFC2580 InetAddressType, InetAddress FROM INET-ADDRESS-MIB; -- RFC3291 ipfixCollectorMIB MODULE-IDENTITY LAST-UPDATED "200602161600Z" -- 16 February 2006 ORGANIZATION "IETF IPFIX Working Group" CONTACT-INFO "Editor: Atsushi Kobayashi NTT Information Sharing Platform Laboratories 3-9-11 Midori-cho Musashino-shi 180-8585 Japan Phone: +81-422-59-3978> Email: akoba@nttv6.net" DESCRIPTION "The IPFIX collector MIB defines managed objects that are maintained by the collecting process in Traffic Collector or IPFIX concentrator. These objects provide informations that are Exporter's profile data and received templates. Exporter's profile has that Exporter's ip address and port number. In addition, these object has statistics data per exporter or per templates. Copyright (C) The Internet Society (2005). This version of this MIB module is part of RFC yyyy; see the RFC itself for full legal notices." -- replace yyyy with actual RFC number & remove this noti -- Revision history REVISION "200502161600Z" -- 16 February 2006 DESCRIPTION "Initial version, published as RFC yyyy." -- replace yyyy with actual RFC number & remove this notice ::= { mib-2 XXXX } -- XXXX to be assigned by IANA. -- Top level structure of the MIB collectorObjects OBJECT IDENTIFIER ::= { ipfixCollectorMIB 1 } collectorConformance OBJECT IDENTIFIER ::= { ipfixCollectorMIB 2 } -------------------------------------------------------------------- -- objects of collecting process -------------------------------------------------------------------- collectExporter OBJECT IDENTIFIER ::= { collectorObjects 1 } -------------------------------------------------------------------- -- 1: Exporter Table -------------------------------------------------------------------- collectExporterTable OBJECT-TYPE SYNTAX SEQUENCE OF CollectExporterEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table lists Exporters that received by collecting process. This process manages them." ::= { collectExporter 1 } collectExporterEntry OBJECT-TYPE SYNTAX CollectExporterEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Defines an entry in the collectExporterTable" INDEX { collectExporterIndex } ::= { collectExporterTable 1 } CollectExporterEntry ::= SEQUENCE { collectExporterIndex Integer32, collectExporterSrcIpAddrType InetAddressType, collectExporterSrcIpAddr InetAddress, collectExporterProtocol Integer32, collectExporterDstPort Integer32, collectExporterSrcPort Integer32, collectExporterProcessId Integer32, collectExporterRcdPackets Counter32, collectExporterRcdBytes Counter32, collectExporterRcdMessages Counter32, collectExporterRcdFlows Counter32, collectExporterRcdTemplates Counter32, collectExporterRcdSequence Integer32, collectExporterRowStatus RowStatus } collectExporterIndex OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "Locally arbitrary, but unique identifier of an entry in collectExporterTable. The value is expected to remain constant from a re-initialization of the entity's network management system to the next re-initialization. It is used in entries of the concExporterListTable in IPFIX concentrator MIB objects as reference to the collectExporterTable and its associated parameters." ::= { collectExporterEntry 1 } collectExporterSrcIpAddrType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-create STATUS current DESCRIPTION "The IP address type of the exporter. The value for IPv4 is ipv4(1). The value for IPv6 is ipv6(2)." ::= { collectExporterEntry 2 } collectExporterSrcIpAddr OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-create STATUS current DESCRIPTION "The IP address of the exporter." ::= { collectExporterEntry 3 } collectExporterProtocol OBJECT-TYPE SYNTAX Integer32 (0..256) MAX-ACCESS read-create STATUS current DESCRIPTION "The transport protocol is used for receiving sampled packets from the exporter. The recommended protocols are TCP (6), UDP (17) and SCTP (132). The default is SCTP." DEFVAL { 132 } ::= { collectExporterEntry 4 } collectExporterDstPort OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-create STATUS current DESCRIPTION "The transport protocol port number used by the local Collecting Process." DEFVAL { 4739 } ::= { collectExporterEntry 5 } collectExporterSrcPort OBJECT-TYPE SYNTAX Integer32 (0..65535) MAX-ACCESS read-only STATUS current DESCRIPTION "The transport protocol port number of the pre-IPFIX enabled device." ::= { collectExporterEntry 6 } collectExporterProcessId OBJECT-TYPE SYNTAX Integer32 (0..256) MAX-ACCESS read-only STATUS current DESCRIPTION "The process id is used by this collecting process." ::= { collectExporterEntry 7 } collectExporterRcdPackets OBJECT-TYPE SYNTAX Counter32 (0..256) MAX-ACCESS read-only STATUS current DESCRIPTION "The number of packets received from the pre-IPFIX enabled device." ::= { collectExporterEntry 8 } collectExporterRcdBytes OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of bytes received from the pre-IPFIX enabled device." ::= { collectExporterEntry 9 } collectExporterRcdMessages OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of IPFIX messages received from the pre-IPFIX enabled device." ::= { collectExporterEntry 10 } collectExporterRcdFlows OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of flow records received from the pre-IPFIX enabled device." ::= { collectExporterEntry 11 } collectExporterRcdTemplates OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of templates received from the pre-IPFIX enabled device." ::= { collectExporterEntry 12 } collectExporterRcdSequence OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "The latest sequence number. The collecting process overwrites to this object when it receives IPFIX message." ::= { collectExporterEntry 13 } collectExporterRowStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The status of this row of the table." ::= { collectExporterEntry 14 } -------------------------------------------------------------------- -- 2: Template Record Table -------------------------------------------------------------------- collectTemplateRcdTable OBJECT-TYPE SYNTAX SEQUENCE OF CollectTemplateRcdEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table lists templates that are received by the collecting process. This process manages them." ::= { collectExporter 2 } collectTemplateRcdEntry OBJECT-TYPE SYNTAX CollectTemplateRcdEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Defines an entry in the collectTemplateRcdTable" INDEX { collectExporterIndex, collectTemplateRcdId, collectTemplateRcdIndex } ::= { collectTemplateRcdTable 1 } CollectTemplateRcdEntry ::= SEQUENCE { collectTemplateRcdId Integer32, collectTemplateRcdIndex Integer32, collectTemplateRcdInfoEltId Integer32, collectTemplateRcdRowStatus RowStatus } collectTemplateRcdId OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "Locally arbitrary, but unique identifier of an entry in collectTemplateRcdTable. The value is expected to remain constant from a re-initialization of the entity's network management system to the next re-initialization. It groups the information element ids in a template record." ::= { collectTemplateRcdEntry 2 } collectTemplateRcdIndex OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "Locally arbitrary, but unique identifier of an information element id in the template record identified by collectTemplateRcdId. The value is expected to remain constant from a re-initialization of the entity's network management system to the next re-initialization. The collectTemplateRcdIndex specifies the order in which the information element ids are used in the template record." ::= { collectTemplateRcdEntry 3 } collectTemplateRcdInfoEltId OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS read-only STATUS current DESCRIPTION "This indicates the Information Elt Id at position collectTemplateRcdIndex in the template collectTemplateRcdId. This implicitly gives the data type and state values that are received." ::= { collectTemplateRcdEntry 4 } collectTemplateRcdRowStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The status of this row of the table." ::= { collectTemplateRcdEntry 5 } -------------------------------------------------------------------- -- 3: Template Statistics Table -------------------------------------------------------------------- collectTemplateStatisticsTable OBJECT-TYPE SYNTAX SEQUENCE OF CollectTemplateStatisticsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table lists statistics objects that have data per template." ::= { collectExporter 3 } collectTemplateStatisticsEntry OBJECT-TYPE SYNTAX CollectTemplateStatisticsEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Defines an entry in the collectTemplateStatisticsTable" INDEX { collectExporterIndex, collectTemplateRcdId } ::= { collectTemplateStatisticsTable 1 } CollectTemplateStatisticsEntry ::= SEQUENCE { collectTempRcdFlows Counter32, collectTempRcdTime DateAndTime, collectTempStatisRowStatus RowStatus } collectTempRcdFlows OBJECT-TYPE SYNTAX Counter32 MAX-ACCESS read-only STATUS current DESCRIPTION "The number of flow records per template received from the pre-IPFIX enabled device." ::= { collectTemplateStatisticsEntry 1 } collectTempRcdTime OBJECT-TYPE SYNTAX DateAndTime MAX-ACCESS read-only STATUS current DESCRIPTION "Time that the collecting process received this template." ::= { collectTemplateStatisticsEntry 2 } collectTempStatisRowStatus OBJECT-TYPE SYNTAX RowStatus MAX-ACCESS read-create STATUS current DESCRIPTION "The status of this row of the table." ::= { collectTemplateStatisticsEntry 3 } --================================================================== -- Conformance information --================================================================== collectCompliances OBJECT IDENTIFIER ::= { collectorConformance 1 } collectGroups OBJECT IDENTIFIER ::= { collectorConformance 2 } --================================================================== -- Compliance statements --================================================================== collectCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "An implementation that complies to this module must implement the objects defined in the mandatory groups collectGroupExporters, collectGroupTemplates. The imeplementation of all other objects depends on the imeplementation of the corresponding functionality in the equipment." MODULE -- this module MANDATORY-GROUPS { collectGroupExporters, collectGroupTemplates } GROUP collectGroupStatistics DESCRIPTION "These objects must be implementes if the statistics function is implemented in the equipment." ::= { collectCompliances 1 } --================================================================== -- MIB groupings --================================================================== collectGroupExporters OBJECT-GROUP OBJECTS { collectExporterSrcIpAddrType, collectExporterSrcIpAddr, collectExporterProtocol, collectExporterDstPort, collectExporterSrcPort, collectExporterProcessId, collectExporterRowStatus } STATUS current DESCRIPTION "All objects that are basic for the management function of exporters." ::= { collectGroups 1 } collectGroupTemplates OBJECT-GROUP OBJECTS { collectTemplateRcdInfoEltId, collectTemplateRcdRowStatus } STATUS current DESCRIPTION "All objects that are basic for the management function of templates." ::= { collectGroups 2 } collectGroupStatistics OBJECT-GROUP OBJECTS { collectExporterRcdPackets, collectExporterRcdBytes, collectExporterRcdMessages, collectExporterRcdFlows, collectExporterRcdTemplates, collectExporterRcdSequence, collectTempRcdFlows, collectTempRcdTime, collectTempStatisRowStatus } STATUS current DESCRIPTION "All objects that are basic for the statistics function." ::= { collectGroups 3 } END -- -- Copyright (C) The Internet Society (2006). This document is subject -- to the rights, licenses and restrictions contained in BCP 78, and -- except as set forth therein, the authors retain all their rights. -- -- -- Acknowledgment -- -- Funding for the RFC Editor function is currently provided by the -- Internet Society.