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

NBAR2 Custom Protocol

NBAR2 Custom Protocol

Last Updated: April 4, 2013

The NBAR2 Custom Protocol feature lets you create attribute profiles and attach these attribute profiles to protocols. This module provides an overview of the NBAR2 Custom Protocol feature and explains how to configure attribute profiles for custom protocols.

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 NBAR2 Custom Protocol

Protocol pack licensing must be enabled to configure custom protocols.

Information About NBAR2 Custom Protocol

Overview of NBAR2 Custom Protocol

Network-Based Application Recognition (NBAR) supports the use of custom protocols to identify custom applications. Custom protocols support static port-based protocols and applications that NBAR does not support.

The NBAR2 Custom Protocol feature lets you create attribute profiles for a custom protocol using the ip nbar attribute-map command. You can attach this profile to a protocol by using the ip nbar attribute-set command. An attribute profile can be modified even after you attach the profile to a protocol.

You can modify (add, edit, delete) individual attributes that have already been configured. This modification does not alter the profile-protocol mapping.


Note


You can also delete an attribute profile. When deleted, the profile gets detached from all the protocols to which it was attached, and those protocols start using the default attribute set.

How to Configure NBAR2 Custom Protocol

Creating and Configuring an Attribute Profile

SUMMARY STEPS

1.    enable

2.    configure terminal

3.    ip nbar attribute-map profile-name

4.    attribute attribute-name attribute-value

5.    attribute attribute-name attribute-value

6.    end


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 attribute-map profile-name


Example:

Device(config)# ip nbar attribute-map test-name

 

Creates an attribute profile with the name that you specify, and enters the attribute-map configuration mode.

  • Use the profile-name argument to specify the name of the attribute profile that you want to create.
 
Step 4
attribute attribute-name attribute-value


Example:

Device(config-attribute-map)# attribute application-group aol-group

 

Adds attribute values from the application-group attribute, on to your profile.

 
Step 5
attribute attribute-name attribute-value


Example:

Device(config-attribute-map)# attribute category browsing

 

Adds attribute values from the category attribute, on to your profile.

Note    Repeat Steps 4 and 5 to continue adding as many attributes to your profile as required.
 
Step 6
end


Example:

Device(config-attribute-map)# end

 

Returns to privileged EXEC mode.

 

Attaching an Attribute Profile to a Protocol

Before You Begin

Note


Before attaching an attribute profile to a custom protocol, complete the following tasks:
  • Create the attribute profile by using the ip nbar attribute-map command.
  • Configure the attributes for the profile by using the attribute attribute-name attribute-value command.


SUMMARY STEPS

1.    enable

2.    configure terminal

3.    ip nbar attribute-set protocol-name profile-name

4.    end


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 attribute-set protocol-name profile-name


Example:

Device(config)# ip nbar attribute-set acp test-name

 

Attaches an attribute profile to a protocol.

  • Use the profile-name argument to specify the name of the attribute profile that you want to attach to the protocol.
 
Step 4
end


Example:

Device(config)# end

 

Returns to privileged EXEC mode.

 

Configuration Examples for NBAR2 Custom Protocol

Example: Creating a Profile and Configuring Attributes for the Profile

The following example shows how to create an attribute profile with attributes configured for the Network News Transfer Protocol (NNTP) protocol:

Device> enable
Device# configure terminal
Device(config)# ip nbar attribute-map nntp-attrib
Device(config-attribute-map)# attribute category newsgroup
Device(config-attribute-map)# attribute application-group nntp-group
Device(config-attribute-map)# attribute tunnel tunnel-no
Device(config-attribute-map)# attribute encrypted encrypted-yes
Device(config-attribute-map)# attribute p2p-technology p2p-tech-no
Device(config-attribute-map)# end

The following example shows how to verify the above configuration:

Device> enable
Device# show ip nbar attribute-map nntp-attrib
Device# Profile Name :  nntp-attrib
            category :  newsgroup
   application-group :  nntp-group
           encrypted :  encrypted-yes
Device# end

Example: Attaching an Attribute Profile to a Protocol

The following example shows how to set an attribute profile to the Application Communication Protocol (ACP) protocol:

Device> enable
Device# configure terminal
Device(config)# ip nbar attribute-set acp test-profile
Device(config)# exit

Additional References for NBAR2 Custom Protocol

Related Documents

Related Topic

Document Title

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

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 NBAR2 Custom Protocol

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 NBAR2 Custom Protocol

Feature Name

Releases

Feature Information

NBAR2 Custom Protocol

Cisco IOS XE Release 3.8S

The NBAR2 Custom Protocol feature configures attribute profiles for protocols, and maps profiles to protocols.

The following commands were introduced or modified:

attribute , ip nbar attribute-map, ip nbar attribute-set.

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.

© 2012-2013 Cisco Systems, Inc. All rights reserved.