Cisco PGW 2200 Softswitch Feature Module Document Release History Publication Date August 28, 2009 Comments Initial release of document. Feature History Release Modification 9.8(1) S5P5 The feature was introduced on the Cisco PGW 2200 Softswitch software. This document describes the feature. This feature is described in the following sections: Feature Description, page 2 Upgrading to Support This Feature, page 5 Upgrading to Support This Feature, page 5 Provisioning Tasks, page 6 Provisioning Examples, page 6 Provisioning Examples, page 6 MML Command Reference, page 9 Software Changes for This Feature, page 12 Obtaining Documentation, Obtaining Support, and Security Guidelines, page 14 Glossary, page 14 Americas Headquarters: Cisco Systems, Inc., 170 West Tasman Drive, San Jose, CA 95134-1706 USA 2009 Cisco Systems, Inc. All rights reserved.
Feature Description Cisco PGW 2200 Softswitch Feature Module Feature Description The feature enables a service provider to configure the Cisco PGW 2200 Softswitch to perform additional routing operations beyond the pre-existing manner of route selection. If you apply a generic call tag in Pre-analysis, A-number analysis, or B-number analysis, the Cisco PGW 2200 Softswitch can perform another level of route selection defined by the tag, which extends the route selection algorithms for certain calls. This feature enables you to refine route selection. When you use the feature, you influence the progression of call route selection: Dial Plan You must configure a new dial plan result called CALL_TAG, which you can configure to be present for the Pre-analysis, A-number analysis, or B-number analysis stages of routing analysis. The Cisco PGW 2200 Softswitch processes the CALL_TAG result type by associating it with a data word, in which you provide a name for a particular tag list. The identity you specify for a tag list must be an alphanumeric character string (upper/lower case) of a maximum of 32 characters. There is no limit to the number of name/value pairs (or just tags without values) that you can contain in a tag list. If you specify a tag name without a value, the Cisco PGW 2200 Softswitch supplies the default value true. Tag List Table The Cisco PGW 2200 Softswitch constructs a tag list table with which it can decide whether a particular trunk group can service a call based on the presence of a tag. By constructing a tag list table, you can blacklist (or skip) any number of trunk groups from servicing calls that bear particular tags. Routing Analysis When the Cisco PGW 2200 Softswitch reaches the point in route analysis at which it must select a trunk group to service a call, it consults the tag list table to find a trunk group that is allowed to service the call To implement the feature, you must perform the following procedures. 1. Provision the taglist 2. Provision tag/value pairs 3. Create the CALL_TAG result type associated with the taglist provisioned in step 1. 4. Associate a trunk group with the taglist provisioned in step 1. The feature enables you to use your own naming conventions to suit your location and purposes. The primary intent is to associate tags with particular trunk groups. This enables you to designate the trunk groups over which you wish to route certain calls. You can associate a tag with a trunk group to prevent the trunk group from routing a call that requires handling defined by the tag. This effectively blacklists the trunk group from routing calls of a designated type. For example, you could prevent some trunk groups from routing a call that requires fax transmission. 2
Cisco PGW 2200 Softswitch Feature Module Feature Description Example Scenario Presume that a service provider has a customer who wants to pass calling line identity (CLI) information in its call signaling to the recipient on the remote side of the telephone call. The customer makes a service level agreement (SLA) with the service provider to transmit the CLI information. In this case, the service provider must not route calls from the customer to a carrier that does not preserve the CLI field as it routes calls through its network. To fulfill its customer s requirement, the service provided must ensure that it routes such calls to a carrier that does preserve the CLI field as it routes calls through its network. In this scenario, the service provider might want to use its existing routing schemes, which can be complex and probably optimized for least cost and perhaps other routing considerations. The Generic Call Tagging feature allows a service provider to avoid the need to recreate a great many dial plans with some modifications for each customer that has a special routing requirement. The feature helps to reduce the time and cost that a service provider would need to spend to maintain numerous, complex dial plans. With, the service provider can create a tag (for example, climust ) with which it can mark all calls coming from the customer who wishes to pass the CLI field end to end. If the service provider provisions a climust tag for calls coming from the customer who requires it, the Cisco PGW 2200 Softswitch can refer to its established routing choices and exclude any trunk groups that go to a carrier that does not transfer the CLI field across its network. Figure 1 illustrates how the Cisco PGW 2200 Softswitch might use to progress through Pre-analysis, A-number analysis, and B-number analysis prior to the route selection stage to associate specific tags with existing trunk groups. In Pre-analysis, the Cisco PGW 2200 Softswitch receives a call that has the CALL_TAG result type. The Cisco PGW 2200 Softswitch retrieves a tag list that includes a TagID named Tag1 with value Value1. In A-number analysis, the Cisco PGW 2200 Softswitch collects the CALL_TAG result type and retrieves another tag list which includes a TagID named Tag2 with value Value2. In B-number analysis, the Cisco PGW 2200 Softswitch collects the CALL_TAG result type and retrieves a tag list that includes a TagID named Tag3 with value Value3. As the system progresses to routing analysis, the Cisco PGW 2200 Softswitch has saved Tag1/Value1, Tag2/Value2, and Tag3/Value3. During routing analysis, the Cisco PGW 2200 Softswitch searches its list of trunk groups, its list of TagIds, and its Tag table to eliminate the trunk groups that are unsuitable to route the call and to find the trunk groups that are suited to route the call. 3
Feature Description Cisco PGW 2200 Softswitch Feature Module Figure 1 Call_Tag Result Analysis Tag1/Value1 Pre-Analysis Tag2/Value 2 A-Analysis Tag3/Value3 B-Analysis Routing-Analysis Tag1/Value1, Tag2/Value 2, Tag3/Value3 TrunkGroup List Prepared TG45, TG76, TG81, TG93 Filter TG List TG76 Tag Tag1/Value1 Tag2/Value 2 Tag3/Value3 TrunkGroup TG45 TG81 TG93 Continue to Circuit Selection 276239 When you configure a dial plan, the first step is to create a customer group ID. Thereafter, the dial plan is identified by the customer group ID. The CALL_TAG result type is an intermediate result type. Intermediate result types do not signify the end of the analysis. It is possible that the Cisco PGW 2200 Softswitch can encounter another intermediate result type (including a recurrence of the CALL_TAG result type) further on in the analysis. The recurrence of the same result type can generate different data. In such cases, the Cisco PGW 2200 Softswitch overwrites the data recorded from the initial result type with the data provided by the subsequent encounter with the same result type. For example, if the Cisco PGW 2200 Softswitch encounters the CALL_TAG result type in B-number analysis for digit string ''876'' and the CALL_TAG result type contains Taglist1, which includes Tag1/Value1 and Tag2/Value2, the Cisco PGW 2200 Softswitch copies those tags and proceeds with the analysis. 4
Cisco PGW 2200 Softswitch Feature Module Upgrading to Support This Feature If the Cisco PGW 2200 Softswitch then encounters the CALL_TAG result type again during B-number analysis for digit string ''8765'', the result type could contain Taglist2, which includes Tag3/Value3 and Tag4/Value4. In this case, the Cisco PGW 2200 Softswitch overwrites the data it saved initially (Tag1/Value1 and Tag2/Value2) with Tag3/Value3 and Tag4/Value4. It is those tags then that are present for routing analysis. For detailed information on number analysis and result type processing, see the Cisco Media Gateway Controller Software Release 9 Dial Plan Guide. Benefits This feature provides the following benefits: Enables a service provider to configure a call tag as a routing criterion that extends the existing routing-selection functionality Enables multiple re-uses of an existing routing configuration Avoids the need to duplicate configurations excessively Related Documents This document contains information that is strictly related to this feature. The documents that contain additional information related to the Cisco PGW 2200 Softswitch are at http://www.cisco.com/en/us/products/hw/vcallcon/ps2027/tsd_products_support_series_home.html Upgrading to Support This Feature For the Cisco PGW 2200 Softswitch patch upgrade procedure refer to the Patch Upgrade Procedure for Cisco PGW 2200 Softswitch Release 9.6 and Later. To install the patch that includes the feature, download the latest patch script. Caution Before you attempt to perform the patch upgrade that includes the feature, delete the TimesTen replicator on both Cisco PGW 2200 Softswitches. Falling Back to the Previous Release Caution If you attempt to perform a fallback procedure from one patch level to a preceding patch level when the active and standby Cisco PGW 2200 softswitches are operating with different patch levels, ensure that you do not enable operation of the software replicator and TimesTen replicator. For instructions on how to disable the replicator, see the Cisco PGW 2200 Softswitch Release 9.8 Software Installation and Configuration Guide. 5
Provisioning Tasks Cisco PGW 2200 Softswitch Feature Module Provisioning Tasks Information about provisioning is available in the Cisco PGW 2200 Softswitch Release 9 Provisioning Guide in the following sections Planning for Provisioning http://www.cisco.com/en/us/partner/docs/voice_ip_comm/pgw/9/provisioning/guide/r9plnprv.ht ml MML Basics http://www.cisco.com/en/us/partner/docs/voice_ip_comm/pgw/9/provisioning/guide/r9mmlcfg. html Provisioning Examples This section provides provisioning examples for this feature. Additional provisioning examples for the Cisco MGC software can be found in the Cisco Media Gateway Controller Software Release 9 Provisioning Guide. Create Tag Lists and Tags To provision the feature you create tag lists, which you can associate with the trunk group property called CallTagList or the dialplan result type CALL_TAG. If you specify type=0 when you add a tag list, this tag list can be associated with a trunk group. If you specify type=1 when you add a tag list, this tag list can be associated with the CALL_TAG result in a dialplan. The following sample MML command adds a tag list with type 0: numan-add:taglist:name="taglist1", type="0" The following sample MML commands adds a tag named climust' with value= true to the taglist= 7000. numan-add:tag:name="climust", value="true", taglist="7000" The following sample MML command adds a tag named codec with value= G721 to taglist= 7000. numan-add:tag:name="codec", value="g721", taglist="7000" The following sample MML command adds a taglist named sipcall in the dialplan with type 1. numan-add:taglist:name="sipcall", type="1" Note Cisco recommends that you do not attempt to create more than 100,000 tags or tag lists. The numan-rtrv command can retrieve only 10,000 entries even if many more than 10,000 entries have been created. 6
Cisco PGW 2200 Softswitch Feature Module Provisioning Examples Create the CALL_TAG Result Type The following sample command shows how to add the result type CALL_TAG to the dial plan on the Cisco PGW 2200 Softswitch: numan-add:resulttable:name="tag_result", resulttype="call_tag", custgrpid="1111", setname="someresultset", dw1="taglist1" Associating a Tag List with a Trunk Group for SS7 The following sample command shows how to associate a trunk group with a tag list for SS7 calls. prov-add:trnkgrpprop:name="444", calltaglist="taglist4" Associating a Tag List with a Trunk Group for SIP The following sample command shows how to associate a trunk group with a tag list for SIP calls. prov-add:profile:name="sip-prof1", type="sipprofile", custgrpid="dp00", mgcdomain="10.0.57.158", calltaglist="taglist8" prov-add:trnkgrpprof:name="100",profile="sip-prof1" Create Two TimesTen Tables For the feature, you must provision a TagList and Tag/Value pairs into two TimesTen tables. Note If you need to use the export files taglist.dat and tagvalue.dat to delete taglists and tagvalues in the TimesTen tables, you must import the file tagvalue.dat first and then import the file taglist.dat. The Tag List Table A tag list table contains four elements taglistname(*) type blackorwhite taglistid(*) 7000 0 0 15 taglistname the taglist name type specifies whether the tag list applies for a trunk group or for a dialplan blackorwhite the value 0 is for blacklist; the value 1 is for whitelist (whitelist is for future use). Note Currently, the Cisco PGW 2200 Softswitch allows only the value 0 for blacklist. taglistid a unique tag list identifier that is used in the result table 7
Provisioning Examples Cisco PGW 2200 Softswitch Feature Module Tag List Table Example The following text represents the output from a rtrv-taglist command. < taglist102223, 0, 1, 102223 > Command> DESC Cisco.TAGLIST; Table CISCO.TAGLIST: Columns: *TAGLISTNAME CHAR (32) NOT NULL BLACKORWHITE CHAR (1) DEFAULT '0' TYPE CHAR (1) NOT NULL TAGLISTID CHAR (32) UNIQUE 1 table found. (primary key columns are indicated with *) The Tag Value Table The tag value table contains three elements. tagname(*) tagvalue(*) taglistid codec 0 <integer> tagname the name of the tag tagvalue the value assigned to the tag taglistid identifies the taglist to which the tag/value pair belongs Additional Provisioning Examples Add the property taglist: numan-add:taglist:name="sipcall", type=1 numan-add:taglist:name="trunkgrptaglist", type=0 Add a tag/value to taglist: numan-add:tag:name="codec", value="g711", taglist="sipcall" numan-add:tag:name="codec", value="g729", taglist="trunkgrptaglist" numan-ed:tag:name="routingclass", value="primum", taglist="sipcall" Add the result CALL_TAG to a dial plan: numan-add:resulttable:custgrpid="1111", setname="tagset", name="calltag", resulttype="call_tag", dw1="sipcall" Delete a taglist and tags: numan-dlt:taglist:name="sipcall", type=1 numan-dlt:tag:name="codec", value="g711", taglist="sipcall" Retrieve a taglist and tags: numan-rtrv:taglist:name= sipcall, type= 1 numan-rtrv:taglist: all numan-rtrv:tag:name= codec, value= G711 numan-rtrv:tag: all 8
Cisco PGW 2200 Softswitch Feature Module MML Command Reference MML Command Reference This section documents new, modified, or deleted Man-Machine Language (MML) commands. All other MML commands are documented in the Cisco Media Gateway Controller Software Release 9 MML Command Reference. New MML Commands This section contains the MML commands that are new for this feature. 9
MML Command Reference Cisco PGW 2200 Softswitch Feature Module NUMAN-ADD:TAGLIST (Release 9.8(1)) Purpose: Syntax: Input Output Examples: This MML command adds a tag list to a tag list table. numan-add:taglist:name="tag_list_name", type="type_value" name The name for the tag list. type The tag list type value, which specifies whether the tag list is for a trunk group or for a dialplan COMPLD Provision succeeds DENY Provision fails The MML command shown in the following example adds a new tag list to the tag list table. mml> numan-add:taglist:name="sipcall", type=1 MGC-01 - Media Gateway Controller 2009-06-23 17:33:50.277 CST M COMPLD ''taglist'' ; Comments: Performance impact category: A NUMAN-ADD:TAG (Release 9.8(1)) Purpose: Syntax: Input Output Example: This MML command adds a tag to a tag list. mml> numan-add:tag:name="tag_name", value="tag_value", taglistname="tag_list_name" name The name associated with the specified tag. value The value associated with the specified tag.mml name of a service. taglistname The tag list to which the specified tag is added. COMPLD Provision succeeds DENY Provision fails The MML command shown in the following example adds the specified tag to the specified tag list. mml> numan-add:tag:name="tag1",value="codec",taglistname="tag_list_name" MGC-01 - Media Gateway Controller 2009-06-23 17:35:34.424 CST M COMPLD ''tag'' ; Comments: Performance impact category: A 10
Cisco PGW 2200 Softswitch Feature Module MML Command Reference NUMAN-RTRV:TAGLIST (Release 9.8(1)) Purpose: Syntax: Input Output Examples: This MML command retrieves entries in the tag list table. numan-rtrv:taglist:name="tag_liat_name, type="type_value name Customer group ID. A 4-digit numeric string (enclosed in straight quotes) that identifies the dial plan. type The type value, which RTRV Retrieve succeeds DENY Retrieve fails The MML commands shown in the following examples retrieve a tag list from the tag list table: mml> numan-rtrv:taglist:name= tag_list_name,type= 0 MGC-01 - Media Gateway Controller 2009-06-23 17:36:12.723 CST M RTRV ''session=gct:taglist'' /* taglistname type taglistid ----------- ---------- -------------- tag_list_name 0 9 */ ; Comments: Performance impact category: B NUMAN-RTRV:TAG (Release 9.8(1)) Purpose: Syntax: Input Output This MML command retrieves a tag from the tag list table. numan-rtrv:tag:name="tag_name, value="tag_value name The name specified for the tag. value The value associated with the specified tag. all Displays all entries in the tag list table. RTRV Retrieve succeeds DENY Retrieve fails 11
Software Changes for This Feature Cisco PGW 2200 Softswitch Feature Module Example: The MML command shown in the following example retrieves one entry from the tag list table: mml> numan-rtrv:tag:name="tag1",value="codec" MGC-01 - Media Gateway Controller 2009-06-23 17:37:09.906 CST M RTRV ''session=gct:tag'' /* tagname tagvalue taglistid ----------- ---------- -------------------- tag1 codec 9 */ ; Comments: Performance impact category: B Software Changes for This Feature The following sections contain software changes related to this feature: Properties, page 12 Result Type Definitions, page 13 Properties This section identifies the new property associated with. For information on other properties for the Cisco PGW 2200 Softswitch software, see the Cisco Media Gateway Controller Software Release 9 Provisioning Guide. Cisco PGW 2200 Softswitch Release 9 Provisioning Guide. Table 1 presents the new trunk group property CallTagList. Table 1 Property CallTagList Trunk Group Property Definition Indicates the tag list for a specified trunk group. You define the CallTagList property by issuing an MML command. The property is saved in a TimesTen database table. Value: String (32 alpha/numeric characters) Default: NULL 12
Cisco PGW 2200 Softswitch Feature Module Software Changes for This Feature Result Type Definitions The following sample command shows how to add the result type CALL_TAG to a dial plan on the Cisco PGW 2200 Softswitch: numan-add:resulttable:name="tag_result", resulttype="call_tag", custgrpid="1111", setname="someresultset", dw1="taglist1" For the feature, a value specified for the data word (dw1) in the CALL_TAG result type names a tag list. A tag list contains tag pairs, which are formed by a tag name and a tag value. However, a tag list can contain just a tag name with the default tag value true. Table 2 shows the CALL_TAG result type and its data words. Table 2 Result Type Definition Analysis Points Result Type Valid For Result Number. Result Type Data Word 1 Data Word 2 Data Word 3 Data Word 4 Intermediate End Point A-digit analysis B-digit analysis Cause Pre-analysis 88 CALL_TAG Call tag list Reserved Reserved Reserved X X X X 13
Obtaining Documentation, Obtaining Support, and Security Guidelines Cisco PGW 2200 Softswitch Feature Module Obtaining Documentation, Obtaining Support, and Security Guidelines For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, 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 Glossary Table 3 Expansions Acronym MGC MML PGW Expansion Cisco Media Gateway Controller Machine-Man Language PSTN Gateway CCDE, CCENT, CCSI, Cisco Eos, Cisco HealthPresence, Cisco Ironport, the Cisco logo, Cisco Lumin, Cisco Nexus, Cisco Nurse Connect, Cisco Stackpower, Cisco StadiumVision, Cisco TelePresence, Cisco Unified Computing System, Cisco WebEx, DCE, Flip Channels, Flip for Good, Flip Mino, Flip Video, Flip Video (Design), Flipshare (Design), Flip Ultra, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn, Cisco Store, and Flip Gift Card are service marks; and Access Registrar, Aironet, 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 Press, Cisco Systems, Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, EtherFast, EtherSwitch, Event Center, Fast Step, Follow Me Browsing, FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iphone, iquick Study, IronPort, the IronPort logo, LightStream, Linksys, MediaTone, MeetingPlace, MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, Network Registrar, PCNow, PIX, PowerPanels, ProConnect, ScriptShare, SenderBase, SMARTnet, Spectrum Expert, StackWise, The Fastest Way to Increase Your Internet Quotient, TransPath, 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. (0907R) 14