QoS: NBAR Configuration Guide, Cisco IOS XE Release 3S (Cisco ASR 1000)
NBAR Protocol Pack
Downloads: This chapterpdf (PDF - 120.0KB) The complete bookPDF (PDF - 568.0KB) | Feedback

NBAR Protocol Pack

NBAR Protocol Pack

Last Updated: April 4, 2013

The NBAR Protocol Pack feature provides an easy way to load a protocol pack that allows you to update Network-Based Application Recognition (NBAR) protocol support on a device without having to replace the Cisco software on the device.

An NBAR protocol pack contains a set of signatures that is supported by NBAR.

Finding Feature Information

Your software release may not support all the features documented in this module. For the latest caveats and feature information, see Bug Search Tool and 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 table at the end of this module.

Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required.

Prerequisites for the NBAR Protocol Pack

The protocol pack must be copied to your local disk to avoid any errors after rebooting.


Note


It is strongly recommended to load the NBAR protocol pack that is the exact match for the NBAR engine and also load the latest rebuild of Cisco software.

Restrictions for the NBAR Protocol Pack

Only one protocol pack is supported per device.

Information About the NBAR Protocol Pack

Protocol Pack Overview

NBAR protocol packs are software packages that update the NBAR protocol support on a device without replacing the Cisco software on the device. An NBAR protocol pack contains a set of signatures that is supported by NBAR.

Protocol packs provide the following features:

  • They are easy to load.
  • They are easy to upgrade or downgrade.
  • They provide only the required set of protocols.

NBAR protocol packs are released for specific engine versions. For example, Cisco IOS XE Release 3.7S software has NBAR engine version 13. Therefore, the protocol packs for Cisco IOS XE Release 3.7S software are created for the NBAR engine version 13. An NBAR protocol pack can be installed on a device if the NBAR engine version on the platform is same or later than the version required by the NBAR protocol pack. For example, NBAR Protocol Pack 3.0.0 for Cisco IOS XE Release 3.7S software can be installed on Cisco IOS XE Release 3.7S and Cisco IOS XE Release 3.8S software, but NBAR Protocol Pack 3.0.0 for Cisco IOS XE Release 3.8S software cannot be installed on Cisco IOS XE Release 3.7S software.

NBAR protocol packs are of two types: advanced protocol pack and standard protocol pack.

The advanced protocol pack is available as the default protocol pack in the DATA image. The advanced protocol pack is available only with Application Visibility and Control (AVC) license. The advanced protocol packs are released periodically as NBAR2 Protocol Packs. With the AVC license and on an advanced protocol pack, only a protocol pack with the NAME field as Advanced Protocol Pack can be installed.

A standard protocol pack is available as the default protocol pack in the IP Base image. The standard protocol pack has limited features and functionality because of the license infrastructure and contains only a subset of protocols. The standard protocol packs are released along with Cisco software. On a standard protocol pack, only a protocol pack with the NAME field as Standard Protocol Pack can be installed

Cisco provides a specific identity number for an organization (also known as the "publisher") that creates the protocol packs and uses Cisco tools and processes to create new protocol packs. The organization that creates the protocol pack owns the pack.

To view the list of protocols supported in a protocol pack, see NBAR Protocol Library.

How to Load the NBAR Protocol Pack

Loading the NBAR Protocol Pack

SUMMARY STEPS

1.    enable

2.    configure terminal

3.    ip nbar protocol-pack protocol-pack [force]

4.    exit

5.    show ip nbar protocol-pack {protocol-pack | active} [detail]


DETAILED STEPS
  Command or Action Purpose
Step 1
enable


Example:

Device> enable

 

Enables privileged EXEC mode.

  • Enter your password if prompted.
 
Step 2
configure terminal


Example:

Device# configure terminal

 

Enters global configuration mode.

 
Step 3
ip nbar protocol-pack protocol-pack [force]


Example:

Device(config)# ip nbar protocol-pack harddisk:defProtoPack

 

Loads a protocol pack.

  • Use the force keyword to specify and load a protocol pack of a lower version, which is different from the base protocol pack version.
 
Step 4
exit


Example:

Device(config)# exit

 

Exits global configuration mode and returns to privileged EXEC mode.

 
Step 5
show ip nbar protocol-pack {protocol-pack | active} [detail]


Example:

Device# show ip nbar protocol-pack active

 

(Optional) Displays protocol pack information.

  • Verify the loaded protocol pack version, publisher, and other details using this command.
  • Use the protocol-pack argument to display information about a specified protocol pack.
  • Use the active keyword to display active protocol pack information.
  • Use the detail keyword to display detailed protocol pack information.
 

Configuration Examples for the NBAR Protocol Pack

Example: Loading the NBAR Protocol Pack

The following example shows how to load an NBAR protocol pack named defProtoPack from the harddisk:

Device> enable
Device# configure terminal
Device(config)# ip nbar protocol-pack harddisk:defProtoPack
Device(config)# exit

The following example shows how to revert to the base image version of NBAR protocol pack:

Device> enable
Device# configure terminal
Device(config)# default ip nbar protocol-pack
Device(config)# exit

The following example shows how to load a protocol pack of a lower version using the force keyword:

Device> enable
Device# configure terminal
Device(config)# ip nbar protocol-pack harddisk:olddefProtoPack force
Device(config)# exit

Example: Verifying the Loaded NBAR Protocol Pack

The following sample output from the show ip nbar protocol-pack active command shows information about the protocol pack that is provided by default with a licensed Cisco image:

Router# show ip nbar protocol-pack active

ACTIVE protocol pack: 
Name:                            Advanced Protocol Pack
Version:                         1.0
Publisher:                       Cisco Systems Inc.
NBAR Engine Version:             14

The following sample output from the show ip nbar protocol-pack active detail command shows detailed information about the protocol pack that is provided by default with a licensed Cisco image:

Router# show ip nbar protocol-pack active detail

ACTIVE protocol pack: 
Name:                            Advanced Protocol Pack
Version:                         1.0
Publisher:                       Cisco Systems Inc.
NBAR Engine Version:             14
Protocols:
base                             Mv: 4
ftp                              Mv: 5
http                             Mv: 18
static                           Mv: 6
socks                            Mv: 2
nntp                             Mv: 2
tftp                             Mv: 2
exchange                         Mv: 3
vdolive                          Mv: 1
sqlnet                           Mv: 2
netshow                          Mv: 3
sunrpc                           Mv: 3
streamwork                       Mv: 2
citrix                           Mv: 11
fasttrack                        Mv: 3
gnutella                         Mv: 7
kazaa2                           Mv: 11

The following sample output from the show ip nbar protocol-pack command shows the protocol pack information of an advanced protocol pack that is present in the specified device location:

Router# show ip nbar protocol-pack disk:0ppsmall_higherversion

Name:                            Advanced Protocol Pack
Version:                         2.0
Publisher:                       Cisco Systems Inc.
NBAR Engine Version:             13
Creation time:                   Mon Jul 16 09:29:34 UTC 2012

The following sample output from the show ip nbar protocol-pack command shows detailed protocol pack information present in the specified disk location:

Router# show ip nbar protocol-pack disk:0ppsmall_higherversion detail

Name:                            Advanced Protocol Pack
Version:                         2.0
Publisher:                       Cisco Systems Inc.
NBAR Engine Version:             13
Creation time:                   Mon Jul 16 09:29:34 UTC 2012
Protocol Pack contents:
iana                     Mv: 1
base                     Mv: 4
tftp                     Mv: 2

Additional References for NBAR Protocol Pack

Related Documents

Related Topic

Document Title

Application Visibility and Control

Cisco IOS Application Visibility and Control Configuration Guide

Cisco IOS commands

Cisco IOS Master Command List, All Releases

Cisco IOS LAN Switching commands

Cisco IOS LAN Switching Command Reference

Cisco IOS QoS configuration information

Cisco IOS QoS Configuration Guide

Technical Assistance

Description

Link

The Cisco Support and Documentation website provides online resources to download documentation, software, and tools. Use these resources to install and configure the software and to troubleshoot and resolve technical issues with Cisco products and technologies. Access to most tools on the Cisco Support and Documentation website requires a Cisco.com user ID and password.

http://www.cisco.com/cisco/web/support/index.html

Feature Information for NBAR Protocol Pack

The following table provides release information about the feature or features described in this module. This table 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.

Use Cisco Feature Navigator to find information about platform support and Cisco software image support. To access Cisco Feature Navigator, go to www.cisco.com/go/cfn. An account on Cisco.com is not required.

Table 1 Feature Information for NBAR Protocol Pack

Feature Name

Releases

Feature Information

NBAR Protocol Pack

Cisco IOS XE Release 3.3S

This feature was introduced on Cisco ASR 1000 Series Aggregation Services Routers.

NBAR protocol packs are software packages that update the NBAR protocol support on a device without the need to replace the Cisco software.

The following commands were introduced or modified: default ip nbar protocol-pack, ip nbar protocol-pack, and show ip nbar protocol pack.

Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: 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. (1110R)

Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual addresses and phone numbers. Any examples, command display output, network topology diagrams, and other figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses or phone numbers in illustrative content is unintentional and coincidental.

© 2013 Cisco Systems, Inc. All rights reserved.