The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
The Periodic MIB Data Collection and Transfer Mechanism feature provides the ability to periodically transfer selected MIB data from Cisco IOS XE-based devices to specified Network Management Stations (NMS). Using the command-line interface (CLI), data from multiple MIBs can be grouped into lists, and a polling interval (frequency of data collection) can be configured. All the MIB objects in a list are periodically polled using this specified interval. The collected data from the lists can then be transferred to a specified NMS at a user-specified transfer interval (frequency of data transfer) using TFTP, rcp, or FTP.
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 IOS XE software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
•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
•Feature Information 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.
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.
To configure the Periodic MIB Data Collection and Transfer Mechanism, you must understand the following concepts:
•Bulk Statistics Transfer Options
•Benefits of the Periodic MIB Data Collection and Transfer Mechanism
Note The Periodic MIB Data Collection and Transfer Mechanism is also referred to as the Bulk Statistics feature.
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).
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 Fast Ethernet MIB object in the same schema, because the containing tables for both objects are indexed by the ifIndex.
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.
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.
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.
This section contains the following procedures:
•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)
The first step in configuring the Periodic MIB Data Collection and Transfer Mechanism is to configure one or more object lists.
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.
1. enable
2. configure terminal
3. snmp mib bulkstat object-list list-name
4. add {oid | object-name}
5. exit
The next step in configuring the Periodic MIB Data Collection and Transfer Mechanism is to configure one or more schemas.
The bulk statistics object list to be used in the schema must be defined.
Only one object list can be associated with a schema at a time.
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
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.
The bulk statistics object lists and bulk statistics schemas should be defined before configuring the bulk statistics transfer options.
Transfers can only be performed using schemaASCII (cdcSchemaASCII) format. SchemaASCII is an ASCII format that contains parser-friendly hints for parsing data values.
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
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.
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).
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. exit
6. copy running-config startup-config
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.
1. show snmp mib bulkstat transfer [transfer-name]
2. debug snmp bulkstat
This section provides the following configuration example:
•Configuring Periodic MIB Data Collection and Transfer Mechanism: Example
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
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.)
The following polling requirements for ATM interface 2/0 and Fast 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
Fast 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)
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 Fast 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 ifmib
add ifInoctets
add ifOutoctets
add ifInUcastPkts
add ifInDiscards
exit
snmp mib bulkstat object-list CAR-mib
add CcarStatSwitchedPkts
add CcarStatSwitchedBytes
add CcarStatFilteredBytes
exit
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 schema
snmp mib bulkstat schema ATM2/0-IFMIB
! The following command points to the IF-MIB object list, defined above.
object-list ifmib
poll-interval 5
instance exact interface ATM2/0 subif
exit
! ATM CAR-MIB schema
snmp mib bulkstat schema-def ATM2/0-CAR
object-list CAR-mib
poll-interval 5
instance wildcard interface ATM2/0 subif
exit
!FastEthernet IF-MIB schema
snmp mib bulkstat schema FastEthernet2/1-IFMIB
object-list ifmib
poll-interval 5
instance exact interface FastEthernet2/1
exit
! FastEthernet CAR-MIB schema
snmp mib bulkstat schema FastEthernet2/1-CAR
object-list CAR-mib
poll-interval 5
! Note: ifindex of FastEthernet2/1 is 3
instance wildcard oid 3.1
exit
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 bulkstat1
schema ATM2/0-IFMIB
schema ATM2/0-CAR
schema FastEthernet2/1-IFMIB
schema FastEthernet2/1-CAR
url primary ftp://username1:pswrd@cbin2-host/users/username1/bulkstat1
url secondary tftp://username1@10.1.0.1/tftpboot/username1/bulkstat1
format schemaASCII
transfer-interval 30
retry 5
buffer-size 1024
retain 30
end
copy running-config startup-config
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 transfer
Transfer Name : bulkstat1
Primary URL ftp://user:XXXXXXXX@192.168.200.162/
Secondary ftp://user:XXXXXXXX@192.168.200.163/
Retained files
File Name : Time Left (in seconds) : STATE
----------------------------------------------------------------------
bulkstat1_Router_030307_102519739: 1196 :Retry(4 Retry attempt(s) Left)
bulkstat1_Router_030307_102219739: 1016 :Retained
bulkstat1_Router_030307_101919739: 836 :Retained
The 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.
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 Fast 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 ifInDiscards
Schema-def ATM2/0-CAR "%u, %s, %s, %u, %u, %u, %u "
epochtime ifDescr instanceoid CcarStatSwitchedPkts ccarStatSwitchedBytes CcarStatSwitchedPkts ccarStatSwitchedBytes
Schema-def FastEthernet2/1-IFMIB "%u, %u, %u, %u, %u, %u"
epochtime ifDescr instanceoid ifInOctets ifOutOctets ifInUcastPkts ifInDiscards
Schema-def FastEthernet2/1-CAR "%u, %s, %u, %u, %u, %u "
Epochtime instanceoid CcarStatSwitchedPkts ccarStatSwitchedBytes CcarStatSwitchedPkts ccarStatSwitchedBytes
Schema-def GLOBAL "%s, %s, %s, %u, %u, %u, %u"
hostname data timeofday sysuptime cpu5min cpu1min cpu5sec
ATM2/0-IFMIB: 954417080, ATM2/0, 2, 95678, 23456, 234, 3456
ATM2/0-IFMIB: 954417080, ATM2/0.1, 8, 95458, 54356, 245, 454
ATM2/0-IFMIB: 954417080, ATM2/0.2, 9, 45678, 8756, 934, 36756
ATM2/0-CAR: 954417083, ATM2/0, 2.1.1, 234, 345, 123, 124
ATM2/0-CAR: 954417083, ATM2/0, 2.2.1, 452, 67, 132, 145
ATM2/0-CAR: 954417083, ATM2/0.1, 8.1.1, 224, 765, 324 234
ATM2/0-CAR: 954417083, ATM2/0.1, 8.2.1, 234, 345, 123, 124
ATM2/0-CAR: 954417083, ATM2/0.2, 9.1.1, 234, 345, 123, 124
ATM2/0-CAR: 954417083, ATM2/0.2, 9.2.1, 452, 67, 132, 145
FastEthernet2/1-IFMIB: 954417090, FastEthernet2/1, 3, 45678, 8756, 934, 36756
FastEthernet2/1-CAR: 954417093, 3.1.1, 234, 345, 123, 124
FastEthernet2/1-CAR: 954417093, 3.1.2, 134, 475, 155, 187
ATM2/0-IFMIB: 954417100, ATM2/0, 2, 95678, 23456, 234, 3456
ATM2/0-IFMIB: 954417101, ATM2/0.1, 8, 95458, 54356, 245, 454
ATM2/0-IFMIB: 954417102, ATM2/0.2, 9, 45678, 8756, 934, 36756
ATM2/0-CAR: 954417106, ATM2/0, 2.1.1, 234, 345, 123, 124
ATM2/0-CAR: 954417107, ATM2/0, 2.2.1, 452, 67, 132, 145
ATM2/0-CAR: 954417107, ATM2/0.1, 8.1.1, 224, 765, 324 234
ATM2/0-CAR: 954417108, ATM2/0.1, 8.2.1, 234, 345, 123, 124
ATM2/0-CAR: 954417113, ATM2/0.2, 9.1.1, 234, 345, 123, 124
ATM2/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 FastEthernet2/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 ifInDiscards
ifOutDiscards
! The following data sample reflects the change in the configuration.
FastEthernet2/1-IFMIB: 954417090, FastEthernet2/1, 3, 45678, 8756, 934, 36756, 123
FastEthernet2/1-CAR: 954417093, 3.1.1, 234, 345, 123, 124
FastEthernet2/1-CAR: 954417093, 3.1.2, 134, 475, 155, 187
GLOBAL: Govinda, 20020129, 115131, 78337, 783337, 2%, 0%, 62%
The following sections provide references related to the Periodic MIB Data Collection and Transfer Mechanism.
|
|
---|---|
SNMP configuration tasks |
"Configuring SNMP Support" module in the Cisco IOS XE Network Management Configuration Guide |
SNMP commands: complete command syntax, command mode, command history, defaults, usage guidelines, and examples |
•Cisco IOS Network Management Command Reference |
|
|
---|---|
None |
— |
Table 1 lists the release history for this feature.
Use Cisco Feature Navigator to find information about platform support and software image support. Cisco Feature Navigator enables you to determine which Cisco IOS XE 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 Cisco IOS XE software release that introduced support for a given feature in a given Cisco IOS XE software release train. Unless noted otherwise, subsequent releases of that Cisco IOS XE software release train also support that feature.