Feedback
|
Table Of Contents
Periodic MIB Data Collection and Transfer Mechanism
Prerequisites for Periodic MIB Data Collection and Transfer Mechanism
Restrictions for Periodic MIB Data Collection and Transfer Mechanism
Information About Periodic MIB Data Collection and Transfer Mechanism
Bulk Statistics Transfer Options
Benefits of the Periodic MIB Data Collection and Transfer Mechanism
How to Configure Periodic MIB Data Collection and Transfer Mechanism
Configuring a Bulk Statistics Object List
Configuring a Bulk Statistics Schema
Configuring a Bulk Statistics Transfer Options
Enabling Monitoring for Bulk Statistics Collection
Monitoring and Troubleshooting Periodic MIB Data Collection and Transfer Mechanism
Configuration Examples for Periodic MIB Data Collection and Transfer Mechanism
Example: Configuring Periodic MIB Data Collection and Transfer Mechanism
Schema Definition Configuration
Transfer Parameter Configuration
Feature Information for Periodic MIB Data Collection and Transfer Mechanism
Periodic MIB Data Collection and Transfer Mechanism
First Published: January 20, 2003Last Updated: September 10, 2010This document describes how to periodically transfer selected MIB data from Cisco IOS-based devices to specified Network Management Systems (NMS).
Finding Feature Information
Your software release may not support all the features documented in this module. For the latest feature information and caveats, see the release notes for your platform and software release. To find information about the features documented in this module, and to see a list of the releases in which each feature is supported, see the "Feature Information for Periodic MIB Data Collection and Transfer Mechanism" section.
Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Contents
•
Prerequisites for Periodic MIB Data Collection and Transfer Mechanism
•
Restrictions for Periodic MIB Data Collection and Transfer Mechanism
•
Information About Periodic MIB Data Collection and Transfer Mechanism
•
How to Configure Periodic MIB Data Collection and Transfer Mechanism
•
Configuration Examples for Periodic MIB Data Collection and Transfer Mechanism
Prerequisites for Periodic MIB Data Collection and Transfer Mechanism
To use this feature, you should be familiar with the Simple Network Management Protocol (SNMP) model of management information. You should also know what MIB information you want to monitor on your network devices, and the OIDs or object names for the MIB objects to be monitored.
Restrictions for Periodic MIB Data Collection and Transfer Mechanism
Cisco Data Collection MIB configuration using SNMP is not currently implemented.
For specific restrictions, see the tasks in the "How to Configure Periodic MIB Data Collection and Transfer Mechanism" section.
Information About Periodic MIB Data Collection and Transfer Mechanism
•
Bulk Statistics Transfer Options
•
Benefits of the Periodic MIB Data Collection and Transfer Mechanism
Note
In the Cisco IOS CLI, the Periodic MIB Data Collection and Transfer Mechanism is referred to as the Bulk Statistics feature.
SNMP Objects and Instances
A type (or class) of SNMP management information is called an object. A specific instance from a type of management information is called an object instance (or SNMP variable). To configure a bulk statistics collection, you must specify the object types to be monitored using a bulk statistics object list and the specific instances of those objects to be collected using a bulk statistics schema.
MIBs, MIB tables, MIB objects, and object indices can all be specified using a series of numbers called an object identifier (OID). OIDs are used in configuring a bulk statistics collection in both the bulk statistics object lists (for general objects) and in the bulk statistics schemas (for specific object instances).
Bulk Statistics Object Lists
To group the MIB objects to be polled, you will need to create one or more object lists. A bulk statistics object list is a user-specified set of MIB objects that share the same MIB index. Object lists are identified using a name that you specify. Named bulk statistics object lists allow the same configuration to be reused in different bulk statistics schemas.
All the objects in an object list must share the same MIB index. However, the objects do not need to be in the same MIB and do not need to belong to the same MIB table. For example, it is possible to group ifInOctets and an Ethernet MIB object in the same schema, because the containing tables for both objects are indexed by the ifIndex.
Bulk Statistics Schemas
Data selection for the Periodic MIB Data Collection and Transfer Mechanism requires the definition of a schema with the following information:
•
Name of an object list.
•
Instance (specific or wildcarded) that needs to be retrieved for objects in above object list.
•
How often the specified instances need to be sampled (polling interval).
A bulk statistics schema is also identified using a name that you specify. This name is used when configuring the transfer options.
Bulk Statistics Transfer Options
After configuring the data to be collected, a single virtual file (VFile or "bulk statistics file") with all collected data is created. This file can be transferred to a network management station (NMS) using FTP, rcp, or TFTP. You can specify how often this file should be transferred. The default transfer interval is once every 30 minutes. You can also configure a secondary destination for the file to be used if, for whatever reason, the file cannot be transferred to the primary network management station.
The value of the transfer interval is also the collection period (collection interval) for the local bulk statistics file. After the collection period ends, the bulk statistics file is frozen, and a new local bulk statistics file is created for storing data. The frozen bulk statistics file is then transferred to the specified destination.
By default, the local bulk statistics file is deleted after successful transfer to an NMS. However, you can configure the routing device to keep the bulk statistics file in memory for a specified amount of time.
An SNMP notification (trap) can be sent to the NMS if a transfer to the primary or secondary NMS is not successful. Additionally, a syslog message will be logged on the local device if transfers are unsuccessful.
Benefits of the Periodic MIB Data Collection and Transfer Mechanism
The Periodic MIB Data Collection and Transfer Mechanism (Bulk Statistics feature) allows many of the same functions as the Bulk File MIB (CISCO-BULK-FILE-MIB.my), but offers some key advantages.
The main advantage is that this feature can be configured through the CLI and does not require an external monitoring application.
The Periodic MIB Data Collection and Transfer Mechanism is mainly targeted for medium to high-end platforms that have sufficient local storage (volatile or permanent) to store bulk statistics files. Locally storing bulk statistics files helps minimize loss of data during temporary network outages.
This feature also has more powerful data selection features than the Bulkfile MIB; it allows grouping of MIB objects from different tables into data groups (object lists). It also incorporates a more flexible instance selection mechanism, where the application is not restricted to fetching an entire MIB table.
How to Configure Periodic MIB Data Collection and Transfer Mechanism
•
Configuring a Bulk Statistics Object List (required)
•
Configuring a Bulk Statistics Schema (required)
•
Configuring a Bulk Statistics Transfer Options (required)
•
Enabling Monitoring for Bulk Statistics Collection (optional)
•
Monitoring and Troubleshooting Periodic MIB Data Collection and Transfer Mechanism (optional)
Configuring a Bulk Statistics Object List
The first step in configuring the Periodic MIB Data Collection and Transfer Mechanism is to configure one or more object lists.
Restrictions
All the objects in a bulk statistics object list have to be indexed by the same MIB index. However, the objects in the object list do not need to belong to the same MIB or MIB table.
When specifying an object name instead of an OID (using the add command), only object names from the Interfaces MIB (IF-MIB.my), Cisco Committed Access Rate MIB (CISCO-CAR-MIB.my) and the MPLS Traffic Engineering MIB (MPLS-TE-MIB.my) may be used.
SUMMARY STEPS
1.
enable
2.
configure terminal
3.
snmp mib bulkstat object-list list-name
4.
add {oid | object-name}
5.
exit
DETAILED STEPS
Configuring a Bulk Statistics Schema
The next step in configuring the Periodic MIB Data Collection and Transfer Mechanism is to configure one or more schemas.
Prerequisites
The bulk statistics object list to be used in the schema must be defined.
Restrictions
Only one object list can be associated with a schema at a time.
SUMMARY STEPS
1.
snmp mib bulkstat schema schema-name
2.
object-list list-name
3.
instance {exact | wild} {interface interface-id [sub-if] | controller controller-id [sub-if] | oid oid}
4.
instance range start oid end oid (optional)
5.
instance repetition oid-instance max repeat-number (optional)
6.
poll-interval minutes
7.
exit
DETAILED STEPS
Configuring a Bulk Statistics Transfer Options
The final step in configuring the Periodic MIB Data Collection and Transfer Mechanism is to configure the transfer options. The collected MIB data are kept in a local file-like entity called a VFile (virtual file, referred to as a bulk statistics file in this document). This file can be transferred to a remote network management station (NMS) at intervals you specify.
Prerequisites
The bulk statistics object lists and bulk statistics schemas should be defined before configuring the bulk statistics transfer options.
Restrictions
Transfers can only be performed using schemaASCII (cdcSchemaASCII) format. SchemaASCII is an ASCII format that contains parser-friendly hints for parsing data values.
SUMMARY STEPS
1.
snmp mib bulkstat transfer transfer-id
2.
buffer-size bytes (optional)
3.
format {bulkBinary | bulkASCII | schemaASCII} (optional)
4.
schema schema-name
5.
transfer-interval minutes (optional)
6.
url primary url
7.
url secondary url (optional)
8.
retry number (optional)
9.
retain minutes (optional)
10.
enable
11.
exit
DETAILED STEPS
Troubleshooting Tips
If the maximum buffer size for a bulk statistics file is reached before the transfer interval time expires, the transfer operation will still be initiated, and bulk statistics data will be collected into a new file in the system buffer. To correct this behavior, you can decrease the polling frequency, or increase the size of the bulk statistics buffer. If retain 0 is configured, no retries will be attempted. This is because the interval between retries is the retain value divided by the retry value. For example, if retain 10 and retry 2 are configured, retries will be attempted once every 5 minutes. Therefore, if you configure the retry command, you should also configure an appropriate value for the retain command.
Enabling Monitoring for Bulk Statistics Collection
Optionally, you can enable SNMP notifications to be sent, which provide information on the transfer status of the Periodic MIB Data Collection and Transfer Mechanism (Bulk Statistics feature).
SUMMARY STEPS
1.
configure terminal
2.
snmp-server community string [view view-name] [ro | rw] [acl-number]
3.
snmp-server enable traps bulkstat [collection | transfer]
4.
snmp-server host host-address [traps | informs] [version {1 | 2c | 3 [auth | noauth | priv]}] community-string [udp-port port] [bulkstat]
5.
do copy running-config startup-config
DETAILED STEPS
Monitoring and Troubleshooting Periodic MIB Data Collection and Transfer Mechanism
The show command for this feature displays the status of the bulk statistics processes. The debug command enables the standard set of debugging messages for technical support purposes.
SUMMARY STEPS
1.
show snmp mib bulkstat transfer [transfer-name]
2.
debug snmp bulkstat
DETAILED STEPS
Configuration Examples for Periodic MIB Data Collection and Transfer Mechanism
This section provides the following configuration example:
•
Example: Configuring Periodic MIB Data Collection and Transfer Mechanism
Example: Configuring Periodic MIB Data Collection and Transfer Mechanism
This section provides a complete example of configuring the Periodic MIB Data Collection and Transfer Mechanism (Bulk Statistics feature). The example is described in the following subsections:
•
Schema Definition Configuration
•
Transfer Parameter Configuration
Transfer Parameters
The following transfer parameters are used for the "Configuring the Periodic MIB Data Collection and Transfer Mechanism" example:
•
Transfer interval (collection interval)—30 minutes
•
Primary URL—ftp://john:pswrd@cbin2-host/users/john/bulkstat1
•
Secondary URL—tftp://john@10.1.1.1/tftpboot/john/bulkstat1
•
Transfer format—schemaASCII
•
Retry interval—Retry after 6 minutes (retry = 5, retain = 30; 5 retry attempts over the 30-minute retention interval.)
Polling Requirements
The following polling requirements for ATM interface 2/0 and Ethernet interface 2/1 are used for the "Configuring the Periodic MIB Data Collection and Transfer Mechanism" example:
ATM interface 2/0
•
Objects to be polled—ifInOctets, ifOutOctets, ifInUcastPkts, ifInDiscards, CcarStatSwitchedPkts, CcarStatSwitchedBytes, CcarStatFilteredBytes
•
Polling interval—Once every 5 minutes
•
Instances—Main interface and all subinterfaces
•
For CAR MIB objects, poll all instances related to the specified interface
Ethernet Interface 2/1
•
Objects to be polled—ifInOctets, ifOutOctets, ifInUcastPkts, ifInDiscards, CcarStatSwitchedPkts, CcarStatSwitchedBytes, CcarStatFilteredBytes
•
Polling interval—Once every 10 minutes
•
Instances—Only main interface is to be monitored
•
For CAR MIB objects, only include instances pertaining to packets in the incoming direction (on the main interface)
Object List Configuration
Note that since the IF-MIB objects and the CAR-MIB objects do not have the same index, they will have to be a part of different schemas. However, since the objects required are the same for the ATM interface and the Ethernet interface, the object list can be reused for each schema. Therefore, in the following example, an object list is created for the for the IF-MIB objects and another object list is created for the CAR-MIB objects.
snmp mib bulkstat object-list ifmibadd ifInoctetsadd ifOutoctetsadd ifInUcastPktsadd ifInDiscardsexitsnmp mib bulkstat object-list CAR-mibadd CcarStatSwitchedPktsadd CcarStatSwitchedBytesadd CcarStatFilteredBytesexitSchema Definition Configuration
For the following bulk statistics schema configuration, two schemas are defined for each interface—one for the IF-MIB object instances and one for the CAR-MIB object instances.
! ATM IF-MIB schemasnmp mib bulkstat schema ATM2/0-IFMIB! The following command points to the IF-MIB object list, defined above.object-list ifmibpoll-interval 5instance exact interface ATM2/0 subifexit! ATM CAR-MIB schemasnmp mib bulkstat schema-def ATM2/0-CARobject-list CAR-mibpoll-interval 5instance wildcard interface ATM2/0 subifexit!Ethernet IF-MIB schemasnmp mib bulkstat schema Ethernet2/1-IFMIBobject-list ifmibpoll-interval 5instance exact interface Ethernet2/1exit! Ethernet CAR-MIB schemasnmp mib bulkstat schema Ethernet2/1-CARobject-list CAR-mibpoll-interval 5! Note: ifindex of Ethernet2/1 is 3instance wildcard oid 3.1exitTransfer Parameter Configuration
For the transfer of the bulk statistics file, the transfer configuration is given the name bulkstat1. All of the four schema definitions are included in the following transfer configuration.
snmp mib bulkstat transfer bulkstat1schema ATM2/0-IFMIBschema ATM2/0-CARschema Ethernet2/1-IFMIBschema Ethernet2/1-CARurl primary ftp://username1:pswrd@cbin2-host/users/username1/bulkstat1url secondary tftp://username1@10.1.0.1/tftpboot/username1/bulkstat1format schemaASCIItransfer-interval 30retry 5buffer-size 1024retain 30endcopy running-config startup-configDisplaying Status
The following sample output for the show snmp mib bulkstat transfer command shows that the initial transfer attempt and the first retry has failed for the newest file, and four additional retry attempts will be made:
Router# show snmp mib bulkstat transferTransfer Name : bulkstat1Primary URL ftp://user:XXXXXXXX@192.168.200.162/Secondary ftp://user:XXXXXXXX@192.168.200.163/Retained filesFile Name : Time Left (in seconds) : STATE----------------------------------------------------------------------bulkstat1_Router_030307_102519739: 1196 :Retry(4 Retry attempt(s) Left)bulkstat1_Router_030307_102219739: 1016 :Retainedbulkstat1_Router_030307_101919739: 836 :RetainedThe filename for the bulk statistics file is generated with the following extensions to the name you specify in the url command:
specified-filename_device-name_date_time-stamp
The device name is the name of the sending device, as specified in the CLI prompt.
The time-stamp format will depend on your system configuration. Typically, the format for the date is YYYYMMDD or YYMMDD. The time stamp uses a 24-hour clock notation, and the format is HHMMSSmmm (where mmm are milliseconds).
In the example above, the files were created on March 7, 2003, at 10:25 a.m., 10:22 a.m., and 10:19 a.m.
Bulk Statistics Output File
The following is sample output as it appears in the bulk statistics file received at the transfer destination. In this output, the name of the bulk statistics file is bulkstat1_Router_20030131_193354234. Also, note that the schema definition (Schema-def) for the schema Ethernet2/1-IFMIB was added to the file as the configuration was changed (see comment lines indicated by "!").
Schema-def ATM2/0-IFMIB "%u, %s, %u, %u, %u, %u"epochtime ifDescr instanceoid ifInOctets ifOutOctets ifInUcastPkts ifInDiscardsSchema-def ATM2/0-CAR "%u, %s, %s, %u, %u, %u, %u "epochtime ifDescr instanceoid CcarStatSwitchedPkts ccarStatSwitchedBytes CcarStatSwitchedPkts ccarStatSwitchedBytesSchema-def Ethernet2/1-IFMIB "%u, %u, %u, %u, %u, %u"epochtime ifDescr instanceoid ifInOctets ifOutOctets ifInUcastPkts ifInDiscardsSchema-def Ethernet2/1-CAR "%u, %s, %u, %u, %u, %u "Epochtime instanceoid CcarStatSwitchedPkts ccarStatSwitchedBytes CcarStatSwitchedPkts ccarStatSwitchedBytesSchema-def GLOBAL "%s, %s, %s, %u, %u, %u, %u"hostname data timeofday sysuptime cpu5min cpu1min cpu5secATM2/0-IFMIB: 954417080, ATM2/0, 2, 95678, 23456, 234, 3456ATM2/0-IFMIB: 954417080, ATM2/0.1, 8, 95458, 54356, 245, 454ATM2/0-IFMIB: 954417080, ATM2/0.2, 9, 45678, 8756, 934, 36756ATM2/0-CAR: 954417083, ATM2/0, 2.1.1, 234, 345, 123, 124ATM2/0-CAR: 954417083, ATM2/0, 2.2.1, 452, 67, 132, 145ATM2/0-CAR: 954417083, ATM2/0.1, 8.1.1, 224, 765, 324 234ATM2/0-CAR: 954417083, ATM2/0.1, 8.2.1, 234, 345, 123, 124ATM2/0-CAR: 954417083, ATM2/0.2, 9.1.1, 234, 345, 123, 124ATM2/0-CAR: 954417083, ATM2/0.2, 9.2.1, 452, 67, 132, 145Ethernet2/1-IFMIB: 954417090, Ethernet2/1, 3, 45678, 8756, 934, 36756Ethernet2/1-CAR: 954417093, 3.1.1, 234, 345, 123, 124Ethernet2/1-CAR: 954417093, 3.1.2, 134, 475, 155, 187ATM2/0-IFMIB: 954417100, ATM2/0, 2, 95678, 23456, 234, 3456ATM2/0-IFMIB: 954417101, ATM2/0.1, 8, 95458, 54356, 245, 454ATM2/0-IFMIB: 954417102, ATM2/0.2, 9, 45678, 8756, 934, 36756ATM2/0-CAR: 954417106, ATM2/0, 2.1.1, 234, 345, 123, 124ATM2/0-CAR: 954417107, ATM2/0, 2.2.1, 452, 67, 132, 145ATM2/0-CAR: 954417107, ATM2/0.1, 8.1.1, 224, 765, 324 234ATM2/0-CAR: 954417108, ATM2/0.1, 8.2.1, 234, 345, 123, 124ATM2/0-CAR: 954417113, ATM2/0.2, 9.1.1, 234, 345, 123, 124ATM2/0-CAR: 954417114, ATM2/0.2, 9.2.1, 452, 67, 132, 145! Here the Schema-def for "Ehternet2/1-IFMIB" was changed on the originating device.Schema-def Ethernet2/1-IFMIB "%u, %u, %u, %u, %u, %u"! The object ifOutDiscards has been added to the object list for this schema.epochtime ifDescr instanceoid ifInOctets ifOutOctets ifInUcastPkts ifInDiscardsifOutDiscards! The following data sample reflects the change in the configuration.Ethernet2/1-IFMIB: 954417090, Ethernet2/1, 3, 45678, 8756, 934, 36756, 123Ethernet2/1-CAR: 954417093, 3.1.1, 234, 345, 123, 124Ethernet2/1-CAR: 954417093, 3.1.2, 134, 475, 155, 187GLOBAL: Govinda, 20020129, 115131, 78337, 783337, 2%, 0%, 62%Additional References
Related Documents
Related Topic Document TitleCisco IOS commands
SNMP commands
SNMP configuration tasks
"Configuring SNMP Support" module in the Cisco IOS Network Management Configuration Guide
MIBs
RFCs
Technical Assistance
Feature Information for Periodic MIB Data Collection and Transfer Mechanism
Use Cisco Feature Navigator to find information about platform support and software image support. Cisco Feature Navigator enables you to determine which software images support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note
Table 1 lists only the software release that introduced support for a given feature in a given software release train. Unless noted otherwise, subsequent releases of that software release train also support that feature.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership relationship between Cisco and any other company. (1005R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.
© 2003-2010 Cisco Systems, Inc. All rights reserved.
Feedback