Cisco IOS XR Session Border Controller Configuration Guide Release 3.6 - Configuring SIP Method Profiles [Cisco IOS XR Software (End-of-Sale)]

Table Of Contents

Configuring SIP Method Profiles

Contents

Restrictions for Configuring Method Profiles

Information About Method Profiles

How to Configure Method Profiles

Configuring Method Profiles

Applying Method Profiles

Examples of Method Profiles

Example of Configuring Method Profiles

Example of Applying Method Profiles

Additional References

Related Documents

Standards

MIBs

RFCs

Technical Assistance

Configuring SIP Method Profiles

You can configure the SBC with method whitelist and blacklist profiles on Session Initiation Protocol (SIP) messages. These profiles are used to control which SIP requests are accepted (whitelists) and which requests are rejected (blacklists) based on the method of the request. This feature helps to avoid misusing the SBE or SIP adjacency by SIP users and improves the efficiency of SIP calls.

Feature History for Method Profiles

Release

Modification

Release 3.4.1

This feature was introduced on the Cisco XR 12000 Series Router.

Release 3.5.0

No modification.

Release 3.6.0

No modification.

Contents

This module contains the following sections:

•Restrictions for Configuring Method Profiles

•Information About Method Profiles

•How to Configure Method Profiles

•Examples of Method Profiles

•Additional References

Restrictions for Configuring Method Profiles

Review the following restrictions for method profiles:

•Any given profile must be exclusively a whitelist or a blacklist. It cannot contain elements of both.

•Two profiles are applied to process any given SIP message: one inbound and, if permitted through that, one outbound.

•Profiles check only SIP methods in the Request URI.

•SIP requests are rejected as a result of a method profile's rules. SIP responses are always forwarded.

•Any method unknown to the SBC which is forwarded as a result of a profile's rules does not affect creating or deleting a SIP dialog.

•Methods that are essential to the operation of an SBC cannot be blacklisted and are implicitly added to any whitelist.

•Profiles cannot be deleted while they are in active use by at least one adjacency.

Information About Method Profiles

After you configure a profile, you can assign it for a default application. Any SIP adjacency can apply it to signaling for that adjacency.

You can add or remove methods from profiles at any time.

Profiles cannot be deleted while a least one adjacency is using them. You can see which adjacencies are using a profile by entering the following show command:
show services sbc <sbc-name> sbe sip method-profile <name>
Table 2 lists the methods that are part of the essential method set.

Table 2 Essential Methods

INVITE

OPTIONS

ACK

PRACK

CANCEL

UPDATE

BYE

NOTIFY

REGISTER

REFER

INFO

SUBSCRIBE

Profiles are an optional part of the configuration; they do not have to be specified for the SBC to operate correctly. The default behavior is that requests with one of the essential methods are processed, and all other requests are rejected.

How to Configure Method Profiles

You first configure the method profiles and then apply them as explained in the following sections:

•Configuring Method Profiles

•Applying Method Profiles

Configuring Method Profiles

SUMMARY STEPS

1. configure

2. sbc service-name sbe sip

3. method-profile profile-name

4. blacklist

5. pass-body

6. method name

7. description text

8. commit

9. exit

10. show services sbc service-name sbe sip-method-profile profile name

11. show services sbc service-name sbe sip method-profiles

12. show services sbc sbc-name sbe sip essential-methods

DETAILED STEPS

Command or Action

Purpose

Step 1

configure
Example:

RP/0/0/CPU0:router# configure

Enables global configuration mode.

Step 2

sbc service-name sbe sip
Example:

RP/0/0/CPU0:router(config)# sbc mysbc sbe sip

Enters the submode for configuring the method profile.

Use the service-name argument to define the name of the service.

Step 3

method-profile profile-name
Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip)# method-profile profile1

Configures a method profile.

If you enter the name default, the default profile is configured. This profile is used for all adjacencies which do not have a specific profile configured.

Step 4

blacklist
Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-mth-prf)# blacklist

Configures a profile to be a blacklist. The "no" version of this command configures the profile to be a whitelist.

Note By default, profiles are whitelists.

Step 5

pass-body
Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-mth-prf)# pass-body

Permits message bodies to be passed through for non-vital methods accepted by this profile.

The no form of this command strips the message body out of any non-vital SIP messages matched by this profile.

Step 6

method name
Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-mth-prf)# method test

Adds a method with the specified name to the profile.

This field can be 1 to 32 characters (inclusive) in length and is case-insensitive.

The no version of this command deletes the method with that name from the profile.

Step 7

description text
Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-mth-prf)# description my SBC profile

Adds a description for the specified profile.

The no form of this command removes the description.

This description is displayed when the show command is used for this profile and is displayed for each profile when displaying a summary of all profiles.

Step 8

commit
Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-mth-prf)# commit

Saves configuration changes. Use the commit command to save the configuration changes to the running configuration file and remain within the configuration session.

Step 9

exit
Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-mth-prf)# exit

Exits the method profile mode to the sbe mode.

Step 10

show services sbc sbc-name sbe sip-method-profile name
Example:

RP/0/0/CPU0:router(config-sbc-sbe)# show services sbc mysbc sbe sip method-profile profile1

Displays details for the method profile with the designated name.

Use name default to view the default profile.

Step 11

show services sbc sbc-name sbe sip method-profiles
Example:

RP/0/0/CPU0:router(config-sbc-sbe)# show services sbc mysbc sbe sip method-profiles

Displays a list of all configured method profiles.

Step 12

show services sbc sbc-name sbe sip essential-methods
Example:

RP/0/0/CPU0:router(config-sbc-sbe)# show services sbc mysbc sbe sip essential-methods

Displays a list of the essential methods listed in Table 2.

Applying Method Profiles

SUMMARY STEPS

1. configure

2. sbc service-name

3. sbe

4. adjacency sip adjacency-name

5. method-profile inbound profile-name

6. commit

7. exit

8. show services sbc sbc-name sbe sip method-profile name

DETAILED STEPS

Command or Action

Purpose

Step 1

configure
Example:

RP/0/0/CPU0:router# configure

Enables global configuration mode.

Step 2

sbc service-name
Example:

RP/0/0/CPU0:router(config)# sbc mysbc

Enters the mode of an SBC service.

Use the service-name argument to define the name of the service.

Step 3

sbe
Example:

RP/0/0/CPU0:router(config-sbc)# sbe

Enters the mode of an SBE entity within an SBC service.

Step 4

adjacency sip adjacency-name
Example:

RP/0/0/CPU0:router(config-sbc-sbe)# adjacency sip test

Enters the mode of an SBE SIP adjacency.

Use the adjacency-name argument to define the name of the service.

Step 5

method-profile inbound profile-name
Example:

RP/0/0/CPU0:router(config-sbc-sbe-adj-sip)# method-profile inbound profile1

Sets profile1 to be used for inbound signaling on adjacency test.

Step 6

commit
Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-adj-sip)# commit

Saves configuration changes. Use the commit command to save the configuration changes to the running configuration file and remain within the configuration session.

Step 7

exit
Example:

RP/0/0/CPU0:router(config-sbc-sbe-sip-adj-sip)# exit

Exits the header profile mode to the sbe mode.

Step 8

show services sbc sbc-name sbe sip method-profile name
Example:

RP/0/0/CPU0:router(config-sbc-sbe)# show

Displays the header profile information.

Examples of Method Profiles

This section provides a sample configuration and output for method profiles.

Example of Configuring Method Profiles

The following example shows the commands and output generated when you configure method profiles.
RP/0/0/CPU0:node3#conf terminal
RP/0/0/CPU0:node3(config)#sbc umsbc-node3 sbe
RP/0/0/CPU0:node3(config-sbc-sbe)# sip method-profile test1
RP/0/0/CPU0:node3(config-sbc-sbe-sip-mth)#method abcd
RP/0/0/CPU0:node3(config-sbc-sbe-sip-mth)#blacklist
RP/0/0/CPU0:node3(config-sbc-sbe-sip-mth)#commit
RP/0/0/CPU0:Nov 13 17:43:11.124 : config[65761]: %MGBL-CONFIG-6-DB_COMMIT : Configuration 
committed by user 'yunsun'. Use 'show configuration commit changes 1000000296' to view the 
changes. 
RP/0/0/CPU0:node3(config-sbc-sbe-sip-mth)#end
RP/0/0/CPU0:Nov 13 17:43:14.866 : config[65761]: %MGBL-SYS-5-CONFIG_I : Configured from 
console by yunsun 
RP/0/0/CPU0:node3#sh services sbc umsbc-node3 sbe sip method-profiles
Method profiles for SBC service "umsbc-node3"
  Name                          In use
  ====================================
  test1                          No
  default                        Yes
RP/0/0/CPU0:node3#sh services sbc umsbc-node3 sbe sip method-profile test1
  Method profile "test1"
    Type:    Blacklist
    Methods:
      abcd
    In use by:
       Not in use with any adjacencies
Example of Applying Method Profiles

The following example shows the commands and output generated when you are applying a method profile to an SBC.
RP/0/0/CPU0:node3#conf terminal
RP/0/0/CPU0:node3(config)#sbc umsbc-node3 sbe
RP/0/0/CPU0:node3(config-sbc-sbe)#adjacency sip sipp-10
RP/0/0/CPU0:node3(config-sbc-sbe-adj-sip)#method-profile inbound test1
RP/0/0/CPU0:node3(config-sbc-sbe-adj-sip)#commit                      
RP/0/0/CPU0:Nov 13 17:44:28.609 : config[65761]: %MGBL-CONFIG-6-DB_COMMIT : Configuration 
committed by user 'yunsun'. Use 'show configuration commit changes 1000000297' to view the 
changes. 
RP/0/0/CPU0:node3(config-sbc-sbe-adj-sip)#end
RP/0/0/CPU0:Nov 13 17:44:31.637 : config[65761]: %MGBL-SYS-5-CONFIG_I : Configured from 
console by yunsun 
RP/0/0/CPU0:node3#sh services sbc umsbc-node3 sbe sip method-profiles
Method profiles for SBC service "umsbc-node3"
  Name                          In use
  ====================================
  test1                          Yes
  testb                          No
RP/0/0/CPU0:node3#sh services sbc umsbc-node3 sbe sip method-profile test1
  Method profile "test1"
    Type:    Blacklist
    Methods:
      abcd
    In use by:
       Adjacency: sipp-10 (in)
Additional References

The following sections provide references related to configuring method profiles.

Related Documents

Related Topic

Document Title

Cisco IOS XR master command reference

Cisco IOS XR Master Commands List

Cisco IOS XR SBC interface configuration commands

Cisco IOS XR Session Border Controller Command Reference

Initial system bootup and configuration information for a router using the Cisco IOS XR Software

Cisco IOS XR Getting Started Guide

Cisco IOS XR command modes

Cisco IOS XR Command Mode Reference

Standards

Standards

Title

No new or modified standards are supported by this feature, and support from existing standards has not been modified by this feature.

—

MIBs

MIBs

MIBs Link

—

To locate and download MIBs using Cisco IOS XR software, use the Cisco MIB Locator found at the following URL and choose a platform under the Cisco Access Products menu:

http://cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml

RFCs

RFCs

Title

RFC 2833

RTP Payload for DTMF Digits, Telephony Tones and Telephony Signals

RFC 3261

SIP: Session Initiation Protocol

Technical Assistance

Description

Link

The Cisco Technical Support website contains thousands of pages of searchable technical content, including links to products, technologies, solutions, technical tips, and tools. Registered Cisco.com users can log in from this page to access even more content.

http://www.cisco.com/techsupport