Table Of Contents
SIP Profiles Feature Module
Feature Description
Profile Enhancements
Security Enhancements
Property Enhancements
Benefits
Prerequisites
Restrictions or Limitations
Related Features and Technology
Related Documents
Upgrading to Support This Feature
Implementing SIP Profiles
Creating Profiles
SIP Profiles
EISUP Profiles
Common Profiles
Domain Profiles
Applying Multiple Profiles
Topology Hiding
B2BUA Modes
SIP Header Tables
SIP Headers That Support Customized Treatment
Implementing Inbound SIP Header Tables
Implementing Outbound SIP Header Tables
Applying Multiple SIP Headers
Provisioning Tasks
Provisioning SIP and EISUP Profiles
Adding a SIP or EISUP Profile
Cloning a SIP or EISUP Profile
Retrieving a SIP or EISUP Profile
Modifying a SIP or EISUP Profile
Adding a Common Profile, a Grprofile, or an ISUP Timer Profile Reference to a SIP Profile
Removing a Property from a SIP or EISUP Profile
Deleting a SIP or EISUP Profile
Provisioning Common Profiles
Adding a Common Profile
Cloning a Common Profile
Retrieving a Common Profile
Modifying a Common Profile
Removing a Property from a Common Profile
Deleting a Common Profile
Provisioning Domain Profiles
Adding a Domain Profile
Cloning a Domain Profile
Retrieving a Domain Profile
Modifying a Domain Profile
Adding a Common Profile or Grprofile Reference to a Domain Profile
Removing a Property from a Domain Profile
Deleting a Domain Profile
Managing the Domain Table
Adding a New Domain Name
Editing Domain Properties
Modifying the Domain Profile Assigned to a Domain
Retrieving Domain Names
Deleting a Domain Name
Assigning Profiles to Trunk Groups
Adding a Profile to a Trunk Group
Modifying the Profile Assigned to a Trunk Group
Removing a Trunk Group from a Profile
Provisioning SIP Header Tables
Adding an Inbound SIP Header Table Entry
Adding an Outbound SIP Header Table Entry
Adding a SIP Header Table to a Profile
Modifying a SIP Header Table Entry
Retrieving a SIP Header Table
Retrieving a SIP Header Table Entry
Reordering a SIP Header Table
Deleting an Entry from a SIP Header Table
Deleting a SIP Header Table
Provisioning Examples
Software Changes for This Feature
MML Command Reference
New MML Commands
PROV-ADD:INSIPHEADER (Release 9.8(1))
PROV-ADD:OUTSIPHEADER (Release 9.8(1))
PROV-ADD:DOMAINPROF (Release 9.8(1))
Modified MML Commands
PROV-ADD:PROFILE (Release 9.8(1))
Billing Interface
New Call Data Records
Modified Call Data Records
Properties
Provisioning Worksheets
Obtaining Documentation and Submitting a Service Request
Glossary
SIP Profiles Feature Module
Document Release History
Publication Date
|
Comments
|
December 2009
|
Updated the "SIP Header Tables" section.
|
February 2009
|
Updated for the ISUP timer profile reference in a SIP profile.
|
November 2008
|
Initial release of document.
|
Feature History
Release
|
Modification
|
9.8(1)
|
Added support for the ISUP timer profile reference in a SIP profile.
|
9.8(1)
|
The SIP Profiles feature was introduced on the Cisco PGW 2200 Softswitch software.
|
This document describes the SIP Profiles feature for the Cisco PGW 2200 Softswitch. The feature is described in the following sections:
•
Feature Description
•Upgrading to Support This Feature
•Provisioning Tasks
•Provisioning Examples
•MML Command Reference
•Billing Interface
•Glossary
Feature Description
This feature introduces new service profiles for SIP, EISUP, and other protocols. Service profiles improve provisioning and security for the Cisco PGW 2200 Softswitch by allowing you to create a customized set of call properties and assign it to a call trunk group.
Profile Enhancements
Prior to the introduction of this feature, the Cisco PGW 2200 Softswitch supported two profile types: grprofiles (for SS7 and SIP trunk groups) and isuptmrprofiles (for SS7 sigpaths). This feature includes four new profile types:
•SIP profiles—Profiles for SIP trunk groups.
•EISUP profiles—Profiles for EISUP trunk groups.
•Domain profiles—Profiles based upon a domain name. Domain profiles are for SIP interfaces only.
•Common profiles—A general profile type that can handle SIP and EISUP trunk groups as well as properties from other protocols. SIP and EISUP profiles can contain references to a common profile.
Security Enhancements
SIP profiles introduce improved security features including topology hiding, back-to-back user agent (B2BUA), and customizable SIP header treatment. These features provide improved security by obscuring or removing call topology information and by allowing you to customize how the Cisco PGW 2200 Softswitch processes certain SIP headers. You can combine these features with the new profile types to create unique security settings for each service profile.
Property Enhancements
This feature replaces all existing SIP and EISUP trunk group properties with equivalent SIP and EISUP profile properties. After migrating to Release 9.8(1), you can no longer use trunk group properties. For more information about migrating to Release 9.8(1), see "Upgrading to Support This Feature" section.
Note This feature does not affect sigpath properties.
Benefits
With this feature, you can
•Create service profiles with custom provisioning and security settings
•Apply profiles based on trunk group or domain name
•Create separate profiles for inbound and outbound traffic
•Define the a unique level of B2BUA support for each profile
•Hide the topology of core and access networks by erasing Via: and Record-Route: headers from outbound SIP messages
•Create customized SIP header treatment
Prerequisites
The Cisco PGW 2200 Softswitch must be running Cisco PGW 2200 Softswitch Software Release 9.8(1). Prerequisites for this release can be found in the Release Notes for the Cisco PGW 2200 Softswitch Software Release 9.8(1) at
http://www.cisco.com/en/US/partner/docs/voice_ip_comm/pgw/9/release/note/rn981.html
Restrictions or Limitations
•Limited service for transparent B2BUA mode for call transfers—The Cisco PGW 2200 Softswitch does not support transparent B2BUA mode for transferred calls. To read more about B2BUA modes, see "B2BUA Modes" section.
•Limited trust policy for call transfers—The Cisco PGW 2200 Softswitch provides limited trust policy support for call transfers. The transferred call is considered trusted only if both legs of the call are trusted.
•B2BUA Mode Limitation—The B2BUA mode implementation in this feature does not provide protocol repair or repair for a capability mismatch between call legs. To read more about B2BUA modes, see "B2BUA Modes" section.
•SIP header table size limitation—You cannot create more than 20 entries in a SIP header table.
•SIP profiles do not modify SIP messages affected by call treatment—SIP profiles do not modify the URLs of SIP messages that are affected by the existing call treatment in the Cisco PGW 2200 Softswitch configuration.
•Topology hiding limitations—The following limitations apply to topology hiding:
–For some messages that involve multiple contacts, such as 300 (Multiple Choices), 301 (Moved Permanently), and 302 (Moved Temporarily), the Cisco PGW 2200 Softswitch does not support topology hiding for retry requests. This is because the Cisco PGW 2200 Softswitch may obtain an incorrect routing analysis result when using domain-based routing to resolve a hostname that has been rewritten for topology hiding.
–The sipEgressRoutingControl property modifies the Request-Line and Route headers. In full B2BUA, the default value MODIFY_REQUEST_LINE_NO_ROUTE_USED does not reveal topology information. However, the other available values might reveal topology information.
–If your privacy policy requires that the hostname be set to "anonymous.invalid", topology hiding does not rewrite this hostname.
Related Features and Technology
The following features are related to SIP Profiles:
•SIP-I Protocol
•Multiple Inbound IP Trunks
Related Documents
Cisco PGW 2200 Softswitch Release 9.8 Provisioning Guide
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9/provisioning/guide/prvgde.html
Cisco PGW 2200 Softswitch Release 9.8 Dial Plan Guide
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9/dial_plan/guide/dplan.html
Cisco PGW 2200 Softswitch Release 9 MML Command Reference
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9/command/reference/mmlref_1.html
The documents that contain additional information related to the Cisco PGW 2200 Softswitch are available at
http://www.cisco.com/en/US/products/hw/vcallcon/ps2027/tsd_products_support_series_home.html
Upgrading to Support This Feature
For instructions on how to migrate to Release 9.8(1), see the Release Notes for the Cisco PGW 2200 Softswitch Software Release 9.8(1) at
http://www.cisco.com/en/US/partner/docs/voice_ip_comm/pgw/9/release/note/rn981.html
The following caveats apply to the migration procedure:
•If the Cisco PGW 2200 Softswitch is in B2BUA mode, the migration process sets all existing trunk groups to nontrusted.
•The migration process converts existing trunk group properties to equivalent SIP and EISUP profile properties. If a trunk group property does not have an equivalent profile property, the migration script moves it to a common profile, which is referenced by the SIP or EISUP profile.
•No domain profiles are defined by default.
Implementing SIP Profiles
The following sections describe how to implement the SIP profiles feature.
Creating Profiles
The following sections describe how to create SIP, EISUP, Common, and Domain profiles.
SIP Profiles
A SIP profile creates a set of provisioning properties that you can apply to SIP trunk groups. Each SIP profile can contain the following information:
•SIP properties (former trunk group properties)
• A pointer to a common profile (optional)
•A pointer to a grprofile (optional)
•A pointer to an ISUP timer profile (optional)
• A pointer to an inbound SIP header table (optional)
• A pointer to an outbound SIP header table (optional)
EISUP Profiles
An EISUP profile creates a set of provisioning properties that you can apply to EISUP trunk groups. Each EISUP profile can contain the following information:
•EISUP properties (former trunk group properties)
• A pointer to a common profile (optional)
•A pointer to a grprofile (optional)
Common Profiles
A common profile is an extension of SIP and EISUP profiles that allows you to create a set of provisioning properties for multiple protocols. Common profiles can contain any of the properties present in other profile types.
Domain Profiles
A domain profile creates a set of provisioning properties that you can apply to one or more domain names. Each domain profile can contain the following information:
•SIP provisioning properties
•B2BUA properties introduced in this feature (optional)
• A pointer to an inbound SIP header table (optional)
• A pointer to an outbound SIP header table (optional)
Domain Table
The domain table defines the domain profile that is associated with a given domain name. The domain table contains the following information for each domain name:
•A direction (inbound or outbound)
•A pointer to a domain profile
Applying Multiple Profiles
If the Cisco PGW 2200 Softswitch processes traffic that matches both a SIP profile and a domain profile, the Cisco PGW 2200 Softswitch uses both profiles to process the SIP message.
Topology Hiding
Topology hiding improves network security in a VoIP environment by preventing customers on one side of a call from knowing the details of the network topology on the other side of the call. Prior to the introduction of this feature, the Cisco PGW 2200 Softswitch used two SIP modes: proxy mode and partial B2BUA mode. Both of these options provide some topology hiding between the incoming and outgoing sides of the call. This feature introduces a full B2BUA SIP mode which completely divides a SIP call into two separate SIP calls, with one call terminating at the Cisco PGW 2200 Softswitch and the other originating from the Cisco PGW 2200 Softswitch.
For a call in full B2BUA mode with topology hiding enabled, the Cisco PGW 2200 Softswitch rewrites the FROM, CONTACT, VIA, Call-ID, RECORD-ROUTE, Remote-Party-ID, and P-Asserted-ID headers to remove topology information. The Cisco PGW 2200 Softswitch does not rewrite headers that contain a Tel: URI (Telephone Uniform Resource Identifier) value.
By default, other headers include topology information, such as Refer-to and Diversion. You can define customized header treatment for some tags using the SIP header tables capability introduced in this feature.
Table 1 summarizes how the Cisco PGW 2200 Softswitch performs topology hiding for selected SIP headers.
Table 1 Topology Hiding Summary
Header
|
Description
|
Treatment
|
Example
|
From
|
Contains a URI and a display name (optional). The URI can include topology information at the originating side.
|
The Cisco PGW 2200 Softswitch reconstructs the URI using the Cisco PGW 2200 Softswitch's domain name and port number when sending to the terminating side of the connection, and restores the original values when sending to the originating side of the connection.
Note The Cisco PGW 2200 Softswitch does not rewrite the domain in the From header if it is altered by the IP_SET_SOURCE_DMN result type introduced in the Domain-based Routing feature.
|
Incoming Cisco PGW 2200 Softswitch OCC: From: "Bob" <sip:bob@example.com:5511>;tag=a48s
Outgoing Cisco PGW 2200 Softswitch TCC: From: "Bob" <sip:bob@cisco.com:5060>;tag=b84s
|
Contact
|
The Contact header can contain a display name, a URI with URI parameters, and header parameters. The URI can reveal topology information.
|
Cisco PGW 2200 Softswitch reconstructs the URI with the Cisco PGW 2200 Softswitch's domain and port number. Other parts of the header are unchanged.
|
Incoming Cisco PGW 2200 Softswitch: Contact: "Mr. Watson" <sip:watson@example.com:5061>
Outgoing Cisco PGW 2200 Softswitch: Contact: "Mr. Watson" <sip:watson@cisco.com:5060>
|
Via
|
The Via header contains the transport protocol used to send a message and the client's host name or network address, and it may contain the requested port number for responses. The Via header can also contain parameters including maddr, ttl, received, and branch.
|
In full B2BUA mode, the Cisco PGW 2200 Softswitch replaces the Via header with the Cisco PGW 2200 Softswitch's Via header.
|
Incoming Cisco PGW 2200 Softswitch: Via: SIP/2.0/UDP example.com:5060
Outgoing Cisco PGW 2200 Softswitch: Via: SIP/2.0/UDP cisco.com:5060
|
Call-ID
|
Some SIP implementations use a Call-ID header with the localid@host format.
|
In full B2BUA mode, the Cisco PGW 2200 Softswitch generates a new Call-ID value using Cisco PGW 2200 Softswitch domain as the hostname.
|
Incoming Cisco PGW 2200 Softswitch: Call-ID: 12345600@example.com
Outgoing Cisco PGW 2200 Softswitch: Call-ID: 7624438c-9380b3e-95b3f8d-8@cisco.com
|
Record-Route
|
Some SIP proxy devices insert a Record-Route into a request to force future requests in the dialog to use the proxy.
|
In full B2BUA mode, Cisco PGW 2200 Softswitch does not transmit Record-Route headers from one side of the call to the other and also inserts a non-Record-Route header.
|
|
P-Asserted-ID
|
The P-Asserted-ID header contains a URI (typically a SIP URI) and an optional display-name. This header can be transmitted from the originating side of the call to the terminating side depending on the local configuration.
|
When the header is sent to the terminating side, the Cisco PGW 2200 Softswitch reconstructs the URI using the Cisco PGW 2200 Softswitch's domain name and port number. Other parts of the header are unchanged.
|
Incoming Cisco PGW 2200 Softswitch: P-Asserted-Identity: "Ms. Jennings" <sip:jennings@example.com:5522>
Outgoing Cisco PGW 2200 Softswitch: P-Asserted-Identity: "Ms. Jennings" <sip:jennings@cisco.com:5060>
|
Remote-Party-ID
|
The Remote-Party-ID header contains the URI of the remote party.
|
The Cisco PGW 2200 Softswitch reconstructs the URI using the Cisco PGW 2200 Softswitch domain name and port number. Other parts of the header are unchanged.
|
Incoming Cisco PGW 2200 Softswitch: Remote-Party-ID: "John Doe" <sip:jdoe@example.com:5522>
Outgoing Cisco PGW 2200 Softswitch: Remote-Party-ID: "John Doe" <sip:jdoe@cisco.com:5060>
|
B2BUA Modes
The SIP Profiles feature introduces four B2BUA modes so that you can configure multiple levels of call security. Each B2BUA mode provides a distinct level of unknown SIP header treatment and a topology hiding. You can configure B2BUA by setting the trustLevel and topologyHidingEnabled properties of each profile, which specify whether the trunk group is on a trusted interface and whether topology hiding is enabled.
Note You can modify a profile's SIP header table to override the default treatment of unknown SIP headers.
Table 2 summarizes the trustLevel and topologyHidingEnabled values needed to configure each B2BUA mode.
Table 2 B2BUA Modes
B2BUA Mode
|
Unknown SIP Header Treatment
|
trustLevel Value
|
TopologyHidingEnabled Value
|
Transparent
|
Transparent
|
0 (trusted)
|
0 (based on trustLevel value) or
1 (disabled)
|
Full
|
Transparent
|
0 (trusted)
|
2 (enabled)
|
Full
|
Discarded
|
1 (nontrusted)
|
0 (based on trustLevel value) or
2 (enabled)
|
Partial
|
Discarded
|
1 (nontrusted)
|
1 (disabled)
|
SIP Header Tables
Each profile can contain a SIP header table, which defines a set of SIP headers and corresponding actions. SIP header tables allow you to customize how the Cisco PGW 2200 Softswitch treats calls based on defined SIP header values.
Table 3 describes the actions that the Cisco PGW 2200 Softswitch can take based on SIP headers in inbound and outbound traffic.
Table 3 SIP Header Table Actions
Inbound SIP Traffic
|
Outbound SIP Traffic
|
Discard header
|
Discard header
|
Reject message if header is present
|
Add header using fixed string
|
Reject message if header is not present
|
Replace the header using fixed string
|
Remove tag
|
Remove tag
|
Add tag
|
Add tag
|
Replace tag
|
Replace tag
|
| |
Add header using header of another call leg
|
| |
Replace the header of another call leg
|
SIP Headers That Support Customized Treatment
The SIP Profiles feature defines two categories of SIP headers:
•Known SIP headers—The first column of Table 4 lists known SIP headers in Cisco PGW 2200 Softswitch Software Release 9.8(1). The Cisco PGW 2200 Softswitch treats known SIP headers following its rules.
•Unknown SIP headers—All of the SIP headers that are not listed in the first column of Table 4 are unknown SIP headers. The Cisco PGW 2200 Softswitch discards unknown SIP headers by default.
The second column of Table 4 lists SIP headers that support customized treatment for Cisco PGW 2200 Softswitch Software Release 9.8(1) by default. You can use SIP header tables to customize treatment for these SIP headers. Treatment that is available can be found in Table 3.
You can find provisioning examples of SIP header tables in the "Provisioning SIP Header Tables" section.
Note The second column of Table 4 lists SIP headers that support customized treatment by default. If you want to customize treatment for more SIP headers, contact Cisco Technical Assistance Center (TAC) personnel. For more information about contacting the Cisco TAC, see the "Obtaining Documentation and Submitting a Service Request" section.
Table 4 Known SIP Headers and SIP Headers That Support Customized Treatment
Known SIP Headers
|
SIP Headers That Support Customized Treatment
|
allow
|
Diversion
|
also
|
Organization
|
call-ID
|
Priority
|
call-info
|
Requested-By
|
contact
|
Server
|
content-disposition
|
Subject
|
content-encoding
|
User-Agent
|
content-language
|
Warning
|
content-length
|
|
content-type
|
|
cseq
|
|
date
|
|
event
|
|
expires
|
|
from
|
|
max-forwards
|
|
min-se
|
|
p-asserted-identity
|
|
privacy
|
|
proxy-require
|
|
rack
|
|
reason
|
|
record-route
|
|
referred-by
|
|
refer-to
|
|
remote-party-id
|
|
require
|
|
route
|
|
rseq
|
|
session-expires
|
|
subscription-state
|
|
supported
|
|
to
|
|
unsupported
|
|
via
|
|
Implementing Inbound SIP Header Tables
Table 5 describes the properties of inbound SIP header tables.
Table 5 Inbound SIP Header Table Properties
Property
|
Description
|
Valid values
|
Header Name
|
The name of a SIP header that the Cisco PGW 2200 Softswitch uses to modify traffic.
Note You can use the same header name more than once in a SIP header table.
|
String from 1-255 characters, case insensitive
|
Message
|
The SIP message that triggers a customized action. The value must be the name of a SIP request or response message.
|
String from 1-256 characters, case insensitive
Request message names:
ACK, BYE, CANCEL, COMET, INFO, INVITE, NOTIFY, OPTIONS, PRACK, RE_INVITE, REFER, REGISTER, SIGNAL, SUBSCRIBER, UPDATE
Response numbers: 100-699
Keywords:
ALL, ALL_REQUEST, ALL_RESPONSE
|
Condition
|
Defines how the Cisco PGW 2200 Softswitch uses the SIP header table entry to analyze traffic. This field requires one or more entries in the Condition DW fields.
|
Valid values:
•0 = Unconditional
•1 = Header contains tag
•2 = Header doesn't contain tag
•3 = Message contains tag
•4 = Message doesn't contain tag
|
Treatment
|
The action that the Cisco PGW 2200 Softswitch takes when the SIP header is present.
Note The Cisco PGW 2200 Softswitch applies inbound SIP header table header actions during message validation.
|
Valid values:
•1 = Discard header
•2 = Reject message if header exists
•3 = Reject message if header does not exist
•4 = Remove tag
•5 = Add tag
•6 = Replace tag
|
Index
|
Defines the preferred order for applying SIP header table entries. If a SIP header matches more than one entry in the SIP Header table, the Cisco PGW 2200 Softswitch applies the entry with the lowest Index value.
|
Valid values: 1-20
Default value: 1
|
Condition DW1-4
|
The tags the Cisco PGW 2200 Softswitch uses to analyze SIP traffic. You can define up to four tags for each row in the SIP header table.
Note SIP table header treatments take effect only if a message matches all of the Condition DW fields.
|
String from 1-255 characters, optional, case insensitive.
|
Treatment DW1-4
|
Data words that describe how the Cisco PGW 2200 Softswitch applies the treatment settings.
If the Treatment field is set to 2 or 3, Treatment DW1-4 defines the response code that the Cisco PGW 2200 Softswitch uses to reject the SIP request.
If the Treatment field is set to 4, 5, or 6, DW1-4 define the tag the Cisco PGW 2200 Softswitch removes, adds, or replaces. You can apply up to four tags for each row in the SIP header table.
|
String from 1-255 characters, optional, case sensitive.
Permitted response codes are from 400 to 699. If the SIP header table specifies a response code that the Cisco PGW 2200 Softswitch does not support or does not specify a response code, the Cisco PGW 2200 Softswitch uses the 400 Bad Request response.
For more information about supported response codes, see the Cisco PGW 2200 Softswitch Release 9.8 Dial Plan Guide.
|
Table 6 shows an example of an inbound SIP header table.
Table 6 Sample Inbound SIP Header Table
Header Name
|
Index
|
Message
|
Condition
|
Treatment
|
DW1
Condition
|
DW2
Condition
|
DW3
Condition
|
DW4
Condition
|
DW1 Treatment
|
DW2 Treatment
|
DW3 Treatment
|
DW4 Treatment
|
Diversion
|
1
|
ALL
|
1
|
6
|
example.com
|
|
|
|
cisco.com
|
|
|
|
Organization
|
2
|
Notify
|
0
|
5
|
|
|
|
|
example.net
|
|
|
|
Warning
|
3
|
486
|
4
|
1
|
Server
|
|
|
|
|
|
|
|
Subject
|
4
|
All_Request
|
3
|
4
|
example.com
|
|
|
|
example.com
|
|
|
|
User-Agent
|
5
|
ALL_Response
|
3
|
5
|
example.net
|
|
|
|
Urgent
|
|
|
|
Priority
|
6
|
Invite
|
4
|
2
|
Urgent
|
|
|
|
|
|
|
|
Server
|
7
|
ALL
|
4
|
3
|
example.com
|
|
|
|
|
|
|
|
Requested-By
|
8
|
ALL
|
3
|
6
|
example.com
|
|
|
|
example.com
|
cisco.com
|
|
|
For example, row four of the table removes the Subject header from all SIP requests. The following example demonstrates how this entry alters a SIP request.
Before:
INVITE sip:bob@cisco.com SIP/2.0
Via: SIP/2.0/UDP site3.example.com;branch=z9hG4bK77ef4c2312983.1
Via: SIP/2.0/UDP pc33.example.com;branch=z9hG4bKnashds8;received=192.0.2.1
To: Bob <sip:bob@cisco.com>
From: Alice <sip:alice@example.com>;tag=1928301774
Contact: <sip:alice@pc33.example.com>
Content-Type: application/sdp
After:
INVITE sip:bob@cisco.com SIP/2.0
CC-Diversion:alice@192.0.2.1
Via: SIP/2.0/UDP site3.example.com;branch=z9hG4bK77ef4c2312983.1
Via: SIP/2.0/UDP pc33.example.com;branch=z9hG4bKnashds8;received=192.0.2.1
To: Bob <sip:bob@cisco.com>
From: Alice <sip:alice@example.com>;tag=1928301774
Contact: <sip:alice@pc33.example.com>
Content-Type: application/sdp
Implementing Outbound SIP Header Tables
Table 7 describes the properties of outbound SIP header tables.
Table 7 Outbound SIP Header Table Properties
Property
|
Description
|
Valid Values
|
Header Name
|
The name of a SIP header that the Cisco PGW 2200 Softswitch uses to modify traffic.
Note You can use the same header name more than once in a SIP header table.
|
String from 1-40 characters, case insensitive
|
Apply Policy
|
Defines the B2BUA mode applied to the call/trunk group
|
•Trusted
•Nontrusted
•ALL
|
Message
|
The SIP message that triggers a customized action. The value must be the name of a SIP request or response message.
|
String from 1-256 characters, case insensitive
Request message names:
ACK, BYE, CANCEL, COMET, INFO, INVITE, NOTIFY, OPTIONS, PRACK, RE_INVITE, REFER, REGISTER, SIGNAL, SUBSCRIBER, UPDATE
Response numbers: 100-699
Keywords:
ALL, ALL_REQUEST, ALL_RESPONSE
|
Condition
|
Defines how the Cisco PGW 2200 Softswitch uses the SIP header table entry to analyze traffic. This field requires one or more entries in the Condition DW fields.
|
•0 = Unconditional
•1 = Header contains tag
•2 = Header doesn't contain tag
•3 = Message contains tag
•4 = Message doesn't contain tag
|
Treatment
|
The action that the Cisco PGW 2200 Softswitch takes when the SIP header is present.
To apply multiple changes to a single SIP message, define the treatments in the outbound SIP header table. The Cisco PGW 2200 Softswitch applies the treatments in order of index value.
Note The Cisco PGW 2200 Softswitch analyzes headers prior to SIP table header handling.
|
•1 = Discard header
•2 = Add header using fixed string
•3 = Replace the header using fixed string
•4 = Remove tag
•5 = Add tag
•6 = Replace tag
•7 = Add text from a header in another call leg
Use this option to add text from a header present in another call leg. This treatment adds the header body only. Define the treatment data word to specify the header to use from the other call leg. The Cisco PGW 2200 Softswitch inserts text from the first header that matches the data word.
•8 = Replace the header of another call leg
Use this option to replace a header in another call leg. Define the treatment data word to specify the header to replace in the other call leg. The Cisco PGW 2200 Softswitch replaces the first header that matches the data word.
|
Index
|
Defines the order in which the Cisco PGW 2200 Softswitch applies SIP header table entries. If a SIP header matches more than one entry in the SIP Header table, the Cisco PGW 2200 Softswitch applies the entry with the lowest Index value.
|
Valid values: 1-20
Default value: 1
|
Condition DW1-4
|
The tags the Cisco PGW 2200 Softswitch uses to analyze SIP traffic. You can define up to four tags for each row in the SIP header table.
Note SIP table header treatments take effect only if a message matches all of the Condition DW fields.
|
String from 1-256 characters, optional, case insensitive.
|
Treatment DW1-4
|
The tag the Cisco PGW 2200 Softswitch uses based on the value in the Treatment field. You can apply up to four tags for each row in the SIP header table.
|
String from 1-256 characters, optional, case sensitive.
|
Table 8 shows an example of an outbound SIP header table.
Table 8 Sample Outbound SIP Header Table
Header Name
|
Index
|
Message
|
Apply Policy
|
Condition
|
Treatment
|
Condition DW1
|
Condition DW2
|
Treatment DW1
|
Treatment DW2
|
Treatment DW3
|
Treatment DW4
|
Diversion
|
1
|
All
|
Trusted
|
1
|
6
|
example.com
|
2405
|
example.com
|
cisco.com
|
|
|
Organization
|
2
|
Notify
|
Nontrusted
|
0
|
5
|
|
|
example.net
|
|
|
|
Warning
|
3
|
486
|
ALL
|
4
|
1
|
cisco.com
|
|
|
|
|
|
Subject
|
4
|
ALL_Request
|
ALL
|
3
|
4
|
example.com
|
|
example.com
|
|
|
|
User-Agent
|
5
|
ALL_Response
|
ALL
|
2
|
5
|
organization
|
|
organization: Cisco
|
|
|
|
Priority
|
6
|
Invite
|
ALL
|
2
|
3
|
Urgent
|
|
Urgent
|
Normal
|
|
|
Server
|
7
|
ALL
|
ALL
|
4
|
2
|
cisco.com
|
|
Server: PGW
|
|
|
|
Requested-By
|
8
|
ALL
|
ALL
|
3
|
6
|
example.com
|
|
example.com
|
cisco.com
|
|
|
User-agent
|
9
|
ALL
|
ALL
|
3
|
7
|
User-Agent: cisco.com
|
|
User-Agent: example.net
|
|
|
|
Requested-By
|
10
|
ALL
|
ALL
|
3
|
8
|
example.com
|
|
example.com
|
cisco.com
|
|
|
For example, row four of the table removes the Subject header from all SIP requests. The following example demonstrates how this entry alters a SIP message.
Before:
Via: SIP/2.0/UDP site3.example.com;branch=z9hG4bK77ef4c2312983.1;received=192.0.2.2
Via: SIP/2.0/UDP pc33.example.com;branch=z9hG4bKnashds8;received=192.0.2.1
To: Bob <sip:bob@cisco.com>;tag=a6c85cf
From: Alice <sip:alice@example.com>;tag=1928301774
Contact: <sip:bob@192.0.2.4>
Content-Type: application/sdp
After:
Via: SIP/2.0/UDP site3.example.com;branch=z9hG4bK77ef4c2312983.1;received=192.0.2.2
Via: SIP/2.0/UDP pc33.example.com;branch=z9hG4bKnashds8;received=192.0.2.1
To: Bob <sip:bob@cisco.com>;tag=a6c85cf
From: Alice <sip:alice@example.com>;tag=1928301774
Contact: <sip:bob@192.0.2.4>
Content-Type: application/sdp
Applying Multiple SIP Headers
If the Cisco PGW 2200 Softswitch applies multiple profiles to a SIP message and both profiles have SIP header tables defined, the Cisco PGW 2200 Softswitch uses both SIP header tables to process the SIP message.
Provisioning Tasks
Further information about provisioning is available in the Cisco PGW 2200 Softswitch Release 9.8 Provisioning Guide in the following sections:
•Planning for Provisioning
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9/provisioning/guide/R9PlnPrv.html
•MML Basics
http://www.cisco.com/en/US/docs/voice_ip_comm/pgw/9/provisioning/guide/R9MMLCfg.html
The following tasks describe how to provision the SIP Profile feature.
Provisioning SIP and EISUP Profiles
Use the commands presented in the following sections to provision SIP and EISUP profiles.
Adding a SIP or EISUP Profile
The following examples demonstrate how to add a new SIP or EISUP profile:
mml> prov-add:profile:name="sp1", type="SIPPROFILE", custgrpid="1111",
mgcdomain="10.0.6.55", trustlevel="1", topologyhidingenabled="1"
mml> prov-add:profile:name="spf3", type="EISUPPROFILE", populatesdpinfoincdr="1"
Cloning a SIP or EISUP Profile
The base parameter allows you to create a new profile based on an existing profile. To use this parameter, create a new profile and set the base parameter to an existing profile name. The new profile has the properties of the original profile, but you can override the settings of the original profile properties by manually specifying new settings in the command. Both profiles must be of the same type.
mml> prov-add:profile:name="spf2",type="SIPPROFILE",base="spf1",responseattempts="2"
Retrieving a SIP or EISUP Profile
Use the prov-rtrv:profile command to retrieve SIP and EISUP profile properties. This command has the following parameters:
•prop—Displays the provisioning property settings for the profile
•comp—Displays the components associated with the profile
•all—Displays the profile name, type, and property names, and values for all existing profiles
mml> prov-rtrv:profile:"prop", name="spf1"
mml> prov-rtrv:profile:"comp", name="spf2"
mml> prov-rtrv:profile:"all"
Modifying a SIP or EISUP Profile
Use the prov-ed:profile command to modify a SIP or EISUP profile:
mml> prov-ed:profile:name="spf1", noninvitereqattempts="2"
Adding a Common Profile, a Grprofile, or an ISUP Timer Profile Reference to a SIP Profile
You can add a common profile or grprofile reference to a SIP or EISUP profile using the commonprofile and grprofile parameters. You can also add an ISUP timer profile reference to a SIP profile using the isuptmrprofile parameter.
mml> prov-ed:profile:name="spf1",commonprofile="cpf1"
mml> prov-ed:profile:name="spf1",grprofile="gpf1"
mml> prov-ed:profile:name="spf1",isuptmrprofile="isuptmrpf1"
Note You must create common profiles or grprofiles before referencing them in a SIP or EISUP profile. You must create ISUP timer profiles before referencing them in a SIP profile.
Note For instructions on how to create a grprofile or an ISUP timer profile, see the Cisco PGW 2200 Softswitch
Release 9.8 Provisioning Guide.
Removing a Property from a SIP or EISUP Profile
Use the following command to remove a property from a SIP or EISUP profile:
mml> prov-dlt:profile:name="spf1","noninvitereqattempts"
Caution Be sure to specify a property value when deleting a property from a SIP or EISUP profile. If you do not, the command deletes the entire profile.
Deleting a SIP or EISUP Profile
Use the prov-dlt command to delete a SIP or EISUP profile:
mml> prov-dlt:profile:name="spf1"
Note You cannot delete a SIP or EISUP profile that is referenced by another profile.
Provisioning Common Profiles
Common profiles allow you to apply SIP or EISUP profiles to profile types that use other protocols, such as SS7. Use the following commands to provision common profiles.
Adding a Common Profile
Use the prov-add:profile command to add a common profile:
mml> prov-add:profile:name="cpf1",type="COMMONPROFILE",glare="0"
Cloning a Common Profile
The base parameter allows you to create a new profile based on an existing profile. To use this parameter, create a new profile and set the base parameter to an existing profile name. The new profile has the properties of the original profile, but you can override the settings of the original profile properties by manually specifying them in the command. Both profiles must be of the same type.
mml> prov-add:profile:name="cpf2", type="COMMONPROFILE", base="cpf1", responseattempts="2"
Retrieving a Common Profile
Use the prov-rtrv:profile command to retrieve common profile properties. This command has the following parameters:
•prop—Displays the provisioning property settings for the profile
•comp—Displays the components associated with the profile
•all—Displays the profile name, type, and property names, and values for all existing profiles
mml> prov-rtrv:profile:"prop", name="cpf1"
mml> prov-rtrv:profile:"comp", name="gpf2"
mml> prov-rtrv:profile:"all"
Modifying a Common Profile
Use the prov-ed:profile command to modify a common profile:
mml> prov-ed:profile:name="cpf1", noninvitereqattempts="2"
Removing a Property from a Common Profile
Use the following command to remove a property from a common profile:
mml> prov-dlt:profile:name="cpf1"," noninvitereqattempts"
Caution Be sure to specify a property value when deleting a property from a group or common profile. If you do not, the command deletes the entire profile.
Deleting a Common Profile
Use the prov-dlt command to delete a common profile:
mml> prov-dlt:profile:name="cpf1"
Provisioning Domain Profiles
The commands to provision domain profiles are similar to the commands for provisioning SIP and EISUP profiles, with the exception that SIP and EISUP provisioning properties are not available. Use the commands in the following sections to provision domain profiles.
Adding a Domain Profile
The following example demonstrates how to add a new domain profile:
mml> prov-add:profile:name="dpf1", type="DOMAINPROFILE", topologyhidingenabled="2",
trustlevel="1"
Cloning a Domain Profile
The base parameter allows you to create a new profile based on an existing profile. To use this parameter, create a new profile and set the base parameter to an existing profile name. The new profile has the properties of the original profile, but you can override the settings of the original profile properties by manually specifying them in the command. Both profiles must be of the same type.
mml> prov-add:profile:name="dpf2", type="DOMAINPROFILE", base="dpf1",trustlevel="1"
Retrieving a Domain Profile
Use the prov-rtrv:profile command to retrieve domain profile properties. This command has the following parameters:
•prop—Displays the provisioning property settings for the profile
•comp—Displays the components associated with the profile
•all—Displays the profile name, type, and property names, and values for all existing profiles
mml> prov-rtrv:profile:"prop", name="dpf1"
mml> prov-rtrv:profile:"comp", name="dpf2"
mml> prov-rtrv:profile:"all"
Modifying a Domain Profile
Use the prov-ed:profile command to modify a domain profile:
mml> prov-ed:profile:name="dpf1", topologyhidingenabled="1"
Adding a Common Profile or Grprofile Reference to a Domain Profile
You can add a common or grprofile reference within a domain profile using the commonprofile and grprofile parameters.
mml> prov-ed:profile:name="dpf1",commonprofile="cpf1"
mml> prov-ed:profile:name="dpf1",grprofile="gpf1"
Note You must create Common Profiles or grprofiles before referencing them in a domain profile.
Note For instructions on how to create a grprofile, see the Cisco PGW 2200 Softswitch
Release 9.8 Provisioning Guide.
Removing a Property from a Domain Profile
Use the prov-dlt:profile command to remove a property from a domain profile:
mml> prov-dlt:profile:name="dpf1", "topologyhidingenabled"
Caution Be sure to specify a property value when deleting a property from a SIP or EISUP profile. If you do not, the command deletes the entire profile.
Deleting a Domain Profile
Use the prov-dlt command to delete a domain profile:
mml> prov-dlt:profile:name="dpf1"
Note You cannot delete a domain profile that is referenced by another profile.
Managing the Domain Table
The domain table allows you to define a set of domain names and associate them with a domain profile for both inbound and outbound traffic. Use the commands in the following sections to manage the domain table.
Adding a New Domain Name
Use the prov-add:domainprof command to add a new domain name to the domain table. A type (inbound or outbound) and profile are required.
mml> prov-add:domainprof:domain="cisco.com", type="OUTBOUND", profile="dpf1"
Editing Domain Properties
Use the prov-ed:domainprof command to modify the properties of a domain name:
mml> prov-ed:domainprof:domain="cisco.com", type="INBOUND", profile="dpf1"
Modifying the Domain Profile Assigned to a Domain
Use the prov-ed:domainprof command to change the domain profile assigned to a domain name:
mml> prov-ed:domainprof:domain="cisco.com", type="INBOUND", profile="dpf1"
Retrieving Domain Names
Use the prov-rtrv:domainprof command to retrieve domain names from the domain table. To retrieve properties for an individual domain, specify the domain name and type (inbound or outbound).
mml> prov-rtrv:domainprof:domain="cisco.com", type="INBOUND"
mml> prov-rtrv:domainprof:domain="cisco.com", type="OUTBOUND"
To retrieve properties for all domain names in the domain table, enter the following command:
prov-rtrv:domainprof:"all"
Deleting a Domain Name
Use the prov-dlt:domainprof command to delete a domain name from the domain table:
mml> prov-dlt:domainprof:domain="cisco.com", type="OUTBOUND"
Note You cannot delete a domain name that is referenced by a domain profile.
Assigning Profiles to Trunk Groups
You can assign one profile to each trunk group in order to customize call behavior. Use the commands described in the following sections to assign profiles to trunk groups.
Tip In many cases, inbound and outbound trunk groups can utilize the same profile.
Adding a Profile to a Trunk Group
The profiles created above are associated with trunk groups. The inbound and outbound trunk groups typically have the same profile. Use the prov-add:trnkgrpprof command to add a trunk group to a profile:
mml> prov-add:trnkgrpprof:name="1", profile="spf1"
mml> prov-add:trnkgrpprof:name="2", profile="gpf1"
Modifying the Profile Assigned to a Trunk Group
Use the prov-ed:trnkgrpprof command to modify the profile associated with a trunk group:
mml> prov-ed:trnkgrpprof:name="1", profile="spf2"
Removing a Trunk Group from a Profile
Use the prov-dlt:trnkgrpprof command to remove a trunk group from a profile:
mml> prov-dlt:trnkgrpprof:name="1",profile="spf1"
Provisioning SIP Header Tables
Use the commands described in the following sections to provision SIP header tables.
Adding an Inbound SIP Header Table Entry
Use the prov-add:insipheader command to add an inbound SIP header table entry:
mml> prov-add:insipheader:name="insipht1",header="p-asserted-identity",
message="INVITE",cond=2,treat=1, cdw1="user=phone"
Note To create a new SIP header table, use a new header table name when adding a table entry. The Cisco PGW 2200 Softswitch creates the new SIP header table automatically.
Adding an Outbound SIP Header Table Entry
Use the prov-add:outsipheader command to add an outbound SIP header table entry:
mml> prov-add:outsipheader:name="outsipht1",header="user-agent",message="INVITE",cond=0,
treat=5 ,cdw1="pgw2200 Release 9.8",policy="ALL"
Adding a SIP Header Table to a Profile
Use the prov-ed:profile command to add a SIP header table to a profile:
mml> prov-ed:profile:name="spf1", outsipheadertable="outsipht1"
Modifying a SIP Header Table Entry
Use the prov-ed:insipheader command to modify a SIP header table entry:
mml> prov-ed:insipheader:name="insipht1",index=1, cdw1="user=phone"
Note You must provide an index value to edit SIP header table entries.
Retrieving a SIP Header Table
Use the prov-rtrv:insipheader or prov-rtrv:outsipheader command to retrieve SIP header tables.
mml> prov-rtrv:insipheader:name="insip1"
mml> prov-rtrv:insipheader:name="insip1", message="INVITE"
mml> prov-rtrv:insipheader:name="insip1", header="user-agent"
Use the following command to retrieve all SIP header tables:
mml> prov-rtrv:insipheader:"all"
Retrieving a SIP Header Table Entry
To retrieve an individual entry in a SIP header table, use the prov-rtrv:insipheader or prov-rtrv:outsipheader command and specify an index, header, or message value.
mml> prov-rtrv:insipheader:name="insip1", index=1
mml> prov-rtrv:outsipheader:name="outsip1", header="user-agent"
mml> prov-rtrv:outsipheader:name="outsip1", message="INVITE"
mml> prov-rtrv:insipheader:name="insip2",index=1, header="user-agent",message="INVITE"
Note You can retrieve a SIP header table entry using an index, header, or message value.
Reordering a SIP Header Table
The following caveats apply when your reorder a SIP header table:
•If you create a new SIP table header entry without specifying an index value, the Cisco PGW 2200 Softswitch assigns a value one higher than the largest existing index number. If you attempt to set a larger index value, the Cisco PGW 2200 Softswitch replaces the new value with the default next value.
•If you set a SIP table header table entry to an existing index value, the new entry takes this value, and all affected entries are incremented by 1.
•To move an entry backward in index order, use the prov-add and prov-dlt commands to remove the original entry and insert it earlier in the index order.
Deleting an Entry from a SIP Header Table
Use the prov-dlt:insipheader command to delete an entry from a SIP header table:
mml> prov-dlt:insipheader:name="insipht1",index=1, header="user-agent", message="INVITE"
Note You must enter an index, header, and message value to delete a SIP header table entry.
Deleting a SIP Header Table
Use the prov-dlt:insipheader command to delete a SIP header table:
mml> prov-dlt:insipheader:name="insipht1"
Note You cannot delete a SIP header table that is referenced in a profile.
Provisioning Examples
This section provides a provisioning example for this feature. Additional provisioning examples for the Cisco PGW 2200 Softswitch software can be found in the Cisco PGW 2200 Softswitch Release 9.8 Provisioning Guide.
______________________________________
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-add:profile:name="gp1",type="GRPROFILE",cgpninclude="1"
________________________________________
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-add:profile:name="cp1",type="COMMONPROFILE",mgcdomain="10.0.6.55"
________________________________________
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-add:profile:name="isuptmrp1",type="ISUPTMRPROFILE",t6="120000",
variant="etsi356",t2="180000",t9="60000",t33="12000",validation="OFF"
________________________________________
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-add:profile:name="sp1",type="SIPPROFILE",custgrpid="1111",mgcdomain="10.0.6.55",
trustlevel="1",topologyhidingenabled="1"
mml> prov-add:profile:name="sp2",type="SIPPROFILE",grprofile="gp1",commonprofile="cp1"
mml> prov-ed:profile:name="sp2",isuptmrprofile="isuptmrp1"
________________________________________
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-add:profile:name="ep1",type="EISUPPROFILE",custgrpid="1111"
________________________________________
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-add:profile:name="dp1",type="DOMAINPROFILE",trustlevel="1",
topologyhidingenabled="1"
________________________________________
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-add:domainprof:name="cisco.com",type="INBOUND",profile="dp1"
________________________________________
; SIP Header Table Entries
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-add:insipheader:name="insipht1",header="p-asserted-identity",
message="INVITE",cond=2,treat=1, cdw1="user=phone"
________________________________________
; SIP Header Table References
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
mml> prov-ed:profile:name="sp1", insipheadertable="insipht1"
Software Changes for This Feature
The following sections contain software changes related to this feature:
•New MML Commands
•Modified MML Commands
•Billing Interface
•Properties
•Provisioning Worksheets
MML Command Reference
This section documents new, modified, or deleted Man-Machine Language (MML) commands. All other MML commands are documented in the Cisco PGW 2200 Softswitch Release 9 MML Command Reference.
New MML Commands
This section contains the MML commands that are new for this feature.
PROV-ADD:INSIPHEADER (Release 9.8(1))
Purpose:
|
This MML command adds an inbound SIP header table.
|
Syntax:
|
prov-add:insipheader: name="Header Table Name", header="Header Name",
message="Message Name", index="Index", cond="Condition", cdw1="Condition
Word 1", cdw2="Condition Word 2", cdw3="Condition Word 3",
cdw4="Condition Word 4", treat="treatment", tdw1="treatment word 1",
tdw2="treatment word 2", tdw3="treatment word 3", tdw4="treatment word 4"
|
Input Description:
|
•name—The name of the SIP header table.
•header—The name of a SIP header that the Cisco PGW 2200 Softswitch uses to modify traffic.
•message name—The name of the SIP message that triggers a customized action. The value must be the name of a SIP request or response message.
•index—Defines the order in which the Cisco PGW 2200 Softswitch applies SIP header table entries. If a SIP header matches more than one entry in the SIP Header Table, the Cisco PGW 2200 Softswitch applies the entry with the lowest index value.
•cond—Defines how the Cisco PGW 2200 Softswitch uses the SIP header table entry to analyze traffic. This field requires one or more entries in the Condition DW fields.
•cdw1-4—The tags the Cisco PGW 2200 Softswitch uses to analyze SIP traffic.
•treat—The action that the Cisco PGW 2200 Softswitch takes when the SIP header is present.
•tdw1-4—Data words that describe how the Cisco PGW 2200 Softswitch applies the treatment settings.
Note For more information about applying inbound SIP headers, see "Implementing Inbound SIP Header Tables" section.
|
Output Description:
|
•COMPLD—Provision succeeds.
•DENY— Provision fails.
|
Example:
|
prov-add:insipheader:name=''insipht1'',message=''INVITE'',cond=2,treat=1,
cdw1=''user=phone'',header=''User-Agent''
MGC-01 - Media Gateway Controller 2008-03-04 10:47:38.222 EST
|
Comments:
|
Performance impact category C applies to the commands used to create, delete, and edit inbound SIP header tables.
For more information about performance impact categories, see the Cisco PGW 2200 Softswitch Release 9 MML Command Reference.
|
PROV-ADD:OUTSIPHEADER (Release 9.8(1))
Purpose:
|
This MML command adds an outbound SIP header table.
|
Syntax:
|
prov-add:outsipheader: name="Header Table Name", header="Header Name",
message="Message Name", policy="Policy", index="Index", cond="Condition",
cdw1="Condition Word 1", cdw2="Condition Word 2", cdw3="Condition Word
3", cdw4="Condition Word 4", treat="treatment", tdw1="treatment word 1",
tdw2="treatment word 2", tdw3="treatment word 3", tdw4="treatment word 4"
|
Input Description:
|
•name—The name of the SIP header table.
•header—The name of a SIP header that the Cisco PGW 2200 Softswitch uses to modify traffic.
•message name—The name of the SIP message that triggers a customized action. The value must be the name of a SIP request or response message.
•policy—Defines the B2BUA mode applied to the call/trunk group.
•index—Defines the order in which the Cisco PGW 2200 Softswitch applies SIP header table entries. If a SIP header matches more than one entry in the SIP Header table, the Cisco PGW 2200 Softswitch applies the entry with the lowest Index value.
•cond—Defines how the Cisco PGW 2200 Softswitch uses the SIP header table entry to analyze traffic. This field requires one or more entries in the Condition DW fields.
•cdw1-4—The tags the Cisco PGW 2200 Softswitch uses to analyze SIP traffic. You can define up to four tags for each row in the SIP header table. SIP table header treatments take effect only if a message matches all of the Condition DW fields.
•treat—The action that the Cisco PGW 2200 Softswitch takes when the SIP header is present.
•tdw1-4—Data words that describe how the Cisco PGW 2200 Softswitch applies the treatment settings. For values 2-3 in the Treatment field, Treatment DW1 defines the response code used to reject the request. For values 4-6 in the Treatment field, Treatment DW1-4 define the tag the Cisco PGW 2200 Softswitch applies. You can apply up to four tags for each row in the SIP header table.
Note For more information about applying inbound SIP headers, see "Implementing Inbound SIP Header Tables" section.
|
Output Description:
|
•COMPLD—Provision succeeds.
•DENY— Provision fails.
|
Example:
|
prov-add:outsipheader:name=''outsipht1'',header=''Diversion'',message=''I
NVITE'',cond=1,treat=1 ,cdw1=''xyf2'',policy=0,index=1
MGC-01 - Media Gateway Controller 2008-03-04 10:51:22.260 EST
|
Comments:
|
Performance impact category C applies to the commands used to create, delete, and edit outbound SIP header tables.
For more information about performance impact categories, see the Cisco PGW 2200 Softswitch Release 9 MML Command Reference.
|
PROV-ADD:DOMAINPROF (Release 9.8(1))
Purpose:
|
This MML command creates an entry in the domain table.
|
Syntax:
|
prov-add:domainprof:domain="Domain Name",type="Inbound or
Outbound",profile="Domain Profile Name"
|
Input Description:
|
•domain—The domain name used to analyze traffic
•type—The direction of the profile (inbound or outbound)
•profile—The name of a domain profile that is used for the domain name
|
Output Description:
|
•COMPLD—Provision succeeds.
•DENY— Provision fails.
|
Example:
|
mml>
prov-add:domainprof:domain=''cisco.com'',type=''INBOUND'',profile="dpf1"
MGC-01 - Media Gateway Controller 2008-03-04 10:47:38.222 EST
|
Comments:
|
Performance impact category A applies to the commands used to manage the domain table.
For more information about performance impact categories, see the Cisco PGW 2200 Softswitch Release 9 MML Command Reference.
|
Modified MML Commands
This section contains the MML commands that are modified for this feature.
PROV-ADD:PROFILE
Purpose:
|
This MML command creates a SIP, EISUP, Domain, or Common profile.
|
Syntax:
|
prov-add:profile:name= "profile name", type="SIPPROFILE",validation="ON",
base="existing profile", cat="Category",
topologyhidingenabled="enablevalue", trustlevel="level"
|
Input Description:
|
•name—The name of the new profile.
•type—The type of profile you wish to create. The available options are
–SIPPROFILE
–EISUPPROFILE
–DOMAINPROFILE
–COMMONPROFILE
•validation—Indicates if profile property validation is enabled or disabled. Valid values are ON and OFF.
Note Validation can be disabled only for ISUP timer profiles.
•base—The name of an existing profile used to create the new profile. The properties of the existing profile are copied to the new profile.
•cat—A property category name which is used to filter the provisioning properties. This parameter allows you to apply a command to a subset of provisioning properties. Valid values are
–A&R
–Billing
–Media
–Misc
–Number
–SIP
–Timer
•topologyhidingenabled—Indicates if topology hiding is enabled. Valid values are:
–0 (based on trustLevel value)
–1 (disabled)
–2 (enabled)
•trustlevel—Defines the trust level assigned to a profile. Valid values are
–0 (trusted)
–(nontrusted)
|
Output Description:
|
•COMPLD—Provision succeeds.
•DENY— Provision fails.
|
Example:
|
mml> prov-add:profile:name="spf1", type="SIPPROFILE", validation="ON",
cat="SIP", topologyhidingenabled="2", trustlevel="1"
MGC-01 - Media Gateway Controller 2008-03-04 10:47:38.222 EST
|
Comments:
|
The base property is new in 9.8(1) and allows you to create a new profile based on an existing profile. To use this property, set the base property to the name of an existing profile. You can set additional properties to override the values copied from the original profile.
Performance impact category A applies to this command. For more information about performance impact categories, see the Cisco PGW 2200 Softswitch Release 9 MML Command Reference.
|
(Release 9.8(1))
Billing Interface
This section identifies the call detail record (CDR) data added for this feature. For billing interface information for the rest of the Cisco PGW 2200 Softswitch software, see the Cisco PGW 2200 Softswitch Release 9 Billing Interface Guide.
New Call Data Records
This section describes the new Call Data Records (CDRs) introduced for this feature.
Table 9 Inbound Trunk Profile Description Form
Name: Inbound Trunk Profile
|
Tag: 4051
|
Source: MDL/Engine
|
Description/Purpose: Contains the inbound trunk profile name used for the call.
|
Format: IA5
|
Length in Octets: 1-256
|
Data Value: Inbound trunk profile name.
|
Extended Data Value: No extended value.
|
General Information:
|
Release: Release 9.8 or later.
|
Answered (1010)
|
Deselected (1020)
|
Aborted (1030)
|
Release (1040)
|
Interrupted (1050)
|
Ongoing (1060)
|
Maintenance (1070)
|
External DB (1080)
|
End of Call (1110)
|
Y
|
N
|
Y
|
Y
|
N
|
N
|
N
|
N
|
Y
|
Table 10 Outbound Trunk Profile Description Form
Name: Outbound Trunk Profile
|
Tag: 4052
|
Source: MDL/Engine
|
Description/Purpose: Contains the outbound trunk profile name used for the call.
|
Format: IA5
|
Length in Octets: 1-256
|
Data Value: Outbound trunk profile name.
|
Extended Data Value: No extended value.
|
General Information:
|
Release: Release 9.8 or later.
|
Answered (1010)
|
Deselected (1020)
|
Aborted (1030)
|
Release (1040)
|
Interrupted (1050)
|
Ongoing (1060)
|
Maintenance (1070)
|
External DB (1080)
|
End of Call (1110)
|
Y
|
N
|
Y
|
Y
|
N
|
N
|
N
|
N
|
Y
|
Table 11 Inbound Domain Profile Description Form
Name: Inbound Domain Profile
|
Tag: 4053
|
Source: MDL/Engine
|
Description/Purpose: Contains the inbound domain profile name used for the call.
|
Format: IA5
|
Length in Octets: 1-256
|
Data Value: Inbound domain profile name.
|
Extended Data Value: No extended value.
|
General Information:
|
Release: Release 9.8 or later.
|
Answered (1010)
|
Deselected (1020)
|
Aborted (1030)
|
Release (1040)
|
Interrupted (1050)
|
Ongoing (1060)
|
Maintenance (1070)
|
External DB (1080)
|
End of Call (1110)
|
Y
|
N
|
Y
|
Y
|
N
|
N
|
N
|
N
|
Y
|
Table 12 Outbound Domain Profile Description Form
Name: Outbound Domain Profile
|
Tag: 4054
|
Source: MDL/Engine
|
Description/Purpose: Contains the outbound domain profile name used for the call.
|
Format: IA5
|
Length in Octets: 1-256
|
Data Value: Outbound domain profile name.
|
Extended Data Value: No extended value.
|
General Information:
|
Release: Release 9.8 or later.
|
Answered (1010)
|
Deselected (1020)
|
Aborted (1030)
|
Release (1040)
|
Interrupted (1050)
|
Ongoing (1060)
|
Maintenance (1070)
|
External DB (1080)
|
End of Call (1110)
|
Y
|
N
|
Y
|
Y
|
N
|
N
|
N
|
N
|
Y
|
Table 13 Call Policy Description Form
Name: Call Policy
|
Tag: 4055
|
Source: MDL
|
Description/Purpose: Indicates the back-to-back user agent policy applied to the call.
|
Format: Structured variable
|
Length in Octets: 1
|
Data Value: Outbound domain profile name.
Octet 1 Transport Protocol
•0 = Trusted
•1 = Nontrusted
•2 = Trusted, topology hiding enabled
•3 = Nontrusted, topology hiding disabled
|
Extended Data Value: No extended value.
|
General Information:
|
Release: Release 9.8 or later.
|
Answered (1010)
|
Deselected (1020)
|
Aborted (1030)
|
Release (1040)
|
Interrupted (1050)
|
Ongoing (1060)
|
Maintenance (1070)
|
External DB (1080)
|
End of Call (1110)
|
Y
|
N
|
Y
|
Y
|
N
|
N
|
N
|
N
|
Y
|
Table 14 SIP terminating Call ID Description Form
Name: SIP Terminating Call ID
|
Tag: 4056
|
Source: MDL/Engine
|
Description/Purpose: Contains the Call ID used by the terminating side of a SIP call.
|
Format: IA5
|
Length in Octets: 1-256
|
Data Value: Call ID number.
|
Extended Data Value: No extended value.
|
General Information:
|
Release: Release 9.8 or later.
|
Answered (1010)
|
Deselected (1020)
|
Aborted (1030)
|
Release (1040)
|
Interrupted (1050)
|
Ongoing (1060)
|
Maintenance (1070)
|
External DB (1080)
|
End of Call (1110)
|
Y
|
N
|
Y
|
N
|
N
|
N
|
N
|
N
|
Y
|
Modified Call Data Records
This section describes the Call Data Records (CDRs) modified by this feature.
Table 15 SIP Originating Call ID Description Form
Name: SIP Originating Call ID
|
Tag: 4203
|
Source: MDL/Engine
|
Description/Purpose: Contains the Call ID used by the originating side of a SIP call.
Note The name of this CDR was changed from SIP Call ID to SIP Originating Call ID for this feature.
|
Format: IA5
|
Length in Octets: 1-256
|
Data Value: Call ID number
|
Extended Data Value: No extended value.
|
General Information:
|
Release: Release 9.8 or later.
|
Answered (1010)
|
Deselected (1020)
|
Aborted (1030)
|
Release (1040)
|
Interrupted (1050)
|
Ongoing (1060)
|
Maintenance (1070)
|
External DB (1080)
|
End of Call (1110)
|
Y
|
N
|
Y
|
N
|
N
|
N
|
N
|
N
|
Y
|
Properties
The SIP Profiles feature replaces all existing SIP and EISUP trunk group properties with equivalent SIP and EISUP profile properties. For a full listing of all affected properties, see the Cisco PGW 2200 Softswitch Release 9.8 Provisioning Guide.
Table 16 and Table 17 describe the trunk group properties used for this feature.
Table 16 Software Properties Related to This Feature
Property Name
|
Parent Object
|
|
|
AVM
|
DPNSS
|
EISUP
|
IOCC
|
ISDNPRI
|
MGCP
|
QSIG
|
RLM
|
SESSION
|
SGCP
|
SIP
|
SS7-ANSI
|
SS7-China
|
SS7-ITU
|
SS7-Japan
|
SS7-UK
|
TALI-IOCC
|
TCAPOverIP
|
TrunkGroup
|
VSI
|
LI
|
CTI-QBE
|
commonprofile
|
|
|
X
|
|
|
|
|
|
|
|
X
|
|
|
|
|
|
|
|
|
|
|
|
grprofile
|
|
|
X
|
|
|
|
|
|
|
|
X
|
|
|
|
|
|
|
|
|
|
|
|
isuptmrprofile
|
|
|
|
|
|
|
|
|
|
|
X
|
|
|
|
|
|
|
|
|
|
|
|
insipheadertable
|
|
|
X
|
|
|
|
|
|
|
|
X
|
|
|
|
|
|
|
|
|
|
|
|
outboundDomainProfileSource
|
|
|
|
|
|
|
|
|
|
|
X
|
|
|
|
|
|
|
|
|
|
|
|
outsipheadertable
|
|
|
X
|
|
|
|
|
|
|
|
X
|
|
|
|
|
|
|
|
|
|
|
|
topologyHidingEnabled
|
|
|
X
|
|
|
|
|
|
|
|
X
|
|
|
|
|
|
|
|
|
|
|
|
trustLevel
|
|
|
X
|
|
|
|
|
|
|
|
X
|
|
|
|
|
|
|
|
|
|
|
|
useDomainProfile
|
|
|
|
|
|
|
|
|
|
|
X
|
|
|
|
|
|
|
|
|
|
|
|
Table 17 Profile Properties
Property
|
Description
|
commonprofile
|
Contains a pointer to a Common Profile.
Valid values: String. Enter the name of an existing Common Profile.
Default value: NULL
Dynamically reconfigurable: Yes
|
grprofile
|
Contains a pointer to a GRPROFILE profile.
Valid values: String. Enter the name of an existing Group Profile.
Default value: NULL
Dynamically reconfigurable: Yes
|
insipheadertable
|
Contains a pointer to an inbound SIP header table.
Valid values: String. Enter the name of an existing inbound SIP Header table.
Default value: NULL
Dynamically reconfigurable: Yes
|
isuptmrprofile
|
Contains a pointer to an ISUP timer profile.
Valid values: String. Enter the name of an existing ISUP timer profile.
Default value: NULL
Dynamically reconfigurable: Yes
|
outboundDomainProfileSource
|
Indicates the source that the Cisco PGW 2200 Softswitch uses for the outbound domain name.
Valid values:
•0 = If available, the Cisco PGW 2200 Softswitch uses the domain used for routing as introduced by the domain-based routing feature. Otherwise, the Cisco PGW 2200 Softswitch uses the domain of the SIP trunk group.
•1 = The Cisco PGW 2200 Softswitch uses the domain of the SIP trunk group.
Default value: 0
Dynamically reconfigurable: Yes
|
outsipheadertable
|
Contains a pointer to an outbound SIP header table.
Valid values: String. Enter the name of an existing outbound SIP header table.
Default value: NULL
Dynamically reconfigurable: Yes
|
topologyHidingEnabled
|
Indicates whether topology hiding is enabled.
Valid values:
•0 = Trust level configuration
•1 = Disabled
•2 = Enabled
Default value: 1
Dynamically reconfigurable: Yes
|
trustLevel
|
Indicates if the trunk group or domain is on a trusted or nontrusted interface.
Valid values:
•0 = trusted
•1 = nontrusted
Default value: 0
Dynamically reconfigurable: Yes
|
useDomainProfile
|
Indicate whether domain profiles are enabled for a SIP profile.
Valid values:
•0 = Disabled
•1 = Enabled
Default value: 1
Dynamically reconfigurable: Yes
|
Provisioning Worksheets
This section contains worksheets for the provisioning components required for this feature. For worksheets covering the rest of the provisioning components in the Cisco PGW 2200 Softswitch software, see the Cisco PGW 2200 Softswitch Release 9.8 Provisioning Guide.
Table 18 SIP and EISUP Profiles Worksheet Example
Profile Name
|
Type
|
Trust Level
|
Topology
Hiding
|
Property
|
Value
|
Profile Reference
|
SIP Header Table Name
|
spf1
|
SIP
|
0
|
1
|
ACCRespCntlInhibit
|
1
|
|
outsipht1
|
| |
|
|
|
ADigitCCPrefix
|
0
|
|
|
spf2
|
EISUP
|
1
|
2
|
|
|
epf1
|
|
| |
|
|
|
|
|
|
|
| |
|
|
|
|
|
|
|
Table 19 Common Profiles Worksheet Example
Profile Name
|
Type
|
Property
|
Value
|
epf1
|
Common
|
Glare
|
0
|
gpf1
|
Group
|
cgpninclude
|
1
|
| |
|
|
|
| |
|
|
|
| |
|
|
|
Table 20 Domain Profile Worksheet Example
Profile Name
|
Domain
|
Direction
|
Property
|
Value
|
dpf1
|
cisco.com
|
Inbound
|
populatesdpinfoincdr
|
1
|
dpf2
|
bt.com
|
Outbound
|
|
|
| |
|
|
|
|
| |
|
|
|
|
| |
|
|
|
|
Table 21 Trunk Group Profile Assignments Worksheet Example
Trunk Group Number
|
Profile Name
|
1
|
spf1
|
2
|
gpf1
|
| |
|
| |
|
| |
|
Table 22 SIP Header Tables Worksheet Example
Table Name
|
Type
|
Comments
|
insipht1
|
Inbound
|
|
outsipht1
|
Outbound
|
|
| |
|
|
| |
|
|
| |
|
|
Table 23 Inbound SIP Header Table Worksheet Example
Header Name
|
Index
|
Message
|
Condition
|
Treatment
|
DW1
Condition
|
DW2
Condition
|
DW3
Condition
|
DW4
Condition
|
DW1 Treatment
|
DW2 Treatment
|
DW3 Treatment
|
DW4 Treatment
|
Remote-Party_id
|
1
|
INVITE
|
2
|
4
|
User=
|
Rpi-
|
|
|
;User=phone
|
;rpi-screen=no
|
|
|
Referred-By
|
2
|
REFER
|
4
|
6
|
Pgw.cisco.com
|
Cisco.com
|
|
|
CallerDomain.com
|
Pgw.cisco.com
|
|
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
| |
|
|
|
|
|
|
|
|
|
|
|
|
Table 24 Outbound SIP Header Table Worksheet Example
Header Name
|
Index
|
Apply Policy
|
Message
|
Condition
|
Treatment
|
Condition DW1
|
Condition DW2
|
Treatment DW1
|
Treatment DW2
|
Retry-After
|
1
|
Trusted
|
503
|
2
|
5
|
Duration=
|
|
;Duration=100
|
;Reason=overload
|
Referred-By
|
2
|
ALL
|
REFER
|
2
|
6
|
CallerDomainA
|
|
CallerDomainA.com
|
PGWA.cisco.com
|
| |
|
|
|
|
|
|
|
|
|
| |
|
|
|
|
|
|
|
|
|
| |
|
|
|
|
|
|
|
|
|
Obtaining Documentation and Submitting a Service Request
For information on obtaining documentation, submitting a service request, and gathering additional information, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.
Glossary
Table 25 Acronym Expansions and Definitions
Acronym
|
Expansion
|
B2B
|
Back to back. See B2BUA.
|
B2BUA
|
A device that acts as a user agent on both ends of a call. The B2BUA handles all SIP signalling for both ends of the call and maintains state for all dialogues.
|
CDR
|
Call detail record. A record containing call information that is used in billing.
|
EISUP
|
Extended-ISUP. Originally a subset of Q.761 ISUP.
|
MGC
|
Cisco Media Gateway Controller.
|
MML
|
Man-Machine Language. Industry standard command line language used to manage telecommunications network elements, including the Cisco PGW 2200 Softswitch.
|
PGW
|
PSTN Gateway
|
SIP
|
Session Initiation Protocol. A protocol developed by the IETF MMUSIC Working Group as an alternative to H.323. SIP equips platforms to signal the setup of voice and multimedia calls over IP networks.
|
Tel: URI
|
Telephone Uniform Resource Identifier.
|
CCDE, CCENT, CCSI, Cisco Eos, Cisco HealthPresence, Cisco IronPort, the Cisco logo, Cisco Nurse Connect, Cisco Pulse, Cisco SensorBase, Cisco StackPower, Cisco StadiumVision, Cisco TelePresence, Cisco Unified Computing System, Cisco WebEx, DCE, Flip Channels, Flip for Good, Flip Mino, Flipshare (Design), Flip Ultra, Flip Video, Flip Video (Design), Instant Broadband, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn, Cisco Capital, Cisco Capital (Design), Cisco:Financed (Stylized), Cisco Store, Flip Gift Card, and One Million Acts of Green are service marks; and Access Registrar, Aironet, AllTouch, AsyncOS, Bringing the Meeting To You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Lumin, Cisco Nexus, Cisco Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, Continuum, EtherFast, EtherSwitch, Event Center, Explorer, Follow Me Browsing, GainMaker, iLYNX, IOS, iPhone, IronPort, the IronPort logo, Laser Link, LightStream, Linksys, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, PCNow, PIX, PowerKEY, PowerPanels, PowerTV, PowerTV (Design), PowerVu, Prisma, ProConnect, ROSA, SenderBase, SMARTnet, Spectrum Expert, StackWise, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc. and/or its affiliates in the United States and certain other countries.
All other trademarks mentioned in this document or website 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. (0910R)
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.
© 2008-2009 Cisco Systems, Inc. All rights reserved.
