CME Admin-Guide
Uploaded by
dondegCME Admin-Guide
Uploaded by
dondegCisco Unified Communications Manager
Express System Administrator Guide
September 29, 2010
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
Customer Order Number: OL-10663-02
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS MANUAL ARE SUBJECT TO CHANGE WITHOUT NOTICE. ALL
STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT
WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
DISCLAIMER: The use of monitoring, recording, or listening devices to eavesdrop, monitor, retrieve, or record phone conversations or other sound activities, whether or
not contemporaneous with transmission, may be illegal in certain circumstances under federal, state and/or local laws. Legal advice should be sought prior to implementing
any practice that monitors or records any phone conversation. Some laws require some form of notification to all parties to a phone conversation, such as by using a beep
tone or other notification method or requiring the consent of all parties to the phone conversation, prior to monitoring or recording the phone conversation. Some of these
laws incorporate strict penalties. In cases where local laws require a periodic beep while a conversation is being recorded, the Cisco Unity Express voice-mail system provides
a user with the option of activating "the beep." Prior to activating the Cisco Unity Express live record function, check the laws of all applicable jurisdictions. This is not legal
advice and should not take the place of obtaining legal advice from a lawyer. IN ADDITION TO THE GENERAL DISCLAIMER THAT ACCOMPANIES THIS CISCO
UNITY EXPRESS PRODUCT, CISCO ADDITIONALLY DISCLAIMS ANY AND ALL LIABILITY, BOTH CIVIL AND CRIMINAL, AND ASSUMES NO
RESPONSIBILITY FOR THE UNAUTHORIZED AND/OR ILLEGAL USE OF THIS CISCO UNITY EXPRESS PRODUCT. THIS DISCLAIMER OF LIABILITY
INCLUDES, BUT IS NOT NECESSARILY LIMITED TO, THE UNAUTHORIZED AND/OR ILLEGAL RECORDING AND MONITORING OF TELEPHONE
CONVERSATIONS IN VIOLATION OF APPLICABLE FEDERAL, STATE AND/OR LOCAL LAWS.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at
www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word partner does not imply a partnership
relationship between Cisco and any other company. (1005R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and figures included in the
document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and coincidental.
Cisco Unified Communications Manager Express System Administrator Guide
© 2007-2010 Cisco Systems, Inc. All rights reserved.
CONTENTS
Cisco Unified CME Features Roadmap 1
Cisco Unified CME Overview 17
Contents 17
Information About Cisco Unified CME 17
Cisco Unified CME Overview 18
Licenses 19
PBX or Keyswitch Model 20
Call Details Records 22
Cisco Unified CME on the Cisco 3200 Series 22
Where to Go Next 23
Additional References 23
Related Documents 23
Related Websites 25
MIBs 25
Technical Assistance 25
Obtaining Documentation, Obtaining Support, and Security Guidelines 25
Before You Begin 27
Contents 27
Prerequisites for Configuring Cisco Unified CME 27
Restrictions for Configuring Cisco Unified CME 28
Information About Planning Your Configuration 29
System Design 29
Toll Fraud Prevention 30
Configuration Methods Summary 31
Cisco Unified CME GUI 33
Workflow 34
How to Install Cisco Voice Services Hardware 37
Prerequisites 37
Installing Hardware 37
How to Install Cisco IOS Software 39
Prerequisites 39
Installing Cisco IOS Software 40
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 iii
Contents
How to Configure VLANs on a Cisco Switch 41
Using Network Assistant to Configure a Cisco Catalyst Switch 41
Using Cisco IOS Commands to Configure a Cisco Catalyst Switch 42
Configuring VLANs on an Internal Cisco Ethernet Switching Module 45
How to Configure Cisco Unified CME 46
Using Cisco IOS Commands to Create or Modify the Configuration 46
Using Cisco Unified CME GUI to Modify or Maintain Configuration 47
Feature Summary 48
Additional References 51
Related Documents 51
Technical Assistance 51
Installing and Upgrading Cisco Unified CME Software 53
Contents 53
Prerequisites for Installing Cisco Unified CME Software 53
Information About Cisco Unified CME Software 54
Basic Files 54
GUI Files 54
Phone Firmware Files 54
XML Template 56
Music-on-Hold (MOH) File 56
Script Files 56
Bundled TSP Archive 57
File Naming Conventions 57
How to Install and Upgrade Cisco Unified CME Software 57
Installing Cisco Unified CME Software 58
SCCP: Upgrading or Downgrading Phone Firmware Between Versions 59
SIP: Upgrading or Downgrading Phone Firmware Between Versions 61
SCCP: Converting Phone Firmware to SIP 65
SIP: Converting Phone to SCCP 68
SCCP: Verifying the Phone Firmware Version on an IP Phone 72
Troubleshooting Tips 73
Additional References 74
Related Documents 74
Technical Assistance 74
Defining Network Parameters 75
Contents 75
Prerequisites for Defining Network Parameters 75
Cisco Unified Communications Manager Express System Administrator Guide
iv OL-10663-02
Contents
Restrictions for Defining Network Parameters 76
Information About Defining Network Parameters 76
DHCP Service 76
Network Time Protocol for the Cisco Unified CME Router 77
DTMF Relay 77
SIP Register Support 77
Out-of-Dialog REFER 78
How to Define Network Parameters 79
Enabling Calls in Your VoIP Network 80
Defining DHCP 82
Enabling Network Time Protocol on the Cisco Unified CME Router 88
Configuring DTMF Relay for H.323 Networks in Multisite Installations 89
Configuring SIP Trunk Support 90
Verifying SIP Trunk Support Configuration 92
Changing the TFTP Address on a DHCP Server 93
Enabling OOD-R 94
Verifying OOD-R Configuration 96
Troubleshooting OOD-R 96
Configuration Examples for Network Parameters 98
NTP Server: Example 98
DTMF Relay for H.323 Networks: Example 98
OOD-R: Example 98
Where to Go Next 99
Additional References 99
Related Documents 99
Technical Assistance 99
Feature Information for Network Parameters 100
Configuring System-Level Parameters 101
Contents 101
Prerequisites for System-Level Parameters 101
Information About Configuring System-Level Parameters 102
DSCP 102
Maximum Ephones in Cisco Unified CME 4.3 and Later Versions 102
Network Time Protocol for SIP Phones 103
Per-Phone Configuration Files 103
Redundant Cisco Unified CME Router 104
Timeouts 105
IPv6 Support in Cisco Unified CME SCCP Endpoints. 105
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 v
Contents
Support for IPv4-IPv6 (Dual-Stack) 105
Media Flow Through and Flow Around 106
How to Configure System-Level Parameters 106
Configuring IP Phones in IPv4, IPv6, or Dual Stack Mode 107
Configuring IPv6 Source Address for SCCP IP Phones. 109
Verifying IPv6 and Dual-Stack Configuration on Cisco Unified CME 111
Configuring Bulk Registration 112
SCCP: Setting Up Cisco Unified CME 114
SCCP: Setting Date and Time Parameters 117
SCCP: Blocking Automatic Registration 118
SCCP: Defining Per-Phone Configuration Files and Alternate Location 119
SCCP: Changing Defaults for Timeouts 121
SCCP: Configuring a Redundant Router 123
SIP: Setting Up Cisco Unified CME 125
SIP: Setting Date and Time Parameters 127
SIP: Setting Network Time Protocol 129
SIP: Changing Session-Level Application for SIP Phones 130
Configuration Examples for System-Level Parameters 131
IPv6 Support on Cisco Unified CME: Example 132
System-Level Parameters: Example 134
Blocking Automatic Registration: Example 135
Redundant Router: Example 136
Where to Go Next 136
Additional References 136
Related Documents 136
Technical Assistance 137
Feature Information for System-Level Parameters 138
Configuring Phones to Make Basic Calls 139
Contents 139
Prerequisites for Configuring Phones to Make Basic Calls 140
Restrictions for Configuring Phones to Make Basic Calls 140
Information About Configuring Phones to Make Basic Calls 140
Phones in Cisco Unified CME 141
Directory Numbers 141
Monitor Mode for Shared Lines 147
Watch Mode for Phones 148
PSTN FXO Trunk Lines 149
Codecs for Cisco Unified CME Phones 150
Cisco Unified Communications Manager Express System Administrator Guide
vi OL-10663-02
Contents
Analog Phones 151
Secure IP Phone (IP-STE) Support 153
Remote Teleworker Phones 154
Busy Trigger and Channel Huntstop for SIP Phones 156
Digit Collection on SIP Phones 156
Session Transport Protocol for SIP Phones 157
Ephone-Type Configuration 157
How to Configure Phones for a PBX System 158
SCCP: Creating Directory Numbers 158
SCCP: Configuring Ephone-Type Templates 162
SCCP: Assigning Directory Numbers to Phones 165
SIP: Creating Directory Numbers 169
SIP: Assigning Directory Numbers to Phones 171
SIP: Configuring Dial Plans 174
SIP: Verifying Dial Plan Configuration 177
SIP: Enabling KPML 178
SIP: Selecting Session-Transport Protocol for a Phone 180
SIP: Disabling SIP Proxy Registration for a Directory Number 181
Modifying the Global Codec 183
Configuring Codecs of Individual Phones for Calls Between Local Phones 184
How to Configure Phones for a Key System 187
SCCP: Creating Directory Numbers for a Simple Key System 187
SCCP: Configuring Trunk Lines for a Key System 190
SCCP: Configuring Individual IP Phones for Key System 197
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure
IP Phone (IP-STE) 199
Configuring Cisco ATA Support 200
Verifying Cisco ATA Support 201
Troubleshooting Cisco ATA Support 201
Using Call Pickup and Group Call Pickup with Cisco ATA 203
SCCP: Enabling Auto-Configuration for Cisco VG202, VG204, and VG224 204
SCCP: Configuring Phones on SCCP Controlled Analog (FXS) Ports 206
SCCP: Verifying Analog Phone Support 209
SCCP: Enabling a Remote Phone 209
SCCP: Verifying Remote Phones 211
SCCP: Configuring Cisco IP Communicator Support 211
SCCP: Verifying Cisco IP Communicator Support 213
SCCP: Troubleshooting Cisco IP Communicator Support 213
SCCP: Configuring Secure IP Phone (IP-STE) 214
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 vii
Contents
Configuration Examples for Making Basic Calls 215
Configuring SCCP Phones for Making Basic Calls: Example 216
Configuring SIP Phones for Making Basic Calls: Example 220
Disabling a Bulk Registration for a SIP Phone: Example 223
Cisco ATA: Example 223
SCCP Analog Phone: Example 223
Remote Teleworker Phones: Example 224
Secure IP Phone (IP-STE): Example 225
Where to Go Next 225
Additional References 225
Related Documents 225
Technical Assistance 226
Feature Information for Configuring Phones to Make Basic Calls 227
Creating Phone Configurations Using Extension Assigner 229
Contents 229
Prerequisites for Extension Assigner 229
Restrictions for Extension Assigner 230
Information About Extension Assigner 230
Extension Assigner Overview 230
Files Included in this Release 234
Extension Assigner Synchronization 235
SCCP: How to Configure Extension Assigner 235
Configuring Extension Assigner 236
Configuring Extension Assigner Synchronization 249
Assigning Extension Numbers Onsite by Using Extension Assigner 251
Verifying Extension Assigner 253
Configuration Examples for Extension Assigner 254
Extension Assigner: Example 255
Extension Assigner Synchronization: Example 257
Additional References 258
Related Documents 258
Technical Assistance 258
Feature Information for Extension Assigner 259
Generating Configuration Files for Phones 261
Contents 261
Information About Configuration Files 261
Configuration Files for Phones in Cisco Unified CME 261
Cisco Unified Communications Manager Express System Administrator Guide
viii OL-10663-02
Contents
Per-Phone Configuration Files 262
How to Generate Configuration Files for Phones 263
SCCP: Generating Configuration Files for SCCP Phones 263
SCCP: Verifying Configuration Files for SCCP Phones 264
SIP: Generating Configuration Profiles for SIP Phones 265
SIP: Verifying Configuration Profiles for SIP Phones 267
Where to Go Next 270
Additional References 270
Related Documents 270
Technical Assistance 270
Resetting and Restarting Phones 271
Contents 271
Information About Resetting and Restarting Phones 271
Differences between Resetting and Restarting IP Phones 271
Cisco Unified CME TAPI Enhancement 272
How to Reset and Restart Phones 273
SCCP: Using the reset Command 273
SCCP: Using the restart Command 274
SCCP: Resetting a Session Between a TAPI Application and an SCCP Phone 276
SIP: Using the reset Command 277
SIP: Using the restart Command 278
Verifying Basic Calling 279
Additional References 280
Related Documents 280
Technical Assistance 280
Feature Information for Cisco Unified CME 7.0(1) New Features 281
Configuring Dialing Plans 283
Contents 283
Information About Dialing Plans 283
Phone Number Plan 284
Dial-Plan Patterns 285
Direct Inward Dialing Trunk Lines 286
Voice Translation Rules and Profiles 286
Secondary Dial Tone 286
How to Configure Dialing Plans 287
SCCP: Configuring Dial-Plan Patterns 287
SIP: Configuring Dial-Plan Patterns 288
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 ix
Contents
Verifying Dial-Plan Patterns 290
Defining Voice Translation Rules in Cisco CME 3.2 and Later Versions 291
SCCP: Applying Voice Translation Rules in Cisco CME 3.2 and Later Versions 293
SCCP: Applying Translation Rules Before Cisco CME 3.2 294
SIP: Applying Voice Translation Rules in Cisco Unified CME 4.1 and Later 296
SIP: Applying Voice Translation Rules before Cisco Unified CME 4.1 297
Verifying Voice Translation Rules and Profiles 298
Activating a Secondary Dial Tone 299
Configuration Examples for Dialing Plan Features 300
Secondary Dial Tone: Example 300
Voice Translation Rules: Example 301
Additional References 302
Related Documents 302
Technical Assistance 302
Feature Information for Dialing Plan Features 303
Configuring Localization Support 305
Contents 305
Information About Localization 305
System-Defined Locales 306
User-Defined Locales 306
Localization Support for Phone Displays 306
Multiple Locales 307
Locale Installer 307
SCCP: How to Configure Localization Support 308
Installing System-Defined Locales for Cisco Unified IP Phone 7906, 7911, 7921, 7931,7941, 7961,
7970, 7971, and Cisco IP Communicator 308
Installing User-Defined Locales 311
Using the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions 314
Verifying User-Defined Locales 317
Configuring Multiple Locales 317
Verifying Multiple Locales 320
Configuration Examples for Localization 321
Multiple User and Network Locales: Example 321
User-Defined Locales: Example 322
Locale Installer: Examples 323
Where to Go Next 325
Additional References 326
Related Documents 326
Cisco Unified Communications Manager Express System Administrator Guide
x OL-10663-02
Contents
Technical Assistance 326
Feature Information for Localization Support 327
Configuring Transcoding Resources 329
Contents 329
Prerequisites for Configuring Transcoding Resources 329
Restrictions for Configuring Transcoding Resources 330
Information About Transcoding Resources 330
Transcoding Support 330
Transcoding When a Remote Phone Uses G.729r8 333
Secure DSP Farm Transcoding 334
How to Configure Transcoding Resources 334
Determining DSP Resource Requirements for Transcoding 335
Provisioning Network Modules or PVDMs for Transcoding 335
Configuring DSP Farms for NM-HDs and NM-HDV2s 336
Configuring DSP Farms for NM-HDVs 341
Configuring the Cisco Unified CME Router to Act as the DSP Farm Host 343
Modifying DSP Farms for NM-HDVs After Upgrading Cisco IOS Software 346
Modifying the Number of Transcoding Sessions for NM-HDVs 347
Tuning DSP-Farm Performance on an NM-HDV 348
Verifying DSP Farm Operation 349
Registering the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode 353
Configuration Examples for Transcoding Resources 363
DSP Farms for NM-HDVs: Example 363
DSP Farms for NM-HDs and NM-HDV2s: Example 363
Cisco Unified CME Router as the DSP Farm Host: Example 364
Where to go Next 364
Additional References 364
Related Documents 364
Technical Assistance 365
Feature Information for Transcoding Resources 366
Configuring Toll Fraud Prevention 367
Finding Feature Information 367
Contents 367
Prerequisites for Configuring Toll Fraud Prevention 368
Information About Toll Fraud Prevention 368
How to Configure Toll Fraud Prevention 370
Configuring IP Address Trusted Authentication for Incoming VoIP Calls 370
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xi
Contents
Adding Valid IP Addresses For Incoming VoIP Calls 373
Configuring Direct Inward Dial for Incoming ISDN Calls 375
Blocking Secondary Dialtone on Analog and Digital FXO Ports 377
Troubleshooting Tips for Toll Fraud Prevention 378
Additional References 380
Related Documents 380
Standards 380
MIBs 381
RFCs 381
Technical Assistance 381
Feature Information for Toll Fraud Prevention 382
Enabling the GUI 383
Contents 383
Prerequisites for Enabling the GUI 383
Restrictions for Enabling the GUI 384
Information About Enabling the GUI 384
Cisco Unified CME GUI Support 384
AAA Authentication 385
How to Enable the GUI 385
Enabling the HTTP Server 385
Enabling GUI Access for the System Administrator 387
Accessing the Cisco Unified CME GUI 389
Creating a Customized XML File for Customer Administrator GUI 390
Enabling GUI Access for Customer Administrators 391
Enabling GUI Access for Phone Users 393
Troubleshooting the Cisco Unified CME GUI 395
Configuration Examples for Enabling the GUI 395
HTTP and Account Configuration: Example 395
XML Configuration File Template: Example 395
XML Configuration File: Example 396
Additional References 398
Related Documents 398
Technical Assistance 398
Feature Information for Enabling the GUI 399
Integrating Voice Mail 401
Contents 401
Prerequisites 401
Cisco Unified Communications Manager Express System Administrator Guide
xii OL-10663-02
Contents
Information About Voice-Mail Integration 403
Cisco Unity Connection Integration 403
Cisco Unity Express Integration 403
Cisco Unity Integration 404
DTMF Integration for Legacy Voice-Mail Applications 404
Mailbox Selection Policy 404
RFC 2833 DTMF MTP Passthrough 405
MWI Line Selection 405
AMWI 405
SIP MWI Prefix Specification 406
SIP MWI - QSIG Translation 406
VMWI 407
Transfer to Voice Mail 408
Live Record 408
Cisco Unity Express AXL Enhancement 408
How to Configure Voice-Mail Integration 409
SCCP: Configuring a Voice Mailbox Pilot Number 409
SCCP: Configuring a Mailbox Selection Policy 410
SCCP: Enabling Transfer to Voice Mail 414
SCCP: Configuring Live Record 417
SIP: Configuring a Voice Mailbox Pilot Number 420
Enabling DTMF Integration 422
SCCP: Configuring a Phone for MWI Outcall 429
SIP: Enabling MWI at the System-Level 431
SIP: Configuring a Directory Number for MWI 432
Enabling SIP MWI Prefix Specification 435
SIP: Configuring VMWI 436
Verifying Voice-Mail Integration 438
Configuration Examples for Voice-Mail Integration 438
Mailbox Selection Policy for SCCP Phones: Example 439
Voice Mailbox for SIP Phones: Example 439
DTMF Integration Using RFC 2833: Example 439
DTMF Integration Using SIP Notify: Example 439
DTMF Integration for Legacy Voice-Mail Applications: Example 440
SCCP Phone Line for MWI: Example 440
SIP MWI Prefix Specification: Example 441
SIP Directory Number for MWI Outcall: Example 441
SIP Directory Number for MWI Unsolicited Notify: Example 441
SIP Directory Number for MWI Subscribe/NOTIFY: Example 441
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xiii
Contents
Additional References 442
Related Documents 442
Technical Assistance 442
Feature Information for Voice-Mail Integration 443
Configuring Security 445
Contents 445
Prerequisites for Security 446
Restrictions for Security 446
Information About Security 447
Phone Authentication Overview 447
Public Key Infrastructure 448
Phone Authentication Components 449
Phone Authentication Process 452
Startup Messages 453
Configuration File Maintenance 453
CTL File Maintenance 453
CTL Client and Provider 454
Manually Importing MIC Root Certificate 454
Feature Design of Media Encryption 454
Secure Cisco Unified CME 455
Secure Supplementary Services 456
Secure Transcoding for Remote Phones with DSP Farm Transcoding Configured 457
Secure Cisco Unified CME with Cisco Unity Express 458
Secure Cisco Unified CME with Cisco Unity 458
How to Configure Security 459
Configuring the Cisco IOS Certification Authority 459
Obtaining Certificates for Server Functions 463
Configuring Telephony-Service Security Parameters 466
Configuring the CTL Client 468
Configuring the CAPF Server 473
Configuring Ephone Security Parameters 477
What to Do Next 480
Configuring the CTL Provider 480
Configuring the Registration Authority 483
Entering the Authentication String on the Phone 486
Manually Importing the MIC Root Certificate 487
Configuring Media Encryption (SRTP) in Cisco Unified CME 490
What to Do Next 492
Cisco Unified Communications Manager Express System Administrator Guide
xiv OL-10663-02
Contents
Configuring Cisco Unified CME SRTP Fallback for H.323 Dial Peers 492
Configuring Cisco Unity for Secure Cisco Unified CME Operation 494
Configuration Examples for Security 497
Cisco IOS CA: Example 497
Manually Importing MIC Root Certificate on the Cisco Unified CME Router: Example 498
Telephony-Service Security Parameters: Example 500
CTL Client Running on Cisco Unified CME Router: Example 500
Secure Cisco Unified CME: Example 504
Where to Go Next 511
Additional References 512
Related Documents 512
Technical Assistance 512
Feature Information for Security 513
Configuring Automatic Line Selection 515
Contents 515
Information About Automatic Line Selection 515
Automatic Line Selection for Incoming and Outgoing Calls 515
How to Configure Automatic Line Selection 516
SCCP: Enabling Automatic Line Selection 516
Verifying Automatic Line Selection 518
Configuration Examples for Automatic Line Selection 518
Automatic Line Selection: Example 518
Additional References 519
Related Documents 519
Technical Assistance 519
Feature Information for Automatic Line Selection 520
Configuring Barge and Privacy 521
Contents 521
Information About Barge and Privacy 521
Barge and cBarge 521
Privacy and Privacy on Hold 523
How to Configure Barge and Privacy 524
SCCP: Configuring the cBarge Soft Key 524
SIP: Enabling Barge and cBarge Soft Keys 526
SCCP: Enabling Privacy and Privacy on Hold 528
SIP: Enabling Privacy and Privacy on Hold 531
Additional References 534
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xv
Contents
Related Documents 534
Technical Assistance 534
Feature Information for Barge and Privacy 535
Configuring Call Blocking 537
Contents 537
Information About Call Blocking 537
Call Blocking Based on Date and Time (After-Hours Toll Bar) 537
Call Blocking Override 538
Class of Restriction 539
How to Configure Call Blocking 539
Configuring Call Blocking 539
Configuring Call Blocking Exemption for a Dial Peer 542
SCCP: Configuring Call Blocking Override for All Phones 543
SCCP: Configuring Call Blocking Exemption for an Individual Phone 544
SIP: Configuring Call Blocking Exemption for an Individual Phone or Directory Number 545
Verifying Call Blocking Configuration 546
SCCP: Applying Class of Restriction to a Directory Number 547
SIP: Applying Class of Restriction to Directory Number 548
Verifying Class of Restriction 549
Configuration Examples for Call Blocking 551
Call Blocking: Example 551
Class of Restriction: Example 551
Where to Go Next 552
Additional References 553
Related Documents 553
Technical Assistance 553
Feature Information for Call Blocking 554
Configuring Call Park 555
Contents 555
Information About Call Park 555
Call Park Enhancements in Cisco Unified CME 7.1 556
Basic Call Park 556
Directed Call Park 558
Park Reservation Groups 558
Dedicated Call-Park Slots 558
Call-Park Blocking 560
Call-Park Redirect 560
Cisco Unified Communications Manager Express System Administrator Guide
xvi OL-10663-02
Contents
How to Configure Call Park 561
Enabling Call Park or Directed Call Park 561
Verifying Call Park 566
Troubleshooting Call Park 567
Configuration Examples for Call Park 567
Basic Call Park: Example 567
Phone Blocked From Using Call Park: Example 568
Call-Park Redirect: Example 568
Where to Go Next 568
Additional References 569
Related Documents 569
Technical Assistance 570
Feature Information for Call Park 571
Call Restriction Regulations 573
Finding Feature Information 573
Contents 573
Prerequisites for LPCOR 573
Information About LPCOR 574
LPCOR Overview 574
LPCOR Policy and Resource Groups 575
How LPCOR Policies are Associated with Resource Groups 576
LPCOR Support for Supplementary Services 578
Phone Display and Warning Tone for LPCOR 580
LPCOR VSAs 581
How to Configure LPCOR 581
Defining a LPCOR Policy 581
Associating a LPCOR Policy with Analog Phone or PSTN Trunk Calls 584
Associating a LPCOR Policy with VoIP Trunk Calls 587
Associating a LPCOR Policy with IP Phone or SCCP FXS Phone Calls 590
Associating LPCOR with Mobile Phone Calls 594
Verifying LPCOR Configuration 598
Configuration Examples for LPCOR 599
LPCOR for Cisco Unified CME: Example 599
Cisco 3800 Series Integrated Services Router: Example 602
Additional References 610
Related Documents 610
Standards 610
MIBs 610
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xvii
Contents
RFCs 610
Technical Assistance 611
Feature Information for LPCOR 612
Configuring Call Transfer and Forwarding 613
Contents 613
Information About Call Transfer and Forwarding 613
Call Forwarding 614
B2BUA Call Forwarding for SIP Devices 615
Call Forward All Synchronization for SIP Phones 615
Call Transfer 616
H.450.2 and H.450.3 Support 618
Transfer Method Recommendations by Cisco Unified CME Version 621
H.450.12 Support 622
Hairpin Call Routing 622
H.450 Tandem Gateways 625
Dial Peers 627
QSIG Supplementary Services 627
Disabling SIP Supplementary Services for Call Forward and Call Transfer 628
Typical Network Scenarios for Call Transfer and Call Forwarding 629
How to Configure Call Transfer and Forwarding 632
Enabling Call Transfer and Forwarding at System-Level 633
SCCP: Enabling Call Forwarding for a Directory Number 638
SCCP: Enabling Call Transfer for a Directory Number 641
SCCP: Configuring Call Transfer Options for Phones 642
SCCP: Verifying Call Transfer 644
Enabling H.450.12 Capabilities 645
Enabling H.323-to-H.323 Connection Capabilities 647
Forwarding Calls Using Local Hairpin Routing 649
Enabling H.450.7 and QSIG Supplementary Services at a System-Level 651
Enabling H.450.7 and QSIG Supplementary Services on a Dial Peer 652
Disabling SIP Supplementary Services for Call Forward and Call Transfer 654
Enabling Interworking with Cisco Unified Communications Manager 656
SIP: Configuring SIP-to-SIP Phone Call Forwarding 662
SIP: Configuring Call-Forwarding-All Soft Key URI 665
SIP: Specifying Number of 3XX Responses To be Handled 666
SIP: Configuring Call Transfer 667
Configuration Examples for Call Transfer and Forwarding 669
H.450.2 and H.450.3: Example 669
Basic Call Forwarding: Example 669
Cisco Unified Communications Manager Express System Administrator Guide
xviii OL-10663-02
Contents
Call Forwarding Blocked for Local Calls: Example 670
Selective Call Forwarding: Example 670
Call Transfer: Example 670
Call-Transfer Recall: Example 671
H.450.12: Example 671
H.450.7 and QSIG Supplementary Services: Example 671
Cisco Unified CME and Cisco Unified Communications Manager in Same Network: Example 672
H.450 Tandem Gateway Working with Cisco Unified CME and
Cisco Unified Communications Manager: Example 674
Forwarding Calls to Cisco Unity Express: Example 676
Where to Go Next 676
Additional References 677
Related Documents 677
Technical Assistance 677
Feature Information for Call Transfer and Forwarding 678
Configuring Call-Coverage Features 681
Contents 681
Information About Call Coverage Features 681
Call-Coverage Summary 682
Call Hunt 683
Call Pickup 684
Call Waiting 686
Callback Busy Subscriber 687
Hunt Groups 687
Night Service 698
Overlaid Ephone-dns 700
How to Configure Call Coverage Features 704
SCCP: Configuring Call Hunt 705
SCCP: Verifying Call Hunt 706
SIP: Configuring Call Hunt 707
Enabling Call Pickup 709
SIP: Configuring GPickUp and PickUp Soft Key URIs 712
SCCP: Configuring Call-Waiting Indicator Tone 714
SCCP: Verifying Call-Waiting Indicator Tone 715
SCCP: Configuring Cancel Call Waiting 716
SIP: Enabling Call Waiting 718
SCCP: Configuring Ephone Hunt Groups 720
SCCP: Verifying Ephone Hunt Groups 726
Configuring Voice Hunt Groups 728
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xix
Contents
SCCP: Configuring Night Service 732
SCCP: Verifying Night Service 736
SCCP: Configuring Overlaid Ephone-dns 738
SCCP: Verifying Overlaid Ephone-dns 741
Configuration Examples for Call Coverage Features 742
Call Hunt: Examples 742
Call Pickup: Examples 744
Call-Waiting Beep: Example 745
Call-Waiting Ring: Example 745
Hunt Group: Examples 745
Night Service: Examples 749
Overlaid Ephone-dns Examples 750
Where to Go Next 756
Additional References 758
Related Documents 758
Technical Assistance 758
Feature Information for Call Coverage Features 759
Configuring Caller ID Blocking 763
Contents 763
Restrictions for Caller ID Blocking 763
Information about Caller ID Blocking 763
Caller ID Blocking on Outbound Calls 764
How to Configure Caller ID Blocking 764
SCCP: Blocking Caller ID For All Outbound Calls 764
SCCP: Blocking Caller ID From a Directory Number 765
Verifying Caller ID Blocking 767
Configuration Examples for Caller ID Blocking 768
Caller ID Blocking Code: Example 768
SCCP: Caller ID Blocking for Outbound Calls from a Directory Number: Example 768
Additional References 768
Related Documents 768
Technical Assistance 769
Feature Information for Caller ID Blocking 770
Configuring Conferencing 771
Contents 771
Restrictions for Conferencing 771
Information About Conferencing 772
Cisco Unified Communications Manager Express System Administrator Guide
xx OL-10663-02
Contents
Conferencing Overview 772
Conferencing with Octo-Lines 772
Secure Conferencing Limitation 772
Ad Hoc Conferencing 773
Meet-Me Conferencing in Cisco Unified CME 4.1 and Later versions 774
Meet-Me Conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0 775
How to Configure Conferencing 777
Modifying the Default Configuration for Three-Party Ad Hoc Conferencing 778
SCCP: Configuring Conferencing Options on a Phone 779
SIP: Configuring Conferencing Options on a Phone 781
Verifying Three-Party Ad Hoc Conferencing 782
SCCP: Configuring Multi-Party Ad Hoc and Meet-Me Conferencing in Cisco Unified CME 4.1 and Later
Versions 783
SCCP: Verifying Multi-Party Ad Hoc and Meet-Me Conferencing 797
SCCP: Configuring Meet-Me Conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0 797
Configuration Examples for Conferencing 805
Basic Conferencing: Example 805
End of Conference Options: Example 806
DSP Farm and Cisco Unified CME on the Same Router: Example 807
DSP Farm and Cisco Unified CME on Different Routers: Example 811
Where to Go Next 820
Additional References 821
Related Documents 821
Technical Assistance 821
Feature Information for Conferencing 822
Configuring Directory Services 823
Contents 823
Information About Directory Services 823
Local Directory 824
External Directory 824
Called-Name Display 824
Directory Search 824
How to Configure Directory Services 825
Configuring Local Directory Service 825
SCCP: Defining a Name for a Directory Number 826
SCCP: Adding an Entry to a Local Directory 827
SCCP: Configuring External Directory Service 828
SCCP: Enabling Called-Name Display 831
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xxi
Contents
Verifying Called-Name Display 832
SIP: Defining a Name for a Directory Number 833
SIP: Configuring External Directory Service 834
Verifying Directory Services 835
Configuration Examples for Directory Services 836
Local Directory 836
Called-Name Display 837
Additional References 841
Related Documents 841
Technical Assistance 841
Feature Information for Directory Services 842
Configuring Do Not Disturb 843
Contents 843
Information About Do Not Disturb 843
SCCP: Do Not Disturb 843
SIP: Do Not Disturb 844
How to Configure Do Not Disturb 845
SCCP: Blocking Do Not Disturb 845
SCCP: Verifying Do Not Disturb 847
SIP: Configuring Do Not Disturb 847
Where to Go Next 849
Additional References 850
Related Documents 850
Technical Assistance 850
Feature Information for Do Not Disturb 851
Configuring Enhanced 911 Services 853
Contents 853
Prerequisites for Enhanced 911 Services 853
Restrictions for Enhanced 911 Services 854
Information About Enhanced 911 Services 854
Overview of Enhanced 911 Services 855
Call Processing for E911 Services 857
Precautions for Mobile Phones 860
Planning Your Implementation of Enhanced 911 Services 861
Interactions with Existing Cisco Unified CME Features 863
How to Configure Enhanced 911 Services 866
Configuring the Emergency Response Location 866
Cisco Unified Communications Manager Express System Administrator Guide
xxii OL-10663-02
Contents
Configuring Locations under Emergency Response Zones 868
Configuring Outgoing Dial Peers for Enhanced 911 Services 869
Configuring a Dial Peer for Callbacks from the PSAP 871
Assigning ERLs to Phones 873
Configuring Customized Settings 877
Using the Address Command for Two ELINS 879
Enabling Call Detail Records 879
Verifying E911 Configuration 880
Troubleshooting Enhanced 911 Services 882
Error Messages 882
Configuration Examples for Enhanced 911 Services 882
Enhanced E911 Services with Cisco Unified CME 4.2: Example 882
Enhanced E911 Services with Cisco Unified CME 4.1 in SRST Fallback Mode: Example 884
Additional References 890
Related Documents 890
Technical Assistance 891
Feature Information for Enhanced 911 Services 892
Configuring Extension Mobility 893
Contents 893
Prerequisites for Configuring Extension Mobility 893
Restrictions 894
Information About Configuring Extension Mobility 894
Extension Mobility 894
Personal Speed Dials on an Extension Mobility Phone 895
Cisco Unified CME Extension Mobility Enhancements 895
Privacy on an Extension Mobility Phone 896
How to Enable Extension Mobility 896
Configuring Cisco Unified CME for Extension Mobility 896
Configuring a Logout Profile for an IP Phone 900
Enabling an IP Phone for Extension Mobility 902
Configuring a User Profile 904
Configuration Examples for Extension Mobility 907
Logout Profile: Example 907
Enabling an IP Phone for Extension Mobility: Example 908
User Profile: Example 908
Where to Go Next 908
Additional References 909
Related Documents 909
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xxiii
Contents
Technical Assistance 909
Feature Information for Extension Mobility 910
Configuring Feature Access Codes 911
Contents 911
Information About Feature Access Codes 911
Feature Access Codes 912
How to Configure Feature Access Codes 913
SCCP: Enabling Feature Access Codes 913
Verifying Feature Access Codes 914
Configuration Examples for Feature Access Codes 915
FAC: Example 915
Additional References 916
Related Documents 916
Technical Assistance 916
Feature Information for Feature Access Codes 917
Configuring Fax Relay 919
Contents 919
Prerequisites for Fax Relay 919
Restrictions for Fax Relay 920
Information About Fax Relay 920
Fax Relay and Equipment 920
Feature Design of Cisco Fax Relay 921
How to Configure Fax Relay 922
SCCP: Configuring Fax Relay 922
Verifying and Troubleshooting Fax Relay Configuration 923
Configuration Examples for Fax Relay 924
Fax Relay: Example 924
Additional References 924
Related Documents 924
Technical Assistance 925
Feature Information for Fax Relay 926
Configuring Headset Auto-Answer 927
Contents 927
Information About Headset Auto-Answer 927
Auto-Answering Calls Using a Headset 928
Difference Between a Line and a Button 928
Cisco Unified Communications Manager Express System Administrator Guide
xxiv OL-10663-02
Contents
How to Configure Headset Auto-Answer 930
SCCP: Enabling Headset Auto-Answer 930
Verifying Headset Auto-Answer 931
Configuration Examples for Headset Auto-answer 931
Additional References 932
Related Documents 932
Technical Assistance 932
Feature Information for Headset Auto-Answer 933
Configuring Intercom Lines 935
Contents 935
Information About Intercom Lines 935
Intercom Auto-Answer Lines 936
Whisper Intercom 937
How to Configure Intercom Lines 938
SCCP: Configuring an Intercom Auto-Answer Line 938
SCCP: Configuring Whisper Intercom 940
SIP: Configuring an Intercom Auto-Answer Line 942
Configuration Examples for Intercom Lines 944
Intercom Lines: Example 944
Where to Go Next 944
Additional References 945
Related Documents 945
Technical Assistance 945
Feature Information for Intercom Lines 946
Configuring Loopback Call Routing 947
Contents 947
Information About Loopback Call Routing 947
Loopback Call Routing 947
How to Configure Loopback Call Routing 948
SCCP: Enabling Loopback Call Routing 948
Verifying Loopback Call Routing 952
Configuration Examples for Loopback Call Routing 952
Enabling Loopback Call Routing: Example 952
Additional References 953
Related Documents 953
Technical Assistance 953
Feature Information for Loopback Call Routing 954
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xxv
Contents
Configuring MLPP 955
Finding Feature Information 955
Contents 955
Prerequisites for MLPP 955
Information About MLPP 956
Precedence 956
Preemption 957
DSN Dialing Format 959
MLPP Service Domains 961
MLPP Indication 962
MLPP Announcements 963
Automatic Call Diversion (Attendant Console) 964
How to Configure MLPP 965
Enabling MLPP Service Globally in Cisco Unified CME 965
Enabling MLPP Service on SCCP Phones 967
Enabling MLPP Service on Analog FXS Ports 971
Configuring an MLPP Service Domain for Outbound Dial Peers 973
Configuring MLPP Options 974
Troubleshooting MLPP Service 978
Additional References 978
Related Documents 978
Standards 979
MIBs 979
RFCs 979
Technical Assistance 979
Feature Information for MLPP 980
Configuring Music on Hold 981
Contents 981
Prerequisites for Music on Hold 981
Restrictions for Music on Hold 981
Information About Music on Hold 982
Music on Hold Summary 982
Music on Hold 983
Music on Hold from a Live Feed 983
Multicast MOH 984
Music on Hold for SIP Phones 984
Music On Hold Enhancement 985
Caching MOH Files for Enhanced System Performance 985
Cisco Unified Communications Manager Express System Administrator Guide
xxvi OL-10663-02
Contents
How to Configure Music on Hold 986
Configuring Music on Hold from an Audio File 986
Examples 989
Configuring Music on Hold from a Live Feed 989
Configuring Music on Hold Groups to Support Different Media Sources 995
Assigning a MOH Group to a Directory Number 999
Assigning a MOH Group to all Internal Calls (SCCP Only) 1001
Configuring Buffer Size for MOH Files 1002
Verifying MOH File Caching 1004
Verifying Music on Hold Group Configuration 1005
Additional References 1007
Related Documents 1007
Technical Assistance 1007
Feature Information for Music on Hold 1008
Configuring Paging 1009
Contents 1009
Information About Paging 1009
Audio Paging 1009
How to Configure Paging 1011
SCCP: Configuring a Simple Paging Group 1011
SCCP: Configuring a Combined Paging Group 1012
Verifying Paging 1015
Configuration Examples for Paging 1015
Where to Go Next 1018
Additional References 1018
Related Documents 1018
Technical Assistance 1018
Feature Information for Paging 1019
Configuring Presence Service 1021
Contents 1021
Prerequisites for Presence Service 1021
Restrictions for Presence Service 1021
Information About Presence Service 1022
Presence Service 1022
BLF Monitoring of Ephone-DNs with DnD, Call Park, Paging, and Conferencing 1024
Device-Based BLF Monitoring 1025
How to Configure Presence Service 1026
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xxvii
Contents
Enabling Presence for Internal Lines 1026
Enabling a Directory Number to be Watched 1028
SCCP: Enabling BLF Monitoring for Speed-Dials and Call Lists 1030
SIP: Enabling BLF Monitoring for Speed-Dials and Call Lists 1033
Configuring Presence to Watch External Lines 1035
Verifying Presence Configuration 1037
Troubleshooting Presence 1038
Configuration Examples for Presence 1040
Presence in Cisco Unified CME: Example 1040
Additional References 1043
Related Documents 1043
Technical Assistance 1044
Feature Information for Presence Service 1045
Configuring Ring Tones 1047
Contents 1047
Information About Ring Tones 1047
Distinctive Ringing 1048
Customized Ring Tones 1048
On-Hold Indicator 1048
How to Configure Ring Tones 1049
SCCP: Enabling Distinctive Ringing 1049
SCCP: Enabling Customized Ring Tones 1050
SCCP: Enabling On-Hold Indicator 1052
SIP: Enabling Distinctive Ringing 1053
Configuration Examples for Ring Tones 1054
Distinctive Ringing for Internal Calls: Example 1054
On-Hold Indicator: Example 1054
Additional References 1055
Related Documents 1055
Technical Assistance 1055
Feature Information for Ring Tones 1056
Configuring Single Number Reach (SNR) 1057
Contents 1057
Information About Single Number Reach 1057
Single Number Reach 1057
How to Configure Single Number Reach 1058
SCCP: Configuring Single Number Reach 1058
Cisco Unified Communications Manager Express System Administrator Guide
xxviii OL-10663-02
Contents
Additional References 1062
Related Documents 1062
Technical Assistance 1063
Feature Information for Single Number Reach 1064
Customizing Soft Keys 1065
Contents 1065
Information About Soft Keys 1065
Soft Keys on IP Phones 1066
Account Code Entry 1067
Hookflash Soft Key 1068
Feature Blocking 1068
How to Customize Soft Keys 1068
SCCP: Modifying Soft-Key Display 1069
SIP: Modifying Soft-Key Display 1072
Verifying Soft-Key Configuration 1074
Enabling Flash Soft Key 1075
Verifying Flash Soft-Key Configuration 1076
Configuring Feature Blocking 1077
Verifying Feature Blocking 1079
Configuration Examples for Soft-Keys 1079
Modifying Soft-Key Display: Example 1079
Modifying the HLog Soft Key for Ephone Hunt Groups: Example 1080
Enabling Flash Soft Key for PSTN Calls: Example 1080
Park and Transfer Blocking: Example 1080
Conference Blocking: Example 1080
Where to Go Next 1081
Additional References 1081
Related Documents 1081
Technical Assistance 1081
Feature Information for Soft Keys 1082
Configuring Speed Dial 1083
Contents 1083
Information About Speed Dial 1083
Speed Dial Summary 1084
Speed Dial Buttons and Abbreviated Dialing 1085
Bulk-Loading Speed Dial Numbers 1085
Monitor-Line Button for Speed Dial 1086
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xxix
Contents
DSS (Direct Station Select) Service 1087
Phone User-Interface for Speed Dial and Fast Dial 1087
How to Configure Speed Dial 1088
Enabling a Local Speed Dial Menu 1088
SCCP: Enabling DSS Service 1090
SCCP: Enabling a Personal Speed Dial Menu 1091
SCCP: Defining Speed-Dial Buttons and Abbreviated Dialing 1092
SCCP: Enabling Bulk-Loading Speed-Dial 1094
SCCP: Verifying Bulk Speed-Dial Parameters 1095
SCCP: Enabling User Interface for Speed-Dial and Fast-Dial 1096
SIP: Defining Speed-Dial Buttons 1097
SIP: Configuring a Personal Speed-Dial Menu 1098
Configuration Examples for Speed Dial 1100
Enabling a Local Speed Dial Menu: Example 1100
Personal Speed Dial Menu: Example 1101
Speed-Dial Buttons and Abbreviated Dialing: Example 1101
Bulk-Loading Speed Dial: Example 1101
Speed-Dial and Fast-Dial User Interface: Example 1102
Where to Go Next 1102
Additional References 1102
Related Documents 1102
Technical Assistance 1103
Feature Information for Speed Dial 1104
Configuring Video Support for SCCP-Based Endpoints 1105
Contents 1105
Prerequisites for Video Support for SCCP-Based Endpoints 1105
Restrictions for Video Support for SCCP-Based Endpoints 1106
Information About Video Support for SCCP-Based Endpoints 1107
Video Support Overview 1108
SIP Trunk Video Support for SCCP Endpoints 1108
Matching Endpoint Capabilities 1109
Retrieving Video Codec Information 1109
Call Fallback to Audio-Only 1109
Call Setup for Video Endpoints 1109
Flow of the RTP Video Stream 1110
How to Configure Video for SCCP-Based Endpoints 1111
SCCP: Enabling Support for Video Streams Across H.323 Networks 1111
SCCP: Enabling System-Level Video Capabilities 1112
Cisco Unified Communications Manager Express System Administrator Guide
xxx OL-10663-02
Contents
SCCP: Enabling Video Capabilities on a Phone 1113
Verifying Video Support for SCCP-Based Endpoints 1115
Troubleshooting Video Support for SCCP-Based Endpoints 1115
Where to Go Next 1116
Additional References 1116
Related Documents 1116
Technical Assistance 1117
Feature Information for Video Support for SCCP-Based Endpoints 1118
Modifying Cisco Unified IP Phone Options 1119
Contents 1119
Information About Cisco Unified IP Phone Options 1119
Customized Background Images for Cisco Unified IP Phone 7970 1120
Fixed Line/Feature Buttons for Cisco Unified IP Phone 7931G 1120
Header Bar Display 1120
Phone Labels 1121
Programmable Vendor Parameters for Phones 1121
Push-to-Talk 1121
System Message Display 1122
URL Provisioning for Feature Buttons 1122
How to Configure Cisco Unified IP Phone Options 1123
SCCP: Selecting Button Layout for a Cisco Unified IP Phone 7931G 1124
SCCP: Modifying Header Bar Display 1125
SIP: Modifying Header Bar Display 1127
Verifying Header Bar Display 1128
Troubleshooting Header Bar Display 1128
SCCP: Creating Labels for Directory Numbers 1129
SIP: Creating Labels for Directory Numbers 1130
Verifying Labels 1131
SCCP: Modifying System Message Display 1132
Verifying System Message Display 1133
Troubleshooting System Message Display 1133
SCCP: Provisioning URLs for Feature Buttons 1134
SIP: Provisioning URLs for Feature Buttons 1135
Troubleshooting URL Provisioning for Feature Buttons 1137
SCCP: Modifying Vendor Parameters for All Phones 1137
SCCP: Modifying Vendor Parameters For a Specific Phone 1138
Troubleshooting Vendor Parameter Configuration 1140
SCCP: Configuring One-Way Push-to-Talk on Cisco Unified Wireless IP Phones 1140
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xxxi
Contents
Configuration Examples for Cisco Unified IP Phone Options 1142
Text Labels for Ephone-dns: Example 1143
Phone Header Bar Display: Example 1143
System Text Message Display: Example 1143
System File Display: Example 1143
URL Provisioning for Directories, Services, and Messages Buttons: Example 1143
Programmable VendorConfig Parameters: Example 1144
Push-to-Talk (PTT) on Cisco Unified Wireless IP Phones in Cisco Unified CME: Example 1144
Additional References 1145
Related Documents 1145
Technical Assistance 1145
Feature Information for Cisco Unified IP Phone Options 1146
Creating Templates 1147
Contents 1147
Information About Templates 1147
Phone Templates 1147
Ephone-dn Templates 1148
How to Configure Templates 1148
SCCP: Enabling Ephone Templates 1148
SCCP: Enabling Ephone-dn Templates 1150
SCCP: Verifying Templates 1151
SIP: Creating and Applying Templates to SIP Phones 1152
Configuration Examples for Creating Templates 1154
Using Ephone Template to Block The Use of Park and Transfer Soft Keys 1154
Using Ephone-dn Template to Set Call Forwarding 1155
Where to Go Next 1155
Additional References 1155
Related Documents 1155
Technical Assistance 1156
Feature Information for Creating Templates 1157
Configuring Interoperability with Cisco Unified CCX 1159
Contents 1159
Information About Interoperability with Cisco Unified CCX 1160
How to Configure Interoperability with Cisco Unified CCX 1162
Enabling Interoperability with Cisco Unified CCX 1162
SCCP: Identifying Agent Directory Numbers in Cisco Unified CME for Session Manager 1165
Verifying Registrations and Subscriptions in Cisco Unified CME 1167
Cisco Unified Communications Manager Express System Administrator Guide
xxxii OL-10663-02
Contents
Re-creating a Session Manager in Cisco Unified CME 1167
Reconfiguring a Cisco CRS Route Point as a SIP Endpoint 1168
Configuration Examples for Interoperability with Cisco Unified CCX 1171
Where to Go Next 1180
Additional References 1181
Related Documents 1181
Technical Assistance 1181
Feature Information for Interoperability with Cisco Unified CCX 1182
Configuring CTI CSTA Protocol Suite 1183
Contents 1183
Information About CTI CSTA Protocol Suite 1184
CTI CSTA in Cisco Unified CME 1184
CTI Session 1184
Supported Services and Events 1185
How to Configure CTI CSTA Protocol Suite 1185
Enabling CTI CSTA in Cisco Unified CME 1186
Creating a Session Manager 1189
Configuring a Number or Device for CTI CSTA Operations 1191
Clearing a Session Between a CTSA Client Application and Cisco Unified CME 1195
Configuration Examples for CTII CSTA Protocol Suite 1195
MOC Client: Example 1196
CSTA Client Application Requiring a Session Manager: Example 1198
Additional References 1202
Related Documents 1202
Standards 1202
MIBs 1202
RFCs 1202
Technical Assistance 1203
Feature Information for CTI CSTA Protocol Suite 1204
Configuring SRST Fallback Mode 1205
Contents 1205
Prerequisites for SRST Fallback Mode 1205
Restrictions for SRST Fallback Mode 1206
Information About SRST Fallback Mode 1206
SRST Fallback Mode Using Cisco Unified CME 1206
Prebuilding Cisco Unified CME Phone Configurations 1210
Autoprovisioning Directory Numbers in SRST Fallback Mode 1210
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xxxiii
Contents
How to Configure SRST Fallback Mode 1210
Enabling SRST Fallback Mode 1211
Verifying SRST Fallback Mode 1214
Prebuilding Cisco Unified CME Phone Configurations 1215
Modifying Call Pickup for Fallback Support 1215
Configuration Examples for SRST Fallback Mode 1216
Enabling SRST Mode: Example 1217
Provisioning Directory Numbers for Fallback Support: Example 1218
Configuring Templates for Fallback Support: Example 1219
Enabling Hunt Groups for Fallback Support: Example 1219
Modifying Call Pickup for Fallback Support: Example 1219
Prebuilding DNs: Example 1220
Additional References 1220
Related Documents 1220
Technical Assistance 1220
Feature Information for SRST Fallback Mode 1221
Configuring VRF Support 1223
Finding Feature Information 1223
Contents 1223
Prerequisites for Configuring VRF Support 1224
Restrictions for Configuring VRF Support 1225
Information About VRF Support 1226
VRF-Aware Cisco Unified CME 1226
How to Configure VRF Support 1226
Creating VRF Groups 1227
Adding Cisco Unified CME Phones to a VRF Group 1228
Configuration Examples for Configuring VRF Support 1231
Mapping IP Address Ranges to VRF Using DHCP: Example 1231
VRF-Aware Hardware Conferencing: Example 1232
Cisco Unity Express on Global Voice VRF: Example 1233
Additional References 1233
Related Documents 1233
Standards 1233
MIBs 1234
RFCs 1234
Technical Assistance 1234
Feature Information for VRF Support 1235
Cisco Unified Communications Manager Express System Administrator Guide
xxxiv OL-10663-02
Contents
Configuring the XML API 1237
Contents 1237
Information About XML API 1237
XML API Definition 1237
XML API Provision Using IXI 1238
How to Configure XML API 1238
Defining XML Transport Parameters 1238
Defining XML Application Parameters 1240
Defining Authentication for XML Access 1241
Defining XML Event Table Parameters 1242
Troubleshooting the XML Interface 1243
Configuration Examples for XML API 1243
XML Transport Parameters: Example 1243
XML Application Parameters: Example 1243
XML Authentication: Example 1244
XML Event Table: Example 1244
Where to Go Next 1244
Additional References 1244
Related Documents 1244
Technical Assistance 1245
Feature Information for XML API 1246
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xxxv
Contents
Cisco Unified Communications Manager Express System Administrator Guide
xxxvi OL-10663-02
FEATURE MAP
Numerics BLF notification 1021
Blocking Call Transfer 616
911 Services 853 Blocking Caller ID 763
Blocking Call-Park 560
Blocking Calls Based on Date and Time 537
A Blocking Features 537, 1065
Blocking Local Directory 823
Abbreviated Dialing Speed Dial 1092 Blocking, Automatic Registration 119
Account Code Entry 1067 Bulk-Loading Speed-Dial Numbers 1084
Ad Hoc Conferencing 771 Busy Timeout 101
Adding Directory Entries 823
After-Hours Call Blocking 537
After-Hours Toll Bar 537 C
Agent Availability, Hunt Groups 694
Analog Phone Support 206 Call Blocking Based on Date and Time 537
API, XML 1237 Call Blocking Override 537
Assigning a MOH Group to a Directory Number Call Forwarding 614
999 Call Forwarding Support 613
Assigning a MOH Group to all Internal Calls 1001 Call History 22
ATA (Cisco Analog Telephone Adapters) 139 Call Hold 1047
Audio Paging 1009 Call Hunt 683
Authentication, Phone 445 Call Park 555
Auto-Answer, Headset 927 Call Pickup 684
Autoconfiguration of VG2xx 152 Call Restrictions 573
Automatic Agent Status Not-Ready, Ephone Hunt Call Transfer 613
Groups 694 Call Transfer Blocking 616
Automatic Line Selection 515 Call Transfer Recall 617
Auto-Registration Blocking 119 Call Transfer Support 613
Call Waiting 686
Call Waiting for Overlaid Ephone-dns 700
B Callback Busy Subscriber 687
Called-Name Display 823
Backup Router 101 Caller ID Blocking 763
Barge 521 Call-Park Blocking 560
Billing Records 22 Call-Park Redirect 560
Blast Hunt Group 693 Call-Waiting Beep 686
BLF for Phone 139 Call-Waiting Ring 687
BLF for Phone Line 139 Cancel Call Waiting 687
CBarge 521
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xxxvii
Index
CDRs (Call Detail Records) 22 DTMF Relay for SIP Trunks 90
Channel Huntstop 683 Dynamic Membership, Ephone Hunt Groups 694
Cisco IP Communicator 139
Cisco Unified CME TAPI Enhancement 272
Cisco Unified CME Usability Enhancement 307 E
Cisco Unity Express AXL Enhancement 401, 408
Conference Gain Control 773 Emergency Services 853
Conference Initiator Drop-Off Control 771 End-of-Conference Options 773
Conferencing 771 Enhanced 911 Services 853
Configuration Files 103, 261 Ephone Hunt Group Agent Availability Options
Configuring Buffer Size for MOH Files 1002 694
Configuring IP Phones in IPv4, IPv6, or Dual Stack Ephone Hunt Groups 687
mode 107 Ephone-dn Overview 139
Configuring IPv6 Source Address for SCCP IP Ephone-dn, Overlaid 700
Phones 109 Ephone-Type Templates 157
Configuring Music on Hold Groups to Support Dif- Extension Assigner 229
ferent Media Sources 995 Automatic Sysnchronization 229
CTI CSTA Protocol Suite 1183 Extension Mobility 893
Customized Background Images 1119 Automatic Clear Call History 895
Customizing Feature Buttons 1119 Automatic Logout 895
Privacy 896
Externally Stored Configuration Files 103, 261
D
Dedicated Call-Park Slots 558 F
Dedicated FXO Trunk Lines 139
DHCP Setup 53 FAC (feature access code) 911
Dial Plans, SIP 139 Fax Relay 919
Dial Tone, Secondary 283 Feature Blocking 1065
Dial-Peer Preference 683 Feature Buttons,URL Provisioning 1119
Differentiated Services Code Point (DSCP) 102 Feature Control 1065
Directed Call Park 558 Feature Ring 843
Directed Call Pickup 684 Files, Configuration 261
Directories 823 Fixed Line/Feature Button Set 1119
Directory Disable 823 Flash Soft Key 1065
Display Forwarding 613
Called-Name 823 Forwarding Support 613
Phone Header Bar 1119 FXO Hookflash 1065
Phone System Message 1119 FXO Lines, Dedicated 139
Distinctive Ringing 1047 FXS Ports 206
Do Not Disturb (DND) 843
DSP Farms 334
DSS (Direct Station Select) 618, 1087 G
DTMF Integration Patterns for Voice Mail 422
DTMF Relay for H.323 Networks 89 G.722-64K codec 150
Cisco Unified Communications Manager Express System Administrator Guide
xxxviii OL-10663-02
Index
Group Call Pickup 684 Line Selection, Automatic 515
Live Record 408
Local Directory 823
H Local Group Pickup 684
Locale Installer 305
Hairpin Call Routing 622 Locales, Multiple 307
Hardware-Based Conferencing 771 Locales, Network and User 305
Header Bar Display 1119 Logical Partitioning Class of Restriction 573
Headset Auto-Answer 927 Longest-Idle Ephone Hunt Groups 692
Hold 1047 Loopback Call Routing 947
Hold Notification 1048 LPCOR 573
Hookflash, FXO 1065
Hunt Groups 687
Huntstop, Channel 683 M
Mailbox Selection Policy 410
I Media Encryption 445
Meet-Me Conferencing 771
iLBC codec 150 MLPP 955
Intercom Lines 935 Monitor Mode 139
Interdigit Timeout 101 Monitor-Line Speed Dial 1086
International Languages and Tones 305 MTP (Media Termination Point) 155
Interoperability with Unified CCX 1159 Multi-party Conferencing Enhancements 771
IP-STE Phone 153 Music on Hold (MOH) 981
MWI Line Selection 401
MWI Prefix Specification for SIP Voice Mail 435
J
Join Ephone Hunt Groups 694 N
Network Locales 305
K Network Time Protocol 75, 101, 129
Night Service 698
Keep-Conference Options 773
Key System 20, 187
Keyswitch 20, 187 O
KPML 139
Octo-Line Directory Numbers 143
one-way Push-to-Talk 1119
L On-hold Notification 1048
Out-of-Dialog REFER 75
Labels, Phone 1119 Overlaid Ephone-dns 700
Languages and Tones 305 Overlaid Ephone-dns Rollover Buttons 704
Leave Ephone Hunt Groups 694
Line Selection for MWI 401
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xxxix
Index
P Ringing Timeout 101
Ringing, Distinctive 1047
Paging 1009 Rollover Buttons for Overlaid Ephone-dns 704
Parallel Hunt Groups 693
Park 555
Park Reservation Groups 558 S
PBX System 20, 158
Peer Ephone Hunt Groups 691 SCCP Controlled Analog (FXS) Ports 206
Per-Phone Configuration Files 103, 262 Secondary Dial Tone 283
Personal Speed Dial 1084 Secondary Router 101
Phone Authentication 445 Secure IP Phone 153
Phone Display Security 445
Called-Name 823 Selective Call Forwarding 614
Header Bar 1119 Sequential Ephone Hunt Groups 690
System Message 1119 Session Transport Protocol 139
Phone Feature Buttons, Customizing 1119 Shared Lines (Exclusive) 146
Phone Header Bar Display 1119 Shared Lines (SIP) 144
Phone Labels 1119 Shared-line Overlay Ephone-dns 700
Phone Screen, Customized Background Images Silent Ring 681
1119 Single Number Reach (SNR) 1057
Phone Soft Keys 1065 SIP Dial Plans 139
Phones SIP Supplementary Services, Disabling 628
Analog 139 SIP Trunks 75
Remote Teleworker 154 Soft Keys 1065
Pickup Groups 684 Software-based Conferencing 771
Presence 1021 Speed Dial
Privacy 521 Abbreviated Dialing 1092
Privacy on Hold 521 Bulk Loading 1084
Programmable Vendor Parameters 1119 Local Speed Dial 1084
PTT 1119 Monitor-Line Button 1086
Push-to-Talk 1119 Personal Speed Dial 1084
Phone User Interface 1087
Speed-Dial Buttons 1084
Q SRST Fallback Mode 1205
SRTP 445
QSIG Supplementary Services 613 System Message Display 1119
System-Defined Locales 305
R
T
Redundant Router 101
Remote Teleworker Phones 154 Tandem Gateway 625
Resetting Phones 271 Teleworker Remote Phones 154
Resetting TAPI Session 271 Timeouts 101
Restarting Phones 271 Toll Bar and Toll Bar Override 537
Cisco Unified Communications Manager Express System Administrator Guide
xl OL-10663-02
Index
Toll Fruad Prevention 30
Tone, Secondary Dial 101
Transcoding Support 329
Transfer 613
Transfer Recall 617
Transfer to Voice Mail 408
Translation Rules and Profiles 283
Trunks, SIP 75
URL Provisioning for Feature Buttons 1119
User-Defined Locales 305
Vendor Configuration Parameters 1121
Verifying MOH File Caching 1004
Verifying Music on Hold Group Configuration
1005
VG224 206
VG2xx Autoconfiguration 152
Video Support 1105
Voice Hunt Groups 687
Voice Mail Integration 401
Voice Translation Rules and Profiles 283
VRF Support on Cisco Unified CME 1223
Watch Mode 139
Whisper Intercom 937
XML Application Programming Interface 1237
XML Configuration Files 53
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 xli
Index
Cisco Unified Communications Manager Express System Administrator Guide
xlii OL-10663-02
Cisco Unified CME Features Roadmap
Last Updated: July 21, 2010
This roadmap lists the features documented in the Cisco Unified Communications Manager Express
System Administrator Guide and maps them to the modules in which they appear.
Feature and Release Support
Table 1 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature. Only features
that were introduced or modified in Cisco Unified CME 4.0 or a later version appear in the table. Not all
features may be supported in your Cisco Unified CME software version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and Cisco IOS software image
support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An account on
Cisco.com is not required.
Table 1 Supported Cisco Unified CME Features
Version Feature Name Feature Description Where Documented
Cisco Unified CME 8.1
8.1 Toll Fraud Prevention Enables Toll Fraud Prevention on Cisco Unified CME to Configuring Toll Fraud
secure the Cisco Unified CME system against potential toll Prevention
fraud exploitation by unauthorized users.
Enhancements to SIP Allows to verify SIP phone registration process, remove Cisco Unified CME
Phone Configuration global registration parameters, and display details on phones Commands: show
that attempted to register with Cisco Unified CME and fail. presence global through
subnet.
Support for Cisco Adds support for new SCCP IP phones 6901 and 6911. Ephone-Type
Unified 6901 and 6911 Parameters for
SCCP IP Phones Supported Phone Types
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
Cisco Unified CME 8.0(1)
8.0 Cancel Call Waiting Enables an SCCP phone user to disable Call Waiting for a call Configuring
they originate. Call-Coverage Features
CTI CSTA Protocol Allows computer-based CSTA client applications, such as a Configuring CTI CSTA
Suite Microsoft Office Communicator (MOC) client, to monitor Protocol Suite
and control the Cisco Unified CME system to enable
programmatic control of SCCP telephony devices registered
in Cisco Unified CME.
IPv6 Support for SCCP Adds IPv6 support for SCCP phones. SCCP Phones can Configuring IP Phones in
Endpoints interact with and support any SCCP devices that support IPv4 IPv4, IPv6, or Dual
only or both IPv4 and IPv6 (dual-stack). Stack Mode
Logical Partitioning Enables a single directory number on an IP or analog phone Call Restriction
Class of Restriction that is registered to Cisco Unified CME to connect to both Regulations
(LPCOR) PSTN and VoIP calls according to restrictions specified by
Telecom Regulatory Authority of India (TRAI) regulations.
MLPP enhancements Adds enhanced Multilevel Priority and Preemption (MLPP) Configuring MLPP
features for Cisco Unified CME including:
• Additional MLPP announcements for isolated code
(ICA), unauthorized precedence level (UPA), loss of C2
features (LOC2), and vacant code (VCA)
• Multiple service domains for the Defense Switched
Network (DSN) and Defense Red Switched Network
(DRSN)
• Route codes and service digits in dialing formats
• Support for supplementary services, such as Three-Way
Conferencing, Call Pickup, and Cancel Call Waiting on
Analog FXS ports
Music On Hold Adds support for Music on Hold from different media Configuring Music on
Enhancement sources. Hold Groups to Support
Different Media Sources
Secure IP Phone Adds support for secure IP Phone, IP-STE. Secure IP Phone
(IP-STE) Support (IP-STE) Support
Cisco Unified Communications Manager Express System Administrator Guide
2 OL-10663-02
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
Cisco Unified CME 7.1
7.1 Autoconfiguration of Allows you to automatically configure the Cisco VG202, Configuring Phones to
Cisco VG202, VG204, VG204, and VG224 Analog Phone Gateway from Make Basic Calls
and VG224 Cisco Unified CME.
Barge and cBarge for SIP Enables phone users to join a call on a SIP shared-line Configuring Barge and
phones directory number. Privacy
BLF Monitoring of Provides Busy Lamp Field (BLF) indicators for directory Configuring Presence
Ephone-DNs with DnD, numbers that becomes DND-enabled, or are configured as Service
Call Park, Paging, and call-park slots, paging numbers, or conference numbers.
Conferencing
BLF Monitoring of Supports device-based BLF monitoring, allowing a watcher to Configuring Presence
Devices monitor the status of a phone, not only a line on the phone. Service
Busy Trigger and Provides a busy trigger and channel huntstop for directory Configuring Phones to
Channel Huntstop for numbers on SIP phones to prevent incoming calls from Make Basic Calls
SIP Phones overloading the phone.
Call Park Enhancements Adds Call Park features for SIP phones and enhances the Configuring Call Park
Directed Call Park feature.
Call Pickup Adds Call Pickup features for SIP phones and enables users Configuring
Enhancements to perform Directed Call Pickup using the GPickUp soft key. Call-Coverage Features
DND Enhancement for Modifies DND behavior so that the SIP phone flashes an alert Configuring Do Not
SIP phones to visually indicate an incoming call instead of ringing and Disturb
the call can be answered if desired.
DSCP Supports Differentiated Services Code Point (DSCP) packet Configuring
marking for Cisco Unified IP phones. System-Level
Parameters
Privacy for SIP phones Enables phone users to block other users from seeing call Configuring Barge and
information or barging into a call on a SIP shared-line Privacy
directory number.
Shared-Line Directory Adds shared-line directory numbers for SIP phones. Configuring Phones to
Numbers Make Basic Calls
Single Number Reach Enables users to answer incoming calls on their desktop Configuring Single
(SNR) IP phone or at a remote destination, such as a mobile phone. Number Reach (SNR)
SIP Trunk Video Support Supports video calls between SCCP endpoints across Configuring Video
for SCCP Endpoints different Cisco Unified CME routers connected through a SIP Support for SCCP-Based
trunk. Supports H.264 codec for video calls. Endpoints
Whisper Intercom Provides a one-way voice path from the caller to the called Configuring Intercom
party, regardless of whether the called party is busy or idle. Lines
The called phone automatically answers in speakerphone
mode.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 3
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
Cisco Unified CME 7.0(1)
7.0(1) Note Cisco Unified CME 7.0 includes the same features as Cisco Unified CME 4.3,
which is renumbered to align with Cisco Unified Communications versions.
Cisco Unified CME • Enhanced load command automatically creates TFTP How to Configure
Usability Enhancement bindings if cnf location is router flash memory or router System-Level
slot 0 memory. Parameters
SCCP: Upgrading or
Downgrading Phone
Firmware Between
Versions
• Locale installer that supports a single procedure for all Configuring
SCCP IP phones. Localization Support
• Automatically creates the required TFTP aliases for
localization.
• Backward compatibility with the configuration method in
Cisco Unified CME 7.0 and earlier versions.
Cisco Unified CME Cisco IOS command that disassociates and reestablishes a Resetting and Restarting
TAPI Enhancement TAPI session that is in frozen state or out of synchronization. Phones
Cisco Unity Express Cisco Unified CME and Cisco Unity Express passwords are Integrating Voice Mail
AXL Enhancement automatically synchronized.
Cisco Unified IP Phones SCCP support was added for the following phone type: Cisco Unified
Communications
• Cisco Unified Wireless IP Phone 7925
Manager Express 7.0/4.3
Supported Firmware,
Platforms, Memory, and
Voice Products
VRF Support on Support for conferencing, transcoding, and RSVP Configuring VRF
Cisco Unified CME components in Cisco Unified CME through a VRF; also Support
allows soft phones and TAPI clients in data VRF resources to
communicate with phones in a VRF voice gateway.
Cisco Unified CME 7.0/4.3
Cisco Unified Communications Manager Express System Administrator Guide
4 OL-10663-02
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
7.0/4.3 Autoprovisioning Allows you to specify whether Cisco Unified CME in SRST Configuring SRST
Directory Numbers in Fallback mode creates octo-line or dual-line directory Fallback Mode
SRST Fallback Mode numbers for ephone-dns that are “learned” automatically
from the ephone configuration.
Barge Enables phone users to join a call on a shared octo-line Configuring Barge and
directory number by pressing the Cbarge soft key and Privacy
converting the call to an ad hoc conference.
Call Transfer Recall Enables a transferred call to return to the phone that initiated Configuring Call
the transfer if the destination does not answer. Transfer and Forwarding
Cisco 3200 Series Support for Cisco Unified CME on the Cisco 3200 Series Cisco Unified CME
Mobile Access Router Mobile Access Router was added. Overview
Cisco Unified IP Phones SCCP support was added for the following phone types: Cisco Unified
Communications
• Cisco Unified IP Phone 7915 Expansion Module
Manager Express 7.0/4.3
• Cisco Unified IP Phone 7916 Expansion Module Supported Firmware,
• Cisco Unified IP Conference Station 7937 Platforms, Memory, and
Voice Products
• Nokia E61
SIP support was added for the following phones:
• Cisco Unified IP Phone 7942G and 7945G
• Cisco Unified IP Phone 7962G and 7965G
• Cisco Unified IP Phone 7975G
Consultative Transfer Modifies the digit-collection process for consultative call Configuring Call
Enhancements transfers. After a phone user presses the Transfer soft key for Transfer and Forwarding
a consultative transfer, a new consultative call leg is created
and the Transfer soft key is not displayed again until the
dialed digits of the transfer-to number are matched to a
transfer pattern and consultative call leg is in alerting state.
Directory Search Increases the number of entries supported in a search results Configuring Directory
Enhancement list from 32 to 240 when using the directory search feature. Services
Extension Mobility Adds support for the following: Configuring Extension
Enhancement Mobility
• Automatic Logout, including:
– Configurable time-of-day timers for automatically
logging out all Extension Mobility users.
– Configurable idle-duration timer for logging out a
single user from an idle Extension Mobility phone.
• Automatic Clear Call History when a user logs out from
Extension Mobility.
Phone-Type Allows you to dynamically add a new phone type to your Configuring Phones to
Configuration configuration without upgrading your Cisco IOS software. Make Basic Calls
Live Record Enables IP phone users to record a phone conversation when Integrating Voice Mail
Cisco Unity Express is the voice mail system.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 5
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
Maximum Ephones The max-ephones command now sets the maximum number Configuring
of SCCP phones that can register to Cisco Unified CME, System-Level
without limiting the number that can be configured. This Parameters
enhancement also expands the maximum number of phones
that can be configured to 1000.
Octo-Line Directory Adds octo-line directory numbers that support up to eight Configuring Phones to
Numbers active calls, both incoming and outgoing, on a single phone Make Basic Calls
button. Unlike a dual-line directory number, an octo-line
directory number can split its channels among other phones
that share the directory number.
Privacy Enables phone users to block other users from seeing call Configuring Barge and
information or barging into a call on a shared octo-line Privacy
directory number.
Push-to-Talk Adds support for one-way Push-to-Talk (PTT) in SCCP: Configuring
Cisco Unified CME without requiring an external server to One-Way Push-to-Talk
support the functionality. PTT is supported in firmware on Cisco Unified
version 1.0.4 and later versions on Cisco Unified wireless IP Wireless IP Phones
phones with a thumb button.
Speed Dial/Fast Dial Allows IP phone users to configure their own speed-dial and Configuring Speed Dial
Phone User Interface fast-dial settings directly from the phone. Extension Mobility
users can add or modify speed-dial settings in their user
profile after logging in.
Transfer to Voice Mail Allows a phone user to transfer a caller directly to a Integrating Voice Mail
voice-mail extension by pressing the TrnsfVM soft key.
Voice Hunt-Group Supports the following Voice Hunt Group features: Configuring
Enhancements Call-Coverage Features
• Call Forwarding to a Parallel Voice Hunt-Group (Blast
Hunt Group).
• Call Transfer to a Voice Hunt-Group.
• Member of Voice Hunt-Group can be a SCCP phone, FXS
analog phone, DS0-group, PRI-group, SIP phone, or SIP
trunk.
Cisco Unified CME 4.2(1)
4.2(1) Call Blocking Adds support for selective call blocking on IP phones and Configuring Call
Enhancements PSTN trunk lines. Blocking
Extension Assigner Provides support for automatically synchronizing Creating Phone
Synchronization configuration changes to backup systems Configurations Using
Extension Assigner
Extension Mobility Allows a phone user to use a name and password from an Accessing the
Phone User support in Extension Mobility profile to log into the Cisco Unified CME Cisco Unified CME GUI
Cisco Unified CME GUI GUI for configuring personal speed dials on an Extension
Mobility phone. Extension Mobility options in the GUI
cannot be accessed from the System Administrator or
Customer Administrator login screens.
Cisco Unified Communications Manager Express System Administrator Guide
6 OL-10663-02
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
Cisco Unified CME 4.2
4.2 Enhanced 911 Services • Enables routing to the PSAP closest to the caller by Configuring Enhanced
assigning ERLs to zones. 911 Services
• Allows customizing of E911 services by defining a
default ELIN, designated number for callback, expiry
time for Last Caller table, and syslog messages for
emergency calls.
• Expands the E911 location information to include name
and address.
• Uses templates to assign ERLs to a group of phones.
• Adds permanent call detail records.
Extension Mobility Provides the benefit of phone mobility for end users by Configuring Extension
enabling the user to log into any local Cisco Unified IP phone Mobility
that is enabled for extension mobility.
Interoperability with Enables interoperability between Cisco Unified CME and Configuring
Cisco Unified Contact Cisco Customer Response Solutions (CRS) 5.0 and later Interoperability with
Center Express versions with Cisco Unified Contact Center Express Cisco Unified CCX
(Cisco UCCX) (Unified CCX), including Cisco Unified IP IVR, enhanced
call processing, device and call monitoring, and unattended
call transfers to multiple call center agents and basic
extension mobility.
Media Encryption Provides the following secure voice call capabilities: Configuring Security
(SRTP) on Cisco Unified
• Secure call control signaling and media streams in
Communications
Cisco Unified CME networks using Secure Real-Time
Manager Express
Transport Protocol (SRTP) and H.323 protocols.
• Secure supplementary services for Cisco Unified CME
networks using H.323 trunks.
• Secure Cisco VG224 Analog Phone Gateway endpoints.
Cisco Unified CME 4.1
4.1 Call Forward All When a user enables Call Forward All on a SIP phone using Configuring Call
Synchronization the CfwdAll soft key, the uniform resource identifier (URI) Transfer and Forwarding
for the service is sent to Cisco Unified CME. When Call
Forward All is configured in Cisco Unified CME, the
configuration is sent to the SIP phone which updates the
CfwdAll soft key to indicate that Call forward All is enabled.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 7
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
Cisco Unified IP Phones SCCP support was added for the following phones: Cisco Unified CME 4.1
Supported Firmware,
• Cisco Unified IP Phone 7921G
Platforms, Memory, and
• Cisco Unified IP Phone 7942G and 7945G Voice Products
• Cisco Unified IP Phone 7962G and 7965G
• Cisco Unified IP Phone 7975G
SIP support was added for the following phones:
• Cisco Unified IP Phone 3911
• Cisco Unified IP Phone 3951
• Cisco Unified IP Phone 7911G
• Cisco Unified IP Phone 7941G and 7941G-GE
• Cisco Unified IP Phone 7961G and 7961G-GE
• Cisco Unified IP Phone 7970G and 7971G-GE
No additional configuration is required for these phones.
They are supported in the appropriate Cisco IOS commands.
Directory Services Local directory and local speed dial features are supported for Configuring Directory
SIP phones. Services
Disabling SIP You can disable REFER messages for call transfers and Configuring Call
Supplementary Services redirect responses for call forwarding from being sent by Transfer and Forwarding
for Call Forward and Cisco Unified CME if a destination gateway does not support
Call Transfer supplementary services.
Disabling supplementary services is supported if all
endpoints use SCCP or all endpoints use SIP.
Enhanced 911 Services Routes callers dialing 911 to the correct location. Configuring Enhanced
for Cisco Unified CME 911 Services
in SRST Fallback Mode
KPML Key Press Markup Language (KPML) reports SIP phone users Configuring Phones to
input digit by digit to Cisco Unified CME, which performs Make Basic Calls
pattern recognition by matching a destination pattern to a dial
peer as it collects the dialed digits.
Multi-Party • Enhanced ad-hoc conferences are hardware-based and Configuring
Conferencing allow more than three parties. Conferencing
Enhancements
• Meet-me conferences consist of at least three parties
dialing a meet-me conference number.
Cisco Unified Communications Manager Express System Administrator Guide
8 OL-10663-02
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
Network Time Protocol SIP phones registered to a Cisco Unified CME router can Defining Network
synchronize to a Network Time Protocol (NTP) server, known Parameters
as the clock master.
Out-of-Dialog REFER Out-of-dialog REFER (OOD-R) allows remote applications Defining Network
to establish calls by sending a REFER message to Parameters
Cisco Unified CME without an initial INVITE. After the
REFER is sent, the remainder of the call setup is independent
of the application and the media stream does not flow through
the application.
Presence with BLF Presence supports BLF notification features for speed-dial Configuring Presence
Status buttons and directory call lists for missed calls, placed calls, Service
and received calls. SIP and SCCP phones that support BLF
speed-dial and BLF call-list features can subscribe to status
notification for internal and external directory numbers.
Restarting Phones SIP phones can be quickly reset by using the restart Resetting and Restarting
command. Phones contact the TFTP server for updated Phones
configuration information and reregister without contacting
the DHCP server.
Session Transport TCP can be used as the transport protocol for supported SIP Configuring Phones to
phones connected to Cisco Unified CME. Previously only Make Basic Calls
UDP was supported.
SIP Dial Plans Dial plans enable SIP phones to perform local digit collection Configuring Phones to
and recognize dial patterns as user input is collected. After a Make Basic Calls
pattern is recognized, the SIP phone sends an INVITE
message to Cisco Unified CME to initiate the call.
Soft Keys You can customize the display and order of soft keys that Customizing Soft Keys
appear on individual SIP phones during the connected, hold,
idle, and seized call states.
Translation Rules SIP phones in a Cisco Unified CME system support Configuring Dialing
translation rules with functionality similar to phones running Plans
SCCP. Translation rules can be applied to incoming calls for
directory numbers on a SIP phone.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 9
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
Cisco Unified CME 4.0(3)
4.0(3) AMWI Cisco Unified IP Phone 7911 and Cisco Unified IP Phone Integrating Voice Mail
7931G can be configured to receive AMWI (Audible Message
Line Indicator) and visual MWI notification from an external
voice-messaging system.
Cisco Unified IP Phones Support was added for the following phones: Cisco Unified CME
• Cisco Unified IP Phone 7906G 4.0(3) Supported
Firmware, Platforms,
• Cisco IP Unified IP Phone 7931G Memory, and Voice
Products
DSS DSS (Direct Station Select) feature allows the phone user to Configuring Speed Dial
press a single speed-dial line button to transfer an incoming
call when the call is in the connected state. This feature is
supported on all phones on which monitor line buttons for
speed dial or speed-dial line buttons are configured.
Extension Assigner Allows installation technicians to assign extension numbers Creating Phone
to phones without administrative access to Configurations Using
Cisco Unified CME, typically during the installation of new Extension Assigner
phones or the replacement of broken phones.
Fax Relay SCCP-enhanced features add support for Cisco Fax Relay and Configuring Fax Relay
Super Group 3 (SG3) to G3 fax relay. This feature allows the
fax stream between two SG3 fax machines to negotiate down
to G3 speeds (less than 14.4 kbps) allowing SG3 fax machines
to interoperate over fax relay with G3 fax machines.
Cisco Unified CME 4.0(1)
4.0(1) Call Forwarding Automatic call forwarding during night Configuring Call
service—Ephone-dns (extensions) can be designated to Transfer and Forwarding
automatically forward their calls to a specified number during
the time that night service is in effect.
Blocking call forwarding of local calls—Forwarding of
local (internal) calls from other Cisco Unified CME ephones
can be blocked. External calls will continue to be forwarded
as specified by the configuration for the ephone-dns.
Selective call forwarding—Call forwarding for busy and
no-answer ephone-dns can be applied selectively based on the
number that a caller dials for a particular ephone-dn: the
primary number, the secondary number, or either of those
numbers expanded through the use of a dial-plan pattern.
Cisco Unified Communications Manager Express System Administrator Guide
10 OL-10663-02
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
Call Park Call park blocked per ephone—Individual ephones can be Configuring Call Park
blocked from parking calls at call-park slots.
Call park redirect—You can specify that calls use the H.450
or SIP Refer method of call forwarding or transfer to park
calls and to pick up calls from park.
Dedicated call-park slots—A private call-park slot can be
configured for each ephone.
Direct pickup of parked call on monitored park slot —A
call that is parked on a monitored call-park slot can be picked
up by pressing the assigned monitor button.
Call Pickup Directed call pickup disable—The no service Configuring
directed-pickup command globally disables directed call Call-Coverage Features
pickup and changes the action of the PickUp soft key to
invoke local group pickup rather than directed call pickup.
Call Transfer Call transfer blocking—When call transfers to phones Configuring Call
outside the Cisco Unified CME system have been globally Transfer and Forwarding
enabled, you can block them for individual ephones.
Call transfer destination digits limited—When call
transfers to phones outside the Cisco Unified CME system
have been globally enabled, you can limit the number of digits
that can be dialed when transferring a call.
transfer-system command—The command default has been
changed from the blind keyword to the full-consult keyword,
making H.450.2 consultative transfer the default method.
QSIG supplementary services support—H.450
supplementary services features allow Cisco Unified CME
phones to use QSIG to interwork with PBX phones. IP phones
can use a PBX message center with proper MWI notifications.
Cisco Unified IP Phones Support was added for the following phones: Cisco Unified CME 4.0
Supported Firmware,
• Cisco Unified IP Phone 7911G
Platforms, Memory, And
• Cisco Unified IP Phone 7941G and 7941G-GE Voice Products
• Cisco Unified IP Phone 7961G and 7961G-GE
No additional configuration is required for these phones.
They are supported in the appropriate Cisco IOS commands.
Conferencing Drop last party or keep parties connected—New options Configuring
specify whether the last party that joined a conference can be Conferencing
dropped from the conference and whether the remaining two
parties should be allowed to continue their connection after
the conference initiator has left the conference.
Improved conference display—A Cisco Unified IP phone
that is connected to a three-way conference displays
“Conference.” No special configuration is required.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 11
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
Feature Access Codes Feature Access Code (FAC) support—The same FACs that Configuring Feature
are used by analog phones can be enabled for IP phones. In Access Codes
addition, standard FACs can be customized and aliases can be
created to simplify the dialing of a FAC and any additional
digits that are required to activate the feature.
Headset Auto-Answer Headset auto-answer—When the headset key on a phone is Configuring Headset
activated, lines on the phone that are specified for headset Auto-Answer
auto-answer will automatically connect to incoming calls
after playing an alerting tone to notify the phone user of the
incoming call. This feature is available on Cisco Unified IP
Phones 7940G, 7960G, 7970G, and 7971G-GE.
Hunt Groups Agent status control—Hunt group agents can put their Configuring
phones in a not-ready state to temporarily suspend the Call-Coverage Features
receiving of hunt group calls by using the HLog soft key. A
new FAC can toggle ready and not-ready state.
Automatic agent not-ready status—The criterion for
placing a hunt group agent into not-ready status (previously
called automatic logout) was changed. If an agent does not
answer the number of consecutive hunt-group calls that you
specify in the auto logout command, the agent’s ephone-dn is
put into not-ready status (logged out) and will not receive
further hunt group calls.
Call hold statistics—New fields describing the length of time
that calls spend in the hold state are in the statistical reports
for Cisco Unified CME B-ACD applications. See the
show ephone-hunt statistics command and the hunt-group
report url command in Cisco Unified CME B-ACD and Tcl
Call-Handling Applications.
Dynamic hunt group membership—Agents can join or
leave a hunt group using standard or custom FACs when
wildcard slots are configured for hunt groups and the agents’
ephone-dns are authorized to join hunt groups.
Change in hops command default—The maximum number of
hops allowed by a hunt group is automatically adjusted to
reflect the dynamically changing number of members.
Enhanced display of ephone hunt-group information—A
text string can be added to provide information in
configuration output and to display on IP phones when a
hunt-group call is ringing or answered, or when all
hunt-group members are logged out.
Local call forwarding restriction in sequential ephone
hunt groups—In sequential ephone-hunt groups, local
(internal) calls to the hunt group can be prevented from being
forwarded beyond the first ephone-dn in the hunt group.
Cisco Unified Communications Manager Express System Administrator Guide
12 OL-10663-02
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
Hunt Groups Longest-idle hunt group improvement—The from-ring Configuring
command specifies that on-hook time stamps should be Call-Coverage Features
updated when a call rings an agent and when a call is
answered by an agent.
Maximum number of agents per hunt group has increased
from 10 to 20. No special configuration is required.
Maximum number of hunt groups per Cisco Unified CME
system has increased from 10 to 100. No special configuration
is required.
No-answer timeout enhancements—No-answer timeouts in
ephone hunt groups can be set individually for each
ephone-dn in the list. A maximum cumulative no-answer
timeout can be also be set.
Restricting presentation of calls to idle or on-hook
phones—The presentation of hunt group calls can be
restricted to hunt-group members on phones that are idle or
on-hook. This enhancement considers all lines on the phone,
both members of the hunt group and nonmembers, when
restricting presentation of hunt group calls.
Return to a secondary destination in an ephone hunt
group after call park—Calls parked by hunt group agents
can be returned to a different entry point in the hunt group.
Return to transferring party on no answer in an ephone
hunt group—A call that was transferred into a hunt group
and was not answered can be returned to the party that
transferred it to the hunt group instead of being sent to voice
mail or another final destination.
Localization Multiple user locales and network locales—Up to five user Configuring
and network locales are supported. Localization Support
User-defined user locales and network locales—
User-defined locales can be added for supported phones.
Music on Hold Music on hold (MOH) for internal calls—Internal callers Configuring Music on
(those making calls between extensions in the same Hold
Cisco Unified CME system) hear music when they are on
hold or are being transferred. The mulitcast moh command
must be used to enable the flow of packets to the subnet on
which the phones are located.
Internal extensions that are connected through an analog
voice gateway or through a WAN (remote extensions) do not
hear MOH on internal calls.
The ability to disable multicast MOH per phone was
introduced, using the no multicast-moh command in ephone
or ephone-template configuration mode.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 13
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
Overlaid Ephone-dns Overlaid ephone-dns—The maximum number of overlaid Configuring
ephone-dns per ephone button has increased from 10 to 25. Call-Coverage Features
No special configuration is required.
Overlaid ephone-dn call-waiting display—The number of
waiting calls that can be displayed for overlaid ephone-dns
that have call waiting configured has been increased to six for
the Cisco IP Phone 7940G, 7941G, 7941G-GE, 7960G,
7961G, 7961G-GE, 7970G, and 7971G-GE.
The overlaid ephone-dns must be configured on the phone
using the button command and the c keyword.
Overlaid ephone-dn call overflow to other buttons—One
or more buttons can be dedicated to serve as expansion, or
overflow, buttons for another button on the same
Cisco Unified IP phone that has overlaid ephone-dns. A call
to an overlay button that is busy with an active call will roll
over to the next available expansion button.
Phone Support Cisco IP Communicator is a software-based application that Configuring Phones to
appears on a user’s computer monitor as a graphical, Make Basic Calls
display-based IP phone with a color screen, a key pad, feature
buttons, and soft keys. Cisco Unified CME supports Cisco IP
Communicator 2.0 and later versions.
Remote teleworker phone—Teleworkers can connect
remote phones over a WAN and be directly supported by
Cisco Unified CME.
Ring Tones Distinctive ringing—An extension’s ring patterns can be set Configuring Ring Tones
to distinguish among internal, external, and feature calls.
Security Cisco Unified CME phone authentication is a security Configuring Security
infrastructure for providing secure Skinny Client Control
Protocol (SCCP) signaling between Cisco Unified CME and
IP phones.
Soft keys Feature blocking—The features associated with the Customizing Soft Keys
following soft keys can be individually blocked per ephone:
CFwdAll, Confrn, GpickUp, Park, PickUp, and Trnsfer. The
soft key is not removed, but it does not function.
Soft-key control for hold state—The soft keys that are
available while a call is on hold can be modified. The
NewCall and Resume soft keys are normally available when a
phone has a call on hold, but a template can be applied to the
phone to remove these soft keys.
Speed Dial Bulk-loading of speed-dial numbers—Text files with lists Configuring Speed Dial
of speed-dial numbers can be loaded into system flash or a
URL. The files can hold up to 10,000 numbers and can be
applied to all ephones or to specific ephones.
Cisco Unified Communications Manager Express System Administrator Guide
14 OL-10663-02
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
System-Level Disabling automatic phone registration—Normally, Configuring
Parameters Cisco Unified CME allocates an ephone slot to any ephone System-Level
that connects to the system. To prevent unauthorized Parameters
registrations, the no auto-reg-ephone command prevents any
ephone from registering with Cisco Unified CME if its MAC
address is not explicitly listed in the configuration.
External storage of configuration files and per-phone
configuration files—Phone configuration files can be stored
on an external TFTP server to offload the TFTP server
function of the Cisco Unified CME router. This additional
storage space permits the use of per-phone configuration files,
which can be used to specify different user locales and
network locales for phones.
Failover to Redundant Router—Sites can be set up with a
primary and secondary Cisco Unified CME router to provide
redundant Cisco Unified CME capability. Phones
automatically register at the secondary router if the primary
router fails and later rehome to the primary router when it is
operational again.
Templates Maximum number of ephone templates that can be defined Creating Templates
has increased from 5 to 20. No special configuration is
required.
New commands available for ephone templates—Ephone
templates were previously introduced to allow system
administrators to control the display of soft keys in various
call states on individual ephones. Their role has been
expanded to allow you to define a set of ephone parameter
values that can be assigned to one or more phones in a single
step.
Ephone-dn templates are introduced to allow administrators
to easily apply sets of configured parameters to individual
ephone-dns. Up to 15 ephone-dn templates can be defined.
Video Support Video support for SCCP-based endpoints—This feature Configuring Video
adds video support to allow you to pass a video stream with a Support for SCCP-Based
voice call, between video-capable SCCP endpoints and Endpoints
between SCCP and H.323 endpoints. Through the
Cisco Unified CME router, the video-capable endpoints can
communicate with each other locally, to a remote H.323
endpoint through a gateway, or through an H.323 network.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 15
Cisco Unified CME Features Roadmap
Table 1 Supported Cisco Unified CME Features (continued)
Version Feature Name Feature Description Where Documented
Voice Mail Line-selectable MWI—Previously, the message-waiting Integrating Voice Mail
indication (MWI) lamp on a phone could only indicate when
messages were waiting for the primary number on a phone.
Now any phone line can be designated during configuration.
Mailbox selection policy for voice-mail servers—A policy
can be set for selecting the mailbox to use for calls that are
diverted one or more times within a Cisco Unified CME
system before being sent to a Cisco Unity Express,
Cisco Unity, or PBX voice-mail pilot number.
Prefix option for SIP unsolicited MWI Notify
messages—Central voice-message servers that provide
mailboxes for multiple Cisco Unified CME sites may use site
codes or prefixes to distinguish among similarly numbered
ranges of extensions at different sites.
You can specify the prefix for your site so that central mailbox
numbers are correctly converted to your extension numbers.
XML Interface XML interface enhancements—An eXtensible Markup Configuring the XML
Language (XML) application program interface (API) is API
provided to supply data from Cisco Unified CME to
management software. In Cisco Unified CME 4.0 and later
versions, all Cisco Unified CME features have XML support.
DISCLAIMER: The use of monitoring, recording, or listening devices to eavesdrop, monitor, retrieve, or record phone conversations or other sound
activities, whether or not contemporaneous with transmission, may be illegal in certain circumstances under federal, state and/or local laws. Legal
advice should be sought prior to implementing any practice that monitors or records any phone conversation. Some laws require some form of
notification to all parties to a phone conversation, such as by using a beep tone or other notification method or requiring the consent of all parties to
the phone conversation, prior to monitoring or recording the phone conversation. Some of these laws incorporate strict penalties. In cases where local
laws require a periodic beep while a conversation is being recorded, the Cisco Unity Express voice-mail system provides a user with the option of
activating “the beep.” Prior to activating the Cisco Unity Express live record function, check the laws of all applicable jurisdictions. This is not legal
advice and should not take the place of obtaining legal advice from a lawyer. IN ADDITION TO THE GENERAL DISCLAIMER THAT
ACCOMPANIES THIS CISCO UNITY EXPRESS PRODUCT, CISCO ADDITIONALLY DISCLAIMS ANY AND ALL LIABILITY, BOTH
CIVIL AND CRIMINAL, AND ASSUMES NO RESPONSIBILITY FOR THE UNAUTHORIZED AND/OR ILLEGAL USE OF THIS CISCO
UNITY EXPRESS PRODUCT. THIS DISCLAIMER OF LIABILITY INCLUDES, BUT IS NOT NECESSARILY LIMITED TO, THE
UNAUTHORIZED AND/OR ILLEGAL RECORDING AND MONITORING OF TELEPHONE CONVERSATIONS IN VIOLATION OF
APPLICABLE FEDERAL, STATE AND/OR LOCAL LAWS.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks
can be found at www.cisco.com/go/trademarks. Third party trademarks mentioned are the property of their respective owners. The use of the word
partner does not imply a partnership relationship between Cisco and any other company. (1005R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and
figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and
coincidental.
© 2007-2009 Cisco Systems, Inc. All rights reserved.
Cisco Unified Communications Manager Express System Administrator Guide
16 OL-10663-02
Cisco Unified CME Overview
Last Updated: July 11, 2008
Cisco Unified Communications Manager Express (formerly known as Cisco Unified
CallManager Express) is a call-processing application in Cisco IOS software that enables Cisco routers
to deliver key-system or hybrid PBX functionality for enterprise branch offices or small businesses.
Contents
• Information About Cisco Unified CME, page 17
• Where to Go Next, page 23
• Additional References, page 23
• Obtaining Documentation, Obtaining Support, and Security Guidelines, page 25
Information About Cisco Unified CME
To design and configure a Cisco Unified Communications Manager Express (Cisco Unified CME)
system, you should understand the following concepts:
• Cisco Unified CME Overview, page 18
• Licenses, page 19
• PBX or Keyswitch Model, page 20
• Call Details Records, page 22
• Cisco Unified CME on the Cisco 3200 Series, page 22
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 17
Cisco Unified CME Overview
Information About Cisco Unified CME
Cisco Unified CME Overview
Cisco Unified CME is a feature-rich entry-level IP telephony solution that is integrated directly into
Cisco IOS software. Cisco Unified CME allows small business customers and autonomous small
enterprise branch offices to deploy voice, data, and IP telephony on a single platform for small offices,
thereby streamlining operations and lowering network costs.
Cisco Unified CME is ideal for customers who have data connectivity requirements and also have a need
for a telephony solution in the same office. Whether offered through a service provider’s managed
services offering or purchased directly by a corporation, Cisco Unified CME offers most of the core
telephony features required in the small office, and also many advanced features not available with
traditional telephony solutions. The ability to deliver IP telephony and data routing by using a single
converged solution allows customers to optimize their operations and maintenance costs, resulting in a
very cost-effective solution that meets office needs.
A Cisco Unified CME system is extremely flexible because it is modular. A Cisco Unified CME system
consists of a router that serves as a gateway and one or more VLANs that connect IP phones and phone
devices to the router.
Figure 1 shows a typical deployment of Cisco Unified CME with several phones and devices connected
to it. The Cisco Unified CME router is connected to the public switched telephone network (PSTN). The
router can also connect to a gatekeeper and a RADIUS billing server in the same network.
Figure 1 Cisco Unified CME for the Small- and Medium-Size Office
Telephone Telephone
Fax
Cisco Unified CME router
PSTN
Cisco Unified IP phones
RADIUS
billing
IP IP IP server
146626
PCs
Gatekeeper
Cisco Unified Communications Manager Express System Administrator Guide
18 OL-10663-02
Cisco Unified CME Overview
Information About Cisco Unified CME
Figure 2 shows a branch office with several Cisco Unified IP phones connected to a
Cisco IAD2430 series router with Cisco Unified CME. The Cisco IAD2430 router is connected to a
multiservice router at a service provider office, which provides connection to the WAN and PSTN.
Figure 2 Cisco Unified CME for Service Providers
Telephone Telephone
IP
PSTN network
Fax
Voice
switch
Cisco IAD2430
Service
T1/DSL/Cable
provider
IAD V office
Cisco Unified IP phones
IP IP IP
Voice-mail
Gatekeeper server
146627
PCs
A Cisco Unified CME system uses the following basic building blocks:
• Ephone or voice register pool—A software concept that usually represents a physical telephone,
although it is also used to represent a port that connects to a voice-mail system, and provides the
ability to configure a physical phone using Cisco IOS software. Each phone can have multiple
extensions associated with it and a single extension can be assigned to multiple phones. Maximum
number of ephones and voice register pools supported in a Cisco Unified CME system is equal to
the maximum number of physical phones that can be connected to the system.
• Directory number—A software concept that represents the line that connects a voice channel to a
phone. A directory number represents a virtual voice port in the Cisco Unified CME system, so the
maximum number of directory numbers supported in Cisco Unified CME is the maximum number
of simultaneous call connections that can occur. This concept is different from the maximum number
of physical lines in a traditional telephony system.
Licenses
You must purchase a base Cisco Unified CME feature license and phone user licenses that entitle you to
use Cisco Unified CME.
Note To support H.323 call transfers and forwards to network devices that do not support the H.450 standard,
such as Cisco Unified Communications Manager, a tandem gateway is required in the network. The
tandem gateway must be running Cisco IOS release 12.3(7)T or a later release and requires the
Integrated Voice and Video Services feature license (FL-GK-NEW-xxx), which includes H.323
gatekeeper, IP-to-IP gateway, and H.450 tandem functionality.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 19
Cisco Unified CME Overview
Information About Cisco Unified CME
PBX or Keyswitch Model
When setting up a Cisco Unified CME system, you need to decide if call handling should be similar to
that of a PBX, similar to that of a keyswitch, or a hybrid of both. Cisco Unified CME provides significant
flexibility in this area, but you must have a clear understanding of the model that you choose.
PBX Model
The simplest model is the PBX model, in which most of the IP phones in your system have a single
unique extension number. Incoming PSTN calls are routed to a receptionist at an attendant console or to
an automated attendant. Phone users may be in separate offices or be geographically separated and
therefore often use the telephone to contact each other.
For this model, we recommend that you configure directory numbers as dual-lines so that each button
that appears on an IP phone can handle two concurrent calls. The phone user toggles between calls using
the blue navigation button on the phone. Dual-line directory numbers enable your configuration to
support call waiting, call transfer with consultation, and three-party conferencing (G.711 only).
Figure 3 shows a PSTN call that is received at the Cisco Unified CME router, which sends it to the
designated receptionist or automated attendant (1), which then routes it to the requested extension (2).
Figure 3 Incoming Call Using PBX Model
FXO ports
1
2
Cisco Unified CME Receptionist or
automated attendant
IP IP IP
146456
Extension Extension Extension
1001 1002 1003
For configuration information, see the “How to Configure Phones for a PBX System” section on
page 158.
Keyswitch Model
In a keyswitch system, you can set up most of your phones to have a nearly identical configuration, in
which each phone is able to answer any incoming PSTN call on any line. Phone users are generally close
to each other and seldom need to use the telephone to contact each other.
For example, a 3x3 keyswitch system has three PSTN lines shared across three telephones, such that all
three PSTN lines appear on each of the three telephones. This permits an incoming call on any PSTN
line to be directly answered by any telephone—without the aid of a receptionist, an auto-attendant
service, or the use of (expensive) DID lines. Also, the lines act as shared lines—a call can be put on hold
on one phone and resumed on another phone without invoking call transfer.
In the keyswitch model, the same directory numbers are assigned to all IP phones. When an incoming
call arrives, it rings all available IP phones. When multiple calls are present within the system at the same
time, each individual call (ringing or waiting on hold) is visible and can be directly selected by pressing
Cisco Unified Communications Manager Express System Administrator Guide
20 OL-10663-02
Cisco Unified CME Overview
Information About Cisco Unified CME
the corresponding line button on an IP phone. In this model, calls can be moved between phones simply
by putting the call on hold at one phone and selecting the call using the line button on another phone. In
a keyswitch model, the dual-line option is rarely appropriate because the PSTN lines to which the
directory numbers correspond do not themselves support dual-line configuration. Using the dual-line
option also makes configuration of call-coverage (hunting) behaviors more complex.
You configure the keyswitch model by creating a set of directory numbers that correspond one-to-one
with your PSTN lines. Then you configure your PSTN ports to route incoming calls to those ephone-dns.
The maximum number of PSTN lines that you can assign in this model can be limited by the number of
available buttons on your IP phones. If so, the overlay option may be useful for extending the number of
lines that can be accessed by a phone.
Figure 4 shows an incoming call from the PSTN (1), which is routed to extension 1001 on all three
phones (2).
Figure 4 Incoming PSTN Call Using Keyswitch Model
FXO ports
1
Cisco Unified CME
2
IP IP IP
Extension Extension Extension
1001 1001 1001
146457
1002 1002 1002
1003 1003 1003
For configuration information, see the “How to Configure Phones for a Key System” section on
page 187.
Hybrid Model
PBX and keyswitch configurations can be mixed on the same IP phone and can include both unique
per-phone extensions for PBX-style calling and shared lines for keyswitch-style call operations.
Single-line and dual-line directory numbers can be combined on the same phone.
In the simplest keyswitch deployments, individual telephones do not have private extension numbers.
Where key system telephones do have individual lines, the lines are sometimes referred to as intercoms
rather than as extensions. The term “Intercom” is derived from “internal communication;” there is no
assumption of the common “intercom press-to-talk” behavior of auto dial or auto answer in this context,
although those options may exist.
For key systems that have individual intercom (extension) lines, PSTN calls can usually be transferred
from one key system phone to another using the intercom (extension) line. When Call Transfer is invoked
in the context of a connected PSTN line, the outbound consultation call is usually placed from the
transferrer phone to the transfer-to phone using one of the phone’s intercom (extension) line buttons.
When the transferred call is connected to the transfer-to phone and the transfer is committed (the
transferrer hangs up), the intercom lines on both phones are normally released and the transfer-to call
continues in the context of the original PSTN line button (all PSTN lines are directly available on all
phones). The transferred call can be put on hold (on the PSTN line button) and then subsequently
resumed from another phone that shares that PSTN line.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 21
Cisco Unified CME Overview
Information About Cisco Unified CME
For example, you can design a 3x3 keyswitch system as shown in Figure 4 and then add another, unique
extension on each phone (Figure 5). This setup will allow each phone to have a “private” line to use to
call the other phones or to make outgoing calls.
Figure 5 Incoming PSTN Call Using Hybrid PBX-Keyswitch Model
FXO ports
1
Cisco Unified CME
2
IP IP IP
Extension Extension Extension
1001 1001 1001
1002 1002 1002
146458
1003 1003 1003
1004 1005 1006
Call Details Records
The accounting process collects accounting data for each call leg created on the Cisco voice gateway.
You can use this information for post-processing activities such as generating billing records and
network analysis. Voice gateways capture accounting data in the form of call detail records (CDRs)
containing attributes defined by Cisco. The gateway can send CDRs to a RADIUS server, syslog server,
or to a file in .csv format for storing to flash or an FTP server. For information about generating CDRs,
see CDR Accounting for Cisco IOS Voice Gateways.
Cisco Unified CME on the Cisco 3200 Series
Cisco Unified CME 4.3 and later versions support the Cisco 3200 Series Mobile Access Router.
The Cisco 3200 Series Mobile Access Router offers secure data, voice, and video communications with
seamless mobility across wireless networks independent of location or movement. This access router has
a high-performance, compact, rugged design optimized for use in vehicles in the defense, public safety,
Homeland Security, and transportation markets.
Cisco Unified CME on the Cisco 3200 Series can be deployed in sites requiring on demand network
connectivity and voice and data communications that typically do not have PSTN connectivity. The
benefits include:
• Ensures voice communications locally if the WAN link fails
• Allows greater autonomy for voice communications at remote sites
• Supports H.323 and SIP trunks
• Easily portable
For information on installing and configuring the Cisco 3200 Series Mobile Access Router, see the
Cisco 3200 Series Mobile Access Router documentation.
Cisco Unified Communications Manager Express System Administrator Guide
22 OL-10663-02
Cisco Unified CME Overview
Where to Go Next
Restrictions for Cisco 3200 Series
The Cisco 3200 Series Mobile Access Router has the following restrictions:
• Fixed flash memory
• No PSTN interfaces (FXS, E&M)
• No Advanced Integration Module (AIM)
• No digital signal processor (DSP)
• No analog interfaces
• No T1/E1/BRI digital interfaces
• MGCP is not supported
The following Cisco Unified CME features are not supported on the Cisco 3200 Series:
• SIP Phones
• Basic Automatic Call Distribution (B-ACD) and IVR applications
• Cisco Unified CME GUI
• Cisco Unified Contact Center Express (Unified CCX) integration
• Hardware Conferencing and Transcoding
• Voice Mail
To manage flash memory limitations on the Cisco 3200 Series Mobile Access Router, store phoneloads
and other files for Cisco Unified CME on an external TFTP server. Use the cnf-file location tftp
command as described in the “SCCP: Defining Per-Phone Configuration Files and Alternate Location”
section on page 119.
Where to Go Next
Before configuring Cisco Unified CME, see “Before You Begin” on page 27.
Additional References
The following sections provide references related to Cisco Unified CME.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 23
Cisco Unified CME Overview
Additional References
Related Topic Document Title
Cisco IOS voice troubleshooting • Cisco IOS Voice Troubleshooting and Monitoring Guide
Dial peers, DID, and other dialing issues • Dial Peer Configuration on Voice Gateway Routers
• Understanding One Stage and Two Stage Dialing (technical
note)
• Understanding How Inbound and Outbound Dial Peers Are
Matched on Cisco IOS Platforms (technical note)
• Using IOS Translation Rules - Creating Scalable Dial Plans for
VoIP Networks (sample configuration)
Dynamic Host Configuration Protocol (DHCP) • “DHCP” section of the Cisco IOS IP Addressing Services
Configuration Guide
Fax and modem configurations • Cisco Fax Services over IP Application Guide
FXS ports FXS Ports in H.323 Mode
• “Configuring Analog Voice Ports” section of the Cisco IOS
Voice Port Configuration Guide
• Caller ID
FXS Ports in SCCP Mode on Cisco VG 224 Analog Phone Gateway
• SCCP Controlled Analog (FXS) Ports with Supplementary
Features in Cisco IOS Gateways
• Cisco VG 224 Analog Phone Gateway data sheet
H.323 • Cisco IOS H.323 Configuration Guide
Network Time Protocol (NTP) • “Performing Basic System Management” chapter of Cisco IOS
Network Management Configuration Guide
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Public key infrastructure (PKI) • “Part 5: Implementing and Managing a PKI” in the Cisco IOS
Security Configuration Guide
SIP • Cisco IOS SIP Configuration Guide
TAPI and TSP documentation • Cisco Unified CME programming Guides
Tcl IVR and VoiceXML • Cisco IOS Tcl IVR and VoiceXML Application Guide -
12.3(14)T and later
• Default Session Application Enhancements
• Tcl IVR API Version 2.0 Programmer’s Guide
• Cisco VoiceXML Programmer’s Guide
VLAN class-of-service (COS) marking • Enterprise QoS Solution Reference Network Design Guide
Voice-mail integration • Cisco Unified CallManager Express 3.0 Integration Guide for
Cisco Unity 4.0
• Integrating Cisco CallManager Express with
Cisco Unity Express
Call detail records (CDRs) • CDR Accounting for Cisco IOS Voice Gateways
XML • XML Provisioning Guide for Cisco CME/SRST
• Cisco IP Phone Services Application Development Notes
Cisco Unified Communications Manager Express System Administrator Guide
24 OL-10663-02
Cisco Unified CME Overview
Obtaining Documentation, Obtaining Support, and Security Guidelines
Related Websites
Related Topic Title and Location
Cisco IOS configuration examples Cisco Systems Technologies website
Select a technology category and subsequent hierarchy of
subcategories, and then click Configure > Configuration
Examples and Tech Notes.
MIBs
MIBs MIBs Link
CISCO-CCME-MIB To locate and download MIBs for selected platforms, Cisco IOS
releases, and feature sets, use Cisco MIB Locator found at the
MIB CISCO-VOICE-DIAL-CONTROL-MIB
following URL:
http://www.cisco.com/go/mibs
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
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
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 25
Cisco Unified CME Overview
Obtaining Documentation, Obtaining Support, and Security Guidelines
Cisco Unified Communications Manager Express System Administrator Guide
26 OL-10663-02
Before You Begin
Last Updated: September 1, 2010
This module describes general decisions that you should make before you configure Cisco Unified
Communications Manager Express (Cisco Unified CME), information about tools for configuring
Cisco Unified CME, and the work flow for creating or modifying a telephony configuration.
Contents
• Prerequisites for Configuring Cisco Unified CME, page 27
• Restrictions for Configuring Cisco Unified CME, page 28
• Information About Planning Your Configuration, page 29
• How to Install Cisco Voice Services Hardware, page 37
• How to Install Cisco IOS Software, page 39
• How to Configure VLANs on a Cisco Switch, page 41
• How to Configure Cisco Unified CME, page 46
• Feature Summary, page 48
• Additional References, page 51
Prerequisites for Configuring Cisco Unified CME
• Base Cisco Unified CME feature license and phone user licenses that entitle you to use
Cisco Unified CME are purchased.
Note To support H.323 call transfers and forwards to network devices that do not support the H.450 standard,
such as Cisco Unified Communications Manager, a tandem gateway is required in the network. The
tandem gateway must be running Cisco IOS release 12.3(7)T or a later release and requires the
Integrated Voice and Video Services feature license (FL-GK-NEW-xxx), which includes H.323
gatekeeper, IP-to-IP gateway, and H.450 tandem functionality.
• Your IP network is operational and you can access Cisco web.
• You have a valid Cisco.com account.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 27
Before You Begin
Restrictions for Configuring Cisco Unified CME
• You have access to a TFTP server for downloading files.
• Cisco router with all recommended services hardware for Cisco Unified CME is installed. For
installation information, see the “How to Install Cisco Voice Services Hardware” section on
page 37.
• Recommended Cisco IOS IP Voice or higher image is downloaded to flash memory in the router.
– To determine which Cisco IOS software release supports the recommended Cisco Unified CME
version, see the Cisco Unified CME and Cisco IOS Software Compatibility Matrix.
– For a list of features for each Cisco IOS Software release, see the Feature Navigator.
– For installation information, see the “How to Install Cisco IOS Software” section on page 39.
• VoIP networking must be operational. For quality and security purposes, we recommend separate
virtual LANs (VLANs) for data and voice. The IP network assigned to each VLAN should be large
enough to support addresses for all nodes on that VLAN. Cisco Unified CME phones receive their
IP addresses from the voice network, whereas all other nodes such as PCs, servers, and printers
receive their IP addresses from the data network. For configuration information, see the “How to
Configure VLANs on a Cisco Switch” section on page 41.
Restrictions for Configuring Cisco Unified CME
• Cisco Unified CME cannot register as a member of a Cisco Unified Communications Manager
cluster.
• For conferencing and music on hold (MOH) support with G.729, hardware digital signal processors
(DSPs) are required for transcoding G.729 between G.711.
• After a three-way conference is established, a participant cannot use call transfer to join the
remaining conference participants to a different number.
• Cisco Unified CME does not support the following:
– CiscoWorks IP Telephony Environment Monitor (ITEM)
– Element Management System (EMS) integration
– Media Gateway Control Protocol (MGCP) on-net calls
– Java Telephony Application Programming Interface (JTAPI) applications, such as the Cisco IP
Softphone, Cisco Unified Communications Manager Auto Attendant, or Cisco Personal
Assistant
– Telephony Application Programming Interface (TAPI)
Cisco Unified CME implements only a small subset of TAPI functionality. It supports operation
of multiple independent clients (for example, one client per phone line), but not full support for
multiple-user or multiple-call handling, which is required for complex features such as
automatic call distribution (ACD) and Cisco Unified Contact Center (formerly Cisco IPCC).
Also, this TAPI version does not have direct media- and voice-handling capabilities.
Cisco Unified Communications Manager Express System Administrator Guide
28 OL-10663-02
Before You Begin
Information About Planning Your Configuration
Information About Planning Your Configuration
Before configuring Cisco Unified CME, you should understand the following concepts:
• System Design, page 29
• Toll Fraud Prevention, page 30
• Configuration Methods Summary, page 31
• Cisco Unified CME GUI, page 33
• Workflow, page 34
System Design
Traditional telephony systems are based on physical connections and are therefore limited in the types
of phone services that they can offer. Because phone configurations and directory numbers in a
Cisco Unified CME system are software entities and because the audio stream is packet-based, an almost
limitless number of combinations of phone numbers, lines, and phones can be planned and implemented.
Cisco Unified CME systems can be designed in many ways. The key is to determine the total number of
simultaneous calls you want to handle at your site and at each phone at your site, and how many different
directory numbers and phones you want to have. Even a Cisco Unified CME system has its limits,
however. Consider the following factors in your system design:
• Maximum number of phones—This number corresponds to the maximum number of devices that
can be attached. The maximum is platform- and version-dependent. To find the maximum for your
platform and version, see the appropriate Cisco CME Supported Firmware, Platforms, Memory, and
Voice Products.
• Maximum number of directory numbers—This number corresponds to the maximum number of
simultaneous call connections that can occur. The maximum is platform- and version-dependent. To
find the maximum for your platform and version, see the appropriate Cisco CME Supported
Firmware, Platforms, Memory, and Voice Products.
• Telephone number scheme—Your numbering plan may restrict the range of telephone numbers or
extension numbers that you can use. For example, if you have DID, the PSTN may assign you a
certain series of numbers.
• Maximum number of buttons per phone—You may be limited by the number of buttons and phones
that your site can use. For example, you may have two people with six-button phones to answer 20
different telephone numbers.
The flexibility of a Cisco Unified CME system is due largely to the different types of directory numbers
(DNs) that you can assign to phones in your system. By understanding types of DNs and considering
how they can be combined, you can create the complete call coverage that your business requires. For
more information about DNs, see“Configuring Phones to Make Basic Calls” on page 139.
After setting up the DNs and phones that you need, you can add optional Cisco Unified CME features
to create a telephony environment that enhances your business objectives. Cisco Unified CME systems
are able to integrate with the PSTN and with your business requirements to allow you to continue using
your existing number plans, dialing schemes, and call coverage patterns.
When creating number plans, dialing schemes, and call coverage patterns in Cisco Unified CME, there
are several factors that you must consider:
• Is there an existing PBX or Key System that you are replacing and want to emulate?
• Number of phones and phone users to be supported?
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 29
Before You Begin
Information About Planning Your Configuration
• Do you want to use single-line or dual-line DNs?
• What protocols does your voice network support?
• Which call transfer and forwarding methods must be supported?
• What existing or preferred billing method do you want to use for transferred and forwarded calls?
• Do you need to optimize network bandwidth or minimize voice delay?
Because these factors can limit your choices for some of the configuration decisions that you will make
when you create of a dialing plan, see the Cisco Unified CME Solution Reference Network Design Guide
to help you understand the effect these factors have on your Cisco Unified CME implementation.
Toll Fraud Prevention
When a Cisco router platform is installed with a voice-capable Cisco IOS software image, appropriate
features must be enabled on the platform to prevent potential toll fraud exploitation by unauthorized
users. Deploy these features on all Cisco router Unified Communications applications that process voice
calls, such as Cisco Unified Communications Manager Express (Cisco Unified CME), Cisco Survivable
Remote Site Telephony (Cisco Unified SRST), Cisco Unified Border Element, Cisco IOS-based router
and standalone analog and digital PBX and public-switched telephone network (PSTN) gateways, and
Cisco contact-center VoiceXML gateways. These features include, but are not limited to, the following:
• Disable secondary dial tone on voice ports—By default, secondary dial tone is presented on voice
ports on Cisco router gateways. Use private line automatic ringdown (PLAR) for foreign exchange
office (FXO) ports and direct-inward-dial (DID) for T1/E1 ports to prevent secondary dial tone from
being presented to inbound callers.
• Cisco router access control lists (ACLs)—Define ACLs to allow only explicitly valid sources of
calls to the router or gateway, and therefore to prevent unauthorized Session Initiation Protocol (SIP)
or H.323 calls from unknown parties to be processed and connected by the router or gateway.
• Close unused SIP and H.323 ports—If either the SIP or H.323 protocol is not used in your
deployment, close the associated protocol ports. If a Cisco voice gateway has dial peers configured
to route calls outbound to the PSTN using either time division multiplex (TDM) trunks or IP, close
the unused H.323 or SIP ports so that calls from unauthorized endpoints cannot connect calls. If the
protocols are used and the ports must remain open, use ACLs to limit access to legitimate sources.
• Change SIP port 5060—If SIP is actively used, consider changing the port to something other than
well-known port 5060.
• SIP registration—If SIP registration is available on SIP trunks, turn on this feature because it
provides an extra level of authentication and validation that only legitimate sources can connect
calls. If it is not available, ensure that the appropriate ACLs are in place.
• SIP Digest Authentication—If the SIP Digest Authentication feature is available for either
registrations or invites, turn this feature on because it provides an extra level of authentication and
validation that only legitimate sources can connect calls.
• Explicit incoming and outgoing dial peers—Use explicit dial peers to control the types and
parameters of calls allowed by the router, especially in IP-to-IP connections used on
Cisco Unified CME, Cisco Unified SRST, and Cisco Unified Border Element. Incoming dial peers
offer additional control on the sources of calls, and outgoing dial peers on the destinations. Incoming
dial peers are always used for calls. If a dial peer is not explicitly defined, the implicit dial peer 0 is
used to allow all calls.
Cisco Unified Communications Manager Express System Administrator Guide
30 OL-10663-02
Before You Begin
Information About Planning Your Configuration
• Explicit destination patterns—Use dial peers with more granularity than .T for destination patterns
to block disallowed off-net call destinations. Use class of restriction (COR) on dial peers with
specific destination patterns to allow even more granular control of calls to different destinations on
the PSTN.
• Translation rules—Use translation rules to manipulate dialed digits before calls connect to the PSTN
to provide better control over who may dial PSTN destinations. Legitimate users dial an access code
and an augmented number for PSTN for certain PSTN (for example, international) locations.
• Tcl and VoiceXML scripts—Attach a Tcl/VoiceXML script to dial peers to do database lookups or
additional off-router authorization checks to allow or deny call flows based on origination or
destination numbers. Tcl/VoiceXML scripts can also be used to add a prefix to inbound DID calls.
If the prefix plus DID matches internal extensions, then the call is completed. Otherwise, a prompt
can be played to the caller that an invalid number has been dialed.
• Host name validation—Use the “permit hostname” feature to validate initial SIP Invites that contain
a fully qualified domain name (FQDN) host name in the Request Uniform Resource Identifier
(Request URI) against a configured list of legitimate source hostnames.
• Dynamic Domain Name Service (DNS)—If you are using DNS as the “session target” on dial peers,
the actual IP address destination of call connections can vary from one call to the next. Use voice
source groups and ACLs to restrict the valid address ranges expected in DNS responses (which are
used subsequently for call setup destinations).
For more configuration guidance, see the "Cisco IOS Unified Communications Toll Fraud Prevention”
and “Configuring Toll Fraud Prevention”.
Configuration Methods Summary
Your choice of configuration method depends on whether you want to create an initial configuration for
your IP telephony system or you want to perform ongoing maintenance, such as routinely making
additions and changes associated with employee turnover. Table 2 compares the different methods for
configuring Cisco Unified CME:
.
Table 2 Comparison of Configuration Methods for Cisco Unified CME
Configuration Method Benefits Restrictions
Cisco IOS command line • Generates commands for running Requires knowledge of Cisco IOS commands
interface configuration which can be saved on and Cisco Unified CME.
Cisco router to be configured.
For information about
supported features, see • Use for setting up or modifying all
Table 6. parameters and features during initial
For information about using configuration and ongoing maintenance.
Cisco IOS commands, see
the “Using Cisco IOS
Commands to Create or
Modify the Configuration”
section on page 46.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 31
Before You Begin
Information About Planning Your Configuration
Table 2 Comparison of Configuration Methods for Cisco Unified CME (continued)
Configuration Method Benefits Restrictions
Cisco Unified CME GUI, • Graphical user interface • Cannot provision voice features such as
page 33. digit translation, call routing, and class of
• Use for ongoing system maintenance
restriction.
For information about using
• Modifies, adds, and deletes phones and
the Cisco Unified CME • Cannot provision data features such as
extensions; configures voice-mail; IP
GUI, see the “Using DHCP, IP addressing, and VLANs.
phone URLs; secondary dial tone pattern;
Cisco Unified CME GUI to
timeouts; transfer patterns; and the • Can only provision IP phones that are
Modify or Maintain
music-on-hold file. registered to Cisco Unified CME. Cannot
Configuration” section on
use bulk administration to import multiple
page 47. • Three configurable levels of access.
phones at the same time. Cannot manage
IP phone firmware.
• Requires manual upgrade of files in flash
if Cisco Unified CME version is
upgraded.
Voice Bundles
Voice bundles include a Cisco Integrated Services Router for secure data routing, Cisco Unified CME
software and licenses to support IP telephony, Cisco IOS SP Services or Advanced IP Services software
for voice gateway features, and the flexibility to add Cisco Unity Express for voice mail and auto
attendant capabilities. Voice bundles are designed to meet the diverse needs of businesses world wide.
To complete the solution, add digital or analog trunk interfaces to interface to the PSTN or the host PBX,
Cisco IP phones, and Cisco Catalyst data switches supporting Power-over Ethernet (PoE).
Table 3 contains a list of the Cisco tools for deploying Cisco IPC Express.
Table 3 Cisco Tools for Deploying Cisco IPC Express
Tool Name Description
Cisco Configuration Professional Express (Cisco CP Express) Cisco CP Express is a basic router configuration tool that
and Cisco Configuration Professional (Cisco CP) resides in router Flash memory. It is shipped with every
device ordered with Cisco CP. Cisco CP Express allows the
user to give the device a basic configuration, and allows the
user to install Cisco CP for advanced configuration and
monitoring capabilities.
Cisco CP is the next generation advanced configuration and
monitoring tool. It enables you to configure such things as
router LAN and WAN interfaces, a firewall, IPSec VPN,
dynamic routing, and wireless communication. Cisco CP is
installed on a PC. It is available on a CD, and can also be
downloaded from www.cisco.com.
Cisco Unified CME GUI, page 33 Cisco Unified CME GUI enables the user to configure a
subset of optional system and phone features.
Cisco Unified Communications Manager Express System Administrator Guide
32 OL-10663-02
Before You Begin
Information About Planning Your Configuration
Table 3 Cisco Tools for Deploying Cisco IPC Express (continued)
Tool Name Description
Cisco IPC Express Quote-Builder Cisco IPC Express Quote-Builder is an online application
available to Cisco Systems partners to help them quickly
identify recommended hardware configurations for
Cisco IPC Express telephony systems based on the
Cisco Integrated Services Router platform, which includes all
versions of the Cisco 2800 and Cisco 3800 series routers.
Cisco Network Assistant Cisco Network Assistant is a PC-based network management
application optimized for networks of small and
medium-sized businesses. Through a user-friendly GUI, the
user can apply common services such as configuration
management, inventory reports, password
synchronization and Drag and Drop IOS Upgrade across
Cisco SMB-Class switches, routers and access points.
Initialization Wizard for Cisco Unity Express Initialization Wizard in the Cisco Unity Express GUI prompts
the user for required information to configure users, voice
See “Configuring the System for the First Time,” in the
mailboxes, and other features of voice mail and auto
appropriate Cisco Unity Express GUI Administrator Guide at
attendant. The wizard starts automatically the first time you
http://www.cisco.com/en/US/products/sw/voicesw/ps5520/p
log in to the Cisco Unity Express GUI.
rod_maintenance_guides_list.html.
Router and Security Device Manager (SDM) Cisco Router and Security Device Manager (Cisco SDM) is
an intuitive, Web-based device-management tool for
Cisco routers. Cisco SDM simplifies router and security
configuration through smart wizards, which help customers
and Cisco partners quickly and easily deploy, and configure a
Cisco router without requiring knowledge of the
command-line interface (CLI).
Supported on Cisco 830 Series to Cisco 7301 routers,
Cisco SDM is shipping on Cisco 1800 Series, Cisco 2800
Series, and Cisco 3800 Series routers pre-installed by the
factory.
Cisco Unified CME GUI
The Cisco Unified CME GUI provides a web-based interface to manage most system-level and
phone-level features. In particular, the GUI facilitates the routine additions and changes associated with
employee turnover, allowing these changes to be performed by nontechnical staff.
The GUI provides three levels of access to support the following user classes:
• System administrator—Able to configure all systemwide and phone-based features. This person is
familiar with Cisco IOS software and VoIP network configuration.
• Customer administrator—Able to perform routine phone additions and changes without having
access to systemwide features. This person does not have to be familiar with Cisco IOS software.
• Phone user—Able to program a small set of features on his or her own phone and search the
Cisco Unified CME directory.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 33
Before You Begin
Information About Planning Your Configuration
The Cisco Unified CME GUI uses HTTP to transfer information between the Cisco Unified CME router
and the PC of an administrator or phone user. The router must be configured as an HTTP server, and an
initial system administrator username and password must be defined. Additional customer
administrators and phone users can be added by using Cisco IOS command line interface or by using
GUI screens.
Cisco Unified CME provides support for eXtensible Markup Language (XML) cascading style sheets
(files with a .css suffix) that can be used to customize the browser GUI display.
The GUI supports authentication, authorization, and accounting (AAA) authentication for system
administrators through a remote server capability. If authentication through the server fails, the local
router is searched.
Cisco Unified CME GUI must be installed and set up before it can be used. Instructions for using the
Cisco Unified GUI are in online help for the GUI.
For information about using the Cisco Unified CME GUI, see the “Using Cisco Unified CME GUI to
Modify or Maintain Configuration” section on page 47.
Workflow
This section contains the following topics:
• Configuring Cisco Unified CME: Workflow, page 34
Configuring Cisco Unified CME: Workflow
Table 4 lists the tasks for installing and configuring Cisco Unified CME and for modifying the
configuration, in the order in which the tasks are to be performed and including links to modules in this
guide that support each task.
Note Not all tasks are required for all Cisco Unified CME systems, depending on software version and on
whether it is a new Cisco Unified CME, an existing Cisco router that is being upgraded to support
Cisco Unified CME, or an existing Cisco Unified CME that is being upgraded or modified for new
features or to add or remove phones.
Table 4 Workflow for Creating or Modifying Basic Telephony Configuration
Cisco Unified CME
Configuration
Task New Modify Documentation
Install Cisco router and all recommended Required Optional Installing Hardware, page 37
services hardware for Cisco Unified CME.
Download recommended Cisco IOS IP Voice or Optional Optional Installing Cisco IOS Software, page 40
higher image to flash memory in the router.
Download recommended Cisco Unified CME Optional Optional Installing and Upgrading Cisco Unified CME
software including phone firmware and GUI Software, page 53
files.
Cisco Unified Communications Manager Express System Administrator Guide
34 OL-10663-02
Before You Begin
Information About Planning Your Configuration
Table 4 Workflow for Creating or Modifying Basic Telephony Configuration (continued)
Cisco Unified CME
Configuration
Task New Modify Documentation
Configure separate virtual LANs (VLANS) for Required — Using Network Assistant to Configure a Cisco
data and voice on the port switch. Catalyst Switch, page 41 or
Using Cisco IOS Commands to Configure a
Cisco Catalyst Switch, page 42 or
Configuring VLANs on an Internal Cisco
Ethernet Switching Module, page 45
• Enable calls in your VoIP network. Required Optional Defining Network Parameters, page 75
• Define DHCP.
• Set Network Time Protocol (NTP).
• Configure DTMF Relay for H.323 networks
in multisite installations.
• Configure SIP trunk support.
• Change the TFTP address on a DHCP server
• Enable OOD-R.
• Configure Bulk Registration. Required Optional Configuring System-Level Parameters, page 101
• Set up Cisco Unified CME.
• Set date and time parameters.
• Block Automatic Registration.
• Define alternate location and type of
configuration files.
• Change defaults for Time Outs.
• Configure a redundant router.
• Create directory numbers and assigning Required Optional Configuring Phones to Make Basic Calls,
directory numbers to phones. page 139
• Create phone configurations using
Extension Assigner.
• Generate configuration files for phones.
• Reset or restart phones.
Connect to PSTN. Required — Configuring Dialing Plans, page 283
Install system- and user-defined files for Optional Optional Configuring Localization Support, page 305
localization of phones.
Enable call detail records (CDRs) for collecting Optional Optional RADIUS VSA Voice Implementation Guide
accounting data.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 35
Before You Begin
Information About Planning Your Configuration
Table 5 contains a list of tasks for adding commonly configured features in Cisco Unified CME and the
module in which they appear in this guide. For a detailed list of features, with links to corresponding
information in this guide, see “Cisco Unified CME Features Roadmap” on page 1.
Table 5 Workflow for Adding Features in Cisco Unified CME
Task Documentation
Configure transcoding to support conferencing, call Configuring Transcoding Resources, page 329
transferring and forwarding, MoH, and Cisco Unity Express.
Enable the graphical user interface in Cisco Unified CME. Enabling the GUI, page 367
Configure support for voice mail. Integrating Voice Mail, page 385
Configure interoperability with Cisco Unified CCX. Configuring Interoperability with Cisco Unified CCX,
page 1141
Configure authentication support. Configuring Security, page 427
Add features. • Configuring Automatic Line Selection, page 497
• Call Blocking • Configuring Call Blocking, page 519
• Call-Coverage Features, including: • Configuring Call-Coverage Features, page 663
– Call Hunt • Configuring Call Park, page 537
– Call Pickup • Configuring Call Transfer and Forwarding, page 595
– Call Waiting • Configuring Caller ID Blocking, page 745
– Callback Busy Subscriber • Configuring Conferencing, page 753
– Hunt Groups • Configuring Directory Services, page 805
– Night Service • Configuring Do Not Disturb, page 825
– Overlaid Ephone-dns • Configuring Extension Mobility, page 875
• Call Park • Configuring Feature Access Codes, page 893
• Call Transfer and Forwarding • Configuring Headset Auto-Answer, page 907
• Caller ID Blocking • Configuring Intercom Lines, page 917
• Conferencing • Configuring Loopback Call Routing, page 929
• Intercom Lines • Configuring Music on Hold, page 963
• Music on Hold (MoH) • Configuring Paging, page 991
• Paging • Configuring Presence Service, page 1003
• Configuring Ring Tones, page 1029
• Customizing Soft Keys, page 1047
• Configuring Speed Dial, page 1065
Cisco Unified Communications Manager Express System Administrator Guide
36 OL-10663-02
Before You Begin
How to Install Cisco Voice Services Hardware
Table 5 Workflow for Adding Features in Cisco Unified CME (continued)
Task Documentation
Configure phone options, including: Modifying Cisco Unified IP Phone Options, page 1101
• Customized Background Images for Cisco Unified IP
Phone 7970
• Fixed Line/Feature Buttons for Cisco Unified IP Phone
7931G
• Header Bar Display
• PC Port Disable
• Phone Labels
• Programmable vendorConfig Parameters
• System Message Display
• URL Provisioning for Feature Buttons
Configure video support. Configuring Video Support for SCCP-Based Endpoints,
page 1087
Configure Cisco Unified CME as SRST Fallback. Configuring SRST Fallback Mode, page 1187
How to Install Cisco Voice Services Hardware
Note Cisco routers are normally shipped with Cisco voice services hardware and other optional equipment
that you ordered already installed. In the event that the hardware is not installed or you are upgrading
your existing Cisco router to support Cisco Unified CME or Cisco Unity Express, you will be required
to install hardware components.
Voice bundles do not include all the necessary components for Cisco Unity Express. Contact the
Cisco IP Communications Express partner in your area for more information about including
Cisco Unity Express in your configuration.
Prerequisites
• Cisco router and all recommended hardware for Cisco Unified CME, and if required,
Cisco Unity Express, is ordered and delivered, or is already onsite. To determine the recommended
hardware configuration to support your telephony system requirements, see the Cisco IPC Express
Quote-Builder online tool.
Installing Hardware
To install the Cisco router and voice services hardware, perform the following steps.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 37
Before You Begin
How to Install Cisco Voice Services Hardware
SUMMARY STEPS
1. Install the Cisco router on the network.
2. Connect to the Cisco router.
3. Use the show version or show flash command to check the amount of memory installed in the
router.
4. Identify DRAM and flash memory requirements.
5. Install or upgrade system memory.
6. Install Cisco voice services hardware.
7. Disable Smartinit and allocate ten percent of the total memory to Input/Output (I/O) memory.
DETAILED STEPS
Step 1 Install the Cisco router on your network. To find installation instructions for the Cisco router, access
documents located at www.cisco.com>Technical Support & Documentation>Product
Support>Routers>router you are using>Install and Upgrade Guides.
Step 2 Install Cisco voice services hardware.
a. To find installation instructions for any Cisco interface card, access documents located at
www.cisco.com>Technical Support & Documentation>Product Support>Cisco Interfaces and
Modules>interface you are using>Install and Upgrade Guides or Documentation Roadmap.
b. To install and configure your Catalyst switch, see Cisco Network Assistant.
c. To find installation instructions for any Cisco EtherSwitch module, access documents located at
www.cisco.com>Technical Support & Documentation>Product Support>Cisco Switches>switch
you are using>Install and Upgrade Guides.
Step 3 Connect to the Cisco router using a terminal or PC with terminal emulation. Attach a terminal or PC
running terminal emulation to the console port of the router.
Use the following terminal settings:
• 9600 baud rate
• No parity
• 8 data bits
• 1 stop bit
• No flow control
Note Memory recommendations and maximum numbers of Cisco IP phones identified in the next step are for
common Cisco Unified CME configurations only. Systems with large numbers of phones and complex
configurations may not work on all platforms and can require additional memory or a higher
performance platform.
Step 4 Log in to the router and use the show version EXEC command or the show flash privileged EXEC
command to check the amount of memory installed in the router. Look for the following lines after
issuing the show version command.
Example:
Router> show version
...
Cisco Unified Communications Manager Express System Administrator Guide
38 OL-10663-02
Before You Begin
How to Install Cisco IOS Software
Cisco 2691 (R7000) processor (revision 0.1) with 177152K/19456K bytes of memory
...
31360K bytes of ATA System Compactflash (Read/Write)
The first line indicates how much Dynamic RAM (DRAM) and Packet memory is installed in your
router. Some platforms use a fraction of their DRAM as Packet memory. The memory requirements take
this into account, so you have to add both numbers to find the amount of DRAM available on your router
(from a memory requirement point of view).
The second line identifies the amount of flash memory installed in your router.
or
Look for the following line after issuing the show flash command. Add the number available to the
number used to determine the total flash memory installed in the Cisco router.
Example:
Router# show flash
...
2252800 bytes available, (29679616 bytes used]
Step 5 Identify DRAM and flash memory requirements for the Cisco Unified CME version and Cisco router
model you are using. To find Cisco Unified CME specifications, see the appropriate Cisco Unified CME
Supported Firmware, Platforms, Memory, and Voice Products.
Step 6 Compare the amount of memory required to the amount of memory installed in the router. To install or
upgrade the system memory in the router, access documents located at www.cisco.com>Technical
Support & Documentation>Product Support>Routers>router you are using>Install and Upgrade Guides.
Step 7 Use the memory-size iomem i/o memory-percentage privileged EXEC command to disable Smartinit
and allocate ten percent of the total memory to Input/Output (I/O) memory.
Example:
Router# memory-size iomem 10
How to Install Cisco IOS Software
Note The Cisco router in a voice bundle is preloaded with the recommended Cisco IOS software release and
feature set plus the necessary Cisco Unified CME phone firmware and GUI files to support
Cisco Unified CME and Cisco Unity Express. If the recommended software is not installed or if you are
upgrading an existing Cisco router to support Cisco Unified CME and Cisco Unity Express, you will be
required to download and extract the required image and files.
Prerequisites
• The Cisco router is installed including sufficient memory, all Cisco voice services hardware, and
other optional hardware.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 39
Before You Begin
How to Install Cisco IOS Software
Installing Cisco IOS Software
To verify that the recommended software is installed on the Cisco router and if required, download and
install a Cisco IOS Voice or higher image, perform the following steps.
SUMMARY STEPS
1. Identify which Cisco IOS software release is installed on router.
2. Determine whether the Cisco IOS release supports the recommended Cisco Unified CME.
3. Download and extract the recommended Cisco IOS IP Voice or higher image to flash memory
4. Use the reload command to reload the Cisco Unified CME router with the new software.
DETAILED STEPS
Step 1 Identify which Cisco IOS software release is installed on router. Log in to the router and use the show
version EXEC command.
Example:
Router> show version
Cisco Internetwork Operating System Software
IOS (tm) 12.3 T Software (C2600-I-MZ), Version 12.3(11)T, RELEASE SOFTWARE
Step 2 Compare the Cisco IOS release installed on the Cisco router to the information in the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix to determine whether the
Cisco IOS release supports the recommended Cisco Unified CME.
Step 3 If required, download and extract the recommended Cisco IOS IP Voice or higher image to flash memory
in the router.
To find software installation information, access information located at www.cisco.com>Technical
Support & Documentation>Product Support> Cisco IOS Software>Cisco IOS Software Mainline release
you are using> Configuration Guides> Cisco IOS Configuration Fundamentals and Network
Management Configuration Guide>Part 2: File Management>Locating and Maintaining System Images.
Step 4 To reload the Cisco Unified CME router with the new software after replacing or upgrading the
Cisco IOS release, use the reload privileged EXEC command.
Example:
Router# reload
System configuration has been modified. Save [yes/no]:
Y
Building configuration...
OK
Proceed with reload? Confirm.
11w2d: %Sys-5-RELOAD: Reload requested by console. Reload reason: reload command
.
System bootstrap, System Version 12.2(8r)T, RELEASE SOFTWARE (fc1)
...
Press RETURN to get started.
...
Router>
Cisco Unified Communications Manager Express System Administrator Guide
40 OL-10663-02
Before You Begin
How to Configure VLANs on a Cisco Switch
What to Do Next
• If you installed a new Cisco IOS software release on the Cisco router, download and extract the
compatible Cisco Unified CME version. See the “Installing Cisco Unified CME Software” section
on page 58.
• If you are installing a new stand-alone Cisco Unified CME system, see the “How to Configure
VLANs on a Cisco Switch” section on page 41.
How to Configure VLANs on a Cisco Switch
To configure two Virtual Local Area Networks (VLANs), one for voice and one for data, on a Cisco
Catalyst switch or an internal Cisco NM, HWIC, or Fast Ethernet switching module, perform only one
of the following tasks.
• Using Network Assistant to Configure a Cisco Catalyst Switch, page 41
• Using Cisco IOS Commands to Configure a Cisco Catalyst Switch, page 42
• Configuring VLANs on an Internal Cisco Ethernet Switching Module, page 45
Using Network Assistant to Configure a Cisco Catalyst Switch
To configure two Virtual Local Area Networks (VLANs), one for voice and one for data, on an external
Cisco Catalyst switch and to implement Cisco Quality-of-Service (QoS) policies on your network,
perform the following steps.
Prerequisites
• The Cisco router is installed including sufficient memory, all Cisco voice services hardware and
other optional hardware.
• The recommended Cisco IOS release and feature set plus the necessary Cisco Unified CME phone
firmware and GUI files are installed.
• Determine if you can use the Cisco Network Assistant to configure VLANs on the switch for your
Cisco Unified CME router, see “Devices Supported” in the appropriate Release Notes for Cisco
Network Assistant.
Note A PC connected to the Cisco Unified CME router over the LAN is required to download, install, and run
Cisco Network Assistant.
• If you want to use Cisco Network Assistant to configure VLANs on the Cisco Catalyst switch, verify
that the PC on which you want to install and run Cisco Network Assistant meets the minimum
hardware and operating system requirements. See “Installing, Launching, and Connecting Network
Assistant” in Getting Started with Cisco Network Assistant.
• An RJ-45-to-RJ-45 rollover cable and the appropriate adapter (both supplied with the switch)
connecting the RJ-45 console port of the switch to a management station or modem is required to
manage a Cisco Catalyst switch through the management console.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 41
Before You Begin
How to Configure VLANs on a Cisco Switch
For more information on cabling and details about how to connect a management station or modem
to the console port, see “Connecting to the Console Port” in the Catalyst 2820 Series Installation
and Configuration Guide.
SUMMARY STEPS
1. Install, launch, and connect Cisco Network Assistant.
2. Use Network assistant to enable two VLANs on the switch port, configure a trunk between the
Cisco Unified CME router and the switch, and configure Cisco IOS Quality-of-Service (QoS).
DETAILED STEPS
Step 1 Install, launch, and connect Cisco Network Assistant. For instructions, see “Installing, Launching, and
Connecting Network Assistant” in Getting Started with Cisco Network Assistant.
Step 2 Use Cisco Network Assistant to perform the following tasks. See online Help for additional information
and procedures.
• Enable two VLANs on the switch port.
• Configure a trunk between the Cisco Unified CME router and the switch.
• Configure Cisco IOS Quality-of-Service (QoS).
What to Do Next
See the “Using Cisco IOS Commands to Create or Modify the Configuration” section on page 46.
Using Cisco IOS Commands to Configure a Cisco Catalyst Switch
To configure two Virtual Local Area Networks (VLANs), one for voice and one for data, a trunk between
the Cisco Unified CME router and the switch, and Cisco IOS Quality-of-Service (QoS) on an external
Cisco Catalyst switch, perform the following steps.
Prerequisites
• The Cisco router is installed including sufficient memory, all Cisco voice services hardware and
other optional hardware.
• The recommended Cisco IOS release and feature set plus the necessary Cisco Unified CME phone
firmware and GUI file are installed.
• An RJ-45-to-RJ-45 rollover cable and the appropriate adapter (both supplied with the switch)
connecting the RJ-45 console port of the switch to a management station or modem is required to
manage a Cisco Catalyst switch through the management console.
For more information on cabling and details about how to connect a management station or modem
to the console port, see “Connecting to the Console Port” in the Catalyst 2820 Series Installation
and Configuration Guide.
Cisco Unified Communications Manager Express System Administrator Guide
42 OL-10663-02
Before You Begin
How to Configure VLANs on a Cisco Switch
SUMMARY STEPS
1. enable
2. vlan database
3. vlan vlan-number name vlan-name
4. vlan vlan-number name vlan-name
5. exit
6. wr
7. configure terminal
8. macro global apply cisco-global
9. interface slot-number/port-number
10. macro apply cisco-phone $AVID number $VVID number
11. interface slot-number/port-number
12. macro apply cisco-router $NVID number
13. end
14. wr
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Switch> enable
Step 2 vlan database Enters VLAN configuration mode.
Example:
Switch# vlan database
Step 3 vlan vlan-number name vlan-name Specifies the number and name of the VLAN being
configured.
Example: • vlan-number—Unique value that you assign to the
Switch(vlan)# vlan 10 name data dial-peer being configured. Range: 2 to 1004.
VLAN 10 modified
Name: DATA • name—Name of the VLAN to associate to the
vlan-number being configured.
Step 4 vlan vlan-number name vlan-name Specifies the number and name of the VLAN being
configured.
Example:
Switch(vlan)# vlan 100 name voice
VLAN 100 modified
Name: VOICE
Step 5 exit Exits this configuration mode.
Example:
Switch(vlan)# exit
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 43
Before You Begin
How to Configure VLANs on a Cisco Switch
Command or Action Purpose
Step 6 wr Writes the modifications to the configuration file.
Example:
Switch# wr
Step 7 configure terminal Enters global configuration mode.
Example:
Switch# configure terminal
Step 8 macro global apply cisco-global Applies the Smartports global configuration macro for QoS.
Example:
Switch (config)# macro global apply
cisco-global
Step 9 interface slot-number/port-number Specifies interface to be configured while in the interface
configuration mode.
Example: • slot-number/port-number—Slot and port of interface to
Switch (config)# interface fastEthernet 0/1 which Cisco IP phones or PCs are connected.
Note The slash must be entered between the slot and port
numbers.
Step 10 macro apply cisco-phone $AVID number $VVID Applies VLAN and QoS settings in Smartports macro to the
number port being configured.
• $AVID number—Data VLAN configured in earlier
Example: step.
Switch (config-if)# macro apply cisco-phone
$AVID 10 $VVID 100 • $VVID number—Voice VLAN configured in earlier
step.
Step 11 interface slot-number/port-number Specifies interface to be configured while in the interface
configuration mode.
Example: • slot-number/port-number—Slot and port of interface to
Switch (config-if)# interface fastEthernet 0/24 which the Cisco router is connected.
Note The slash must be entered between the slot and port
numbers.
Step 12 macro apply cisco-router $NVID number Applies the VLAN and QoS settings in Smartports macro to
the port being configured.
Example: • $NVID number—Data VLAN configured in earlier
Switch (config-if)# macro apply cisco-router step.
$NVID 10
Step 13 end Exits to privileged EXEC configuration mode.
Example:
Switch(config-if)# end
Step 14 wr Writes the modifications to the configuration file.
Example:
Switch# wr
Cisco Unified Communications Manager Express System Administrator Guide
44 OL-10663-02
Before You Begin
How to Configure VLANs on a Cisco Switch
What to Do Next
See the “Using Cisco IOS Commands to Create or Modify the Configuration” section on page 46.
Configuring VLANs on an Internal Cisco Ethernet Switching Module
To configure two Virtual Local Area Networks (VLANs), one for voice and one for data, on an internal
Cisco Ethernet switching module, perform the following steps.
Prerequisites
• The Cisco router is installed including sufficient memory, all Cisco voice services hardware and
other optional hardware.
• The recommended Cisco IOS release and feature set plus the necessary Cisco Unified CME phone
firmware and GUI files are installed.
• The switch is in privileged EXEC mode.
SUMMARY STEPS
1. enable
2. vlan database
3. vlan vlan-number name vlan-name
4. vlan vlan-number name vlan-name
5. exit
6. wr
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Switch> enable
Step 2 vlan database Enters VLAN configuration mode.
Example:
Switch# vlan database
Step 3 vlan vlan-number name vlan-name Specifies the number and name of the VLAN being
configured.
Example: • vlan-number—Unique value that you assign to
Switch(vlan)# vlan 10 name data dial-peer being configured. Range: 2 to 1004.
VLAN 10 modified
Name: DATA • name—Name of the VLAN to associate to the
vlan-number being configured.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 45
Before You Begin
How to Configure Cisco Unified CME
Command or Action Purpose
Step 4 vlan vlan-number name vlan-name Specifies the number and name of the VLAN being
configured.
Example:
Switch(vlan)# vlan 100 name voice
VLAN 100 modified
Name: VOICE
Step 5 exit Exits this configuration mode.
Example:
Switch(vlan)# exit
Step 6 wr Writes the modifications to the configuration file.
Example:
Switch# wr
What to Do Next
See the “Using Cisco IOS Commands to Create or Modify the Configuration” section on page 46.
How to Configure Cisco Unified CME
This section contains the following tasks:
• Using Cisco IOS Commands to Create or Modify the Configuration, page 46
• Using Cisco Unified CME GUI to Modify or Maintain Configuration, page 47
Using Cisco IOS Commands to Create or Modify the Configuration
Note For information about the Cisco IOS Command-Line Interface (CLI) and command modes, see Using
the Command-Line Interface in Cisco IOS Software.
Prerequisites
• Hardware and software to establish a physical or virtual console connection to the Cisco router using
a terminal or PC running terminal emulation is available and operational.
• Connect to the Cisco router using a terminal or PC with terminal emulation. Attach a terminal or PC
running terminal emulation to the console port of the router.
For connecting to the router to be configured, use the following terminal settings:
– 9600 baud rate
– No parity
– 8 data bits
– 1 stop bit
Cisco Unified Communications Manager Express System Administrator Guide
46 OL-10663-02
Before You Begin
How to Configure Cisco Unified CME
– No flow control
What to Do Next
For step-by-step procedures for configuring Cisco Unified CME using Cisco IOS commands, see the
Cisco Unified CME System Administrator Guide.
Using Cisco Unified CME GUI to Modify or Maintain Configuration
To use the Cisco Unified CME GUI to modify the configuration, see online help.
Prerequisites
• Cisco CME 3.2 or a later version.
• Files required for the operation of the GUI must be copied into flash memory on the router. For
information about files, see “Installing and Upgrading Cisco Unified CME Software” on page 53.
• Cisco Unified CME GUI must be enabled. For information, see “Enabling the GUI” on page 367.
Restrictions
• The web browser that you use to access the GUI must be Microsoft Internet Explorer 5.5 or a later
version. No other type of browser can be used to access the GUI.
• Cannot provision voice features such as digit translation, call routing, and class of restriction.
• Cannot provision data features such as DHCP, IP addressing, and VLANs.
• Can only provision IP phones that are registered to Cisco Unified CME. Cannot use bulk
administration to import multiple phones at the same time. Cannot manage IP phone firmware.
• Requires manual upgrade of files in flash memory of router if Cisco Unified CME is upgraded to
later version.
• Other minor limitations, such as:
– If you use an XML configuration file to create a customer administrator login, the size of that
XML file must be 4000 bytes or smaller.
– The password of the system administrator cannot be changed through the GUI. Only the
password of a customer administrator or a phone user can be changed through the GUI.
– If more than 100 phones are configured, choosing to display all phones will result in a long
delay before results are shown.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 47
Before You Begin
Feature Summary
Feature Summary
Table 6 contains a list of commonly configured features in Cisco Unified CME and the module in which
they appear in this guide. For a detailed list of features, with links to corresponding information in this
guide, see “Cisco Unified CME Features Roadmap” on page 1.
Table 6 Parameters and Features Supported by Cisco IOS Commands
Parameters and Features Where to Find Configuration Information
Cisco Unified CME Software
Installing and upgrading software, including: Installing and Upgrading Cisco Unified CME
Software
• Cisco Unified CME
• Cisco Unified CME GUI
• Firmware files for Cisco Unified IP phones
Basic Configuration
• Enabling Calls in Your VoIP Network Defining Network Parameters
• Defining DHCP
• Setting Network Time Protocol
• Configuring DTMF Relay for H.323 Networks in Multisite
Installations
• Configuring SIP Trunk Support
• Changing the TFTP Address on a DHCP Server
• Enabling OOD-R
• Configuring Bulk Registration Configuring System-Level Parameters
• Setting Up Cisco Unified CME
• Setting Date and Time Parameters
• Blocking Automatic Registration
• Defining Alternate Location and Type of Configuration Files
• Changing Defaults for Time Outs
• Configuring a Redundant Router
• Creating Directory Numbers, Assigning Directory Numbers to Phones Configuring Phones to Make Basic Calls
• Creating Phone Configurations Using Extension Assigner
• Generating Configuration Files for Phones
• Resetting and Restarting Phones
Connecting to PSTN
• Dial-plan patterns Configuring Dialing Plans
• Translation rules and profiles
• Secondary dial tones
Cisco Unified Communications Manager Express System Administrator Guide
48 OL-10663-02
Before You Begin
Feature Summary
Table 6 Parameters and Features Supported by Cisco IOS Commands
Parameters and Features Where to Find Configuration Information
Transcoding Support
• DSP farms Configuring Transcoding Resources.
• NMs or NM farms
• Transcoding sessions
Localization Support
• Use locale Configuring Localization Support.
• Network locale
Cisco Unified CME GUI Enabling the GUI
Features
• Automatic line selection Adding Features in the Cisco Unified CME
Admistrator Guide
• Call blocking
• Call park
• Call transfer and forwarding
• Caller ID blocking
• Conferencing
• Directory services
• Do Not Disturb (DND)
• Feature Access Codes (FAC)
• Headset auto-answer
• Intercom lines
• Loopback call routing
• Music on Hold (MOH)
• Paging
• Presence service
• Ring tones
• Soft keys
• Speed dial
• Call hunt Configuring Call-Coverage Features.
• Call pickup
• Call waiting
• Callback busy subscriber
• Hunt groups
• Night service
• Overlaid Ephone-dns
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 49
Before You Begin
Feature Summary
Table 6 Parameters and Features Supported by Cisco IOS Commands
Parameters and Features Where to Find Configuration Information
Authentication Support
• Phone authentication startup messages Configuring Security.
• CTL file
• CTL client and provider
• MIC root certificate
Phone Options
• Customized Background Images for Cisco Unified IP Phone 7970 Modifying Cisco Unified IP Phone Options.
• Fixed Line/Feature Buttons for Cisco Unified IP Phone 7931G
• Header Bar Display
• PC Port Disable
• Phone Labels
• Programmable vendorConfig Parameters
• System Message Display
• URL Provisioning for Feature Buttons
Configuring Video Support for SCCP-Based
Video Support Endpoints
Voice-Mail Support
• Cisco Unity Connection Integrating Voice Mail.
• Cisco Unity Express
• Cisco Unity
• DTMF integration for legacy voice-mail applications
• Mailbox selection policy
• RFC 2833 Dual Tone Multifrequency (DTMF) MTP Passthrough
• MWI
Cisco Unified CME as SRST Fallback Configuring SRST Fallback Mode.
Cisco Unified Communications Manager Express System Administrator Guide
50 OL-10663-02
Before You Begin
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User documentation for Cisco Unified IP phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 51
Before You Begin
Additional References
Cisco Unified Communications Manager Express System Administrator Guide
52 OL-10663-02
Installing and Upgrading Cisco Unified CME
Software
Last Updated: June 3, 2009
This chapter explains how to install Cisco Unified Communications Manager Express
(Cisco Unified CME) software and how to upgrade phone firmware for Cisco Unified IP phones.
Contents
• Prerequisites for Installing Cisco Unified CME Software, page 53
• Information About Cisco Unified CME Software, page 54
• How to Install and Upgrade Cisco Unified CME Software, page 57
• Additional References, page 74
Prerequisites for Installing Cisco Unified CME Software
Hardware
• Your IP network is operational and you can access Cisco web.
• You have a valid Cisco.com account.
• You have access to a TFTP server for downloading files.
• Cisco router and all recommended services hardware for Cisco Unified CME is installed. For
installation information, see the “How to Install Cisco Voice Services Hardware” section on
page 37.
Cisco IOS Software
• Recommended Cisco IOS IP Voice or higher image is downloaded to flash memory in the router.
To determine which Cisco IOS software release supports the recommended Cisco Unified CME
version, see the Cisco Unified CME and Cisco IOS Software Compatibility Matrix. For installation
information, see the “How to Install Cisco IOS Software” section on page 39.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 53
Installing and Upgrading Cisco Unified CME Software
Information About Cisco Unified CME Software
Information About Cisco Unified CME Software
This section contains a list of the types of files that must be downloaded and installed in the router flash
memory to use with Cisco Unified CME. The files listed in this section are included in zipped or tar
archives that are downloaded from the Cisco Unified CME software download website at
http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp.
• Basic Files, page 54
• GUI Files, page 54
• Phone Firmware Files, page 54
• XML Template, page 56
• Music-on-Hold (MOH) File, page 56
• Script Files, page 56
• Bundled TSP Archive, page 57
• File Naming Conventions, page 57
Basic Files
A tar archive contains the basic files you need for Cisco Unified CME. Be sure to download the correct
version for the Cisco IOS software release that is running on your router. The basic tar archive generally
also contains the phone firmware files that you require, although you may occasionally need to download
individual phone firmware files. For information about installing Cisco Unified CME, see the “Installing
Cisco Unified CME Software” section on page 58.
GUI Files
A tar archive contains the files that you need to use the Cisco Unified CME graphical user interface
(GUI), which provides a mouse-driven interface for provisioning phones after basic installation is
complete. For installation information, see the “Installing Cisco Unified CME Software” section on
page 58.
Note Cisco Unified CME GUI files are version-specific; GUI files for one version of Cisco Unified CME are
not compatible with any other version of Cisco Unified CME. When downgrading or upgrading
Cisco Unified CME, the GUI files for the old version must be overwritten with GUI files that match the
Cisco Unified CME version that is being installed.
Phone Firmware Files
Phone firmware files provide code to enable phone displays and operations. These files are specialized
for each phone type and protocol, SIP or SCCP, and are periodically revised. You must be sure to have
the appropriate phone firmware files for the types of phones, protocol being used, and
Cisco Unified CME version at your site.
Cisco Unified Communications Manager Express System Administrator Guide
54 OL-10663-02
Installing and Upgrading Cisco Unified CME Software
Information About Cisco Unified CME Software
New IP phones are shipped from Cisco with a default manufacturing SCCP image. When a IP phone
downloads its configuration profile, the phone compares the phone firmware mentioned in the
configuration profile with the firmware already installed on the phone. If the firmware version differs
from the one that is currently loaded on the phone, the phone contacts the TFTP server to upgrade to the
new phone firmware and downloads the new firmware before registering with Cisco Unified CME.
Generally, phone firmware files are included in the Cisco Unified CME software archive that you
download. They can also be posted on the software download website as individual files or archives.
Early versions of Cisco phone firmware for SCCP and SIP IP phones had filenames as follows:
• SCCP firmware—P003xxyy.bin
• SIP firmware—P0S3xxyy.bin
In both bases, x represents the major version, and y represented the minor version. The third character
represents the protocol, “0” for SCCP or “S” for SIP.
In later versions, the following conventions are used:
• SCCP firmware—P003xxyyzzww, where x represents the major version, y represents the major
subversion, z represents the maintenance version, and w represents the maintenance subversion.
• SIP firmware—P0S3-xx-y-zz, where x represents the major version, y represents the minor version,
and z represents the subversions.
• The third character in a filename—Represents the protocol, “0” for SCCP or “S” for SIP.
There are exceptions to the general guidelines. For Cisco ATA, the filename begins with AT. For
Cisco Unified IP Phone 7002, 7905, and 7912, the filename can begin with CP.
Signed and unsigned versions of phone firmware are available for certain phone types. Signed binary
files support image authentication, which increases system security. We recommend signed versions if
your version of Cisco Unified CME supports them. Signed binary files have .sbn file extensions, and
unsigned files have .bin file extensions.
For Java-based IP phones, such as the Cisco Unified IP Phone 7911, 7941, 7941GE, 7961, 7961GE,
7970, and 7971, the firmware consists of multiple files including JAR and tone files. All of the firmware
files for each phone type must be downloaded the TFTP server before they can be downloaded to the
phone.
The following example shows a list of phone firmware files that are installed in flash memory for the
Cisco Unified IP Phone 7911:
tftp-server flash:SCCP11.7-2-1-0S.loads
tftp-server flash:term06.default.loads
tftp-server flash:term11.default.loads
tftp-server flash:cvm11.7-2-0-66.sbn
tftp-server flash:jar11.7-2-0-66.sbn
tftp-server flash:dsp11.1-0-0-73.sbn
tftp-server flash:apps11.1-0-0-72.sbn
tftp-server flash:cnu11.3-0-0-81.sbn
However, you only specify the filename for the image file when configuring Cisco Unified CME. For
Java-based IP phones, the following naming conventions are used for image files:
• SCCP firmware—TERMnn.xx-y-z-ww or SCCPnn.xx-y-zz-ww, where n represents the phone type,
x represents the major version, y represents the major subversion, z represents the maintenance
version, and w represents the maintenance subversion.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 55
Installing and Upgrading Cisco Unified CME Software
Information About Cisco Unified CME Software
The following example shows how to configure Cisco Unified CME so that the Cisco Unified IP Phone
7911 can download the appropriate SCCP firmware from flash memory:
Router(config)# telephony-service
Router(config-telephony)#load 7911 SCCP11.7-2-1-0S
Table 7 contains firmware-naming convention examples, in alphabetical order:
.
Table 7 Firmware-Naming Conventions
SCCP Phones SIP Phones
Image Version Image Version
P00303030300 3.3(3) P0S3-04-4-00 4.4
P00305000200 5.0(2) P0S3-05-2-00 5.2
P00306000100 6.0(1) P0S3-06-0-00 6.0
SCCP41.8-0-4ES4-0-1S 8.0(4) SIP70.8-0-3S 8.0(3)
TERM41.7-0-3-0S 7.0(3) — —
The phone firmware filenames for each phone type and Cisco Unified CME version are listed in the
appropriate Cisco CME Supported Firmware, Platforms, Memory, and Voice Products document at
http://www.cisco.com/en/US/products/sw/voicesw/ps4625/products_device_support_tables_list.html.
For information about installing firmware files, see the “Installing Cisco Unified CME Software”
section on page 58.
For information about configuring Cisco Unified CME for upgrading between versions or converting
between SCCP and SIP, see the “How to Install and Upgrade Cisco Unified CME Software” section on
page 57.
XML Template
The file called xml.template can be copied and modified to allow or restrict specific GUI functions to
customer administrators, a class of administrative users with limited capabilities in a
Cisco Unified CME system. This file is included in both tar archives (cme-basic-... and cme-gui-...). To
install the file, see the “Installing Cisco Unified CME Software” section on page 58.
Music-on-Hold (MOH) File
An audio file named music-on-hold.au provides music for external callers on hold when a live feed is
not used.This file is included in the tar archive with basic files (cme-basic-...). To install the file, see the
“Installing Cisco Unified CME Software” section on page 58.
Script Files
Archives containing Tcl script files are listed individually on the Cisco Unified CME software download
website. For example, the file named app-h450-transfer.2.0.0.9.zip.tar contains a script that adds H.450
transfer and forwarding support for analog FXS ports.
Cisco Unified Communications Manager Express System Administrator Guide
56 OL-10663-02
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
The Cisco Unified CME Basic Automatic Call Distribution and Auto Attendant Service (B-ACD)
requires a number of script files and audio files, which are contained in a tar archive with the name
cme-b-acd-.... For a list of files in the archive and for more information about the files, see Cisco CME
B-ACD and TCL Call-Handling Applications.
For information about installing TcL script file or an archive, see “Installing Cisco Unified CME
Software” on page 58.
Bundled TSP Archive
An archive is available at the Cisco Unified CME software download website that contains several
Telephony Application Programming Interface (TAPI) Telephony Service Provider (TSP) files. These
files are needed to set up individual PCs for Cisco Unified IP phone users who wish to make use of
Cisco Unified CME-TAPI integration with TAPI-capable PC software. To install the files from the
archive, see the installation instructions in the TAPI Developer Guide for Cisco CME/SRST.
File Naming Conventions
Most of the files available at the Cisco Unified CME software download website are archives that must
be uncompressed before individual files can be copied to the router. In general, the following naming
conventions apply to files on the Cisco Unified CME software download website:
cme-basic-... Basic Cisco Unified CME files, including phone firmware files for a
particular Cisco Unified CME version or versions.
cme-gui-... Files required for the Cisco Unified CME GUI.
cmterm..., P00..., 7970.. Phone firmware files.
Note Not all firmware files to be downloaded to a phone are specified in
the load command. For a list of file names to be installed in flash
memory, and which file names are to be specified by using the load
command, see Cisco Unified CME Supported Firmware,
Platforms, Memory, and Voice Products.
cme-b-acd... Files required for Cisco Unified CME B-ACD service.
How to Install and Upgrade Cisco Unified CME Software
This section contains the following procedures:
• Installing Cisco Unified CME Software, page 58 (required)
• SCCP: Upgrading or Downgrading Phone Firmware Between Versions, page 59 (required)
• SIP: Upgrading or Downgrading Phone Firmware Between Versions, page 61 (required)
• SCCP: Converting Phone Firmware to SIP, page 65 (required)
• SIP: Converting Phone to SCCP, page 68 (required)
• SCCP: Verifying the Phone Firmware Version on an IP Phone, page 72 (optional)
• Troubleshooting Tips, page 73 (optional)
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 57
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
Note Customers who purchase a router bundle enabled with Cisco Unified CME will have the necessary
Cisco Unified CME files installed at time of manufacture.
Installing Cisco Unified CME Software
To install Cisco Unified CME in flash memory, perform the following steps.
SUMMARY STEPS
1. Go to Software Download site.
2. Download archive.
3. Extract files to be downloaded.
4. Use the copy or archive tar command to copy file to flash memory.
5. Use the show flash: command to list files in flash memory.
DETAILED STEPS
Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/ip-key.
Step 2 Select the file to download.
Step 3 Download zip file to tftp server.
Step 4 Use the zip program to extract the file to be installed, then:
a. If the file is an individual file, use the copy command to copy the files to router flash:
Router# copy tftp://x.x.x.x/P00307020300.sbn flash:
b. If the file is a tar file, use the archive tar command to extract the files to flash memory.
Router# archive tar /xtract source-url flash:/file-url
Step 5 Verify the installation. Use the show flash: command to list the files installed in in flash memory.
Router# show flash:
31 128996 Sep 19 2005 12:19:02 -07:00 P00307020300.bin
32 461 Sep 19 2005 12:19:02 -07:00 P00307020300.loads
33 681290 Sep 19 2005 12:19:04 -07:00 P00307020300.sb2
34 129400 Sep 19 2005 12:19:04 -07:00 P00307020300.sbn
Step 6 Use the archive tar /create command to create a backup tar file of all the files stored in flash. You can
create a tar file that includes all files in a directory or a list of up to four files from a directory.
For example, the following command creates a tar file of the three files listed:
archive tar /create flash:abctestlist.tar flash:orig1 sample1.txt sample2.txt sample3.txt
The following command creates a tar file of all the files in the directory:
archive tar /create flash:abctest1.tar flash:orig1
Cisco Unified Communications Manager Express System Administrator Guide
58 OL-10663-02
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
The following command creates a tar file to backup the flash files to a USB card, on supported platforms:
archive tar /create usbflash1:abctest1.tar flash:orig1
What to Do Next
• If you installed Cisco Unified CME software and Cisco Unified CME is not configured on your
router, see “Defining Network Parameters” on page 75.
• If Cisco Unified IP phones presently connected to Cisco Unified CME are using the SCCP protocol
to receive and place calls and the firmware version must be upgraded to a recommended version, or
if the phones to be connected to Cisco Unified CME are brand new, out-of-the-box, the phone
firmware preloaded at the factory must be upgraded to the recommended version before your phones
can complete registration, see the “SCCP: Upgrading or Downgrading Phone Firmware Between
Versions” section on page 59.
• If Cisco Unified IP phones presently connected to Cisco Unified CME are using the SIP protocol to
receive and place calls and the firmware version must be upgraded to a recommended version, see
the “SIP: Upgrading or Downgrading Phone Firmware Between Versions” section on page 61.
• If Cisco Unified IP phones presently connected to Cisco Unified CME are using the SCCP protocol
to receive and place calls and you now want some or all of these phones to use the SIP protocol, the
phone firmware for each phone type must be upgraded from SCCP to the recommended SIP version
before the phones can register. See the “SCCP: Converting Phone Firmware to SIP” section on
page 65.
• If Cisco Unified IP phones to be connected to Cisco Unified CME are using the SIP protocol and
are brand new, out-of-the-box, the phone firmware preloaded at the factory must be upgraded to the
recommended SIP version before your SIP phones can complete registration. See the “SCCP:
Converting Phone Firmware to SIP” section on page 65.
• If Cisco Unified IP phones presently connected to Cisco Unified CME are using the SIP protocol to
receive and place calls and you now want some or all of these phones to use the SCCP protocol, the
phone firmware for each phone type must be upgraded from SIP to the recommended SCCP version
before the phones can register. See the “SIP: Converting Phone to SCCP” section on page 68.
SCCP: Upgrading or Downgrading Phone Firmware Between Versions
To downgrade or upgrade firmware versions on a Cisco Unified IP phone running SCCP, perform the
following steps.
Prerequisites
• Phone firmware for Cisco Unified IP phones to be connected to Cisco Unified CME, including all
versions required during an upgrade or downgrade sequence, must be loaded in the flash memory of
the TFTP server from which the phones download their configuration profiles. For information
about installing firmware files in flash memory, see the “Installing Cisco Unified CME Software”
section on page 58.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 59
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
Note For certain IP phones, such as the Cisco Unified IP Phone 7911, 7941, 7961, 7970, and 7971, the
firmware consists of multiple files including JAR and tone files. All of the firmware files must be
downloaded to the TFTP server before they can be downloaded to the phone. For a list of files in each
firmware version, see the appropriate Cisco Unified CME Supported Firmware, Platforms, Memory, and
Voice Products.
SUMMARY STEPS
1. enable
2. configure terminal
3. tftp-server device:firmware-file
4. telephony-service
5. load phone-type firmware-file
6. create cnf-files
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 tftp-server device:firmware-file (Optional) Creates TFTP bindings to permit IP phones
served by the Cisco Unified CME router to access the
specified file.
Example:
Router(config)# tftp-server • A separate tftp-server command is required for each
flash:P00307020300.loads phone type.
Router(config)# tftp-server
flash:P00307020300.sb2 • Required for Cisco Unified CME 7.0/4.3 and earlier
Router(config)# tftp-server versions.
flash:P00307020300.sbn
Router(config)# tftp-server • Cisco Unified CME 7.0(1) and later versions: Required
flash:P00307020300.bin only if the location for cnf files is not flash or slot 0.
Use the complete filename, including the file suffix, for
phone firmware versions later than version 8-2-2 for all
phone types.
Step 4 telephony service Enters telephone-service configuration mode.
Example:
Router(config)# telephony service
Cisco Unified Communications Manager Express System Administrator Guide
60 OL-10663-02
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
Command or Action Purpose
Step 5 load phone-type firmware-file Associates a phone type with a phone firmware file.
• A separate load command is required for each IP phone
Example: type.
Router(config-telephony)# load 7960-7940
P00307020300
• firmware-file—Filenames are case-sensitive.
– In Cisco Unified CME 7.0/4.3 and earlier versions,
do not use the file suffix (.bin, .sbin, .loads) for any
phone type except the Cisco ATA and
Cisco Unified IP Phone 7905 and 7912.
– In Cisco Unified CME 7.0(1) and later versions,
you must use the complete filename, including the
file suffix, for phone firmware versions later than
version 8-2-2 for all phone types.
Step 6 create cnf-files Builds XML configuration files required for SCCP phones.
Example:
Router(config-telephony)# create cnf-files
Step 7 end Exits to privileged EXEC mode.
Example:
Router(config-telephony)# end
What to Do Next
• If the Cisco Unified IP phone to be upgraded is not configured in Cisco Unified CME, see “How to
Configure Phones for a PBX System” on page 158.
• If the Cisco Unified IP phone is already configured in Cisco Unified CME and can make and receive
calls, you are ready to reboot the Cisco Unified IP phones to download the phone firmware to the
phone. See “Resetting and Restarting Phones” on page 271.
SIP: Upgrading or Downgrading Phone Firmware Between Versions
To upgrade or downgrade phone firmware for Cisco Unified IP phones running SIP between versions,
perform the steps in this section.
The upgrade and downgrade sequences for SIP phones differ per phone type as follows:
• Upgrading/downgrading the phone firmware for Cisco Unified IP Phone 7905G, Cisco Unified IP
Phone 7912G, and Cisco ATA Analog Telephone Adapter is straightforward; modify the load
command to upgrade directly to the target load.
• The phone firmware version upgrade sequence for Cisco Unified IP Phone 7940Gs and 7960Gs is
from version [234].x to 4.4, to 5.3, to 6.x, to 7.x. You cannot go directly from version [234].x to
version 7.x.
• To downgrade phone firmware for Cisco Unified IP Phone 7940Gs and 7960Gs, first upgrade to
version 7.x, then modify the load command to downgrade directly to the target phone firmware.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 61
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
Prerequisites
Phone firmware for Cisco Unified IP phones to be connected to Cisco Unified CME, including all
versions required during an upgrade or downgrade sequence, must be loaded in the flash memory of the
TFTP server from which the phones will download their configuration profiles. For information about
installing firmware files in flash memory, see the “Installing Cisco Unified CME Software” section on
page 58.
Restrictions
• Cisco Unified IP Phone 7905G, Cisco Unified IP Phone 7912G, and Cisco ATA—Signed load starts
from SIP v1.1. After you upgrade the firmware to a signed load, you cannot downgrade the firmware
to an unsigned load.
• Cisco Unified IP Phone 7940G and Cisco Unified IP Phone 7960G—Signed load starts from SIP
v5.x. Once you upgrade the firmware to a signed load, you cannot downgrade the firmware to an
unsigned load.
• The procedures for upgrading phone firmware files for SIP phones is the same for all
Cisco Unified IP phones. For other limits on firmware upgrade between versions, see the
Cisco 7940 and 7960 IP Phones Firmware Upgrade Matrix.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. mode cme
5. load phone-type firmware-file
6. upgrade
7. Repeat Steps 5 and 6.
8. file text
9. create profile
10. exit
11. voice register pool tag
12. reset
13. exit
14. voice register global
15. no upgrade
16. end
Cisco Unified Communications Manager Express System Administrator Guide
62 OL-10663-02
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Step 4 mode cme Enables mode for provisioning SIP phones in
Cisco Unified CME.
Example:
Router(config-register-global)# mode cme
Step 5 load phone-type firmware-file Associates a phone type with a phone firmware file.
• A separate load command is required for each IP phone
Example: type.
Router(config-register-global)# load 7960-7940
P0S3-06-0-00
• firmware-file—Filename to be associated with the
specified Cisco Unified IP phone type.
• Do not use the .sbin or .loads file extension except for
Cisco ATA and Cisco Unified IP Phone 7905 and 7912
Step 6 upgrade Generates a file with the universal application loader image
for upgrading phone firmware and performs the TFTP
server alias binding.
Example:
Router(config-register-global)# upgrade
Step 7 Repeat previous two steps. (Optional) Repeat for each version required in multistep
upgrade sequences only.
Example:
Router(config-register-global)# load 7960-7940
P0S3-07-4-00
Router(config-register-global)# upgrade
Step 8 file text (Optional) Generates ASCII text files for Cisco Unified IP
Phone 7905s and 7905Gs, Cisco Unified IP Phone 7912s
and 7912Gs, Cisco ATA-186, or Cisco ATA-188.
Example:
Router(config-register-global)# file text • Default—System generates binary files to save disk
space.
Step 9 create profile Generates provisioning files required for SIP phones and
writes the file to the location specified with the tftp-path
command.
Example:
Router(config-register-global;)# create profile
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 63
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
Command or Action Purpose
Step 10 exit Exits from the current command mode to the next highest
mode in the configuration mode hierarchy.
Example:
Router(config-register-global)# exit
Step 11 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for SIP phones.
Example: • pool-tag—Unique sequence number of the SIP phone
Router(config)# voice register pool 1 to be configured. Range is 1 to 100 or the upper limit as
defined by max-pool command.
Step 12 reset Performs a complete reboot of the single SIP phone
specified with the voice register pool command and
contacts the DHCP server and the TFTP server for updated
Example:
Router(config-register-pool)# reset
information.
Step 13 exit Exits from the current command mode to the next highest
mode in the configuration mode hierarchy.
Example:
Router(config-register-pool)# exit
Step 14 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Step 15 no upgrade Return to the default for the upgrade command.
Example:
Router(config-register-global)# no upgrade
Step 16 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-global)# end
Examples
The following example shows the configuration steps for upgrading firmware for a Cisco Unified IP
Phone 7960G or Cisco Unified IP Phone 7940G from SIP 5.3 to SIP 6.0, then from SIP 6.0 to SIP 7.4:
Router(config)# voice register global
Router(config-register-global)# mode cme
Router(config-register-global)# load 7960 P0S3-06-0-00
Router(config-register-global)# upgrade
Router(config-register-global)# load 7960 P0S3-07-4-00
Router(config-register-global)# create profile
The following example shows the configuration steps for downgrading firmware for a Cisco Unified IP
Phone 7960/40 from SIP 7.4 to SIP 6.0:
Router(config)# voice register global
Router(config-register-global)# mode cme
Router(config-register-global)# load 7960 P0S3-06-0-00
Router(config-register-global)# upgrade
Cisco Unified Communications Manager Express System Administrator Guide
64 OL-10663-02
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
Router(config-register-global)# create profile
What to Do Next
• If the Cisco Unified IP phone to be upgraded is not configured in Cisco Unified CME, see “How to
Configure Phones for a PBX System” on page 158.
• If the Cisco Unified IP phone is already configured in Cisco Unified CME and can make and receive
calls, you are ready to reboot the Cisco Unified IP phones to download the phone firmware to the
phone. See “Resetting and Restarting Phones” on page 271.
SCCP: Converting Phone Firmware to SIP
To upgrade the phone firmware for a particular phone from SCCP to SIP, follow the steps in this task.
If Cisco Unified IP phones presently connected to Cisco Unified CME are using the SCCP protocol to
receive and place calls and you now want some or all of these phones to use the SIP protocol, the phone
firmware for each phone type must be upgraded from SCCP to the recommended SIP version before the
phones can register. If Cisco Unified IP phones to be connected to Cisco Unified CME are brand new,
out-of-the-box, the SCCP phone firmware preloaded at the factory must be upgraded to the
recommended SIP version before your SIP phones can complete registration.
Note If codec values for the dial peers of a connection do not match, the call fails. The default codec for the
POTS dial peer for an SCCP phone is G.711 and the default codec for a VoIP dial peer for a SIP phone
is G.729. If neither the SCCP phone nor the SIP phone in Cisco Unified CME has been specifically
configured to change the codec, calls between the two IP phones on the same router will produce a busy
signal caused by the mismatched default codecs. To avoid codec mismatch, specify the codec for IP
phones in Cisco Unified CME. For configuration information, see the “Configuring Codecs of
Individual Phones for Calls Between Local Phones” section on page 184.
Prerequisites
• Phone firmware for Cisco Unified IP phones to be connected to Cisco Unified CME, including all
versions required during an upgrade or downgrade sequence, must be loaded in the flash memory of
the TFTP server from which the phones download their configuration profiles. For information
about installing firmware files in flash memory, see the “Installing Cisco Unified CME Software”
section on page 58.
• Cisco Unified IP Phone 7940Gs and Cisco Unified IP Phone 7960Gs—If these IP phones are
already configured in Cisco Unified CME to use the SCCP protocol, the SCCP phone firmware on
the phone must be version 5.x. If required, upgrade the SCCP phone firmware to 5.x before
upgrading to SIP.
SUMMARY STEPS
1. enable
2. configure terminal
3. no ephone ephone-tag
4. exit
5. no ephone-dn dn-tag
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 65
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
6. exit
7. voice register global
8. mode cme
9. load phone-type firmware-file
10. upgrade
11. Repeat previous two steps.
12. create profile
13. file text
14. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 no ephone ephone-tag (Optional) Disables the ephone and removes the ephone
configuration.
Example: • Required only if the Cisco Unified IP phone to be
Router (config)# no ephone 23 configured is already connected to Cisco Unified CME
and is using SCCP protocol.
• ephone-tag—Particular IP phone to which this
configuration change will apply.
Step 4 exit (Optional) Exits from the current command mode to the
next highest mode in the configuration mode hierarchy.
Example: • Required only if you performed the previous step.
Router(config-ephone)# exit
Step 5 no ephone-dn dn-tag (Optional) Disables the ephone-dn and removes the
ephone-dn configuration.
• Required only if this directory number is not now nor
will be associated to any SCCP phone line, intercom
line, paging line, voice-mail port, or message-waiting
indicator (MWI) connected to Cisco Unified CME.
• dn-tag—Particular configuration to which this change
will apply.
Step 6 exit (Optional) Exits from the current command mode to the
next highest mode in the configuration mode hierarchy.
Example: • Required only if you performed the previous step.
Router(config-ephone-dn)# exit
Cisco Unified Communications Manager Express System Administrator Guide
66 OL-10663-02
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
Command or Action Purpose
Step 7 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Step 8 mode cme Enables mode for provisioning SIP phones in
Cisco Unified CME.
Example:
Router(config-register-global)# mode cme
Step 9 load phone-type firmware-file Associates a phone type with a phone firmware file.
• A separate load command is required for each IP phone
Example: type.
Router(config-register-global)# load 7960-7940
P0S3-06-3-00
Step 10 upgrade Generates a file with the universal application loader image
for upgrading phone firmware and performs the TFTP
server alias binding.
Example:
Router(config-register-global)# upgrade
Step 11 Repeat previous two steps (Optional) Repeat for each version required in multistep
upgrade sequences only.
Example:
Router(config-register-global)# load 7960-7940
P0S3-07-4-00
Router(config-register-global)# upgrade
Step 12 create profile Generates provisioning files required for SIP phones and
writes the file to the location specified with the tftp-path
command.
Example:
Router(config-register-global;)# create profile
Step 13 file text (Optional) Generates ASCII text files for Cisco Unified IP
Phones 7905 and 7905G, Cisco Unified IP Phone 7912 and
Cisco Unified IP Phone 7912G, Cisco ATA-186, or
Example:
Router(config-register-global)# file text
Cisco ATA-188.
• Default—System generates binary files to save disk
space.
Step 14 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-global)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 67
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
Examples
The following example shows the configuration steps for converting firmware on an Cisco Unified IP
phone already connected in Cisco Unified CME and using the SCCP protocol, from SCCP 5.x to SIP 7.4:
Router(config)# telephony-service
Router(config-telephony)# no create cnf
CNF files deleted
Router(config-telephony)# voice register global
Router(config-register-global)# mode cme
Router(config-register-global)# load 7960 P0S3-07-4-00
Router(config-register-global)# upgrade
Router(config-register-global)# create profile
What to Do Next
After you configure the upgrade command, refer to the following statements to determine which task to
perform next.
• If the Cisco Unified IP phone to be upgraded is already connected in Cisco Unified CME and you
removed the SCCP configuration file for the phone but have not configured this phone for SIP in
Cisco Unified CME, see “How to Configure Phones for a PBX System” on page 158.
• If the Cisco Unified IP phones to be upgraded are already configured in Cisco Unified CME, see
“Resetting and Restarting Phones” on page 271.
SIP: Converting Phone to SCCP
To upgrade the phone firmware for a particular phone from SIP to SCCP, follow the steps in this task.
If Cisco Unified IP phones presently connected to Cisco Unified CME are using the SIP protocol to
receive and place calls and you now want some or all of these phones to use the SCCP protocol, the
phone firmware for each phone type must be upgraded from SIP to SCCP before the phones can register.
Note If codec values for the dial peers of a connection do not match, the call fails. The default codec for the
POTS dial peer for an SCCP phone is G.711 and the default codec for a VoIP dial peer for a SIP phone
is G.729. If neither the SCCP phone nor the SIP phone in Cisco Unified CME has been specifically
configured to change the codec, calls between the two IP phones on the same router will produce a busy
signal caused by the mismatched default codecs. To avoid codec mismatch, specify the codec for SIP and
SCCP phones in Cisco Unified CME. For more information, see “How to Configure Phones for a PBX
System” on page 158.
Prerequisites
• Phone firmware for Cisco Unified IP phones to be connected to Cisco Unified CME, including all
versions required during an upgrade or downgrade sequence, must be loaded in the flash memory of
the TFTP server from which the phones will download their configuration profiles. For information
about installing firmware files in flash memory, see the “Installing Cisco Unified CME Software”
section on page 58.
• Cisco Unified IP Phone 7940Gs and Cisco Unified IP Phone 7960Gs—If these IP phones are
already configured in Cisco Unified CME to use the SIP protocol, the SIP phone firmware must be
version 7.x. See the “SIP: Upgrading or Downgrading Phone Firmware Between Versions” section
on page 61.
Cisco Unified Communications Manager Express System Administrator Guide
68 OL-10663-02
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
Removing a SIP Configuration Profile
To remove the SIP configuration profile before downloading the SCCP phone firmware to convert a
phone from SIP to SCCP, perform the steps in this task.
SUMMARY STEPS
1. enable
2. configure terminal
3. no voice register pool pool-tag
4. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 no voice register pool pool-tag Disables voice register pool and removes the voice pool
configuration.
Example: • pool-tag—Unique sequence number for a particular
Router(config)# no voice register pool 1 SIP phone to which this configuration applies.
Step 4 end Exits from the current command mode to the next highest
mode in the configuration mode hierarchy.
Example:
Router(config-register-pool)# end
Generating an SCCP XML Configuration File for Upgrading from SIP to SCCP
To create an ephone entry and generate a new SCCP XML configuration file for upgrading a particular
Cisco Unified IP phone in Cisco Unified CME from SIP to SCCP, perform the steps in this task.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
4. exit
5. tftp-server device:firmware-file
6. telephony service
7. load phone-type firmware-file
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 69
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
8. create cnf-files
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode, creates an
ephone-dn, and optionally assigns it dual-line status.
Example: • dn-tag—Unique sequence number that identifies this
Router(config)# ephone dn 1 ephone-dn during configuration tasks. The maximum
number of ephone-dns in Cisco Unified CME is
version and platform specific. Type ? to display range.
Step 4 exit Exits from the current command mode to the next highest
mode in the configuration mode hierarchy.
Example:
Router(config-ephone-dn)# exit
Step 5 tftp-server device:firmware-file (Optional) Creates TFTP bindings to permit IP phones
served by the Cisco Unified CME router to access the
specified file.
Example:
Router(config)# tftp-server • A separate tftp-server command is required for each
flash:P00307020300.loads phone type.
Router(config)# tftp-server
flash:P00307020300.sb2 • Required for Cisco Unified CME 7.0/4.3 and earlier
Router(config)# tftp-server versions.
flash:P00307020300.sbn
Router(config)# tftp-server • Cisco Unified CME 7.0(1) and later versions: Required
flash:P00307020300.bin only if the location for cnf files is not flash or slot 0.
Use the complete filename, including the file suffix, for
phone firmware versions later than version 8-2-2 for all
phone types.
Step 6 telephony service Enters telephone-service configuration mode.
Example:
Router(config)# telephony service
Cisco Unified Communications Manager Express System Administrator Guide
70 OL-10663-02
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
Command or Action Purpose
Step 7 load phone-type firmware-file Associates a phone type with a phone firmware file.
• A separate load command is required for each IP phone
Example: type.
Router(config-telephony)# load 7960-7940
P00307020300
• firmware-file—Filename is case-sensitive.
– Cisco Unified CME 7.0/4.3 and earlier versions:
Do not use the .sbin or .loads file extension except
for the Cisco ATA and Cisco Unified IP Phone
7905 and 7912.
– Cisco Unified CME 7.0(1) and later versions: Use
the complete filename, including the file suffix, for
phone firmware versions later than version 8-2-2
for all phone types
Step 8 create cnf-files Builds XML configuration files required for SCCP phones.
Example:
Router(config-telephony)# create cnf-files
Step 9 end Exits to privileged EXEC mode.
Example:
Router(config-telephony)# end
Examples
The following example shows the configuration steps for upgrading firmware for a Cisco Unified IP
Phone 7960G from SIP to SCCP. First the SIP firmware is upgraded to SIP 6.3 and from SIP 6.3 to SIP
7.4; then, the phone firmware is upgraded from SIP 7.4 to SCCP 7.2(3). The SIP configuration profile is
deleted and a new ephone configuration profile is created for the Cisco Unified IP phone.
Router(config)# voice register global
Router(config-register-global)# mode cme
Router(config-register-global)# load 7960 P0S3-06-0-00
Router(config-register-global)# upgrade
Router(config-register-global)# load 7960 P0S3-07-4-00
Router(config-register-global)# exit
Router(config)# no voice register pool 1
Router(config-register-pool)# exit
Router(config)# voice register global
Router(config-register-global)# no upgrade
Router(config-register-global)# exit
Router(config)# ephone-dn 1
Router(config-ephone-dn)# exit
Router(config)# tftp-server flash:P00307020300.loads
Router(config)# tftp-server flash:P00307020300.sb2
Router(config)# tftp-server flash:P00307020300.sbn
Router(config)# tftp-server flash:P00307020300.bin
Router(config)# telephony service
Router(config-telephony)# load 7960-7940 P00307000100
Router(config-telephony)# create cnf-files
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 71
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
What to Do Next
After you configure the upgrade command:
• If the Cisco Unified IP phone to be upgraded is already connected in Cisco Unified CME and you
removed the SIP configuration file for the phone and have not configured the SCCP phone in
Cisco Unified CME, see “How to Configure Phones for a PBX System” on page 158.
• If the Cisco Unified IP phones to be upgraded are already configured in Cisco Unified CME, see
“Resetting and Restarting Phones” on page 271.
SCCP: Verifying the Phone Firmware Version on an IP Phone
To verify which version firmware is on an IP phone, perform the following steps.
SUMMARY STEPS
1. show flash:
2. show ephone phone-load
DETAILED STEPS
Step 1 show flash:
Use this command to learn the filenames associated with that phone firmware
Router# show flash:
31 128996 Sep 19 2005 12:19:02 -07:00 P00307020300.bin
32 461 Sep 19 2005 12:19:02 -07:00 P00307020300.loads
33 681290 Sep 19 2005 12:19:04 -07:00 P00307020300.sb2
34 129400 Sep 19 2005 12:19:04 -07:00 P00307020300.sbn
Step 2 show ephone phone-load
Use this command to verify which phone firmware is installed on a particular ephone. The DeviceName
includes the MAC address for the IP phone.
Router# show ephone phone-load
DeviceName CurrentPhoneload PreviousPhoneload LastReset
=====================================================================
SEP000A8A2C8C6E 7.3(3.02) Initialized
Cisco Unified Communications Manager Express System Administrator Guide
72 OL-10663-02
Installing and Upgrading Cisco Unified CME Software
How to Install and Upgrade Cisco Unified CME Software
Troubleshooting Tips
Use the debug tftp event command to troubleshoot an attempt to upgrade or convert Cisco phone
firmware files for SIP phones. The following sample from the debug tftp event command shows how
the Cisco phone firmware for a Cisco Unified IP Phone 7940G is upgraded from SCCP 5.X to SIP 6.3.
The configuration profiles are downloaded when a phone is rebooted or reset.
Router# debug tftp event
…
Router(config)# telephony-service
Router(config-telephony)# no create cnf
CNF files deleted
Router(config-telephony)# voice register global
Router(config-register-global)# load 7960 P0S3-06-3-00
Router(config-register-global)# upgrade
Router(config-register-global)# create profile
Router(config-register-global)#
*May 6 17:37:03.737: %IPPHONE-6-UNREGISTER_NORMAL: ephone-1:SEP000ED7DF7932 IP:1.5.49.84
Socket:4
DeviceType:Phone has unregistered normally.
*May 6 17:37:35.949: TFTP: Looking for OS79XX.TXT
*May 6 17:37:36.413: TFTP: Opened system:/cme/sipphone/OS79XX.TXT, fd 4, size 13 for
process 81
*May 6 17:37:36.413: TFTP: Finished system:/cme/sipphone/OS79XX.TXT, time 00:00:00 for
process 81
*May 6 17:37:40.533: TFTP: Looking for P0S3-06-3-00.sbn
*May 6 17:37:40.541: TFTP: Opened flash:P0S3-06-3-00.sbn, fd 4, size 487198 for process 81
*May 6 17:37:48.225: TFTP: Finished flash:P0S3-06-3-00.sbn, time 00:00:07 for process 81
*May 6 17:40:26.925: TFTP: Looking for OS79XX.TXT
*May 6 17:40:26.925: TFTP: Opened system:/cme/sipphone/OS79XX.TXT, fd 4, size 13 for
process 81
*May 6 17:40:26.925: TFTP: Finished system:/cme/sipphone/OS79XX.TXT, time 00:00:00 for
process 81
*May 6 17:40:26.929: TFTP: Looking for SIPDefault.cnf
*May 6 17:40:26.929: TFTP: Opened system:/cme/sipphone/SIPDefault.cnf, fd 4, size 1558 for
process 81
*May 6 17:40:26.937: TFTP: Finished system:/cme/sipphone/SIPDefault.cnf, time 00:00:00 for
process 81
*May 6 17:40:27.053: TFTP: Looking for SIP000ED7DF7932.cnf
*May 6 17:40:27.053: TFTP: Opened system:/cme/sipphone/SIP000ED7DF7932.cnf, fd 4, size 789
for process 81
*May 6 17:40:27.057: TFTP: Finished system:/cme/sipphone/SIP000ED7DF7932.cnf, time
00:00:00 for process 81
The following sample from the debug tftp event command shows how the Cisco phone firmware for a
Cisco Unified IP Phone 7940G is upgraded from SIP 6.3 to SIP 7.0 after the phone is rebooted or reset:
Router# debug tftp event
…
Router(config-register-global)# load 7960 P003-07-4-00
Router(config-register-global)# upgrade
Router(config-register-global)# load 7960 P0S3-07-4-00
Router(config-register-global)# create profile
Router(config-register-global)# end
Router-2012#
*May 6 17:42:35.581: TFTP: Looking for OS79XX.TXT
*May 6 17:42:35.585: TFTP: Opened system:/cme/sipphone/OS79XX.TXT, fd 5, size 13 for
process 81
*May 6 17:42:35.585: TFTP: Finished system:/cme/sipphone/OS79XX.TXT, time 00:00:00 for
process 81
*May 6 17:42:35.969: TFTP: Looking for P003-07-4-00.sbn
*May 6 17:42:35.977: TFTP: Opened slot0:P003-07-4-00.sbn, fd 5, size 129876 for process 81
*May 6 17:42:37.937: TFTP: Finished slot0:P003-07-4-00.sbn, time 00:00:01 for process 81
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 73
Installing and Upgrading Cisco Unified CME Software
Additional References
*May 6 17:44:31.037: TFTP: Looking for CTLSEP000ED7DF7932.tlv
*May 6 17:44:31.057: TFTP: Looking for SEP000ED7DF7932.cnf.xml
*May 6 17:44:31.089: TFTP: Looking for SIP000ED7DF7932.cnf
*May 6 17:44:31.089: TFTP: Opened system:/cme/sipphone/SIP000ED7DF7932.cnf, fd 5, size 789
for process 81
*May 6 17:44:31.089: TFTP: Finished system:/cme/sipphone/SIP000ED7DF7932.cnf, time
00:00:00 for process 81
*May 6 17:44:31.125: TFTP: Looking for P0S3-07-4-00.loads
*May 6 17:44:31.133: TFTP: Opened slot0:P0S3-07-4-00.loads, fd 5, size 461 for process 81
*May 6 17:44:31.141: TFTP: Finished slot0:P0S3-07-4-00.loads, time 00:00:00 for process 81
*May 6 17:44:31.673: TFTP: Looking for P0S3-07-4-00.sb2
*May 6 17:44:31.681: TFTP: Opened slot0:P0S3-07-4-00.sb2, fd 5, size 592626 for process 81
*May 6 17:44:33.989: TFTP: Finished slot0:P0S3-07-4-00.sb2, time 00:00:02 for process 81
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
74 OL-10663-02
Defining Network Parameters
Last Updated: March 8, 2010
This chapter describes how to define parameters that enable Cisco Unified Communications Manager
Express (Cisco Unified CME) to work with your network.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Network Parameters”
section on page 100.
Contents
• Prerequisites for Defining Network Parameters, page 75
• Information About Defining Network Parameters, page 76
• How to Define Network Parameters, page 79
• Configuration Examples for Network Parameters, page 98
• Where to Go Next, page 99
• Additional References, page 99
• Feature Information for Network Parameters, page 100
Prerequisites for Defining Network Parameters
• IP routing must be enabled.
• VoIP networking must be operational. For quality and security purposes, we recommend you have
separate virtual LANs (VLANs) for data and voice. The IP network assigned to each VLAN should
be large enough to support addresses for all nodes on that VLAN. Cisco Unified CME phones
receive their IP addresses from the voice network, whereas all other nodes such as PCs, servers, and
printers receive their IP addresses from the data network. For configuration information, see the
“How to Configure VLANs on a Cisco Switch” section on page 41.
• If applicable, PSTN lines are configured and operational.
• If applicable, the WAN links are configured and operational.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 75
Defining Network Parameters
Restrictions for Defining Network Parameters
• Trivial File Transfer Protocol (TFTP) must be enabled on the router to allow IP phones to download
phone firmware files.
• To support IP phones that are running SIP to be directly connected to the Cisco Unified CME router,
Cisco Unified CME 3.4 or later must be installed on the router. For installation information, see
“Installing and Upgrading Cisco Unified CME Software” on page 53.
• To provide voice-mail support for phones connected to the Cisco Unified CME router, install and
configure voice mail on your network.
Restrictions for Defining Network Parameters
In Cisco Unified CME 4.0 and later versions, Layer-3-to-Layer-2 VLAN Class of Service (CoS) priority
marking is not automatically processed. Cisco Unified CME 4.0 and later versions will continue to mark
Layer 3, but Layer 2 marking is now only handled in the Cisco IOS software. Any Quality of Service
(QoS) design that requires Layer 2 marking will have to be explicitly configured, either on a Catalyst
switch that supports this capability or on the Cisco Unified CME router under the Ethernet interface
configuration. For configuration information, see the Enterprise QoS Solution Reference Network
Design Guide.
Information About Defining Network Parameters
To configure network parameters, you should understand the following concepts:
• DHCP Service, page 76
• Network Time Protocol for the Cisco Unified CME Router, page 77
• DTMF Relay, page 77
• SIP Register Support, page 77
• Out-of-Dialog REFER, page 78
DHCP Service
When a Cisco Unified IP phone is connected to the Cisco Unified CME system, it automatically queries
for a Dynamic Host Configuration Protocol (DHCP) server. The DHCP server responds by assigning an
IP address to the Cisco Unified IP phone and providing the IP address of the TFTP server through DHCP
option 150. Then the phone registers with the Cisco Unified CME server and attempts to get
configuration and phone firmware files from the TFTP server.
For configuration information, perform only one of the following procedures to set up DHCP service for
your IP phones:
• If your Cisco Unified CME router is the DHCP server and you can use a single shared address pool
for all your DHCP clients, see the “Defining a Single DHCP IP Address Pool” section on page 82.
• If your Cisco Unified CME router is the DHCP server and you need separate pools for non-IP-phone
DHCP clients, see the “Defining a Separate DHCP IP Address Pool for Each DHCP Client” section
on page 84.
• If the Cisco Unified CME router is not the DHCP server and you want to relay DHCP requests from
IP phones to a DHCP server on a different router, see the “Defining a DHCP Relay” section on
page 86.
Cisco Unified Communications Manager Express System Administrator Guide
76 OL-10663-02
Defining Network Parameters
Information About Defining Network Parameters
Network Time Protocol for the Cisco Unified CME Router
Network Time Protocol (NTP) allows you to synchronize your Cisco Unified CME router to a single
clock on the network, known as the clock master. NTP is disabled on all interfaces by default, but it is
essential for Cisco Unified CME so you must ensure that it is enabled. For information about configuring
NTP for the Cisco Unified CME router, see the “Enabling Network Time Protocol on the Cisco Unified
CME Router” section on page 88.
DTMF Relay
IP phones connected to Cisco Unified CME systems require the use of out-of-band DTMF relay to
transport DTMF (keypad) digits across VoIP connections. The reason for this is that the codecs used for
in-band transport may distort DTMF tones and make them unrecognizable. DTMF relay solves the
problem of DTMF tone distortion by transporting DTMF tones out-of-band, or separate, from the
encoded voice stream.
For IP phones on H.323 networks, DTMF is relayed using the H.245 alphanumeric method, which is
defined by the ITU H.245 standard. This method separates DTMF digits from the voice stream and sends
them as ASCII characters in H.245 user input indication messages through the H.245 signaling channel
instead of the RTP channel. For information about configuring a DTMF relay in a multisite installation,
see the “Configuring DTMF Relay for H.323 Networks in Multisite Installations” section on page 89.
To use remote voice-mail or IVR applications on SIP networks from Cisco Unified CME phones, the
DTMF digits used by the Cisco Unified CME phones must be converted to the RFC 2833 in-band DTMF
relay mechanism used by SIP phones. The SIP DTMF relay method is needed in the following situations:
• When SIP is used to connect a Cisco Unified CME system to a remote SIP-based IVR or voice-mail
application.
• When SIP is used to connect a Cisco Unified CME system to a remote SIP-PSTN voice gateway that
goes through the PSTN to a voice-mail or IVR application.
The requirement for out-of-band DTMF relay conversion is limited to SCCP phones. SIP phones natively
support in-band DTMF relay as specified in RFC 2833.
To use voice mail on a SIP network that connects to a Cisco Unity Express system, which uses a
nonstandard SIP Notify format, the DTMF digits used by the Cisco Unified CME phones must be
converted to the Notify format. Additional configuration may be required for backward compatibility
with Cisco CME 3.0 and 3.1. For configuration information about enabling DTMF relay for SIP
networks, see “Configuring SIP Trunk Support” section on page 90.
SIP Register Support
SIP register support enables a SIP gateway to register E.164 numbers with a SIP proxy or SIP registrar,
similar to the way that H.323 gateways can register E.164 numbers with a gatekeeper. SIP gateways
allow registration of E.164 numbers to a SIP proxy or registrar on behalf of analog telephone voice ports
(FXS) and IP phone virtual voice ports (EFXS) for local SCCP phones.
When registering E.164 numbers in dial peers with an external registrar, you can also register them with
a secondary SIP proxy or registrar to provide redundancy. The secondary registration can be used if the
primary registrar fails. For configuration information, see the “Basic SIP Configuration” chapter in the
Cisco IOS SIP Configuration Guide.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 77
Defining Network Parameters
Information About Defining Network Parameters
Note No commands allow registration between the H.323 and SIP protocols.
By default, SIP gateways do not generate SIP Register messages, so the gateway must be configured to
register the gateway’s E.164 telephone numbers with an external SIP registrar. For information about
configuring the SIP gateway to register phone numbers with Cisco Unified CME, see the “Configuring
SIP Trunk Support” section on page 90.
Note When you configure SIP on a router, the ports on all its interfaces are open by default. This makes the
router vulnerable to malicious attackers who can execute toll fraud across the gateway if the router has
a public IP address and a public switched telephone network (PSTN) connection. To eliminate the threat,
you should bind an interface to private IP address that is not accessible by untrusted hosts. In addition, you
should protect any public or untrusted interface by configuring a firewall or an access control list (ACL)
to prevent unwanted traffic from traversing the router.
Out-of-Dialog REFER
Out-of-dialog REFER (OOD-R) allows remote applications to establish calls by sending a REFER
message to Cisco Unified CME without an initial INVITE. After the REFER is sent, the remainder of
the call setup is independent of the application and the media stream does not flow through the
application. The application using OOD-R triggers a call setup request that specifies the Referee address
in the Request-URI and the Refer-Target in the Refer-To header. The SIP messaging used to
communicate with Cisco Unified CME is independent of the end-user device protocol which can be SIP,
SCCP, H.323, or POTS. Click-to-dial is an example of an application that can be created using OOD-R.
A click-to-dial application allows users to combine multiple steps into one click for a call setup. For
example, a user can click a web-based directory application from their PC to look up a telephone number,
off-hook their desktop phone, and dial the called number. The application initiates the call setup without
the user having to out-dial from their own phone. The directory application sends a REFER message to
Cisco Unified CME which sets up the call between both parties based on this REFER.
Figure 6 shows an example of OOD-R being used by a click-to-dial application. In this scenario, the
following events occur (refer to the event numbers in the illustration):
1. Remote user clicks to dial.
2. Application sends out-of-dialog REFER to Cisco Unified CME 1.
3. Cisco Unified CME 1 connects to SIP phone 1 (Referee).
4. Cisco Unified CME 1 sends INVITE to Cisco Unified CME 2.
5. Cisco Unified CME 2 sends INVITE to SIP phone 2 (Refer-Target) and the call is accepted.
6. Voice path is created between the two SIP phones.
Cisco Unified Communications Manager Express System Administrator Guide
78 OL-10663-02
Defining Network Parameters
How to Define Network Parameters
Figure 6 Click-to-Dial Application using Out-of-Dialog REFER
Cisco Unified CME 2
Directory SIP 4
services
application
6
1 IP
6 5
2
IP 3 IP
IP phone 1 IP phone 2
6
Cisco Unified CME 1
155789
PSTN
The initial OOD-R request can be authenticated and authorized using RFC 2617-based digest
authentication. To support authentication, Cisco Unified CME retrieves the credential information from
a text file stored in flash. This mechanism is used by Cisco Unified CME in addition to phone-based
credentials. The same credential file can be shared by other services that require request-based
authentication and authorization such as presence service. Up to five credential files can be configured
and loaded into the system. The contents of these five files are mutually exclusive, meaning the username
and password pairs must be unique across all the files. The username and password pairs must also be
different than those configured for SCCP or SIP phones in a Cisco Unified CME system.
For configuration information, see the “Enabling OOD-R” section on page 94.
How to Define Network Parameters
This section contains the following tasks. You may not need to perform all of these procedures.
• Enabling Calls in Your VoIP Network, page 80 (required)
• Defining DHCP, page 82 (required)
• Enabling Network Time Protocol on the Cisco Unified CME Router, page 88 (required)
• Configuring DTMF Relay for H.323 Networks in Multisite Installations, page 89 (optional)
• Configuring SIP Trunk Support, page 90 (optional)
• Verifying SIP Trunk Support Configuration, page 92 (optional)
• Changing the TFTP Address on a DHCP Server, page 93 (optional)
• Enabling OOD-R, page 94 (optional)
• Verifying OOD-R Configuration, page 96 (optional)
• Troubleshooting OOD-R, page 96 (optional)
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 79
Defining Network Parameters
How to Define Network Parameters
Enabling Calls in Your VoIP Network
To enable calls between endpoints in Cisco Unified CME, perform the following steps.
Restrictions
• SIP endpoints are not supported on H.323 trunks. SIP endpoints are supported on SIP trunks only.
• Cisco Unified CME 3.4 and later versions support Media Flow-through mode only; enabling
SIP-to-SIP calls is required before you can successfully make SIP-to-SIP calls.
• Media Flow-around configured with the media flow-around command is not supported by
Cisco Unified CME with SIP phones.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice service voip
4. allow-connections from-type to to-type
5. sip
6. registrar server [expires [max sec] [min sec]
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice service voip Enters voice service configuration mode and specifies Voice
over IP (VoIP) encapsulation.
Example:
Router(config)# voice service voip
Step 4 allow-connections from-type to to-type Enables calls between specific types of endpoints in a VoIP
network.
Example: • A separate allow-connections command is required for
Router(config-voi-srv)# allow-connections h323 each type of endpoint to be supported.
to h323
Router(config-voi-srv)# allow-connections h323
to SIP
Router(config-voi-srv)# allow-connections SIP
to SIP
Cisco Unified Communications Manager Express System Administrator Guide
80 OL-10663-02
Defining Network Parameters
How to Define Network Parameters
Command or Action Purpose
Step 5 sip (Optional) Enters SIP configuration mode.
• Required if you are connecting IP phones running SIP
Example: directly in Cisco CME 3.4 and later.
Router(config-voi-srv)# sip
Step 6 registrar server [expires [max sec][min sec]] (Optional) Enables SIP registrar functionality in
Cisco Unified CME.
Example: • Required if you are connecting IP phones running SIP
Router(config-voi-sip)# registrar server directly in Cisco CME 3.4 and later.
expires max 600 min 60
Note Cisco Unified CME does not maintain a persistent
database of registration entries across reloads.
Because SIP phones do not use a keepalive
functionality, the SIP phones must register again.
To decrease the amount of time after which the SIP
phones register again, we recommend that you
change the expiry.
• max sec—(Optional) Range: 600 to 86400.
Default: 3600. Recommended value: 600.
Note Ensure that the registration expiration timeout is set
to a value smaller than the TCP connection aging
timeout to avoid disconnection from the TCP.
• min sec—(Optional) Range: 60 to 3600. Default: 60.
Step 7 exit Exits dial-peer configuration mode.
Example:
Router(config-voi-sip)# exit
Step 8 sip-ua Enters SIP user-agent configuration mode.
Example:
Router(config)# sip-ua
Step 9 notify telephone-event max-duration time Configures the maximum time interval allowed between
two consecutive NOTIFY messages for a single DTMF
event.
Example:
Router(config-sip-ua)# notify telephone-event • max-duration time—Range: 500 to 3000.
max-duration 2000 Default: 2000.
Step 10 registrar {dns:host-name | ipv4:ip-address} Registers E.164 numbers on behalf of analog telephone
expires seconds [tcp] [secondary] voice ports (FXS) and IP phone virtual voice ports (EFXS)
with an external SIP proxy or SIP registrar server.
Example:
Router(config-sip-ua)# registrar
ipv4:10.8.17.40 expires 3600 secondary
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 81
Defining Network Parameters
How to Define Network Parameters
Command or Action Purpose
Step 11 retry register number Sets the total number of SIP Register messages that the
gateway should send.
Example: • number—Number of Register message retries.
Router(config-sip-ua)# retry register 10 Range: 1 to 10. Default: 10.
Step 12 timers register time Sets how long the SIP user agent (UA) waits before sending
Register requests.
Example: • time—Waiting time, in milliseconds.
Router(config-sip-ua)# timers register 500 Range: 100 to 1000. Default: 500.
Step 13 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-voi-sip)# end
Defining DHCP
To set up DHCP service for your DHCP clients, perform only one of the following procedures:
• If your Cisco Unified CME router is the DHCP server and you can use a single shared address pool
for all your DHCP clients, see Defining a Single DHCP IP Address Pool, page 82.
• If your Cisco Unified CME router is the DHCP server and you need separate pools for each IP phone
and each non-IP-phone DHCP client, see Defining a Separate DHCP IP Address Pool for Each
DHCP Client, page 84.
• If the Cisco Unified CME router is not the DHCP server and you want to relay DHCP requests from
IP phones to a DHCP server on a different router, see Defining a DHCP Relay, page 86.
Defining a Single DHCP IP Address Pool
To create a shared pool of IP addresses for all DHCP clients, perform the following step.
Note Do not perform this task if you already have a DHCP server on the LAN that can be used to provide
addresses to the Cisco Unified CME phones. See the “Enabling Network Time Protocol on the Cisco
Unified CME Router” section on page 88.
Prerequisites
Your Cisco Unified CME router is a DHCP server.
Restrictions
A single DHCP IP address pool cannot be used if non-IP-phone clients, such as PCs, must use a different
TFTP server address.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
82 OL-10663-02
Defining Network Parameters
How to Define Network Parameters
3. ip dhcp pool pool-name
4. network ip-address [mask | /prefix-length]
5. option 150 ip ip-address
6. default-router ip-address
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ip dhcp pool pool-name Creates a name for the DHCP server address pool
and enters DHCP pool configuration mode.
Example:
Router(config)# ip dhcp pool mypool
Step 4 network ip-address [mask | /prefix-length] Specifies the IP address of the DHCP address pool
to be configured.
Example:
Router(config-dhcp)# network 10.0.0.0 255.255.0.0
Step 5 option 150 ip ip-address Specifies the TFTP server address from which the
Cisco Unified IP phone downloads the image
configuration file.
Example:
Router(config-dhcp)# option 150 ip 10.0.0.1 • This is your Cisco Unified CME router’s
address.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 83
Defining Network Parameters
How to Define Network Parameters
Command or Action Purpose
Step 6 default-router ip-address (Optional) Specifies the router that the IP phones
will use to send or receive IP traffic that is external
to their local subnet.
Example:
Router(config-dhcp)# default-router 10.0.0.1 • If the Cisco Unified CME router is the only
router on the network, this address should be the
Cisco Unified CME IP source address. This
command can be omitted if IP phones need to
send or receive IP traffic only to or from devices
on their local subnet.
• The IP address that you specify for default
router will be used by the IP phones for fallback
purposes. If the Cisco Unified CME IP source
address becomes unreachable, IP phones will
attempt to register to the address specified in
this command.
Step 7 end Returns to privileged EXEC mode.
Example:
Router(config-dhcp)# end
What to Do Next
• If you are configuring Cisco Unified CME for the first time on this router, you are ready to configure
NTP for the Cisco Unified CME router. See the “Enabling Network Time Protocol on the Cisco
Unified CME Router” section on page 88.
• If you are finished modifying network parameters for an already configured Cisco Unified CME
router, see “Generating Configuration Files for Phones” on page 261.
Defining a Separate DHCP IP Address Pool for Each DHCP Client
To create a DHCP IP address pool for each DHCP client, including non-IP-phone clients such as PCs,
perform the following steps.
Note Do not perform this task if you already have a DHCP server on the LAN that can be used to provide
addresses to the Cisco Unified CME phones. See the “Enabling Network Time Protocol on the Cisco
Unified CME Router” section on page 88.
Prerequisites
Your Cisco Unified CME router is a DHCP server.
Restrictions
To use a separate DHCP IP address pool for each DHCP client, make an entry for each IP phone.
Cisco Unified Communications Manager Express System Administrator Guide
84 OL-10663-02
Defining Network Parameters
How to Define Network Parameters
SUMMARY STEPS
1. enable
2. configure terminal
3. ip dhcp pool pool-name
4. host ip-address subnet-mask
5. client-identifier mac-address
6. option 150 ip ip-address
7. default-router ip-address
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ip dhcp pool pool-name Creates a name for the DHCP server address pool
and enters DHCP pool configuration mode.
Example:
Router(config)# ip dhcp pool pool2
Step 4 host ip-address subnet-mask Specifies the IP address that you want the phone to
get.
Example:
Router(config-dhcp)# host 10.0.0.0 255.255.0.0
Step 5 client-identifier mac-address Specifies the MAC address of the phone, which is
printed on a label on each Cisco Unified IP phone.
Example: • A separate client-identifier command is
Router(config-dhcp)# client-identifier 01238.380.3056 required for each DHCP client.
• Add “01” prefix number before the MAC
address.
Step 6 option 150 ip ip-address Specifies the TFTP server address from which the
Cisco Unified IP phone downloads the image
configuration file.
Example:
Router(config-dhcp)# option 150 ip 10.0.0.1 • This is your Cisco Unified CME router’s
address.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 85
Defining Network Parameters
How to Define Network Parameters
Command or Action Purpose
Step 7 default-router ip-address (Optional) Specifies the router that the IP phones
will use to send or receive IP traffic that is external
to their local subnet.
Example:
Router(config-dhcp)# default-router 10.0.0.1 • If the Cisco Unified CME router is the only
router on the network, this address should be
the Cisco Unified CME IP source address.
This command can be omitted if IP phones
need to send or receive IP traffic only to or
from devices on their local subnet.
• The IP address that you specify for default
router will be used by the IP phones for
fallback purposes. If the Cisco Unified CME
IP source address becomes unreachable, IP
phones will attempt to register to the address
specified in this command.
Step 8 end Returns to privileged EXEC mode.
Example:
Router(config-dhcp)# end
What to Do Next
• If you are configuring Cisco Unified CME for the first time on this router, you are ready to configure
NTP for the Cisco Unified CME router. See the “Enabling Network Time Protocol on the Cisco
Unified CME Router” section on page 88.
• If you are finished modifying network parameters for an already configured Cisco Unified CME
router, see “Generating Configuration Files for Phones” on page 261.
Defining a DHCP Relay
To set up DHCP relay on the LAN interface where the Cisco Unified IP phones are connected and enable
the DHCP relay to relay requests from the phones to the DHCP server, perform the following steps.
Prerequisites
There is a DHCP server that is not on this Cisco Unified CME router on the LAN that can provide
addresses to the Cisco Unified CME phones.
Restrictions
This Cisco Unified CME router cannot be the DHCP server.
SUMMARY STEPS
1. enable
2. configure terminal
3. service dhcp
Cisco Unified Communications Manager Express System Administrator Guide
86 OL-10663-02
Defining Network Parameters
How to Define Network Parameters
4. interface type number
5. ip helper-address ip-address
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 service dhcp Enables the Cisco IOS DHCP server feature on the
router.
Example:
Router(config)# service dhcp
Step 4 interface type number Enters interface configuration mode for the
specified interface.
Example:
Router(config)# interface vlan 10
Step 5 ip helper-address ip-address Specifies the helper address for any unrecognized
broadcast for TFTP server and DNS server
requests.
Example:
Router(config-if)# ip helper-address 10.0.0.1 • A separate ip helper-address command is
required for each server if the servers are on
different hosts.
• You can also configure multiple TFTP server
targets by using the ip helper-address
commands for multiple servers.
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-if)# end
What to Do Next
• If you are configuring Cisco Unified CME for the first time on this router, you are ready to configure
NTP for the Cisco Unified CME router. See the “Enabling Network Time Protocol on the Cisco
Unified CME Router” section on page 88.
• If you are finished modifying network parameters for an already configured Cisco Unified CME
router, see “Generating Configuration Files for Phones” on page 261.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 87
Defining Network Parameters
How to Define Network Parameters
Enabling Network Time Protocol on the Cisco Unified CME Router
To enable NTP for the Cisco Unified CME router, perform this task.
SUMMARY STEPS
1. enable
2. configure terminal
3. clock timezone zone hours-offset [minutes-offset]
4. clock summer-time zone recurring [week day month hh:mm week day month hh:mm [offset]]
5. ntp server ip-address
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 clock timezone zone hours-offset [minutes-offset] Sets the local time zone.
Example:
Router(config)# clock timezone pst -8
Step 4 clock summer-time zone recurring [week day month hh:mm (Optional) Specifies daylight savings time.
week day month hh:mm [offset]]
• Default: summer time is disabled. If the clock
summer-time zone recurring command is
Example: specified without parameters, the summer
Router(config)# clock summer-time pdt recurring time rules default to United States rules.
Default of the offset argument is 60.
Step 5 ntp server ip-address Synchronize software clock of router with the
specified NTP server.
Example:
Router(config)# ntp server 10.1.2.3
Step 6 exit Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Cisco Unified Communications Manager Express System Administrator Guide
88 OL-10663-02
Defining Network Parameters
How to Define Network Parameters
What to Do Next
• If you are configuring Cisco Unified CME for the first time on this router and if you have a multisite
installation, you are ready to configure a DTMF relay. See the “Configuring DTMF Relay for H.323
Networks in Multisite Installations” section on page 89.
• If Cisco Unified CME will interact with a SIP Gateway, you must set up support for the gateway.
See the Configuring SIP Trunk Support, page 90.
• If you are configuring Cisco Unified CME for the first time on this router and you are ready to
configure system parameters. See “Configuring System-Level Parameters” on page 101.
• If you are finished modifying network parameters for an already configured Cisco Unified CME
router, see “Generating Configuration Files for Phones” on page 261.
Configuring DTMF Relay for H.323 Networks in Multisite Installations
To configure DTMF relay for H.323 networks in a multisite installation only, perform the following
steps.
Note To configure DTMF relay on SIP networks, see the “Configuring SIP Trunk Support” on page 90.
SUMMARY STEPS
1. enable
2. configure terminal
3. dial-peer voice tag voip
4. dtmf-relay h245-alphanumeric
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 dial-peer voice tag voip Enters dial-peer configuration mode.
Example:
Router(config)# dial-peer voice 2 voip
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 89
Defining Network Parameters
How to Define Network Parameters
Command or Action Purpose
Step 4 dtmf-relay h245-alphanumeric Specifies the H.245 alphanumeric method for
relaying dual tone multifrequency (DTMF) tones
between telephony interfaces and an H.323 network.
Example:
Router(config-dial-peer)# dtmf-relay
h245-alphanumeric
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-dial-peer)# end
What to Do Next
• To set up support for a SIP trunk, see the Configuring SIP Trunk Support, page 90.
• If you are configuring Cisco Unified CME for the first time on this router and you are ready to
configure system parameters. See “Configuring System-Level Parameters” on page 101.
• If you are finished modifying network parameters for an already configured Cisco Unified CME
router, see “Generating Configuration Files for Phones” on page 261.
Configuring SIP Trunk Support
To enable DTMF relay on a dial-peer for a SIP gateway and set up the gateway to register phone numbers
with Cisco Unified CME, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. dial-peer voice tag voip
4. dtmf-relay rtp-nte
5. dtmf-relay sip-notify
6. exit
7. sip-ua
8. notify telephone-event max-duration msec
9. registrar {dns:host-name | ipv4:ip-address} expires seconds [tcp] [secondary]
10. retry register number
11. timers register msec
12. end
Cisco Unified Communications Manager Express System Administrator Guide
90 OL-10663-02
Defining Network Parameters
How to Define Network Parameters
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 dial-peer voice tag voip Enters dial-peer configuration mode.
Example:
Router(config)# dial-peer voice 2 voip
Step 4 dtmf-relay rtp-nte Forwards DTMF tones by using Real-Time Transport
Protocol (RTP) with the Named Telephone Event (NTE)
payload type and enables DTMF relay using the RFC 2833
Example:
Router(config-dial-peer)# dtmf-relay rtp-nte
standard method.
Step 5 dtmf-relay sip-notify Forwards DTMF tones using SIP NOTIFY messages.
Example:
Router(config-dial-peer)# dtmf-relay sip-notify
Step 6 exit Exits dial-peer configuration mode.
Example:
Router(config-dial-peer)# exit
Step 7 sip-ua Enters SIP user-agent configuration mode.
Example:
Router(config)# sip-ua
Step 8 notify telephone-event max-duration msec Sets the maximum milliseconds allowed between two
consecutive NOTIFY messages for a single DTMF event.
Example: • max-duration time—Range: 500 to 3000.
Router(config-sip-ua)# notify telephone-event Default: 2000.
max-duration 2000
Step 9 registrar {dns:host-name | ipv4:ip-address} Registers E.164 numbers on behalf of analog telephone
expires seconds [tcp] [secondary] voice ports (FXS) and IP phone virtual voice ports (EFXS)
with an external SIP proxy or SIP registrar server.
Example:
Router(config-sip-ua)# registrar
ipv4:10.8.17.40 expires 3600 secondary
Step 10 retry register number Sets the total number of SIP Register messages that the
gateway should send.
Example: • number—Number of Register message retries.
Router(config-sip-ua)# retry register 10 Range: 1 to 10. Default: 10.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 91
Defining Network Parameters
How to Define Network Parameters
Command or Action Purpose
Step 11 timers register msec Sets how long the SIP user agent (UA) waits before sending
Register requests.
Example: • time—Waiting time, in milliseconds.
Router(config-sip-ua)# timers register 500 Range: 100 to 1000. Default: 500.
Step 12 end Returns to privileged EXEC mode.
Example:
Router(config-sip-ua)# end
Verifying SIP Trunk Support Configuration
To verify SIP trunk configuration, perform the following steps:
SUMMARY STEPS
1. show sip-ua status
2. show sip-ua timers
3. show sip-ua register status
4. show sip-ua statistics
DETAILED STEPS
Step 1 show sip-ua status
Use this command to display the time interval between consecutive NOTIFY messages for a telephone
event. In the following example, the time interval is 2000 ms.
Router# show sip-ua status
SIP User Agent Status
SIP User Agent for UDP :ENABLED
SIP User Agent for TCP :ENABLED
SIP User Agent bind status(signaling):DISABLED
SIP User Agent bind status(media):DISABLED
SIP early-media for 180 responses with SDP:ENABLED
SIP max-forwards :6
SIP DNS SRV version:2 (rfc 2782)
NAT Settings for the SIP-UA
Role in SDP:NONE
Check media source packets:DISABLED
Maximum duration for a telephone-event in NOTIFYs:2000 ms
SIP support for ISDN SUSPEND/RESUME:ENABLED
Redirection (3xx) message handling:ENABLED
SDP application configuration:
Version line (v=) required
Owner line (o=) required
Timespec line (t=) required
Media supported:audio image
Network types supported:IN
Address types supported:IP4
Transport types supported:RTP/AVP udptl
Cisco Unified Communications Manager Express System Administrator Guide
92 OL-10663-02
Defining Network Parameters
How to Define Network Parameters
Step 2 show sip-ua timers
This command displays the waiting time before Register requests are sent; that is, the value that has been
set with the timers register command.
Step 3 show sip-ua register status
This command displays the status of local E.164 registrations.
Step 4 show sip-ua statistics
ThIs command displays the Register messages that have been sent.
Changing the TFTP Address on a DHCP Server
To change the TFTP IP address after it has already been configured, perform the following steps.
Prerequisites
Your Cisco Unified CME router is a DHCP server.
Restrictions
If the DHCP server is on a different router than Cisco Unified CME, reconfigure the external DHCP
server with the new IP address of the TFTP server.
SUMMARY STEPS
1. enable
2. configure terminal
3. ip dhcp pool pool-name
4. option 150 ip ip-address
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 93
Defining Network Parameters
How to Define Network Parameters
Command or Action Purpose
Step 3 ip dhcp pool pool-name Enters DHCP pool configuration mode to create or
modify a DHCP pool.
Example: • pool-name—Previously configured unique
Router(config)# ip dhcp pool pool2 identifier for the pool to be configured.
Step 4 option 150 ip ip-address Specifies the TFTP server IP address from which
the Cisco Unified IP phone downloads the image
configuration file, XmlDefault.cnf.xml.
Example:
Router(config-dhcp)# option 150 ip 10.0.0.1
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-dhcp)# end
Enabling OOD-R
To enable OOD-R support on the Cisco Unified CME router, perform the following steps.
Prerequisites
• Cisco Unified CME 4.1 or a later version.
• The application that initiates OOD-R, such as a click-to-dial application, and its directory server
must be installed and configured.
– For information on the SIP REFER and NOTIFY methods used between the directory server and
Cisco Unified CME, see RFC 3515, The Session Initiation Protocol (SIP) Refer Method.
– For information on the message flow Cisco Unified CME uses when initiating a session
between the Referee and Refer-Target, see RFC 3725, Best Current Practices for Third Party
Call Control (3pcc).
Restrictions
• The call waiting, conferencing, hold, and transfer call features are not supported while the
Refer-Target is ringing.
• In a SIP to SIP scenario, no ringback is heard by the Referee when Refer-Target is ringing.
SUMMARY STEPS
1. enable
2. configure terminal
3. sip-ua
4. refer-ood enable [request-limit]
5. exit
6. voice register global
7. authenticate ood-refer
Cisco Unified Communications Manager Express System Administrator Guide
94 OL-10663-02
Defining Network Parameters
How to Define Network Parameters
8. authenticate credential tag location
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 sip-ua Enters SIP user-agent configuration mode to configure the
user agent.
Example:
Router(config)# sip-ua
Step 4 refer-ood enable [request-limit] Enables OOD-R processing.
• request-limit—Maximum number of concurrent
Example: incoming OOD-R requests that the router can process.
Router(config-sip-ua)# refer-ood enable 300 Range: 1 to 500. Default: 500.
Step 5 exit Exits SIP user-agent configuration mode.
Example:
Router(config-sip-ua)# exit
Step 6 voice register global Enters voice register global configuration mode to set
global parameters for all supported SIP phones in a
Cisco Unified CME or Cisco Unified SRST environment.
Example:
Router(config)# voice register global
Step 7 authenticate ood-refer (Optional) Enables authentication of incoming OOD-R
requests using RFC 2617-based digest authentication.
Example:
Router(config-register-global)# authenticate
ood-refer
Step 8 authenticate credential tag location (Optional) Specifies the credential file to use for
authenticating incoming OOD-R requests.
Example: • tag—Number that identifies the credential file to use
Router(config-register-global)# authenticate for OOD-R authentication. Range: 1 to 5.
credential 1 flash:cred1.csv
• location—Name and location of the credential file in
URL format. Valid storage locations are TFTP, HTTP,
and flash memory.
Step 9 end Exits to privileged EXEC mode.
Example:
Router(config-register-global)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 95
Defining Network Parameters
How to Define Network Parameters
Verifying OOD-R Configuration
Step 1 show running-config
This command verifies your configuration.
Router# show running-config
!
voice register global
mode cme
source-address 10.1.1.2 port 5060
load 7971 SIP70.8-0-1-11S
load 7970 SIP70.8-0-1-11S
load 7961GE SIP41.8-0-1-0DEV
load 7961 SIP41.8-0-1-0DEV
authenticate ood-refer
authenticate credential 1 tftp://172.18.207.15/labtest/cred1.csv
create profile sync 0004550081249644
.
.
.
sip-ua
refer-ood enable
Step 2 show sip-ua status refer-ood
This command displays OOD-R configuration settings.
Router# show sip-ua status refer-ood
Maximum allow incoming out-of-dialog refer 500
Current existing incoming out-of-dialog refer dialogs: 1
outgoing out-of-dialog refer dialogs: 0
Troubleshooting OOD-R
Step 1 debug ccsip messages
This command displays the SIP messages exchanged between the SIP UA client and the router.
Router# debug ccsip messages
SIP Call messages tracing is enabled
Aug 22 18:15:35.757: //-1/xxxxxxxxxxxx/SIP/Msg/ccsipDisplayMsg:
Received:
REFER sip:1011@10.5.2.141:5060 SIP/2.0
Via: SIP/2.0/UDP 172.18.204.144:59607;branch=z9hG4bK1238
From: <sip:1011@172.18.204.144>;tag=308fa4ba-4509
To: <sip:1001@10.5.2.141>
Call-ID: f93780-308fa4ba-0-767d@172.18.204.144
CSeq: 101 REFER
Max-Forwards: 70
Contact: <sip:1011@172.18.204.144:59607>
User-Agent: CSCO/7
Timestamp: 814720186
Refer-To: sip:1001@10.5.2.141
Referred-By: <sip:root@172.18.204.144>
Content-Length: 0
Cisco Unified Communications Manager Express System Administrator Guide
96 OL-10663-02
Defining Network Parameters
How to Define Network Parameters
Aug 22 18:15:35.773: //-1/xxxxxxxxxxxx/SIP/Msg/ccsipDisplayMsg:
Sent:
SIP/2.0 202 Accepted
Via: SIP/2.0/UDP 172.18.204.144:59607;branch=z9hG4bK1238
From: <sip:1011@172.18.204.144>;tag=308fa4ba-4509
To: <sip:1001@10.5.2.141>;tag=56D02AC-1E8E
Date: Tue, 22 Aug 2006 18:15:35 GMT
Call-ID: f93780-308fa4ba-0-767d@172.18.204.144
Timestamp: 814720186
CSeq: 101 REFER
Content-Length: 0
Contact: <sip:1011@172.18.204.141:5060>
Step 2 debug voip application oodrefer
This command displays debugging messages for the OOD-R feature.
Router# debug voip application oodrefer
voip application oodrefer debugging is on
Aug 22 18:16:21.625: //-1//AFW_:/C_ServiceThirdParty_Event_Handle:
Aug 22 18:16:21.625: //-1//AFW_:/AFW_ThirdPartyCC_New:
Aug 22 18:16:21.625: //-1//AFW_:EE461DC520000:/C_PackageThirdPartyCC_NewReq: ThirdPartyCC
module listened by TclModule_45F39E28_0_91076048
Aug 22 18:16:21.625: //-1//AFW_:EE461DC520000:/OCOpen_SetupRequest: Refer Dest1: 1011,
Refer Dest2: 1001; ReferBy User: root
Aug 22 18:16:21.693: //-1//AFW_:EE461DC520000:/OCHandle_SignalEvent_1:
Aug 22 18:16:21.693: //-1//AFW_:/Third_Party_CC_Send_Notify: Third_Party_CC_Send_Notify:
sending notify respStatus=2, final=FALSE, failureCause=16
Aug 22 18:16:21.693: //-1//AFW_:/Third_Party_CC_Send_Notify: AppNotify successful!
Aug 22 18:16:26.225: //-1//AFW_:EE461DC520000:/OCHandle_SignalEvent_1:
Aug 22 18:16:26.229: //-1//AFW_:EE461DC520000:/OCHandle_SignalEvent_1:
Aug 22 18:16:26.249: //-1//AFW_:EE461DC520000:/OCHandle_SignalEvent_2:
Aug 22 18:16:29.341: //-1//AFW_:EE461DC520000:/OCHandle_SignalEvent_2:
Aug 22 18:16:29.341: //-1//AFW_:/Third_Party_CC_Send_Notify: Third_Party_CC_Send_Notify:
sending notify respStatus=4, final=TRUE, failureCause=16
Aug 22 18:16:29.341: //-1//AFW_:/Third_Party_CC_Send_Notify: AppNotify successful!
Aug 22 18:16:29.349: //-1//AFW_:EE461DC520000:/OCHandle_Handoff: BAG contains:
Aug 22 18:16:29.349: LEG[895 ][LEG_INCCONNECTED(5)][Cause(0)]
Aug 22 18:16:29.349: CON[7 ][CONNECTION_CONFED(2)] {LEG[895
][LEG_INCCONNECTED(5)][Cause(0)],LEG[896 ][LEG_OUTCONNECTED(10)][Cause(0)]}
Aug 22 18:16:29.349: LEG[896 ][LEG_OUTCONNECTED(10)][Cause(0)]
Aug 22 18:16:29.365: //-1//AFW_:EE461DC520000:/OCAnyState_IgnoreEvent: Event Ignored
Aug 22 18:16:29.365: //-1//AFW_:/C_ServiceThirdParty_Event_Handle:
Aug 22 18:16:29.365: //-1//AFW_:EE461DC520000:/C_ServiceThirdParty_Event_Handle: Received
event APP_EV_NOTIFY_DONE[174] in Main Loop
Aug 22 18:16:29.365: //-1//AFW_:EE461DC520000:/OCAnyState_IgnoreEvent: Event Ignored
Aug 22 18:16:29.365: //-1//AFW_:/C_ServiceThirdParty_Event_Handle:
Aug 22 18:16:29.365: //-1//AFW_:EE461DC520000:/C_ServiceThirdParty_Event_Handle: Received
event APP_EV_NOTIFY_DONE[174] in Main Loop
Aug 22 18:16:29.369: //-1//AFW_:EE461DC520000:/OCHandle_SubscribeCleanup:
Aug 22 18:16:29.369: //-1//AFW_:EE461DC520000:/Third_Party_CC_Cleaner:
Aug 22 18:16:29.453: //-1//AFW_:EE461DC520000:/OCClosing_AnyEvent:
Aug 22 18:16:29.453: //-1//AFW_:EE461DC520000:/Third_Party_CC_Cleaner:
Aug 22 18:16:29.453: //-1//AFW_:EE461DC520000:/OCClosing_AnyEvent:
Aug 22 18:16:29.453: //-1//AFW_:EE461DC520000:/Third_Party_CC_Cleaner:
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 97
Defining Network Parameters
Configuration Examples for Network Parameters
Configuration Examples for Network Parameters
• NTP Server: Example, page 98
• DTMF Relay for H.323 Networks: Example, page 98
• OOD-R: Example, page 98
NTP Server: Example
The following example defines the pst timezone as 8 hours offset from UTC, using a recurring daylight
savings time called pdt, and synchronizes the clock with the NTP server at 10.1.2.3.
clock timezone pst -8
clock summer-time pdt recurring
ntp server 10.1.2.3
DTMF Relay for H.323 Networks: Example
The following excerpt from the show running-config command output shows a dial peer configured to
use H.245 alphanumeric DTMF relay:
dial-peer voice 4000 voip
destination-pattern 4000
session target ipv4:10.0.0.25
codec g711ulaw
dtmf-relay h245-alphanumeric
OOD-R: Example
voice register global
mode cme
source-address 11.1.1.2 port 5060
load 7971 SIP70.8-0-1-11S
load 7970 SIP70.8-0-1-11S
load 7961GE SIP41.8-0-1-0DEV
load 7961 SIP41.8-0-1-0DEV
authenticate ood-refer
authenticate credential 1 tftp://172.18.207.15/labtest/cred1.csv
create profile sync 0004550081249644
.
.
.
sip-ua
authentication username jack password 021201481F
refer-ood enable
Cisco Unified Communications Manager Express System Administrator Guide
98 OL-10663-02
Defining Network Parameters
Where to Go Next
Where to Go Next
• If you are configuring Cisco Unified CME for the first time on this router, you are ready to configure
system-level parameters. See “Configuring System-Level Parameters” on page 101.
• If you modified network parameters for an already configured Cisco Unified CME router, you are
ready to generate the configuration file to save the modifications. See “Generating Configuration
Files for Phones” on page 261
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME documentation roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 99
Defining Network Parameters
Feature Information for Network Parameters
Feature Information for Network Parameters
Table 8 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 8 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 8 Feature Information for Network Parameters
Cisco Unified CME
Feature Name Version Modification
Out-of-Dialog Refer 4.1 Out-of Dialog REFER support was added.
Cisco Unified Communications Manager Express System Administrator Guide
100 OL-10663-02
Configuring System-Level Parameters
Last Updated: October 7, 2009
This chapter describes the system-level settings to configure before you add devices and configure
Cisco Unified Communications Manager Express (Cisco Unified CME) features.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for System-Level
Parameters” section on page 138.
Contents
• Prerequisites for System-Level Parameters, page 101
• Information About Configuring System-Level Parameters, page 102
• How to Configure System-Level Parameters, page 106
• Configuration Examples for System-Level Parameters, page 131
• Where to Go Next, page 136
• Additional References, page 136
• Feature Information for System-Level Parameters, page 138
Prerequisites for System-Level Parameters
• To directly connect Cisco Unified IP phones that are running Session Initiation Protocol (SIP) in
Cisco Unified CME, Cisco CME 3.4 or a later version must be installed on the router. For
installation information, see “Installing and Upgrading Cisco Unified CME Software” on page 53.
• Cisco Unified CME must be configured to work with your IP network. For configuration
information, see “Defining Network Parameters” on page 75.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 101
Configuring System-Level Parameters
Information About Configuring System-Level Parameters
Information About Configuring System-Level Parameters
To configure system-level parameters, you should understand the following concepts:
• DSCP, page 102
• Maximum Ephones in Cisco Unified CME 4.3 and Later Versions, page 102
• Network Time Protocol for SIP Phones, page 103
• Per-Phone Configuration Files, page 103
• Redundant Cisco Unified CME Router, page 104
• Timeouts, page 105
DSCP
Differentiated Services Code Point (DSCP) packet marking is used to specify the class of service for
each packet. Cisco Unified IP Phones get their DSCP information from the configuration file that is
downloaded to the device.
In earlier versions of Cisco Unified CME, the DSCP value is predefined. In Cisco Unified CME 7.1 and
later versions, you can configure the DSCP value for different types of network traffic.
Cisco Unified CME downloads the configured DSCP value to SCCP and SIP phones in their
configuration files and all control messages and flow-through RTP streams are marked with the
configured DSCP value. This allows you to set different DSCP values, for example, for video streams
and audio streams.
For configuration information, see the “SCCP: Setting Up Cisco Unified CME” section on page 114 or
the “SIP: Setting Up Cisco Unified CME” section on page 125.
Maximum Ephones in Cisco Unified CME 4.3 and Later Versions
In Cisco Unified CME 4.3 and later versions, the max-ephones command is enhanced to set the
maximum number of SCCP phones that can register to Cisco Unified CME, without limiting the number
that can be configured. In previous versions of Cisco Unified CME, the max-ephones command defined
the maximum number of phones that could be both configured and registered.
This enhancement expands the maximum number of phones that can be configured to 1000. The
maximum number of phones that can register to Cisco Unified CME has not changed; it is dependent on
the number of phones supported by the hardware platform and is limited by the max-ephones command.
This enhancement supports features such as Extension Assigner that require you to configure more
phones than can register. For example, if you set the max-ephones command to 50 and configure 100
ephones, only 50 phones can register to Cisco Unified CME, one at a time in random order. The
remaining 50 phones cannot register and an error message displays for each rejected phone. This
enhancement also allows you to assign ephone tags that match the extension number of the phone, for
extensions up to 1000.
If you reduce the value of the max-ephones command, currently registered phones are not forced to
unregister until a reboot. If the number of registered phones, however, is already equal to or more than
the max-ephones value, no additional phones can register to Cisco Unified CME. If you increase the
value of the max-ephones command, the previously rejected ephones are able to register immediately
until the new limit is reached.
Cisco Unified Communications Manager Express System Administrator Guide
102 OL-10663-02
Configuring System-Level Parameters
Information About Configuring System-Level Parameters
Network Time Protocol for SIP Phones
SIP phones registered to a Cisco Unified CME router can synchronize to an NTP server. SIP phones can
synchronize to the Cisco Unified CME router; however, a router can lose its clock after a reboot causing
phones to display the wrong time. Synchronizing to an NTP server ensures that SIP phones maintain the
correct time. For configuration information, see the “SIP: Setting Network Time Protocol” section on
page 129.
Per-Phone Configuration Files
In Cisco Unified CME 4.0 and later versions, you can use an external TFTP server to off load the TFTP
server function on the Cisco Unified CME router. Using flash memory or slot 0 memory on the
Cisco Unified CME router allows you to use different configuration files for each phone type or for each
phone, which allows you to specify different user locales and network locales for different phones.
Before this version, you could specify only a single default user and network locale for a
Cisco Unified CME system.
You can specify one of the following four locations to store configuration files:
• System—This is the default. When system:/its is the storage location, there is only one default
configuration file for all phones in the system. All phones, therefore, use the same user locale and
network locale. User-defined locales are not supported.
• Flash or slot 0—When flash memory or slot 0 memory on the router is the storage location, you can
create additional configuration files to apply per phone type or per individual phone. Up to five user
and network locales can be used in these configuration files.
Note When the storage location chosen is flash memory and the file system type on this device is Class
B (LEFS), check free space on the device periodically and use the squeeze command to free the
space used up by deleted files. Unless you use the squeeze command, the space used by the
moved or deleted configuration files cannot be used by other files. Rewriting flash memory space
during the squeeze operation may take several minutes. We recommend using this command
during scheduled maintenance periods or off-peak hours.
• TFTP—When an external TFTP server is the storage location, you can create additional
configuration files that can be applied per phone type or per individual phone. Up to five user and
network locales can be used in these configuration files.
You can then specify one of the following ways to create configuration files:
• Per system—This is the default. All phones use a single configuration file. The default user and
network locale in a single configuration file are applied to all phones in the Cisco Unified CME
system. Multiple locales and user-defined locales are not supported.
• Per phone type—This setting creates separate configuration files for each phone type. For example,
all Cisco Unified IP Phone 7960s use XMLDefault7960.cnf.xml, and all Cisco Unified IP
Phone 7905s use XMLDefault7905.cnf.xml. All phones of the same type use the same configuration
file, which is generated using the default user and network locale. This option is not supported if
you store the configuration files in the system:/its location.
• Per phone—This setting creates a separate configuration file for each phone, by MAC address. For
example, a Cisco Unified IP Phone 7960 with the MAC address 123.456.789 creates the per-phone
configuration file SEP123456789.cnf.xml. The configuration file for a phone generates with the
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 103
Configuring System-Level Parameters
Information About Configuring System-Level Parameters
default user and network locale unless a different user and network locale is applied to the phone
using an ephone template. This option is not supported if you store the configuration files in the
system:/its location.
For configuration information, see the “SCCP: Defining Per-Phone Configuration Files and Alternate
Location” section on page 119.
Redundant Cisco Unified CME Router
A second Cisco Unified CME router can be configured to provide call-control services if the primary
Cisco Unified CME router fails. The secondary Cisco Unified CME router provides uninterrupted
services until the primary router becomes operational again.
When a phone registers to the primary router, it receives a configuration file from the primary router.
Along with other information, the configuration file contains the IP addresses of the primary and
secondary Cisco Unified CME routers. The phone uses these addresses to initiate a keepalive (KA)
message to each router. The phone sends a KA message after every KA interval (30 seconds by default)
to the router with which it is registered and after every two KA intervals (60 seconds by default) to the
other router. The KA interval can be adjusted.
If the primary router fails, a phone will not receive an acknowledgment (ACK) to its KA message to the
primary router. If the phone does not get an ACK from the primary router for three consecutive KAs, it
registers with the secondary Cisco Unified CME router.
During the time that the phone is registered to the secondary router, it keeps sending a KA probe to the
primary router to see if it has come back up, now every 60 seconds by default or two times the normal
KA interval. After the primary Cisco Unified CME router is operating normally, the phone starts
receiving ACKs for its probes. After the phone receives ACKs from the primary router for three
consecutive probes, it switches back to the primary router and reregisters with it. The reregistration of
phones with the primary router is also called rehoming.
The physical setup for redundant Cisco Unified CME routers is as follows. The FXO line from the PSTN
is split using a splitter. From the splitter, one line goes to the primary Cisco Unified CME router, and the
other line goes to the secondary Cisco Unified CME router. When a call comes in on the FXO line, it is
presented to both the primary and secondary Cisco Unified CME routers. The primary router is
configured by default to answer the call immediately. The secondary Cisco Unified CME router is
configured to answer the call after three rings. If the primary router is operational, it answers the call
immediately and changes the call state so that the secondary router does not try to answer it. If the
primary router is unavailable and does not answer the call, the secondary router sees the new call coming
in and answers after three rings.
The secondary Cisco Unified CME router should be connected in some way on the LAN, either through
the same switch or through another switch that may or may not be connected to the primary
Cisco Unified CME router directly. As long as both routers and the phones are connected on the LAN
with the appropriate configurations in place, the phones can register to whichever router is active.
Configure primary and secondary Cisco Unified CME routers identically, with the exception that the
FXO voice port from the PSTN on the secondary router should be configured to answer after more rings
than the primary router, as previously explained. The same command is used on both routers to specify
the IP addresses of the primary and secondary routers.
For configuration information, see the “SCCP: Configuring a Redundant Router” section on page 123.
Cisco Unified Communications Manager Express System Administrator Guide
104 OL-10663-02
Configuring System-Level Parameters
Information About Configuring System-Level Parameters
Timeouts
The following system-level timeout parameters have default values that are generally adequate:
• Busy Timeout—Length of time that can elapse after a transferred call reaches a busy signal before
the call is disconnected.
• Interdigit Timeout—Length of time that can elapse between the receipt of individual dialed digits
before the dialing process times out and is terminated. If the timeout ends before the destination is
identified, a tone sounds and the call ends. This value is important when using variable-length
dial-peer destination patterns (dial plans). For more information, see Dial Peer Configuration on
Voice Gateway Routers.
• Ringing Timeout—Length of time a phone can ring with no answer before returning a disconnect
code to the caller. This timeout is used only for extensions that do not have no-answer call
forwarding enabled. The ringing timeout prevents hung calls received over interfaces such as FXO
that do not have forward-disconnect supervision.
• Keepalive—Interval determines how often a message is sent between the router and
Cisco Unified IP phones, over the session, to ensure that the keepalive timeout is not exceeded. If
no other traffic is sent over the session during the interval, a keepalive message is sent.
For configuration information, see the “SCCP: Changing Defaults for Timeouts” section on page 121.
IPv6 Support in Cisco Unified CME SCCP Endpoints.
Internet Protocol version 6 (IPv6), which is the latest version of the Internet Protocol (IP) that uses
packets to exchange data, voice, and video traffic over digital networks, increases the number of network
address bits from 32 bits in IPv4 to 128 bits. IPv6 support in Cisco Unified CME allows the network to
behave transparently in a dual-stack (IPv4 and IPv6) environment and provides additional IP address
space to SCCP phones and devices that are connected to the network. For information on configuring
DHCP for IPv6, see the Defining Network Parameters chapter.
Before Cisco Unified CME 8.0, SCCP protocol supported IPv4 addresses (4 bytes) only. With
Cisco Unified CME 8.0, SCCP protocol version is upgraded to store IPv6 address (16 bytes) also.
Following SCCP phones and devices are supported on IPv6: 7911, 7931, 7941G, 7941GE, 7961G,
7961GE, 7970G, 7971G, 7971G-GE, 7942, 7962, 7945, 7965, 7975, SCCP analogue gateway, Xcoder,
and Hardware Conference devices. For more information on configuring SCCP IP phones for IPv6
source address, see the “Configuring IPv6 Source Address for SCCP IP Phones.” section on page 109.
Note You must disable Alternative Network Address Transport (ANAT) globally for SIP lines if you have
CME with dual-stack SIP trunk and enable ANAT at dial-peer level for SIP trunk.
Support for IPv4-IPv6 (Dual-Stack)
Cisco Unified CME 8.0 can interact with and support any SCCP devices that support IPv4 only or both
IPv4 and IPv6 (dual-stack). In dual-stack mode two IP addresses are assigned to an interface, one is an
IPv4 address and the other is an IPv6 address. Both IPv4 and IPv6 stacks are enabled on the voice
gateways so that applications can interact with both versions of IP addresses.To support devices that use
both IPv4 and IPv6 (dual-stack) addresses, you must ensure that the Cisco Unified CME has both IPv4
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 105
Configuring System-Level Parameters
How to Configure System-Level Parameters
address and IPv6 address enabled, so it can interact and support devices that use IPv4 only, IPv6 only,
or dual-stack. For more information, see the “Configuring IP Phones in IPv4, IPv6, or Dual Stack Mode”
section on page 107
Media Flow Through and Flow Around
Media transport modes such as flow around and flow through are used to transport media packets across
the endpoints. Media flow around enables media packets to pass directly between the endpoints, without
the intervention of the IP-IP Gateway (IPIPGW). Media flow-through enables media packets to pass
through the endpoints, without the intervention of the IPIPGW.
Table 9 lists media flow-through and flow-around scenarios between endpoints that support IPv4, IPv6,
and dual- stack. When both endpoints are IPv4 only or IPv6 only, the call flows around. When one
endpoint is IPv4 and the other is IPv6, calls flow through. When one endpoint is dual-stack and the other
IPv4 or IPv6 the call s flow around. When both endpoints are dual-stack calls flow around or follows the
preference (preferred IP address version) selected by protocol mode in dual-stack.
Table 9 Call flow scenarios between IPv4 only, IPv6 only, and Dual-stack
IP Versions IPv4 Only IPv6 Only Dual-Stack
1
IPv4 Only Flow Around Flow Through Flow Around
IPv6 Only Flow Through Flow Around Flow Around/IPv6
Dual-Stack Flow Around/IPv4 Flow Around/IPv6 Flow Around/Preference
1. When MTP is configured under ephones all the call flow around scenarios change to flow through. This ia also
applicable to cross-VRF endpoints.
How to Configure System-Level Parameters
Configuring Bulk Registration, page 112 (optional)
IPv6 Support on Cisco Unified CME
• Configuring IP Phones in IPv4, IPv6, or Dual Stack Mode, page 107 (required)
• Configuring IPv6 Source Address for SCCP IP Phones., page 109 (required)
• Verifying IPv6 and Dual-Stack Configuration on Cisco Unified CME, page 111 (Optional)
SCCP
• SCCP: Setting Up Cisco Unified CME, page 114 (required)
• SCCP: Setting Date and Time Parameters, page 117 (required)
• SCCP: Blocking Automatic Registration, page 118 (optional)
• SCCP: Defining Per-Phone Configuration Files and Alternate Location, page 119 (optional)
• SCCP: Changing Defaults for Timeouts, page 121 (optional)
• SCCP: Configuring a Redundant Router, page 123 (optional)
Cisco Unified Communications Manager Express System Administrator Guide
106 OL-10663-02
Configuring System-Level Parameters
How to Configure System-Level Parameters
SIP
• SIP: Setting Up Cisco Unified CME, page 125 (required)
• SIP: Setting Date and Time Parameters, page 127 (required)
• SIP: Setting Network Time Protocol, page 129 (required)
• SIP: Changing Session-Level Application for SIP Phones, page 130 (optional)
Configuring IP Phones in IPv4, IPv6, or Dual Stack Mode
To configure Cisco Unified CME for dual-stack, perform the following steps:
Prerequisites
• Cisco Unified CME 8.0 or later version
• IPv6 cef must be enabled for dual-stack configuration
Restrictions
• Legacy IP phones are not supported.
• Multicast MOH and multicast paging features are not supported on IPv6 only phones. If you want
to receive paging calls on IPv6 enabled phones, use the default multicast paging.
• Primary and secondary CME need to be provisioned with the same network type.
• MWI relay server must be in IPv4 network.
• Presence server must be IPv4 only.
• Video endpoints such as CUVA and 7985 are not supported in IPv6
• TAPI client is not supported in IPv6.
• All HTTP based IPv6 services are not supported.
• IOS TFTP server is not supported in IPv6.
• If protocol mode is IPv4, you can only configure IPv4 as the source IP-address, if protocol mode is
IPv6 you can only configure IPv6 as the source IP address and if the protocol mode is dual-stack,
you can configure both IPv4 and IPv6 sources addresses.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. protocol mode {ipv4 | ipv6 | dual-stack [preference {ipv4 | ipv6}]}
5. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 107
Configuring System-Level Parameters
How to Configure System-Level Parameters
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters the telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 protocol mode {ipv4 | ipv6 | dual-stack Allows SCCP phones to interact with phones on IPv6
[preference {ipv4 | ipv6}]} voice gateways. You can configure phones for IPv4
address, IPv6 address or in dual-stack mode
Example: • ipv4 allows you to set protocol mode as an IPv4
Router(config-telephony)# protocol mode dual-stack address
preference ipv6
• ipv6 allows you to set the protocol mode as an IPv6
address
• dual-stack allows you to set the protocol mode for
both IPv4 and IPv6 addresses.
• preference allows you to choose a preferred IP
address family if protocol mode is dual-stack.
(dual-stack)
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Examples
telephony-service
protocol mode dual-stack preference ipv6
....
ip source-address 10.10.2.1 port 2000
ip source-address 2000:A0A:201:0:F:35FF:FF2C:697D
Cisco Unified Communications Manager Express System Administrator Guide
108 OL-10663-02
Configuring System-Level Parameters
How to Configure System-Level Parameters
Configuring IPv6 Source Address for SCCP IP Phones.
To configure IPv6 source address on SCCP IP Phones, perform the following steps:
Prerequisites
• Cisco Unified CME 8.0 or a later version.
Restrictions
• IPv6 option only appears if protocol mode is in dual-stack or IPv6.
• Do not change the default port number (2000) in the “ip source-address” configuration command.
If you change the port number, IPv6 CEF packet switching engine may not be able to handle the
IPv6 SCCP phones and various packet handling problems may occur.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony service
4. ip source-address {ipv4 address | <ipv6 address} port] [secondary {ipv4 address | ipv6 address}
[rehome seconds]] [strict-match]
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters the telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 109
Configuring System-Level Parameters
How to Configure System-Level Parameters
Command or Action Purpose
Step 4 ip source-address ipv4 address | ipv6 address Allows to configure a IPv4 or IPv6 address as a IP source-
port port secondary ipv4 address | ipv6 address for the phones to communicate with a
address rehome seconds strict-match
Cisco Unified CME router.
• IPv4 address allows the phones to communicate with
Example: phones or voice gateways in network. IPv4 address can
Rounter(config-telephony)# ip source-address
only be configured with IPv4 address or dual-stack
10.10.10.33 port 2000 ip source-address
2001:10:10:10::3 mode.
• IPv6 address allows the phones to communicate with
phones or voice gateways in IPv6 network. IPv6 can
only be configured with IPv6 or dual-stack mode.
(Optional) port port—TCP/IP port number to use for
Skinny Client Control Protocol (SCCP). Range is from
2000 to 9999. Default is 2000. For dual-stack, port is only
configured with IPv4 address.
(Optional) Second —Cisco Unified CME router with
which phones can register if the primary Cisco Unified
CME router fails.
(Optional) Rehome seconds— Used only by Cisco Unified
IP phones that have registered with a Cisco Unified
Survivable Remote Site Telephony (SRST) router. This
keyword defines a delay that is used by phones to verify the
stability of their primary SCCP controller (Cisco Unified
Communication Manager or Cisco Unified CME) before
the phones reregister with it. This parameter is ignored by
phones unless they are registered to a secondary Cisco
Unified SRST router. The range is from 0 to 65535
seconds. The default is 120 seconds.
The use of this parameter is a phone behavior and is subject
to change, based on the phone type and phone firmware
version.
(Optional) strict-match— Requires strict IP address
checking for registration.
Step 5 end • Returns to privileged EXEC mode.
Example:
outer(config-telephony)# end
Cisco Unified Communications Manager Express System Administrator Guide
110 OL-10663-02
Configuring System-Level Parameters
How to Configure System-Level Parameters
Verifying IPv6 and Dual-Stack Configuration on Cisco Unified CME
Step 1 The following example show a list of success messages that are printed printed during IOS boot up.
These messages confirm whether IPv6 has been enabled on interfaces ( for example, EDSP0.1 to
EDSP0.5) specific to exchanging RTP packets with SCCP endpoints.
Router#
00:00:33: %EDSP-6-IPV6_ENABLED: IPv6 on interface EDSP0 added.
00:00:34: %EDSP-6-IPV6_ENABLED: IPv6 on interface EDSP0.1 added.
00:00:34: %EDSP-6-IPV6_ENABLED: IPv6 on interface EDSP0.2 added.
00:00:34: %EDSP-6-IPV6_ENABLED: IPv6 on interface EDSP0.3 added.
00:00:34: %EDSP-6-IPV6_ENABLED: IPv6 on interface EDSP0.4 added.
00:00:34: %EDSP-6-IPV6_ENABLED: IPv6 on interface EDSP0.5 added.
00:00:34: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthernet0/1, changed state
to down
00:00:34: %LINK-3-UPDOWN: Interface ephone_dsp DN 1.1, changed state to up
00:00:34: %LINK-3-UPDOWN: Interface ephone_dsp DN 1.2, changed state to up
Step 2 Use the show ephone socket command to verify if IPv4 only, IPv6 only, or dual-stack (IPv4/IPv6) is
configured in Cisco Unified CME. In the following example, SCCP TCP listening socket
(skinny_tcp_listen_socket fd) values 0 and 1 verify dual-stack configuration. When IPv6 only is
configured show ephone socket command displays SCCP TCP listening socket values as (-1) and (0).
The listening socket is closed if the value is (-1). When IPv4 only is configured the show ephone socket
command displays SCCP TCP listening socket values as (0) and (-1).
Router# show ephone socket
skinny_tcp_listen_socket fd = 0
skinny_tcp_listen_socket (ipv6) fd = 1
skinny_secure_tcp_listen_socket fd = -1
skinny_secure_tcp_listen_socket (ipv6) fd = -1
Phone 7,
skinny_sockets[15] fd = 16 [ipv6]
read_buffer 0x483C0BC4, read_offset 0, read_header N, read_length 0
resend_queue 0x47EC69EC, resend_offset 0, resend_flag N, resend_Q_depth 0
MTP 1,
skinny_sockets[16] fd = 17
read_buffer 0x483C1400, read_offset 0, read_header N, read_length 0
resend_queue 0x47EC6978, resend_offset 0, resend_flag N, resend_Q_depth 0
Phone 8,
skinny_sockets[17] fd = 18 [ipv6]
read_buffer 0x483C1C3C, read_offset 0, read_header N, read_length 0
resend_queue 0x47EC6904, resend_offset 0, resend_flag N, resend_Q_depth 0
Step 3 Use the show ephone summary command to verify IPv6 address or IPv4 addresses configured for
ephones. Following example displays IPv6 and IPv4 addresses for different ephones.
Router# show ephone summary
ephone-2[1] Mac:0016.46E0.796A TCP socket:[7] activeLine:0 whisperLine:0 REGISTERED
mediaActive:0 whisper_mediaActive:0 startMedia:0 offhook:0 ringing:0 reset:0 reset_sent:0
debug:0 privacy:1 primary_dn: 1*
IPv6:2000:A0A:201:0:216:46FF:FEE0:796A* IP:10.10.10.12 7970 keepalive 599 music 0 1:1
sp1:2004
ephone-7[6] Mac:0013.19D1.F8A2 TCP socket:[6] activeLine:0 whisperLine:0 REGISTERED
mediaActive:0 whisper_mediaActive:0 startMedia:0 offhook:0 ringing:0 reset:0 reset_sent:0
debug:0 privacy:0 primary_dn: 13*
IP:10.10.10.14 * Telecaster 7940 keepalive 2817 music 0 1:13 2:28
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 111
Configuring System-Level Parameters
How to Configure System-Level Parameters
Configuring Bulk Registration
To configure bulk registration for registering a block of phone numbers with an external registrar so that
calls can be routed to Cisco Unified CME from a SIP network, follow the steps in this section.
Numbers that match the defined number pattern can register with the external registrar. The block of
numbers that is registered can include any phone that is attached to Cisco Unified CME or any analog
phone that is directly attached to an FXS port on a Cisco Unified CME router.
Note Use this command to specify that an individual directory number not register with the external registrar.
For configuration information, see the “SIP: Disabling SIP Proxy Registration for a Directory Number”
section on page 181.
Prerequisites
• Cisco Unified CME 3.4 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. mode cme
5. bulk number
6. exit
7. sip-ua
8. registrar {dns:address | ipv4:destination-address} expires seconds [tcp] [secondary] no
registrar [secondary]
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Cisco Unified Communications Manager Express System Administrator Guide
112 OL-10663-02
Configuring System-Level Parameters
How to Configure System-Level Parameters
Command or Action Purpose
Step 4 mode cme Enables mode for provisioning SIP phones in
Cisco Unified CME.
Example:
Router(config-register-global)# mode cme
Step 5 bulk number Sets bulk registration for E.164 numbers that will register
with SIP proxy server.
Example: • number—Unique sequence of up to 32 characters
Router(config-register-global)# bulk 408526.... including wild cards and patterns that represents E.164
numbers that will register with Sip proxy server.
Step 6 exit Exits configuration mode to the next highest mode in the
configuration mode hierarchy.
Example:
Router(config-register-pool)# exit
Step 7 sip-ua Enters Session Initiation Protocol (SIP) user agent (ua)
configuration mode for configuring the user agent.
Example:
Router(config)# sip-ua
Step 8 registrar {dns:address | Enables SIP gateways to register E.164 numbers with SIP
ipv4:destination-address} expires seconds [tcp] proxy server.
[secondary] no registrar [secondary]
Example:
Router(config-sip-ua)# registrar server
ipv4:1.5.49.240
Step 9 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-sip-ua)# end
Examples
The following example shows that all phone numbers that match the pattern “408555...” can register
with a SIP proxy server (IP address 1.5.49.240):
voice register global
mode cme
bulk 408555….
sip-ua
registrar ipv4:1.5.49.240
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 113
Configuring System-Level Parameters
How to Configure System-Level Parameters
SCCP: Setting Up Cisco Unified CME
To identify filenames and the location of phone firmware for phone types to be connected, specify the
port for phone registration, and specify number of phones and directory numbers to be supported,
perform the following steps.
Restrictions
• DSCP requires Cisco Unified CME 7.1 or a later version. If DSCP is configured for the gateway
interface using the service-policy command or for the dial peer using the ip qos dscp command, the
value set with those commands takes precedence over the DSCP value configured in this procedure.
SUMMARY STEPS
1. enable
2. configure terminal
3. tftp-server device:filename
4. telephony-service
5. load phone-type firmware-file
6. max-ephones max-phones
7. max-dn max-directory-numbers [preference preference-order] [no-reg primary | both]
8. ip source-address ip-address port port [any-match | strict-match]
9. ip qos dscp {{number | af | cs | default | ef} {media | service | signaling | video}}
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
114 OL-10663-02
Configuring System-Level Parameters
How to Configure System-Level Parameters
Command or Action Purpose
Step 3 tftp-server device:filename (Optional) Creates TFTP bindings to permit IP phones
served by the Cisco Unified CME router to access the
specified file.
Example:
Router(config)# tftp-server • A separate tftp-server command is required for each
flash:P00307020300.bin phone type.
• Required for Cisco Unified CME 7.0/4.3 and earlier
versions.
• Cisco Unified CME 7.0(1) and later versions:
Required only if the location for cnf files is not flash
or slot 0, such as system memory or a TFTP server
url. Use the complete filename, including the file
suffix, for phone firmware versions later than
version 8-2-2 for all phone types.
Step 4 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 5 load phone-type firmware-file Identifies a Cisco Unified IP phone firmware file to be
used by phones of the specified type when they register.
Example: • A separate load command is required for each IP
Router(config-telephony)# load 7960-7940 phone type.
P00307020300
• firmware-file—Filename is case-sensitive.
– Cisco Unified CME 7.0/4.3 and earlier
versions: Do not use the .sbin or .loads file
extension except for the Cisco ATA and
Cisco Unified IP Phone 7905 and 7912.
– Cisco Unified CME 7.0(1) and later versions:
Use the complete filename, including the file
suffix, for phone firmware versions later than
version 8-2-2 for all phone types.
Note If you are loading a firmware file larger than
384 KB, you must first load a file for that phone
type that is smaller than 384 KB, and then load
the larger file.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 115
Configuring System-Level Parameters
How to Configure System-Level Parameters
Command or Action Purpose
Step 6 max-ephones max-phones Sets the maximum number of phones that can register to
Cisco Unified CME.
Example: • Maximum number is platform and version-specific.
Router(config-telephony)# max-ephones 24 Type ? for range.
• In Cisco Unified CME 7.0/4.3 and later versions, the
maximum number of phones that can register is
different than the maximum number of phones that
can be configured. The maximum number of phones
that can be configured is 1000.
• In versions earlier than Cisco Unified CME 7.0/4.3,
this command restricted the number of phones that
could be configured on the router.
Step 7 max-dn max-directory-numbers [preference Limits number of directory numbers to be supported by
preference-order] [no-reg primary | both] this router.
• Maximum number is platform and version-specific.
Example: Type ? for value.
Router(config-telephony)# max-dn 200 no-reg
primary
Step 8 ip source-address ip-address [port port] [any-match Identifies the IP address and port number that the
| strict-match] Cisco Unified CME router uses for IP phone
registration.
Example: • port port—(Optional) TCP/IP port number to use
Router(config-telephony)# ip source-address for SCCP. Range is 2000 to 9999. Default is 2000.
10.16.32.144
• any-match—(Optional) Disables strict IP address
checking for registration. This is the default.
• strict-match—(Optional) Instructs the router to
reject IP phone registration attempts if the IP server
address used by the phone does not exactly match
the source address.
Step 9 ip qos dscp {{number | af | cs | default | ef} Sets the DSCP priority levels for different types of
{media | service | signaling | video}} traffic.
Example:
Router(config-telephony)# ip qos dscp af43 video
Step 10 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Examples
The following example shows different DSCP settings for media, signaling, video, and services enabled
with the ip qos dscp command.
telephony-service
load 7960-7940 P00308000500
max-ephones 100
max-dn 240
Cisco Unified Communications Manager Express System Administrator Guide
116 OL-10663-02
Configuring System-Level Parameters
How to Configure System-Level Parameters
ip source-address 10.10.10.1 port 2000
ip qos dscp af11 media
ip qos dscp cs2 signal
ip qos dscp af43 video
ip qos dscp 25 service
cnf-file location flash:
.
.
SCCP: Setting Date and Time Parameters
To specify the format of the date and time that appears on all SCCP phones in Cisco Unified CME,
follow the steps in this section.
Note For certain phones, such as the Cisco Unified IP Phone 7906, 7911, 7931, 7941, 7942, 7945, 7961, 7962,
7965, 7970, 7971, and 7975, you must configure the time-zone command to ensure that the correct time
stamp appears on the phone display. This command is not required for Cisco Unified IP Phone 7902G,
7905G, 7912G, 7920, 7921, 7935, 7936, 7940, 7960, or 7985G.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. date-format {dd-mm-yy | mm-dd-yy | yy-dd-mm | yy-mm-dd}
5. time-format {12 | 24}
6. time-zone number
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 117
Configuring System-Level Parameters
How to Configure System-Level Parameters
Command or Action Purpose
Step 4 date-format {dd-mm-yy | mm-dd-yy | yy-dd-mm | (Optional) Sets the date format for phone display.
yy-mm-dd}
• Default: mm-dd-yy.
Example:
Router(config-telephony)# date-format yy-mm-dd
Step 5 time-format {12 | 24} (Optional) Selects a 12-hour or 24-hour clock for the
time display format on phone display.
Example: • Default: 12.
Router(config-telephony)# time-format 24
Step 6 time-zone number Sets time zone for SCCP phones.
• Not required for Cisco Unified IP Phone 7902G,
Example: 7905G, 7912G, 7920, 7921, 7935, 7936, 7940, 7960,
Router(config-telephony)# time-zone 2 or 7985G.
• Default: 5, Pacific Standard/Daylight Time (-480).
Step 7 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
SCCP: Blocking Automatic Registration
To prevent Cisco Unified IP phones that are not explicitly configured in Cisco Unified CME from
registering with the Cisco Unified CME router, perform the following steps.
Prerequisite
• Cisco Unified CME 4.0 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. auto-reg-ephone
5. end
Cisco Unified Communications Manager Express System Administrator Guide
118 OL-10663-02
Configuring System-Level Parameters
How to Configure System-Level Parameters
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 auto-reg-ephone Enables all Cisco Unified IP phones that are running
SCCP to register regardless of whether the phone is
explicitly configured in Cisco Unified CME.
Example:
Router(config-telephony)# no auto-reg-ephone • Default: Enabled.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
SCCP: Defining Per-Phone Configuration Files and Alternate Location
To define a location other than system:/its for storing configuration files for per-phone and per-phone
type configuration files, perform the following steps.
Prerequisites
• Cisco Unified CME 4.0 or a later version.
Restrictions
• TFTP does not support file deletion. When configuration files are updated, they overwrite any
existing configuration files with the same name. If you change the configuration file location, files
are not deleted from the TFTP server.
• Generating configuration files on flash memory or slot 0 memory can take up to a minute, depending
on the number of files being generated.
• For smaller routers such as the Cisco 2600 series routers, you must manually enter the squeeze
command to erase files after changing the configuration file location or entering any commands that
trigger the deletion of configuration files. Unless you use the squeeze command, the space used by
the moved or deleted configuration files is not usable by other files.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 119
Configuring System-Level Parameters
How to Configure System-Level Parameters
• If VRF Support on Cisco Unified CME is configured and the cnf-file location command is
configured for system:, the per phone or per phone type file for an ephone in a VRF group is created
in system:/its/vrf<group-tag>/. The vrf directory is automatically created and appended to the TFTP
path. No action is required on your part. Locale files are still created in system:/its/.
• If VRF Support on Cisco Unified CME is configured and the cnf-file location command is
configured as flash: or slot0:, the per phone or per phone type file for an ephone in a VRF group is
named flash:/its/vrf<group-tag>_<filename> or slot0:/its/vrf<group-tag>_filename>. The vrf
directory is automatically created and appended to the TFTP path. No action is required on your
part. The location of the locale files is not changed.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. cnf-file location {flash: | slot0: | tftp tftp-url}
5. cnf-file {perphonetype | perphone}
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 cnf-file location {flash: | slot0: | tftp Specifies a location other than system:/its for storing
tftp-url} phone configuration files.
• Required for per-phone or per-phone type
Example: configuration files.
Router(config-telephony)# cnf-file location
flash:
Cisco Unified Communications Manager Express System Administrator Guide
120 OL-10663-02
Configuring System-Level Parameters
How to Configure System-Level Parameters
Command or Action Purpose
Step 5 cnf-file {perphonetype | perphone} Specifies whether to use a separate file for each type of
phone or for each individual phone.
Example: • Required if you configured the cnf-file location
Router(config-telephony)# cnf-file perphone command.
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Examples
The following example selects flash memory as the configuration file storage location and per-phone as
the type of configuration files that the system generates.
telephony-service
cnf-file location flash:
cnf-file perphone
What to Do Next
If you changed the configuration file storage location, use the option 150 ip command to update the
address. See “Changing the TFTP Address on a DHCP Server” on page 93.
SCCP: Changing Defaults for Timeouts
To configure values for system-level intervals for which default values are typically adequate, perform
the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. timeouts busy seconds
5. timeouts interdigit seconds
6. timeouts ringing seconds
7. keepalive seconds
8. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 121
Configuring System-Level Parameters
How to Configure System-Level Parameters
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 timeouts busy seconds (Optional) Sets the length of time after which calls that are
transferred to busy destinations are disconnected.
Example: • seconds—Number of seconds. Range is 0 to 30. Default
Router(config-telephony)# timeouts busy 20 is 10.
Step 5 timeouts interdigit seconds (Optional) Configures the interdigit timeout value for all
Cisco Unified IP phones attached to the router.
Example: • seconds—Number of seconds before the interdigit
Router(config-telephony)# timeouts interdigit timer expires. Range is 2 to 120. Default is 10.
30
Step 6 timeouts ringing seconds (Optional) Sets the duration, in seconds, for which the
Cisco Unified CME system allows ringing to continue if a
call is not answered. Range is 5 to 60000. Default is 180.
Example:
Router(config-telephony)# timeouts ringing 30
Step 7 keepalive seconds (Optional) Sets the time interval, in seconds, between
keepalive messages that are sent to the router by
Cisco Unified IP phones.
Example:
Router(config-telephony)# keepalive 45 • The default is usually adequate. If the interval is set too
large, it is possible for notification to be delayed when
a system goes down.
• Range: 10 to 65535. Default: 0.
Step 8 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Cisco Unified Communications Manager Express System Administrator Guide
122 OL-10663-02
Configuring System-Level Parameters
How to Configure System-Level Parameters
SCCP: Configuring a Redundant Router
To configure a secondary Cisco Unified CME router to act as a backup if the primary router fails,
perform the following steps on both the primary and secondary Cisco Unified CME routers.
Prerequisites
• Cisco Unified CME 4.0 or a later version.
• The secondary router‘s running configuration must be identical to that of the primary router.
• The physical configuration of the secondary router must be as described in the “Redundant Cisco
Unified CME Router” section on page 104.
• Phones that use this feature must be configured with the type command, which guarantees that the
appropriate phone configuration file will be present.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. ip source-address ip-address port port [secondary ip-address [rehome seconds]] [any-match |
strict-match]
5. exit
6. voice-port slot-number/port
7. signal ground-start
8. incoming alerting ring-only
9. ring number number
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 123
Configuring System-Level Parameters
How to Configure System-Level Parameters
Command or Action Purpose
Step 4 ip source-address ip-address [port port] [secondary Identifies the IP address and port number that the
ip-address [rehome seconds]] [any-match | Cisco Unified CME router uses for IP phone registration.
strict-match]
• ip-address—Address of the primary
Cisco Unified CME router.
Example:
Router(config-telephony)# ip source-address • port port—(Optional) TCP/IP port number to use for
10.0.0.1 secondary 10.2.2.25 SCCP. Range is 2000 to 9999. Default is 2000.
• secondary ip-address—Indicates a backup
Cisco Unified CME router.
• rehome seconds—Not used by Cisco Unified CME.
Used only by phones registered to
Cisco Unified SRST.
• any-match—(Optional) Disables strict IP address
checking for registration. This is the default.
• strict-match—(Optional) Router rejects IP phone
registration attempts if the IP server address used by
the phone does not exactly match the source address.
Step 5 exit Exits telephony-service configuration mode.
Example:
Router(config-telephony)# exit
Step 6 voice-port slot-number/port Enters voice-port configuration mode for the FXO voice
port for DID calls from the PSTN.
Example:
Router(config)# voice-port 2/0
Step 7 signal ground-start Specifies ground-start signaling for a voice port.
Example:
Router(config-voiceport)# signal ground-start
Step 8 incoming alerting ring-only Instructs the FXO ground-start voice port to detect
incoming calls by detecting incoming ring signals.
Example:
Router(config-voiceport)# incoming alerting
ring-only
Cisco Unified Communications Manager Express System Administrator Guide
124 OL-10663-02
Configuring System-Level Parameters
How to Configure System-Level Parameters
Command or Action Purpose
Step 9 ring number number (Required only for the secondary router) Sets the
maximum number of rings to be detected before
answering an incoming call over an FXO voice port.
Example:
Router(config-voiceport)# ring number 3 • number—Number of rings detected before
answering the call. Range is 1 to 10. Default is 1.
Note For an incoming FXO voice port on a secondary
Cisco Unified CME router, set this value higher
than is set on the primary router. We recommend
setting this value to 3 on the secondary router.
Step 10 end Returns to privileged EXEC mode.
Example:
Router(config-voiceport)# end
SIP: Setting Up Cisco Unified CME
To identify filenames and location of phone firmware for phone types to be connected, to specify the
port for phone registration, and to specify the number of phones and directory numbers to be supported,
perform the following steps.
Note If your Cisco Unified CME system supports SCCP and SIP phones, do not connect your SIP phones to
your network until after you have verified the configuration profile for the SIP phone.
Prerequisites
• Cisco CME 3.4 or a later version.
Restrictions
• SIP endpoints are not supported on H.323 trunks. SIP endpoints are supported on SIP trunks only.
• Certain Cisco Unified IP phones, such as the Cisco Unified IP Phone 7911G, 7941G, 7941GE,
7961G, 7961GE, 7970G, and 7971GE, are supported only in Cisco Unified CME 4.1 and later.
• DSCP requires Cisco Unified CME 7.1 or a later version. If DSCP is configured for the gateway
interface using the service-policy command or for the dial peer using the ip qos dscp command, the
value set with those commands takes precedence over the DSCP value configured in this procedure.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. mode cme
5. source-address ip-address [port port]
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 125
Configuring System-Level Parameters
How to Configure System-Level Parameters
6. load phone-type firmware-file
7. tftp path {flash: | slot0: | tftp://url}
8. max-pool max-phones
9. max-dn max-directory-numbers
10. authenticate [all] [realm string]
11. ip qos dscp {{number | af | cs | default | ef} {media | service | signaling | video}}
12. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Step 4 mode cme Enables mode for provisioning SIP phones in
Cisco Unified CME.
Example:
Router(config-register-global)# mode cme
Step 5 source-address ip-address [port port] Enables the Cisco Unified CME router to receive messages
from SIP phones through the specified IP address and port.
Example: • port—(Optional) TCP/IP port number.
Router(config-register-global)# source-address Range: 2000 to 9999. Default: 2000.
10.6.21.4
Step 6 load phone-type firmware-file Associates a phone type with a phone firmware file.
• A separate load command is required for each phone
Example: type.
Router(config-register-global)# load 7960-7940
P0S3-07-3-00
Step 7 tftp-path {flash: | slot0: | tftp://url} (Optional) Defines a location, other than system memory,
from which the SIP phones will download configuration
profile files.
Example:
Router(config-register-global)# tftp-path • Default: system memory (system:/cme/sipphone/).
http://mycompany.com/files
Cisco Unified Communications Manager Express System Administrator Guide
126 OL-10663-02
Configuring System-Level Parameters
How to Configure System-Level Parameters
Command or Action Purpose
Step 8 max-pool max-phones Sets maximum number of SIP phones to be supported by the
Cisco Unified CME router.
Example: • Version- and platform-dependent; type ? for range.
Router(config-register-global)# max-pool 10
• In Cisco CME 3.4 to Cisco Unified CME 7.0: Default
is maximum number supported by platform.
• InCisco Unified CME 7.0(1) and later versions:
Default is 0.
Step 9 max-dn max-directory-numbers (Optional) Sets maximum number of directory numbers for
SIP phones to be supported by the Cisco Unified CME
router.
Example:
Router(config-register-global)# max-dn 20 • Required for Cisco Unified CME 7.0(1) and later
versions.
• InCisco Unified CME 7.0(1) and later versions:
Default is 0. Range: 1 to maximum number supported
by platform. Type ? for range.
• In Cisco CME 3.4 to Cisco Unified CME 7.0: Default:
150 or maximum allowed on platform. Type ? for value.
Step 10 authenticate [all][realm string] (Optional) Enables authentication for registration requests
in which the MAC address of the SIP phone cannot be
identified by using other methods.
Example:
Router(config-register-global)# authenticate
all realm company.com
Step 11 ip qos dscp {{number | af | cs | default | ef} Sets the DSCP priority levels for different types of traffic.
{media | service | signaling | video}}
Example:
Router(config-register-global)# ip qos dscp
af43 video
Step 12 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-global)# end
SIP: Setting Date and Time Parameters
To specify the format of the date and time stamps that appear on all SIP phones in Cisco Unified CME,
follow the steps in this section.
Prerequisites
• Cisco CME 3.4 or a later version.
• The mode cme command is enabled.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 127
Configuring System-Level Parameters
How to Configure System-Level Parameters
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. timezone number
5. date-format [d/m/y | m/d/y | y-d-m | y/d/m | y/m/d | yy-m-d]
6. time-format {12 | 24}
7. dst auto-adjust
8. dst {start | stop} month [day day-of-month | week week-number | day day-of-week] time
hour:minutes
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Step 4 timezone number Selects the time zone used for SIP phones in
Cisco Unified CME.
Example: • Default: 5, Pacific Standard/Daylight Time. Type ? to
Router(config-register-global)# timezone 8 display a list of time zones.
Step 5 date-format [d/m/y | m/d/y | y-d-m | y/d/m | (Optional) Selects the date display format on SIP phones in
y/m/d | yy-m-d] Cisco Unified CME.
• Default: m/d/y.
Example:
Router(config-register-global)# date-format
yy-m-d
Step 6 time-format {12 | 24} (Optional) Selects the time display format on SIP phones in
Cisco Unified CME.
Example: • Default: 12.
Router(config-register-global)# time-format 24
Cisco Unified Communications Manager Express System Administrator Guide
128 OL-10663-02
Configuring System-Level Parameters
How to Configure System-Level Parameters
Command or Action Purpose
Step 7 dst auto-adjust (Optional) Enables automatic adjustment of Daylight
Saving Time on SIP phones in Cisco Unified CME.
Example: • To modify start and stop times for daylight savings
Router(config-register-global)# dst auto-adjust time, use the dst command.
Step 8 dst {start | stop} month [day day-of-month | (Optional) Sets the time period for Daylight Saving Time on
week week-number | day day-of-week] time SIP phones in Cisco Unified CME.
hour:minutes
• Required if automatic adjustment of Daylight Saving
Time is enabled by using the dst auto-adjust
Example: command.
Router(config-register-global)# dst start jan
day 1 time 00:00 • Default is Start: First week of April, Sunday, 2:00 a.m.
Router(config-register-global)# dst stop mar Stop: Last week of October, Sunday 2:00 a.m.
day 31 time 23:59
Step 9 end Returns to privileged EXEC mode.
Example:
Router(config-register-global)# end
SIP: Setting Network Time Protocol
To enable Netwrok Time Protocol (NTP) for certain phones, such as the Cisco Unified IP Phone 7911G,
7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE, connected to Cisco Unified CME running SIP,
perform this task.
Prerequisites
• Cisco Unified CME 4.1 or a later version.
• The firmware load 8.2(1) or a later version is installed for SIP phones to download. For upgrade
information, see the “SIP: Upgrading or Downgrading Phone Firmware Between Versions” section
on page 61.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. ntp-server ip-address [mode {anycast | directedbroadcast | multicast | unicast}]
5. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 129
Configuring System-Level Parameters
How to Configure System-Level Parameters
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to
set global parameters for all supported SIP phones
in a Cisco Unified CME environment.
Example:
Router(config)# voice register global
Step 4 ntp-server ip-address [mode {anycast | Synchronizes clock on this router with the
directedbroadcast | multicast | unicast}] specified NTP server.
Example:
Router(config-register-global)# ntp-server 10.1.2.3
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-register-global)# end
SIP: Changing Session-Level Application for SIP Phones
To change a the default session-level application for all SIP phones, perform the following steps.
Prerequisites
• Cisco CME 3.4 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. application application-name
5. end
Cisco Unified Communications Manager Express System Administrator Guide
130 OL-10663-02
Configuring System-Level Parameters
Configuration Examples for System-Level Parameters
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Step 4 application application-name (Optional) Changes the default application for all dial peers
associated with the SIP phones in Cisco Unified CME to the
specified application.
Example:
Router(config-register-global)# application Note This command can also be configured in voice
sipapp2 register pool configuration mode. The value set in
voice register pool configuration mode has priority
over the value set in voice register global mode.
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-global)# end
Configuration Examples for System-Level Parameters
This section contains the following examples:
• IPv6 Support on Cisco Unified CME: Example, page 132
• System-Level Parameters: Example, page 134
• Blocking Automatic Registration: Example, page 135
• Redundant Router: Example, page 136
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 131
Configuring System-Level Parameters
Configuration Examples for System-Level Parameters
IPv6 Support on Cisco Unified CME: Example
!
ip source-route
!
!ip cef
no ip dhcp use vrf connected
ip dhcp excluded-address 10.10.10.1 10.10.10.9
ip dhcp excluded-address 192.168.2.1
ipv6 unicast-routing
ipv6 cef
ntp server 223.255.254.254
multilink bundle-name authenticated
isdn switch-type primary-5ess
!
voice service voip
allow-connections h323 to h323
allow-connections h323 to sip
allow-connections sip to h323
allow-connections sip to sip
fax protocol cisco
sip
registrar server expires max 1200 min 300
!
!
!
voice register dn 1
number 2016
allow watch
name SIP-7961GE
label SIP2016
!
voice register dn 2
number 2017
!
!
voice logout-profile 1
!
voice logout-profile 2
number 2001 type normal
speed-dial 1 2004 label "7960-1"
!
interface GigabitEthernet0/0
ip address 10.10.10.2 255.255.255.0
duplex auto
speed auto
ipv6 address 2000:A0A:201:0:F:35FF:FF2C:697D/64
ipv6 enable
interface GigabitEthernet0/1
ip address 40.10.30.1 255.255.255.0
shutdown
duplex auto
speed auto
ipv6 address 2000::1/64
ipv6 address 2000::2/64
ipv6 address 2000::A/64
ipv6 address 3000::1/64
ipv6 address 4000::1/64
ipv6 address 9000::1/64
ipv6 address F000::1/64
ipv6 enable
!
i!
Cisco Unified Communications Manager Express System Administrator Guide
132 OL-10663-02
Configuring System-Level Parameters
Configuration Examples for System-Level Parameters
!
!
ip http server
!
ipv6 route 2001:20:20:20::/64 2000:A0A:201:0:F:35FF:FF2C:5
ipv6 route 2001:50:50:50::/64 2000:A0A:201:0:F:35FF:FF2C:5
!
tftp-server flash:P00308000500.bin
tftp-server flash:P00308000500.loads
p-server flash:cvm70sccp.8-5-2FT1-18.sbn
!
!
voice-port 0/0/0:23
!
!
mgcp fax t38 ecm
!
sccp local GigabitEthernet0/0
sccp ccm 10.10.10.2 identifier 1 version 7.0
sccp ccm 2000:A0A:201:0:F:35FF:FF2C:697D identifier 2 version 7.0
sccp
!
!
gateway
timer receive-rtp 1200
!
sip-ua
protocol mode dual-stack preference ipv6
!
!
telephony-service
protocol mode dual-stack preference ipv6
sdspfarm conference mute-on 111 mute-off 222
sdspfarm units 2
sdspfarm transcode sessions 20
sdspfarm tag 1 xcoder
sdspfarm tag 2 conference
conference hardware
no auto-reg-ephone
em logout 0:0 0:0 0:0
max-ephones 52
max-dn 192
ip source-address 10.10.10.2 port 2000
ip source-address 2000:A0A:201:0:F:35FF:FF2C:697D
service phone settingsAccess 1
service phone spanTOPCPort 0
timeouts transfer-recall 15
system message MOTO-CME1
url directories http://10.10.10.2:80/localdirectory
url authentication http://10.10.10.2/CCMCIP/authenticate.asp cme cme
cnf-file location flash:
cnf-file perphone
load 7914 S00103020003
load 7911 SCCP11.8-5-2FT1-18S
load 7970 SCCP70.8-5-2FT1-18S
time-zone 5
max-conferences 4 gain -6
call-forward pattern .T
web admin system name cisco password cisco
web admin customer name admin password admin
transfer-system full-consult
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 133
Configuring System-Level Parameters
Configuration Examples for System-Level Parameters
System-Level Parameters: Example
The following example shows the system-level configuration for a Cisco Unified CME that can support
up to 500 directory numbers on 100 phones. It sets up TFTP file sharing for phone firmware files for
Cisco Unified IP Phone 7905, 7912, 7914, 7920, 7940, and 7960 and it loads those files.
tftp-server flash:ATA030100SCCP040211A.zup
! ATA 186/188 firmware
tftp-server flash:CP7902080001SCCP051117A.sbin
! 7902 firmware
tftp-server flash:CP7905080001SCCP051117A.sbin
! 7905 firmware
tftp-server flash:CP7912080001SCCP051117A.sbin
! 7912 firmware
tftp-server flash:cmterm_7920.4.0-02-00.bin
! 7914 firmware
tftp-server flash:P00503010100.bin
! 7920 firmware
tftp-server flash:S00104000100.sbn
! 7935 firmware
tftp-server flash:cmterm_7936.3-3-5-0.bin
! 7936 firmware
tftp-server flash:P0030702T023.bin
tftp-server flash:P0030702T023.loads
tftp-server flash:P0030702T023.sb2
! 7960/40 firmware
!
telephony-service
max-ephones 100
max-dn 500
load ata ATA030100SCCP040211A
load 7902 CP7902080001SCCP051117A
load 7905 CP7905080001SCCP051117A
load 7912 CP7912080001SCCP051117A
load 7914 S00104000100
load 7920 cmterm_7920.4.0-02-00
load 7935 P00503010100
load 7936 cmterm_7936.3-3-5-0
load 7960-7940 P0030702T023
ip source-address 10.16.32.144 port 2000
create cnf-files version-stamp Jan 01 2002 00:00:00
transfer-system full-consult
Cisco Unified IP Phone 7911, 7941, 7941-GE, 7961, 7961-GE, 7970, and 7971 require multiple
files to be shared using TFTP. The following configuration example adds support for these
phones.
tftp-server flash:SCCP11.7-2-1-0S.loads
tftp-server flash:term11.default.loads
tftp-server flash:apps11.1-0-0-72.sbn
tftp-server flash:cnu11.3-0-0-81.sbn
tftp-server flash:cvm11.7-2-0-66.sbn
tftp-server flash:dsp11.1-0-0-73.sbn
tftp-server flash:jar11.7-2-0-66.sbn
! 7911 firmware
!
tftp-server flash:TERM41.7-0-3-0S.loads
tftp-server flash:TERM41.DEFAULT.loads
tftp-server flash:TERM61.DEFAULT.loads
tftp-server flash:CVM41.2-0-2-26.sbn
tftp-server flash:cnu41.2-7-6-26.sbn
tftp-server flash:Jar41.2-9-2-26.sbn
! 7941/41-GE, 7961/61-GE firmware
!
Cisco Unified Communications Manager Express System Administrator Guide
134 OL-10663-02
Configuring System-Level Parameters
Configuration Examples for System-Level Parameters
tftp-server flash:TERM70.7-0-1-0s.LOADS
tftp-server flash:TERM70.DEFAULT.loads
tftp-server flash:TERM71.DEFAULT.loads
tftp-server flash:CVM70.2-0-2-26.sbn
tftp-server flash:cnu70.2-7-6-26.sbn
tftp-server flash:Jar70.2-9-2-26.sbn
! 7970/71 firmware
!
telephony-service
load 7911 SCCP11.7-2-1-0S
load 7941 TERM41.7-0-3-0S
load 7961 TERM41.7-0-3-0S
load 7941GE TERM41.7-0-3-0S
load 7961GE TERM41.7-0-3-0S
load 7970 TERM70.7-0-1-0s
load 7971 TERM70.7-0-1-0s
create cnf-files version-stamp Jan 01 2002 00:00:00
.
.
.
Blocking Automatic Registration: Example
The following example shows how to disable automatic ephone registration, display a log of attempted
registrations, and then clear the log.
Router(config)# telephony-service
Router(config-telephony)# no auto-reg-ephone
Router(config-telephony)# exit
Router(config)# exit
Router# show ephone attempted-registrations
Attempting Mac address:
Num Mac Address DateTime DeviceType
-----------------------------------------------------------------------------
1 C863.8475.5417 22:52:05 UTC Thu Apr 28 2005 SCCP Gateway (AN)
2 C863.8475.5408 22:52:05 UTC Thu Apr 28 2005 SCCP Gateway (AN)
.....
25 000D.28D7.7222 22:26:32 UTC Thu Apr 28 2005 Telecaster 7960
26 000D.BDB7.A9EA 22:25:59 UTC Thu Apr 28 2005 Telecaster 7960
...
47 C863.94A8.D40F 22:52:17 UTC Thu Apr 28 2005 SCCP Gateway (AN)
48 C863.94A8.D411 22:52:18 UTC Thu Apr 28 2005 SCCP Gateway (AN)
49 C863.94A8.D400 22:52:15 UTC Thu Apr 28 2005 SCCP Gateway (AN)
Router# clear telephony-service ephone-attempted-registrations
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 135
Configuring System-Level Parameters
Where to Go Next
Redundant Router: Example
The following example is configured on the primary Cisco Unified CME router. It establishes the router
at 10.5.2.78 as a secondary router. The voice port 3/0/0 is the FXO port for incoming calls from the
PSTN. It is set to use ground-start signaling and to detect incoming calls by counting incoming ring
signals.
telephony-service
ip source-address 10.0.0.1 port 2000 secondary 10.5.2.78
voice-port 3/0/0
signal ground-start
incoming alerting ring-only
The secondary Cisco Unified CME router is configured with the same commands, except that the ring
number command is set to 3 instead of using the default of 1.
telephony-service
ip source-address 10.0.0.1 port 2000 secondary 10.5.2.78
voice-port 3/0/0
signal ground-start
incoming alerting ring-only
ring number 3
Where to Go Next
After configuring system-level parameters, you are ready to configure phones in Cisco Unified CME for
making basic calls.
• To use Extension Assigner to assign extension numbers to the phones in your Cisco Unified CME,
see “Creating Phone Configurations Using Extension Assigner” on page 229.
• Otherwise, see “Configuring Phones to Make Basic Calls” on page 139.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Cisco Unified Communications Manager Express System Administrator Guide
136 OL-10663-02
Configuring System-Level Parameters
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 137
Configuring System-Level Parameters
Feature Information for System-Level Parameters
Feature Information for System-Level Parameters
Table 10 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 10 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 10 Feature Information for System-Level Parameters
Cisco Unified CME
Feature Name Versions Feature Information
IPv6 Support on Cisco Unified CME 8.0 SCCP Phones can interact with and support any SCCP
devices that support IPv4 only or both IPv4 and IPv6
(dual-stack).
Blocking Automatic Registration 4.0 IP phones that are not explicitly configured in
Cisco Unified CME are blocked from registering.
Bulk Registration 3.4 Bulk registration for registering a block of phone numbers
with an external registrar was introduced.
DSCP 7.1 Supports DSCP packet marking for Cisco Unified
IP Phones to specify the class of service for each packet.
Maximum Ephones 7.0/4.3 The max-ephones command sets the maximum number of
SCCP phones that can register to Cisco Unified CME,
without limiting the number that can be configured.
Maximum number of phones that can be configured is 1000.
Network Time Protocol for SIP Phones 4.1 SIP phones can synchronize to an NTP server.
Per-Phone Configuration Files and 4.0 Defines a location other than system for storing
Alternate Location configuration files and specifies the type of configuration
files to generate.
Redundant Router 4.0 Redundant router capability was introduced.
SIP phones in Cisco Unified CME 3.4 Support for SIP endpoints directly connected to
Cisco Unified CME was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
138 OL-10663-02
Configuring Phones to Make Basic Calls
Last Updated: July 30, 2010
This module describes how to configure Cisco Unified IP phones in Cisco Unified Communications
Manager Express (Cisco Unified CME) so that you can make and receive basic calls.
Caution The Interactive Voice Response (IVR) media prompts feature is only available on the IAD2435 when
running IOS version 15.0(1)M or later.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Configuring Phones
to Make Basic Calls” section on page 227.
Contents
• Prerequisites for Configuring Phones to Make Basic Calls, page 140
• Restrictions for Configuring Phones to Make Basic Calls, page 140
• Information About Configuring Phones to Make Basic Calls, page 140
• How to Configure Phones for a PBX System, page 158
• How to Configure Phones for a Key System, page 187
• How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and
Secure IP Phone (IP-STE), page 199
• Configuration Examples for Making Basic Calls, page 215
• Where to Go Next, page 225
• Additional References, page 225
• Feature Information for Configuring Phones to Make Basic Calls, page 227
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 139
Configuring Phones to Make Basic Calls
Prerequisites for Configuring Phones to Make Basic Calls
Prerequisites for Configuring Phones to Make Basic Calls
Caution The Interactive Voice Response (IVR) media prompts feature is only available on the IAD2435 when
running IOS version 15.0(1)M or later.
• Cisco IOS software and Cisco Unified CME software, including phone firmware files for
Cisco Unified IP phones to be connected to Cisco Unified CME, must be installed in router flash
memory. See “Installing and Upgrading Cisco Unified CME Software” on page 53.
• For Cisco Unified IP phones that are running SIP and are connected directly to Cisco Unified CME,
Cisco Unified CME 3.4 or later must be installed on the router. See “Installing and Upgrading
Cisco Unified CME Software” on page 53.
• Procedures in “Defining Network Parameters” on page 75 and “Configuring System-Level
Parameters” on page 101 must be completed before you start the procedures in this section.
Restrictions for Configuring Phones to Make Basic Calls
When you are configuring dial peers or ephone-dns, including park slots and conferencing extensions,
on Cisco Integrated Services Router Voice Bundles, the following message may appear to warn you that
free memory is not available:
%DIALPEER_DB-3-ADDPEER_MEM_THRESHOLD: Addition of dial-peers limited by available
memory
To configure more dial peers or ephone-dns, increase the DRAM in the system. A moderately complex
configuration may exceed the default 256 MB DRAM and require 512 MB DRAM. Note that many
factors contribute to memory usage, in addition to the number of dial peers and ephone-dns configured.
Information About Configuring Phones to Make Basic Calls
To configure phones to make basic calls, you should understand the following concepts:
• Phones in Cisco Unified CME, page 141
• Directory Numbers, page 141
• Monitor Mode for Shared Lines, page 147
• Watch Mode for Phones, page 148
• PSTN FXO Trunk Lines, page 149
• Codecs for Cisco Unified CME Phones, page 150
• Analog Phones, page 151
• Remote Teleworker Phones, page 154
• Busy Trigger and Channel Huntstop for SIP Phones, page 156
• Digit Collection on SIP Phones, page 156
• Session Transport Protocol for SIP Phones, page 157
Cisco Unified Communications Manager Express System Administrator Guide
140 OL-10663-02
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
• Ephone-Type Configuration, page 157
Phones in Cisco Unified CME
An ephone, or “Ethernet phone,” for SCCP or a voice-register pool for SIP is the software configuration
for a phone in Cisco Unified CME. This phone can be either a Cisco Unified IP phone or an analog
phone. Each physical phone in your system must be configured as an ephone or voice-register pool on
the Cisco Unified CME router to receive support in the LAN environment. Each phone has a unique tag,
or sequence number, to identify it during configuration.
Directory Numbers
A directory number, also known as an ephone-dn for SCCP or a voice-register dn for SIP, is the software
configuration in Cisco Unified CME that represents the line connecting a voice channel to a phone. A
directory number has one or more extension or telephone numbers associated with it to allow call
connections to be made. Generally, a directory number is equivalent to a phone line, but not always.
There are several types of directory numbers, which have different characteristics.
Each directory number has a unique dn-tag, or sequence number, to identify it during configuration.
Directory numbers are assigned to line buttons on phones during configuration.
One virtual voice port and one or more dial peers are automatically created for each directory number,
depending on the configuration for SCCP phones, or for SIP phones, when the phone registers in
Cisco Unified CME.
The number of directory numbers that you create corresponds to the number of simultaneous calls that
you can have, because each directory number represents a virtual voice port in the router. This means
that if you want more than one call to the same number to be answered simultaneously, you need multiple
directory numbers with the same destination number pattern.
The directory number is the basic building block of a Cisco Unified CME system. Six different types of
directory number can be combined in different ways for different call coverage situations. Each type will
help with a particular type of limitation or call-coverage need. For example, if you want to keep the
number of directory numbers low and provide service to a large number of people, you might use shared
directory numbers. Or if you have a limited quantity of extension numbers that you can use and you need
to have a large quantity of simultaneous calls, you might create two or more directory numbers with the
same number. The key is knowing how each type of directory number works and its advantages.
Not all types of directory numbers can be configured for all phones or for all protocols. In the remaining
information about directory numbers, we have used SCCP in the examples presented but that does not
imply exclusivity. The following sections describe the types of directory numbers in a
Cisco Unified CME system:
• Single-Line, page 142
• Dual-Line, page 142
• Octo-Line, page 143
• SIP Shared-Line (Nonexclusive), page 144
• Two Directory Numbers with One Telephone Number, page 145
• Dual-Number, page 146
• Shared Line (Exclusive), page 146
• Monitor Mode for Shared Lines, page 147
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 141
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
• Overlaid, page 147
Single-Line
A single-line directory number has the following characteristics:
• Makes one call connection at a time using one phone line button. A single-line directory number has
one telephone number associated with it.
• Should be used when phone buttons have a one-to-one correspondence to the PSTN lines that come
into a Cisco Unified CME system.
• Should be used for lines that are dedicated to intercom, paging, message-waiting indicator (MWI),
loopback, and music-on-hold (MOH) feed sources.
• When used with multiple-line features like call waiting, call transfer, and conferencing, there must
be more than one single-line directory number on a phone.
• Can be combined with dual-line directory numbers on the same phone.
Note that you must make the choice to configure each directory number in your system as either dual-line
or single-line when you initially create configuration entries. If you need to change from single-line to
dual-line later, you must delete the configuration for the directory number, then recreate it.
Figure 7 shows a single-line directory number for an SCCP phone in Cisco Unified CME.
Figure 7 Single-Line Directory Number
ephone-dn 11
number 1001
IP V ephone 1
88888
Phone 1 button 1:11
Button 1 is extension 1001
Dual-Line
A dual-line directory number has the following characteristics:
• One voice port with two channels.
• Supported on IP phones that are running SCCP; not supported on IP phones that are running SIP.
• Can make two call connections at the same time using one phone line button. A dual-line directory
number has two channels for separate call connections.
• Can have one number or two numbers (primary and secondary) associated with it.
• Should be used for a directory number that needs to use one line button for features like call waiting,
call transfer, or conferencing.
• Cannot be used for lines that are dedicated to intercom, paging, message-waiting indicator (MWI),
loopback, and music-on-hold (MOH) feed sources.
• Can be combined with single-line directory numbers on the same phone.
Note that you must make the choice to configure each directory number in your system as either dual-line
or single-line when you initially create configuration entries. If you need to change from single-line to
dual-line later, you must delete the configuration for the directory number, then recreate it.
Cisco Unified Communications Manager Express System Administrator Guide
142 OL-10663-02
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
Figure 8 shows a dual-line directory number for an SCCP phone in Cisco Unified CME.
Figure 8 Dual-Line Directory Number
ephone-dn 12 dual-line
number 1002
IP V ephone 2
88889
Phone 2 button 1:12
Button 1 is extension 1002
Octo-Line
An octo-line directory number supports up to eight active calls, both incoming and outgoing, on a single
button of a SCCP phone. Unlike a dual-line directory number, which is shared exclusively among phones
(after a call is answered, that phone owns both channels of the dual-line directory number), an octo-line
directory number can split its channels among other phones that share the directory number. All phones
are allowed to initiate or receive calls on the idle channels of the shared octo-line directory number.
Because octo-line directory numbers do not require a different ephone-dn for each active call, one
octo-line directory number can handle multiple calls. Multiple incoming calls to an octo-line directory
number ring simultaneously. After a phone answers a call, the ringing stops on that phone and the
call-waiting tone plays for the other incoming calls. When phones share an octo-line directory number,
incoming calls ring on phones without active calls and these phones can answer any of the ringing calls.
Phones with an active call hear the call-waiting tone.
After a phone answers an incoming call, the answering phone is in the connected state. Other phones
that share the octo-line directory number are in the remote-in-use state.
After a connected call on an octo-line directory number is put on-hold, any phone that shares this
directory number can pick up the held call. If a phone user is in the process of initiating a call transfer
or creating a conference, the call is locked and other phones that share the octo-line directory number
cannot steal the call.
Figure 9 Octo-Line Directory Number
Phone 1
Button 1 is extension 1010
ephone-dn 10 octo-line
number 1010
IP
ephone 1
Phone 2 button 1:10
Button 1 is extension 1010 V
ephone 2
IP button 1:10
ephone 8
IP button 1:10
280623
Phone 8
Button 1 is extension 1010
The Barge and Privacy features control whether other phones are allowed to view call information or join
calls on the shared octo-line directory number.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 143
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
Feature Comparison by Directory Number Line-Mode (SCCP Phones)
Table 11 lists some common directory number features and their support based on the type of line mode
defined with the ephone-dn command.
Table 11 Feature Comparison by Line Mode (SCCP Phones)
Feature Single-Line Dual-Line Octo-Line
Barge — — Yes
Busy Trigger — — Yes
Conferencing (8-party) — 4 directory numbers 1 directory number
FXO Trunk Optimization Yes Yes —
Huntstop Channel — Yes Yes
Intercom Yes — —
Key System Yes — —
(one call per button)
Maximum Calls — — Yes
MWI Yes — —
Overlay directory numbers Yes Yes —
(c, o, x)
Paging Yes — —
Park Yes — —
Privacy — — Yes
SIP Shared-Line (Nonexclusive)
Cisco Unified CME 7.1 and later versions support SIP shared lines to allow multiple phones to share a
common directory number. All phones sharing the directory number can initiate and receive calls at the
same time. Calls to the shared line ring simultaneously on all phones without active calls and any of these
phones can answer the incoming calls. After a phone answers a call, the ringing stops on all phones and
the call-waiting tone plays for other incoming calls to the connected phone.
The phone that answers an incoming call is in the connected state. Other phones that share the directory
number are in the remote-in-use state. The first user that answers the call on the shared line is connected
to the caller and the remaining users see the call information and status of the shared line.
Calls on a shared line can be put on hold like calls on a nonshared line. When a call is placed on hold,
other phones with the shared-line directory number receive a hold notification so all phones sharing the
line are aware of the held call. Any shared-line phone user can resume the held call. If the call is placed
on hold as part of a conference or call transfer operation, the resume is not allowed. The ID of the held
call is used by other shared-line members to resume the call. Notifications are sent to all associated
phones when a held call is resumed on a shared line.
Shared lines support up to 16 calls, depending on the configuration in Cisco Unified CME, which rejects
any new call that exceeds the configured limit. For configuration information, see the “SIP: Creating
Directory Numbers” section on page 169.
The Barge and Privacy features control whether other phones are allowed to view call information or join
calls on the shared-line directory number. See “Configuring Barge and Privacy” on page 503.
Cisco Unified Communications Manager Express System Administrator Guide
144 OL-10663-02
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
Two Directory Numbers with One Telephone Number
Two directory numbers with one telephone or extension number have the following characteristics:
• Have the same telephone number but two separate virtual voice ports, and therefore can have two
separate call connections.
• Can be dual-line (SCCP only) or single-line directory numbers.
• Can appear on the same phone on different buttons or on different phones.
• Should be used when you want the ability to make more call connections while using fewer numbers.
Figure 10 on page 145 shows a phone with two buttons that have the same number, extension 1003. Each
button has a different directory number (button 1 is directory number 13 and button 2 is directory number
14), so each button can make one independent call connection if the directory numbers are single-line
and two call connections (for a total of four) if the directory numbers are dual-line.
Figure 11 shows two phones that each have a button with the same number. Because the buttons have
different directory numbers, the calls that are connected on these buttons are independent of one another.
The phone user at phone 4 can make a call on extension 1003, and the phone user on phone 5 can receive
a different call on extension 1003 at the same time.
The two directory numbers-with-one-number situation is different than a shared line, which also has two
buttons with one number but has only one directory number for both of them. A shared directory number
will have the same call connection at all the buttons on which the shared directory number appears. If a
call on a shared directory number is answered on one phone and then placed on hold, the call can be
retrieved from the second phone on which the shared directory number appears. But when there are two
directory numbers with one number, a call connection appears only on the phone and button at which the
call is made or received. In the example in Figure 11, if the user at phone 4 makes a call on button 1 and
puts it on hold, the call can be retrieved only from phone 4. For more information about shared lines, see
the “Shared Line (Exclusive)” section on page 146.
The examples in Figure 10 and Figure 11 show how two directory numbers with one number are used to
provide a small hunt group capability. In Figure 10, if the directory number on button 1 is busy or does
not answer, an incoming call to extension 1003 rolls over to the directory number associated with button
2 because the appropriate related commands are configured. Similarly, if button 1 on phone 4 is busy, an
incoming call to 1003 rolls over to button 1 on phone 5.
Figure 10 Two Directory Numbers with One Number on One Phone
ephone-dn 13
number 1003
no huntstop
ephone-dn 14
IP V number 1003
Phone 3 preference 1
Button 1 is extension 1003
88891
Button 2 is also extension 1003 ephone 3
button 1:13 2:14
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 145
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
Figure 11 Two Directory Numbers with One Number on Two Phones
Phone 4 ephone-dn 13
Button 1 is extension 1003 number 1003
no huntstop
IP
ephone-dn 14
number 1003
IP V preference 1
Phone 5 ephone 4
Button 1 is extension 1003 button 1:13
88892
ephone 5
button 1:14
Dual-Number
A dual-number directory number has the following characteristics:
• Has two telephone numbers, a primary number and a secondary number.
• Can make one call connection if it is a single-line directory number.
• Can make two call connections at a time if it is a dual-line directory number (SCCP only).
• Should be used when you want to have two different numbers for the same button without using
more than one directory number.
Figure 12 shows a directory number that has two numbers, extension 1006 and extension 1007.
Figure 12 Dual-Number Directory
ephone-dn 15
number 1006 secondary 1007
IP V
ephone 6
88890
Phone 6 button 1:15
Button 1 is extension 1006
Button 1 is also extension 1007
Shared Line (Exclusive)
An exclusively shared directory number has the following characteristics:
• Line appears on two different phones but uses the same directory number, and extension or phone
number.
• Can make one call at a time and that call appears on both phones.
• Should be used when you want the capability to answer or pick up a call at more than one phone.
Because this directory number is shared exclusively among phones, if the directory number is connected
to a call on one phone, that directory number is unavailable for calls on any other phone. If a call is
placed on hold on one phone, it can be retrieved on the second phone. This is like having a single-line
phone in your house with multiple extensions. You can answer the call from any phone on which the
number appears, and you can pick it up from hold on any phone on which the number appears.
Figure 13 shows a shared directory number on phones that are running SCCP. Extension 1008 appears
on both phone 7 and phone 8.
Cisco Unified Communications Manager Express System Administrator Guide
146 OL-10663-02
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
Figure 13 Shared Directory Number (Exclusive)
Phone 7
Button 1 is extension 1008
ephone-dn 16
number 1008
IP
ephone 7
button 1:16
IP V
Phone 8 ephone 8
88893
Button 1 is extension 1008 button 1:16
Overlaid
An overlaid directory number has the following characteristics:
• Is a member of an overlay set, which includes all the directory numbers that have been assigned
together to a particular phone button.
• Can have the same telephone or extension number as other members of the overlay set or different
numbers.
• Can be single-line or dual-line, but cannot be mixed single-line and dual-line in the same overlay set.
• Can be shared on more than one phone.
Overlaid directory numbers provide call coverage similar to shared directory numbers because the same
number can appear on more than one phone. The advantage of using two directory numbers in an overlay
arrangement rather than as a simple shared line is that a call to the number on one phone does not block
the use of the same number on the other phone, as would happen if it were a shared directory number.
For information about configuring call coverage using overlaid ephone-dns, see “Configuring
Call-Coverage Features” on page 663.
You can overlay up to 25 lines on a single button. A typical use of overlaid directory numbers would be
to create a “10x10” shared line, with ten lines in an overlay set shared by ten phones, resulting in the
possibility of ten simultaneous calls to the same number. For configuration information, see the “SCCP:
Creating Directory Numbers for a Simple Key System” section on page 187
Monitor Mode for Shared Lines
In Cisco CME 3.0 and later versions, monitor mode for shared lines provides a visible line status
indicating whether the line is in-use or not. A monitor-line lamp is off or unlit only when its line is in
the idle call state. The idle state occurs before a call is made and after a call is completed. For all other
call states, the monitor line lamp is lit. A receptionist who monitors the line can see that it is in use and
can decide not to send additional calls to that extension, assuming that other transfer and forwarding
options are available, or to report the information to the caller; for example, “Sorry, that extension is
busy, can I take a message?”
In Cisco CME 3.2 and later versions, consultative transfers can occur during Direct Station Select (DSS)
for transferring calls to idle monitored lines. The receptionist who transfers a call from a normal line can
press the Transfer button and then press the line button of the monitored line, causing the call to be
transferred to the phone number of the monitored line. For information about consultative transfer with
DSS, see “Configuring Call Transfer and Forwarding” on page 595.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 147
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
In Cisco Unified CME 4.0(1) and later versions, the line button for a monitored line can be used as a
DSS for a call transfer when the monitored line is idle or in-use, provided that the call transfer can
succeed; for example, when the monitored line is configured for Call Forward Busy or Call Forward No
Answer.
Note Typically, Cisco Unified CME does not attempt a transfer that causes the caller (transferee) to hear a
busy tone. However, the system does not check the state of subsequent target numbers in the call-forward
path when the transferred call is transferred more than once. Multiple transfers can occur because a
call-forward-busy target is also busy and configured for Call Forward Busy.
In Cisco Unified CME 4.3 and later versions, a receptionist can use the Transfer to Voicemail feature to
transfer a caller directly to a voice-mail extension for a monitored line. For configuration information,
see “SCCP: Enabling Transfer to Voice Mail” section on page 398.
For configuration information for monitor mode, see the “SCCP: Assigning Directory Numbers to
Phones” section on page 165.
Monitor mode is intended for use only in the context of shared lines so that a receptionist can visually
monitor the in-use status of several users’ phone extensions; for example, for Busy Lamp Field (BLF)
notification. To monitor all lines on an individual phone so that a receptionist can visually monitor the
in-use status of that phone, see the “Watch Mode for Phones” section on page 148.
For BLF monitoring of speed-dial buttons and directory call-lists, see “Configuring Presence Service”
on page 1003.
Watch Mode for Phones
In Cisco Unified CME 4.1 and later versions, a line button that is configured for watch mode on one
phone provides Busy Lamp Field (BLF) notification for all lines on another phone (watched phone) for
which watched directory number is the primary line. Watch mode allows a phone user, such as a
receptionist, to visually monitor the in-use status of an individual phone. A user can use the line button
that has been set in watch mode as a speed-dial to call the first extension of the watched phone. The
watching phone button would lit red if the watched phone is unregistered, in a DND state or offhook
state. Pressing it, if not lit red, will dial to the number in the same manner it would for a monitor button
or the speed dial button. Incoming calls on a line button that is in watch mode do not ring and do not
display caller ID or call-waiting caller ID.
The line button for a watched phone can also be used as a direct-station-select for a call transfer when
the watched phone is idle. In this case, the phone user who transfers a call from a normal line can press
the Transfer button and then press the line button of the watched directory number, causing the call to
be transferred to the phone number associated with the watched directory number.
For configuration information, see the “SCCP: Assigning Directory Numbers to Phones” section on
page 165.
Note If the watched directory number is a shared line and the shared line is not idle on any phone with which
it is associated, then in the context of watch mode, the status of the line button indicates that the watched
phone is in use.
Cisco Unified Communications Manager Express System Administrator Guide
148 OL-10663-02
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
For best results when monitoring the status of an individual phone based on a watched directory number, the
directory number configured for watch mode should not be a shared line. To monitor a shared line so that a
receptionist can visually monitor the in-use status of several users’ phone extensions, see the “Monitor Mode
for Shared Lines” section on page 147.
For BLF monitoring of speed-dial buttons and directory call-lists, see “Configuring Presence Service”
on page 1003.
PSTN FXO Trunk Lines
In Cisco CME 3.2 and later, IP phones running SCCP can be configured to have buttons for dedicated
PSTN FXO trunk lines, also known as FXO lines. FXO lines may used by companies whose employees
require private PSTN numbers. For example, a salesperson may need a special number that customers
can call without having to go through a main number. When a call comes in to the direct number, the
salesperson knows that the caller is a customer. In the salesperson’s absence the customer can leave voice
mail. FXO lines can use PSTN service provider voice mail: when the line button is pressed, the line is
seized, allowing the user to hear the stutter dial tone provided by the PSTN to indicate that voice
messages are available.
Because FXO lines behave as private lines, users do not have to dial a prefix, such as 9 or 8, to reach an
outside line. To reach phone users within the company, FXO-line users must dial numbers that use the
company's PSTN number. For calls to nonPSTN destinations, such as local IP phones, a second directory
number must be provisioned.
Calls placed to or received on an FXO line have restricted Cisco Unified CME services and cannot be
transferred by Cisco Unified CME. However, phone users are able to access hookflash-controlled PSTN
services using the Flash soft key.
In Cisco Unified CME 4.0(1), the following FXO trunk enhancements were introduced to improve the
keyswitch emulation behavior of PSTN lines on phones running SCCP, in a Cisco Unified CME system.
• FXO port monitoring—Allows the line button on IP phones to reliably show the status of an FXO
port when the port is in use. The status indicator, either a lamp or an icon, depending on the phone
model, accurately displays the status of the FXO port during the duration of the call, even after the
call is forwarded or transferred. The same FXO port can be monitored by multiple phones using
multiple trunk ephone-dns.
• Transfer recall—If a transfer-to phone does not answer after a specified timeout, the call is returned
to the phone that initiated the transfer and it resumes ringing on the FXO line button. The directory
number must be dual-lined.
• Transfer-to button optimization—When an FXO call is transferred to a private extension button on
another phone, and that phone has a shared line button for the FXO port, after the transfer is
committed and the call is answered, the connected call displays on the FXO line button of the
transfer-to phone. This frees up the private extension line on the transfer-to phone. The directory
number n must be dual-line.
• Dual-line ephone-dns— Directory numbers for FXO lines can now be configured for dual-line to
support the FXO monitoring, transfer recall, and transfer-to button optimization features.
For configuration information, see the “SCCP: Configuring Trunk Lines for a Key System” section on
page 190.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 149
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
Codecs for Cisco Unified CME Phones
In Cisco CME 3.4, support for connecting and provisioning SIP phones was added. The default codec of
the POTS dial peer for an SCCP phone is G.711 and the default codec of a VoIP dial peer for a SIP phone
is G.729. If neither the SCCP phone nor the SIP phone in Cisco Unified CME is specifically configured
to change the codec, calls between the two phones on the same router will produce a busy signal caused
by the mismatched default codecs. To avoid codec mismatch, specify the codec for individual IP phones
in Cisco Unified CME. Modify the configuration for either SIP or SCCP phones to ensure that the codec
for all phones match. Do not modify the configuration for SIP and SCCP phones. For configuration
information, see the “Configuring Codecs of Individual Phones for Calls Between Local Phones” section
on page 184.
In Cisco Unified CME 4.3, support for G.722-64K and the Internet Low Bit Rate Codec (iLBC) was
added. This enables Cisco Unified CME to support the same codecs that are used in newer Cisco Unified
IP phones, mobile wireless networks, and internet telephony without transcoding. This feature provides
support for the following:
• iLBC and G.722-capable SIP and SCCP IP phones in Cisco Unified CME
• iLBC-capable SCCP analog endpoints and remote phones in Cisco Unified CME
• Conferencing support for G.722 and ILBC
• Supplementary services, such as transfer, call forward, MOH, support for G.722 and iLBC,
including any supplementary services that require transcoding between G.722 and any other codec
• Transcoding for G.722 and iLBC, including G.722 to G.711 and G.722 to any other codec
With the introduction of G.722 and iLBC codecs, there can be a disparity between codec capabilities of
different phones and different firmware versions on same phone type. For example, when a H.323 call
is established, the codec is negotiated based on the dial-peer codec and the assumption is that the codecs
supported on H.323 side are supported by the phones. This assumption is not valid after G.722 and ILBC
codec are introduced in your network. If the phones do not support the codecs on the H.323 side, a
transcoder is required. To avoid transcoding in this situation, configure incoming dial-peers so that
G.722 and iLBC codecs are not used for calls to phones that are not capable of supporting these codecs.
Instead, configure these phones for G.729 or G.711. Also, when configuring shared directory numbers,
ensure that phones with the same codec capabilities are connected to the shared directory number.
G.722-64K
Traditional PSTN telephony codecs, including G.711 and G.729, are classified as narrowband codecs
because they encode audio signals in a narrow audio bandwidth, giving telephone calls a characteristic
“tinny” sound. Wideband codecs such as G.722 provide a superior voice experience because wideband
frequency response is 200 Hz to 7 kHz compared to narrowband frequency response of 300 Hz to 3.4
kHz. At 64 kbps, the G.722 codec offers conferencing performance and good music quality.
A wideband handset for certain Cisco Unified IP phones, such as the Cisco Unified IP Phone 7906G,
7911G, 7941G-GE, 7942G, 7945G, 7961G-GE, 7962G, 7965G, and 7975G, take advantage of the higher
voice quality provided by wideband codecs to enhance end-user experience with high-fidelity wideband
audio. When users use a headset that supports wideband, they experience improved audio sensitivity
when the wideband setting on their phones is enabled. You can configure phone-user access to the
wideband headset setting on IP phones by setting the appropriate VendorConfig parameters in the
phone’s configuration file. For configuration information, see the “Modifying Cisco Unified IP Phone
Options” on page 1101.
If the system is not configured for a wideband codec, phone users may not detect any additional audio
sensitivity, even when they are using a wideband headset.
Cisco Unified Communications Manager Express System Administrator Guide
150 OL-10663-02
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
You can configure the G.722-64K codec at a system-level for all calls through Cisco Unified CME. For
configuration information, see the “Modifying the Global Codec” section on page 183. To configure
individual phones and avoid codec mismatch for calls between local phones, see “Configuring Codecs
of Individual Phones for Calls Between Local Phones” section on page 184.
iLBC codec
Internet Low Bit Rate Codec (iLBC) enables graceful speech quality degradation in a network where
frames get lost. Consider iLBC suitable for real-time communications, such as telephony and video
conferencing, streaming audio, archival, and messaging. This codec is widely used by internet telephony
softphones.The SIP, SCCP, and MGCP call protocols support use of the iLBC as an audio codec. iLBC
provides better voice quality than G.729 but less than G.711. Supporting codecs that have standardized
use in other networks, such as iLBC, enables end-to-end IP calls without the need for transcoding.
To configure individual SIP or SCCP phones, including analog endpoints in Cisco Unified CME, and
avoid codec mismatch for calls between local phones, see “Configuring Codecs of Individual Phones for
Calls Between Local Phones” section on page 184.
Analog Phones
Cisco Unified CME supports analog phones and fax machines using Cisco Analog Telephone Adaptors
(ATAs) or FXS ports in SCCP mode or H.323 mode. The FXS ports used for analog phones or fax can
be on the Cisco Unified CME router, Cisco VG224 voice gateway, or integrated services router (ISR).
This section provides information on the following topics:
• Cisco ATAs in SCCP Mode, page 151
• FXS Ports in SCCP Mode, page 151
• FXS Ports in H.323 Mode, page 152
• Fax Support, page 152
• Cisco VG202, VG204, and VG224 Autoconfiguration, page 152
Cisco ATAs in SCCP Mode
You can configure the Cisco ATA 186 or Cisco ATA 188 to cost-effectively support analog phones using
SCCP in Cisco IOS Release 12.2(11)T and later. Each Cisco ATA enables two analog phones to function
as IP phones. For configuration information, see the “Configuring Cisco ATA Support” section on
page 200.
FXS Ports in SCCP Mode
FXS ports on Cisco VG224 Voice Gateways and Cisco 2800 Series and Cisco 3800 Series ISRs can be
configured for SCCP supplementary features. For information about using SCCP supplementary features
on analog FXS ports on a Cisco IOS gateway under the control of a Cisco Unified CME router, see SCCP
Controlled Analog (FXS) Ports with Supplementary Features in Cisco IOS Gateways.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 151
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
FXS Ports in H.323 Mode
FXS ports on platforms that cannot enable SCCP supplementary features can use H.323 mode to support
call waiting, caller ID, hookflash transfer, modem pass-through, fax (T.38, Cisco fax relay, and
pass-through), and PLAR. These features are provisioned as Cisco IOS voice features and not as
Cisco Unified CME features. Note that when using Cisco Unified CME, you can configure FXS ports in
H.323 mode for call waiting or hookflash transfer, but not both at the same time.
See the following documents for details on configuring features for FXS ports in H.323 mode:
• “Configuring Analog Voice Ports” section in the Voice Ports Configuration Guide
• “Caller ID” document in the Cisco IOS Voice Configuration Library
• Cisco IOS Fax, Modem, and Text Support over IP Application Guide
Fax Support
Cisco Unified CME 4.0 introduced the use of G.711 fax pass-through for SCCP on the Cisco VG224
voice gateway and Cisco ATA. In Cisco Unified CME 4.0(3) and later versions, fax relay using the
Cisco-proprietary fax protocol is the only supported fax option for SCCP-controlled FXS ports on the
Cisco VG224 and integrated service routers; G.711 fax pass-through is no longer supported for
SCCP-controlled FXS ports. See “Configuring Fax Relay” on page 901.
Cisco VG202, VG204, and VG224 Autoconfiguration
The Autoconfiguration feature in Cisco Unified CME 7.1 and later versions allows you to automatically
configure the Cisco VG202, VG204, and VG224 Analog Phone Gateway. You can configure basic voice
gateway information in Cisco Unified CME, which then generates XML configuration files for the
gateway and saves the files to either the default location in system:/its/ or to a location you define in
system memory, flash memory, or an external TFTP server. When the voice gateway powers up, it
downloads the configuration files from Cisco Unified CME and based on the information in the files, the
voice gateway provisions its analog voice ports and creates the corresponding dial peers.
Using this Autoconfiguration feature with the existing Auto Assign feature allows you to quickly set up
analog phones to make basic calls. After the voice gateway is properly configured and it downloads its
XML configuration files from Cisco Unified CME, the SCCP telephony control (STC) application
registers each configured voice port to Cisco Unified CME.
If you enable the Auto Assign feature, the gateway automatically assigns the next available directory
number from the pool set by the auto assign command, binds that number to the requesting voice port,
and creates an ephone entry associated with the voice port. The MAC address for the ephone entry is
calculated based on the MAC address of the gateway and the port number. You can manually assign a
directory number to each of the voice ports by creating the ephone-dn and corresponding ephone entry.
You can initiate a reset or restart of the analog endpoints from Cisco Unified CME, which triggers the
autoconfiguration process. The voice gateway downloads its configuration files from
Cisco Unified CME and applies the new changes.
For configuration information, see the “SCCP: Enabling Auto-Configuration for Cisco VG202, VG204,
and VG224” section on page 204.
Cisco Unified Communications Manager Express System Administrator Guide
152 OL-10663-02
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
Secure IP Phone (IP-STE) Support
Cisco Unified CME 8.0 adds support for a new secure endpoint, Internet Protocol - Secure Telephone
Equipment (IP-STE). IP-STE is a standalone, V.150.1 capable device which functions like a 7960 phone
with secure communication capability. IP-STE has native state signaling events (SSE / SPRT) support
and supports SCCP protocol. IP-STE uses the device ID 30035 when registering to a SCCP server.
However, only V.150.1 modem relay is implemented in IP-STE stack and V150.1 modem passthrough
is not supported. Therefore, the response to capability query from Cisco Unified CME only includes
media_payload_XV150_MR_711U and media_payload_xv150_MR_729A.
For configuration information, see the SCCP: Configuring Secure IP Phone (IP-STE), page 214
The following support is added for IP-STE endpoints:
• The IP-STE endpoint allows secure communication between gateway-connected legacy analog
STE/STU devices and IP STE devices using existing STE devices in voice networks.
• Secure voice and secure data modes from STE/STU devices connected to Cisco IOS gateway foreign
exchange station (FXS) and BRI ports to an IP-STE.
• Support for the state signaling events (SSE) protocol, allowing for modem signaling end-to-end and
VoIP to modem over IP (MoIP) transition and operation.
• Interoperation between line-side and trunk-side gateways and Cisco Unified CME to determine
codec support and V.150.1 negotiation. You can configure gateway-attached devices to support
either modem relay, modem pass-through, both modem transport methods, or neither method.
This section provides information on the following topics:
• Secure Communications Between STU, STE, and IP-STE, page 153
• SCCP Media Control for Secure Mode, page 153
• Secure Communication Between STE, STU, and IP-STE Across SIP Trunk, page 154
Secure Communications Between STU, STE, and IP-STE
Secure Telephone Equipment (STE) and Secure Telephone Units (STUs) encrypt voice and data streams
with government proprietary algorithms (Type-1 encryption). To provide support for the legacy STEs
and STUs and next generation IP Secure Telephone Equipment (IP-STE), voice gateways must be able
to support voice and data in secure mode within the IP network and be able to pass calls within and also
to and from government voice networks.
In earlier versions of Cisco Unified CME, Cisco IOS gateways supported secure voice and data
communication between legacy STE and STU devices using modem pass-through method.
Cisco Unified CME 8,0 and later versions control the secure endpoints by implementing a subset of
v.150.1 modem relay protocol and ensures secure communications between an IP-STE endpoints and
STE/STU endpoints. This allows Cisco Unified CME SCCP controlled secure endpoints to
communicate with the IP-STE or legacy endpoints in secure mode.
SCCP Media Control for Secure Mode
IP-STE endpoints use the V.150.1 modem relay transport method using Future Narrow Band Digital
Terminal (FNBDT) signaling over a V.32 or V.34 data pump for secure communication with other legacy
STE endpoints. However, IP-STE endpoints cannot communicate with STU endpoints because STU
endpoints use the modem pass-through method using a proprietary data pump and do not support the
FNBDT signalling.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 153
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
Secure communication between IP-STE endpoints and legacy STE endpoints support the following
encryption-capable endpoints:
• STE—Specialized encryption-capable analog or BRI phones, that can communicate over V.150.1
modem relay or over modem pass-through, also known as Voice Band Data (VBD).
• IP-STE—Specialized encryption-capable IP phones that communicate only over V.150.1 modem
relay.
• STU—Specialized encryption-capable analog phones, that operate only over NSE-based modem
pass-through connections.
Table 1 lists call scenarios between devices along with modem transport methods that the IP-STE
endpoints use to communicate with STE endpoints.
Table 12 Supported Secure Call Scenarios and Modem Transport Methods
Device Type STU STE IP-STE
STU Pass-through Pass-through None
STE Pass-through Pass-through Relay
IP-STE None Relay Relay
Secure Communication Between STE, STU, and IP-STE Across SIP Trunk
The Secure Device Provisioning (SDP) for SIP end-to end negotiation includes four proprietary media
types for secure communication between Cisco Unified CME and SIP trunk. These proprietary VBD or
Modem Relay (MR) media types can be encoded into media attributes of SDP media lines. VBD
capabilities are signaled using the SDP extension mechanism and Cisco proprietary nomenclature. MR
capabilities are signaled through V.150.1. The following example shows VBD capabilities. SDP syntax
in the below example are based on RFC 2327 and V.150.1 Appendix E.
a=rtpmap:100 X-NSE/8000
a=rtpmap:118 v150fw/8000
a=sqn:0
a=cdsc:1 audio RTP/AVP 118 0 18
a=cdsc: 4 audio udsprt 120
a=cpar: a=sprtmap: 120 v150mr/8000
Remote Teleworker Phones
IP phones or instances of Cisco IP Communicator can be connected to a Cisco Unified CME system over
a wide area network (WAN) to support teleworkers who have offices that are remote from the
Cisco Unified CME router. The maximum number of remote phones that can be supported is determined
by the available bandwidth.
IP addressing is a determining factor in the most critical aspect of remote teleworker phone design. The
following two scenarios represent the most common designs, the second one is the most common for
small and medium businesses:
• Remote site IP phones and the hub Cisco Unified CME router use globally routable IP addresses.
• Remote site IP phones use NAT with unroutable private IP addresses and the hub
Cisco Unified CME router uses a globally routable address (see Figure 14). This scenario results in
one-way audio unless you use one of the following workarounds:
Cisco Unified Communications Manager Express System Administrator Guide
154 OL-10663-02
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
– Configure static NAT mapping on the remote site router (for example, a Cisco 831 Ethernet
Broadband Router) to convert between a private address and a globally routable address. This
solution uses fewer Cisco Unified CME resources, but voice is unencryped across the WAN.
– Configure an IPsec VPN tunnel between the remote site router (or example, a Cisco 831) and
the Cisco Unified CME router. This solution requires an Advanced IP Services or higher image
on the Cisco Unified CME router if this router is used to terminate the VPN tunnel. Voice will
be encrypted across the WAN. This method will also work with the Cisco VPN client on a PC
to support Cisco IP Communicator.
Figure 14 Remote Site IP Phones Using NAT
IP WAN PSTN
146625
Teleworker Cisco 831
remote phone NAT firewall Cisco Unified CME
router (VPN)
router
Media Termination Point for Remote Phones
Media termination point (MTP) configuration is used to ensure that Real-Time Transport Protocol (RTP)
media packets from remote phones always transit through the Cisco Unified CME router. Without the
MTP feature, a phone that is connected in a call with another phone in the same Cisco Unified CME
system sends its media packets directly to the other phone, without the packets going through the
Cisco Unified CME router. MTP forces the packets to be sourced from the Cisco Unified CME router.
When this configuration is used to instruct a phone to always send its media packets to the
Cisco Unified CME router, the router acts as an MTP or proxy and forwards the packets to the
destination phone. If a firewall is present, it can be configured to pass the RTP packets because the router
uses a specified UDP port for media packets. In this way, RTP packets from remote IP phones can be
delivered to IP phones on the same system though they must pass through a firewall.
You must use the mtp command to explicitly enable MTP for each remote phone that sends media
packets to Cisco Unified CME.
One factor to consider is whether you are using multicast music on hold (MOH) in your system.
Multicast packets generally cannot be forwarded to phones that are reached over a WAN. The multicast
MOH feature checks to see if MTP is enabled for a phone and if it is, MOH is not sent to that phone. If
you have a WAN configuration that can forward multicast packets and you can allow RTP packets
through your firewall, you can decide not to use MTP.
For configuration information, see the “SCCP: Enabling a Remote Phone” section on page 209.
G.729r8 Codec on Remote Phones
You can select the G.729r8 codec on a remote IP phone to help save network bandwidth. The default
codec is G.711 mu-law. If you use the codec g729r8 command without the dspfarm-assist keyword, the
use of the G.729 codec is preserved only for calls between two phones on the Cisco Unified CME router
(such as between an IP phone and another IP phone or between an IP phone and an FXS analog phone).
The codec g729r8 command has no affect on a call directed through a VoIP dial peer unless the
dspfarm-assist keyword is also used.
For configuration information, see the “SCCP: Enabling a Remote Phone” section on page 209.
For information about transcoding behavior when using the G.729r8 codec, see the “Transcoding When
a Remote Phone Uses G.729r8” section on page 333.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 155
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
Busy Trigger and Channel Huntstop for SIP Phones
Cisco Unified CME 7.1 introduces busy trigger and huntstop channel support for SIP phones such as the
Cisco Unified IP Phone 7941G, 7941GE, 7942G, 7945G, 7961G, 7961GE, 7962G, 7965G, 7970G,
7971GE, 7975G, and 7985. For these SIP phones, the number of channels supported is limited by the
amount of memory on the phone. To prevent incoming calls from overloading the phone, you can
configure a busy trigger and a channel huntstop for the directory numbers on the phone.
The Channel Huntstop feature limits the number of channels available for incoming calls to a directory
number. If the number of incoming calls reaches the configured limit, Cisco Unified CME does not
present the next incoming call to the directory number. This reserves the remaining channels for
outgoing calls or for features such as call transfer and conferencing.
The Busy Trigger feature limits the calls to a directory number by triggering a busy response. After the
number of active calls, both incoming and outgoing, reaches the configured limit, Cisco Unified CME
forwards the next incoming call to the Call Forward Busy destination, or rejects the call with a busy tone
if Call Forward Busy is not configured.
The busy-trigger limit applies to all directory numbers on a phone. If a directory number is shared among
multiple SIP phones, Cisco Unified CME presents incoming calls to those phones that have not reached
their busy-trigger limit. Cisco Unified CME initiates the busy trigger for an incoming call only if all the
phones sharing the directory number exceed their limit.
For configuration information, see the “SIP: Creating Directory Numbers” section on page 169 and the
“SIP: Assigning Directory Numbers to Phones” section on page 171.
Digit Collection on SIP Phones
Digit strings dialed by phone users must be collected and matched against predefined patterns to place
calls to the destination corresponding to the user's input. Before Cisco Unified CME 4.1, SIP phone
users had to press the DIAL soft key or # key, or wait for the interdigit-timeout to trigger call processing.
In Cisco United CME 4.1 and later, two methods of collecting and matching digits are supported for SIP
phones, depending on the model of phone:
• KPML Digit Collection, page 156
• SIP Dial Plans, page 157
KPML Digit Collection
Key Press Markup Language (KPML) uses SIP SUBSCRIBE and NOTIFY methods to report user input
digit by digit. Each digit dialed by the phone user generates its own signaling message to
Cisco Unified CME, which performs pattern recognition by matching a destination pattern to a dial peer
as it collects the dialed digits. This process of relaying each digit immediately is similar to the process
used by SCCP phones. It eliminates the need for the user to press the Dial soft key or wait for the
interdigit timeout before the digits are sent to Cisco Unified CME for processing.
KPML is supported on Cisco Unified IP Phones 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and
7971GE. For configuration information, see the “SIP: Enabling KPML” section on page 178.
Cisco Unified Communications Manager Express System Administrator Guide
156 OL-10663-02
Configuring Phones to Make Basic Calls
Information About Configuring Phones to Make Basic Calls
SIP Dial Plans
A dial plan is a set of dial patterns that SIP phones use to determine when digit collection is complete
after a user goes off-hook and dials a destination number. Dial plans allow SIP phones to perform local
digit collection and recognize dial patterns as user input is collected. After a pattern is recognized, the
SIP phone sends an INVITE message to Cisco Unified CME to initiate the call to the number matching
the user's input. All of the digits entered by the user are presented as a block to Cisco Unified CME for
processing. Because digit collection is done by the phone, dial plans reduce signaling messages overhead
compared to KPML digit collection.
SIP dial plans eliminate the need for a user to press the Dial soft key or # key, or to wait for the interdigit
timeout to trigger an outgoing INVITE. You configure a SIP dial plan and associate the dial plan with a
SIP phone. The dial plan is downloaded to the phone in the configuration file.
You can configure SIP dial plans and associate them with the following SIP phones:
• Cisco Unified IP Phone 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE—These
phones use dial plans and support KPML. If both a dial plan and KPML are enabled, the dial plan
has priority.
If a matching dial plan is not found and KPML is disabled, the user must wait for the interdigit
timeout before the SIP NOTIFY message is sent to Cisco Unified CME. Unlike other SIP phones,
these phones do not have a Dial soft key to indicate the end of dialing, except when on-hook dialing
is used. In this case, the user can press the Dial soft key at any time to send all the dialed digits to
Cisco Unified CME.
• Cisco Unified IP Phone 7905, 7912, 7940, and 7960—These phones use dial plans and do not
support KPML. If you do not configure a SIP dial plan for these phones, or if the dialed digits do
not match a dial plan, the user must press the Dial soft key or wait for the interdigit timeout before
digits are sent to Cisco Unified CME.
When you reset a phone, the phone requests its configuration files from the TFTP server, which builds
the appropriate configuration files depending on the type of phone.
• Cisco Unified IP Phone 7905 and 7912—The dial plan is a field in their configuration files.
• Cisco Unified IP Phone 7911G, 7940, 7941G, 7941GE, 7960, 7961G, 7961GE, 7970G, and
7971GE—The dial plan is a separate XML file that is pointed to from the normal configuration file.
For configuration information for Cisco Unified CME, see the “SIP: Configuring Dial Plans” section on
page 174.
Session Transport Protocol for SIP Phones
In Cisco Unified CME 4.1 and later versions, you can select TCP as the transport protocol for connecting
supported SIP phones to Cisco Unified CME. Previously only UDP was supported. TCP is selected for
individual SIP phones by using the session-transport command in voice register pool or voice register
template configuration mode. For configuration information, see the “SIP: Selecting Session-Transport
Protocol for a Phone” section on page 180.
Ephone-Type Configuration
In Cisco Unified CME 4.3 and later versions, you can dynamically add a new phone type to your
configuration without upgrading your Cisco IOS software. New phone models that do not introduce new
features can easily be added to your configuration without requiring a software upgrade.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 157
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
The ephone-type configuration template is a set of commands that describe the features supported by a
type of phone, such as the particular phone type's device ID, number of buttons, and security support.
Other phone-related settings under telephony-service, ephone-template, and ephone configuration mode
can override the features set within the ephone-type template. For example, an ephone-type template can
specify that a particular phone type supports security and another configuration setting can disable this
feature. However, if an ephone-type template specifies that this phone does not support security, the
other configuration cannot enable support for the security feature.
Cisco Unified CME uses the ephone-type template to generate XML files to provision the phone.
System-defined phone types continue to be supported without using the ephone-type configuration.
Cisco Unified CME checks the ephone-type against the system-defined phone types. If there is conflict
with the phone type or the device ID, the configuration is rejected.
For configuration information, see the “SCCP: Configuring Ephone-Type Templates” section on
page 162.
How to Configure Phones for a PBX System
This section contains the following tasks:
• SCCP: Creating Directory Numbers, page 158 (required)
• SCCP: Configuring Ephone-Type Templates, page 162 (optional)
• SCCP: Assigning Directory Numbers to Phones, page 165 (required)
• SIP: Creating Directory Numbers, page 169 (required)
• SIP: Assigning Directory Numbers to Phones, page 171 (required)
• SIP: Configuring Dial Plans, page 174 (optional)
• SIP: Verifying Dial Plan Configuration, page 177 (optional)
• SIP: Enabling KPML, page 178 (optional)
• SIP: Selecting Session-Transport Protocol for a Phone, page 180 (optional)
• SIP: Disabling SIP Proxy Registration for a Directory Number, page 181 (required)
• Modifying the Global Codec, page 183
• Configuring Codecs of Individual Phones for Calls Between Local Phones, page 184 (required)
SCCP: Creating Directory Numbers
To create a directory number in Cisco Unified CME for a SCCP phone, intercom line, voice port, or a
message-waiting indicator (MWI), perform the following steps for each directory number to be created.
Each ephone-dn becomes a virtual line, or extension, on which call connections can be made. Each
ephone-dn configuration automatically creates one or more virtual dial peers and virtual voice ports to
make those call connections.
Note To create and assign directory numbers to be included in an overlay set, see “SCCP: Configuring
Overlaid Ephone-dns” on page 720.
Cisco Unified Communications Manager Express System Administrator Guide
158 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Prerequisites
• The maximum number of directory numbers must be changed from the default of 0 by using the
max-dn command.
• Octo-line directory numbers are supported in Cisco Unified CME 4.3 and later versions.
Restrictions
• The Cisco Unified IP Phone 7931G is a SCCP keyset phone and when configured for a key system,
does not support the dual-line option for a directory number. To configure a Cisco Unified IP Phone
7931G, see the “How to Configure Phones for a Key System” section on page 187.
• Octo-line directory numbers are not supported by the Cisco Unified IP Phone 7902, 7920, or 7931,
or by analog phones connected to the Cisco VG224 or Cisco ATA.
• Octo-line directory numbers are not supported in button overlay sets.
• Octo-line directory numbers do not support the trunk command.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag [dual-line | octo-line]
4. number number [secondary number] [no-reg [both | primary]]
5. huntstop [channel number]
6. name name
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 159
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Command or Action Purpose
Step 3 ephone-dn dn-tag [dual-line | octo-line] Enters ephone-dn configuration mode to create a directory
number for a SCCP phone.
Example: • dual-line—(Optional) Enables two calls per directory
Router(config)# ephone-dn 7 octo-line number. Supports features such as call waiting, call
transfer, and conferencing with a single ephone-dn.
• octo-line—(Optional) Enables eight calls per directory
number. Supported in Cisco Unified CME 4.3 and
later versions.
• To change the line mode of a directory number, for
example from dual-line to octo-line or the reverse, you
must first delete the ephone-dn and then recreate it.
Step 4 number number [secondary number] [no-reg [both Configures an extension number for this directory number.
| primary]]
• Configuring a secondary number supports features
such as call waiting, call transfer, and conferencing
Example: with a single ephone-dn.
Router(config-ephone-dn)# number 2001
Step 5 huntstop [channel number] (Optional) Enables channel huntstop, which keeps a call
from hunting to the next channel of a directory number if
the first channel is busy or does not answer.
Example:
Router(config-ephone-dn)# huntstop channel 4 • channel number—Number of channels available to
accept incoming calls. Remaining channels are
reserved for outgoing calls and features such as call
transfer, call waiting, and conferencing. Range: 1 to 8.
Default: 8.
• Number argument is supported for octo-line directory
numbers only.
Step 6 name name (Optional) Associates a name with this directory number.
• Name is used for caller-ID displays and in the local
Example: directory listings.
Router(config-ephone-dn)# name Smith, John
• Must follow the name order that is specified with the
directory command.
Step 7 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
Examples
Nonshared Octo-Line Directory Number
In the following example, ephone-dn 7 is assigned to phone 10 and not shared by any other phone. There
are two active calls on ephone-dn 7. Because the busy-trigger-per-button command is set to 2, a third
incoming call to extension 2001 is either rejected with a busy tone or forwarded to another destination
if Call Forward Busy is configured. The phone user can still make an outgoing call or transfer or
conference a call on ephone-dn 7 because the max-calls-per-button command is set to 3, which allows
a total of three calls on ephone-dn 7.
Cisco Unified Communications Manager Express System Administrator Guide
160 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
ephone-dn 7 octo-line
number 2001
name Smith, John
huntstop channel 4
!
!
ephone 10
max-calls-per-button 3
busy-trigger-per-button 2
mac-address 00E1.CB13.0395
type 7960
button 1:7
Shared Octo-Line Directory Number
In the following example, ephone-dn 7 is shared between phone 10 and phone 11. There are two active
calls on ephone-dn 7. A third incoming call to ephone-dn 7 rings only phone 11 because its
busy-trigger-per-button command is set to 3. Phone 10 allows a total of three calls, but it rejects the
third incoming call because its busy-trigger-per-button command is set to 2. A fourth incoming call to
ephone-dn 7 on ephone 11 is either rejected with a busy tone or forwarded to another destination if
Call Forward Busy is configured. The phone user can still make an outgoing call or transfer or
conference a call on ephone-dn 7 on phone 11 because the max-calls-per-button command is set to 4,
which allows a total of four calls on ephone-dn 7 on phone 11.
ephone-dn 7 octo-line
number 2001
name Smith, John
huntstop channel 4
!
!
ephone 10
max-calls-per-button 3
busy-trigger-per-button 2
mac-address 00E1.CB13.0395
type 7960
button 1:7
!
!
!
ephone 11
max-calls-per-button 4
busy-trigger-per-button 3
mac-address 0016.9DEF.1A70
type 7960
button 1:7
What to Do Next
After creating directory numbers, you can assign one or more directory number to a Cisco Unified
IP Phone. See “SCCP: Assigning Directory Numbers to Phones” section on page 165.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 161
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
SCCP: Configuring Ephone-Type Templates
To add an IP phone type by defining an ephone-type template, perform the following steps.
Prerequisites
Cisco Unified CME 4.3 or a later version.
Restrictions
Ephone-type templates are not supported for system-defined phone types. For a list of system-defined
phone types, see the type command in the Cisco Unified CME Command Reference.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-type phone-type [addon]
4. device-id number
5. device-name name
6. device-type phone-type
7. num-buttons number
8. max-presentation number
9. addon
10. security
11. phoneload
12. utf8
13. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
162 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Command or Action Purpose
Step 3 ephone-type phone-type [addon] Enters ephone-type configuration mode to create an
ephone-type template.
Example: • phone-type—Unique label that identifies the type of
Router(config)# ephone-type E61 IP phone for which the phone-type template is being
defined.
• addon—(Optional) Phone type is an add-on module,
such as the Cisco Unified IP Phone 7915 Expansion
Module.
Step 4 device-id number Specifies the device ID for the phone type.
• This device ID must match the predefined device ID
Example: for the specific phone model.
Router(config-ephone-type)# device-id 376
• If this command is set to the default value of 0, the
ephone-type is invalid.
• See Table 13 for a list of supported device IDs.
Step 5 device-name name Assigns a name to the phone type.
Example:
Router(config-ephone-type)# device-name E61
Mobile Phone
Step 6 device-type phone-type Specifies the device type for the phone.
• See Table 13 for a list of supported device types.
Example:
Router(config-ephone-type)# device-type E61
Step 7 num-buttons number Number of line buttons supported by the phone type.
• number—Range: 1 to 100. Default: 0.
Example: • See Table 13 for the number of buttons supported by
Router(config-ephone-type)# num-buttons 1
each phone type.
Step 8 max-presentation number Number of call presentation lines supported by the
phone type.
Example: • number—Range: 1 to 100. Default: 0.
Router(config-ephone-type)# max-presentation 1
• See Table 13 for the number of presentation lines
supported by each phone type.
Step 9 addon (Optional) Specifies that this phone type supports an
add-on module such as the Cisco Unified IP Phone 7915
Expansion Module.
Example:
Router(config-ephone-type)# addon
Step 10 security (Optional) Specifies that this phone type supports
security features.
Example: • This command is enabled by default.
Router(config-ephone-type)# security
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 163
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Command or Action Purpose
Step 11 phoneload (Optional) Specifies that this phone type requires that the
load command be configured.
Example: • This command is enabled by default.
Router(config-ephone-type)# phoneload
Step 12 utf8 (Optional) Specifies that this phone type supports UTF8.
• This command is enabled by default.
Example:
Router(config-ephone-type)# utf8
Step 13 end Exits to privileged EXEC mode.
Example:
Router(config-ephone-type)# end
Ephone-Type Parameters for Supported Phone Types
Table 13 lists the required device ID, device type, and the maximum number of buttons and call
presentation lines that are supported for each phone type that can be added with ephone-type templates.
Table 13 Supported Values for Ephone-Type Commands
Supported Device device-id device-type num-buttons max-presentation
Cisco Unified IP Phone 6901 547 6901 1 1
Cisco Unified IP Phone 6911 548 6911 10 1
Cisco Unified IP Phone 7915 227 7915 12 0 (default)
Expansion Module with 12 buttons
Cisco Unified IP Phone 7915 228 7915 24 0
Expansion Module with 24 buttons
Cisco Unified IP Phone 7916 229 7916 12 0
Expansion Module with 12 buttons
Cisco Unified IP Phone 7916 230 7916 24 0
Expansion Module with 24 buttons
Cisco Unified Wireless IP Phone 7925 484 7925 6 4
Cisco Unified IP 431 7937 1 6
Conference Station 7937G
Nokia E61 376 E61 1 1
Cisco Unified Communications Manager Express System Administrator Guide
164 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Examples
The following example shows the Nokia E61 added with an ephone-type template, which is then
assigned to ephone 2:
ephone-type E61
device-id 376
device-name E61 Mobile Phone
num-buttons 1
max-presentation 1
no utf8
no phoneload
!
ephone 2
mac-address 001C.821C.ED23
type E61
button 1:2
SCCP: Assigning Directory Numbers to Phones
This task sets up the initial ephone-dn-to-ephone relationships—that is, how and which extensions
appear on each phone. To create and modify phone-specific parameters for individual SCCP phones,
perform the following steps for each SCCP phone to be connected in Cisco Unified CME.
Note To create and assign directory numbers to be included in an overlay set, see “SCCP: Configuring
Overlaid Ephone-dns” on page 720.
Prerequisites
• To configure a phone line for Watch (w) mode by using the button command,
Cisco Unified CME 4.1 or a later version.
• To configure a phone line for Monitor (m) mode by using the button command, Cisco CME 3.0 or
a later version.
• To assign a user-defined phone type in Cisco Unified CME 4.3 or a later version, you must first
create an ephone-type template. See the “SCCP: Configuring Ephone-Type Templates” section on
page 162.
Restrictions
• For Watch mode. If the watched directory number is associated with several phones, then the
watched phone is the one on which the watched directory number is on button 1 or the one on which
the watched directory number is on the button that is configured by using the auto-line command,
with auto-line having priority. For configuration information, see “Configuring Automatic Line
Selection” on page 497.
• Octo-line directory numbers are not supported by the Cisco Unified IP Phone 7902, 7920, or 7931,
or by analog phones connected to the Cisco VG224 or Cisco ATA.
• Octo-line directory numbers are not supported in button overlay sets.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 165
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. mac-address [mac-address]
5. type phone-type [addon 1 module-type [2 module-type]]
6. button button-number{separator}dn-tag [,dn-tag...] [button-number{x}overlay-button-number]
[button-number...]
7. max-calls-per-button number
8. busy-trigger-per-button number
9. keypad-normalize
10. nte-end-digit-delay [milliseconds]
11. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies
Example: this ephone during configuration tasks. The maximum
Router(config)# ephone 6 number of ephones is version and platform-specific.
Type ? to display range.
Step 4 mac-address [mac-address] Specifies the MAC address of the IP phone that is being
configured.
Example: • mac-address—(Optional) For Cisco Unified CME 3.0
Router(config-ephone)# mac-address 2946.3f2.311 and later, not required to register phones before
configuring the phone because Cisco Unified CME
can detect MAC addresses and automatically populate
phone configurations with the MAC addresses and
phone types for individual phones. Not supported for
voice-mail ports.
Cisco Unified Communications Manager Express System Administrator Guide
166 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Command or Action Purpose
Step 5 type phone-type [addon 1 module-type Specifies the type of phone.
[2 module-type]]
• Cisco Unified CME 4.0 and later versions—The only
types to which you can apply an add-on module are
Example: 7960, 7961, 7961GE, and 7970.
Router(config-ephone)# type 7960 addon 1 7914
• Cisco CME 3.4 and earlier versions—The only type to
which you can apply an add-on module is 7960.
Step 6 button button-number{separator}dn-tag Associates a button number and line characteristics with an
[,dn-tag...] extension (ephone-dn). Maximum number of buttons is
[button-number{x}overlay-button-number]
[button-number...]
determined by phone type.
Note The Cisco Unified IP Phone 7910 has only one line
button, but can be given two ephone-dn tags.
Example:
Router(config-ephone)# button 1:10 2:11 3b12
4o13,14,15
Step 7 max-calls-per-button number (Optional) Sets the maximum number of calls, incoming
and outgoing, allowed on an octo-line directory number on
this phone.
Example:
Router(config-ephone)# max-calls-per-button 3 • number—Range: 1 to 8. Default: 8.
• This command is supported in Cisco Unified CME 4.3
and later versions.
• This command must be set to a value that is more than
or equal to the value set with the
busy-trigger-per-button command.
• This command can also be configured in
ephone-template configuration mode and applied to
one or more phones. The ephone configuration has
priority over the ephone-template configuration.
Step 8 busy-trigger-per-button number (Optional) Sets the maximum number of calls allowed on
this phone’s octo-line directory numbers before triggering
Call Forward Busy or a busy tone.
Example:
Router(config-ephone)# busy-trigger-per-button • number—Range: 1 to 8. Default: 0 (disabled).
2
• This command is supported in Cisco Unified CME 4.3
and later versions.
• After the number of existing calls, incoming and
outgoing, on an octo-line directory number exceeds the
number of calls set with this command, the next
incoming call to the directory number is forwarded to
the Call Forward Busy destination if configured, or the
call is rejected with a busy tone.
• This command must be set to a value that is less than
or equal to the value set with the
max-calls-per-button command.
• This command can also be configured in
ephone-template configuration mode and applied to
one or more phones. The ephone configuration has
priority over the ephone-template configuration.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 167
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Command or Action Purpose
Step 9 keypad-normalize (Optional) Imposes a 200-millisecond delay before each
keypad message from an IP phone.
Example: • When used with the nte-end-digit-delay command,
Router(config-ephone)# keypad-normalize this command ensures that the delay configured for a
dtmf-end event is always honored.
Step 10 nte-end-digit-delay [milliseconds] (Optional) Specifies the amount of time that each digit in
the RTP NTE end event in an RFC 2833 packet is delayed
before being sent.
Example:
Router(config-ephone)# nte-end-digit-delay 150 • This command is supported in Cisco Unified CME 4.3
and later versions.
• milliseconds—length of delay. Range: 10 to 200.
Default: 200.
• To enable the delay, you must also configure the
dtmf-interworking rtp-nte command in
voice-service or dial-peer configuration mode. For
information, see “Enabling DTMF Integration Using
RFC 2833” on page 408.
• This command can also be configured in
ephone-template configuration mode. The value set in
ephone configuration mode has priority over the value
set in ephone-template mode.
Step 11 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Examples
The following example assigns extension 2225 in the Accounting Department to button 1 on ephone 2.
ephone-dn 25
number 2225
name Accounting
ephone 2
mac-address 00E1.CB13.0395
type 7960
button 1:25
What to Do Next
• If you have SIP and SCCP phones connected to the same Cisco Unified CME, see the “Configuring
Codecs of Individual Phones for Calls Between Local Phones” section on page 184.
• After configuring phones in Cisco Unified CME to make basic calls, you are ready to generate
configuration files for the phones to be connected. See “SCCP: Generating Configuration Files for
SCCP Phones” on page 263.
Cisco Unified Communications Manager Express System Administrator Guide
168 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
SIP: Creating Directory Numbers
To create a directory number in Cisco Unified CME for a SIP phone, intercom line, voice port, or a
message-waiting indicator (MWI), perform the following steps for each directory number to be created.
Prerequisites
• Cisco CME 3.4 or a later version.
• SIP shared-line directory numbers are supported in Cisco Unified CME 7.1 and later versions.
• The registrar server command must be configured. For configuration information, see “Enabling
Calls in Your VoIP Network” on page 80.
• In Cisco Unified CME 7.1 and later versions, the maximum number of directory numbers must be
changed from the default of 0 by using the max-dn (voice register global) command. For
configuration information, see “SIP: Setting Up Cisco Unified CME” on page 125.
Restrictions
• The maximum number of directory numbers supported by a router is version and platform
dependent.
• Call Forward All, Presence, and message-waiting indication (MWI) features in Cisco Unified
CME 4.1 and later versions require that SIP phones be configured with a directory number by using
the dn keyword with the number command; direct line numbers are not supported.
• SIP endpoints are not supported on H.323 trunks. SIP endpoints are supported on SIP trunks only.
• The Media Flow-around feature configured with the media flow-around command is not supported
by Cisco Unified CME with SIP phones.
• SIP shared-line directory numbers are not supported by the Cisco Unified IP Phone 7902, 7920,
7931, 7940, or 7960, or by analog phones connected to the Cisco VG224 or Cisco ATA.
• SIP shared-line directory numbers cannot be members of hunt groups.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register dn dn-tag
4. number number
5. shared-line [max-calls number-of-calls]
6. huntstop channel number-of-channels
7. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 169
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register dn dn-tag Enters voice register dn configuration mode to define a
directory number for a SIP phone, intercom line, voice port,
or a message-waiting indicator (MWI).
Example:
Router(config)# voice register dn 17
Step 4 number number Defines a valid number for a directory number.
Example:
Router(config-register-dn)# number 7001
Step 5 shared-line [max-calls number-of-calls] (Optional) Creates a shared-line directory number.
• max-calls number-of-calls—(Optional) Maximum
Example: number of calls, both incoming and outgoing.
Router(config-register-dn)# shared-line Range: 2 to 16. Default: 2.
max-calls 6
• Must be set to a value that is more than or equal to the
value set with the busy-trigger-per-button command.
• This command is supported in Cisco Unified CME 7.1
and later versions.
Step 6 huntstop channel number-of-channels (Optional) Enables channel huntstop, which keeps a call
from hunting to the next channel of a directory number if
the first channel is busy or does not answer.
Example:
Router(config-register-dn)# huntstop channel 3 • number-of-channels—Number of channels available to
accept incoming calls on the directory number.
Remaining channels are reserved for outgoing calls and
features such as call transfer, call waiting, and
conferencing. Range: 1 to 50. Default: 0 (disabled).
• This command is supported in Cisco Unified CME 7.1
and later versions.
Step 7 end Exits to privileged EXEC mode.
Example:
Router(config-register-dn)# end
Examples
The following example shows directory number 24 is configured as a shared line and assigned to
phone 124 and phone 125.
Cisco Unified Communications Manager Express System Administrator Guide
170 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
voice register dn 24
number 8124
shared-line max-calls 6
!
voice register pool 124
id mac 0017.E033.0284
type 7965
number 1 dn 24
!
voice register pool 125
id mac 00E1.CB13.0395
type 7965
number 1 dn 24
SIP: Assigning Directory Numbers to Phones
This task sets up which extensions appear on each phone. To create and modify phone-specific
parameters for individual SIP phones, perform the following steps for each SIP phone to be connected
in Cisco Unified CME.
Note If your Cisco Unified CME system supports SCCP and also SIP phones, do not connect your SIP phones
to your network until after you have verified the configuration profile for the SIP phone.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register pool pool-tag
4. id mac address
5. type phone-type
6. number tag dn dn-tag
7. busy-trigger-per-button number-of-calls
8. username name password string
9. dtmf-relay [cisco-rtp] [rtp-nte] [sip-notify]
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 171
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Command or Action Purpose
Step 3 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for a SIP phone.
Example:
Router(config)# voice register pool 3
Step 4 id {network address mask mask | ip address mask Explicitly identifies a locally available individual SIP phone to
mask | mac address} support a degree of authentication.
Example:
Router(config-register-pool)# id mac
0009.A3D4.1234
Step 5 type phone-type Defines a phone type for the SIP phone being configured.
Example:
Router(config-register-pool)# type 7960-7940
Step 6 number tag dn dn-tag Associates a directory number with the SIP phone being
configured.
Example: • dn dn-tag—Identifies the directory number for this SIP
Router(config-register-pool)# number 1 dn 17 phone as defined by the voice register dn command.
Step 7 busy-trigger-per-button number-of-calls (Optional) Sets the maximum number of calls allowed on
any of this phone’s directory numbers before triggering Call
Forward Busy or a busy tone.
Example:
Router(config-register-pool)# • number-of-calls—Maximum number of calls allowed
busy-trigger-per-button 2 before Cisco Unified CME forwards the next incoming
call to the Call Forward Busy destination, if configured,
or rejects the call with a busy tone. Range: 1 to 50.
Default: 0 (disabled).
• This command is supported in Cisco Unified CME 7.1
and later versions.
Step 8 username username password string (Optional) Required only if authentication is enabled with
the authenticate command. Creates an authentication
credential.
Example:
Router(config-register-pool)# username smith Note This command is not for SIP proxy registration. The
password 123zyx password will not be encrypted. All lines in a phone
will share the same credential.
• username—Identifies a local Cisco Unified IP phone
user. Default: Admin.
Step 9 dtmf-relay {[cisco-rtp] [rtp-nte] [sip-notify]} (Optional) Specifies a list of DTMF relay methods that can
be used by the SIP phone to relay DTMF tones.
Example: Note SIP phones natively support in-band DTMF relay as
Router(config-register-pool)# dtmf-relay specified in RFC 2833.
rtp-nte
Step 10 end Returns to privileged EXEC mode.
Example:
Router(config-register-pool)# end
Cisco Unified Communications Manager Express System Administrator Guide
172 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Examples
SIP Nonshared Line
In the following example, voice register dn 23 is assigned to phone 123. The fourth incoming call to
extension 8123 is not presented to the phone because the huntstop channel command is set to 3.
Because the busy-trigger-per-button command is set to 2 on phone 123, the third incoming call to
extension 8123 is forwarded to extension 8200 because Call Forward Busy is configured.
voice register dn 23
number 8123
call-forward b2bua busy 8200
huntstop channel 3
!
voice register pool 123
busy-trigger-per-button 2
id mac 0009.A3D4.1234
type 7965
number 1 dn 23
SIP Shared Line
In the following example, voice register dn 24 is shared by phones 124 and 125. The first two incoming
calls to extension 8124 ring both phones. A third incoming call rings only phone 125 because its
busy-trigger-per-button command is set to 3. The fourth incoming call to extension 8124 triggers Call
Forward Busy because the busy trigger limit on all phones is exceeded.
voice register dn 24
number 8124
call-forward b2bua busy 8200
shared-line max-calls 6
huntstop channel 6
!
voice register pool 124
busy-trigger-per-button 2
id mac 0017.E033.0284
type 7965
number 1 dn 24
!
voice register pool 125
busy-trigger-per-button 3
id mac 00E1.CB13.0395
type 7965
number 1 dn 24
What to Do Next
• If you have SIP and SCCP phones connected to the same Cisco Unified CME, see the “Configuring
Codecs of Individual Phones for Calls Between Local Phones” section on page 184.
• If you want to select the session-transport protocol for a SIP phone, see the “SIP: Selecting
Session-Transport Protocol for a Phone” section on page 180.
• If you are finished configuring phones to make basic calls, you are ready to generate configuration
files for the phones to be connected. See “SIP: Generating Configuration Profiles for SIP Phones”
on page 265.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 173
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
SIP: Configuring Dial Plans
Dial plans enable SIP phones to recognize digit strings dialed by users. After the phone recognizes a dial
pattern, it automatically sends a SIP INVITE message to Cisco Unified CME to initiate the call and does
not require the user to press the Dial key or wait for the interdigit timeout. To define a dial plan for a SIP
phone, perform the following steps.
Prerequisites
• Cisco Unified CME 4.1 or a later version.
• mode cme command must be enabled in Cisco Unified CME.
Restrictions
• If you create a dial plan by downloading a custom XML dial pattern file to flash and using the
filename command, and the XML file contains an error, the dial plan might not work properly on a
phone. We recommend creating a dial pattern file using the pattern command.
• To remove a dial plan that was created using a custom XML file with the filename command, you
must remove the dial plan from the phone, create a new configuration profile, and then use the reset
command to reboot the phone. You can use the restart command after removing a dial plan from a
phone only if the dial plan was created using the pattern command.
• To use KPML if a matching dial plan is not found, when both a dial plan and KPML are enabled on
a phone, you must configure a dial pattern with a single wildcard character (.) as the last pattern in
the dial plan. For example:
voice register dialplan 10
type 7940-7960-others
pattern 1 66...
pattern 2 91.......
pattern 3 .
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register dialplan dialplan-tag
4. type phone-type
5. pattern tag string [button button-number] [timeout seconds] [user {ip | phone}]
or
filename filename
6. exit
7. voice register pool pool-tag
8. dialplan dialplan-tag
9. end
Cisco Unified Communications Manager Express System Administrator Guide
174 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register dialplan dialplan-tag Enters voice register dialplan configuration mode to define
a dial plan for SIP phones.
Example:
Router(config)# voice register dialplan 1
Step 4 type phone-type Defines a phone type for the SIP dial plan.
• 7905-7912—Cisco Unified IP Phone 7905, 7905G,
Example: 7912, or 7912G.
Router(config-register-dialplan)# type
7905-7912
• 7940-7960-others—Cisco Unified IP Phone 7911,
7940, 7940G, 7941, 7941GE, 7960, 7960G, 7961,
7961GE, 7970, or 7971.
• The phone type specified with this command must
match the type of phone for which the dial plan is used.
If this phone type does not match the type assigned to
the phone with the type command in voice register pool
mode, the dial-plan configuration file is not generated.
• You must enter this command before using the pattern
or filename command in the next step.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 175
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Command or Action Purpose
Step 5 pattern tag string [button button-number] Defines a dial pattern for a SIP dial plan.
[timeout seconds] [user {ip | phone}]
or • tag—Number that identifies the dial pattern.
Range: 1 to 24.
filename filename
• string—Dial pattern, such as the area code, prefix, and
first one or two digits of the telephone number, plus
Example: wildcard characters or dots (.) for the remainder of the
Router(config-register-dialplan)# pattern 1
dialed digits.
52...
or • button button-number—(Optional) Button to which
Router(config-register-dialplan)# filename the dial pattern applies.
dialsip • timeout seconds—(Optional) Time, in seconds, that
the system waits before dialing the number entered by
the user. Range: 0 to 30. To have the number dialed
immediately, specify 0. If you do not use this
parameter, the phone's default interdigit timeout value
is used (10 seconds).
• user—(Optional) Tag that automatically gets added to
the dialed number. Do not use this keyword if
Cisco Unified CME is the only SIP call agent.
• ip—Uses the IP address of the user.
• phone—Uses the phone number of the user.
• Repeat this command for each pattern that you want to
include in this dial plan.
or
Specifies a custom XML file that contains the dial patterns
to use for the SIP dial plan.
• You must load the custom XML file must into flash and
the filename cannot include the .xml extension.
• The filename command is not supported for the
Cisco Unified IP Phone 7905 or 7912.
Step 6 exit Exits dialplan configuration mode.
Example:
Router(config-register-dialplan)# exit
Step 7 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for a SIP phone.
Example: • pool-tag—Unique sequence number of the SIP phone
Router(config)# voice register pool 4 to be configured. Range is version and
platform-dependent; type ? to display range. You can
modify the upper limit for this argument by using the
the max-pool command.
Cisco Unified Communications Manager Express System Administrator Guide
176 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Command or Action Purpose
Step 8 dialplan dialplan-tag Assigns a dial plan to a SIP phone.
• dialplan-tag—Number that identifies the dial plan to
Example: use for this SIP phone. This is the number that was used
Router(config-register-pool)# dialplan 1 with the voice register dialplan command in Step 3.
Range: 1 to 24.
Step 9 end Exits to privileged EXEC mode.
Example:
Router(config-register-global)# end
Examples
The following example shows the configuration for dial plan 1 which is assigned to SIP phone 1.
voice register dialplan 1
type 7940-7960-others
pattern 1 2... timeout 10 user ip
pattern 2 1234 user ip button 4
pattern 3 65...
pattern 4 1...!
!
voice register pool 1
id mac 0016.9DEF.1A70
type 7961GE
number 1 dn 1
number 2 dn 2
dialplan 1
dtmf-relay rtp-nte
codec g711ulaw
What to Do Next
If you are done modifying parameters for SIP phones, you must generate a new configuration profile and
restart the phones. See “Generating Configuration Files for Phones” on page 261.
SIP: Verifying Dial Plan Configuration
Step 1 show voice register dialplan tag
This command displays the configuration information for a specific SIP dial plan.
Router# show voice register dialplan 1
Dialplan Tag 1
Config:
Type is 7940-7960-others
Pattern 1 is 2..., timeout is 10, user option is ip, button is default
Pattern 2 is 1234, timeout is 0, user option is ip, button is 4
Pattern 3 is 65..., timeout is 0, user option is phone, button is default
Pattern 4 is 1..., timeout is 0, user option is phone, button is default
Step 2 show voice register pool tag
This command displays the dial plan assigned to a specific SIP phone.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 177
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Router# show voice register pool 29
Pool Tag 29
Config:
Mac address is 0012.7F54.EDC6
Number list 1 : DN 29
Proxy Ip address is 0.0.0.0
DTMF Relay is disabled
Call Waiting is enabled
DnD is disabled
keep-conference is enabled
dialplan tag is 1
kpml signal is enabled
service-control mechanism is not supported
.
.
.
Step 3 show voice register template tag
This command displays the dial plan assigned to a specific template.
Router# show voice register template 3
Temp Tag 3
Config:
Attended Transfer is disabled
Blind Transfer is enabled
Semi-attended Transfer is enabled
Conference is enabled
Caller-ID block is disabled
DnD control is enabled
Anonymous call block is disabled
Voicemail is 62000, timeout 15
Dialplan Tag is 1
Transport type is tcp
SIP: Enabling KPML
To enable KPML digit collection on a SIP phone, perform the following steps.
Prerequisites
• Cisco Unified CME 4.1 or a later version.
Restrictions
• This feature is supported only on Cisco Unified IP Phone 7911G, 7941G, 7941GE, 7961G, 7961GE,
7970G, and 7971GE.
• A dial plan assigned to a phone has priority over KPML.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
178 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
3. voice register pool pool-tag
4. digit collect kpml
5. end
6. show voice register dial-peer
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for a SIP phone.
Example: • pool-tag—Unique sequence number of the SIP phone
Router(config)# voice register pool 4 to be configured. Range is version and
platform-dependent; type ? to display range. You can
modify the upper limit for this argument by using the
max-pool command.
Step 4 digit collect kpml Enables KPML digit collection for the SIP phone.
Note This command is enabled by default for supported
Example: phones in Cisco Unified CME.
Router(config-register-pool)# digit collect
kpml
Step 5 end Exits to privileged EXEC mode.
Example:
Router(config-register-pool)# end
Step 6 show voice register dial-peers Displays details of all dynamically created VoIP dial peers
associated with the Cisco Unified CME SIP register
including the defined digit collection method.
Example:
Router# show voice register dial-peers
What to Do Next
If you are done modifying parameters for SIP phones, you must generate a new configuration profile and
restart the phones. See “Generating Configuration Files for Phones” on page 261.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 179
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
SIP: Selecting Session-Transport Protocol for a Phone
To change the session-transport protocol for a SIP phone to TCP, from the default of UDP, perform the
following steps.
Prerequisites
• Cisco Unified CME 4.1 or a later version.
• SIP phone to which configuration is to be applied must be already configured. For configuration
information, see the “SIP: Assigning Directory Numbers to Phones” section on page 171.
Restrictions
• TCP is not supported as a session-transport protocol for the Cisco Unified IP Phone 7905, 7912,
7940, or 7960. If TCP is assigned to an unsupported phone using this command, calls to that phone
will not complete successfully. The phone can originate calls, but it uses UDP, although TCP has
been assigned.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register pool pool-tag
4. session-transport {tcp | udp}
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for a SIP phone in
Cisco Unified CME.
Example:
Router(config)# voice register pool 3
Cisco Unified Communications Manager Express System Administrator Guide
180 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Command or Action Purpose
Step 4 session-transport {tcp | udp} (Optional) Specifies the transport layer protocol that a SIP
phone uses to connect to Cisco Unified CME.
Example: • This command can also be configured in voice register
Router(config-register-pool)# session-transport template configuration mode and applied to one or
tcp more phones. The voice register pool configuration has
priority over the voice register template configuration.
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-pool)# end
What to Do Next
• If you want to disable SIP Proxy registration for an individual directory number, see the “SIP:
Disabling SIP Proxy Registration for a Directory Number” section on page 181.
• If you have SIP and SCCP phones connected to the same Cisco Unified CME, see the “Configuring
Codecs of Individual Phones for Calls Between Local Phones” section on page 184.
• If you are finished configuring phones to make basic calls, you are ready to generate configuration
files for the phones to be connected. See “SIP: Generating Configuration Profiles for SIP Phones”
on page 265
SIP: Disabling SIP Proxy Registration for a Directory Number
To prevent a particular directory number from registering with an external SIP proxy server, perform the
following steps.
Prerequisites
• Cisco Unified CME 3.4 or a later version.
• Bulk registration is configured at system level. For configuration information, see “Configuring
Bulk Registration” on page 112.
Restrictions
• Phone numbers that are registered under voice register dn must belong to a SIP phone that is itself
registered in Cisco Unified CME.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register dn dn-tag
4. number number
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 181
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
5. no-reg
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register dn dn-tag Enters voice register dn configuration mode to define a
directory number for a SIP phone, intercom line, voice port,
or an MWI.
Example:
Router(config-register-global)# voice register
dn 1
Step 4 number number Defines a valid number for a directory number to be
assigned to a SIP phone in Cisco Unified CME.
Example:
Router(config-register-dn)# number 4085550152
Step 5 no-reg Causes directory number being configured to not register
with an external proxy server.
Example:
Router(config-register-dn)# no-reg
Step 6 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-dn)# end
What to Do Next
• If you want to configure the G.722-64K codec for all calls through your Cisco Unified CME system,
see the “Modifying the Global Codec” section on page 183.
• If you have SIP and SCCP phones connected to the same Cisco Unified CME, see the “Configuring
Codecs of Individual Phones for Calls Between Local Phones” section on page 184.
• If you want to configure individual phones to support some codec other than the system-level codec
or some codec other than the phone’s native codec, see the “Codecs for Cisco Unified CME Phones”
section on page 150.
• If you are finished configuring phones to make basic calls, you are ready to generate configuration
files for the phones to be connected. See “SIP: Generating Configuration Profiles for SIP Phones”
on page 265
Cisco Unified Communications Manager Express System Administrator Guide
182 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Modifying the Global Codec
To change the global codec from the default (G.711ulaw) to G722-64 for all calls through
Cisco Unified CME, perform the following steps.
Prerequisites
• Cisco Unified CME 4.3 or later versions.
Restrictions
• If G.722-64K codec is configured globally and a phone does not support the codec, the fallback
codec is G.711ulaw.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. codec {g711-ulaw | g722-64k}
5. service phone g722CodecSupport {0 | 1 | 2}
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony service configuration mode to set
parameters for SCCP and SIP phones in
Cisco Unified CME.
Example:
Router(config)# telephony-service
Step 4 codec {g711-ulaw | g722-64k} Specifies the preferred codec for phones in
Cisco Unified CME.
Example: • Required only if you want to modify codec from the
Router(config-telephony)# codec g722-64k default (G.711ulaw) to G722-64K.
• codec-type—Default: g711ulaw
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 183
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Command or Action Purpose
Step 5 service phone g722CodecSupport {0 | 1 | 2} Causes all phones to advertise the G.722-64K codec to
Cisco Unified CME.
Example: • Required only if you configured the codec g722-64k
Router(config)# service phone g722CodecSupport command in telephony-service configuration mode.
2
• 722CodecSupport—Default: 0, phone default set by
manufacturer and equal to enabled or disabled.
• Cisco phone firmware 8.2.1 or a later version is
required to support the G.722-64K codec on
G.722-capable SCCP phones.
• Cisco phone firmware 8.3.1 or a later version is
required to support the G.722-64K codec on
G.722-capable SIP phones.
• For SCCP only: This command can also be configured
in ephone- template configuration mode and applied to
one or more SCCP phones.
Step 6 end Exits the configuration mode and enters privileged EXEC
mode.
Example:
Router(config-telephony)# end
What to Do Next
• If you have SIP and SCCP phones connected to the same Cisco Unified CME, see the “Configuring
Codecs of Individual Phones for Calls Between Local Phones” section on page 184.
• If you want to configure individual phones to support some codec other than the system-level codec
or some codec other than the phone’s native codec, see the “Configuring Codecs of Individual
Phones for Calls Between Local Phones” section on page 184.
• If you are finished configuring SCCP phones to make basic calls, you are ready to generate
configuration files for the phones to be connected. See “SCCP: Generating Configuration Files for
SCCP Phones” on page 263.
Configuring Codecs of Individual Phones for Calls Between Local Phones
To designate a codec for individual phones to ensure connectivity between a variety of phones connected
to the same Cisco Unified CME router, perform the following steps for each SCCP or SIP phone.
Note If codec values for the dial peers of an internal connection do not match, the call fails. For calls to external
phones; that is, phones that are not in the same Cisco Unified CME, such as VoIP calls, the codec is negotiated
based on the protocol that is used for the call, such as H.323. Cisco Unified CME plays no part in the
negotiation.
Prerequisites
• For SIP phones in Cisco Unified CME: Cisco Unified CME 3.4 or a later version.
Cisco Unified Communications Manager Express System Administrator Guide
184 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
• For G.722-64K and iLBC codecs: Cisco Unified CME 4.3 or a later version.
• To support G.722-64K on an individual phone: Cisco phone firmware 8.2.1 or a later version for
SCCP phones and 8.3.1 or a later version for SIP pones. For information about upgrading Cisco
phone firmware, see “Installing and Upgrading Cisco Unified CME Software” on page 53.
• To support iLBC on an individual phone: Cisco phone firmware 8.3.1 or a later version for SCCP
and SIP phones. For information about upgrading Cisco phone firmware, see “Installing and
Upgrading Cisco Unified CME Software” on page 53.
• Cisco Unified IP phone to which the codec is to be applied must be already configured. For
configuration information for SIP phones, see the “SIP: Assigning Directory Numbers to Phones”
section on page 171. For configuration information for SCCP phones, see the “SCCP: Assigning
Directory Numbers to Phones” section on page 165.
Restrictions
• Not all phones support all codecs. To verify whether your phone supports a particular codec, see
your phone documentation.
• For SIP and SCCP phones in Cisco Unified CME: Modify the configuration for either SIP or SCCP
phones to ensure that the codec for all phones match. Do not modify the configuration for SIP and
SCCP phones.
• If G.729 is the desired codec for Cisco ATA-186 and Cisco ATA-188, then only one port of the
Cisco ATA device should be configured in Cisco Unified CME. If a call is placed to the second port
of the Cisco ATA device, it will be disconnected gracefully. If you want to use both Cisco ATA ports
simultaneously, then configure G.711 in Cisco Unified CME.
• If G.722-64K or iLBC codecs are configured in ephone configuration mode and the phone does not
support the codec, the fallback is the global codec or G.711 ulaw if the global codec is not supported.
To configure a global codec, see the “Modifying the Global Codec” section on page 183.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone ephone-tag
or
voice register pool-tag
4. codec codec-type
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 185
Configuring Phones to Make Basic Calls
How to Configure Phones for a PBX System
Command or Action Purpose
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone ephone-tag Enters ephone configuration mode to set phone-specific
or parameters for a SCCP phone in Cisco Unified CME.
voice register pool pool-tag or
Enters voice register pool configuration mode to set
Example: phone-specific parameters for a SIP phone in
Router(config)# telephony-service Cisco Unified CME.
Step 4 codec codec-type Specifies the codec for the dial peer for the IP phone being
configured.
Example: • codec-type—Type ? for a list of codecs.
Router(config-ephone)# codec g729r8
• This command overrides any previously configured
or
codec selection set with the voice-class codec
Router(config-register-pool)# codec g711alaw command.
• This command overrides any previously configured
codec selection set with the codec command in
telephony-service configuration mode.
• SCCP only—This command can also be configured in
ephone-template configuration mode and applied to
one or more phones.
Step 5 end Exits the configuration mode and enters privileged EXEC
mode.
Example:
Router(config-ephone)# end
or
Router(config-register-pool)# end
What to Do Next
• If you want to select the session-transport protocol for a SIP phone, see the “SIP: Selecting
Session-Transport Protocol for a Phone” section on page 180.
• If you are finished configuring SIP phones to make basic calls using, you are ready to generate
configuration files for the phones to be connected. See “SIP: Generating Configuration Profiles for
SIP Phones” on page 265.
• If you are finished configuring SCCP phones to make basic calls, you are ready to generate
configuration files for the phones to be connected. See “SCCP: Generating Configuration Files for
SCCP Phones” on page 263.
Cisco Unified Communications Manager Express System Administrator Guide
186 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a Key System
How to Configure Phones for a Key System
This section contains the following tasks:
• SCCP: Creating Directory Numbers for a Simple Key System, page 187 (required)
• SCCP: Configuring Trunk Lines for a Key System, page 190 (required)
• SCCP: Configuring Individual IP Phones for Key System, page 197 (required)
SCCP: Creating Directory Numbers for a Simple Key System
To create a set of directory numbers with the same number to be associated with multiple line buttons
on an IP phone and provide support for call waiting and call transfer on a key system phone, perform the
following steps.
Restrictions
• Do not configure directory numbers for a key system for dual-line mode because this does not
conform to the key system one-call-per-line button usage model for which the phone is designed.
• Provisioning support for the Cisco Unified IP Phone 7931 is available only in Cisco Unified CME
4.0(2) and later versions.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
4. number number [secondary number] [no-reg [both | primary]]
5. preference preference-order
6. no huntstop
or
huntstop
7. mwi-type {visual | audio | both}
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 187
Configuring Phones to Make Basic Calls
How to Configure Phones for a Key System
Command or Action Purpose
Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode to create a
directory number.
Example:
Router(config)# ephone-dn 11
Step 4 number number [secondary number] [no-reg [both | Configures a valid phone or extension number for this
primary]] directory number.
Example:
Router(config-ephone-dn)# number 101
Step 5 preference preference-order Sets dial-peer preference order for a directory number
associated with a Cisco Unified IP phone.
Example:
• Default: 0.
Router(config-ephone-dn)# preference 1
• Increment the preference order for all subsequent
instances within a set of ephone dns with the same
number to be associated with a key system phone.
That is, the first instance of the directory number is
preference 0 by default and you must specify 1 for
the second instance of the same number, 2 for the
next, and so on. This allows you to create multiple
buttons with the same number on an IP phone.
• Required to support call waiting and call transfer on
a key system phone.
Step 6 no huntstop Explicitly enables call hunting behavior for a directory
or number.
huntstop • Configure no huntstop for all instances, except the
final instance, within a set of ephone dns with the
Example: same number to be associated with a key system
Router(config-ephone-dn)# no huntstop phone.
or • Required to allow call hunting across multiple line
Router(config-ephone-dn)# huntstop buttons with the same number on an IP phone.
or
Disables call hunting behavior for a directory number.
• Configure the huntstop command for the final
instance within a set of ephone dns with the same
number to be associated with a key system phone.
• Required to limit the call hunting to a set of multiple
line buttons with the same number on an IP phone.
Cisco Unified Communications Manager Express System Administrator Guide
188 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a Key System
Command or Action Purpose
Step 7 mwi-type {visual | audio | both} Specifies the type of MWI notification to be received.
• This command is supported only by Cisco Unified
Example: IP Phone 7931s and Cisco Unified IP Phone 7911s.
Router(config-ephone-dn)# mwi-type audible
• This command can also be configured in
ephone-dn-template configuration mode. The value
set in ephone-dn configuration mode has priority
over the value set in ephone-dn-template mode.
Step 8 end Exits to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
Examples
The following example shows the configuration for six instances of directory number 101, assigned to
the first six buttons of an IP phone.
ephone-dn 10
number 101
no huntstop
ephone-dn 11
number 101
preference 1
no huntstop
ephone-dn 12
number 101
preference 2
no huntstop
ephone-dn 13
number 101
preference 3
no huntstop
ephone-dn 14
number 101
preference 4
no huntstop
ephone-dn 15
number 101
preference 5
ephone 1
mac-address 0001.2345.6789
type 7931
button 1:10 2:11 3:12 4:13 5:14 6:15
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 189
Configuring Phones to Make Basic Calls
How to Configure Phones for a Key System
SCCP: Configuring Trunk Lines for a Key System
To set up trunk lines for your key system, perform only one of the following procedures:
• To only enable direct status monitoring of the FXO port on the line button of the IP phone, see the
“SCCP: Configuring a Simple Key System Phone Trunk Line Configuration” section on page 190
• To enable direct status monitoring and allow transferred PSTN FXO line calls to be automatically
recalled if the transfer target does not answer, see the “SCCP: Configuring an Advanced Key System
Phone Trunk Line Configuration” section on page 193.
SCCP: Configuring a Simple Key System Phone Trunk Line Configuration
Perform the steps in this section to:
• Create directory numbers corresponding to each FXO line that allows phones to have shared or
private lines connected directly to the PSTN.
• Enable direct status monitoring of the FXO port on the line button of the IP phone. The line button
indicator, either a lamp or an icon depending on the phone, shows the in-use status of the FXO port
during the duration of the call.
Prerequisites
• FXO port for a private line automatic ringdown (PLAR) off-premises extension (OPX) connection
must be configured; for example:
voice-port 1/0/0
connection plar-opx 801 <<----Private number
• Dial peers for FXO port must be configured; for example:
dial-peer voice 111 pots
destination-pattern 811 <<----Trunk-tag
port 1/0/0
Restrictions
• A directory number with a trunk line cannot be configured for call forward, busy, or no answer.
• Numbers entered after a trunk line is seized will not be displayed. Only the trunk tag is displayed
on IP phones.
• Numbers entered after trunk line is seized will not appear in call history or call detail records
(CDRs) of a Cisco Unified CME router. Only the trunk tag is logged for calls made from trunk lines.
• FXO trunk lines do not support the CFwdALL, Transfer, Pickup, GPickUp, Park, CallBack, and
NewCall soft keys.
• FXO trunk lines do not support conference initiator dropoff.
• FXO trunk lines do not support on-hook redial. The phone user must explicitly select the FXO trunk
line before pressing the Redial button.
• FXO trunk lines do not support call transfer to IP phones. However, the call initiator can conference
an FXO line with an IP phone by pressing the Hold button, which leaves the FXO trunk line and IP
phone connected. The conference initiator is unable to participate in the conference, but can place
calls on other lines.
• FXO trunk lines do not support bulk speed dial.
Cisco Unified Communications Manager Express System Administrator Guide
190 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a Key System
• FXO port monitoring has the following restrictions:
– Not supported before Cisco Unified CME 4.0.
– Supported only for analog FXO loop-start and ground-start ports and T1/E1 FXO CAS ports.
FXS loop-start and ground-start ports and PRI/BRI PSTN trunks are not supported.
– Not supported for analog ports on the Cisco VG224 or Cisco ATA 180 Series.
– T1 CAS DS0 group must be configured per time slot (cannot bundle more than one time slot
into a ds0-group).
• Transfer recall and transfer-to button optimization are supported on dual-line directory numbers
only in Cisco Unified CME 4.0 and later.
• Transfer-to button optimization is not supported for call forwarding, call-park recall, call pickup on
hold, or call pickup at alert.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
4. number number [secondary number] [no-reg [both | primary]]
5. trunk digit-string [timeout seconds] monitor-port port
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode to create a
directory number.
Example: • Configure this command in the default single line
Router(config)# ephone-dn 51 mode, without the dual-line keyword, when
configuring a simple key system trunk line.
Step 4 number number [secondary number] [no-reg [both | Configures a valid phone or extension number for this
primary]] directory number.
Example:
Router(config-ephone-dn)# number 801
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 191
Configuring Phones to Make Basic Calls
How to Configure Phones for a Key System
Command or Action Purpose
Step 5 trunk trunk-tag [timeout seconds] monitor-port Associates a directory number with a foreign exchange
port office (FXO) port.
• The monitor-port keyword is not supported before
Example: Cisco Unified CME 4.0.
Router(config-ephone-dn)# trunk 811 monitor-port
1/0/0 • The monitor-port keyword is not supported on
directory numbers for analog ports on the
Cisco VG224 or Cisco ATA 180 Series.
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
Examples
The following example shows the configuration for six instances of directory number 101, assigned to
the first six buttons of an IP phone, plus four PSTN line appearances that are assigned to buttons 7 to 10.
ephone-dn 10
number 101
no huntstop
ephone-dn 11
number 101
preference 1
no huntstop
ephone-dn 12
number 101
preference 2
no huntstop
ephone-dn 13
number 101
preference 3
no huntstop
ephone-dn 14
number 101
preference 4
no huntstop
ephone-dn 15
number 101
preference 5
ephone-dn 51
number 801
trunk 811 monitor-port 1/0/0
ephone-dn 52
number 802
trunk 812 monitor-port 1/0/1
ephone-dn 53
number 803
trunk 813 monitor-port 1/0/2
Cisco Unified Communications Manager Express System Administrator Guide
192 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a Key System
ephone-dn 54
number 804
trunk 814 monitor-port 1/0/3
ephone 1
mac-address 0001.2345.6789
type 7931
button 1:11 2:12 3:13 4:14 5:15 6:16 7:51 8:52 9:53 10:54
voice-port 1/0/0
connection plar opx 801
voice-port 1/0/1
connection plar opx 802
voice-port 1/0/2
connection plar opx 803
voice-port 1/0/3
connection plar opx 804
dial-peer voice 811 pots
destination-pattern 811
port 1/0/0
dial-peer voice 812 pots
destination-pattern 812
port 1/0/1
dial-peer voice 813 pots
destination-pattern 813
port 1/0/2
dial-peer voice 814 pots
destination-pattern 814
port 1/0/3
What to Do Next
You are ready to configure each individual phone and assign button numbers, line characteristics, and
directory numbers to buttons on the phone. See the “SCCP: Configuring Individual IP Phones for Key
System” section on page 197.
SCCP: Configuring an Advanced Key System Phone Trunk Line Configuration
Perform the steps in this section to:
• Create directory numbers corresponding to each FXO line that allows phones to have shared or
private lines connected directly to the PSTN.
• Enable direct status monitoring of the FXO port on the line button of the IP phone. The line button
indicator, either a lamp or an icon depending on the phone, shows the in-use status of the FXO port
during the duration of the call.
• Allow transferred PSTN FXO line calls to be automatically recalled if the transfer target does not
answer after the specified number of seconds. The call is withdrawn from the transfer-to phone and
the call resumes ringing on the phone that initiated the transfer.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 193
Configuring Phones to Make Basic Calls
How to Configure Phones for a Key System
Prerequisites
• FXO port for a private line automatic ringdown (PLAR) off-premises extension (OPX) connection
must be configured; for example:
voice-port 1/0/0
connection plar-opx 801 <<----Private number
• Dial peers for FXO port must be configured; for example:
dial-peer voice 111 pots
destination-pattern 811 <<----Trunk-tag
port 1/0/0
Restrictions
• An ephone-dn with a trunk line cannot be configured for call forward, busy, or no answer.
• Numbers entered after a trunk line is seized will not be displayed. Only the trunk tag is displayed
on IP phones.
• Numbers entered after trunk line is seized will not appear in call history or call detail records
(CDRs) of a Cisco Unified CME router. Only the trunk tag is logged for calls made from trunk lines.
• FXO trunk lines do not support the CFwdALL, Transfer, Pickup, GPickUp, Park, CallBack, and
NewCall soft keys.
• FXO trunk lines do not support conference initiator dropoff.
• FXO trunk lines do not support on-hook redial. The phone user must explicitly select the FXO trunk
line before pressing the Redial button.
• FXO trunk lines do not support call transfer to IP phones. However, the call initiator can conference
an FXO line with an IP phone by pressing the Hold button, which leaves the FXO trunk line and IP
phone connected. The conference initiator is unable to participate in the conference, but can place
calls on other lines.
• FXO trunk lines do not support bulk speed dial.
• FXO port monitoring has the following restrictions:
– Not supported before Cisco Unified CME 4.0.
– Supported only for analog FXO loop-start and ground-start ports and T1/E1 FXO CAS ports.
FXS loop-start and ground-start ports and PRI/BRI PSTN trunks are not supported.
– Not supported for analog ports on the Cisco VG224 or Cisco ATA 180 Series.
– T1 CAS DS0 group must be configured per time slot (cannot bundle more than one time slot
into a ds0-group).
• Transfer recall and transfer-to button optimization is supported on dual-line directory numbers only
in Cisco Unified CME 4.0 and later.
• Transfer-to button optimization is not supported for call forwarding, call-park recall, call pickup on
hold, or call pickup at alert.
• Transfer recall is not supported for analog ports on the Cisco VG224 or Cisco ATA 180 Series.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
194 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a Key System
3. ephone-dn dn-tag dual-line
4. number number [secondary number] [no-reg [both | primary]]
5. trunk digit-string [timeout seconds] [transfer-timeout seconds] [monitor-port port]
6. huntstop [channel]
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag dual-line Enters ephone-dn configuration mode for the purposes of
creating and configuring a telephone or extension
number.
Example:
Router(config)# ephone-dn 51 dual-line • dual-line—Required when configuring an advanced
key system phone trunk line. Dual-line mode
provides a second call channel for the directory
number on which to place an outbound consultation
call during the call transfer attempt. This also allows
the phone to remain part of the call in order to
monitor the progress of the transfer attempt and if
the transfer is not answered, to pull the call back to
the phone on the original PSTN line button.
Step 4 number number [secondary number] [no-reg [both | Configures a valid telephone number or extension
primary]] number for this directory number.
Example:
Router(config-ephone-dn)# number 801
Step 5 trunk digit-string [timeout seconds] Associates this directory number with a foreign
[transfer-timeout seconds] [monitor-port port] exchange office (FXO) port.
• transfer-timeout seconds—For dual-line
Example: ephone-dns only. Range: 5 to 60000.
Router(config-ephone-dn)# trunk 811 Default: Disabled.
transfer-timeout 30 monitor-port 1/0/0
• The monitor-port keyword is not supported before
Cisco Unified CME 4.0.
• The monitor-port and transfer-timeout keywords
are not supported on directory numbers for analog
ports on the Cisco VG224 or Cisco ATA 180 Series.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 195
Configuring Phones to Make Basic Calls
How to Configure Phones for a Key System
Command or Action Purpose
Step 6 huntstop [channel] Disables call hunting to the second channel of this
directory number if the first channel is busy or does not
answer.
Example:
Router(config-ephone-dn)# huntstop channel • channel—Required when configuring an advanced
key system phone trunk line. Reserves the second
channel created by configuring dual-line mode for
the ephone-dn command so that an outbound
consultation call can be placed during a call transfer
attempt.
Step 7 end Exits to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
Examples
The following example shows the configuration for six instances of directory number 101, assigned to
the first six buttons of an IP phone, plus four PSTN line appearances that are assigned to buttons 7 to 10.
These four PSTN line appearances are configured as dual lines to provide a second call channel on which
to place an outbound consultation call during a call transfer attempt. This configuration allows the phone
to remain part of the call in order to monitor the progress of the transfer attempt, and if the transfer is
not answered, to pull the call back to the phone on the original PSTN line button.
ephone-dn 10
number 101
no huntstop
ephone-dn 11
number 101
preference 1
no huntstop
ephone-dn 12
number 101
preference 2
no huntstop
ephone-dn 13
number 101
preference 3
no huntstop
ephone-dn 14
number 101
preference 4
no huntstop
ephone-dn 15
number 101
preference 5
ephone-dn 51 dual-line
number 801
trunk 811 transfer-timeout 30 monitor-port 1/0/0
huntstop channel
Cisco Unified Communications Manager Express System Administrator Guide
196 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Phones for a Key System
ephone-dn 52 dual-line
number 802
trunk 812 transfer-timeout 30 monitor-port 1/0/1
huntstop channel
ephone-dn 53 dual-line
number 803
trunk 813 transfer-timeout 30 monitor-port 1/0/2
huntstop channel
ephone-dn 54 dual-line
number 804
trunk 814 transfer-timeout 30 monitor-port 1/0/3
huntstop channel
ephone 1
mac-address 0001.2345.6789
type 7931
button 1:11 2:12 3:13 4:14 5:15 6:16 7:51 8:52 9:53 10:54
voice-port 1/0/0
connection plar opx 801
voice-port 1/0/1
connection plar opx 802
voice-port 1/0/2
connection plar opx 803
voice-port 1/0/3
connection plar opx 804
dial-peer voice 811 pots
destination-pattern 811
port 1/0/0
dial-peer voice 812 pots
destination-pattern 812
port 1/0/1
dial-peer voice 813 pots
destination-pattern 813
port 1/0/2
dial-peer voice 814 pots
destination-pattern 814
port 1/0/3
SCCP: Configuring Individual IP Phones for Key System
To assign button numbers, line characteristics, and directory numbers to buttons on an individual phone
to operate as a key system phone, perform the following steps.
Restrictions
• Provisioning for Cisco Unified IP Phone 7931G is available only in Cisco Unified CME 4.0(2) and
later versions.
• Cisco Unified IP Phone 7931G can support only one call waiting overlaid per directory number.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 197
Configuring Phones to Make Basic Calls
How to Configure Phones for a Key System
• Cisco Unified IP Phone 7931G cannot support overlays that contain directory numbers configured
for dual-line mode.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. mac-address [mac-address]
5. type phone-type
6. button button-number{separator}dn-tag [,dn-tag...] [button-number{x}overlay-button-number]
[button-number...]
7. mwi-line line-number
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
Example:
Router(config)# ephone 1
Step 4 mac-address [mac-address] Specifies the MAC address of the IP phone that is being
configured.
Example:
Router(config-ephone)# mac-address 0001.2345.6789
Step 5 type phone-type Specifies the type of phone that is being configured.
Example:
Router(config-ephone)# type 7931
Step 6 button button-number{separator}dn-tag Associates a button number and line characteristics with
[,dn-tag...] an ephone-dn. Maximum number of buttons is
[button-number{x}overlay-button-number]
[button-number...]
determined by phone type.
Tip The line button layout for the Cisco Unified IP
Phone 7931G is a bottom-up array. Button 1 is at
Example:
the bottom right of the array and button 24 is at
Router(config-ephone)# button 1:11 2:12 3:13 4:14
5:15 6:16 7:51 8:52 9:53 10:54 the top left of the array.
Cisco Unified Communications Manager Express System Administrator Guide
198 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
Command or Action Purpose
Step 7 mwi-line line-number Selects a phone line to receive MWI treatment; when a
message is waiting for the selected line, the message
waiting indicator is activated.
Example:
Router(config-ephone)# mwi-line 3 • line-number—Range: 1 to 34. Default: 1.
Step 8 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-ephone)# end
What to Do Next
• If you have SIP and SCCP phones connected to the same Cisco Unified CME, see the “Configuring
Codecs of Individual Phones for Calls Between Local Phones” section on page 184.
• To select a fixed-button layout for a Cisco Unified IP Phone 7931G, see “SCCP: Selecting Button
Layout for a Cisco Unified IP Phone 7931G” on page 1106.
• If you are finished configuring phones to make basic calls, you are ready to generate configuration
files for the phones to be connected. See “SCCP: Generating Configuration Files for SCCP Phones”
on page 263.
How to Configure Cisco ATA, Analog Phone Support, Remote
Phones, Cisco IP Communicator, and Secure IP Phone (IP-STE)
This section contains the following tasks:
Cisco ATA
• Configuring Cisco ATA Support, page 200 (required)
• Verifying Cisco ATA Support, page 201 (optional)
• Using Call Pickup and Group Call Pickup with Cisco ATA, page 203 (optional)
Analog Phones
• SCCP: Enabling Auto-Configuration for Cisco VG202, VG204, and VG224, page 204
• SCCP: Configuring Phones on SCCP Controlled Analog (FXS) Ports, page 206 (required)
• SCCP: Verifying Analog Phone Support, page 209 (optional)
Remote phones
• SCCP: Enabling a Remote Phone, page 209 (required)
• SCCP: Verifying Remote Phones, page 211 (optional)
Cisco IP Communicator
• SCCP: Configuring Cisco IP Communicator Support, page 211 (required)
• SCCP: Verifying Cisco IP Communicator Support, page 213 (required)
• SCCP: Troubleshooting Cisco IP Communicator Support, page 213 (optional)
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 199
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
Secure IP Phones
• SCCP: Configuring Secure IP Phone (IP-STE), page 214
Configuring Cisco ATA Support
To enable an analog phone that uses a Cisco ATA to register with Cisco Unified CME, perform the
following steps.
Restrictions
For a Cisco ATA that is registered to a Cisco Unified CME system to participate in fax calls, it must have
its ConnectMode parameter set to use the same RTP payload type as the Cisco voice gateway that is
performing the fax pass-through. Cisco voice gateways use standard payload type 0/8, which is selected
on Cisco ATAs by setting bit 2 of the ConnectMode parameter to 1. For more information, see the
“Parameters and Defaults” chapter in the Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor
Administrator's Guide for SCCP (version 3.0).
SUMMARY STEPS
1. Install Cisco ATA.
2. Configure Cisco ATA for SCCP.
3. Upgrade firmware.
4. Set network parameters on Cisco ATA.
5. Configure analog phones in Cisco Unified CME.
DETAILED STEPS
Step 1 Install the Cisco ATA. See the “Installing the Cisco ATA” chapter in the in Cisco ATA 186 and
Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for SCCP (version 3.0).
Step 2 Configure the Cisco ATA. See the “Configuring the Cisco ATA for SCCP” chapter in the Cisco ATA 186
and Cisco ATA 188 Analog Telephone Adaptor Administrator’s Guide for SCCP (version 3.0).
Step 3 Upgrade to the latest Cisco ATA image. If you are using either the v2.14 or v2.14ms Cisco ATA 186
image based on the 2.14 020315a build for H.323/SIP or the 2.14 020415a build for MGCP or SCCP,
you must upgrade to the latest version to install a security patch. This patch fixes a security hole in the
Cisco ATA Web server that allows users to bypass the user interface password.
For information about upgrading firmware, see “Installing and Upgrading Cisco Unified CME
Software” on page 53. Alternatively, you can use a manual method, as described in the “Upgrading the
Cisco ATA Signaling Image” chapter of the Cisco ATA 186 and Cisco ATA 188 Analog Telephone
Adaptor Administrator’s Guide for SCCP (version 3.0).
Step 4 Configure the Cisco ATA to set the following parameters:
– DHCP parameter to 1 (enabled).
– TFTP parameter to 1 (enabled).
– TFTPURL parameter to the IP address of the router running Cisco Unified CME.
– SID0 parameter to a period (.) or the MAC address of the Cisco ATA (to enable the first port).
Cisco Unified Communications Manager Express System Administrator Guide
200 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
– SID1 parameter to a period (.) or a modified version the Cisco ATA’s MAC address, with the
first two hexadecimal numbers removed and 01 appended to the end, if you want to use the
second port. For example, if the MAC address of the Cisco ATA is 00012D01073D, set SID1 to
012D01073D01.
– Nprintf parameter to the IP address and port number of the host to which all Cisco ATA debug
messages are sent. The port number is usually set to 9001.
– To prevent tampering and unauthorized access to the Cisco ATA 186, you can disable the
web-based configuration. However, if you disable the web configuration page, you must use
either a TFTP server or the voice configuration menu to configure the Cisco ATA 186.
Step 5 Configure analog phones that use a Cisco ATA in the same way as a Cisco Unified IP phone. In the type
command, use the ata keyword. For information on how to provision phones, see the “SCCP: Creating
Directory Numbers” section on page 158.
What to Do Next
• If you have SIP and SCCP phones connected to the same Cisco Unified CME, see the “Configuring
Codecs of Individual Phones for Calls Between Local Phones” section on page 184.
• To select a fixed-button layout for a Cisco Unified IP Phone 7931G, see “SCCP: Selecting Button
Layout for a Cisco Unified IP Phone 7931G” on page 1106.
• If you are finished configuring phones to make basic calls, you are ready to generate configuration
files for the phones to be connected. See “SCCP: Generating Configuration Files for SCCP Phones”
on page 263 and “SIP: Generating Configuration Profiles for SIP Phones” on page 265.
Verifying Cisco ATA Support
Use the show ephone ata command to display SCCP phone configurations with the type ata command.
The following is sample output for a Cisco Unified CME configured for two analog phones using a
Cisco ATA with MAC address 000F.F758.E70E.
ephone-30 Mac:000F.F758.E70E TCP socket:[2] activeLine:0 REGISTERED in SCCP ver 1 and
Server in ver 1
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0 caps:7
IP:1.4.188.72 15325 ATA Phone keepalive 7 max_line 2 dual-line
button 1: dn 80 number 8080 CH1 IDLE CH2 IDLE
ephone-31 Mac:0FF7.58E7.0E01 TCP socket:[3] activeLine:0 REGISTERED in SCCP ver 1 and
Server in ver 1
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0 caps:3
IP:1.4.188.72 15400 ATA Phone keepalive 7 max_line 2 dual-line
button 1: dn 81 number 8081 CH1 IDLE CH2 IDLE
Troubleshooting Cisco ATA Support
Use the debug ephone detail command to diagnose problems with analog phones that use Cisco ATAs.
The following is sample output for two analog phones using a Cisco ATA with MAC address
000F.F758.E70E. The sample shows the activities that take place when the phones register.
Router# debug ephone detail mac-address 000F.F758.E70E
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 201
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
*Apr 5 02:50:11.966: New Skinny socket accepted [1] (33 active)
*Apr 5 02:50:11.970: sin_family 2, sin_port 15325, in_addr 1.4.188.72
*Apr 5 02:50:11.970: skinny_add_socket 1 1.4.188.72 15325
21:21:49: %IPPHONE-6-REG_ALARM: Name=ATA000FF758E70E Load=ATA030203SCCP051201A.zup
Last=Initialized
*Apr 5 02:50:11.974:
Skinny StationAlarmMessage on socket [2] 1.4.188.72 ATA000FF758E70E
*Apr 5 02:50:11.974: severityInformational p1=0 [0x0] p2=0 [0x0]
*Apr 5 02:50:11.974: Name=ATA000FF758E70E Load=ATA030203SCCP051201A.zup Last=Initialized
*Apr 5 02:50:12.066: ephone-(30)[2] StationRegisterMessage (29/31/48) from 1.4.188.72
*Apr 5 02:50:12.066: ephone-(30)[2] Register StationIdentifier DeviceName ATA000FF758E70E
*Apr 5 02:50:12.070: ephone-(30)[2] StationIdentifier Instance 1 deviceType 12
*Apr 5 02:50:12.070: ephone-30[-1]:stationIpAddr 1.4.188.72
*Apr 5 02:50:12.070: ephone-30[-1]:maxStreams 0
*Apr 5 02:50:12.070: ephone-30[-1]:protocol Ver 0x1
*Apr 5 02:50:12.070: ephone-30[-1]:phone-size 5392 dn-size 632
*Apr 5 02:50:12.070: ephone-(30) Allow any Skinny Server IP address 1.4.188.65
*Apr 5 02:50:12.070: ephone-30[-1]:Found entry 29 for 000FF758E70E
*Apr 5 02:50:12.070: ephone-30[-1]:socket change -1 to 2
*Apr 5 02:50:12.070: ephone-30[-1]:FAILED: CLOSED old socket -1
*Apr 5 02:50:12.074: ephone-30[2]:phone ATA000FF758E70E re-associate OK on socket [2]
21:21:49: %IPPHONE-6-REGISTER: ephone-30:ATA000FF758E70E IP:1.4.188.72 Socket:2
DeviceType:Phone has registered.
*Apr 5 02:50:12.074: Phone 29 socket 2
*Apr 5 02:50:12.074: Phone 29 socket 2: Running Bravo ??
*Apr 5 02:50:12.074: Skinny Local IP address = 1.4.188.65 on port 2000
*Apr 5 02:50:12.074: Skinny Phone IP address = 1.4.188.72 15325
*Apr 5 02:50:12.074: ephone-30[2]:Signal protocol ver 8 to phone with ver 1
*Apr 5 02:50:12.074: ephone-30[2]:Date Format M/D/Y
*Apr 5 02:50:12.078: ephone-30[2]:RegisterAck sent to ephone 2: keepalive period 30 use
sccp-version 1
*Apr 5 02:50:12.078: ephone-30[2]:CapabilitiesReq sent
*Apr 5 02:50:12.090: ephone-30[2]:VersionReq received
*Apr 5 02:50:12.090: ephone-30[2]:Version String not needed for ATA device. Part of XML
file
*Apr 5 02:50:12.090: ephone-30[2]:Version Message sent
*Apr 5 02:50:12.094: ephone-30[2]:CapabilitiesRes received
*Apr 5 02:50:12.098: ephone-30[2]:Caps list 7
G711Ulaw64k 60 ms
G711Alaw64k 60 ms
G729 60 ms
G729AnnexA 60 ms
G729AnnexB 60 ms
G729AnnexAwAnnexB 60 ms
Unrecognized Media Type 257 60 ms
*Apr 5 02:50:12.098: ephone-30[2]:ButtonTemplateReqMessage
*Apr 5 02:50:12.098: ephone-30[2]:StationButtonTemplateReqMessage set max presentation
to 2
*Apr 5 02:50:12.098: ephone-30[2]:CheckAutoReg
*Apr 5 02:50:12.102: ephone-30[2]:AutoReg is disabled
*Apr 5 02:50:12.102: ephone-30[2][ATA000FF758E70E]:Setting 1 lines 4 speed-dials on phone
(max_line 2)
*Apr 5 02:50:12.102: ephone-30[2]:First Speed Dial Button location is 2 (0)
*Apr 5 02:50:12.102: ephone-30[2]:Configured 4 speed dial buttons
*Apr 5 02:50:12.102: ephone-30[2]:ButtonTemplate lines=1 speed=4 buttons=5 offset=0
*Apr 5 02:50:12.102: ephone-30[2]:Skinny IP port 16384 set for socket [2]
*Apr 5 02:50:12.126: ephone-30[2]:StationSoftKeyTemplateReqMessage
*Apr 5 02:50:12.126: ephone-30[2]:StationSoftKeyTemplateResMessage
*Apr 5 02:50:12.206: ephone-30[2]:StationSoftKeySetReqMessage
*Apr 5 02:50:12.206: ephone-30[2]:StationSoftKeySetResMessage
*Apr 5 02:50:12.307: ephone-30[2]:StationLineStatReqMessage from ephone line 1
Cisco Unified Communications Manager Express System Administrator Guide
202 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
*Apr 5 02:50:12.307: ephone-30[2]:StationLineStatReqMessage ephone line 1 DN 80 = 8080
desc = 8080 label =
*Apr 5 02:50:12.307: ephone-30[2][ATA000FF758E70E]:StationLineStatResMessage sent to
ephone (1 of 2)
*Apr 5 02:50:12.427: ephone-30[2]:StationSpeedDialStatReqMessage speed 9
*Apr 5 02:50:12.427: ephone-30[2]:No speed-dial set 9
*Apr 5 02:50:12.427: ephone-30[2]:StationSpeedDialStatMessage sent
*Apr 5 02:50:12.547: ephone-30[2]:StationSpeedDialStatReqMessage speed 8
*Apr 5 02:50:12.547: ephone-30[2]:No speed-dial set 8
*Apr 5 02:50:12.547: ephone-30[2]:StationSpeedDialStatMessage sent
*Apr 5 02:50:12.635: ephone-30[2]:StationSpeedDialStatReqMessage speed 7
*Apr 5 02:50:12.635: ephone-30[2]:No speed-dial set 7
*Apr 5 02:50:12.635: ephone-30[2]:StationSpeedDialStatMessage sent
*Apr 5 02:50:12.707: New Skinny socket accepted [1] (34 active)
*Apr 5 02:50:12.707: sin_family 2, sin_port 15400, in_addr 1.4.188.72
*Apr 5 02:50:12.711: skinny_add_socket 1 1.4.188.72 15400
*Apr 5 02:50:12.711: ephone-30[2]:StationSpeedDialStatReqMessage speed 6
*Apr 5 02:50:12.711: ephone-30[2]:No speed-dial set 6
*Apr 5 02:50:12.715: ephone-30[2]:StationSpeedDialStatMessage sent
21:21:50: %IPPHONE-6-REG_ALARM: Name=ATA0FF758E70E01 Load=ATA030203SCCP051201A.zup
Last=Initialized
*Apr 5 02:50:12.715:
Skinny StationAlarmMessage on socket [3] 1.4.188.72 ATA000FF758E70E
*Apr 5 02:50:12.715: severityInformational p1=0 [0x0] p2=0 [0x0]
*Apr 5 02:50:12.715: Name=ATA0FF758E70E01 Load=ATA030203SCCP051201A.zup Last=Initialized
*Apr 5 02:50:12.811: ephone-30[2]:StationSpeedDialStatReqMessage speed 5
*Apr 5 02:50:12.811: ephone-30[2]:No speed-dial set 5
*Apr 5 02:50:12.811: ephone-30[2]:StationSpeedDialStatMessage sent
21:21:50: %IPPHONE-6-REGISTER: ephone-31:ATA0FF758E70E01 IP:1.4.188.72 Socket:3
DeviceType:Phone has registered.
*Apr 5 02:50:12.908: ephone-30[2]:StationSpeedDialStatReqMessage speed 4
*Apr 5 02:50:12.908: ephone-30[2]:No speed-dial set 4
*Apr 5 02:50:12.908: ephone-30[2]:StationSpeedDialStatMessage sent
*Apr 5 02:50:13.008: ephone-30[2]:StationSpeedDialStatReqMessage speed 3
*Apr 5 02:50:13.008: ephone-30[2]:No speed-dial set 3
*Apr 5 02:50:13.008: ephone-30[2]:StationSpeedDialStatMessage sent
*Apr 5 02:50:13.108: ephone-30[2]:StationSpeedDialStatReqMessage speed 2
*Apr 5 02:50:13.108: ephone-30[2]:No speed-dial set 2
*Apr 5 02:50:13.108: ephone-30[2]:StationSpeedDialStatMessage sent
*Apr 5 02:50:13.208: ephone-30[2]:StationSpeedDialStatReqMessage speed 1
*Apr 5 02:50:13.208: ephone-30[2]:No speed-dial set 1
*Apr 5 02:50:13.208: ephone-30[2]:StationSpeedDialStatMessage sent
*Apr 5 02:50:14.626: New Skinny socket accepted [1] (33 active)
*Apr 5 02:50:14.626: sin_family 2, sin_port 15593, in_addr 1.4.188.72
*Apr 5 02:50:14.630: skinny_add_socket 1 1.4.188.72 15593
*Apr 5 02:50:15.628: New Skinny socket accepted [1] (34 active)
*Apr 5 02:50:15.628: sin_family 2, sin_port 15693, in_addr 1.4.188.72
*Apr 5 02:50:15.628: skinny_add_socket 1 1.4.188.72 15693
*Apr 5 02:50:21.538: ephone-30[2]:SkinnyCompleteRegistration
Using Call Pickup and Group Call Pickup with Cisco ATA
Most of the procedures for using Cisco ATAs with Cisco Unified CME are the same as those for using
Cisco ATAs with Cisco Unified Communications Manager, as described in the “How to Use Pre-Call
and Mid-Call Services” chapter of the Cisco ATA 186 and Cisco ATA 188 Analog Telephone Adaptor
Administrator’s Guide for SCCP (version 3.0). However, the call pickup and group call pickup
procedures are different when using Cisco ATAs with Cisco Unified CME, as described below:
Call Pickup
When using Cisco ATAs with Cisco Unified CME:
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 203
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
• To pickup the last parked call, press **3*.
• To pickup a call on a specific extension, press **3 and enter the extension number.
• To pickup a call from a park slot, press **3 and enter the park slot number.
Group Call Pickup
When using Cisco ATAs with Cisco Unified CME:
• To answer a phone within your call pickup group, press **4*.
• To answer a phone outside of your call pickup group, press **4 and the group ID number.
Note If there is only one pickup group, you do not need to enter the group ID after the **4 to pickup a call.
SCCP: Enabling Auto-Configuration for Cisco VG202, VG204, and VG224
To use the Autoconfiguration feature for voice gateways, perform the following steps on the
Cisco Unified CME router.
Prerequisites
• Cisco Unified CME 7.1 or a later version. The Cisco Unified CME router must be configured and
running before you boot the analog voice gateway. See the “SCCP: Setting Up Cisco Unified CME”
section on page 114.
• Default location of configuration files is system:/its/. To define an alternate location at which to save
the gateway configuration files, see the “SCCP: Defining Per-Phone Configuration Files and
Alternate Location” section on page 119.
• To automatically assign the next available directory number to the voice port as it registers to
Cisco Unified CME, and create an ephone entry associated with each voice port, enable the
auto assign command in Cisco Unified CME.
Restrictions
• Supported only for the Cisco VG202, VG204, and VG224 voice gateways.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice-gateway system tag
4. mac-address mac-address
5. type {vg202 | vg204 | vg224}
6. voice-port port-range
7. network-locale locale-code
8. create cnf-file
Cisco Unified Communications Manager Express System Administrator Guide
204 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
9. reset
or
restart
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice-gateway system tag Enters voice gateway configuration mode and creates a
voice gateway configuration.
Example:
Router(config)# voice-gateway system 1
Step 4 mac-address mac-address Defines the MAC address of the voice gateway to
autoconfigure.
Example:
Router(config-voice-gateway)# mac-address
Step 5 type {vg202 | vg204 | vg224} Defines the type of voice gateway to autoconfigure.
Example:
Router(config-voice-gateway)# type vg224
Step 6 voice-port port-range Identifies the ports on the voice gateway that register to
Cisco Unified CME.
Example:
Router(config-voice-gateway)# voice-port 0-23
Step 7 network-locale locale-code Selects a geographically specific set of tones and cadences
for the voice gateway’s analog endpoints that register to
Cisco Unified CME.
Example:
Router(config-voice-gateway)# network-locale FR
Step 8 create cnf-files Generates the XML configuration files that are required for
the voice gateway to autoconfigure its analog ports that
register to Cisco Unified CME.
Example:
Router(config-voice-gateway)# create cnf-files
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 205
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
Command or Action Purpose
Step 9 reset (Optional) Performs a complete reboot of all analog phones
or associated with the voice gateway and registered to
restart Cisco Unified CME.
or
Example: (Optional) Performs a fast restart of all analog phones
Router(config-voice-gateway)# reset associated with the voice gateway, after simple changes to
or buttons, lines, or speed-dial numbers.
Router(config-voice-gateway)# restart
• Use these commands to download new configuration
files to the analog phones after making configuration
changes to the phones in Cisco Unified CME.
Step 10 end Exits to privileged EXEC mode.
Example:
Router(config-voice-gateway)# end
Examples
The following example shows the voice gateway configuration in Cisco Unified CME:
voice-gateway system 1
network-locale FR
type VG224
mac-address 001F.A30F.8331
voice-port 0-23
create cnf-files
What to Do Next
• Cisco VG202 or VG204 voice gateway—Enable the gateway for autoconfiguration. See the
“Auto-Configuration on the Cisco VG202 and Cisco VG204 Voice Gateways” section in the
Cisco VG202 and Cisco VG204 Voice Gateways Software Configuration Guide.
• Cisco VG224 analog phone gateway—Enable SCCP and the STC application on the gateway. See
the “Configuring FXS Ports for Basic Calls” chapter in the Supplementary Services Features for
FXS Ports on Cisco IOS Voice Gateways Configuration Guide.
SCCP: Configuring Phones on SCCP Controlled Analog (FXS) Ports
Configuring Cisco Unified CME to support calls and features on analog endpoints connected to SCCP
controlled analog (FXS) ports is basically the same as configuring any SCCP phone in
Cisco Unified CME. This section describes only the steps that have special meaning for phones
connected to a Cisco VG224 Analog Phone Gateway.
Prerequisites
• For phones connected to analog FXS ports on the Cisco VG224 Analog Phone Gateway:
Cisco CME 3.2.2 or a later version.
Cisco Unified Communications Manager Express System Administrator Guide
206 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
• For phones connected to analog FXS ports on the Cisco Integrated Services Routers (ISR) voice
gateway: Cisco Unified CME 4.0 or a later version.
• Cisco ISR voice gateway or Cisco VG224 analog phone gateway is installed and configured for
operation. For information, see the appropriate Cisco configuration documentation.
• Prior to Cisco IOS Release 12.4(11)T, set the timeouts ringing command to infinity for all
SCCP-controlled analog ports. In Cisco IOS Release 12.4(11)T and later, the default for this
command is infinity.
• SCCP is enabled on the Cisco IOS voice gateway. For configuration information, see the SCCP
Controlled Analog (FXS) Ports with Supplementary Features in Cisco IOS Gateways document.
Restrictions
• FXS ports on Cisco VG 248 analog phone gateways are not supported by Cisco Unified CME.
SUMMARY STEPS
1. Set up ephone-dns for up to 24 analog endpoints on the Cisco IOS gateway.
2. Set the maximum number of ephones.
3. Assign ephone-dns to ephones.
4. Set up feature parameters as desired.
5. Set up feature restrictions as desired.
DETAILED STEPS
Step 1 Set up ephone-dns for up to 24 endpoints on the Cisco IOS gateway.
Use the ephone-dn command:
ephone-dn 1 dual-line
number 1000
.
.
.
ephone-dn 24 dual-line
number 1024
Step 2 Set the maximum number of ephones.
Use the max ephones command to set a number equal to or greater than the total number of endpoints
that you intend to register on the Cisco Unified CME router, including both IP and analog endpoints. For
example, if you have 6 IP phones and 12 analog phones, set the max ephones command to 18 or greater.
Step 3 Assign ephone-dns to ephones.
Use the auto assign command to enable the automatic assignment of an available ephone-dn to each
phone as the phone contacts the Cisco Unified CME router to register. Note that the order of ephone-dn
assignment is not guaranteed. For example, if you have analog endpoints on ports 2/0 through 2/23 on
the Cisco IOS gateway, port 2/0 does not necessarily become ephone 1. Use one of the following
commands to enable automatic ephone-dn assignment.
• auto assign 1 to 24—You do not need to use the type keyword if you have only analog endpoints
to be assigned or if you want all endpoints to be automatically assigned.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 207
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
• auto assign 1 to 24 type anl—Use the type keyword if you have other phone types in the system
and you want only the analog endpoints to be assigned to ephone-dns automatically.
An alternative to using the auto assign command is to manually assign ephone-dns to ephones (analog
phones on FXS ports). This method is more complicated, but you might need to use it if you want to
assign a specific extension number (ephone-dn) to a particular ephone. The reason that manual
assignment is more complicated is because a unique device ID is required for each registering ephone
and analog phones do not have unique MAC addresses like IP phones do. To create unique device IDs
for analog phones, the auto assign process uses a particular algorithm. When you make manual ephone
assignments, you have to use the same algorithm for each phone that receives a manual assignment.
The algorithm uses the single 12-digit SCCP local interface MAC address on the Cisco IOS gateway as
the base to create unique 12-digit device IDs for all the FXS ports on the Cisco IOS gateway. The
rightmost 9 digits of the SCCP local interface MAC address are shifted left three places and are used as
the leftmost 9 digits for all 24 individual device IDs. The remaining 3 digits are the hexadecimal
translation of the binary representation of the port’s slot number (3 digits), subunit number (2 digits),
and port number (7 digits). The following example shows the use of the algorithm to create a unique
device ID for one port:
a. The MAC address for the Cisco VG224 SCCP local interface is 000C.8638.5EA6.
b. The FXS port has a slot number of 2 (010), a subunit number of 0 (00), and a port number of 1
(0000001). The binary digits are strung together to become 0100 0000 0001, which is then
translated to 401 in hexadecimal to create the final device ID for the port and ephone.
c. The resulting unique device ID for this port is C863.85EA.6401.
When manually setting up an ephone configuration for an analog port, assign it just one button because
the port represents a single-line device. The button command can use the “:” (colon, for normal), “o”
(overlay) and “c” (call-waiting overlay) modes.
Note Once you have assigned ephone-dns to all the ephones that you want to assign manually, you can use the
auto assign command to automatically assign the remaining ports.
Step 4 Set up feature parameters as desired. The following list includes commonly configured features. For
information about supported features, see the SCCP Controlled Analog (FXS) Ports with Supplementary
Features in Cisco IOS Gateways document.
• Call transfer—To use call transfer from analog endpoints, the transfer-system command must be
configured for full-blind or full-consult in telephony-service configuration mode on the
Cisco Unified CME router. This is the recommended setting for Cisco CME 3.0 and later versions,
but it is not the default.
• Call forwarding—Call forwarding destinations are specified for all, busy, and no-answer conditions
for each ephone-dn using the call-forward all, call-forward busy, and call-forward noan
commands in ephone-dn configuration mode.
• Call park—Call-park slots are created using the park-slot command in ephone-dn configuration
mode. Phone users must be instructed how to transfer calls to the call-park slots and use directed
pickup to retrieve the calls.
• Call pickup groups—Extensions are added to pickup groups using the pickup-group command in
ephone-dn configuration mode. Phone users must be told which phones are in which groups.
• Caller ID—Caller names are defined using the name command in ephone-dn configuration mode.
Caller numbers are defined using the number command in ephone-dn configuration mode.
• Speed dial—Numbers to be speed-dialed are stored with their associated speed-dial codes using the
speed-dial command in ephone configuration mode.
Cisco Unified Communications Manager Express System Administrator Guide
208 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
• Speed dial to voice mail—The voice-mail number is defined using the voicemail command in
telephony-service configuration mode.
Step 5 Set up feature restrictions as desired.
Features such as transfer, conference, park, pickup, group pickup (gpickup), and call forward all
(cfwdall) can be restricted from individual ephones using the appropriate Cisco Unified CME softkey
template command, even though analog phones do not have soft keys. Simply create a template that
leaves out the soft key that represents the feature you want to restrict and apply the template to the
ephone for which you want the feature restricted. For more information about soft-key template
customization, see “Customizing Soft Keys” on page 1047.
What to Do Next
• If you have SIP and SCCP phones connected to the same Cisco Unified CME, see the “Configuring
Codecs of Individual Phones for Calls Between Local Phones” section on page 184.
• To select a fixed-button layout for a Cisco Unified IP Phone 7931G, see “SCCP: Selecting Button
Layout for a Cisco Unified IP Phone 7931G” on page 1106.
• After configuring phones in Cisco Unified CME to make basic calls, you are ready to generate
configuration files for the phones to be connected. See “SCCP: Generating Configuration Files for
SCCP Phones” on page 263.
SCCP: Verifying Analog Phone Support
Use the following show commands to display information about analog endpoints.
• show ephone anl—Displays MAC address, registration status, ephone-dn, and speed-dial numbers
for analog ephones.
• show telephony-service ephone-dn—Displays call forward, call waiting, pickup group, and more
information about ephone-dns.
• show running-config—Displays running configuration nondefault values.
SCCP: Enabling a Remote Phone
To enable IP phones or instances of Cisco IP Communicator to connect to a Cisco Unified CME system
over a WAN, perform the following steps.
Prerequisites
• The WAN link supporting remote teleworker phones should be configured with a Call Admission
Control (CAC) or Resource Reservation Protocol (RSVP) solution to prevent the oversubscription
of bandwidth, which can degrade the quality of all voice calls.
• If DSP farms will be used for transcoding, you must configure them separately. See “Configuring
Transcoding Resources” on page 329.
• A SCCP phone to be enabled as a remote phone is configured in Cisco Unified CME. For
configuration information, see the “SCCP: Creating Directory Numbers” section on page 158
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 209
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
Restrictions
• Because Cisco Unified CME is not designed for centralized call processing, remote phones are
supported only for fixed teleworker applications, such as working from a home office.
• Cisco Unified CME does not support CAC for remote SCCP phones, so voice quality can degrade
if a WAN link is oversubscribed. High-bandwidth data applications used over a WAN can cause
degradation of voice quality for remote IP phones.
• Cisco Unified CME does not support Emergency 911 (E911) calls from remote IP phones.
Teleworkers using remote phones connected to Cisco Unified CME over a WAN should be advised
not to use these phones for E911 emergency services because the local public safety answering point
(PSAP) will not be able to obtain valid calling-party information from them.
We recommend that you make all remote phone users aware of this issue. One way is to place a label
on all remote teleworker phones that reminds users not to place 911 emergency calls on remote IP
phones. Remote workers should place any emergency calls through locally configured hotel, office,
or home phones (normal land-line phones) whenever possible. Inform remote workers that if they
must use remote IP phones for emergency calls, they should be prepared to provide specific location
information to the answering PSAP personnel, including street address, city, state, and country.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. mtp
5. codec {g711ulaw | g722r64 | g729r8 [dspfarm-assist]}
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies
Example: this ephone during configuration tasks.
Router(config)# ephone 36
Step 4 mtp Sends media packets to the Cisco Unified CME router.
Example:
Router(config-ephone)# mtp
Cisco Unified Communications Manager Express System Administrator Guide
210 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
Command or Action Purpose
Step 5 codec {g711ulaw | g722r64 | g729r8 (Optional) Selects a preferred codec for setting up calls.
[dspfarm-assist]}
• Default: G.711 mu-law codec.
• The g722r64 keyword requires Cisco Unified CME 4.3
Example:
Router(config-ephone)# codec g729r8
and later versions.
dspfarm-assist • dspfarm-assist—Attempts to use DSP-farm resources
for transcoding the segment between the phone and the
Cisco Unified CME router if G.711 is negotiated for
the call.
Note The dspfarm-assist keyword is ignored if the SCCP
endpoint type is ATA, VG224, or VG248.
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
What to Do Next
• If you have SIP and SCCP phones connected to the same Cisco Unified CME, see the “Configuring
Codecs of Individual Phones for Calls Between Local Phones” section on page 184.
• To select a fixed-button layout for a Cisco Unified IP Phone 7931G, see “SCCP: Selecting Button
Layout for a Cisco Unified IP Phone 7931G” on page 1106.
• After configuring phones in Cisco Unified CME to make basic calls, you are ready to generate
configuration files for the phones to be connected. See “SCCP: Generating Configuration Files for
SCCP Phones” on page 263.
SCCP: Verifying Remote Phones
Step 1 Use the show running-config command or the show telephony-service ephone command to verify
parameter settings for remote ephones.
SCCP: Configuring Cisco IP Communicator Support
To enable support for Cisco IP Communicator, perform the following steps.
Prerequisites
• Cisco Unified CME 4.0 or a later version.
• IP address of the Cisco Unified CME TFTP server.
• PC for Cisco IP Communicator is installed. For hardware and platform requirements, see the
appropriate Cisco IP Communicator User Guide.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 211
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
• Audio devices, such as headset and handsets for users, are installed. You can install audio devices
any time, but the ideal time to do this is before you install and launch Cisco IP Communicator.
• Directory numbers and ephone configuration for Cisco IP Communicator are configured in
Cisco Unified CME. For information, see the “How to Configure Phones for a PBX System” section
on page 158.
SUMMARY STEPS
1. Download software.
2. Install and launch Cisco IP Communicator.
3. Perform registration and configuration tasks on the Cisco IP Communicator interface, including:
a. Configure IP address of the Cisco Unified CME TFTP server.
b. Disable the Optimize for low bandwidth parameter.
4. Wait for the Cisco IP Communicator to register.
5. Test the Cisco IP Communicator.
DETAILED STEPS
Step 1 Download the Cisco IP Communicator 2.0 or a later version software or a later version from the software
download site at http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp.
Step 2 Install the software on your PC, then launch the Cisco IP Communicator application. For information,
see the “Installing and Launching Cisco IP Communicator” section in the appropriate Cisco IP
Communicator User Guide.
Step 3 Complete configuration and registration tasks on the Cisco IP Communicator as required, including the
following:
a. Specify the IP address of the Cisco Unified CME TFTP server.
– Right-click on the Cisco IP Communicator interface, then choose Preferences >Network > Use
these TFTP servers.
– Enter the IP address of the Cisco Unified CME TFTP server in the field.
b. Disable the Optimize for low bandwidth parameter to ensure that Cisco IP Communicator sends
voice packets for all calls.
Note The following steps are required to enable the Cisco IP Communicator to support the G.711 codec,
which is the fallback codec for Cisco Unified CME. You can compensate for disabling the optimization
parameter by using the codec command in ephone configuration mode to configure G.729 or another
advanced codec as the preferred codec for the Cisco IP Communicator. This helps to ensure that the
codec for a VoIP (e.g. SIP or H.323) dial-peer is supported by the Cisco IP Communicator and can
prevent audio problems caused by insufficient bandwidth.
– Right-click on the Cisco IP Communicator interface and choose Preferences > Audio.
– Uncheck the checkbox next to Optimize for low bandwidth.
Step 4 Wait for the Cisco IP Communicator application to connect and register to Cisco Unified CME.
Cisco Unified Communications Manager Express System Administrator Guide
212 OL-10663-02
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
Step 5 Test the Cisco IP Communicator. For information, see the “SCCP: Verifying Cisco IP Communicator
Support” section on page 213.
SCCP: Verifying Cisco IP Communicator Support
Step 1 Use the show running-config command to display ephone-dn and ephone information associated with
this phone.
Step 2 After Cisco IP Communicator registers with Cisco Unified CME, it displays the phone extensions and
soft keys in its configuration. Verify that these are correct.
Step 3 Make a local call from the phone and have someone call you. Verify that you have a two-way voice path.
SCCP: Troubleshooting Cisco IP Communicator Support
Step 1 Use the debug ephone detail command to diagnose problems with calls. For more information, see the
Cisco Unified CME Command Reference.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 213
Configuring Phones to Make Basic Calls
How to Configure Cisco ATA, Analog Phone Support, Remote Phones, Cisco IP Communicator, and Secure IP Phone
SCCP: Configuring Secure IP Phone (IP-STE)
To configure an IP-STE phone on Cisco Unified CME, perform the following steps.
Prerequisites
• Cisco Unified CME 8.0 or a later version.
Restrictions
• Detection or conversion between Network Transmission Equipment (NTE) and Session Signaling
Event (SSE) is not supported.
• Transcoding or trans-compress rate support for different Voice Band Data (VBD) and Modem Relay
(MR) media type is not supported.
• IP-STE supports only single-line calls, dual-line and octo-line calls are not supported.
• Speed-dial can only be configured manually on the IP-STE.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. mac-address [mac-address]
5. type ip-ste
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies
Example: this ephone during configuration tasks. The maximum
Router(config)# ephone 6 number of ephones is version and platform-specific.
Type? to display range.
Cisco Unified Communications Manager Express System Administrator Guide
214 OL-10663-02
Configuring Phones to Make Basic Calls
Configuration Examples for Making Basic Calls
Command or Action Purpose
Step 4 mac-address [mac-address] Specifies the MAC address of the IP phone that is being
configured.
Example:
Router(config-ephone)# mac-address 2946.3f2.311
Step 5 type ip-ste Specifies the type of phone.
Example:
Router(config-ephone)# type ip-ste
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Configuration Examples for Making Basic Calls
This section contains the following examples of the required Cisco Unified CME configurations with
some of the additional options that are discussed in other modules.
• Configuring SCCP Phones for Making Basic Calls: Example, page 216
• Configuring SIP Phones for Making Basic Calls: Example, page 220
• Disabling a Bulk Registration for a SIP Phone: Example, page 223
• Cisco ATA: Example, page 223
• SCCP Analog Phone: Example, page 223
• Remote Teleworker Phones: Example, page 224
• Secure IP Phone (IP-STE): Example, page 225
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 215
Configuring Phones to Make Basic Calls
Configuration Examples for Making Basic Calls
Configuring SCCP Phones for Making Basic Calls: Example
Router# show running-config
version 12.4
service tcp-keepalives-in
service tcp-keepalives-out
service timestamps debug datetime msec
service timestamps log datetime msec
no service password-encryption
!
hostname CME40
!
boot-start-marker
boot-end-marker
!
logging buffered 2000000 debugging
!
no aaa new-model
!
resource policy
!
clock timezone PST -8
clock summer-time PDT recurring
no network-clock-participate slot 2
voice-card 0
no dspfarm
dsp services dspfarm
!
voice-card 2
dspfarm
!
no ip source-route
ip cef
!
!
!
ip domain name cisco.com
ip multicast-routing
!
!
ftp-server enable
ftp-server topdir flash:
isdn switch-type primary-5ess
!
!
!
voice service voip
allow-connections h323 to sip
allow-connections sip to h323
no supplementary-service h450.2
no supplementary-service h450.3
h323
call start slow
!
!
!
controller T1 2/0/0
framing esf
linecode b8zs
pri-group timeslots 1-24
!
controller T1 2/0/1
Cisco Unified Communications Manager Express System Administrator Guide
216 OL-10663-02
Configuring Phones to Make Basic Calls
Configuration Examples for Making Basic Calls
framing esf
linecode b8zs
!
!
interface GigabitEthernet0/0
ip address 192.168.1.1 255.255.255.0
ip pim dense-mode
duplex auto
speed auto
media-type rj45
negotiation auto
!
interface Service-Engine1/0
ip unnumbered GigabitEthernet0/0
service-module ip address 192.168.1.2 255.255.255.0
service-module ip default-gateway 192.168.1.1
!
interface Serial2/0/0:23
no ip address
encapsulation hdlc
isdn switch-type primary-5ess
isdn incoming-voice voice
isdn map address ^.* plan unknown type international
no cdp enable
!
!
ip route 0.0.0.0 0.0.0.0 192.168.1.254
ip route 192.168.1.2 255.255.255.255 Service-Engine1/0
ip route 192.168.2.253 255.255.255.255 10.2.0.1
ip route 192.168.3.254 255.255.255.255 10.2.0.1
!
!
ip http server
ip http authentication local
no ip http secure-server
ip http path flash:
!
!
!
!
tftp-server flash:P00307020300.loads
tftp-server flash:P00307020300.sb2
tftp-server flash:P00307020300.sbn
!
control-plane
!
!
!
voice-port 2/0/0:23
!
!
!
sccp local GigabitEthernet0/0
sccp ccm 192.168.1.1 identifier 1
sccp
!
sccp ccm group 1
associate ccm 1 priority 1
associate profile 1 register MTP0013c49a0cd0
keepalive retries 5
!
dspfarm profile 1 transcode
codec g711ulaw
codec g711alaw
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 217
Configuring Phones to Make Basic Calls
Configuration Examples for Making Basic Calls
codec g729ar8
codec g729abr8
codec gsmfr
codec g729r8
maximum sessions 90
associate application SCCP
!
!
dial-peer voice 9000 voip
mailbox-selection last-redirect-num
destination-pattern 78..
session protocol sipv2
session target ipv4:192.168.1.2
dtmf-relay sip-notify
codec g711ulaw
no vad
!
dial-peer voice 2 pots
incoming called-number .
direct-inward-dial
port 2/0/0:23
forward-digits all
!
dial-peer voice 1 pots
destination-pattern 9[2-9]......
port 2/0/0:23
forward-digits 8
!
dial-peer voice 3 pots
destination-pattern 91[2-9]..[2-9]......
port 2/0/0:23
forward-digits 12!
!
gateway
timer receive-rtp 1200
!
!
telephony-service
load 7960-7940 P00307020300
max-ephones 100
max-dn 300
ip source-address 192.168.1.1 port 2000
system message CCME 4.0
sdspfarm units 1
sdspfarm transcode sessions 128
sdspfarm tag 1 MTP0013c49a0cd0
voicemail 7800
max-conferences 24 gain -6
call-forward pattern .T
moh music-on-hold.au
multicast moh 239.1.1.1 port 2000
web admin system name admin password sjdfg
transfer-system full-consult
transfer-pattern .T
secondary-dialtone 9
create cnf-files version-stamp Jan 01 2002 00:00:00
!
!
ephone-dn-template 1
!
!
ephone-template 1
keep-conference endcall local-only
codec g729r8 dspfarm-assist
Cisco Unified Communications Manager Express System Administrator Guide
218 OL-10663-02
Configuring Phones to Make Basic Calls
Configuration Examples for Making Basic Calls
!
!
ephone-template 2
!
!
ephone-dn 1
number 6001
call-forward busy 7800
call-forward noan 7800 timeout 10
!
!
ephone-dn 2
number 6002
call-forward busy 7800
call-forward noan 7800 timeout 10
!
!
ephone-dn 10
number 6013
paging ip 239.1.1.1 port 2000
!
!
ephone-dn 20
number 8000....
mwi on
!
!
ephone-dn 21
number 8001....
mwi off
!
!
!
!
ephone 1
device-security-mode none
username "user1"
mac-address 002D.264E.54FA
codec g729r8 dspfarm-assist
type 7970
button 1:1
!
!
!
ephone 2
device-security-mode none
username "user2"
mac-address 001C.821C.ED23
type 7960
button 1:2
!
!
!
line con 0
stopbits 1
line aux 0
stopbits 1
line 66
no activation-character
no exec
transport preferred none
transport input all
transport output all
line 258
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 219
Configuring Phones to Make Basic Calls
Configuration Examples for Making Basic Calls
no activation-character
no exec
transport preferred none
transport input all
transport output all
line vty 0 4
exec-timeout 0 0
privilege level 15
password sgpxw
login
!
scheduler allocate 20000 1000
ntp server 192.168.224.18
!
!
end
Configuring SIP Phones for Making Basic Calls: Example
The following is a configuration example for SIP phones running on Cisco Unified CME:
voice service voip
allow-connections sip to sip
sip
registrar server expires max 600 min 60
!
voice class codec 1
codec preference 1 g711ulaw
!
voice hunt-group 1 parallel
final 8000
list 2000,1000,2101
timeout 20
pilot 9000
!
voice hunt-group 2 sequential
final 1000
list 2000,2300
timeout 25
pilot 9100 secondary 9200
!
voice hunt-group 3 peer
final 2300
list 2100,2200,2101,2201
timeout 15
hops 3
pilot 9300
preference 5
!
voice hunt-group 4 longest-idle
final 2000
list 2300,2100,2201,2101,2200
timeout 15
hops 5
pilot 9400 secondary 9444
preference 5 secondary 9
!
voice register global
mode cme
!
external-ring bellcore-dr3
!
Cisco Unified Communications Manager Express System Administrator Guide
220 OL-10663-02
Configuring Phones to Make Basic Calls
Configuration Examples for Making Basic Calls
voice register dn 1
number 2300
mwi
!
voice register dn 2
number 2200
call-forward b2bua all 1000
call-forward b2bua mailbox 2200
mwi
!
voice register dn 3
number 2201
after-hour exempt
!
voice register dn 4
number 2100
call-forward b2bua busy 2000
mwi
voice register dn 5
number 2101
mwi
voice register dn 76
number 2525
call-forward b2bua unreachable 2300
mwi
!
voice register template 1
!
voice register template 2
no conference enable
voicemail 7788 timeout 5
!
voice register pool 1
id mac 000D.ED22.EDFE
type 7960
number 1 dn 1
template 1
preference 1
no call-waiting
codec g711alaw
!
voice register pool 2
id mac 000D.ED23.CBA0
type 7960
number 1 dn 2
number 2 dn 2
template 1
preference 1
!
dtmf-relay rtp-nte
speed-dial 3 2001
speed-dial 4 2201
!
voice register pool 3
id mac 0030.94C3.053E
type 7960
number 1 dn 3
number 3 dn 3
template 2
!
voice register pool 5
id mac 0012.019B.3FD8
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 221
Configuring Phones to Make Basic Calls
Configuration Examples for Making Basic Calls
type ATA
number 1 dn 5
preference 1
dtmf-relay rtp-nte
codec g711alaw
!
voice register pool 6
id mac 0012.019B.3E88
type ATA
number 1 dn 6
number 2 dn 7
template 2
dtmf-relay-rtp-nte
call-forward b2bua all 7778
!
voice register pool 7
!
voice register pool 8
id mac 0006.D737.CC42
type 7940
number 1 dn 8
template 2
preference 1
codec g711alaw
!
voice-port 1/0/0
!
voice-port 1/0/1
!
dial-peer voice 100 pots
destination-pattern 2000
port 1/0/0
!
dial-peer voice 101 pots
destination-pattern 2010
port 1/0/1
!
dial-peer voice 1001 voip
preference 1
destination-pattern 1...
session protocol sipv2
session target ipv4:10.15.6.13
codec g711ulaw
!
sip-ua
mwi-server ipv4:1.15.6.200 expires 3600 port 5060 transport udp
!
telephony-service
load 7960-7940 P0S3-07-2-00
max-ephones 24
max-dn 96
ip source-address 10.15.6.112 port 2000
create cnf-files version-stamp Aug 24 2004 00:00:00
max-conferences 8
after-hours block pattern 1 1...
after-hours day Mon 17:00 07:00
Cisco Unified Communications Manager Express System Administrator Guide
222 OL-10663-02
Configuring Phones to Make Basic Calls
Configuration Examples for Making Basic Calls
Disabling a Bulk Registration for a SIP Phone: Example
The following example shows the configuration for all phone numbers that match the pattern “408555..”
can register with the SIP proxy server (IP address 1.5.49.240) except directory number 1, number
“4085550101,” for which bulk registration is disabled
voice register global
mode cme
bulk 408555….
!
voice register dn 1
number 4085550101
no-reg
sip-ua
registrar ipv4:1.5.49.240
Cisco ATA: Example
The following example shows the configuration for two analog phones using a single Cisco ATA with
MAC address 000F.F758.E70E. The analog phone attached to the first port uses the MAC address of the
Cisco ATA. The analog phone attached to the second port uses a modified version of the Cisco ATA’s
MAC address; the first two hexadecimal numbers are removed and 01 is appended to the end.
telephony-service
conference hardware
load ATA ATA030203SCCP051201A.zup
!
ephone-dn 80 dual-line
number 8080
!
ephone-dn 81 dual-line
number 8081
!
ephone 30
mac-address 000F.F758.E70E
type ata
button 1:80
!
ephone 31
mac-address 0FF7.58E7.0E01
type ata
button 1:81
SCCP Analog Phone: Example
The following excerpt from a Cisco Unified CME configuration sets transfer type to full-blind and sets
the voice-mail extension to 5200. Ephone-dn 10 has the extension 4443 and is assigned to Tommy; that
number and name will be used for caller-ID displays. The description field under ephone-dn is used to
indicate that this ephone-dn is on the Cisco VG224 voice gateway at port 1/3. Extension 4443 is assigned
to ephone 7, which is an analog phone type with 10 speed-dial numbers.
CME_Router# show running-config
.
.
.
telephony-service
load 7910 P00403020214
load 7960-7940 P00305000301
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 223
Configuring Phones to Make Basic Calls
Configuration Examples for Making Basic Calls
load 7905 CP79050101SCCP030530B31
max-ephones 60
max-dn 60
ip source-address 10.8.1.2 port 2000
auto assign 1 to 60
create cnf-files version-stamp 7960 Sep 28 2004 17:23:02
voicemail 5200
mwi relay
mwi expires 99999
max-conferences 8 gain -6
web admin system name cisco password lab
web admin customer name ac2 password cisco
dn-webedit
time-webedit
transfer-system full-blind
transfer-pattern 6...
transfer-pattern 5...
!
!
ephone-dn 10 dual-line
number 4443 secondary 9191114443
pickup-group 5
description vg224-1/3
name tommy
!
ephone 7
mac-address C863.9018.0402
speed-dial 1 4445
speed-dial 2 4445
speed-dial 3 4442
speed-dial 4 4441
speed-dial 5 6666
speed-dial 6 1111
speed-dial 7 1112
speed-dial 8 9191114441
speed-dial 9 9191114442
speed-dial 10 9191114442
type anl
button 1:10
Remote Teleworker Phones: Example
The following example shows the configuration for ephone 270, a remote teleworker phone with its
codec set to G.729r8. The dspfarm-assist keyword is used to ensure that calls from this phone will use
DSP resources to maintain the G.729r8 codec when calls would normally be switched to a G.711 codec.
ephone 270
button 1:36
mtp
codec g729r8 dspfarm-assist
description teleworker remote phone
Cisco Unified Communications Manager Express System Administrator Guide
224 OL-10663-02
Configuring Phones to Make Basic Calls
Where to Go Next
Secure IP Phone (IP-STE): Example
The following example shows the configuration for Secure IP Phone IP-STE, The IP-STE is the phone
type required to configure a secure phone.
ephone-dn 1
number 3001
...
ephone 9
mac-address 0004.E2B9.1AD1
max-calls-per-button 1
type IP-STE
button 1:1 2:2 3:3 4:4
Where to Go Next
To select a fixed-button layout for a Cisco Unified IP Phone 7931G, see “SCCP: Selecting Button Layout
for a Cisco Unified IP Phone 7931G” on page 1106.
After configuring phones in Cisco Unified CME to make basic calls, you are ready to generate
configuration files for the phones to be connected to your router. See “Generating Configuration Files
for Phones” on page 261.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T command references
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 225
Configuring Phones to Make Basic Calls
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
226 OL-10663-02
Configuring Phones to Make Basic Calls
Feature Information for Configuring Phones to Make Basic Calls
Feature Information for Configuring Phones to Make Basic Calls
Caution The Interactive Voice Response (IVR) media prompts feature is only available on the IAD2435 when
running IOS version 15.0(1)M or later.
Table 14 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 14 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 14 Feature Information for Basic Call Features
Cisco Unified CME
Feature Name Versions Feature Information
Secure IP Phones 8.0 Adds support for Secure IP Phone (IP-STE).
SIP Shared Lines 7.1 Adds support for nonexclusive shared lines on SIP phones.
Autoconfiguration for Cisco VG202, Adds autoconfiguration for the Cisco VG202, VG204, and
VG204, and VG224 VG224 Analog Phone Gateway.
Ephone-Type Templates 7.0/4.3 Adds support for dynamically adding new phone types
without upgrading Cisco IOS software.
Octo-Line Directory Numbers Adds octo-line directory numbers that support up to eight
active calls.
G.722 and iLBC Transcoding and Support for the G.722-64K and iLBC codecs was added.
Conferencing Support in
Cisco Unified CME
Dial Plans for SIP Phones 4.1 Dial plans for SIP phones was added.
KPML KPML for SIP phones was added.
Session Transport Protocol Added selection for session-transport protocol for SIP
phones.
Watch Mode Provides Busy Lamp Field (BLF) notification on a line
button that is configured for watch mode on one phone for
all lines on another phone (watched phone) for which the
watched directory number is the primary line.
Remote Teleworker Phones 4.0 Support for teleworker remote phones was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 227
Configuring Phones to Make Basic Calls
Feature Information for Configuring Phones to Make Basic Calls
Table 14 Feature Information for Basic Call Features (continued)
Cisco Unified CME
Feature Name Versions Feature Information
Analog Phones 4.0 Support was introduced for analog phones with SCCP
supplementary features using FXS ports on
Cisco Integrated Services Routers.
3.2.1 Support was introduced for analog phones with SCCP
supplementary features using FXS ports on a Cisco VG224
voice gateway.
3.0 Support was introduced for Cisco ATA 186 and
Cisco ATA 188.
1.0 Support was introduced for analog phones in H.323 mode
using FXS ports.
Cisco IP Communicator 4.0 Support for Cisco IP Communicator was introduced.
Direct FXO Trunk Lines 4.0 Enhancements were added to improve the keyswitch
emulation behavior of PSTN lines in a Cisco Unified CME
system including the following:
• Status monitoring of the FXO port on the line button of
the IP phone.
• Transfer recall if a transfer-to phone does not answer
after a specified timeout.
• Transfer-to button optimization to free up the private
extension line on the transfer-to phone
• Directory numbers for FXO lines can be configured for
dual-line to support the FXO monitoring, transfer
recall, and transfer-to button optimization features.
3.2 Direct FXO trunk line capability was introduced.
SIP Phones 3.4 Added support for SIP phones connected to Cisco CME
system.
Monitor Mode for Shared Lines 3.0 Provides a visible line status indicating whether the line is
in-use or not.
Cisco Unified Communications Manager Express System Administrator Guide
228 OL-10663-02
Creating Phone Configurations Using Extension
Assigner
Last Updated: January 9, 2008
This chapter describes the Extension Assigner feature in Cisco Unified
Communications Manager Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support the feature documented in this module. For a list of
the versions in which this feature is supported, see the “Feature Information for Extension Assigner” section
on page 259.
Contents
• Prerequisites for Extension Assigner, page 229
• Restrictions for Extension Assigner, page 230
• Information About Extension Assigner, page 230
• SCCP: How to Configure Extension Assigner, page 235
• Configuration Examples for Extension Assigner, page 254
• Additional References, page 258
• Feature Information for Extension Assigner, page 259
Prerequisites for Extension Assigner
• Cisco Unified CME 4.0(3) or a later version.
• For Extension Assigner Synchronization, Cisco Unified CME 4.2(1) or a later version.
• The auto-register-phone command must be enabled (default).
• DHCP must be configured. For configuration information, see the “Defining Network Parameters”
section on page 75.
• You have a valid Cisco.com account.
• You have access to a TFTP server for downloading files.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 229
Creating Phone Configurations Using Extension Assigner
Restrictions for Extension Assigner
Restrictions for Extension Assigner
• The number of phones that you install cannot exceed the maximum number of phones supported by
the router chassis. To find the maximum number of phones for a particular router and
Cisco Unified CME version, see the appropriate Cisco Unified CME Supported Firmware,
Platforms, Memory, and Voice Products for your Cisco IOS release.
• This feature is not supported for SIP endpoints in Cisco Unified CME.
• For Extension Assigner Synchronization, automatic synchronization only applies to configuration
changes made by Cisco Unified CME Extension Assigner.
Information About Extension Assigner
To use extension assigner, you should understand the following concepts:
• Extension Assigner Overview, page 230
• Files Included in this Release, page 234
• Extension Assigner Synchronization, page 235
Extension Assigner Overview
This feature enables installation technicians to assign extension numbers to Cisco Unified CME phones
without administrative access to the server, typically during the installation of new phones or the
replacement of broken phones. However, before an installation technician can use this feature, the
system administrator must first configure Cisco Unified CME to allow specific extensions to be
assigned. The system administrator must also provide the installation technician with the information
necessary for assigning extension numbers to phones. The installation technician can then assign
extension numbers to phones with access to only the phones themselves and with no further intervention
from the administrator.
To configure this feature, tasks must be performed on the Cisco router by an administrator and onsite by
installation technicians. .
Procedures for System Administrators
Before an installation technician can assign new extension numbers to phones, you must complete the
following tasks:
1. Determine which extension numbers will be assigned to the new phones and plan your
configuration.
2. Download the appropriate Tcl script and associated audio prompt files and place them in the correct
directory.
3. Configure the Cisco Unified CME router to:
– Configure and load the appropriate Tcl script.
– Specify the extension that the installation technician calls to assign extension numbers.
– Optionally specify whether the extension used to assign extension numbers is dialed
automatically.
Cisco Unified Communications Manager Express System Administrator Guide
230 OL-10663-02
Creating Phone Configurations Using Extension Assigner
Information About Extension Assigner
– Specify the password that the installation technician enters to assign extension numbers.
– Configure the extension assigner feature.
– Configure ephone-dns with temporary extension numbers.
– Configure ephone-dns with the extension numbers that the installation technician can assign to
phones.
– Configure ephones with temporary MAC addresses for each phone that will be assigned an
extension number by the installation technician.
– Optionally configure the router to automatically save your configuration.
4. Provide the installation technician with the information needed to assign extension numbers to the
new phones.
Before you can configure this feature, you must understand how the extension assigner application
works and what information the installation technician needs to assign extension numbers to phones.
Other information you must provide to the installation technician involves the tasks that the installation
technician must perform. These tasks include:
• Dialing a configurable extension number to access the extension assigner application
• Entering a configurable password
• Entering a tag that identifies the extension number that will be assigned to the phone
Therefore, you must make the following decisions:
• Which extension number must be dialed to access the extension assigner application.
• Whether the number is dialed automatically when a phone goes off hook.
• What password the installation technician must enter to access the extension assigner application.
• What type of tag numbers to use to identify the extension number to assign to the phone.
• What specific tag numbers to use to identify the extension number to assign to the phone.
The first three decisions are straightforward, but the last two tag number decisions require some
knowledge of how the extension assigner feature works.
This feature is implemented using a Tcl script and audio files. To run this script, the installation
technician plugs in the phone, waits for a random extension number to be automatically assigned, and
dials a specified extension number.
After the phones have registered and received their temporary extension numbers, the installation
technician can access extension assigner and enter a tag number. This tag number is used to identify the
extension number and must match either an ephone tag or a similar new tag called the provision-tag.
You must decide on which tag you want to use before you configure your ephone and ephone-dn entries.
The advantage of using the provision-tag is that you can make it easier for the installation technician to
assign extension numbers because you can configure the tag to match the primary extension number or
some other unique identifier for the phone, such as a jack number.
The disadvantage is that you configure an additional keyword for each ephone entry, as shown in the
following example:
ephone 1
provision-tag 9001
mac-address 02EA.EAEA.0001
button 1:1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 231
Creating Phone Configurations Using Extension Assigner
Information About Extension Assigner
If you decide to use the ephone tag, it will require less configuration. However, the installation
technician will enter an arbitrary tag number instead of the actual extension number when configuring a
phone. This restriction is because the number of ephone tags that you can configure is limited by your
license. For example, if you use the ephone tag and you have a 100-user license, the installation
technician cannot enter 9001 for the tag because you can configure only ephone 1 to ephone 100.
Note that each ephone entry that you configure must also include a temporary MAC address. As shown
in the above example, this address should begin with 02EA.EAEA and can end with any unique number.
We strongly recommend that you can configure this unique number to match the ephone tag.
You do not have to configure any ephone entries for the extension number that are randomly assigned.
The autoassign feature automatically creates an ephone entry for each new phone when it registers. The
autoassign feature then automatically assigns an ephone-dn entry if there is an available ephone-dn that
has one of the tag numbers specified by the auto assign command. The resulting ephone configurations
have the actual MAC address of the phone and a button with the first available ephone-dn designated for
the autoassign feature.
As shown in the following example, you configure at least one ephone-dn for a temporary extension and
specify which ephone-dns the autoassign feature will assign to the temporary ephone entries:
telephony-service
auto assign 101 to 105
ephone-dn 101
number 0001
When the installation technician assigns an extension number to a phone, the temporary MAC address
is replaced by the actual MAC address and the ephone entry created by the autoregister feature is deleted.
The number of ephone-dns that you configure for the autoassign feature determines how many phones
you can plug in at one time and get an automatically assigned extension. If you define four ephone-dns
for autoassign and you plug in five phones, one phone will not get a temporary extension number until
you assign an extension to one of the other four phones and reset the fifth phone. You are permitted to
set the max-ephone value higher than the number of users and phones supported by your
Cisco Unified CME phone licenses for the purpose of enrolling licensed phones using Extension
Assigner.
In addition to configuring one ephone-dn for each temporary extension number that is assigned
automatically, you also must configure an ephone-dn entry for each extension number that is assigned
by the installation technician.
To complete the configuration, as shown in the following example, you must:
• Specify whether to use the ephone or the provision-tag number to identify the extension
number to assign to the phone. Set this when the feature is enabled with the new
extension-assigner tag-type command provided with this feature.
• Configure an ephone-dn for each temporary extension number that is assigned automatically.
• Configure an ephone-dn for each extension number that you want the installation technician to
assign to a phone.
Cisco Unified Communications Manager Express System Administrator Guide
232 OL-10663-02
Creating Phone Configurations Using Extension Assigner
Information About Extension Assigner
• Configure an ephone with a temporary MAC address for each phone that is assigned an extension
number by the installation technician. Optionally, this ephone definition can include the new
provision-tag. For more information, see the “Configuring Ephones with Temporary MAC
Addresses” section on page 245.
telephony-service
extension-assigner tag-type provision-tag
auto assign 101 to 105
ephone-dn 1 dual-line
number 6001
ephone-dn 101
number 0001
label Temp-Line-not assigned yet
ephone 1
provision-tag 6001
mac-address 02EA.EAEA.0001
button 1:1
Because you must configure two ephone-dns for each extension number that you want to assign, you
may exceed your max-dn setting. You are permitted to set the max-dn value higher than the number
allowed by your license for the purpose of enrolling licensed phones using extension assigner.
Assuming that your max-dn setting is set high enough, your max-ephone setting determines how many
phones you can plug in at one time. For example, if your max-ephone setting is ten more than the number
of phones to which you want to assign extension numbers, the you can plug in ten phones at a time. If
you plug in eleven phones, one phone will not register or get a temporary extension number until you
assign an extension to one of the first ten phones and reset the eleventh phone.
After you have configured your ephone and ephone-dn entries, you can complete your router
configuration by optionally configuring the router to automatically save your configuration. If the router
configuration is not saved, any extension assignments made by the installation technician will be lost
when the router is restarted. The alternative to this optional procedure is to have the installation
technician connect to the router and enter the write memory command to save the router configuration.
The final task of the system administrator is to document the information that the installation technician
needs to assign extension numbers to the new phones. You can also use this documentation as a guide
when you configure Cisco Unified CME to implement this feature. This information includes:
• How many phones the installation technician can plug in at one time
• Which extension number to dial to access the extension assigner application
• Whether the number is dialed automatically when a phone goes off hook
• What password to enter to access the application
• Which tag numbers to enter to assign an extension to each phone
Note Because this feature is implemented using a Tcl script and audio files, you must place the script and
associated audio prompt files in the correct directory. Do not edit this script; just configure
Cisco Unified CME to load the appropriate script.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 233
Creating Phone Configurations Using Extension Assigner
Information About Extension Assigner
Procedures for Installation Technicians
This feature is implemented using a Tcl script and audio prompt files that enable the installation
technician to assign an extension number to a new Cisco Unified CME phone by performing the
following procedure The system administrator provides the installation technician with all of the
information required to perform this procedure.
Step 1 Plug in a specified number of new phones.
Step 2 Wait for the phones to be assigned temporary, random extension numbers.
Step 3 Dial a specified number to access the extension assigner application.
Step 4 Enter a specified password.
Step 5 Enter a tag that identifies an extension number and enables the installation technician to perform one of
the following tasks:
• Assign a new extension number to a phone.
• Unassign the current extension number.
• Reassign an extension number.
Files Included in this Release
The app-cme-ea-2.0.0.0.tar or later archive file provided for the extension assigner feature includes a
readme file, a Tcl script, and several audio prompt files. If you want to replace the audio files with files
that use a language other than English, do not change the name of the files. The Tcl script is written to
use only the following list of the filenames:
• app-cme-ea-2.0.0.0.tcl (script)
• en_cme_tag_assign_phone.au (audio file)
• en_cme_tag_assigned_to_phone.au (audio file)
• en_cme_tag_assigned_to_phone_idle.au (audio file)
• en_cme_tag_assigned_to_phone_inuse.au (audio file)
• en_cme_tag_assigned_to_phone_unreg.au (audio file)
• en_cme_tag_available.au (audio file)
• en_cme_tag_extension.au (audio file)
• en_cme_tag_invalid.au (audio file)
• en_cme_tag_unassign_phone.au (audio file)
• en_cme_tag_action_cancelled.au (audio file)
• en_cme_tag_assign_failed.au (audio file)
• en_cme_tag_assign_success.au (audio file)
• en_cme_tag_contact_admin.au (audio file)
• en_cme_tag_disconnect.au (audio file)
• en_cme_tag_ephone_tagid.au (audio file)
Cisco Unified Communications Manager Express System Administrator Guide
234 OL-10663-02
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
• en_cme_tag_invalid_password.au (audio file)
• en_cme_tag_invalidoption.au (audio file)
• en_cme_tag_noentry.au (audio file)
• en_cme_tag_password.au (audio file)
• en_cme_tag_unassign_failed.au (audio file)
• en_cme_tag_unassign_success.au (audio file)
• en_eight.au (audio file)
• en_five.au (audio file)
• en_four.au (audio file)
• en_nine.au (audio file)
• en_one.au (audio file)
• en_seven.au (audio file)
• en_six.au (audio file)
• en_three.au (audio file)
• en_two.au (audio file)
• en_zero.au (audio file)
• readme.txt
Extension Assigner Synchronization
Extension Assigner Synchronization enables the secondary backup router to automatically receive any
changes made by Extension Assigner to ephone mac-addresses in the primary router. The
synchronization is performed using the Cisco Unified CME XML interface. The Cisco Unified CME
XML client encapsulates the configuration changes into an ISexecCLI request and sends it to the
secondary backup router using HTTP. The server on the secondary backup side processes the incoming
XML request and calls the Cisco IOS CLI parser to perform the updates.
For configuration information, see the “Configuring Extension Assigner Synchronization” section on
page 249.
SCCP: How to Configure Extension Assigner
This section contains the following tasks:
• Configuring Extension Assigner, page 236 (required)
• Configuring Extension Assigner Synchronization, page 249 (optional)
• Assigning Extension Numbers Onsite by Using Extension Assigner, page 251 (required)
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 235
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
Configuring Extension Assigner
The following tasks are performed by an administrator or other personnel who is responsible for
configuring Extension Assigner:
• Determining Which Extension Numbers to Assign to the New Phones and Plan Your Configuration,
page 236
• Downloading the Tcl Script, page 236
• Configuring the Tcl Script, page 237
• Specifying the Extension for Accessing Extension Assigner Application, page 239
• Configuring Provision-Tags for the Extension Assigner Feature, page 241
• Configuring Temporary Extension Numbers for Phones That Use Extension Assigner, page 242
• Configuring Extension Numbers That Installation Technicians Can Assign to Phones, page 244
• Configuring Ephones with Temporary MAC Addresses, page 245
• Configuring the Router to Automatically Save Your Configuration, page 247
• Provide the Installation Technician with the Required Information, page 249
Determining Which Extension Numbers to Assign to the New Phones and Plan Your Configuration
After you determine which extension number to assign to each phone, you must make the following
decisions:
• Which extension number must be dialed to access the extension assigner application.
• Whether the number is dialed automatically when a phone goes off hook.
• What password the installation technician must enter to access the extension assigner application.
• Whether to use ephone-tag or the provision-tag number to identify the extension number to assign
to the phone.
• How many temporary extension numbers to configure. This will determine how many temporary
ephone-dns and temporary MAC addresses to configure.
• What specific tag numbers to use to identify the extension number to assign to the phone.
Downloading the Tcl Script
To download the Tcl script and audio prompt files for the extension assigner feature, perform the
following steps.
For more information about how to use Tcl scripts, see the Cisco IOS Tcl IVR and Voice XML Application
Guide for your Cisco IOS release.
Note Do not edit the Tcl script
Cisco Unified Communications Manager Express System Administrator Guide
236 OL-10663-02
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
SUMMARY STEPS
1. Go to the Cisco Unified CME software download website at
http://www.cisco.com/pcgi-bin/tablebuild.pl/ip-iostsp.
2. Download the Cisco Unified CME extension assigner tar archive to a TFTP server or to the
Cisco Unified CME system’s flash memory.
3. enable
4. archive tar /xtract source-url destination-url
DETAILED STEPS
Command or Action Purpose
Step 1 Go to the Cisco Unified CME software download Gives you access to Cisco Unified CME software
website at downloads.
http://www.cisco.com/pcgi-bin/tablebuild.pl/ip-iosts.
Step 2 Download the Cisco Unified CME extension assigner Downloads the Cisco Unified CME extension assigner tar
tar archive to a TFTP server that is accessible to the archive to a TFTP server that is accessible to the
Cisco Unified CME router. Cisco Unified CME router.
• This tar archive contains the extension assigner Tcl
script and the default audio files that you need for the
extension assigner service.
Step 3 enable Enters global configuration mode.
Example:
Router# enable
Step 4 archive tar /xtract source-url destination-url Uncompresses the files in the archive file and copies them
to a location that is accessible by the Cisco Unified CME
router.
Example:
Router# archive tar /xtract • source-url—URL of the source of the extension
tftp://192.168.1.1/app-cme-ea-2.0.0.0.tar assigner TAR file. Valid URLs can refer to TFTP or
flash:
HTTP servers or to flash memory.
• location—URL of the destination of the extension
assigner TAR file, including its Tcl script and audio
files. Valid URLs can refer to TFTP or HTTP servers or
to flash memory.
Configuring the Tcl Script
To configure and load the Tcl script for the extension assigner feature and create the password that
installation technicians enter to access the extension assigner application, perform the following steps.
For more information about how to use Tcl scripts, se the Cisco IOS Tcl IVR and Voice XML Application
Guide for your Cisco IOS release.
Note To change the password, you must remove the existing extension assigner service and create a new
service that defines a new password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 237
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
SUMMARY STEPS
1. enable
2. configure terminal
3. application
4. service service-name location
5. param ea-password password
6. paramspace english index number
7. paramspace english language en
8. paramspace english location location
9. paramspace english prefix en
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 application Enters application configuration mode to configure
packages and services.
Example:
Router(config)# application
Step 4 service service-name location Enters service parameter configuration mode to configure
parameters for the call-queue service.
Example: • service-name—Name of the extension assigner service.
Router(config-app)# service EA This arbitrary name is used to identify the service
tftp://10.1.1.100/app-cme-ea-2.0.0.0.tcl during configuration tasks.
• location—URL of the Tcl script for the extension
assigner service. Valid URLs can refer to TFTP or
HTTP servers or to flash memory.
Step 5 param ea-password password Sets the password that installation technicians enter to
access the extension assigner application.
Example: • password—Numerical password that installation
Router(config-app-param)# param ea-password technicians enter to access the extension assigner
1234 application. Length: 2 to 10 digits.
Cisco Unified Communications Manager Express System Administrator Guide
238 OL-10663-02
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
Command or Action Purpose
Step 6 paramspace english index number Defines the category of audio files that are used for dynamic
prompts by an IVR application.
Example: • For Extension Assigner, language must be English.
Router(config-app-param)# paramspace english
index 0
• number—Category group of the audio files (from
0 to 4). For example, audio files representing the days
and months can be category 1, audio files representing
units of currency can be category 2, and audio files
representing units of time—seconds, minutes, and
hours—can be category 3. Range is from 0 to 4;
0 means all categories.
Step 7 paramspace english language en Defines the language of audio files that are used for
dynamic prompts by an IVR application.
Example: • For the Extension Assigner, language must be English
Router(config-app-param)# paramspace english and prefix is en.
language en
Step 8 paramspace english location location Defines the location of audio files that are used for dynamic
prompts by an IVR application.
Example: • For the Extension Assigner, language must be English.
Router(config-app-param)# paramspace english
location
• location—URL of the Tcl script for the extension
tftp://10.1.1.100/app-cme-ea-2.0.0.0.tcl assigner service. Valid URLs can refer to TFTP or
HTTP servers or to flash memory.
Step 9 paramspace english prefix en Defines the prefix of audio files that are used for dynamic
prompts by an IVR application.
Example: • For the Extension Assigner, language must be English
Router(config-app-param)# paramspace english and prefix is en.
prefix en
Step 10 end Returns to privileged EXEC mode.
Example:
Router(config-app-param)# end
Specifying the Extension for Accessing Extension Assigner Application
To specify the extension number that installation technicians must dial to access the extension assigner
application during onsite installation, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. dial-peer voice tag voip
4. service service-name outbound
5. destination-pattern string
6. session target ipv4:destination-address
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 239
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
7. dtmf-relay h245-alphanumeric
8. codec g711ulaw
9. no vad
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 dial-peer voice tag voip Enters dial-peer configuration mode.
• tag—Number used during configuration tasks to
Example: identify this dial peer.
Router(config)# dial-peer voice 5999 voip
Step 4 service service-name outbound Loads and configures the extension assigner application on
a dial peer.
Example: • service-name—Name must match the name that you
Router(config-dial-peer)# service EA outbound used to load the extension assigner Tcl script in the
“Configuring the Tcl Script” section on page 237.
• outbound—Required for Extension Assigner.
Step 5 destination-pattern string Specifies either the prefix or the full E.164 telephone
number (depending on the dial plan) for a dial peer.
Example: • string—Number that the installation technician calls
Router(config-dial-peer)# destination pattern when assigning an extension number to a phone.
5999
Step 6 session target ipv4:destination-address Designates a network-specific address to receive calls from
a VoIP dial peer.
Example: • destination—IP address for the Cisco Unified CME
Router(config-dial-peer)# session target interface on this router.
ipv4:172.16.200.200
Step 7 dtmf-relay h245-alphanumeric Specifies the H.245 alphanumeric method for relaying dual
tone multifrequency (DTMF) tones between telephony
interfaces and an H.323 network.
Example:
Router(config-dial-peer)# dtmf-relay
h245-alphanumeric
Step 8 codec codec Specifies the voice coder rate of speech for a dial peer.
• codec—Option that represents the correct voice
Example: decoder rate.
Router(config-dial-peer)# codec g711ulaw
Cisco Unified Communications Manager Express System Administrator Guide
240 OL-10663-02
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
Command or Action Purpose
Step 9 no vad Disables voice activity detection (VAD) for the calls using
a particular dial peer.
Example: • Required fro Extension Assigner.
Router(config-dial-peer)# no vad
Step 10 end Returns to privileged EXEC mode.
Example:
Router(config-dial-peer)# end
Configuring Provision-Tags for the Extension Assigner Feature
To modify Extension Assigner to use provision-tags, perform the following steps. By default, the
extension assigner is enabled and uses ephone tags.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. extension-assigner tag-type {ephone-tag | provision-tag}
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 241
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
Command or Action Purpose
Step 4 extension-assigner tag-type {ephone-tag | Specifies tag type to use to identify extension numbers for
provision-tag} Extension Assigner.
• ephone-tag—Specifies that extension assigner use the
Example: ephone tag to identify the extension number that is
Router(config-telephony)# extension-assigner assigned to a phone. The installation technician enters
tag-type provision-tag
this number to assign an extension number to a phone.
• provision-tag—Specifies that extension assigner use
the provision-tag to identify the extension number that
is assigned to a phone. The installation technician
enters this number to assign an extension number to a
phone.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Configuring Temporary Extension Numbers for Phones That Use Extension Assigner
To create ephone-dsn to use as a temporary extension numbers for phones to which an extension number
will be assigned by Extension Assigner, perform the following steps for each temporary number to be
created.
Tip The readme file that is included with the script contains some sample entries for this procedure that you
can edit to fit your needs.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag [dual-line]
4. number number [secondary number] [no-reg [both | primary]]
5. trunk digit-string [timeout seconds]
6. name name
7. exit
8. telephony-service
9. auto assign dn-tag to dn-tag
10. end
Cisco Unified Communications Manager Express System Administrator Guide
242 OL-10663-02
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag [dual-line] Enters ephone-dn configuration mode, creates an
ephone-dn, and optionally assigns it dual-line status.
Example: Note We recommend that you use single-line mode for
Router(config)# ephone-dn 90 your temporary extension numbers.
Step 4 number number [secondary number] [no-reg [both Configures a valid extension number for this ephone-dn
| primary]] instance.
Example:
Router(config-ephone-dn)# number 9000
Step 5 trunk digit-string [timeout seconds] (Optional) Configures extension number to be
automatically dialed for accessing the extension assigner
application.
Example:
Router(config-ephone-dn)# trunk 5999 • digit-string—Must match the number that you
configured in the “Specifying the Extension for
Accessing Extension Assigner Application” section on
page 239.
Step 6 name name (Optional) Associates a name with this ephone-dn instance.
This name is used for caller-ID displays and in the local
directory listings.
Example:
Router(config-ephone-dn)# name hardware • Must follow the name order that is specified with the
directory command.
Step 7 exit Exits ephone-dn configuration mode
Example:
Router(config-ephone-dn)# exit
Step 8 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 9 auto assign dn-tag to dn-tag Automatically assigns ephone-dn tags to Cisco Unified IP
phones as they register for service with a
Cisco Unified CME router.
Example:
Router(config-telephony)# auto assign 90 to 99 • Must match the tags that you configured in earlier step.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 243
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
Command or Action Purpose
Step 10 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Configuring Extension Numbers That Installation Technicians Can Assign to Phones
To create ephone-dns for an extension numbers that the installation technicians can assign to phones,
perform the following steps for each directory number to be created.
Tip The readme file provided with this feature contains sample entries that you can edit to fit your needs.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag [dual-line]
4. number number [secondary number] [no-reg [both | primary]]
5. name name
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag [dual-line] Enters ephone-dn configuration mode, creates an
ephone-dn, and optionally assigns it dual-line status.
Example: Note To change an ephone-dn from dual-line to
Router(config)# ephone-dn 20 single-line mode or the reverse, first delete the
ephone-dn and then recreate it.
Step 4 number number [secondary number] [no-reg [both Configures a valid extension number for this ephone-dn
| primary]] instance.
Example:
Router(config-ephone-dn)# number 20
Cisco Unified Communications Manager Express System Administrator Guide
244 OL-10663-02
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
Command or Action Purpose
Step 5 name name (Optional) Associates a name with this ephone-dn instance.
This name is used for caller-ID displays and in the local
directory listings.
Example:
Router(config-ephone-dn)# name hardware • Must follow the name order that is specified with the
directory command.
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
Configuring Ephones with Temporary MAC Addresses
To create an ephone configuration with temporary a MAC address for a Cisco Unified CME phone to
which you want the installation technician to assign extension numbers, perform the following steps for
each phone.
Prerequisites
• The max-ephone command must be configured for a value equal to at least one greater than the
number of phones to which you want to assign extension numbers to allow the autoregister feature
to automatically create at least one ephone for your temporary extension numbers.
Note You are permitted to set the max-ephone value higher than the number of users supported by
your Cisco Unified CME licenses for the purpose of enrolling licensed phones using Extension
Assigner.
Restrictions
• Max-ephone setting determines how many phones you can plug in at one time. For example, if your
max-ephone setting is ten more than the number of phones to which you want to assign extension
numbers, the you can plug in ten phones at a time. If you plug in eleven phones, one phone will not
register or get a temporary extension number until you assign an extension to one of the first ten
phones and reset the eleventh phone.
• For Cisco VG224 analog voice gateways with extension assigner, a minimum of 24 temporary
ephones is required.
Tip The readme file provided with this feature contains some sample entries for this procedure that you can
edit to fit your needs.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. provision-tag number
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 245
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
5. mac-address 02EA.EAEA.number
6. type phone-type [addon 1 module-type [2 module-type]]
7. button
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Maximum nuber is version and platfor-
Example: specific. Type ? to display range.
Router(config)# ephone 20
• Number that the installation technician enters when
assigning an extension to a phone if Extension Assigner
uses ephone-tags (default).
Step 4 provision-tag number (Optional) Creates a unique sequence number to be used by
Extension Assigner to identify extension numbers to be
assigned.
Example:
Router(config-ephone)# provision-tag 20 • required only if you configured the provision-tag
keyword with the extension-assigner tag-type
command.
Step 5 mac-address 02EA.EAEA.number Specifies a temporary MAC address number for this
ephone.
Example: • For Extension Assigner, MAC address must begin with
Router(config-ephone)# mac-address 02EA.EAEA.
02EA.EAEA.0020
• number—We strongly recommend that you make this
number the same as the ephone number.
Step 6 type phone-type [addon 1 module-type [2 Specifies the type of phone.
module-type]]
Example:
Router(config-ephone)# type 7960 addon 1 7914
Step 7 button button-number{separator}dn-tag Associates a button number and line characteristics with an
extension (ephone-dn).
Example: • Maximum number of buttons is determined by phone
Router(config-ephone)# button 1:1 type.
Note The Cisco Unified IP Phone 7910 has only one line
button, but can be given two ephone-dn tags.
Cisco Unified Communications Manager Express System Administrator Guide
246 OL-10663-02
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
Command or Action Purpose
Step 8 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Configuring the Router to Automatically Save Your Configuration
To automatically save your router configuration when the router is restarted, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. kron policy-list list-name
4. cli write
5. exit
6. kron occurrence occurrence-name [user username] in [[numdays:]numhours:]nummin {oneshot |
recurring}
7. policy-list list-name
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 kron policy-list list-name Specifies a name for a new or existing Command Scheduler
policy list and enters kron-policy configuration mode.
Example: • If the value of the list-name argument is new, a new
Router(config)# kron policy-list save-config policy list structure is created.
• If the value of the list-name argument exists, the
existing policy list structure is accessed. No editor
function is available, and the policy list is run in the
order in which it was configured.
Step 4 cli write Specifies the fully-qualified EXEC command and
associated syntax to be added as an entry in the Command
Scheduler policy list.
Example:
Router(config-kron-policy)# cli write
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 247
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
Command or Action Purpose
Step 5 exit Returns to global configuration mode.
Example:
Router(config-kron-policy)# exit
Step 6 kron occurrence occurrence-name [user username] Specifies schedule parameters for a Command Scheduler
[[in numdays:]numhours:]nummin {oneshot | occurrence and enters kron-occurrence configuration mode.
recurring}
• We recommend that you configure your router to save
your configuration every 30 minutes.
Example:
Router(config)# kron occurrence backup in 30 • occurrence-name—Specifies the name of the
recurring occurrence. Length of occurrence-name is from 1 to 31
characters. If the occurrence-name is new, an
occurrence structure is created. If the occurrence-name
is not new, the existing occurrence is edited.
• user—(Optional) Used to identify a particular user.
• username—Name of user.
• in—Identifies that the occurrence is to run after a
specified time interval. The timer starts when the
occurrence is configured.
• numdays:—(Optional) Number of days. If used, add a
colon after the number.
• numhours:—(Optional) Number of hours. If used, add
a colon after the number.
• nummin:—(Optional) Number of minutes.
• oneshot—Identifies that the occurrence is to run only
one time. After the occurrence has run, the
configuration is removed.
• recurring—Identifies that the occurrence is to run on a
recurring basis.
Step 7 policy-list list-name Specifies a Command Scheduler policy list.
Example:
Router(config-kron-occurrence)# policy-list
save-config
Step 8 end Returns to privileged EXEC mode.
Example:
Router(config-kron-occurrence)# end
Cisco Unified Communications Manager Express System Administrator Guide
248 OL-10663-02
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
Provide the Installation Technician with the Required Information
Before the installation technician can assign extension numbers to the new phones, you must provide the
following information:
• How many phones the installation technician can plug in at one time. This is determined by the
number of temporary MAC addresses that you configured.
• Which extension number to dial to access the extension assigner application.
• Whether the number is dialed automatically when a phone goes off hook.
• What password to enter to access the application.
• Which tag numbers to enter to assign an extension to each phone.
Configuring Extension Assigner Synchronization
This section contains the following tasks:
• Configuring the XML Interface for the Secondary Backup Router, page 249
• Configuring Extension Assigner Synchronization on the Primary Router, page 250
Configuring the XML Interface for the Secondary Backup Router
To configure the secondary backup router to activate the XML interface required to receive configuration
change information from the primary router, perform the following steps.
Prerequisites
• The XML interface, provided through the Cisco IOS XML Infrastructure (IXI), must be configured.
See the “Configuring the XML API” section on page 1219.
Restrictions
• Automatic synchronization for new or replacement routers is not supported.
• Extension assigner preconfiguration must be manually performed on the secondary backup router.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. xml user user-name password password privilege-level
5. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 249
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony service configuration mode.
Example:
Router(config)# telephony-service
Step 4 xml user user-name password password Defines an authorized user.
privilege-level
• user-name: Username of the authorized user.
• password: Password to use for access.
Example:
Router(config-telephony)# xml user user23 • privilege-level: Level of access to Cisco IOS
password 3Rs92uzQ 15 commands to be granted to this user. Only the
commands with the same or a lower level can be
executed via XML. Range is 0 to 15.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Configuring Extension Assigner Synchronization on the Primary Router
To configure the primary router to enable automatic synchronization to the secondary backup router,
perform the following steps.
Prerequisites
• XML interface for secondary backup router is configured. See the “Configuring the XML Interface
for the Secondary Backup Router” section on page 249.
• The secondary backup router’s IP address must already be configured using the ip source-address
command in telephony-service configuration mode.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. standby username username password password
5. end
Cisco Unified Communications Manager Express System Administrator Guide
250 OL-10663-02
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony service configuration mode.
Example:
Router(config)# telephony-service
Step 4 standby username username password password Defines an authorized user.
• Same username and password that was previously
Example: defined for the XML interface on the secondary backup
Router(config-telephony)# standby username router.
user23 password 3Rs92uzQ
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Assigning Extension Numbers Onsite by Using Extension Assigner
The following tasks are performed by the installation technician at the customer’s site
• Assigning New Extension Numbers, page 251
• Unassigning an Extension Number, page 252
• Reassigning the Current Extension Number, page 252
Assigning New Extension Numbers
Initially, when you install a phone, it is assigned a temporary, random extension number. To access
Extension Assigner and assign the appropriate extension number to this phone, perform the following
steps.
Step 1 Get the information you need to use extension assigner from your system administrator. For a list of this
information, see the “Provide the Installation Technician with the Required Information” section on
page 249.
Step 2 Dial the appropriate extension number to access the extension assigner system.
Step 3 Enter the password for the extension assigner and press #.
Step 4 Enter the ID number that represents this phone’s extension and press #.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 251
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
Step 5 If the extension is not assigned to another phone, press 1 to confirm that you want to assign the extension
to your phone, then hang up. After the phone resets, the assignment is complete.
Step 6 If the extension is assigned to another phone that is idle:
a. Press 2 to confirm that you want to unassign the extension from the other phone.
b. Hang up.
c. Repeat this procedure beginning at Step 2.
Step 7 If the extension is assigned to another phone that is in use, either:
• Return to Step 5 to enter another extension number.
• Perform the procedures in the “Unassigning an Extension Number” section on page 252 and then
repeat this procedure beginning at Step 2.
Unassigning an Extension Number
After the new extension number is assigned, you may find that you assigned the wrong number or that
your original dial plan has changed. To unassign the wrong number so that it can be used by another
phone, perform the following steps.
Step 1 Get the information you need to use extension assigner from your system administrator. For a list of this
information, see the “Provide the Installation Technician with the Required Information” section on
page 249.
Step 2 Dial the appropriate extension number to access the extension assigner system.
Step 3 Enter the password for the extension assigner and press #.
Step 4 Enter the ID number that represents this phone’s extension and press #.
Step 5 When you enter the ID number for the extension that is currently assigned to this phone, you are
prompted to press 2 to confirm that you want to unassign the extension from the phone.
Step 6 Hang up.
Reassigning the Current Extension Number
• If you must replace a broken phone or you want to reassign an extension number, perform the
following steps.
Note You can reassign a number to a phone only if that number:
• Is not assigned to another phone
• Is assigned to another phone and that phone is idle
• Is assigned to another phone and you first unassign the extension
Cisco Unified Communications Manager Express System Administrator Guide
252 OL-10663-02
Creating Phone Configurations Using Extension Assigner
SCCP: How to Configure Extension Assigner
Step 1 Get the information you need to use extension assigner from your system administrator. For a list of this
information, see the “Provide the Installation Technician with the Required Information” section on
page 249.
Step 2 Dial the appropriate extension number to access the extension assigner system.
Step 3 Enter the password for the extension assigner and press #.
Step 4 Enter the ID number that represents this phone’s extension and press #.
Step 5 If the extension is not assigned to another phone, press 1 to confirm that you want to assign the extension
to your phone, then hang up. After the phone resets, the reassignment is complete.
Step 6 If the extension is assigned to another phone that is idle:
a. Press 2 to confirm that you want to unassign the extension from the other phone.
b. Hang up
c. Perform the procedure in the “Assigning New Extension Numbers” section on page 251.
Step 7 If the extension is assigned to another phone that is in use, either:
• Return to Step 5 to enter another extension number.
• Perform the procedures in the “Unassigning an Extension Number” section on page 252 and the
“Assigning New Extension Numbers” section on page 251.
Verifying Extension Assigner
Step 1 Use the debug ephone extension-assigner command to display status messages produced by the
extension assigner application.
*Jun 9 19:08:10.627: ephone_query: inCallID=47, tag=4, ephone_tag=4
*Jun 9 19:08:10.627: extAssigner_IsEphoneMacPreset: ephone_tag = 4,
ipKeyswitch.max_ephones = 96
*Jun 9 19:08:10.627: extAssigner_IsEphoneMacPreset: ephone_ptr->mac_addr_str =
000B46BDE075, MAC_EXT_RESERVED_VALUE = 02EAEAEA0000
*Jun 9 19:08:10.627: SkinnyGetActivePhoneIndexFromCallid: callID = 47
*Jun 9 19:08:10.627: SkinnyGetActivePhoneIndexFromCallid: vdbPtr->physical_interface_type
(26); CV_VOICE_EFXS (26)
*Jun 9 19:08:10.627: SkinnyGetActivePhoneIndexFromCallid: vdbPtr->type (6);
CC_IF_TELEPHONY (6)
*Jun 9 19:08:10.627: SkinnyGetActivePhoneIndexFromCallid: htsp->sig_type (26);
CV_VOICE_EFXS (26)
*Jun 9 19:08:10.627: SkinnyGetActivePhoneIndexFromCallid: dn = 4, chan = 1
*Jun 9 19:08:10.627: ephone_query: EXTASSIGNER_RC_SLOT_ASSIGNED_TO_CALLING_PHONE
*Jun 9 19:08:22.763: ephone_unassign: inCallID=47, tag=4, ephone_tag=4
*Jun 9 19:08:22.763: extAssigner_IsEphoneMacPreset: ephone_tag = 4,
ipKeyswitch.max_ephones = 96
*Jun 9 19:08:22.763: extAssigner_IsEphoneMacPreset: ephone_ptr->mac_addr_str =
000B46BDE075, MAC_EXT_RESERVED_VALUE = 02EAEAEA000
*Jun 9 19:08:22.763: is_ephone_auto_assigned: button-1 dn_tag=4
*Jun 9 19:08:22.763: is_ephone_auto_assigned: NO
*Jun 9 19:08:22.763: SkinnyGetActivePhoneIndexFromCallid: callID = 47
*Jun 9 19:08:22.763: SkinnyGetActivePhoneIndexFromCallid: vdbPtr->physical_interface_type
(26); CV_VOICE_EFXS (26)
*Jun 9 19:08:22.767: SkinnyGetActivePhoneIndexFromCallid: vdbPtr->type (6);
CC_IF_TELEPHONY (6)
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 253
Creating Phone Configurations Using Extension Assigner
Configuration Examples for Extension Assigner
*Jun 9 19:08:22.767: SkinnyGetActivePhoneIndexFromCallid: htsp->sig_type (26);
CV_VOICE_EFXS (26)
*Jun 9 19:08:22.767: SkinnyGetActivePhoneIndexFromCallid: dn = 4, chan = 1
*Jun 9 19:08:29.795: ephone-4[8]:fStationOnHookMessage: Extension Assigner request
restart, cmd=2, new mac=02EAEAEA0004, ephone_tag=4
*Jun 9 19:08:30.063: %IPPHONE-6-UNREGISTER_NORMAL: ephone-4:SEP000B46BDE075 IP:5.5.0.1
Socket:8 DeviceType:Phone has unregistered normally.
*Jun 9 19:08:30.063: ephone-4[8][SEP000B46BDE075]:extAssigner_assign: new
mac=02EAEAEA0004, ephone-tag=4
*Jun 9 19:08:30.063: extAssigner_simple_assign: mac=02EAEAEA0004, tag=4
*Jun 9 19:08:30.063: ephone_updateCNF: update cnf_file ephone_tag=4
*Jun 9 19:08:30.063: extAssigner_assign: restart again (mac=02EAEAEA0004) ephone_tag=4
*Jun 9 19:08:30.131: %IPPHONE-6-REG_ALARM: 23: Name=SEP000B46BDE075 Load=8.0(2.0)
Last=Reset-Restart
*Jun 9 19:08:30.135: %IPPHONE-6-REGISTER_NEW: ephone-7:SEP000B46BDE075 IP:5.5.0.1
Socket:10 DeviceType:Phone has registered.
*Jun 9 19:08:30.503: %IPPHONE-6-UNREGISTER_NORMAL: ephone-7:SEP000B46BDE075 IP:5.5.0.1
Socket:10 DeviceType:Phone has unregistered normally.
*Jun 9 19:08:43.127: %IPPHONE-6-REG_ALARM: 22: Name=SEP000B46BDE075 Load=8.0(2.0)
Last=Reset-Reset
*Jun 9 19:08:43.131: %IPPHONE-6-REGISTER: ephone-7:SEP000B46BDE075 IP:5.5.0.1 Socket:13
DeviceType:Phone has registered.
Step 2 Use the debug voip application script command to display status messages produced by the server as
it runs the assigner application Tcl script.
Jun 20 23:17:45.795: //22//TCL :/tcl_PutsObjCmd: TCL: ***** >>> app-cme-ea-2.0.0.0.tcl <<<
*****
Jun 20 23:17:45.799: //22//TCL :/tcl_PutsObjCmd: TCL: ***** >>> Cisco CME Extension
Assigner Application <<< ****
Jun 20 23:17:45.799: //22//TCL :/tcl_PutsObjCmd: >>> PROMPT: Enter password <<<
Jun 20 23:17:54.559: //22//TCL :/tcl_PutsObjCmd: >>> Collect Password Status = cd_005 <<<
Jun 20 23:17:54.563: //22//TCL :/tcl_PutsObjCmd: >>> INFO: Authentication Successful <<<
Jun 20 23:17:54.563: //22//TCL :/tcl_PutsObjCmd: >>> PROMPT: Please enter the phone tag
number followed by the # key. Press * to re-enter the tag number <<<
Jun 20 23:17:59.839: //22//TCL :/tcl_PutsObjCmd: >>> Ephone TAG Digit Collect Status =
cd_005 <<<
Jun 20 23:17:59.843: //22//TCL :/tcl_PutsObjCmd: >>> INFO: Phone Query result = 1 <<<
Jun 20 23:17:59.843: //22//TCL :/tcl_PutsObjCmd: >>> PROMPT: Ephone Tag 6 is available
<<<
Jun 20 23:17:59.843: //22//TCL :/tcl_PutsObjCmd: >>> PROMPT: To assign extension to Phone,
press 1 to confirm, 9 to cancel <<<
Jun 20 23:17:59.851: //22//TCL :/tcl_PutsObjCmd: >>> INFO: ephone 6 is available <<<
Jun 20 23:18:20.375: //22//TCL :/tcl_PutsObjCmd: >>> INFO: TAPS Status = cd_005 <<<
Jun 20 23:18:20.379: //22//TCL :/tcl_PutsObjCmd: >>> PROMPT: Extension assignment is
successful <<<
Jun 20 23:18:20.379: //22//TCL :/tcl_PutsObjCmd: >>> INFO: Ephone extension is assigned
successfully <<<
Jun 20 23:18:28.975: //22//TCL :/tcl_PutsObjCmd: **** >>> TCL: Closing Cisco CM
Step 3 Use the debug ephone state command as described in the Cisco IOS Debug Command Reference.
Configuration Examples for Extension Assigner
This section contains the following examples:
• Extension Assigner: Example, page 255
• Extension Assigner Synchronization: Example, page 257
Cisco Unified Communications Manager Express System Administrator Guide
254 OL-10663-02
Creating Phone Configurations Using Extension Assigner
Configuration Examples for Extension Assigner
Extension Assigner: Example
This exampleshows a router configuration with the following characteristics:
• The extension that the installation technician dials to access the extension assigner application is
0999.
• The password that the installation technician enters to access the extension assigner application is
1234.
• The auto assign command is configured to assign extensions 0001 to 0005.
• The installation technician can use extension assigner to assign extension numbers 6001 to 6005.
• The extension assigner uses the provision-tag to identify which ephone configuration and extension
numbers to assign to the phone.
• The auto-reg-ephone command is shown but required, since it is enabled by default.
• The kron command is used to automatically save the router configuration.
• The max-ephone and max-dn settings of 51 are high enough to allow the installation technician to
assign extensions to 50 phones, plugging them in one at a time. If the installation technician is
assigning extensions to 40 phones, 11 can be plugged in one at a time. The exceptionis if you use
Cisco VG224 Analog Voice Gateways. Extension assigner creates 24 ephones for each
Cisco VG224 Analog Voice Gateway, one for each port.
Router# show running-config
version 12.4
no service password-encryption
!
hostname Test-Router
!
boot-start-marker
boot system flash:c2800nm-ipvoice-mz.2006-05-31.GOPED_DEV
boot-end-marker
!
enable password ww
!
no aaa new-model
!
resource policy
!
ip cef
no ip dhcp use vrf connected
!
ip dhcp pool pool21
network 172.21.0.0 255.255.0.0
default-router 172.21.200.200
option 150 ip 172.30.1.60
!
no ip domain lookup
!
application
service EA flash:ea/app-cme-ea-2.0.0.0.tcl
paramspace english index 0
paramspace english language en
param ea-password 1234
paramspace english location flash:ea/
paramspace english prefix en
!
interface GigabitEthernet0/0
no ip address
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 255
Creating Phone Configurations Using Extension Assigner
Configuration Examples for Extension Assigner
duplex auto
speed 100
no keepalive
!
interface GigabitEthernet0/0.21
encapsulation dot1Q 21
ip address 172.21.200.200 255.255.0.0
ip http server
!
control-plane
!
dial-peer voice 999 voip
service EA out-bound
destination-pattern 0999
session target ipv4:172.21.200.200
dtmf-relay h245-alphanumeric
codec g711ulaw
no vad
!
telephony-service
extension-assigner tag-type provision-tag
max-ephones 51
max-dn 51
ip source-address 172.21.200.200 port 2000
auto-reg-ephone
auto assign 101 to 105
system message Test-CME
create cnf-files version-stamp 7960 Jun 14 2006 05:37:34
!
ephone-dn 1 dual-line
number 6001
!
ephone-dn 2 dual-line
number 6002
!
ephone-dn 3 dual-line
number 6003
!
ephone-dn 4 dual-line
number 6004
!
ephone-dn 5 dual-line
number 6005
!
ephone-dn 101
number 0101
label Temp-Line-not assigned yet
!
ephone-dn 102
number 0102
label Temp-Line-not assigned yet
!
ephone-dn 103
number 0103
label Temp-Line-not assigned yet
!
ephone-dn 104
number 0104
label Temp-Line-not assigned yet
!
ephone-dn 105
number 0105
label Temp-Line-not assigned yet
Cisco Unified Communications Manager Express System Administrator Guide
256 OL-10663-02
Creating Phone Configurations Using Extension Assigner
Configuration Examples for Extension Assigner
!
ephone 1
provision-tag 101
mac-address 02EA.EAEA.0001
button 1:1
!
ephone 2
provision-tag 102
mac-address 02EA.EAEA.0002
button 1:2
!
ephone 3
provision-tag 103
mac-address 02EA.EAEA.0003
button 1:3
!
ephone 4
provision-tag 104
mac-address 02EA.EAEA.0004
button 1:4
!
ephone 5
provision-tag 105
mac-address 02EA.EAEA.0005
button 1:5
!
kron occurrence backup in 30 recurring
policy-list writeconfig
!
kron policy-list writeconfig
cli write
!
line con 0
line aux 0
line vty 0 4
logging synchronous
!
no scheduler max-task-time
scheduler allocate 20000 1000
!
end
Extension Assigner Synchronization: Example
Primary Router: Example
The extension assigner is authorized to send configuration change information from the primary router
to the secondary backup router.
telephony-service
standby username user555 password purplehat
Secondary Backup Router: Example
System components are enabled and the XML interface is readied to receive configuration change
information.
ip http server
ixi transport http
no shutdown
ixi application cme
no shutdown
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 257
Creating Phone Configurations Using Extension Assigner
Additional References
telephony-service
xml user user555 password purplehat 15
Additional References
The following sections provide references related to extension assigner.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
258 OL-10663-02
Creating Phone Configurations Using Extension Assigner
Feature Information for Extension Assigner
Feature Information for Extension Assigner
Table 15 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 15 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 15 Feature Information for Extension Assigner
Cisco Unified CME
Feature Name Version Feature Information
Extension Assigner Synchronization 4.2(1) Enables the secondary backup router to automatically
receive any changes made to ephone mac-addresess in the
primary router.
Extension Assigner 4.0(3) Enables installation technicians to assign extension
numbers to Cisco Unified CME phones without accessing
the server.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 259
Creating Phone Configurations Using Extension Assigner
Feature Information for Extension Assigner
Cisco Unified Communications Manager Express System Administrator Guide
260 OL-10663-02
Generating Configuration Files for Phones
Last Updated: March 26, 2007
This chapter describes how to generate configuration files for Cisco Unified IP phones that are
connected to a Cisco Unified Communications Manager Express (Cisco Unified CME) router.
Contents
• Information About Configuration Files, page 261
• How to Generate Configuration Files for Phones, page 263
• Where to Go Next, page 270
• Additional References, page 270
Information About Configuration Files
To generate configuration files for phones in Cisco Unified CME, you should understand the following
concepts:
• Configuration Files for Phones in Cisco Unified CME, page 261
• Per-Phone Configuration Files, page 262
Configuration Files for Phones in Cisco Unified CME
When a phone requests service from Cisco Unified CME, the registrar confirms the username, i.e. the
phone number for the phone. The phone accesses its configuration profile on the TFTP server, typically
the Cisco Unified CME router, and processes the information contained in the file, registers itself, and
puts the phone number on the phone console display.
Minimally, a configuration profile contains the MAC address, the type, and the number phone number
that is permitted by the registrar to handle the Register message for a particular Cisco Unified IP phone.
Any time you create or modify parameters for either an individual phone or a directory number, generate
a new phone configuration to properly propagate the parameters.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 261
Generating Configuration Files for Phones
Information About Configuration Files
By default, there is one shared XML configuration file located in system:/its/ for all Cisco Unified IP
phones that are running SCCP. For SIP phones directly connected to Cisco Unified CME, an individual
configuration profile is created for each phone and stored in system:/cme/sipphone/.
When an IP phone comes online or is rebooted, it automatically gets information about itself from the
appropriate configuration file.
The Cisco universal application loader for phone firmware files allows you to add additional phone
features across all protocols. To do this, a hunt algorithm searches for multiple configuration files. After
a phone is reset or restarted, the phone automatically selects protocol depending on which matching
configuration file is found first. To ensure that Cisco Unified IP phones download the appropriate
configuration for the desired protocol, SCCP or SIP, you must properly configure the IP phones before
connecting or rebooting the phones. The hunt algorithm searches for files in the following order:
1. CTLSEP<mac> file for a SCCP phone—For example, CTLSEP003094C25D2E.tlv
2. SEP <mac> file for a SCCP phone—For example, SEP003094C25D2E.cnf.xml
3. SIP <mac> file for a SIP phone—For example, SIP003094C25D2E.cnf or gk003069C25D2E
4. XML default file for SCCP phones—For example, SEPDefault.cnf.xmls
5. XML default file for SIP phones—For example, SIPDefault.cnf.
In Cisco Unified CME 4.0 and later for SCCP and in Cisco CME 3.4 and later for SIP, you can designate
one of the following locations in which to store configuration files:
• System (Default)—For SCCP phones, one configuration file is created, stored, and used for all
phones in the system. For SIP phones, an individual configuration profile is created for each phone.
• Flash or slot 0—When flash or slot 0 memory on the router is the storage location, you can create
additional configuration files to be applied per phone type or per individual phone, such as user or
network locales.
• TFTP—When an external TFTP server is the storage location, you can create additional
configuration files to be applied per phone type or per individual phone, which are required for
multiple user and network locales.
Per-Phone Configuration Files
If configurations files for SCCP phones are to be stored somewhere other than in the default location,
the following individual configuration files can be created for SCCP phones:
• Per phone type—Creates separate configuration files for each phone type and all phones of the same
type use the same configuration file. This method is not supported if the configuration files are to
be stored in the system location.
• Per phone—Creates a separate configuration file for each phone, by MAC address. This method is
not supported if the configuration files are to be stored in the system location.
For configuration information, see the “SCCP: Defining Per-Phone Configuration Files and Alternate
Location” section on page 119.
Cisco Unified Communications Manager Express System Administrator Guide
262 OL-10663-02
Generating Configuration Files for Phones
How to Generate Configuration Files for Phones
How to Generate Configuration Files for Phones
This section contains the following tasks:
• SCCP: Generating Configuration Files for SCCP Phones, page 263
• SCCP: Verifying Configuration Files for SCCP Phones, page 264
• SIP: Generating Configuration Profiles for SIP Phones, page 265
• SIP: Verifying Configuration Profiles for SIP Phones, page 267
SCCP: Generating Configuration Files for SCCP Phones
To generate the configuration profile files that are required by the SCCP phones in Cisco Unified CME
and write them to either system memory or to the location specified by the cnf-file location command,
follow the steps in this section.
Restrictions
• Externally stored and per-phone configuration files are not supported on the Cisco Unified IP Phone
7902G, 7910, 7910G, or 7920, or the Cisco Unified IP Conference Station 7935 and 7936.
• TFTP does not support file deletion. When configuration files are updated, they overwrite any
existing configuration files with the same name. If you change the configuration file location, files
are not deleted from the TFTP server.
• Generating configuration files on flash or slot 0 can take up to a minute, depending on the number
of files being generated.
• For smaller routers such as Cisco 2600 series routers, you must manually enter the squeeze
command to erase files after changing the configuration file location or entering any commands that
trigger the deletion of configuration files. Unless you use the squeeze command, the space used by
the moved or deleted configuration files is not usable by other files.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. create cnf-files
5. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 263
Generating Configuration Files for Phones
How to Generate Configuration Files for Phones
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 create cnf-files Builds the XML configuration files required for IP phones.
Example:
Router(config-telephony)# create cnf-files
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
SCCP: Verifying Configuration Files for SCCP Phones
To verify the Cisco Unified CME phone configuration, perform the following steps.
SUMMARY STEPS
1. show telephony-service all
2. show telephony-service tftp-bindings
DETAILED STEPS
Step 1 show telephony-service all
Use this command to verify the configuration for phones, directory numbers, voice ports, and dial peers
in Cisco Unified CME.
Router# show telephony-service all
CONFIG (Version=4.0(0))
=====================
Version 4.0(0)
Cisco Unified CallManager Express
For on-line documentation please see:
www.cisco.com/en/US/products/sw/voicesw/ps4625/tsd_products_support_series_home.html
ip source-address 10.0.0.1 port 2000
Cisco Unified Communications Manager Express System Administrator Guide
264 OL-10663-02
Generating Configuration Files for Phones
How to Generate Configuration Files for Phones
max-ephones 24
max-dn 24
dialplan-pattern 1 408734....
voicemail 11111
transfer-pattern 510734....
keepalive 30
ephone-dn 1
number 5001
huntstop
ephone-dn 2
number 5002
huntstop
call-forward noan 5001 timeout 8
Step 2 show telephony-service tftp-bindings
Use this command to display the current configuration files accessible to IP phones.
Router# show telephony-service tftp-bindings
tftp-server system:/its/SEPDEFAULT.cnf
tftp-server system:/its/SEPDEFAULT.cnf alias SEPDefault.cnf
tftp-server system:/its/XMLDefault.cnf.xml alias XMLDefault.cnf.xml
tftp-server system:/its/ATADefault.cnf.xml
tftp-server system:/its/XMLDefault7960.cnf.xml alias SEP00036B54BB15.cnf.xml
tftp-server system:/its/germany/7960-font.xml alias German_Germany/7960-font.xml
tftp-server system:/its/germany/7960-dictionary.xml alias
German_Germany/7960-dictionary.xml
tftp-server system:/its/germany/7960-kate.xml alias German_Germany/7960-kate.xml
tftp-server system:/its/germany/SCCP-dictionary.xml alias
German_Germany/SCCP-dictionary.xml
tftp-server system:/its/germany/7960-tones.xml alias Germany/7960-tones.xml
SIP: Generating Configuration Profiles for SIP Phones
To generate the configuration profile files that are required by the SIP phones in Cisco Unified CME and
write them to the location specified by the tftp-path (voice register global) command, follow the steps
in this section.
Any time you create or modify parameters under the voice register dn or voice register pool
configuration modes, generate a new configuration profile and properly propagate the parameters.
Caution If your Cisco Unified CME system supports SCCP and also SIP phones, do not connect your SIP phones
to the network until after you have verified the phone configuration profiles.
Prerequisites
• Cisco Unified CME 3.4 or a later version.
• The mode cme command must be enabled in Cisco Unified CME.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 265
Generating Configuration Files for Phones
How to Generate Configuration Files for Phones
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. file text
5. create profile
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Step 4 file text (Optional) Generates ASCII text files of the configuration
profiles generated for Cisco Unified IP Phone 7905s and
7905Gs, Cisco Unified IP Phone 7912s and 7912Gs,
Example:
Router(config-register-global)# file text
Cisco ATA-186, or Cisco ATA-188.
• Default—System generates binary files to save disk
space.
Step 5 create profile Generates configuration profile files required for SIP
phones and writes the files to the location specified with
tftp-path command.
Example:
Router(config-register-global;)# create profile
Step 6 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-global)# end
Cisco Unified Communications Manager Express System Administrator Guide
266 OL-10663-02
Generating Configuration Files for Phones
How to Generate Configuration Files for Phones
SIP: Verifying Configuration Profiles for SIP Phones
To verify the configuration profiles, perform the following steps. SIP phones to be connected to
Cisco Unified CME can register and minimally, have an assigned phone number, only if the
configuration is correct.
SUMMARY STEPS
1. show voice register tftp-bind
2. show voice register profile
3. more system
DETAILED STEPS
Step 1 show voice register tftp-bind
Use this command to display a list of configuration profiles that are accessible to SIP phones using
TFTP. The file name includes the MAC address for each SIP phone, such as SIP<mac-address>.cnf.
Verify that a configuration profile is available for each SIP phone in Cisco Unified CME.
The following is sample output from this command:
Router(config)# show voice register tftp-bind
tftp-server SIPDefault.cnf url system:/cme/sipphone/SIPDefault.cnf
tftp-server syncinfo.xml url system:/cme/sipphone/syncinfo.xml
tftp-server SIP0009B7F7532E.cnf url system:/cme/sipphone/SIP0009B7F7532E.cnf
tftp-server SIP000ED7DF7932.cnf url system:/cme/sipphone/SIP000ED7DF7932.cnf
tftp-server SIP0012D9EDE0AA.cnf url system:/cme/sipphone/SIP0012D9EDE0AA.cnf
tftp-server gk123456789012 url system:/cme/sipphone/gk123456789012
tftp-server gk123456789012.txt url system:/cme/sipphone/gk123456789012.txt
Step 2 show voice register profile
Use this command to display the contents of the ASCII format configuration profile for a particular voice
register pool.
Note To generate ASCII text files of the configuration profiles for Cisco Unified IP Phone 7905s and 7905Gs,
Cisco Unified IP Phone 7912s and 7912Gs, Cisco ATA-186s, and Cisco ATA-188s, use the file text
command.
The following is sample output from this command displaying information in the configuration profile
for voice register pool 4.
Router# show voice register profile text 4
Pool Tag: 4
# txt
AutoLookUp:0
DirectoriesUrl:0
…
CallWaiting:1
CallForwardNumber:0
Conference:1
AttendedTransfer:1
BlindTransfer:1
…
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 267
Generating Configuration Files for Phones
How to Generate Configuration Files for Phones
SIPRegOn:1
UseTftp:1
UseLoginID:0
UIPassword:0
NTPIP:0.0.0.0
UID:2468
Step 3 more system
Use this command to display the contents of the configuration profile for a particular Cisco Unified IP
Phone 7940, Cisco Unified IP Phone 7905G, Cisco Unified IP Phone 7960, or Cisco Unified IP Phone
7960G.
The following is sample output from this command displaying information in two SIP configuration
profile files. The SIPDefault.cnf configuration profile is a shared file and SIP<MAC address>.cnf is the
SIP configuration profile for the SIP phone with the designated MAC address.
Router# more system:/cme/sipphone/SIPDefault.cnf
image_version: "P0S3-07-4-00";
proxy1_address: "10.1.18.100";
proxy2_address: "";
proxy3_address: "";
proxy4_address: "";
proxy5_address: "";
proxy6_address: "";
proxy1_port: "5060";
proxy2_port: "";
proxy3_port: "";
proxy4_port: "";
proxy5_port: "";
proxy6_port: "";
proxy_register: "1";
time_zone: "EST";
dst_auto_adjust: "1";
dst_start_month: "April";
dst_start_day: "";
dst_start_day_of_week: "Sun";
dst_start_week_of_month: "1";
dst_start_time: "02:00";
dst_stop_month: "October";
dst_stop_day: "";
dst_stop_day_of_week: "Sun";
dst_stop_week_of_month: "8";
dst_stop_time: "02:00";
date_format: "M/D/Y";
time_format_24hr: "0";
local_cfwd_enable: "1";
directory_url: "";
messages_uri: "2000";
services_url: "";
logo_url: "";
stutter_msg_waiting: "0";
sync: "0000200155330856";
telnet_level: "1";
autocomplete: "1";
call_stats: "0";
Domain_Name: "";
dtmf_avt_payload: "101";
dtmf_db_level: "3";
dtmf_inband: "1";
dtmf_outofband: "avt";
dyn_dns_addr_1: "";
dyn_dns_addr_2: "";
Cisco Unified Communications Manager Express System Administrator Guide
268 OL-10663-02
Generating Configuration Files for Phones
How to Generate Configuration Files for Phones
dyn_tftp_addr: "";
end_media_port: "32766";
http_proxy_addr: "";
http_proxy_port: "80";
nat_address: "";
nat_enable: "0";
nat_received_processing: "0";
network_media_type: "Auto";
network_port2_type: "Hub/Switch";
outbound_proxy: "";
outbound_proxy_port: "5060";
proxy_backup: "";
proxy_backup_port: "5060";
proxy_emergency: "";
proxy_emergency_port: "5060";
remote_party_id: "0";
sip_invite_retx: "6";
sip_retx: "10";
sntp_mode: "directedbroadcast";
sntp_server: "0.0.0.0";
start_media_port: "16384";
tftp_cfg_dir: "";
timer_invite_expires: "180";
timer_register_delta: "5";
timer_register_expires: "3600";
timer_t1: "500";
timer_t2: "4000";
tos_media: "5";
voip_control_port: "5060";
Router# more system:/cme/sipphone/SIP000CCE62BCED.cnf
image_version: "P0S3-07-4-00";
user_info: "phone";
line1_name: "1051";
line1_displayname: "";
line1_shortname: "";
line1_authname: "1051";
line1_password: "ww";
line2_name: "";
line2_displayname: "";
line2_shortname: "";
line2_authname: "";
line2_password: "";
auto_answer: "0";
speed_line1: "";
speed_label1: "";
speed_line2: "";
speed_label2: "";
speed_line3: "";
speed_label3: "";
speed_line4: "";
speed_label4: "";
speed_line5: "";
speed_label5: "";
call_hold_ringback: "0";
dnd_control: "0";
anonymous_call_block: "0";
callerid_blocking: "0";
enable_vad: "0";
semi_attended_transfer: "1";
call_waiting: "1";
cfwd_url: "";
cnf_join_enable: "1";
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 269
Generating Configuration Files for Phones
Where to Go Next
phone_label: "";
preferred_codec: "g711ulaw";
Where to Go Next
After you generate a configuration file for a Cisco Unified IP phone connected to the
Cisco Unified CME router, you are ready to download the file to the phone. See “Resetting and
Restarting Phones” on page 271.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
270 OL-10663-02
Resetting and Restarting Phones
Last Updated: August 1, 2008
This chapter describes how to reset or restart Cisco Unified IP phones that are connected to
Cisco Unified Communications Manager Express (Cisco Unified CME).
Contents
• Information About Resetting and Restarting Phones, page 271
• How to Reset and Restart Phones, page 273
• Additional References, page 280
Information About Resetting and Restarting Phones
Before resetting and restarting IP phones in Cisco Unified CME, you should understand the following
concept:
• Differences between Resetting and Restarting IP Phones, page 271
• Cisco Unified CME TAPI Enhancement, page 272
Differences between Resetting and Restarting IP Phones
Cisco Unified IP phones must be rebooted after configuration changes in order for the changes to be
effective. Configurations for phones in Cisco Unified CME are downloaded when a phone is rebooted
or reset. You can reboot a single phone or you can reboot all phones in a Cisco Unified CME system.
The differences between reboot types are summarized in Table 16.
Note When rebooting multiple IP phones, it is possible for a conflict to occur if too many phones attempt to
access changed Cisco Unified CME configuration information via TFTP simultaneously.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 271
Resetting and Restarting Phones
Information About Resetting and Restarting Phones
Table 16 reset and restart Command Differences
reset Command restart Command
Type of Reboot Similar to power-off, power-on reboot. Quick restart.
Phone Configurations Downloads configurations for IP phones. Downloads configurations for IP phones.
DHCP and TFTP Contacts DHCP and TFTP servers for updated Phones contact the TFTP server for updated
configuration information. configuration information and reregister without
contacting the DHCP server.
Note This command was introduced for SIP
phones in Cisco CME 3.4. Note This command was introduced for SIP
phones in Cisco Unified CME 4.1.
Processing Time Takes longer to process when updating multiple Faster processing for multiple phones.
phones.
When Required • Date and time settings • Directory numbers
• Network locale • Phone buttons
• Phone firmware • Speed-dial numbers
• Source address
• TFTP path
• URL parameters
• User locale
• Voicemail access number
Can be used when updating the following:
• Directory numbers
• Phone buttons
• Speed-dial numbers
Cisco Unified CME TAPI Enhancement
Before Cisco Unified CME 7.0(1), the only method to clear a session between a Microsoft Windows
Workstation and an SCCP phone that was out-of-sync was to reboot the router. In Cisco Unified CME
7.0(1) and later versions, you can clear a Telephony Application Programming Interface (TAPI) session
that is in a frozen state or out of synchronization by using a Cisco IOS software command. For
configuration information, see the“SCCP: Resetting a Session Between a TAPI Application and an
SCCP Phone” section on page 276.
This enhancement also automatically handles ephone-TAPI registration error conditions. No additional
configuration is required for this new feature.
Cisco Unified Communications Manager Express System Administrator Guide
272 OL-10663-02
Resetting and Restarting Phones
How to Reset and Restart Phones
How to Reset and Restart Phones
Note If phones are not yet plugged in, resetting or restarting phones is not necessary. Instead, connect your IP
phones to your network to boot the phone and download the required configuration files.
This sections contains the following tasks:
• SCCP: Using the reset Command, page 273 (Required)
• SCCP: Using the restart Command, page 274 (Required)
• SCCP: Resetting a Session Between a TAPI Application and an SCCP Phone, page 276 (Required)
• SIP: Using the reset Command, page 277 (Required)
• SIP: Using the restart Command, page 278 (Required)
• Verifying Basic Calling, page 279 (Optional)
SCCP: Using the reset Command
To reboot and reregister one or more SCCP phones, including contacting the DHCP server for updated
information, perform the following steps.
Prerequisites
• Phones to be rebooted are connected to the Cisco Unified CME router.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
or
ephone phone-tag
4. reset {all [time-interval] | cancel | mac-address mac-address | sequence-all}
or
reset
5. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 273
Resetting and Restarting Phones
How to Reset and Restart Phones
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
or
or
ephone ephone-tag
Enters ephone configuration mode.
Example:
Router(config)# telephony-service
or
Router(config)# ephone 1
Step 4 reset {all [time-interval] | cancel | Performs a complete reboot of the specified or all phones
mac-address mac-address | sequence-all} running SCCP, including contacting the DHCP and TFTP
or servers for the latest configuration information.
reset
or
Performs a complete reboot of the individual SCCP phone
Example: being configured.
Router(config-telephony)# reset all
or
Router(config-ephone)# reset
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
or
Router(config-ephone)# end
SCCP: Using the restart Command
To fast reboot and reregister one or more SCCP phones, perform the following steps.
Prerequisites
• Phones to be rebooted are connected to the Cisco Unified CME router.
Cisco Unified Communications Manager Express System Administrator Guide
274 OL-10663-02
Resetting and Restarting Phones
How to Reset and Restart Phones
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
or
ephone ephone-tag
4. restart {all [time-interval] | mac-address}
or
restart
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
or
or
ephone ephone-tag
Enters ephone configuration mode.
Example:
Router(config)# telephony-service
or
Router(config)# ephone 1
Step 4 restart {all [time-interval] | mac-address} Performs a fast reboot of the specified phone or all phones
or running SCCP associated with this Cisco Unified CME
router. Does not contact the DHCP server for updated
restart
information.
or
Example:
Router(config-telephony)# restart all Performs a fast reboot of the individual SCCP phone being
or configured.
Router(config-ephone)# restart
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 275
Resetting and Restarting Phones
How to Reset and Restart Phones
SCCP: Resetting a Session Between a TAPI Application and an SCCP Phone
To clear a TAPI session that is in a frozen state or out of synchronization, perform the following steps.
Prerequisites
• Cisco Unified CME 7.0(1) or a later version
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. reset tapi
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies
Example: this ephone during configuration tasks.
Router(config)# ephone 36
Step 4 reset tapi Resets the connection between a Telephony Application
Programmer's Interface (TAPI) application and the SCCP
phone.
Example:
Router(config-ephone)# reset tapi
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Cisco Unified Communications Manager Express System Administrator Guide
276 OL-10663-02
Resetting and Restarting Phones
How to Reset and Restart Phones
SIP: Using the reset Command
To reboot and reregister one or more SIP phones, including contacting the DHCP server for updated
information, perform the following steps.
Prerequisites
• Cisco Unified CME 3.4 or later.
• The mode cme command must be enabled in Cisco Unified CME.
• Phones to be rebooted are connected to the Cisco Unified CME router.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
or
voice register pool pool-tag
4. reset
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 277
Resetting and Restarting Phones
How to Reset and Restart Phones
Command or Action Purpose
Step 3 voice register global Enters voice register global configuration mode to set
or parameters for all supported SIP phones in
voice register pool pool-tag Cisco Unified CME.
or
Example: Enters voice register pool configuration mode to set
Router(config)# voice register global phone-specific parameters for SIP phones
or
Router(config)# voice register pool 1
Step 4 reset Performs a complete reboot of all phones connected to this
router that are running SIP, including contacting the DHCP
and TFTP servers for the latest configuration information.
Example:
Router(config-register-global)# reset or
or
Performs a complete reboot of the individual SIP phone
Router(config-register-pool)# reset being configured.
Step 5 end Exits to privileged EXEC mode.
Example:
Router(config-register-global)# end
or
Router(config-register-pool)# end
SIP: Using the restart Command
To fast reboot and reregister one or more SIP phones, perform the following steps.
Prerequisites
• Cisco Unified CME 4.1 or later.
• The mode cme command must be enabled in Cisco Unified CME.
• Phones to be rebooted are connected to the Cisco Unified CME router.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
or
voice register pool pool-tag
4. restart
5. end
Cisco Unified Communications Manager Express System Administrator Guide
278 OL-10663-02
Resetting and Restarting Phones
How to Reset and Restart Phones
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to set
or parameters for all supported SIP phones in
voice register pool pool-tag Cisco Unified CME.
or
Example: Enters voice register pool configuration mode to set
Router(config)# voice register global phone-specific parameters for SIP phones
or
Router(config)# voice register pool 1
Step 4 restart Performs a fast reboot all SIP phones associated with this
Cisco Unified CME router. Does not contact the DHCP
server for updated information.
Example:
Router(config-register-global)# restart or
or
Performs a fast reboot of the individual SIP phone being
Router(config-register-pool)# restart configured.
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-global)# end
or
Router(config-register-pool)# end
Verifying Basic Calling
To verify that Cisco IP phones in Cisco Unified CME can place and receive calls through the voice ports,
perform the following steps.
SUNNARY STEPS
1. Test local operation.
2. Test local calling area.
3. Test incoming calls.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 279
Resetting and Restarting Phones
Additional References
DETAILED STEPS
Step 1 Test local phone operation. Make calls between phones on the Cisco Unified CME router.
Step 2 Place a call from a phone in Cisco Unified CME to a number in the local calling area.
Step 3 Place a call to a phone in Cisco Unified CME from a phone outside this Cisco Unified CME system.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
280 OL-10663-02
Resetting and Restarting Phones
Feature Information for Cisco Unified CME 7.0(1) New Features
Feature Information for Cisco Unified CME 7.0(1) New Features
Table 17 lists the features in this document and provides links to specific configuration information.
Not all commands may be available in your Cisco IOS software release. For release information about a
specific command, see the command reference documentation.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 17 lists only the Cisco IOS software release that introduced support for a given feature in a given
Cisco IOS software release train. Unless noted otherwise, subsequent releases of that Cisco IOS
software release train also support that feature.
Table 17 Feature Information for Cisco Unified CME 7.0(1) New Features
Cisco Unified CME
Feature Name Version Feature Information
Cisco Unified CME TAPI Enhancement 7.0(1) Disassociates and reestablishes a TAPI session that is in a
frozen state or out of synchronization by using a Cisco IOS
command. This enhancement also automatically handles
ephone-TAPI registration error conditions.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 281
Resetting and Restarting Phones
Feature Information for Cisco Unified CME 7.0(1) New Features
Cisco Unified Communications Manager Express System Administrator Guide
282 OL-10663-02
Configuring Dialing Plans
Last Updated: January 29, 2009
This chapter describes features that enable Cisco Unified Communications Manager Express
(Cisco Unified CME) to expand or manipulate internal extension numbers so that they conform to
numbering plans used by external systems.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Dialing Plan Features”
section on page 303.
Contents
• Information About Dialing Plans, page 283
• How to Configure Dialing Plans, page 287
• Configuration Examples for Dialing Plan Features, page 300
• Additional References, page 302
• Feature Information for Dialing Plan Features, page 303
Information About Dialing Plans
To design and configure dialing plans, you should understand the following concepts:
• Phone Number Plan, page 284
• Dial-Plan Patterns, page 285
• Direct Inward Dialing Trunk Lines, page 286
• Voice Translation Rules and Profiles, page 286
• Secondary Dial Tone, page 286
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 283
Configuring Dialing Plans
Information About Dialing Plans
Phone Number Plan
If you install a Cisco Unified CME system to replace an older telephony system that had an established
telephone number plan, you can retain the old number plan. Cisco Unified CME supports flexible
extension number lengths and can provide automatic conversion between extension dialing and E.164
public telephone number dialing.
When a router receives a voice call, it selects an outbound dial peer by comparing the called number (the
full E.164 telephone number) in the call information with the number configured as the destination
pattern for the POTS dial peer. The router then strips out the left-justified numbers corresponding to the
destination pattern matching the called number. If you have configured a prefix, the prefix will be put in
front of the remaining numbers, creating a dial string, which the router will then dial. If all numbers in
the destination pattern are stripped-out, the user will receive (depending on the attached equipment) a
dial tone.
A successful Cisco Unified CME system requires a telephone numbering plan that supports future
expansion. The numbering plan also must not overlap or conflict with other numbers that are on the same
VoIP network or are part of a centralized voice mail system.
Cisco Unified CME supports shared lines and multiple lines configured with the same extension number.
This means that you can set up several phones to share an extension number to provide coverage for that
number. You can also assign several line buttons on a single phone to the same extension number to
create a small hunt group. For more information about types of line configurations, see “Configuring
Phones to Make Basic Calls” on page 139.
If you are configuring more than one Cisco Unified CME site, you need to decide how calls between the
sites will be handled. Calls between Cisco Unified CME phones can be routed either through the PSTN
or over VoIP. If you are routing calls over VoIP, you must decide among the following three choices:
• You can route calls using a global pool of fixed-length extension numbers. For example, all sites
have unique extension numbers in the range 5000 to 5999, and routing is managed by a gatekeeper.
If you select this method, assign a subrange of extension numbers to each site so that duplicate
number assignment does not result. You will have to keep careful records of which
Cisco Unified CME system is assigned which number range.
• You can route calls using a local extension number plus a special prefix for each Cisco Unified CME
site. This choice allows you to use the same extension numbers at more than one site.
• You can use an E.164 PSTN phone number to route calls over VoIP between Cisco Unified CME
sites. In this case, intersite callers use the PSTN area code and local prefix to route calls between
Cisco Unified CME systems.
If you choose to have a gatekeeper route calls among multiple Cisco Unified CME systems, you may
face additional restrictions on the extension number formats that you use. For example, you might be
able to register only PSTN-formatted numbers with the gatekeeper. The gatekeeper might not allow the
registration of duplicate telephone numbers in different Cisco Unified CME systems, but you might be
able to overcome this limitation. Cisco Unified CME allows the selective registration of either 2- to
5-digit extension numbers or 7- to 10-digit PSTN numbers, so registering only PSTN numbers might
prevent the gatekeeper from sensing duplicate extensions.
Mapping of public telephone numbers to internal extension numbers is not restricted to simple truncation
of the digit string. Digit substitutions can be made by defining dial-plan patterns to be matched. For
information about dial plans, see the “Dial-Plan Patterns” section on page 285. More sophisticated
number manipulations can be managed with voice translation rules and voice translation profiles, which
are described in the “Voice Translation Rules and Profiles” section on page 286.
Cisco Unified Communications Manager Express System Administrator Guide
284 OL-10663-02
Configuring Dialing Plans
Information About Dialing Plans
In addition, your selection of a numbering scheme for phones that can be directly dialed from the PSTN
is limited by your need to use the range of extensions that are assigned to you by the telephone company
that provides your connection to the PSTN. For example, if your telephone company assigns you a range
from 408 555-0100 to 408 555-0199, you may assign extension numbers only in the range 100 to 199 if
those extensions are going to have Direct Inward Dialing (DID) access. For more information about
DID, see the “Direct Inward Dialing Trunk Lines” section on page 286.
Dial-Plan Patterns
A dial-plan pattern enables abbreviated extensions to be expanded into fully qualified E.164 numbers.
Use dial-plan patterns when configuring a network with multiple Cisco Unified CMEs to ensure that the
appropriate calling number, extension or E.164 number, is provided to the target Cisco Unified CME,
and appears on the phone display of the called phone. In networks that have a single router, you do not
need to use dial-plan patterns.
.When you define a directory number for an SCCP phone, the Cisco Unified CME system automatically
creates a POTS dial peer with the ephone-dn endpoint as a destination. For SIP phones connected
directly into Cisco Unified CME, the dial peer is automatically created when the phone registers. By
default, Cisco Unified CME creates a single POTS dial peer for each directory number.
For example, when the ephone-dn with the number 1001 was defined, the following POTS dial peer was
automatically created for it:
dial-peer voice 20001 pots
destination-pattern 1001
voice-port 50/0/2
A dial-plan pattern builds additional dial peers for the expanded numbers it creates. If a dialplan pattern
is configured and it matches against a directory number, two POTS dial peers are created, one for the
abbreviated number and one for the complete E.164 direct-dial telephone number.
For example, if you then define a dial-plan pattern that 1001 will match, such as 40855500.., a second
dial peer is created so that calls to both the 0001 and 4085550001 numbers are completed. In this
example, the additional dial peer that is automatically created looks like the following:
dial-peer voice 20002 pots
destination-pattern 40855510001
voice-port 50/0/2
In networks with multiple routers, you may need to use dial-plan patterns to expand extensions to E.164
numbers because local extension numbering schemes can overlap each other. Networks with multiple
routers have authorities such as gatekeepers that route calls through the network. These authorities
require E.164 numbers so that all numbers in the network are unique. Define dial-plan patterns to expand
extension numbers into unique E.164 numbers for registering with a gatekeeper.
If multiple dial-plan patterns are defined, the system matches extension numbers against the patterns in
sequential order, starting with the lowest numbered dial-plan pattern tag first. Once a pattern matches
an extension number, the pattern is used to generate an expanded number. If additional patterns
subsequently match the extension number, they are not used.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 285
Configuring Dialing Plans
Information About Dialing Plans
Direct Inward Dialing Trunk Lines
Direct Inward Dialing (DID), is a one-way incoming trunking mechanism, that allows an external caller
to directly reach a specific extension without the call being served by an attendant or other intervention.
It is a service offered in which the last few (typically three or four) digits dialed by the caller are
forwarded to the called party on a special DID trunk. For example, all the phone numbers from 555-0000
to 555-0999 could be assigned to a company with 20 DID trunks. When a caller dials any number in this
range, the call is forwarded on any available trunk. If the caller dialed 555-0234, then the digits 2, 3, and
4 are forwarded. These DID trunks could be terminated on a PBX, so that the extension 234 gets the call
without operator assistance. This makes it look as though 555-0234 and the other 999 lines all have direct
outside lines, while only requiring 20 trunks to service the 1,000 telephone extensions. Using DID, a
company can offer its customers individual phone numbers for each person or workstation within the
company without requiring a physical line into the PBX for each possible connection. Compared to
regular PBX service, DID saves the cost of a switchboard operator. Calls go through faster, and callers
feel they are calling a person rather than a company.
Dial-plan patterns are required to enable calls to DID numbers. When the PSTN connects a DID call for
“4085550234” to the Cisco Unified CME system, it also forwards the extension digits “234” to allow the
system to route the call.
Voice Translation Rules and Profiles
Translation rules manipulate dialed numbers to conform to internal or external numbering schemes.
Voice translation profiles allow you to group translation rules together and apply them to the following
types of numbers:
• Called numbers (DNIS)
• Calling numbers (ANI)
• Redirected called numbers
• Redirected target numbers—These are transfer-to numbers and call-forwarding final destination
numbers. Supported by SIP phones in Cisco Unified CME 4.1 and later versions.
After you define a set of translation rules and assign them to a translation profile, you can apply the rules
to incoming and outgoing call legs to and from the Cisco Unified CME router based on the directory
number. Translation rules can perform regular expression matches and replace substrings. A translation
rule replaces a substring of the input number if the number matches the match pattern, number plan, and
type present in the rule.
For configuration information, see the “Defining Voice Translation Rules in Cisco CME 3.2 and Later
Versions” section on page 291.
For examples of voice translation rules and profiles, see the “Voice Translation Rules” technical note
and the “Number Translation using Voice Translation Profiles” technical note.
Secondary Dial Tone
A secondary dial tone is available for Cisco Unified IP phones connected to Cisco Unified CME. The
secondary dial tone is generated when a phone user dials a predefined PSTN access prefix and terminates
when additional digits are dialed. An example is when a secondary dial tone is heard after a PSTN access
prefix, such as the number 9, is dialed to reach an outside line. For configuration information, see the
“Activating a Secondary Dial Tone” section on page 299.
Cisco Unified Communications Manager Express System Administrator Guide
286 OL-10663-02
Configuring Dialing Plans
How to Configure Dialing Plans
How to Configure Dialing Plans
This section contains the following tasks:
Dial-Plan Patterns
• SCCP: Configuring Dial-Plan Patterns, page 287 (required)
• SIP: Configuring Dial-Plan Patterns, page 288 (required)
• Verifying Dial-Plan Patterns, page 290 (optional)
Voice Translation Rules
• Defining Voice Translation Rules in Cisco CME 3.2 and Later Versions, page 291 (required)
• SCCP: Applying Voice Translation Rules in Cisco CME 3.2 and Later Versions, page 293 (required)
• SCCP: Applying Translation Rules Before Cisco CME 3.2, page 294 (required)
• SIP: Applying Voice Translation Rules in Cisco Unified CME 4.1 and Later, page 296 (required)
• SIP: Applying Voice Translation Rules before Cisco Unified CME 4.1, page 297 (required)
• Verifying Voice Translation Rules and Profiles, page 298 (optional)
Secondary Dial Tone
• Activating a Secondary Dial Tone, page 299 (optional)
SCCP: Configuring Dial-Plan Patterns
To define a dial-plan pattern, perform the following steps.
Tip In networks that have a single router, you do not need to define dial-plan patterns.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. dialplan-pattern tag pattern extension-length extension-length [extension-pattern
extension-pattern | no-reg]
5. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 287
Configuring Dialing Plans
How to Configure Dialing Plans
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 dialplan-pattern tag pattern extension-length length Maps a digit pattern for an abbreviated
[extension-pattern epattern] [no-reg] extension-number prefix to the full E.164 telephone
number pattern.
Example:
Router(config-telephony)# dialplan-pattern 1
4085550100 extension-length 3 extension-pattern 4..
Note This example maps all extension numbers 4xx to the
PSTN number 40855501xx, so that extension 412
corresponds to 4085550112.
Step 5 end Exits configuration mode and enters privileged
EXEC mode.
Example:
Router(config-telephony)# end
SIP: Configuring Dial-Plan Patterns
To create and apply a pattern for expanding individual abbreviated SIP extensions into fully qualified
E.164 numbers, follow the steps in this section. Dial-plan pattern expansion affects calling numbers and
for call forward using B2BUA, redirecting, including originating and last reroute, numbers for SIP
extensions in Cisco Unified CME.
Prerequisites
Cisco Unified CME 4.0 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
Cisco Unified Communications Manager Express System Administrator Guide
288 OL-10663-02
Configuring Dialing Plans
How to Configure Dialing Plans
4. dialplan-pattern tag pattern extension-length extension-length [extension-pattern
extension-pattern] [no-reg]
5. call-forward system redirecting-expanded
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Step 4 dialplan-pattern tag pattern extension-length Defines pattern that is used to expand abbreviated extension
extension-length [extension-pattern numbers of SIP calling numbers in Cisco Unified CME into
extension-pattern | no-reg]
fully qualified E.164 numbers.
Example:
Router(config-register-global)#
dialplan-pattern 1 4085550... extension-length
5
Step 5 call-forward system redirecting-expanded Applies dial-plan pattern expansion globally to redirecting,
including originating and last reroute, numbers for SIP
extensions in Cisco Unified CME for call forward using
Example:
Router(config-register-global)# call-forward
B2BUA.
system redirecting-expanded
Step 6 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-global)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 289
Configuring Dialing Plans
How to Configure Dialing Plans
Verifying Dial-Plan Patterns
To verify dial-plan pattern configurations, perform the following steps.
SUMMARY STEPS
1. show telephony-service
2. show telephony-service dial-peer
or
show dial-peer summary
DETAILED STEPS
Step 1 show telephony-service
Use this command to verify dial-plan patterns in the configuration.
The following example maps the extension pattern 4.. to the last three digits of the dial-plan pattern
4085550155:
telephony-service
dialplan-pattern 1 4085550155 extension-length 3 extension-pattern 4..
Step 2 SCCP: show telephony-service dial-peer
or
SIP: show dial-peer summary
Use the command to display dial peers that are automatically created by the dialplan-pattern command.
Use this command display the configuration for all VoIP and POTS dial peers configured for a router,
including dial peers created by using the dialplan-expansion (voice register) command.
The following example is output from the show dial-peer summary command displaying information
for four dial peers, one each for extensions 60001 and 60002 and because the dialplan-expansion
command is configured to expand 6.... to 4085555...., one each for 4085550001 and 4085550002. The
latter two dial peers will not appear in the running configuration.
Router# show dial-peer summary
AD PRE PASS OUT
TAG TYPE MIN OPER PREFIX DEST-PATTERN FER THRU SESS-TARGET STATT
20010 pots up up 60002$ 0 0
20011 pots up up 60001$ 0 9
20012 pots up up 5105555001$ 0 9
20013 pots up up 5105555002$ 0 0
Cisco Unified Communications Manager Express System Administrator Guide
290 OL-10663-02
Configuring Dialing Plans
How to Configure Dialing Plans
Defining Voice Translation Rules in Cisco CME 3.2 and Later Versions
To define voice translation rules and voice translation profiles, perform the following steps.
Note To configure translation rules for voice calls in Cisco CME 3.1 and earlier versions, see the "Cisco IOS
Voice, Video, and FAX Configuration Guide."
Prerequisites
• SCCP—Cisco CME 3.2 or a later version.
• SIP—Cisco Unified CME 4.1 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice translation-rule number
4. rule precedence /match-pattern/ /replace-pattern/
5. exit
6. voice translation-profile name
7. translate {called | calling | redirect-called | redirect-target} translation-rule-number
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice translation-rule number Defines a translation rule for voice calls and enters voice
translation-rule configuration mode.
Example: • number—Number that identifies the translation rule.
Router(config)# voice translation-rule 1 Range: 1 to 2147483647.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 291
Configuring Dialing Plans
How to Configure Dialing Plans
Command or Action Purpose
Step 4 rule precedence /match-pattern/ Defines a translation rule.
/replace-pattern/
• precedence—Priority of the translation rule.
Range: 1 to 15.
Example:
Router(cfg-translation-rule)# rule 1 /^9/ //
• match-pattern—Stream Editor (SED) expression used
to match incoming call information. The slash (/) is a
delimiter in the pattern.
• replace-pattern—SED expression used to replace the
match pattern in the call information. The slash (/) is a
delimiter in the pattern.
Step 5 exit Exits voice translation-rule configuration mode.
Example:
Router(cfg-translation-rule)# exit
Step 6 voice translation-profile name Defines a translation profile for voice calls.
• name—Name of the translation profile. Maximum
Example: length of the voice translation profile name is
Router(config)# voice translation-profile name1 31 alphanumeric characters.
Step 7 translate {called | calling | redirect-called | Associates a translation rule with a voice translation
redirect-target} translation-rule-number profile.
• called—Associates the translation rule with called
Example: numbers.
Router(cfg-translation-profile)# translate
called 1 • calling—Associates the translation rule with calling
numbers.
• redirect-called—Associates the translation rule with
redirected called numbers.
• redirect-target—Associates the translation rule with
transfer-to numbers and call-forwarding final
destination numbers. This keyword is supported by
SIP phones in Cisco Unified CME 4.1 and later
versions.
• translation-rule-number—Reference number of the
translation rule configured in Step 3.
Range: 1 to 2147483647.
Step 8 end Returns to privileged EXEC mode.
Example:
Router(cfg-translation-profile)# end
What to Do Next
• To apply voice translation profiles to SCCP phones connected to Cisco Unified CME 3.2 or a later
version, see the “SCCP: Applying Voice Translation Rules in Cisco CME 3.2 and Later Versions”
section on page 293.
Cisco Unified Communications Manager Express System Administrator Guide
292 OL-10663-02
Configuring Dialing Plans
How to Configure Dialing Plans
• To apply voice translation profiles to SIP phones connected to Cisco Unified CME 4.1 or a later
version, see the “SIP: Applying Voice Translation Rules in Cisco Unified CME 4.1 and Later”
section on page 296.
• To apply voice translation profiles to SIP phones connected to Cisco CME 3.4 or Cisco Unified
CME 4.0(x), see the “SIP: Applying Voice Translation Rules before Cisco Unified CME 4.1”
section on page 297.
SCCP: Applying Voice Translation Rules in Cisco CME 3.2 and Later Versions
To apply a voice translation profile to incoming or outgoing calls to or from a directory number on a
SCCP phone, perform the following steps.
Prerequisites
• Cisco CME 3.2 or a later version.
• Voice translation profile containing voice translation rules to be applied must be already configured.
For configuration information, see the “Defining Voice Translation Rules in Cisco CME 3.2 and
Later Versions” section on page 291.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn tag
4. translation-profile {incoming | outgoing} name
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 293
Configuring Dialing Plans
How to Configure Dialing Plans
Command or Action Purpose
Step 3 ephone-dn tag Enters ephone-dn configuration mode to create an
extension (ephone-dn) for a Cisco Unified IP phone line,
an intercom line, a paging line, a voice-mail port, or a
Example:
Router(config)# ephone-dn 1
message-waiting indicator (MWI).
• tag—Unique sequence number that identifies this
ephone-dn during configuration tasks. Range is
1 to the maximum number of ephone-dns allowed on
the router platform. See the CLI help for the maximum
value for this argument.
Step 4 translation-profile {incoming | outgoing} name Assigns a translation profile for incoming or outgoing call
legs to or from Cisco Unified IP phones.
Example: • You can also use an ephone-dn template to apply this
Router(config-ephone-dn)# translation-profile command to one or more directory numbers. If you use
outgoing name1 an ephone-dn template to apply a command and you
use the same command in ephone-dn configuration
mode for the same directory number, the value that you
set in ephone-dn configuration mode has priority.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See “Generating Configuration Files for Phones” on page 261.
SCCP: Applying Translation Rules Before Cisco CME 3.2
To apply a translation rule to an individual directory number in Cisco CME 3.1 and earlier versions,
perform the following steps.
Prerequisites
Translation rule to be applied must be already configured by using the translation-rule and rule
commands. For configuration information, see the "Cisco IOS Voice, Video, and FAX Configuration
Guide."
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
4. translate {called | calling} translation-rule-number
5. end
Cisco Unified Communications Manager Express System Administrator Guide
294 OL-10663-02
Configuring Dialing Plans
How to Configure Dialing Plans
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn tag Enters ephone-dn configuration mode to create directory
number for a Cisco Unified IP phone line, an intercom line,
a paging line, a voice-mail port, or a message-waiting
Example:
Router(config)# ephone-dn 1
indicator (MWI).
Step 4 translate {called | calling} Specifies rule to be applied to the directory number being
translation-rule-tag configured.
• translation-rule-tag—Reference number of previously
Example: configured translation rule. Range: 1 to 2147483647.
Router(config-ephone-dn)# translate called 1
• You can use an ephone-dn template to apply this
command to one or more directory numbers. If you use
an ephone-dn template to apply a command to a
directory number and you also use the same command
in ephone-dn configuration mode for the same
directory number, the value that you set in ephone-dn
configuration mode has priority.
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(cfg-translation-profile)# end
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See “Generating Configuration Files for Phones” on page 261.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 295
Configuring Dialing Plans
How to Configure Dialing Plans
SIP: Applying Voice Translation Rules in Cisco Unified CME 4.1 and Later
To apply a voice translation profile to incoming calls to a directory number on a SIP phone, perform the
following steps.
Prerequisites
• Cisco Unified CME 4.1 or a later version.
• Voice translation profile containing voice translation rules to be applied must be already configured.
For configuration information, see the “Defining Voice Translation Rules in Cisco CME 3.2 and
Later Versions” section on page 291.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register dn dn-tag
4. translation-profile incoming name
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register dn dn-tag Enters voice register dn configuration mode to define a
directory number for a SIP phone, intercom line, voice
port, or a message-waiting indicator (MWI).
Example:
Router(config)# voice register dn 1
Step 4 translation-profile incoming name Assigns a translation profile for incoming call legs to this
directory number.
Example:
Router(config-register-dn)# translation-profile
incoming name1
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-register-dn)# end
Cisco Unified Communications Manager Express System Administrator Guide
296 OL-10663-02
Configuring Dialing Plans
How to Configure Dialing Plans
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See “SIP: Generating Configuration Profiles for SIP Phones” on page 265.
SIP: Applying Voice Translation Rules before Cisco Unified CME 4.1
To apply an already-configured voice translation rule to modify the number dialed by extensions on a
SIP phone, perform the following steps.
Prerequisites
• Cisco CME 3.4 or a later version.
• Voice translation rule to be applied must be already configured. For configuration information, see
the “Defining Voice Translation Rules in Cisco CME 3.2 and Later Versions” section on page 291.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register pool tag
4. translate-outgoing {called | calling} rule-tag
5. end
DETAILED STEPS
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for SIP phones.
Example:
Router(config)# voice register pool 3
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 297
Configuring Dialing Plans
How to Configure Dialing Plans
Step 4 translate-outgoing {called | calling} rule-tag Specifies an already configured voice translation rule to be
applied to SIP phone being configured.
Example:
Router(config-register-pool)#
translate-outgoing called 1
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-global)# end
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See “SIP: Generating Configuration Profiles for SIP Phones” on page 265.
Verifying Voice Translation Rules and Profiles
To verify voice translation profiles, and rules, perform the following steps.
SUMMARY STEPS
1. show voice translation-profile
2. show voice translation-rule
3. test voice translation-rule
DETAILED STEPS
Step 1 show voice translation-profile [name]
This command displays the configuration of one or all translation profiles.
Router# show voice translation-profile profile-8415
Translation Profile: profile-8415
Rule for Calling number: 4
Rule for Called number: 1
Rule for Redirect number: 5
Rule for Redirect-target number: 2
Step 2 show voice translation-rule [number]
This command displays the configuration of one or all translation rules.
Router# show voice translation-rule 6
Translation-rule tag: 6
Rule 1:
Match pattern: 65088801..
Replace pattern: 6508880101
Match type: none Replace type: none
Match plan: none Replace plan: none
Cisco Unified Communications Manager Express System Administrator Guide
298 OL-10663-02
Configuring Dialing Plans
How to Configure Dialing Plans
Step 3 test voice translation-rule number
This command enables you to test your translation rules.
Router(config)# voice translation-rule 5
Router(cfg-translation-rule)# rule 1 /201/ /102/
Router(cfg-translation-rule)# exit
Router(config)# exit
Router# test voice translation-rule 5 2015550101
Matched with rule 5
Original number:2015550101 Translated number:1025550101
Original number type: none Translated number type: none
Original number plan: none Translated number plan: none
Activating a Secondary Dial Tone
To activate a secondary dial tone after a phone user dials the specified number string, perform the
following steps.
Prerequisite
• Cisco CME 3.0 or a later version.
• PSTN access prefix must be configured for outbound dial peer.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. secondary-dialtone digit-string
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 299
Configuring Dialing Plans
Configuration Examples for Dialing Plan Features
Command or Action Purpose
Step 4 secondary-dialtone digit-string Activates a secondary dial tone when digit-string is dialed.
• digit-string—String of up to 32 digits that, when dialed,
Example: activates a secondary dial tone. Typically, the
Router(config-telephony)# secondary-dialtone 9 digit-string is a predefined PSTN access prefix.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Configuration Examples for Dialing Plan Features
This section contains the following example:
• Secondary Dial Tone: Example, page 300
• Voice Translation Rules: Example, page 301
Secondary Dial Tone: Example
telephony-service
fxo hook-flash
load 7910 P00403020214
load 7960-7940 P00305000600
load 7914 S00103020002
load 7905 CP7905040000SCCP040701A
load 7912 CP7912040000SCCP040701A
max-ephones 100
max-dn 500
ip source-address 10.153.233.41 port 2000
max-redirect 20
no service directed-pickup
timeouts ringing 10
system message XYZ Company
voicemail 7189
max-conferences 8 gain -6
moh music-on-hold.au
web admin system name admin1 password admin1
dn-webedit
time-webedit
!
!
!
secondary-dialtone 9
Cisco Unified Communications Manager Express System Administrator Guide
300 OL-10663-02
Configuring Dialing Plans
Configuration Examples for Dialing Plan Features
Voice Translation Rules: Example
In the following configuration examples, if a user on Cisco Unified CME 1 dials 94155550100, the call
matches on dial peer 9415 and uses translation profile profile-9415. The called number is translated from
94155550100 to 4155550100, as specified by the translate called command using translation rule 1.
If a user on Cisco Unified CME 1 calls a phone on Cisco Unified CME 2 by dialing 5105550120, and
the call forward number is 94155550100, Cisco Unified CME 1 attempts to forward the call to
94155550100. A 302 message is then sent to Cisco Unified CME 1 with the “Contact:” field translated
to 4155550100. When the 302 reaches Cisco Unified CME 1, it matches the To: field in the 302 message
(5105550120) with dial peer 510. It does incoming translation from 4155550100 to 84155550100, and
an INVITE with 84155550100 is sent, which matches dial-peer 8415.
Figure 15 Translation Rules in SIP Call Transfer
Cisco Unified CME 2
Cisco Unified CME 1 IP
510555....
IP SIP
Cisco Unified CME 3
408555....
170612
IP
415555....
Cisco Unified CME 1 with 408555.... dialplan-pattern Cisco Unified CME 2 with 510555.... dialplan-pattern
dial-peer voice 9415 voip dial-peer voice 8415 voip
translation-profile outgoing profile-9415 translation-profile outgoing profile-8415
destination-pattern 9415555.... destination-pattern 8415555....
session protocol sipv2 session protocol sipv2
session target ipv4:10.4.187.177 session target ipv4:10.4.187.177
codec g711ulaw codec g711ulaw
voice translation-profile profile-9415 dial-peer voice 510 voip
translate called 1 translation-profile incoming profile-510
translate redirect-target 1 destination-pattern 510555....
session protocol sipv2
voice translation-rule 1 session target ipv4:10.4.187.188
rule 1 /^9415/ /415/ codec g711ulaw
voice translation-profile profile-8415
translate called 1
translate redirect-target 2
voice translation-profile profile-510
translate called 3
voice translation-rule 1
rule 1 /^9415/ /415/
voice translation-rule 2
rule 2 /^415/ /9415/
voice translation-rule 3
rule 1 /^8415/ /415/
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 301
Configuring Dialing Plans
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
302 OL-10663-02
Configuring Dialing Plans
Feature Information for Dialing Plan Features
Feature Information for Dialing Plan Features
Table 18 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 18 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 18 Feature Information for Dialing Plan Features
Cisco Unified CME
Feature Name Versions Feature Information
Dial-Plan Pattern 4.0 Added support for dial-plan pattern expansion for call
forward and call transfer when the forward or transfer-to
target is an individual abbreviated SIP extension or an
extension that appear on a SIP phone.
2.1 Strips leading digit pattern from extension number when
expanding an extension to an E.164 telephone number. The
length of the extension pattern must equal the value
configured for the extension-length argument.
1.0 Adds a prefix to extensions to transform them into E.164
numbers.
Secondary Dial Tone 3.0 Support for secondary dial tone after dialing specified
number string.
Voice Translation Rules 4.1 Added support for voice translation profiles for incoming
call legs to a directory number on a SIP phone.
3.4 Added support for voice translation rules to modify the
number dialed by extensions on a SIP phone.
3.2 Adds, removes, or transforms digits for calls going to or
originating from specified ephone-dns.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 303
Configuring Dialing Plans
Feature Information for Dialing Plan Features
Cisco Unified Communications Manager Express System Administrator Guide
304 OL-10663-02
Configuring Localization Support
Last Updated: November 6, 2009
This chapter describes the localization support in Cisco Unified Communications Manager Express
(Cisco Unified CME) for languages other than English and network tones and cadences not specific to
the United States.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Localization Support”
section on page 327.
Contents
• Information About Localization, page 305
• SCCP: How to Configure Localization Support, page 308
• Configuration Examples for Localization, page 321
• Where to Go Next, page 325
• Additional References, page 326
• Feature Information for Localization Support, page 327
Information About Localization
To configure localization support, you should understand the following concepts:
• System-Defined Locales, page 306
• User-Defined Locales, page 306
• Localization Support for Phone Displays, page 306
• Multiple Locales, page 307
• Locale Installer, page 307
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 305
Configuring Localization Support
Information About Localization
System-Defined Locales
Cisco Unified CME provides built-in localization support for 12 languages including English and
16 countries including the United States. Network locales specify country-specific tones and cadences;
user locales specify the language to use for text displays.
Configuring system-defined locales depends on the type of IP phone:
• Cisco Unified IP Phone 7905, 7912, 7940, and 7960—System-defined network locales and user
locales are preloaded into Cisco IOS software. No external files are required. Use the
network-locale and user-locale commands to set the locales for these phones.
• Cisco Unified IP Phone 7906, 7911, 7921, 7931, 7941, 7961, 7970, and 7971, and
Cisco IP Communicator—You must download locale files to support the system-defined locales and
store the files in flash memory, slot 0, or on an external TFTP server. See the “Installing
System-Defined Locales for Cisco Unified IP Phone 7906, 7911, 7921, 7931,7941, 7961, 7970,
7971, and Cisco IP Communicator” section on page 308.
User-Defined Locales
The user-defined locale feature allows you to support network and user locales other than the
system-defined locales that are predefined in Cisco IOS software. For example, if your site has phones
that must use the language and tones for Traditional Chinese, which is not one of the system-defined
choices, you must install the locale files for Traditional Chinese.
In Cisco Unified CME 4.0 and later, you can download files to support a particular user and network
locale and store the files in flash memory, slot 0, or an external TFTP server. These files cannot be stored
in the system location. User-defined locales can be assigned to all phones or to individual phones.
User-defined language codes for user locales are based on ISO 639 codes, which are available at the
Library of Congress website at http://www.loc.gov/standards/iso639-2/. User-defined country codes for
network locales are based on ISO 3166 codes.
For configuration information, see the “Installing User-Defined Locales” section on page 311.
Localization Support for Phone Displays
On the Cisco Unified IP Phone 7906, 7911, 7921, 7931, 7941, 7961, 7970, and 7971, and
Cisco IP Communicator, menus and prompts that are managed by the locale file for the IP phone type
(.jar) or the Cisco Unified CME dictionary file are localized. Display options configured through
Cisco IOS commands are not localized.
The following display items are localized by the IP phone (.jar file):
• System menus accessed with feature buttons (for example, messages, directories, services, settings,
and information).
• Call processing messages
• Soft keys (for example, Redial and CFwdALL).
The following display items are localized by the dictionary file for Cisco Unified CME:
• Directory Service (Local Directory, Local Speed Dial, and Personal Speed Dial)
• Status Line
Cisco Unified Communications Manager Express System Administrator Guide
306 OL-10663-02
Configuring Localization Support
Information About Localization
Display options configured through Cisco IOS commands are not localized and can only be displayed in
English. For example, this includes features such as:
• Caller ID
• Header Bar
• Phone Labels
• System Message
Multiple Locales
In Cisco Unified CME 4.0 and later, you can specify up to five user and network locales and apply
different locales to individual ephones or groups of ephones using ephone templates. For example, you
can specify French for phones A, B, and C; German for phones D, E, and F; and English for phones G,
H, and I. Only one user and network locale can be applied to each phone.
Each of the five user and network locales that you can define in a multilocale system is identified by a
locale tag. The locale identified by tag 0 is always the default locale, although you can define this default
to be any supported locale. For example, if you define user locale 0 to be JP (Japanese), the default user
locale for all phones is JP. If you do not specify a locale for tag 0, the default is US (United States).
To apply alternative locales to different phones, you must use per-phone configuration files to build
individual configuration files for each phone. The configuration files automatically use the default
user-locale 0 and network-locale 0. You can override these defaults for individual phones by configuring
alternative locale codes and then creating ephone-templates to assign the locales to individual ephones.
For configuration information, see the “Configuring Multiple Locales” section on page 317.
Locale Installer
Before Cisco Unified CME 7.0(1), configuring localization required up to 16 steps, most of which were
manual and some of which required file name changes. In Cisco Unified CME 7.0(1) and later versions,
the following enhancements for installing locales are supported:
• Locale installer that supports a single procedure for all SCCP IP phones.
• Cisco Unified CME parses new firmware-load text files and automatically creates the TFTP aliases
for localization, eliminating the requirement for you to manually create up to five aliases for files in
the TAR file. To use this feature in Cisco Unified CME 7.0(1), you must use the complete filename,
including the file suffix, when you configure the load command for phone firmware versions later
than version 8-2-2 for all phone types. For example:
Router(config-telephony)# load 7941 SCCP41.8-3-3S.loads
Router(config-telephony)#
Note In Cisco Unified CME 4.3 and earlier versions, you do not include the file suffix for any phone type
except Cisco ATA and Cisco Unified IP Phone 7905 and 7912. For example:
Router(config-telephony)# load 7941 SCCP41.8-2-2SR2S
• Backward compatibility with the configuration method in Cisco Unified CME 7.0 and earlier
versions.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 307
Configuring Localization Support
SCCP: How to Configure Localization Support
For configuration information, see the “Using the Locale Installer in Cisco Unified CME 7.0(1) and
Later Versions” section on page 314.
SCCP: How to Configure Localization Support
This section contains the following tasks:
• Installing System-Defined Locales for Cisco Unified IP Phone 7906, 7911, 7921, 7931,7941, 7961,
7970, 7971, and Cisco IP Communicator, page 308 (required)
• Installing User-Defined Locales, page 311 (optional)
• Using the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions, page 314 (optional)
• Verifying User-Defined Locales, page 317 (optional)
• Configuring Multiple Locales, page 317 (optional)
• Verifying Multiple Locales, page 320 (optional)
Installing System-Defined Locales for Cisco Unified IP Phone 7906, 7911, 7921,
7931,7941, 7961, 7970, 7971, and Cisco IP Communicator
Network locale files allow an IP phone to play the proper network tone for the specified country. You
must download and install a tone file for the country you want to support.
User locale files allow an IP phone to display the menus and prompts in the specified language. You must
download and install JAR files and dictionary files for each language you want to support.
To download and install locale files for system-defined locales, perform the following steps.
Tip The locale installer simplifies installing and configuring system and user-defined locales in
Cisco Unified CME 7.0(1) and later versions. To use the locale installer in Cisco Unified CME 7.0(1)
and later versions, see the “Using the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions”
section on page 314.
Prerequisites
• Cisco Unified CME 4.0(2) or a later version.
• You must create per-phone configuration files as described in the “SCCP: Defining Per-Phone
Configuration Files and Alternate Location” section on page 119.
• You must have an account on Cisco.com to download locale files.
Restrictions
• Localization is not supported for SIP phones.
• Phone firmware, configuration files, and locale files must be in the same directory, except the
directory file for Japanese and Russian which must be in flash memory.
Cisco Unified Communications Manager Express System Administrator Guide
308 OL-10663-02
Configuring Localization Support
SCCP: How to Configure Localization Support
DETAILED STEPS
Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/CME-Locale
You must have an account on Cisco.com to access the Software Download Center. If you do not have an
account or if you have forgotten your username or password, click the appropriate button at the login
dialog box and follow the instructions that appear.
Step 2 Select your version of Cisco Unified CME.
Step 3 Select the TAR file for the locale you want to install. Each TAR file contains locale files for a specific
language and country and uses the following naming convention:
CME-locale-language_country-CMEversion
For example, CME-locale-de_DE-4.0.2-2.0 is German for Germany for Cisco Unified CME 4.0(2).
Step 4 Download the TAR file to a TFTP server that is accessible to the Cisco Unified CME router. Each file
contains all the firmware required for all phone types supported by that version of Cisco Unified CME.
Step 5 Use the archive tar command to extract the files to flash, slot 0, or an external TFTP server.
Router# archive tar /xtract source-url flash:/file-url
For example, to extract the contents of CME-locale-de_DE-4.0.2-2.0.tar from TFTP server 192.168.1.1
to router flash memory, use this command:
Router# archive tar /xtract tftp://192.168.1.1/cme-locale-de_DE-4.0.2-2.0.tar flash:
Step 6 See Table 19 and Table 20 for a description of the codes used in the filenames and the list of supported
directory names.
Each phone type has a JAR file that uses the following naming convention:
language-phone-sccp.jar
For example, de-td-sccp.jar is for German on the Cisco Unified IP Phone 7970.
Each TAR file also includes the file g3-tones.xml for country-specific network tones and cadences.
Table 19 Phone-Type Codes for Locale JAR Files
Phone Type Phone Code
7906/7911 tc
7931 gp
7941/7961 mk
7970/7971 td
CIPC ipc
Table 20 System-Defined User and Network Locales
Language User-Locale Country Network-Locale
Language Code Directory Name Code Directory Name
English en English_United_States1 US United_States
English_United_Kingdom UK United_Kingdom
CA Canada
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 309
Configuring Localization Support
SCCP: How to Configure Localization Support
Table 20 System-Defined User and Network Locales
Language User-Locale Country Network-Locale
Language Code Directory Name Code Directory Name
Danish dk Danish_Denmark DK Denmark
Dutch nl Dutch_Netherlands NL Netherlands
French fr French_France FR France
CA Canada
German de German_Germany DE Germany
AT Austria
CH Switzerland
Italian it Italian_Italy IT Italy
2
Japanese jp Japanese_Japan JP Japan
Norwegian no Norwegian_Norway NO Norway
Portuguese pt Portuguese_Portugal PT Portugal
Russian ru Russian_Russia RU Russian_Federation
Spanish es Spanish_Spain ES Spain
Swedish se Swedish_Sweden SE Sweden
1. English for the United States is the default language. You do not need to install the JAR file for U.S. English unless you
assign a different language to a phone and then want to reassign English.
2. Katakana is supported by Cisco Unified IP Phone 7905, 7912, 7940, and 7960. Kanji is supported by Cisco Unified IP Phone
7911, 7941, 7961, 7970, and 7971.
Step 7 If you store the locale files in flash or slot 0: on the Cisco Unified CME router, create a TFTP alias for
the user locale (text displays) and network locale (tones) using this format:
Router(config)# tftp-server flash:/jar_file alias directory_name/td-sccp.jar
Router(config)# tftp-server flash:/g3-tones.xml alias directory_name/g3-tones.xml
Use the appropriate directory name shown in Table 20 and remove the two-letter language code from the
JAR file name.
For example, the TFTP aliases for German and Germany for the Cisco Unified IP Phone 7970 are:
Router(config)# tftp-server flash:/de-td-sccp.jar alias German_Germany/td-sccp.jar
Router(config)# tftp-server flash:/g3-tones.xml alias Germany/g3-tones.xml
Note On Cisco 3800 series routers, you must include /its in the directory name (flash:/its or slot0:/its). For
example, the TFTP alias for German for the Cisco Unified IP Phone 7970 is:
Router# tftp-server flash:/its/de-td-sccp.jar alias German_Germany/td-sccp.jar
Step 8 If you store the locale files on an external TFTP server, create a directory under the TFTP root directory
for each user and network locale.
Use the appropriate directory name shown in Table 20 and remove the two-letter language code from the
JAR file name.
For example, the user-locale directory for German and the network-locale directory for Germany for the
Cisco Unified IP Phone 7970 are:
Cisco Unified Communications Manager Express System Administrator Guide
310 OL-10663-02
Configuring Localization Support
SCCP: How to Configure Localization Support
TFTP-Root/German_Germany/td-sccp.jar
TFTP-Root/Germany/g3-tones.xml
Step 9 For Russian and Japanese, you must copy the UTF8 dictionary file into flash to use special phrases.
• Only flash can be used for these locales. Copy russian_tags_utf8_phrases for Russian;
Japanese_tags_utf8_phrases for Japanese.
• Use the user-locale jp and user-locale ru command to load the UTF8 phrases into
Cisco Unified CME.
Step 10 Assign the locales to phones. To set a default locale for all phones, use the user-locale and
network-locale commands in telephony-service configuration mode.
Step 11 To support more than one user or network locale, see the “Configuring Multiple Locales” section on
page 317.
Step 12 Use the create cnf-files command to rebuild the configuration files.
Step 13 Use the reset command to reset the phones and see the localized displays.
Installing User-Defined Locales
You must download XML files for locales that are not predefined in the system. To install up to five
user-defined locale files to use with phones, perform the following steps.
Prerequisites
• Cisco Unified CME 4.0(3) or a later version.
• You must create per-phone configuration files as described in the “SCCP: Defining Per-Phone
Configuration Files and Alternate Location” section on page 119.
• You must have an account on Cisco.com to download locale files.
Restrictions
• Localization is not supported for SIP phones.
• User-defined locales are not supported on the Cisco Unified IP Phone 7920 or 7936.
• User-defined locales are not supported if the configuration file location is system.
• When you use the setup tool from the telephony-service setup command to provision phones, you
can only choose a default user locale and network locale, and you are limited to selecting a locale
code that is supported in the system. You cannot use multiple locales or user-defined locales with
the setup tool.
• When using a user-defined locale, the phone normally displays text using the user-defined fonts,
except for any strings that are interpreted by Cisco Unified CME, such as “Cisco/Personal
Directory,” “Speed Dial/Fast Dial,” and so forth.
Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/CME-Locale
You must have an account on Cisco.com to access the Software Download Center. If you do not have an
account or if you have forgotten your username or password, click the appropriate button at the login
dialog box and follow the instructions that appear.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 311
Configuring Localization Support
SCCP: How to Configure Localization Support
Step 2 Select your version of Cisco Unified CME.
Step 3 Select the TAR file for the locale that you want to install. Each TAR file contains locale files for a
specific language and country and uses the following naming convention:
CME-locale-language_country-CMEversion-fileversion
For example, CME-locale-zh_CN-4.0.3-2.0 is Traditional Chinese for China for
Cisco Unified CME 4.0(3).
Step 4 Download the TAR file to a TFTP server that is accessible to the Cisco Unified CME router. Each file
contains all the firmware required for all phone types supported by that version of Cisco Unified CME.
Step 5 Use the archive tar command to extract the files to slot 0, flash, or an external TFTP server.
Router# archive tar /xtract source-url flash:/file-url
For example, to extract the contents of CME-locale-zh_CN-4.0.3-2.0.tar from TFTP server 192.168.1.1
to router flash memory, use this command:
Router# archive tar /xtract tftp://192.168.1.1/cme-locale-zh_CN-4.0.3-2.0.tar flash:
Step 6 For Cisco Unified IP Phones 7905, 7912, 7940, or 7960, go to Step 11.
For Cisco Unified IP Phones 7911, 7941, 7961, 7970, or 7971, go to Step 7.
Step 7 Each phone type has a JAR file that uses the following naming convention:
language-type-sccp.jar
For example, zh-td-sccp.jar is Traditional Chinese for the Cisco Unified IP Phone 7970.
See Table 21 and Table 22 for a description of the codes used in the filenames.
Table 21 Phone-Type Codes for Locale Files
Phone Type Code
7906/7911 tc
7931 gp
7941/7961 mk
7970/7971 td
CIPC ipc
Table 22 Language Codes for User-Defined Locales
Language Language Code
Bulgarian bg
Chinese zh1
Croation hr
Czech Republic cs
Finnish fi
Greek el
Hungarian hu
Korean ko
Cisco Unified Communications Manager Express System Administrator Guide
312 OL-10663-02
Configuring Localization Support
SCCP: How to Configure Localization Support
Table 22 Language Codes for User-Defined Locales
Language Language Code
Polish pl
Portugese (Brazil) pt
Romanian ro
Serbian sr
Slovakian sk
Slovenian sl
Turkish tr
1. For Cisco Unified IP Phone 7931, code for
Chinese Simplified is chs; Chinese
Traditional is cht.
Step 8 If you store the locale files in flash or slot 0: on the Cisco Unified CME router, create a TFTP alias using
this format:
Router(config)# tftp-server flash:/jar_file alias directory_name/td-sccp.jar
Remove the two-letter language code from the JAR filename and use one of five supported directory
names with the following convention:
user_define_number, where number is 1 to 5
For example, the alias for Chinese on the Cisco Unified IP Phone 7970 is:
Router(config)# tftp-server flash:/zh-td-sccp.jar alias user_define_1/td-sccp.jar
Note On Cisco 3800 series routers, you must include /its in the directory name (flash:/its or slot0:/its). For
example, the TFTP alias for Chinese for the Cisco Unified IP Phone 7970 is:
Router(config)# tftp-server flash:/its/zh-td-sccp.jar alias user_define_1/td-sccp.jar
Step 9 If you store the locale files on an external TFTP server, create a directory under the TFTP root directory
for each locale.
Remove the two-letter language code from the JAR filename and use one of five supported directory
names with the following convention:
user_define_number, where number is 1 to 5
For example, for Chinese on the Cisco Unified IP Phone 7970, remove “zh” from the JAR filename and
create the “user_define_1” directory under TFTP-Root on the TFTP server:
TFTP-Root/user_define_1/td-sccp.jar
Step 10 Go to Step 13.
Step 11 Download one or more of the following XML files depending on your selected locale and phone type.
All required files are included in the JAR file.
7905-dictionary.xml
7905-font.xml
7905-kate.xml
7920-dictionary.xml
7960-dictionary.xml
7960-font.xml
7960-kate.xml
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 313
Configuring Localization Support
SCCP: How to Configure Localization Support
7960-tones.xml
SCCP-dictionary.utf-8.xml
SCCP-dictionary.xml
Step 12 Rename these files and copy them to flash, slot 0, or an external TFTP server. Rename the files using the
format user_define_number_filename where number is 1 to 5. For example, use the following names if
you are setting up the first user-locale:
user_define_1_7905-dictionary.xml
user_define_1_7905-font.xml
user_define_1_7905-kate.xml
user_define_1_7920-dictionary.xml
user_define_1_7960-dictionary.xml
user_define_1_7960-font.xml
user_define_1_7960-kate.xml
user_define_1_7960-tones.xml
user_define_1_SCCP-dictionary.utf-8.xml
user_define_1_SCCP-dictionary.xml
Step 13 Copy the language_tags_file and language_utf8_tags_file to the location of the other locale files (flash,
slot 0, or TFTP server). Rename the files to user_define_number_tags_file and
user_define_number_utf8_tags_file respectively, where number is 1 to 5 and matches the user-defined
directory.
Step 14 Assign the locales to phones. See the “Configuring Multiple Locales” section on page 317.
Step 15 Use the create cnf-files command to rebuild the configuration files.
Step 16 Use the reset command to reset the phones and see the localized displays.
Using the Locale Installer in Cisco Unified CME 7.0(1) and Later Versions
To install and configure locale files to use with SCCP phones in Cisco Unified CME, perform the
following steps.
Tip Cisco Unified CME 7.0(1) provides backward compatibility with the configuration method in
Cisco Unified CME 4.3/7.0 and earlier versions. To use the same procedures as you used with earlier
versions of Cisco Unified CME, see“Installing System-Defined Locales for Cisco Unified IP Phone
7906, 7911, 7921, 7931,7941, 7961, 7970, 7971, and Cisco IP Communicator” section on page 308.
Prerequisites
• Cisco Unified CME 7.0(1) or a later version.
• You must configure Cisco Unified CME for per-phone configuration files. See “SCCP: Defining
Per-Phone Configuration Files and Alternate Location” section on page 119.
• When the storage location specified by the cnf-file location command is flash memory, sufficient
space must be on the flash file system for extracting the contents of the locale TAR file.
• You must have an account on Cisco.com to download locale files.
Cisco Unified Communications Manager Express System Administrator Guide
314 OL-10663-02
Configuring Localization Support
SCCP: How to Configure Localization Support
Restrictions
• Localization is not supported for SIP phones.
• When using an external TFTP server, you must manually create the user locale folders in the root
directory. This is a limitation of the TFTP server.
• Locale support is limited to phone firmware versions that are supported by Cisco Unified CME.
• User-defined locales are not supported on the Cisco Unified IP Phone 7920 or 7936.
• User-defined locales are not supported if the configuration file location is system.
• When you use the setup tool from the telephony-service setup command to provision phones, you
can only choose a default user locale and network locale, and you are limited to selecting a locale
code that is supported in the system. You cannot use multiple locales or user-defined locales with
the setup tool.
• When using a user-defined locale, the phone normally displays text using the user-defined fonts,
except for any strings that are interpreted by Cisco Unified CME, such as “Cisco/Personal
Directory,” and “Speed Dial/Fast Dial.”
• If you install and configure a user-defined locale using country codes U1-U5 and then you install a
new locale using the same label, the phone retains the original language locale even after the phone
is reset. This is a limitation of the IP phone. To work around this limitation, you must configure the
new package using a different country code (U1 - U5).
• Each user-defined country code (U1-U5) can be used for only one user-locale-tag at a time. For
example:
Router(config-telephony)# user-locale 2 U2 load Finnish.pkg
Router(config-telephony)# user-locale 1 U2 load Chinese.pkg
LOCALE ERROR: User Defined Locale U2 already exists on locale index 2.
DETAILED STEPS
Step 1 Go to http://www.cisco.com/cgi-bin/tablebuild.pl/CME-Locale.
You must have an account on Cisco.com to access the Software Download Center. If you do not have an
account or have forgotten your username or password, click the appropriate button at the login dialog
box and follow the instructions that appear.
Step 2 Select your version of Cisco Unified CME.
Step 3 Select the TAR file for the locale you want to install. Each TAR file contains locale files for a specific
language and country and uses the following naming convention:
CME-locale-language_country-CMEversion
For example, CME-locale-de_DE-7.0.1.0 is German for Germany for Cisco Unified CME 7.0(1).
Step 4 Download the TAR file to the location previously specified by the cnf-file location command. Each file
contains all the firmware required for all phone types supported by that version of Cisco Unified CME.
a. If the cnf-file location is flash memory: Copy the TAR file to the flash:/its directory.
b. If the cnf-file location is slot0: Copy the TAR file to the slot0:/its directory.
c. If the cnf-file location is tftp: Create a folder in the root directory of the TFTP server for each locale
using the following format and then copy the TAR file to the folder.
TFTP-Root/LocaleFolderName/TAR-filename
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 315
Configuring Localization Support
SCCP: How to Configure Localization Support
For system-defined locales, use the locale folder name as shown in Table 23. For example, create
the folder for system-defined German as follows:
TFTP-Root/German_Germany/de_DE-7.0.1.0.tar
For up to five user-defined locales, use the User_Define_n folder name as shown in Table 23. A
user-defined locale is a language other than the system-defined locales that are predefined in
Cisco IOS software. For example, create the folder for user-defined locale Chinese (User_Define_1)
as follows:
TFTP-Root/User_Define_1/CME-locale-zh_CN-7.0.1.0.tar
Note For a list of user-defined languages supported in Cisco Unified CME, see the Cisco Unified CME
Localization Matrix.
Table 23 System-Defined and User-Defined Locales
Country
Language Locale Folder Name Code
English English_United_States US
English_United_Kingdom UK
CA
Danish Danish_Denmark DK
Dutch Dutch_Netherlands NL
French French_France FR
CA
German German_Germany DE
AT
CH
Italian Italian_Italy IT
1
Japanese Japanese_Japan JP
Norwegian Norwegian_Norway NO
Portuguese Portuguese_Portugal PT
Russian Russian_Russia RU
Spanish Spanish_Spain ES
Swedish Swedish_Sweden SE
2 2
Un User_Define_n Un2
1. Katakana is supported by Cisco Unified IP Phone 7905, 7912, 7940, and 7960.
Kanji is supported by Cisco Unified IP Phone 7911, 7941, 7961, 7970, and
7971.
2. Where “n” is a number from 1 to 5.
Cisco Unified Communications Manager Express System Administrator Guide
316 OL-10663-02
Configuring Localization Support
SCCP: How to Configure Localization Support
Step 5 Use the user-locale [user-locale-tag] country-code load TAR-filename command in telephony-service
configuration mode to extract the contents of the TAR file. For country codes, see Table 23. For example,
to extract the contents of the CME-locale-zh_CN-7.0.1.0.tar file when U1 is the country code for
user-defined locale Chinese (User_Define_1), use this command:
Router (telephony-service)# user-locale U1 load CME-locale-zh_CN-7.0.1.0.tar
Step 6 Assign the locales to phones. See the “Configuring Multiple Locales” section on page 317.
Step 7 Use the create cnf-files command to rebuild the configuration files.
Step 8 Use the reset command to reset the phones and see the localized displays.
Verifying User-Defined Locales
See the “Verifying Multiple Locales” section on page 320.
Configuring Multiple Locales
To define one or more alternatives to the default user and network locales, and apply them to individual
phones, perform the following steps.
Prerequisites
• Cisco Unified CME 4.0 or a later version.
• To specify alternative user and network locales for individual phones in a Cisco Unified CME
system, you must use per-phone configuration files. For more information, see the “SCCP: Defining
Per-Phone Configuration Files and Alternate Location” section on page 119.
• You can also use user-defined locale codes as alternative locales after you download the appropriate
XML files. See the“Installing User-Defined Locales” section on page 311.
Restrictions
• Multiple user and network locales are not supported on the Cisco Unified IP Phone 7902G, 7910,
7910G, or 7920, or the Cisco Unified IP Conference Station 7935 and 7936.
• When you use the setup tool from the telephony-service setup command to provision phones, you
can only choose a default user locale and network locale, and you must select a locale code that is
predefined in the system. You cannot use multiple or user-defined locales with the setup tool.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. user-locale [user-locale-tag] {[user-defined-code] country-code}
5. network-locale network-locale-tag [user-defined-code] country-code
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 317
Configuring Localization Support
SCCP: How to Configure Localization Support
6. create cnf-files
7. exit
8. ephone-template template-tag
9. user-locale user-locale-tag
10. network-locale network-locale-tag
11. exit
12. ephone phone-tag
13. ephone-template template-tag
14. exit
15. telephony service
16. reset {all [time-interval] | cancel | mac-address mac-address | sequence-all}
17. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 user-locale [user-locale-tag] Specifies a language for phone displays.
{[user-defined-code] country-code}
• user-locale-tag—Assigns a locale identifier to the
locale. Range is 0 to 4. Default: 0. This argument is
Example: required when defining some locale other than the
Router(config-telephony)# user-locale 1 U1 ZH default (0).
• user-defined-code—(Optional) Assigns one of the
user-defined codes to the specified country code. Valid
codes are U1, U2, U3, U4, and U5.
• country-code—Type ? to display a list of
system-defined codes. Default: US (United States). You
can assign any valid ISO 639 code to a user-defined
code (U1 to U5).
Cisco Unified Communications Manager Express System Administrator Guide
318 OL-10663-02
Configuring Localization Support
SCCP: How to Configure Localization Support
Command or Action Purpose
Step 5 network-locale network-locale-tag Specifies a country for tones and cadences.
[user-defined-code] country-code
• network-locale-tag—Assigns a locale identifier to the
country code. Range is 0 to 4. Default: 0. This
Example: argument is required when defining some locale other
Router(config-telephony)# network-locale 1 FR than the default (0).
• user-defined-code—(Optional) Assigns one of the
user-defined codes to the specified country code. Valid
codes are U1, U2, U3, U4, and U5.
• country-code—Type ? to display a list of
system-defined codes. Default: US (United States). You
can assign any valid ISO 3166 code to a user-defined
code (U1 to U5).
Step 6 create cnf-files Builds the required XML configuration files for IP phones.
Use this command after you update configuration file
parameters such as the user locale or network locale.
Example:
Router(config-telephony)# create cnf-files
Step 7 exit Exits telephony-service configuration mode.
Example:
Router(config-telephony)# exit
Step 8 ephone-template template-tag Enters ephone-template configuration mode.
• template-tag—Unique sequence number that identifies
Example: this template during configuration tasks.
Router(config)# ephone template 1
Step 9 user-locale user-locale-tag Assigns a user locale to this ephone template.
• user-locale-tag—A locale tag that was created in
Example: Step 4. Range is 0 to 4.
Router(config-ephone-template)# user-locale 2
Step 10 network-locale network-locale-tag Assigns a network locale to this ephone template.
• network-locale-tag—A locale tag that was created in
Example: Step 5. Range is 0 to 4.
Router(config-ephone-template)#
network-locale 2
Step 11 exit Exits ephone-template configuration mode.
Example:
Router(config-ephone-template)# exit
Step 12 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies
Example: this ephone during configuration tasks.
Router(config)# ephone 36
Step 13 ephone-template template-tag Applies an ephone template to an ephone.
• template-tag—Number of the template to apply to this
Example: ephone.
Router(config-ephone)# ephone-template 1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 319
Configuring Localization Support
SCCP: How to Configure Localization Support
Command or Action Purpose
Step 14 exit Exits ephone configuration mode.
Example:
Router(config-ephone)# exit
Step 15 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 16 reset {all [time-interval] | cancel | Performs a complete reboot of all phones or the specified
mac-address mac-address | sequence-all} phone, including contacting the DHCP and TFTP servers
for the latest configuration information.
Example: • all—All phones in the Cisco Unified CME system.
Router(config-telephony)# reset all
• time-interval—(Optional) Time interval, in seconds,
between each phone reset. Range is 0 to 60. Default
is 15.
• cancel—Interrupts a sequential reset cycle that was
started with a reset sequence-all command.
• mac-address mac-address—A specific phone.
• sequence-all—Resets all phones in strict one-at-a-time
order by waiting for one phone to reregister before
starting the reset for the next phone.
Step 17 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Verifying Multiple Locales
Step 1 Use the show telephony-service tftp-bindings command to display a list of configuration files that are
accessible to IP phones using TFTP, including the dictionary, language, and tone configuration files.
Router(config)# show telephony-service tftp-bindings
tftp-server system:/its/SEPDEFAULT.cnf
tftp-server system:/its/SEPDEFAULT.cnf alias SEPDefault.cnf
tftp-server system:/its/XMLDefault.cnf.xml alias XMLDefault.cnf.xml
tftp-server system:/its/ATADefault.cnf.xml
tftp-server system:/its/XMLDefault7960.cnf.xml alias SEP00036B54BB15.cnf.xml
tftp-server system:/its/germany/7960-font.xml alias German_Germany/7960-font.xml
tftp-server system:/its/germany/7960-dictionary.xml alias
German_Germany/7960-dictionary.xml
tftp-server system:/its/germany/7960-kate.xml alias German_Germany/7960-kate.xml
tftp-server system:/its/germany/SCCP-dictionary.xml alias
German_Germany/SCCP-dictionary.xml
tftp-server system:/its/germany/7960-tones.xml alias Germany/7960-tones.xml
Step 2 Ensure that per-phone configuration files are defined with the cnf-file perphone command.
Cisco Unified Communications Manager Express System Administrator Guide
320 OL-10663-02
Configuring Localization Support
Configuration Examples for Localization
Step 3 Use the show telephony-service ephone-template command to check the user locale and network
locale settings in each ephone template.
Step 4 Use the show telephony-service ephone command to check that the correct templates are applied to
phones.
Step 5 If the configuration file location is not TFTP, use the debug tftp events command to see which files
Cisco Unified CME is looking for and whether the files are found and opened correctly. There are
usually three states (“looking for x file” “opened x file” and “finished x file”). The file is found when
all three states are displayed. For an external TFTP server you can use the logs from the TFTP server.
Configuration Examples for Localization
This section contains the following examples:
• Multiple User and Network Locales: Example, page 321
• User-Defined Locales: Example, page 322
• Locale Installer: Examples, page 323
Multiple User and Network Locales: Example
The following example sets the default locale of 0 to Germany, which defines Germany as the default
user and network locale. Germany is used for all phones unless you apply a different locale to individual
phones using ephone templates.
telephony service
cnf-file location flash:
cnf-file perphone
user-locale 0 DE
network-locale 0 DE
After using the previous commands to define Germany as the default user and network locale, use the
following commands to return the default value of 0 to US:
telephony service
no user-locale 0 DE
no network-locale 0 DE
Another way to define Germany as the default user and network locale is to use the following commands:
telephony service
cnf-file location flash:
cnf-file perphone
user-locale DE
network-locale DE
After using the previous commands, use the following commands to return the default to US:
telephony service
no user-locale DE
no network-locale DE
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 321
Configuring Localization Support
Configuration Examples for Localization
The following example defines three alternative locales: JP (Japan), FR (France), and ES (Spain). The
default is US for all phones that do not have an alternative applied using ephone templates. In this
example, ephone 11 uses JP for its locales, ephone 12 uses FR, ephone 13 uses ES, and ephone 14 uses
the default, US.
telephony-service
cnf-file location flash:
cnf-file perphone
create cnf-files
user-locale 1 JP
user-locale 2 FR
user-locale 3 ES
network-locale 1 JP
network-locale 2 FR
network-locale 3 ES
create cnf-files
ephone-template 1
user-locale 1
network-locale 1
ephone-template 2
user-locale 2
network-locale 2
ephone-template 3
user-locale 3
network-locale 3
ephone 11
button 1:25
ephone-template 1
ephone 12
button 1:26
ephone-template 2
ephone 13
button 1:27
ephone-template 3
ephone 14
button 1:28
User-Defined Locales: Example
The following example shows user-locale tag 1 assigned to code U1, which is defined as ZH for
Traditional Chinese. Traditional Chinese is not predefined in the system so you must download the
appropriate XML files to support this language.
In this example, ephone 11 uses Traditional Chinese (ZH) and ephone 12 uses the default, US English.
The default is US English for all phones that do not have an alternative applied using ephone templates.
telephony-service
cnf-file location flash:
cnf-file perphone
user-locale 1 U1 ZH
network-locale 1 U1 CN
ephone-template 2
user-locale 1
Cisco Unified Communications Manager Express System Administrator Guide
322 OL-10663-02
Configuring Localization Support
Configuration Examples for Localization
network-locale 1
ephone 11
button 1:25
ephone-template 2
ephone 12
button 1:26
Locale Installer: Examples
This section contains the following examples:
• System-Defined Locale is the Default Applied to All Phones, page 323
• User-Defined Locale is Default Language to be Applied to all Phones, page 324
• Configuring a Locale on a Nondefault Locale Index, page 324
System-Defined Locale is the Default Applied to All Phones
The following example is the output from the user-locale command when you configure a
system-defined locale for Cisco Unified CME and the locale is on the default locale index
(user-locale-tag 0). The user-locale-tag argument is required only when using multiple locales,
otherwise the specified language is the default applied to all SCCP phones.
Router(config-telephony)# user-locale SE load CME-locale-sv_SV-7.0.1.1a.tar
Updating CNF files
LOCALE INSTALLER MESSAGE: VER:1
LOCALE INSTALLER MESSAGE: Langcode:se
LOCALE INSTALLER MESSAGE: Language:swedish
LOCALE INSTALLER MESSAGE: Filename: g3-tones.xml
LOCALE INSTALLER MESSAGE: Filename: gp-sccp.jar
LOCALE INSTALLER MESSAGE: Filename: ipc-sccp.jar
LOCALE INSTALLER MESSAGE: Filename: mk-sccp.jar
LOCALE INSTALLER MESSAGE: Filename: tc-sccp.jar
LOCALE INSTALLER MESSAGE: Filename: td-sccp.jar
LOCALE INSTALLER MESSAGE: New Locale configured
CNF-FILES: Clock is not set or synchronized, retaining old versionStamps
CNF files updating complete
Router(config-telephony)# create cnf-files
Router(config-telephony)# ephone 3
Router(config-ephone)# reset
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 323
Configuring Localization Support
Configuration Examples for Localization
User-Defined Locale is Default Language to be Applied to all Phones
The following example is the output from the user-locale command when you configure a user-defined
locale for Cisco Unified CME and the locale is on the default locale index (user-locale-tag 0). The
user-locale-tag argument is required when using multiple locales, otherwise the specified language is
the default applied to all SCCP phones.
Router(config-telephone)# user-locale U1 load CME-locale-xh_CN-7.0.1.1.tar
Updating CNF files
LOCALE INSTALLER MESSAGE: VER:1
LOCALE INSTALLER MESSAGE: Langcode:fi
LOCALE INSTALLER MESSAGE: Language:Finnish
LOCALE INSTALLER MESSAGE: Filename: 7905-dictionary.xml
LOCALE INSTALLER MESSAGE: Filename: 7905-kate.xml
LOCALE INSTALLER MESSAGE: Filename: 7920-dictionary.xml
LOCALE INSTALLER MESSAGE: Filename: 7960-dictionary.xml
LOCALE INSTALLER MESSAGE: Filename: 7960-font.xml
LOCALE INSTALLER MESSAGE: Filename: 7960-kate.xml
LOCALE INSTALLER MESSAGE: Filename: 7960-tones.xml
LOCALE INSTALLER MESSAGE: Filename: mk-sccp.jar
LOCALE INSTALLER MESSAGE: Filename: tc-sccp.jar
LOCALE INSTALLER MESSAGE: Filename: td-sccp.jar
LOCALE INSTALLER MESSAGE: Filename: tags_file
LOCALE INSTALLER MESSAGE: Filename: utf8_tags_file
LOCALE INSTALLER MESSAGE: Filename: g3-tones.xml
LOCALE INSTALLER MESSAGE: Filename: SCCP-dictionary.utf-8.xml
LOCALE INSTALLER MESSAGE: Filename: SCCP-dictionary.xml
LOCALE INSTALLER MESSAGE: Filename: ipc-sccp.jar
LOCALE INSTALLER MESSAGE: Filename: gp-sccp.jar
LOCALE INSTALLER MESSAGE: New Locale configured
Processing file:flash:/its/user_define_2_tags_file
Processing file:flash:/its/user_define_2_utf8_tags_file
CNF-FILES: Clock is not set or synchronized, retaining old versionStamps
CNF files updating complete
Router(config-telephony)# create cnf-files
Router(config-telephony)# ephone 3
Router(config-ephone)# reset
Configuring a Locale on a Nondefault Locale Index
The following example is the output from the user-locale command if you configure a user-defined
locale as an alternate locale for a particular SCCP phone (ephone 1) in Cisco Unified CME. The
user-locale-tag argument is required only when using multiple locales. In this configuration, the locale
is user-defined Finnish (U2) on user-locale index 2.
Router(config-telephony)# user-locale 2 U2 load CME-locale-fi_FI-7.0.1.1.tar
Updating CNF files
LOCALE INSTALLER MESSAGE: VER:1
LOCALE INSTALLER MESSAGE: Langcode:fi
LOCALE INSTALLER MESSAGE: Language:Finnish
LOCALE INSTALLER MESSAGE: Filename: 7905-dictionary.xml
LOCALE INSTALLER MESSAGE: Filename: 7905-kate.xml
LOCALE INSTALLER MESSAGE: Filename: 7920-dictionary.xml
LOCALE INSTALLER MESSAGE: Filename: 7960-dictionary.xml
LOCALE INSTALLER MESSAGE: Filename: 7960-font.xml
Cisco Unified Communications Manager Express System Administrator Guide
324 OL-10663-02
Configuring Localization Support
Where to Go Next
LOCALE INSTALLER MESSAGE: Filename: 7960-kate.xml
LOCALE INSTALLER MESSAGE: Filename: 7960-tones.xml
LOCALE INSTALLER MESSAGE: Filename: mk-sccp.jar
LOCALE INSTALLER MESSAGE: Filename: tc-sccp.jar
LOCALE INSTALLER MESSAGE: Filename: td-sccp.jar
LOCALE INSTALLER MESSAGE: Filename: tags_file
LOCALE INSTALLER MESSAGE: Filename: utf8_tags_file
LOCALE INSTALLER MESSAGE: Filename: g3-tones.xml
LOCALE INSTALLER MESSAGE: Filename: SCCP-dictionary.utf-8.xml
LOCALE INSTALLER MESSAGE: Filename: SCCP-dictionary.xml
LOCALE INSTALLER MESSAGE: Filename: ipc-sccp.jar
LOCALE INSTALLER MESSAGE: Filename: gp-sccp.jar
LOCALE INSTALLER MESSAGE: New Locale configured
Processing file:flash:/its/user_define_2_tags_file
Processing file:flash:/its/user_define_2_utf8_tags_file
CNF-FILES: Clock is not set or synchronized, retaining old versionStamps
CNF files updating complete
Router(config-telephony)# ephone-template 1
Router(config-ephone-template)# user-locale 2
Router(config-ephone-template)# ephone 1
Router(config-ephone)# ephone-template 1
The ephone template tag has been changed under this ephone, please restart or reset ephone
to take effect.
Router(config-ephone)# telephony-service
Router(config-telephony)# create cnf-files
Router(config-telephony)# ephone 1
Router(config-ephone)# reset
Where to Go Next
Ephone Templates
For more information about ephone templates, see “Creating Templates” on page 1129.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 325
Configuring Localization Support
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
326 OL-10663-02
Configuring Localization Support
Feature Information for Localization Support
Feature Information for Localization Support
Table 24 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 24 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 24 Feature Information for Localization Support
Cisco Unified CME
Feature Name Version Feature Information
Cisco Unified CME Usability 7.0(1) • Locale installer that supports a single procedure for all
Enhancement SCCP IP phones.
• Parses firmware-load text files and automatically
creates the required TFTP aliases for localization.
• Backward compatibility with the configuration method
in Cisco Unified CME 7.0 and earlier versions.
Multiple Locales 4.0 Multiple user and network locales were introduced.
User-Defined Locales 4.0 User-defined locales were introduced.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 327
Configuring Localization Support
Feature Information for Localization Support
Cisco Unified Communications Manager Express System Administrator Guide
328 OL-10663-02
Configuring Transcoding Resources
Last Updated: March 12, 2009
This chapter describes the transcoding support available in Cisco Unified
Communications Manager Express (Cisco Unified CME).
Note • To configure a DSP farm profile for multi-party ad hoc and meet-me conferencing in
Cisco Unified CME 4.1 and later versions, see “Meet-Me Conferencing in Cisco Unified CME 4.1
and Later versions” on page 756.
• To configure DSP farms for meet-me conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0.
see “Meet-Me Conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0” on page 757.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Transcoding
Resources” section on page 366.
Contents
• Prerequisites for Configuring Transcoding Resources, page 329
• Restrictions for Configuring Transcoding Resources, page 330
• Information About Transcoding Resources, page 330
• How to Configure Transcoding Resources, page 334
• Configuration Examples for Transcoding Resources, page 363
• Where to go Next, page 364
• Additional References, page 364
• Feature Information for Transcoding Resources, page 366
Prerequisites for Configuring Transcoding Resources
• Cisco Unified CME 3.2 or a later version.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 329
Configuring Transcoding Resources
Restrictions for Configuring Transcoding Resources
Restrictions for Configuring Transcoding Resources
• Before Cisco CME 3.2, only G.729 is supported for two-party voice calls.
• In Cisco CME 3.2 to Cisco Unified CME 4.0, transcoding between G.711 and G.729 does not
support the following:
– Meet-me conferencing
– Multiple-party ad-hoc conferencing
– Transcoding security
Information About Transcoding Resources
To configure transcoding support, you should understand the following concepts:
• Transcoding Support, page 330
• Transcoding When a Remote Phone Uses G.729r8, page 333
• Secure DSP Farm Transcoding, page 334
Transcoding Support
Transcoding compresses and decompresses voice streams to match endpoint-device capabilities.
Transcoding is required when an incoming voice stream is digitized and compressed (by means of a
codec) to save bandwidth, and the local device does not support that type of compression.
Cisco CME 3.2 and later versions support transcoding between G.711 and G.729 codecs for the
following features:
• Ad hoc conferencing—One or more remote conferencing parties uses G.729.
• Call transfer and forward—One leg of a Voice over IP (VoIP)-to-VoIP hairpin call uses G.711 and
the other leg uses G.729. A hairpin call is an incoming call that is transferred or forwarded over the
same interface from which it arrived.
• Cisco Unity Express—An H.323 or SIP call using G.729 is forwarded to Cisco Unity Express.
Cisco Unity Express supports only G.711, so G.729 must be transcoded.
• Music on hold (MOH)—The phone receiving MOH is part of a system that uses G.729. The G.711
MOH is transcoded into G.729 resulting in a poorer quality sound due to the lower compression of
G.729.
Each of the preceding call situations is illustrated in Figure 16.
Cisco Unified Communications Manager Express System Administrator Guide
330 OL-10663-02
Configuring Transcoding Resources
Information About Transcoding Resources
Figure 16 Three-Way Conferencing, Call Transfer and Forward, Cisco Unity Express, and MOH
Between G.711 and G.729
Transcoding is facilitated through DSPs, which are located in network modules. All network modules
have single inline memory module (SIMM) sockets or packet voice/data modules (PVDM) slots that
each hold a Packet Voice DSP Module (PVDM). Each PVDM holds DSPs. A router can have multiple
network modules.
Cisco Unified CME routers and external voice routers on the same LAN must be configured with digital
signal processors (DSPs) that support transcoding. DSPs reside either directly on a voice network
module, such as the NM-HD-2VE, on PVDM2s that are installed in a voice network module, such as the
NM-HDV2, or on PVDM2s that are installed directly onto the motherboard, such as on the Cisco 2800
and 3800 series voice gateway routers.
• DSPs on the NM-HDV, NM-HDV2, NM-HD-1V, NM-HD-2V, and NM-HD-2VE can be configured
for transcoding.
• PVDM2-xx on the Cisco 2800 series and the Cisco 3800 series motherboards can also be configured
for transcoding.
Transcoding of G.729 calls to G.711 allows G.729 calls to participate in existing G.711 software-based,
three-party conferencing, thus eliminating the need to divide DSPs between transcoding and
conferencing.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 331
Configuring Transcoding Resources
Information About Transcoding Resources
Figure 17 shows an NM-HDV with five SIMM sockets or PVDM slots that each hold a 12-Channel
PVDM (PVDM-12). Each PVDM-12 holds three TI 549 DSPs. Each DSP supports four channels.
Figure 17 NM-HDV Supports Up to Five PVDMs
Use DSP resources to provide voice termination of the digital voice trunk group or resources for a DSP
farm. DSP resources available for transcoding and not used for voice termination are referred to as a
DSP farm. Figure 18 shows a DSP farm managed by Cisco Unified CME.
Cisco Unified Communications Manager Express System Administrator Guide
332 OL-10663-02
Configuring Transcoding Resources
Information About Transcoding Resources
Figure 18 DSP Farm
Transcoding When a Remote Phone Uses G.729r8
A situation in which transcoding resources may be used is when you use the codec command to select
the G.729r8 codec to help save network bandwidth for a remote IP phone. If a conference is initiated,
all phones in the conference switch to G.711 mu-law. To allow the phone to retain its G.729r8 codec
setting when joined to a conference, you can use the codec g729r8 dspfarm-assist command to specify
that this phone’s calls should use the resources of a DSP farm for transcoding. For example, there are
two remote phones (A and B) and a local phone (C) that initiates a conference with them. Both A and B
are configured to use the G.729r8 codec with the assistance of the DSP-farm transcoder. In the
conference, the call leg from C to the conference uses the G.711 mu-law codec, and the call legs from
A and B to the Cisco Unified CME router use the G.729r8 codec.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 333
Configuring Transcoding Resources
How to Configure Transcoding Resources
Consider your options carefully when deciding to use the codec g729r8 dspfarm-assist command. The
benefit is that it allows calls to use the G.729r8 codec on the call leg between the IP phone and the
Cisco Unified CME router, which saves network bandwidth. The disadvantage is that for situations
requiring G.711 codecs, such as conferencing and Cisco Unity Express, DSP resources that are possibly
scarce are used to transcode the call, and delay is introduced while voice is shuttled to and from the DSP.
In addition, the overuse of this feature can mask configuration errors in the codec selection mechanisms
involving dial peers and codec lists.
Therefore, we recommend using the codec g729r8 dspfarm-assist command sparingly and only when
absolutely required for bandwidth savings or when you know the phone will be participating very little,
if at all, in calls that require a G.711 codec.
Because of how Cisco Unified CME uses voice channels with Skinny Client Control Protocol (SCCP)
endpoints, you must configure at least two available transcoding sessions when establishing a call that
requires transcoding configured with the codec g729r8 dspfarm-assist command. Only one session is
used after the voice path is established with transcoding. However, during the SCCP manipulations, a
temporary session may be allocated. If this temporary session cannot be allocated, the transcoding
request is not honored, and the call continues with the G.711 codec.
If the codec g729r8 dspfarm-assist command is configured for a phone and a DSP resource is not
available when needed for transcoding, a phone registered to the local Cisco Unified CME router will
use G.711 instead of G.729r8. This is not true for nonSCCP call legs; if DSP resources are not available
for the transcoding required for a conference, for example, the conference is not created.
Secure DSP Farm Transcoding
Cisco Unified CME uses the secure transcoding DSP farm capability only in the case described in the
“Transcoding When a Remote Phone Uses G.729r8” section on page 333. If a call using the codec
g729r8 dspfarm-assist command is secure, Cisco Unified CME looks for a secure transcoding resource.
If it cannot find one, transcoding is not done. If the call is not secure, Cisco Unified CME looks for a
nonsecure transcoding resource. If it cannot find one, Cisco Unified CME looks for a secure transcoding
resource. Even if Cisco Unified CME uses a secure transcoding resource, the call is not secure, and a
more expensive secure DSP Farm resource is not needed for a nonsecure call because
Cisco Unified CME cannot find a less expensive nonsecure transcoder.
How to Configure Transcoding Resources
This section contains the following tasks:
• Determining DSP Resource Requirements for Transcoding, page 335 (required)
• Provisioning Network Modules or PVDMs for Transcoding, page 335 (required)
DSP Farms for NM-HDs and NM-HDV2s
• Configuring DSP Farms for NM-HDs and NM-HDV2s, page 336 (required)
DSP Farms for NM-HDVs
• Configuring DSP Farms for NM-HDVs, page 341 (required)
• Configuring the Cisco Unified CME Router to Act as the DSP Farm Host, page 343 (required)
• Modifying DSP Farms for NM-HDVs After Upgrading Cisco IOS Software, page 346 (optional)
• Modifying the Number of Transcoding Sessions for NM-HDVs, page 347 (optional)
Cisco Unified Communications Manager Express System Administrator Guide
334 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
• Tuning DSP-Farm Performance on an NM-HDV, page 348 (optional)
• Verifying DSP Farm Operation, page 349 (optional)
DSP Farms with Cisco Unified CME 4.2 and Later Versions
• Registering the DSP Farm with Cisco Unified CME 4.2 or a Later Version in Secure Mode, page 353
(optional)
Determining DSP Resource Requirements for Transcoding
To determine if that there are enough DSPs available on your router for transcoding services, perform
the following steps.
Note For more information about DSP resources for transcoding, see the “Allocation of DSP Resources”
section in the “Configuring Enhanced Conferencing and Transcoding for Voice Gateway Routers”
chapter of the Cisco Unified Communications Manager and Cisco IOS Interoperability Guide.
SUMMARY STEPS
1. show voice dsp
2. show sdspfarm sessions
3. show sdspfarm units
DETAILED STEPS
Step 1 Use the show voice dsp command to display current status of digital signal processor (DSP) voice
channels.
Step 2 Use the show sdspfarm sessions command to display the number of transcoder sessions that are active.
Step 3 Use the show sdspfarm units command to display the number of DSP farms that are configured.
Provisioning Network Modules or PVDMs for Transcoding
DSPs can reside directly on any one of the following:
• A voice network module, such as the NM-HD-2VE,
• PVDM2s that are installed in a voice network module, such as the NM-HDV2. A single network
module can hold up to five PVDMs.
• PVDM2s that are installed directly onto the motherboard, such as on the Cisco 2800 and 3800 series
voice gateway routers.
You must determine the number of PVDM2s or network modules that are required to support your
conferencing and transcoding services and install the modules on your router.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 335
Configuring Transcoding Resources
How to Configure Transcoding Resources
SUMMARY STEPS
1. Determine performance requirements.
2. Determine the number of DSPs that are required.
3. Determine the number of DSPs that are supportable.
4. Verify your solution.
5. Install hardware
DETAILED STEPS
Step 1 Determine the number of transcoding sessions that your router must support.
Step 2 Determine the number of DSPs that are required to support transcoding sessions. See Table 5 and Table
6 in the “Allocation of DSP Resources” section of the “Configuring Enhanced Conferencing and
Transcoding for Voice Gateway Routers” chapter of the Cisco Unified Communications Manager and
Cisco IOS Interoperability Guide.
If voice termination is also required, determine the additional number of DSPs required.
For example: 16 transcoding sessions (30-ms packetization) and 4 G.711 voice calls require two DSPs.
Step 3 Determine the maximum number of NMs or NM farms that your router can support by using Table 4 in
the “Allocation of DSP Resources” section of the “Configuring Enhanced Conferencing and
Transcoding for Voice Gateway Routers” chapter of the Cisco Unified Communications Manager and
Cisco IOS Interoperability Guide.
Step 4 Ensure that your requirements fall within router capabilities, taking into account whether your router
supports multiple NMs or NM farms. If necessary, reassess performance requirement.
Step 5 Install PVDMs, NMs, and NM farms as needed. See the “Connecting Voice Network Modules” chapter
in the Cisco Network Modules Hardware Installation Guide.
What to Do Next
Perform one of the following options, depending on the type of network module to be configured:
• To set up DSP farms on NM-HDs and NM-HDV2s, see the “Configuring DSP Farms for NM-HDs
and NM-HDV2s” section on page 336.
• To set up DSP farms for NM-HDVs, see the “Configuring DSP Farms for NM-HDVs” section on
page 341.
Configuring DSP Farms for NM-HDs and NM-HDV2s
To configure DSP farms for NM-HDs or NM-HDV2s and to configure secure transcoding profiles,
perform the following procedure.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
336 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
3. voice-card slot
4. dsp services dspfarm
5. exit
6. sccp local interface-type interface-number
7. sccp ccm ip-address identifier identifier-number
8. sccp
9. sccp ccm group group-number
10. bind interface interface-type interface-number
11. associate ccm identifier-number priority priority-number
12. associate profile profile-identifier register device-name
13. keepalive retries number
14. switchover method {graceful | immediate}
15. switchback method {graceful | guard timeout-guard-value | immediate | uptime
uptime-timeout-value}
16. switchback interval seconds
17. exit
18. dspfarm profile profile-identifier transcode [security]
19. trustpoint trustpoint-label
20. codec codec-type
21. maximum sessions number
22. associate application sccp
23. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice-card slot Enters voice-card configuration mode for the network
module on which you want to enable DSP-farm services.
Example:
Router(config)# voice-card 1
Step 4 dsp services dspfarm Enables DSP-farm services for the voice card.
Example:
Router(config-voicecard)# dsp services dspfarm
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 337
Configuring Transcoding Resources
How to Configure Transcoding Resources
Command or Action Purpose
Step 5 exit Exits voice-card configuration mode.
Example:
Router(config-voicecard)# exit
Step 6 sccp local interface-type interface-number Selects the local interface that the SCCP applications
(transcoding and conferencing) should use to register with
Cisco Unified CME.
Example:
Router(config)# sccp local FastEthernet 0/0 • interface-type—Interface type that the SCCP
application uses to register with Cisco Unified CME.
The type can be an interface address or a
virtual-interface address such as Ethernet.
• interface-number—Interface number that the SCCP
application uses to register with Cisco Unified CME.
Step 7 sccp ccm ip-address identifier Specifies the Cisco Unified CME address.
identifier-number
• ip-address—IP address of the Cisco Unified CME
router.
Example:
Router(config)# sccp ccm 10.10.10.1 identifier
• identifier identifier-number—Number that identifies
1 the Cisco Unified CME router.
• Repeat this step to specify the address of a secondary
Cisco Unified CME router.
Step 8 sccp Enables SCCP and its associated transcoding and
conferencing applications.
Example:
Router(config)# sccp
Step 9 sccp ccm group group-number Creates a Cisco Unified CME group and enters SCCP
configuration mode for Cisco Unified CME.
Example: • group-number—Number that identifies the
Router(config)# sccp ccm group 1 Cisco Unified CME group.
Note A Cisco Unified CME group is a naming device
under which data for the DSP farms is declared.
Only one group is required.
Step 10 bind interface interface-type interface-number (Optional) Binds an interface to a Cisco Unified CME
group so that the selected interface is used for all calls that
belong to the profiles that are associated to this
Example:
Router(config-sccp-ccm)# bind interface
Cisco Unified CME group.
FastEthernet 0/0 • This command is optional, but we recommend it if you
have more than one profile or if you are on different
subnets, to ensure that the correct interface is selected.
Cisco Unified Communications Manager Express System Administrator Guide
338 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
Command or Action Purpose
Step 11 associate ccm identifier-number priority Associates a Cisco Unified CME router with a group and
priority-number establishes its priority within the group.
• identifier-number—Number that identifies the
Example: Cisco Unified CME router. See the sccp ccm command
Router(config-sccp-ccm)# associate ccm 1 in Step 7.
priority 1
• priority—The priority of the Cisco Unified CME
router in the Cisco Unified CME group. Only one
Cisco Unified CME group is possible. Default: 1.
Step 12 associate profile profile-identifier register Associates a DSP farm profile with a Cisco Unified CME
device-name group.
• profile-identifier—Number that identifies the DSP
Example: farm profile.
Router(config-sccp-ccm)# associate profile 1
register mtp000a8eaca80 • device-name—MAC address with the “mtp” prefix
added, where the MAC address is the burnt-in address
of the physical interface that is used to register as the
SCCP device.
Step 13 keepalive retries number Sets the number of keepalive retries from SCCP to
Cisco Unified CME.
Example: • number—Number of keepalive attempts. Range:
Router(config-sccp-ccm)# keepalive retries 5 1 to 32. Default: 3.
Step 14 switchover method [graceful | immediate] Sets the switchover method that the SCCP client uses when
its communication link to the active Cisco Unified CME
system goes down.
Example:
Router(config-sccp-ccm)# switchover method • graceful—Switchover happens only after all the active
immediate sessions have been terminated gracefully.
• immediate—Switches over to any one of the secondary
Cisco Unified CME systems immediately.
Step 15 switchback method {graceful | guard Sets the switch back method that the SCCP client uses when
timeout-guard-value | immediate | uptime the primary or higher priority Cisco Unified CME becomes
uptime-timeout-value}
available again.
• graceful—Switchback happens only after all the active
Example: sessions have been terminated gracefully.
Router(config-sccp-ccm)# switchback method
immediate • guard timeout-guard-value—Switchback happens
either when the active sessions have been terminated
gracefully or when the guard timer expires, whichever
happens first. Timeout value is in seconds. Range:
60 to 172800. Default: 7200.
• immediate—Switches back to the higher order
Cisco Unified CME immediately when the timer
expires, whether there is an active connection or not.
• uptime uptime-timeout-value—Initiates the uptime
timer when the higher-order Cisco Unified CME
system comes alive. Timeout value is in seconds.
Range: 60 to 172800. Default: 7200.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 339
Configuring Transcoding Resources
How to Configure Transcoding Resources
Command or Action Purpose
Step 16 switchback interval seconds Sets the amount of time that the DSP farm waits before
polling the primary Cisco Unified CME system when the
current Cisco Unified CME switchback connection fails.
Example:
Router(config-sccp-ccm)# switchback interval 5 • seconds—Timer value, in seconds. Range: 1 to 3600.
Default: 60.
Step 17 exit Exits SCCP configuration mode.
Example:
Router(config-sccp-ccm)# exit
Step 18 dspfarm profile profile-identifier transcode Enters DSP farm profile configuration mode and defines a
[security] profile for DSP farm services.
• profile-identifier—Number that uniquely identifies a
Example: profile. Range: 1 to 65535.
Router(config)# dspfarm profile 1 transcode
security • transcode—Enables profile for transcoding.
• security—Enables secure DSP farm services. This
keyword is supported in Cisco Unified CME 4.2 and
later versions.
Step 19 trustpoint trustpoint-label (Optional) Associates a trustpoint with a DSP farm profile.
Example:
Router(config-dspfarm-profile)# trustpoint
dspfarm
Step 20 codec codec-type Specifies the codecs supported by a DSP farm profile.
• codec-type—Specifies the preferred codec. Type ? for
Example: a list of supported codecs.
Router(config-dspfarm-profile)# codec g711ulaw
• Repeat this step for each supported codec.
Step 21 maximum sessions number Specifies the maximum number of sessions that are
supported by the profile.
Example: • number—Number of sessions supported by the profile.
Router(config-dspfarm-profile)# maximum Range: 0 to X. Default: 0.
sessions 5
• The X value is determined at run time depending on the
number of resources available with the resource
provider.
Step 22 associate application sccp Associates SCCP with the DSP farm profile.
Example:
Router(config-dspfarm-profile)# associate
application sccp
Step 23 end Returns to privileged EXEC mode.
Example:
Router(config-dspfarm-profile)# end
Cisco Unified Communications Manager Express System Administrator Guide
340 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
What to Do Next
• To register the DSP Farm to Cisco Unified CME in secure mode, see the “Registering the DSP Farm
with Cisco Unified CME 4.2 or a Later Version in Secure Mode” section on page 353
Configuring DSP Farms for NM-HDVs
To configure DSP farms for NM-HDVs, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice-card slot
4. dsp services dspfarm
5. exit
6. sccp local interface-type interface-number
7. sccp ccm ip-address priority priority-number
8. sccp
9. dspfarm transcoder maximum sessions number
10. dspfarm
11. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice-card slot Enters voice-card configuration mode and identifies the slot
in the chassis in which the NM-HDV or NM-HDV farm is
located.
Example:
Router(config)# voice-card 1
Step 4 dsp services dspfarm Enables DSP-farm services on the NM-HDV or NM-HDV
farm.
Example:
Router(config-voicecard)# dsp services dspfarm
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 341
Configuring Transcoding Resources
How to Configure Transcoding Resources
Command or Action Purpose
Step 5 exit Returns to global configuration mode.
Example:
Router(config-voicecard)# exit
Step 6 sccp local interface-type interface-number Selects the local interface that the SCCP applications
(transcoding and conferencing) should use to register with
Cisco Unified CME.
Example:
Router(config)# sccp local FastEthernet 0/0 • interface-type—Interface type that the SCCP
application uses to register with Cisco Unified CME.
The type can be an interface address or a
virtual-interface address such as Ethernet.
• interface-number—Interface number that the SCCP
application uses to register with Cisco Unified CME.
Step 7 sccp ccm ip-address priority priority-number Specifies the Cisco Unified CME address.
• ip-address—IP address of the Cisco Unified CME
Example: router.
Router(config)# sccp ccm 10.10.10.1 priority 1
• priority priority—Priority of the Cisco Unified CME
router relative to other connected routers. Range:
1 (highest) to 4 (lowest).
Step 8 sccp Enables SCCP and its associated transcoding and
conferencing applications.
Example:
Router(config)# sccp
Step 9 dspfarm transcoder maximum sessions number Specifies the maximum number of transcoding sessions to
be supported by the DSP farm. A DSP can support up to
four transcoding sessions.
Example:
Router(config)# dspfarm transcoder maximum Note When you assign this value, take into account the
sessions 12 number of DSPs allocated for conferencing
services.
Step 10 dspfarm Enables the DSP farm.
Example:
Router(config)# dspfarm
Step 11 end Returns to privileged EXEC mode.
Example:
Router(config)# end
Cisco Unified Communications Manager Express System Administrator Guide
342 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
Configuring the Cisco Unified CME Router to Act as the DSP Farm Host
To configure the Cisco Unified CME router to act as the DSP farm host, perform the following tasks.
• Determining DSP Resource Requirements for Transcoding, page 335
• Setting the Cisco Unified CME Router to Receive IP Phone Messages, page 343
• Configuring the Cisco Unified CME Router to Act as the DSP Farm Host, page 343
Determining the Maximum Number of Transcoder Sessions
To determine the maximum number of transcoder sessions that can occur at one time perform the
following steps.
SUMMARY STEPS
1. dspfarm transcoder maximum sessions
2. show sdspfarm sessions
3. show sdspfarm units
4. Determine maximum number of transcoder sessions based on values in steps 2 and 3.
DETAILED STEPS
Step 1 Use the dspfarm transcoder maximum sessions command to set the maximum number of transcoder
sessions you have configured.
Step 2 Use the show sdspfarm sessions command to display the number of transcoder sessions that are active.
Step 3 Use the show sdspfarm units command to display the number of DSP farms that are configured.
Step 4 Obtain the maximum number of transcoder sessions by multiplying the number of transcoder sessions
from Step 2 (configured in Step 1 using the dspfarm transcoder maximum sessions command) by the
number of DSP farms from Step 3.
Setting the Cisco Unified CME Router to Receive IP Phone Messages
To set the Cisco Unified CME router to receive IP phone messages, perform the following steps.
Note You can unregister all active calls’ transcoding streams with the sdspfarm unregister force command.
Prerequisites
Identify the MAC address of the SCCP client interface. For example, if you have the following
configuration:
interface FastEthernet 0/0
ip address 10.5.49.160 255.255.0.0
.
.
.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 343
Configuring Transcoding Resources
How to Configure Transcoding Resources
sccp local FastEthernet 0/0
sccp
The show interface FastEthernet 0/0 command will yield a MAC address. In the following example,
the MAC address of the Fast Ethernet interface is 000a.8aea.ca80:
Router# show interface FastEthernet 0/0
.
.
.
FastEthernet0/0 is up, line protocol is up
Hardware is AmdFE, address is 000a.8aea.ca80 (bia 000a.8aea.ca80)
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. ip source-address ip-address [port port] [any-match | strict-match]
5. sdspfarm units number
6. sdspfarm transcode sessions number
7. sdspfarm tag number device-number
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
344 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
Command or Action Purpose
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 ip source-address ip-address [port port] Enables a router to receive messages from Cisco Unified IP
[any-match | strict-match] phones through the router’s IP addresses and ports.
• address—Range: 0 to 5. Default: 0.
Example:
Router(config-telephony)# ip source address
• port port—(Optional) TCP/IP port used for SCCP.
10.10.10.1 port 3000 Default: 2000.
• any-match—(Optional) Disables strict IP address
checking for registration. This is the default.
• strict-match—(Optional) Requires strict IP address
checking for registration.
Step 5 sdspfarm units number Specifies the maximum number of DSP farms that are
allowed to be registered to the SCCP router.
Example: • number—Range: 0 to 5. Default: 0.
Router(config-telephony)# sdspfarm units 4
Step 6 sdspfarm transcode sessions number Specifies the maximum number of transcoder sessions for
G.729 allowed by the Cisco Unified CME router.
Example: • One transcoder session consists of two transcoding
Router(config-telephony)# sdspfarm transcode streams between callers using transcode. Use the
sessions 40 maximum number of transcoding sessions and
conference calls that you want your router to support at
one time.
• number—See the “Determining the Maximum Number
of Transcoder Sessions” section on page 343. Range:
0 to 128. Default: 0.
Step 7 sdspfarm tag number device-name Permits a DSP farm unit to be registered to
Cisco Unified CME and associates it with an SCCP client
interface’s MAC address.
Example:
Router(config-telephony)# sdspfarm tag 1 • Required only if you blocked automatic registration by
mtp000a8eaca80 using the auto-reg-ephone command.
or
• number—The tag number. Range: 1 to 5.
Router(config-telephony)# sdspfarm tag 1
MTP000a8eaca80 • device-name—MAC address of the SCCP client
interface with the “MTP” prefix added.
Step 8 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 345
Configuring Transcoding Resources
How to Configure Transcoding Resources
Configuring the Cisco Unified CME Router to Host a Secure DSP Farm
You must configure the Media Encryption Secure Real-Time Transport Protocol (SRTP) feature in the
Cisco Unified CME 4.2 and later versions, making it a secure Cisco Unified CME, before it can host a
secure DSP farm. See “Configuring Security” on page 427 for information on configuring a secure
Cisco Unified CME.
Modifying DSP Farms for NM-HDVs After Upgrading Cisco IOS Software
To ensure continued support for existing DSP farms for NM-HDVs configured after upgrading the
Cisco IOS software on your Cisco router, perform the following steps.
Note Perform this task if previously-configured DSP farms for NM-HDVs fail to register to
Cisco Unified CME after you upgrade the Cisco IOS software release.
Prerequisites
Confirm that device name for a dspfarm tag in telephony-service configuration is lower case by using
the show-running configuration command.
Example:
Router#show-running configuration
Building configuration...
.
.
.
!
telephony-service
max-ephones 2
max-dn 20
ip source-address 142.103.66.254 port 2000
auto assign 1 to 2
system message Your current options
sdspfarm units 2
sdspfarm transcode sessions 16
sdspfarm tag 1 mtp00164767cc20 !<===Device name is MAC address with lower-case “mtp”
prefix
.
.
.
SUMMARY STEPS
1. enable
2. configure terminal
3. no sdspfarm tag number
4. sdspfarm tag number device-name
5. end
Cisco Unified Communications Manager Express System Administrator Guide
346 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 no sdspfarm tag number Disables the DSP farm.
Example:
Router(config)# no sdspfarm tag 1
Step 4 sdspfarm tag number device-name Permits a digital-signal-processor (DSP) farm to be to
registered to Cisco Unified CME and associates it with a
SCCP client interface's MAC address.
Example:
Router(config)# sdspfarm tag 1 MTP00164767cc20 • Required only if you blocked automatic registration by
using the auto-reg-ephone command.
• device-name—MAC address of the SCCP client
interface with the “MTP” prefix added.
Step 5 dspfarm Enables the DSP farm.
Example:
Router(config)# dspfarm
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config)# end
Modifying the Number of Transcoding Sessions for NM-HDVs
To modify the maximum number of transcoding sessions for NM-HDVs, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. no dspfarm
4. dspfarm transcoder maximum sessions number
5. dspfarm
6. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 347
Configuring Transcoding Resources
How to Configure Transcoding Resources
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 no dspfarm Disables the DSP farm.
Example:
Router(config)# no dspfarm
Step 4 dspfarm transcoder maximum sessions number Specifies the maximum number of transcoding sessions to
be supported by the DSP farm.
Example:
Router(config)# dspfarm transcoder maximum
sessions 12
Step 5 dspfarm Enables the DSP farm.
Example:
Router(config)# dspfarm
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config)# end
Tuning DSP-Farm Performance on an NM-HDV
To tune DSP farm performance, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. sccp ip precedence value
4. dspfarm rtp timeout seconds
5. dspfarm connection interval seconds
6. end
Cisco Unified Communications Manager Express System Administrator Guide
348 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 sccp ip precedence value (Optional) Sets the IP precedence value to increase the
priority of voice packets over connections controlled by
SCCP.
Example:
Router(config)# sccp ip precedence 5
Step 4 dspfarm rtp timeout seconds (Optional) Configures the Real-Time Transport Protocol
(RTP) timeout interval if the error condition “RTP port
unreachable” occurs.
Example:
Router(config)# dspfarm rtp timeout 60
Step 5 dspfarm connection interval seconds (Optional) Specifies how long to monitor RTP inactivity
before deleting an RTP stream.
Example:
Router(config)# dspfarm connection interval 60
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config)# end
Verifying DSP Farm Operation
To verify that the DSP farm is registered and running, perform the following steps in any order.
SUMMARY STEPS
1. show sccp [statistics | connections]
2. show sdspfarm units
3. show sdspfarm sessions
4. show sdspfarm sessions summary
5. show sdspfarm sessions active
6. show sccp connections details
7. debug sccp {all | errors | events | packets | parser}
8. debug dspfarm {all | errors | events | packets}
9. debug ephone mtp
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 349
Configuring Transcoding Resources
How to Configure Transcoding Resources
DETAILED STEPS
Step 1 Use the show sccp [statistics | connections] command to display the SCCP configuration information
and current status.
Router# show sccp statistics
SCCP Application Service(s) Statistics:
Profile ID:1, Service Type:Transcoding
TCP packets rx 7, tx 7
Unsupported pkts rx 1, Unrecognized pkts rx 0
Register tx 1, successful 1, rejected 0, failed 0
KeepAlive tx 0, successful 0, failed 0
OpenReceiveChannel rx 2, successful 2, failed 0
CloseReceiveChannel rx 0, successful 0, failed 0
StartMediaTransmission rx 2, successful 2, failed 0
StopMediaTransmission rx 0, successful 0, failed 0
Reset rx 0, successful 0, failed 0
MediaStreamingFailure rx 0
Switchover 0, Switchback 0
Use the show sccp connections command to display information about the connections controlled by
the SCCP transcoding and conferencing applications. In the following example, the secure value of the
stype field indicates that the connection is encrypted:
Router# show sccp connections
sess_id conn_id stype mode codec ripaddr rport sport
16777222 16777409 secure-xcode sendrecv g729b 10.3.56.120 16772 19534
16777222 16777393 secure-xcode sendrecv g711u 10.3.56.50 17030 18464
Total number of active session(s) 1, and connection(s) 2
Step 2 Use the show sdspfarm units command to display the configured and registered DSP farms.
Router# show sdspfarm units
mtp-1 Device:MTP003080218a31 TCP socket:[2] REGISTERED
actual_stream:8 max_stream 8 IP:10.10.10.3 11470 MTP YOKO keepalive 1
Supported codec:G711Ulaw
G711Alaw
G729a
G729ab
max-mtps:1, max-streams:40, alloc-streams:8, act-streams:2
Cisco Unified Communications Manager Express System Administrator Guide
350 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
Step 3 Use the show sdspfarm sessions command to display the transcoding streams.
Router# show sdspfarm sessions
Stream-ID:1 mtp:1 10.10.10.3 18404 Local:2000 START
usage:Ip-Ip
codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:2
Stream-ID:2 mtp:1 10.10.10.3 17502 Local:2000 START
usage:Ip-Ip
codec:G729AnnexA duration:20 vad:0 peer Stream-ID:1
Stream-ID:3 mtp:1 0.0.0.0 0 Local:0 IDLE
usage:
codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:0
Stream-ID:4 mtp:1 0.0.0.0 0 Local:0 IDLE
usage:
codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:0
Stream-ID:5 mtp:1 0.0.0.0 0 Local:0 IDLE
usage:
codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:0
Stream-ID:6 mtp:1 0.0.0.0 0 Local:0 IDLE
usage:
codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:0
Stream-ID:7 mtp:1 0.0.0.0 0 Local:0 IDLE
usage:
codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:0
Stream-ID:8 mtp:1 0.0.0.0 0 Local:0 IDLE
usage:
codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:0
Step 4 Use the show sdspfarm sessions summary command to display a summary view the transcoding
streams.
Router# show sdspfarm sessions summary
max-mtps:2, max-streams:240, alloc-streams:40, act-streams:2
ID MTP State CallID confID Usage Codec/Duration
==== ===== ====== =========== ====== ============================= ==============
1 2 IDLE -1 0 G711Ulaw64k /20ms
2 2 IDLE -1 0 G711Ulaw64k /20ms
3 2 START -1 3 MoH (DN=3 , CH=1) FE=TRUE G729 /20ms
4 2 START -1 3 MoH (DN=3 , CH=1) FE=FALSE G711Ulaw64k /20ms
5 2 IDLE -1 0 G711Ulaw64k /20ms
6 2 IDLE -1 0 G711Ulaw64k /20ms
7 2 IDLE -1 0 G711Ulaw64k /20ms
8 2 IDLE -1 0 G711Ulaw64k /20ms
9 2 IDLE -1 0 G711Ulaw64k /20ms
10 2 IDLE -1 0 G711Ulaw64k /20ms
11 2 IDLE -1 0 G711Ulaw64k /20ms
12 2 IDLE -1 0 G711Ulaw64k /20ms
13 2 IDLE -1 0 G711Ulaw64k /20ms
14 2 IDLE -1 0 G711Ulaw64k /20ms
15 2 IDLE -1 0 G711Ulaw64k /20ms
16 2 IDLE -1 0 G711Ulaw64k /20ms
17 2 IDLE -1 0 G711Ulaw64k /20ms
18 2 IDLE -1 0 G711Ulaw64k /20ms
19 2 IDLE -1 0 G711Ulaw64k /20ms
20 2 IDLE -1 0 G711Ulaw64k /20ms
21 2 IDLE -1 0 G711Ulaw64k /20ms
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 351
Configuring Transcoding Resources
How to Configure Transcoding Resources
22 2 IDLE -1 0 G711Ulaw64k /20ms
23 2 IDLE -1 0 G711Ulaw64k /20ms
24 2 IDLE -1 0 G711Ulaw64k /20ms
25 2 IDLE -1 0 G711Ulaw64k /20ms
26 2 IDLE -1 0 G711Ulaw64k /20ms
27 2 IDLE -1 0 G711Ulaw64k /20ms
28 2 IDLE -1 0 G711Ulaw64k /20ms
29 2 IDLE -1 0 G711Ulaw64k /20ms
30 2 IDLE -1 0 G711Ulaw64k /20ms
31 2 IDLE -1 0 G711Ulaw64k /20ms
32 2 IDLE -1 0 G711Ulaw64k /20ms
33 2 IDLE -1 0 G711Ulaw64k /20ms
34 2 IDLE -1 0 G711Ulaw64k /20ms
35 2 IDLE -1 0 G711Ulaw64k /20ms
36 2 IDLE -1 0 G711Ulaw64k /20ms
Step 5 Use the show sdspfarm sessions active command to display the transcoding streams for all active
sessions.
Router# show sdspfarm sessions active
Stream-ID:1 mtp:1 10.10.10.3 18404 Local:2000 START
usage:Ip-Ip
codec:G711Ulaw64k duration:20 vad:0 peer Stream-ID:2
Stream-ID:2 mtp:1 10.10.10.3 17502 Local:2000 START
usage:Ip-Ip
codec:G729AnnexA duration:20 vad:0 peer Stream-ID:1
Step 6 Use the show sccp connections details command to display the SCCP connections details such as
call-leg details.
Router# show sccp connections details
bridge-info(bid, cid) - Normal bridge information(Bridge id, Calleg id)
mmbridge-info(bid, cid) - Mixed mode bridge information(Bridge id, Calleg id)
sess_id conn_id call-id codec pkt-period type bridge-info(bid, cid)
mmbridge-info(bid, cid)
1 - 14 N/A N/A transmsp All RTPSPI Callegs N/A
1 2 15 g729a 20 rtpspi (4,14) N/A
1 1 13 g711u 20 rtpspi (3,14) N/A
Total number of active session(s) 1, connection(s) 2, and callegs 3
Step 7 Use the debug sccp {all | errors | events | packets | parser} command to set debugging levels for SCCP
and its applications.
Step 8 Use the debug dspfarm {all | errors | events | packets} command to set debugging levels for DSP-farm
service
Step 9 Use the debug ephone mtp command to enable Message Transfer Part (MTP) debugging. Use this
debug command with the debug ephone mtp, debug ephone register, debug ephone state, and debug
ephone pak commands.
Cisco Unified Communications Manager Express System Administrator Guide
352 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
Registering the DSP Farm with Cisco Unified CME 4.2 or a Later Version in
Secure Mode
The DSP farm can reside on the same router with the Cisco Unified CME or on a different router. Some
of the steps in the following tasks are optional depending the location of the DSP farm.
This section contains the following tasks:
• Obtaining a Digital Certificate from a CA Server, page 353
• Copying the CA Root Certificate of the DSP Farm Router to the Cisco Unified CME Router,
page 359
• Copying the CA Root Certificate of the Cisco Unified CME Router to the DSP farm Router,
page 360
• Configuring Cisco Unified CME to Allow the DSP Farm to Register, page 360
• Verifying DSP Farm Registration with Cisco Unified CME, page 362
Obtaining a Digital Certificate from a CA Server
The CA server can be the same router as the DSP farm. The DSP farm router can be configured as a CA
server. The configuration steps below show how to configure a CA server on the DSP farm router.
Additional configurations are required for configuring CA server on an external Cisco router or using a
different CA server by itself.
This section contains the following tasks:
• Configuring a CA Server, page 353 (Optional)
• Creating a Trustpoint, page 356
• Authenticating and Enrolling the Certificate with the CA Server, page 358
Configuring a CA Server
Note Skip this procedure if the DSP farm resides on the same router as the Cisco Unified CME. Proceed to
the “Creating a Trustpoint” section on page 356.
The CA server automatically creates a trustpoint where the certificates are stored. The automatically
created trustpoint stores the CA root certificate.
Prerequisites
• Cisco Unified CME 4.2 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. crypto pki server label
4. database level complete
5. grant auto
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 353
Configuring Transcoding Resources
How to Configure Transcoding Resources
6. database url root-url
7. no shutdown
8. crypto pki trustpoint label
9. revocation-check crl
10. rsakeypair key-label
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 crypto pki server label Defines a label for the certificate server and enters
certificate-server configuration mode.
Example: • label—Name for CA certificate server.
Router(config)# crypto pki server dspcert
Step 4 database level complete (Optional) Controls the type of data stored in the certificate
enrollment database. The default if this command is not
used is minimal.
Example:
Router(cs-server)# database level complete • complete—In addition to the information given in the
minimal and names levels, each issued certificate is
written to the database.
Note The complete keyword produces a large amount of
information; so specify an external TFTP server in
which to store the data using of the database url
command.
Step 5 grant auto (Optional) Allows an automatic certificate to be issued to
any requester. The recommended method and default if this
command is not used is manual enrollment.
Example:
Router(cs-server)# grant auto Tip Use this command only during enrollment when
testing and building simple networks. A security
best practice is to disable this functionality using
the no grant auto command after configuration so
that certificates cannot be continually granted.
Cisco Unified Communications Manager Express System Administrator Guide
354 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
Command or Action Purpose
Step 6 database url root-url (Optional) Specifies the location where all database entries
for the certificate server are to be written out. If this
command is not specified, all database entries are written to
Example:
Router(cs-server)# database url nvram:
NVRAM.
• root-url—Location where database entries will be
written out. The URL can be any URL that is supported
by the Cisco IOS file system.
Note If the CA is going to issue a large number of
certificates, select an appropriate storage location
like flash or other storage device to store the
certificates.
Note When the storage location chosen is flash and the
file system type on this device is Class B (LEFS),
make sure to check free space on the device
periodically and use the squeeze command to free
the space used up by deleted files. This process may
take several minutes and should be done during
scheduled maintenance periods or off-peak hours.
Step 7 no shutdown (Optional) Enables the CA.
Note You should use this command only after you have
Example: completely configured the CA.
Router(cs-server)# no shutdown
Step 8 exit Exits certificate-server configuration mode.
Example:
Router(cs-server)# exit
Step 9 crypto pki trustpoint label (Optional) Declares a trustpoint and enters ca-trustpoint
configuration mode.
Example: • label—Name for the trustpoint. The label
Router(config)# crypto pki trustpoint dspcert
Note Use this command and the enrollment url
command if this CA is local to the
Cisco Unified CME router. These commands are
not needed for a CA running on an external router.
The label has to be the same as the label in Step 3.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 355
Configuring Transcoding Resources
How to Configure Transcoding Resources
Command or Action Purpose
Step 10 revocation-check crl (Optional) Checks the revocation status of a certificate and
specifies one or more methods to check the status. If a
second and third method are specified, each method is used
Example:
Router(ca-trustpoint)# revocation-check crl
only if the previous method returns an error, such as a server
being down.
• crl—Certificate checking is performed by a certificate
revocation list (CRL). This is the default behavior.
Step 11 rsakeypair key-label (Optional) Specifies an RSA key pair to use with a
certificate.
Example: • key-label—Name of the key pair, which is generated
Router(ca-trustpoint)# rsakeypair caserver during enrollment if it does not already exist or if the
auto-enroll regenerate command is used.
Note Multiple trustpoints can share the same key.
Creating a Trustpoint
The trustpoint stores the digital certificate for the DSP farm. To create a trustpoint, perform the
following procedure:
Prerequisites
• Cisco Unified CME 4.2 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. crypto pki trustpoint label
4. enrollment url ca-url
5. serial-number none
6. fqdn none
7. ip-address none
8. subject-name [x.500-name]
9. revocation-check none
10. rsakeypair key-label
Cisco Unified Communications Manager Express System Administrator Guide
356 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 crypto pki trustpoint label Declares the trustpoint that your RA mode certificate server
should use and enters CA-trustpoint configuration mode.
Example: • label—Name for the trustpoint and RA.
Router(config)# crypto pki trustpoint dspcert
Step 4 enrollment url ca-url Specifies the enrollment URL of the issuing CA certificate
server (root certificate server).
Example: • ca-url—URL of the router on which the root CA is
Router(ca-trustpoint)# enrollment url installed.
http://10.3.105.40:80
Step 5 serial-number none Specifies whether the router serial number should be
included in the certificate request.
Example: • none—Specifies that a serial number will not be
Router(ca-trustpoint)# serial-number none included in the certificate request.
Step 6 fqdn none Specifies a fully qualified domain name (FQDN) that will
be included as “unstructuredName” in the certificate
request.
Example:
Router(ca-trustpoint)# fqdn none • none—Router FQDN will not be included in the
certificate request.
Step 7 ip-address none Specifies a dotted IP address or an interface that will be
included as “unstructuredAddress” in the certificate
request.
Example:
Router(ca-trustpoint)# ip-address none • none—Specifies that an IP address is not to be included
in the certificate request.
Step 8 subject-name [x.500-name] Specifies the subject name in the certificate request.
Note The example shows how to format the certificate
Example: subject name to be similar to that of an IP phone’s.
Router(ca-trustpoint)# subject-name cn=vg224,
ou=ABU, o=Cisco Systems Inc.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 357
Configuring Transcoding Resources
How to Configure Transcoding Resources
Command or Action Purpose
Step 9 revocation-check none (Optional) Checks the revocation status of a certificate and
specifies one or more methods to check the status. If a
second and third method are specified, each method is used
Example:
Router(ca-trustpoint)# revocation-check none
only if the previous method returns an error, such as a server
being down.
• none—Certificate checking is not required.
Step 10 rsakeypair key-label (Optional) Specifies an RSA key pair to use with a
certificate.
Example: • key-label—Name of the key pair, which is generated
Router(ca-trustpoint)# rsakeypair dspcert during enrollment if it does not already exist or if the
auto-enroll regenerate command is used.
Note Multiple trustpoints can share the same key.
The key-label is the same as the label in Step 3.
Authenticating and Enrolling the Certificate with the CA Server
Prerequisites
• Cisco Unified CME 4.2 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. crypto pki authenticate trustpoint-label
4. crypto pki enroll trustpoint-label
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
358 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
Command or Action Purpose
Step 3 crypto pki authenticate trustpoint-label Retrieves the CA certificate and authenticates it. Checks the
certificate fingerprint if prompted.
Example: • trustpoint-label—Trustpoint label.
Router(config)# crypto pki authenticate dspcert
Note The trustpoint-label is the trustpoint label specified
in the “Creating a Trustpoint” section on page 356.
Step 4 crypto pki enroll trustpoint-label Enrolls with the CA and obtains the certificate for this
trustpoint.
Example: • trustpoint-label—Trustpoint label.
Router(config)# crypto pki enroll dspcert
Note The trustpoint-label is the trustpoint label specified
in the “Creating a Trustpoint” section on page 356.
Copying the CA Root Certificate of the DSP Farm Router to the Cisco Unified CME Router
The DSP farm router and Cisco Unified CME router exchanges certificates during the registration
process. These certificates are digitally signed by the CA server of the respective router. For the routers
to accept each others digital certificate, they should have the CA root certificate of each other. Manually
copy the CA root certificate of the DSP farm and Cisco Unified CME router to each other.
Prerequisites
• Cisco Unified CME 4.2 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. crypto pki trustpoint name
4. enrollment terminal
5. crypto pki export trustpoint pem terminal
6. crypto pki authenticate trustpoint-label
7. You will be prompted to enter the CA certificate. Cut and paste the base 64 encoded certificate at
the command line, then press Enter, and type “quit.” The router prompts you to accept the
certificate. Enter “yes” to accept the certificate.
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 359
Configuring Transcoding Resources
How to Configure Transcoding Resources
Command or Action Purpose
Step 3 crypto pki trustpoint label Declares the trustpoint that your RA mode certificate server
should use and enters CA-trustpoint configuration mode.
Example: • label—Name for the trustpoint and RA.
Router(config)# crypto pki trustpoint dspcert
Note The label is the trustpoint label specified in the
“Creating a Trustpoint” section on page 356.
Step 4 enrollment terminal Specifies manual cut-and-paste certificate enrollment.
Example:
Router(ca-trustpoint)# enrollment terminal
Step 5 crypto pki export trustpoint pem terminal Exports certificates and RSA keys that are associated with
a trustpoint in a privacy-enhanced mail (PEM)-formatted
file.
Example:
Router(ca-trustpoint)# crypto pki export
dspcert pem terminal
Step 6 crypto pki authenticate trustpoint-label Retrieves the CA certificate and authenticates it. Checks the
certificate fingerprint if prompted.
Example: • trustpoint-label—Trustpoint label.
Router(config)# crypto pki authenticate vg224
Note This command is optional if the CA certificate is
already loaded into the configuration.
Step 7 You will be prompted to enter the CA certificate. Cut Completes the copying of the CA root certificate of the DSP
and paste the base 64 encoded certificate at the farm router to the Cisco Unified CME router.
command line, then press Enter, and type “quit.” The
router prompts you to accept the certificate. Enter
“yes” to accept the certificate.
Copying the CA Root Certificate of the Cisco Unified CME Router to the DSP farm Router
Repeat the steps in the “Copying the CA Root Certificate of the DSP Farm Router to the Cisco Unified
CME Router” section on page 359 in the opposite direction, that is, from Cisco Unified CME router to
the DSP farm router.
Prerequisites
• Cisco Unified CME 4.2 or a later version.
Configuring Cisco Unified CME to Allow the DSP Farm to Register
Prerequisites
• Cisco Unified CME 4.2 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
360 OL-10663-02
Configuring Transcoding Resources
How to Configure Transcoding Resources
4. sdspfarm units number
5. sdspfarm transcode sessions number
6. sdspfarm tag number device-name
7. exit
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 sdspfarm units number Specifies the maximum number of digital-signal-processor
(DSP) farms that are allowed to be registered to the Skinny
Client Control Protocol (SCCP) server.
Example:
Router(config-telephony)# sdspfarm units 1
Step 5 sdspfarm transcode sessions number Specifies the maximum number of transcoding sessions
allowed per Cisco Unified CME router.
Example: • number—Declares the number of DSP farm sessions.
Router(config-telephony)# sdspfarm transcode Valid values are numbers from 1 to 128.
sessions 30
Step 6 sdspfarm tag number device-name Permits a DSP farm to register to Cisco Unified CME and
associates it with a SCCP client interface's MAC address.
Example: Note The device-name in this step must be the same as the
Router(config-telephony)# sdspfarm tag 1 vg224 device-name in the associate profile command in
Step 17 of the “Configuring DSP Farms for
NM-HDs and NM-HDV2s” section on page 336.
Step 7 exit Exits telephony-service configuration mode.
Example:
Router(config-telephony)# exit
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 361
Configuring Transcoding Resources
How to Configure Transcoding Resources
Verifying DSP Farm Registration with Cisco Unified CME
Use the show sdspfarm units command to verify that the DSP farm is registering with
Cisco Unified CME. Use the show voice dsp group slot command to show the status of secure
conferencing.
Prerequisites
• Cisco Unified CME 4.2 or a later version.
show sdspfarm units: Example
Router# show sdspfarm units
mtp-2 Device:choc2851SecCFB1 TCP socket:[1] REGISTERED
actual_stream:8 max_stream 8 IP:10.1.0.20 37043 MTP YOKO keepalive 17391
Supported codec: G711Ulaw
G711Alaw
G729
G729a
G729ab
GSM FR
max-mtps:2, max-streams:60, alloc-streams:18, act-streams:0
show voice dsp: Example
Router# show voice dsp group slot 1
dsp 13:
State: UP, firmware: 4.4.706
Max signal/voice channel: 16/16
Max credits: 240
Group: FLEX_GROUP_VOICE, complexity: FLEX
Shared credits: 180, reserved credits: 0
Signaling channels allocated: 2
Voice channels allocated: 0
Credits used: 0
Group: FLEX_GROUP_XCODE, complexity: SECURE MEDIUM
Shared credits: 0, reserved credits: 60
Transcoding channels allocated: 0
Credits used: 0
dsp 14:
State: UP, firmware: 1.0.6
Max signal/voice channel: 16/16
Max credits: 240
Group: FLEX_GROUP_CONF, complexity: SECURE CONFERENCE
Shared credits: 0, reserved credits: 240
Conference session: 1
Credits used: 0
Cisco Unified Communications Manager Express System Administrator Guide
362 OL-10663-02
Configuring Transcoding Resources
Configuration Examples for Transcoding Resources
Configuration Examples for Transcoding Resources
This section contains the following examples:
• DSP Farms for NM-HDVs: Example, page 363
• DSP Farms for NM-HDs and NM-HDV2s: Example, page 363
• Cisco Unified CME Router as the DSP Farm Host: Example, page 364
DSP Farms for NM-HDVs: Example
The following example sets up a DSP farm of 4 DSPs to handle up to 16 sessions (4 sessions per DSP)
on a router with an IP address of 10.5.49.160 and a priority of 1 among other servers.
voice-card 1
dsp services dspfarm
exit
sccp local FastEthernet 0/0
sccp
sccp ccm 10.5.49.160 priority 1
dspfarm transcoder maximum sessions 16
dspfarm
telephony-service
ip source-address 10.5.49.200 port 2000
sdspfarm units 4
sdspfarm transcode sessions 40
sdspfarm tag 1 mtp000a8eaca80
sdspfarm tag 2 mtp123445672012
DSP Farms for NM-HDs and NM-HDV2s: Example
The following example sets up six transcoding sessions on a router with one DSP farm, an IP address of
10.5.49.160, and a priority of 1 among servers.
voice-card 1
dsp services dspfarm
sccp local FastEthernet 0/1
sccp
sccp ccm 10.5.49.160 identifier 1
sccp ccm group 123
associate ccm 1 priority
associate profile 1 register mtp123456792012
keepalive retries 5
switchover method immediate
switchback method immediate
switchback interval 5
dspfarm profile 1 transcode
codec g711ulaw
codec g711alaw
codec g729ar8
codec g729abr8
maximum sessions 6
associate application sccp
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 363
Configuring Transcoding Resources
Where to go Next
telephony-service
ip source-address 10.5.49.200 port 2000
sdspfarm units 1
sdspfarm transcode sessions 40
sdspfarm tag 1 mtp000a8eaca80
sdspfarm tag 2 mtp123445672012
Cisco Unified CME Router as the DSP Farm Host: Example
The following example configures Cisco Unified CME router address 10.100.10.11 port 2000 to be the
farm host using the DSP farm at mtp000a8eaca80 to allow for a maximum of 1 DSP farm and 16
transcoder sessions.
telephony-service
ip source address 10.100.10.11 port 2000
sdspfarm units 1
sdspfarm transcode sessions 16
sdspfarm tag 1 mtp000a8eaca80
Where to go Next
Music on Hold
Music on hold can require transcoding resources. See “Configuring Music on Hold” on page 963.
Teleworker Remote Phones
Transcoding has benefits and disadvantages for remote teleworker phones. See the discussion in
“Configuring Phones to Make Basic Calls” on page 139.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Cisco Unified Communications Manager Express System Administrator Guide
364 OL-10663-02
Configuring Transcoding Resources
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 365
Configuring Transcoding Resources
Feature Information for Transcoding Resources
Feature Information for Transcoding Resources
Table 25 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 25 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 25 Feature Information for Transcoding Resources
Cisco Unified CME
Feature Name Version Feature Information
Secure Transcoding 4.2 Secure transcoding for calls using the codec g729r8
dspfarm-assist command was introduced.
Transcoding Support 3.2 Transcoding between G.711 and G.729 was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
366 OL-10663-02
Configuring Toll Fraud Prevention
First Published: July 21, 2010
This module describes the Toll Fraud Prevention feature in Cisco Unified Communications Manager
Express (Cisco Unified CME).
Finding Feature Information
Your software release may not support all the features documented in this module. For the latest feature
information and caveats, see the release notes for your platform and software release. To find information
about the features documented in this module, and to see a list of the releases in which each feature is
supported, see the “Feature Information for Toll Fraud Prevention” section on page 382.
Use Cisco Feature Navigator to find information about platform support and Cisco IOS and Catalyst OS
software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An
account on Cisco.com is not required.
Contents
• Prerequisites for Configuring Toll Fraud Prevention, page 368
• Restrictions for Configuring VRF Support, page 1207
• Information About Toll Fraud Prevention, page 368
• How to Configure Toll Fraud Prevention, page 370
• Additional References, page 380
• Feature Information for Toll Fraud Prevention, page 382
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 367
Configuring Toll Fraud Prevention
Prerequisites for Configuring Toll Fraud Prevention
Prerequisites for Configuring Toll Fraud Prevention
• Cisco Unified CME 8.1 or a later version.
• Cisco IOS Release 15.1(2)T.
Information About Toll Fraud Prevention
Cisco Unified CME 8.1 enhances the Toll Fraud Prevention feature to secure the Cisco Unified CME
system against potential toll fraud exploitation by unauthorized users. The following are the
enhancements to Toll Fraud Prevention in Cisco Unified CME:
• IP Address Trusted Authentication
• Direct Inward Dial for Incoming ISDN Calls
• Disconnecting ISDN Calls With no Matching Dial-peer
• Blocking Two-stage Dialing Service on Analog and Digital FXO Ports
IP Address Trusted Authentication
IP address trusted authentication process blocks unauthorized calls and helps secure the
Cisco Unified CME system against potential toll fraud exploitation by unauthorized users. In
Cisco Unified CME, IP address trusted authentication is enabled by default. When IP address trusted
authenticate is enabled, Cisco Unified CME accepts incoming VoIP (SIP/H.323) calls only if the remote
IP address of an incoming VoIP call is successfully validated from the system IP address trusted list.
If the IP address trusted authentication fails, an incoming VoIP call is then disconnected by the
application with a user- defined cause code and a new application internal error code 31 message
(TOLL_FRAUD_CALL_BLOCK) is logged. For more information, see the, “Configuring IP Address
Trusted Authentication for Incoming VoIP Calls” section on page 370.
Cisco Unified CME maintains an IP address trusted list to validate the remote IP addresses of
incoming VOIP calls. Cisco Unified CME saves an IPv4 session target of VoIP dial-peer to add the
trusted IP addresses to IP address trusted list automatically.The IPv4 session target is identified as a
trusted IP address only if the status of VoIP dial-peer in operation is “UP”. Up to 10050 IPv4 addresses
can be defined in the trusted IP address list. No duplicate IP addresses are allowed in the trusted IP
address list. You can manually add up to 100 trusted IP addresses for incoming VOIP calls. For more
information on manually adding trusted IP addresses, see the, “Adding Valid IP Addresses For Incoming
VoIP Calls” section on page 373.
A call detail record (CDR) history record is generated when the call is blocked as a result of IP address
trusted authentication failure. A new voice Internal Error Code (IEC) is saved to the CDR history record.
The voice IEC error messages are logged to syslog if “voice iec syslog” option is enabled. The following
is an IEC toll fraud call rejected syslog display:
*Aug 14 19:54:32.507: %VOICE_IEC-3-GW: Application Framework Core: Internal Error (Toll
fraud call rejected): IEC=1.1.228.3.31.0 on callID 3 GUID=AE5066C5883E11DE8026A96657501A09
The IP address trusted list authentication must be suspended when Cisco Unified CME is defined with
“gateway” and a VoIP dial-peer with “session-target ras” is in operational UP status. The incoming VOIP
call routing is then controlled by the gatekeeper. Table 26 shows administration state and operational
state in different trigger conditions.
Cisco Unified Communications Manager Express System Administrator Guide
368 OL-10663-02
Configuring Toll Fraud Prevention
Information About Toll Fraud Prevention
Table 26 Administration and Operation States of IP Address Trusted Authentication
Trigger Condition Administration State Operation State
When ip address trusted authenticate is enabled. Down Down
When “gateway” is defined and a VoIP dial-peer Up Down
with “ras” as a session target is in “UP”
operational state
When ip address trusted authenticate is enabled Up Up
and either “gateway” is not defined or no voip
dial-peer with “ras” as session target is in “UP”
operational state
Note We recommend enabling SIP authentication before enabling Out-of-dialog REFER (OOD-R) to avoid
any potential toll fraud threats.
Direct Inward Dial for Incoming ISDN Calls
In Cisco Unified CME 8.1 and later versions the direct-inward-dial isdn feature in enabled to prevent
the toll fraud for incoming ISDN calls. The called number of an incoming ISDN enbloc dialing call is
used to match the outbound dial-peers even if the direct-inward-dial option is disabled from a selected
inbound plain old telephone service (POTS) dial-peer. If no outbound dial-peer is selected for the
outgoing call set up, the incoming ISDN call is disconnected with cause-code “unassigned-number (1)”.
For more information on direct-inward dial for incoming ISDN calls, see the, “Configuring Direct
Inward Dial for Incoming ISDN Calls” section on page 375.
Disconnecting ISDN Calls With no Matching Dial-peer
Cisco Unified CME 8.1 and later versions disconnect unauthorized ISDN calls when no matching
inbound voice dial-peer is selected. Cisco Unified CME and voice gateways use the dial-peer no-match
disconnect-cause command to disconnect an incoming ISDN call when no inbound dial-peer is selected
to avoid default POTS dial-peer behavior including two-stage dialing service to handle the incoming
ISDN call.
Blocking Two-stage Dialing Service on Analog and Digital FXO Ports
Cisco Unified CME 8.1 and later versions block the two-stage dialing service which is initiated when an
Analog or Digital FXO port goes offhook and the private line automatic ringdown (PLAR) connection
is not setup from the voice-port. As a result, no outbound dial-peer is selected for an incoming analog
or digital FXO call and no dialed digits are collected from an FXO call. Cisco Unified CME and voice
gateways disconnect the FXO call with cause-code “unassigned-number (1)”. Cisco Unified CME uses
the no secondary dialtone command by default from FXO voice-port to block the two-stage dialing
service on Analog or digital FXO ports. For more information on blocking two-stage dialing service on
Analog and Digital FXO port, see Blocking Secondary Dialtone on Analog and Digital FXO Ports,
page 377.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 369
Configuring Toll Fraud Prevention
How to Configure Toll Fraud Prevention
How to Configure Toll Fraud Prevention
TThis section contains the following tasks.
• Configuring IP Address Trusted Authentication for Incoming VoIP Calls, page 370
• Adding Valid IP Addresses For Incoming VoIP Calls, page 373
• Configuring Direct Inward Dial for Incoming ISDN Calls, page 375
• Blocking Secondary Dialtone on Analog and Digital FXO Ports, page 377
• Troubleshooting Tips for Toll Fraud Prevention, page 378
Configuring IP Address Trusted Authentication for Incoming VoIP Calls
Prerequisites
• Cisco Unified CME 8.1 or a later version.
Restrictions
• IP address trusted authentication is skipped if an incoming SIP call is originated from a SIP phone.
• IP address trusted authentication is skipped if an incoming call is an IPv6 call.
• For an incoming VoIP call, IP trusted authentication must be invoked when the IP address trusted
authentication is in “UP” operational state.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice service voip
4. ip address trusted authenticate
5. ip-address trusted call-block cause <code>
6. end
7. show ip address trusted list
Cisco Unified Communications Manager Express System Administrator Guide
370 OL-10663-02
Configuring Toll Fraud Prevention
How to Configure Toll Fraud Prevention
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice service voip Enters voice service voip configuration mode.
Example:
Router(config)# voice service voip
Step 4 ip address trusted authenticate Enables IP address authentication on incoming H.323 or
SIP trunk calls for toll fraud prevention support.
Example: IP address trusted list authenticate is enabled by default.
Router(conf-voi-serv)# ip address trusted Use the “no ip address trusted list authenticate”
authenticate command to disable the IP address trusted list
authentication.
Step 5 ip-address trusted call-block cause code Issues a cause-code when the incoming call is rejected to
the IP address trusted authentication.
Example:
Router(conf-voi-serv)#ip address trusted
call-block cause call-reject Note If the IP address trusted authentication fails, a
call-reject (21) cause-code is issued to disconnect
the incoming VoIP call.
Step 6 end Returns to privileged EXEC mode.
Example:
Router()# end
Step 7 show ip address trusted list Verifies a list of valid IP addresses for incoming H.323 or
SIP trunk calls, Call Block cause for rejected incoming
calls.
Example:
Router# #show ip address trusted list
IP Address Trusted Authentication
Administration State: UP
Operation State: UP
IP Address Trusted Call Block Cause:
call-reject (21)
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 371
Configuring Toll Fraud Prevention
How to Configure Toll Fraud Prevention
Examples
Router #show ip address trusted list
IP Address Trusted Authentication
Administration State: UP
Operation State: UP
IP Address Trusted Call Block Cause: call-reject (21)
VoIP Dial-peer IPv4 Session Targets:
Peer Tag Oper State Session Target
-------- ---------- --------------
11 DOWN ipv4:1.3.45.1
1 UP ipv4:1.3.45.1
IP Address Trusted List:
ipv4 172.19.245.1
ipv4 172.19.247.1
ipv4 172.19.243.1
ipv4 171.19.245.1
ipv4 172.19.245.0 255.255.255.0''
Cisco Unified Communications Manager Express System Administrator Guide
372 OL-10663-02
Configuring Toll Fraud Prevention
How to Configure Toll Fraud Prevention
Adding Valid IP Addresses For Incoming VoIP Calls
Prerequisites
• Cisco Unified CME 8.1 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice service voip
4. ip address trusted list
5. ipv4 ipv4 address network mask
6. end
7. show ip address trusted list
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice service voip Enters voice service voip configuration mode.
Example:
Router(config)# voice service voip
Step 4 ip address trusted list Enters ip address trusted list mode and allows to manually
add additional valid IP addresses.
Example:
Router(conf-voi-serv)# ip address trusted list
Router(cfg-iptrust-list)#
Step 5 ipv4 {<ipv4 address> [<network mask>]} Allows you to add up to 100 IPv4 addresses in ip address
trusted list. Duplicate IP addresses are not allowed in the
ip address trusted list.
Example:
Router(config)#voice service voip • (Optional) network mask— allows to define a subnet
Router(conf-voi-serv)#ip taddress trusted list IP address.
Router(cfg-iptrust-list)#ipv4 172.19.245.1
Router(cfg-iptrust-list)#ipv4 172.19.243.1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 373
Configuring Toll Fraud Prevention
How to Configure Toll Fraud Prevention
Command or Action Purpose
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-register-pool)# end
Step 7 show ip address trusted list Displays a list of valid IP addresses for incoming H.323 or
SIP trunk calls.
Example:
Router# show shared-line
Examples
The following example shows 4 IP addresses configured as trusted IP addresses:
Router#show ip address trusted list
IP Address Trusted Authentication
Administration State: UP
Operation State: UP
IP Address Trusted Call Block Cause: call-reject (21)
VoIP Dial-peer IPv4 Session Targets:
Peer Tag Oper State Session Target
-------- ---------- --------------
11 DOWN ipv4:1.3.45.1
1 UP ipv4:1.3.45.1
IP Address Trusted List:
ipv4 172.19.245.1
ipv4 172.19.247.1
ipv4 172.19.243.1
ipv4 171.19.245.1
ipv4 171.19.10.1
Cisco Unified Communications Manager Express System Administrator Guide
374 OL-10663-02
Configuring Toll Fraud Prevention
How to Configure Toll Fraud Prevention
Configuring Direct Inward Dial for Incoming ISDN Calls
To configure Direct Inward Dial for incoming ISDN calls, perform the following steps:
Restrictions
• Direct-inward-dial isdn is not supported for incoming ISDN overlap dialing call.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice service pots
4. direct-inward-dial isdn
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice service pots Enters voice service configuration mode with voice
telephone-service encapsulation type (pots).
Example:
Router(config)# voice service pots
Router(conf-voi-serv)#
Step 4 direct-inward-dial isdn Enables direct-inward-dial (DID) for incoming ISDN
number. The incoming ISDN (enbloc dialing) call is treated
as if the digits were received from the DID trunk. The
Example:
Router(conf-voi-serv)#direct-inward-dial isdn
called number is used to select the outgoing dial peer. No
dial tone is presented to the caller.
Step 5 exit Exits voice service pots configuration mode.
Example:
Router(conf-voi-serv)# exit
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 375
Configuring Toll Fraud Prevention
How to Configure Toll Fraud Prevention
Examples
!
voice service voip
ip address trusted list
ipv4 172.19.245.1
ipv4 172.19.247.1
ipv4 172.19.243.1
ipv4 171.19.245.1
ipv4 171.19.10.1
allow-connections h323 to h323
allow-connections h323 to sip
allow-connections sip to h323
allow-connections sip to sip
supplementary-service media-renegotiate
sip
registrar server expires max 120 min 120
!
!
dial-peer voice 1 voip
destination-pattern 5511...
session protocol sipv2
session target ipv4:1.3.45.1
incoming called-number 5522...
direct-inward-dial
dtmf-relay sip-notify
codec g711ulaw
!
dial-peer voice 100 pots
destination-pattern 91...
incoming called-number 2...
forward-digits 4
!
Cisco Unified Communications Manager Express System Administrator Guide
376 OL-10663-02
Configuring Toll Fraud Prevention
How to Configure Toll Fraud Prevention
Blocking Secondary Dialtone on Analog and Digital FXO Ports
To block secondary dialtone on Analog and Digital FXO port, perform the following steps:
SUMMARY STEPS
1. enable
2. configure terminal
3. voice-port
4. no secondary dialtone
5. exit
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice-port Enters voice-port configuration mode.
• Type your Analog or Digital FXO port number.
Example:
Router(config)#voice-p 2/0/0
Step 4 no secondary dialtone Blocks the secondary dialtone on Analong and Digital
FXO port.
Example:
Router((config-voiceport)# no secondary
dialtone
Step 5 end Returns to privileged EXEC mode.
Example:
Router(conf-voiceport)# exit
Step 6 show run Verifies that the secondary dialtone is disabled on the
specific voice-port.
Example:
Router# show run | sec voice-port 2/0/0
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 377
Configuring Toll Fraud Prevention
How to Configure Toll Fraud Prevention
Examples
Router# conf t
Router(config)#voice-p 2/0/0
Router(config-voiceport)# no secondary dialtone
!
end
Router# show run | sec voice-port 2/0/0
Foreign Exchange Office 2/0/0 Slot is 2, Sub-unit is 0, Port is 0
Type of VoicePort is FXO
Operation State is DORMANT
Administrative State is UP
...
Secondary dialtone is disabled
Troubleshooting Tips for Toll Fraud Prevention
When incoming VOIP call is rejected by IP address trusted authentication, a specific internal error code
(IEC) 1.1.228.3.31.0 is saved to the call history record. You can monitor the failed or rejected calls using
the IEC support. Follow these steps to monitor any rejected calls:
Step 1 Use the show voice iec description command to find the text description of an IEC code.
Router# show voice iec description 1.1.228.3.31.0
IEC Version: 1
Entity: 1 (Gateway)
Category: 228 (User is denied access to this service)
Subsystem: 3 (Application Framework Core)
Error: 31 (Toll fraud call rejected)
Diagnostic Code: 0
Step 2 View the IEC statistics information using the Enable iec statistics command. The example below shows
that 2 calls were rejected due to toll fraud call reject error code.
Example:
Router# Enable iec statistics
Router(config)#voice statistics type iec
Router#show voice statistics iec since-reboot
Internal Error Code counters
----------------------------
Counters since reboot:
SUBSYSTEM Application Framework Core [subsystem code 3]
[errcode 31] Toll fraud call rejected 2
Step 3 Use the enable IEC syslog command to verify the syslog message logged when a call with IEC error is
released.
Cisco Unified Communications Manager Express System Administrator Guide
378 OL-10663-02
Configuring Toll Fraud Prevention
How to Configure Toll Fraud Prevention
Example:
Router# Enable iec syslog
Router (config)#voice iec syslog
Feb 11 01:42:57.371: %VOICE_IEC-3-GW: Application Framework Core:
Internal Error (Toll fraud call rejected): IEC=1.1.228.3.31.0 on
callID 288 GUID=DB3F10AC619711DCA7618593A790099E
Step 4 Verify the source address of an incoming VOIP call using the show call history voice last command.
Example:
Router# show call history voice last 1
GENERIC:
SetupTime=3306550 ms
Index=6
...
InternalErrorCode=1.1.228.3.31.0
...
RemoteMediaIPAddress=1.5.14.13
...
Step 5 IEC is saved to VSA of Radius Accounting Stop records. Monitor the rejected calls using the external
RADIUS server.
Example:
Feb 11 01:44:06.527: RADIUS: Cisco AVpair [1] 36
“internal-error-code=1.1.228.3.31.0”
Step 6 Retrieve the IEC details from cCallHistoryIec MIB object. More information on IEC is available at:
ttp://www.cisco.com/en/US/docs/ios/voice/monitor/configuration/guide/vt_voip_err_cds_ps6350_TSD
_Products_Configuration_Guide_Chapter.html
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 379
Configuring Toll Fraud Prevention
Additional References
Example:
getmany 1.5.14.10 cCallHistoryIec
cCallHistoryIec.6.1 = 1.1.228.3.31.0
>getmany 172.19.156.132 cCallHistory
cCallHistorySetupTime.6 = 815385
cCallHistoryPeerAddress.6 = 1300
cCallHistoryPeerSubAddress.6 =
cCallHistoryPeerId.6 = 8000
cCallHistoryPeerIfIndex.6 = 76
cCallHistoryLogicalIfIndex.6 = 0
cCallHistoryDisconnectCause.6 = 15
cCallHistoryDisconnectText.6 = call rejected (21)
cCallHistoryConnectTime.6 = 0
cCallHistoryDisconnectTime.6 = 815387
cCallHistoryCallOrigin.6 = answer(2)
cCallHistoryChargedUnits.6 = 0
cCallHistoryInfoType.6 = speech(2)
cCallHistoryTransmitPackets.6 = 0
cCallHistoryTransmitBytes.6 = 0
cCallHistoryReceivePackets.6 = 0
cCallHistoryReceiveBytes.6 = 0
cCallHistoryReleaseSrc.6 = internalCallControlApp(7)
cCallHistoryIec.6.1 = 1.1.228.3.31.0
>getone 172.19.156.132 cvVoIPCallHistoryRemMediaIPAddr.6
cvVoIPCallHistoryRemMediaIPAddr.6 = 1.5.14.13
Additional References
The following sections provide references related to Virtual Route Forwarding.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified Communications Manager Express System
Administrator Guide
• Cisco Unified Communications Manager Express Command
Reference
Cisco IOS voice configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Voice Command Reference
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Standards
Standard Title
No new or modified standards are supported by this —
feature, and support for existing standards has not been
modified by this feature.
Cisco Unified Communications Manager Express System Administrator Guide
380 OL-10663-02
Configuring Toll Fraud Prevention
Additional References
MIBs
MIB MIBs Link
No new or modified MIBs are supported, and support To locate and download MIBs for selected platforms, Cisco IOS
for existing MIBs has not been modified. releases, and feature sets, use Cisco MIB Locator found at the
following URL:
http://www.cisco.com/go/mibs
RFCs
RFC Title
No new or modified RFCs are supported, and support —
for existing RFCs has not been modified.
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 381
Configuring Toll Fraud Prevention
Feature Information for Toll Fraud Prevention
Feature Information for Toll Fraud Prevention
Table 27 lists the release history for this feature.
Not all commands may be available in your Cisco IOS software release. For release information about a
specific command, see the command reference documentation.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS and Catalyst OS software images
support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 27 lists only the Cisco IOS software release that introduced support for a given feature in a given
Cisco IOS software release train. Unless noted otherwise, subsequent releases of that Cisco IOS
software release train also support that feature.
Table 27 Feature Information for Virtual Route Forwarding
Cisco Unified CME
Feature Name Version Feature Information
Toll Fraud Prevention in 8.1 Introduced support for Toll Fraud Prevention feature.
Cisco Unified CME
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)
© 2010 Cisco Systems, Inc. All rights reserved.
Cisco Unified Communications Manager Express System Administrator Guide
382 OL-10663-02
Enabling the GUI
Last Updated: February 14, 2008
This chapter describes the Cisco Unified Communications Manager Express (Cisco Unified CME)
graphical user interface (GUI) and explains how to set it up accounts for system administrators, customer
administrators, and phone users.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Enabling the GUI”
section on page 383.
Contents
• Prerequisites for Enabling the GUI, page 367
• Restrictions for Enabling the GUI, page 368
• Information About Enabling the GUI, page 368
• How to Enable the GUI, page 369
• Configuration Examples for Enabling the GUI, page 379
• Additional References, page 382
• Feature Information for Enabling the GUI, page 383
Prerequisites for Enabling the GUI
• GUI files must be copied into flash memory on the router. For information, see “Installing and
Upgrading Cisco Unified CME Software” on page 53.
• To use a phone user account in the Cisco Unified CME GUI to configure speed dials on a phone that
is enabled for Extension Mobility, Cisco Unified CME GUI 4.2.1 or a later version must be installed
on the Cisco router.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 367
Enabling the GUI
Restrictions for Enabling the GUI
Restrictions for Enabling the GUI
• Cisco Unified CME GUI files are version-specific; GUI files for one version of Cisco Unified CME
are not compatible with any other version of Cisco Unified CME. If you are downgrading or
upgrading your Cisco Unified CME version, you must downgrade or upgrade your GUI files. For
information, see “Installing and Upgrading Cisco Unified CME Software” on page 53.
• The user name parameter of any authentication credential must be unique. Do not use the same value
for a user name when you configure any two or more authentication credentials in Cisco Unified
CME, such as the username for any Cisco United CME GUI account and the user name in a logout
or user profile for Extension Mobility.
• Extension Mobility options in Cisco Unified CME GUI 4.2.1 and later versions cannot be accessed
from the System Administrator or Customer Administrator login screens.
• To access the GUI, you must use Microsoft Internet Explorer 5.5 or a later version. Other browsers
are not supported.
• If you use an XML configuration file to create a customer administrator login, the XML file can
have a maximum size of 4000 bytes.
• The password of the system administrator cannot be changed through the GUI. Only the password
of a customer administrator or a phone user can be changed through the GUI.
• If more than 100 phones are configured, choosing to display all phones results in a long delay before
results appear.
Information About Enabling the GUI
To enable GUI support, you should understand the following concepts:
• Cisco Unified CME GUI Support, page 368
• AAA Authentication, page 369
Cisco Unified CME GUI Support
The Cisco Unified CME GUI provides a web-based interface to manage most system-level and
phone-based features. In particular, the GUI facilitates the routine additions and changes associated with
employee turnover, allowing these changes to be performed by nontechnical staff. The GUI provides
three levels of access to support the following user classes:
• System administrator—Able to configure all system-level and phone-based features. This person is
familiar with Cisco IOS software and VoIP network configuration.
• Customer administrator—Able to perform routine phone additions and changes without having
access to system-level features. This person does not have to be familiar with Cisco IOS software.
• Phone user—Able to program a small set of features on his or her own phone and search the
Cisco Unified CME directory. In Cisco Unified CME GUI 4.2.1 and later versions, phone users can
use the GUI to set up personal speed dials for an Extension Mobility phone. The same credential for
logging into an Extension Mobility phone can be used to log into the Cisco Unified CME GUI.
Cisco Unified Communications Manager Express System Administrator Guide
368 OL-10663-02
Enabling the GUI
How to Enable the GUI
The user name parameter of any authentication credential must be unique. Do not use the same value for
a user name when you configure any two or more authentication credentials in Cisco Unified CME, such
as the username for any Cisco United CME GUI account and the user name in a logout or user profile
for Extension Mobility.
The Cisco Unified CME GUI uses HTTP to transfer information from the router to the PC of an
administrator or phone user. The router must be configured as an HTTP server, and an initial system
administrator username and password must be defined from the router command-line interface (CLI).
Additional accounts for customer administrators and phone users can be added from the
Cisco Unified CME router using Cisco IOS software commands or from a PC using GUI screens.
Cisco Unified CME provides support for eXtensible Markup Language (XML) cascading style sheets
(files with a .css suffix) that can be used to customize the browser GUI display.
AAA Authentication
The GUI supports authentication, authorization, and accounting (AAA) authentication for system
administrators through a remote server when this capability is enabled with the ip http authentication
command. If authentication through the server fails, the local router is searched.
Using the ip http authentication command prevents unauthorized users from accessing the
Cisco Unified CME router. If this command is not used, the enable password for the router is the only
requirement to authenticate user access to the GUI. Instead, we recommend you use the local or
TACACS authentication options, configured as part of a global AAA framework. By explicitly using the
ip http authentication command, you designate alternative authentication methods, such as by a local
login account or by the method that is specified in the AAA configuration on the Cisco Unified CME
router. If you select the AAA authentication method, you must also define an authentication method in
your AAA configuration.
For information on configuring AAA authentication, see “Configuring Authentication” chapter of the
Cisco IOS Security Configuration Guide.
How to Enable the GUI
This section contains the following procedures:
• Enabling the HTTP Server, page 369 (required)
• Enabling GUI Access for the System Administrator, page 371 (required)
• Accessing the Cisco Unified CME GUI, page 373 (required)
• Creating a Customized XML File for Customer Administrator GUI, page 374 (optional)
• Enabling GUI Access for Customer Administrators, page 375 (optional)
• Enabling GUI Access for Phone Users, page 377 (optional)
• Troubleshooting the Cisco Unified CME GUI, page 379 (optional)
Enabling the HTTP Server
To enable the HTTP server, and specify the path to files for the GUI and a method of user authentication
for security, perform the following steps. The HTTP server on a router is disabled by default.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 369
Enabling the GUI
How to Enable the GUI
SUMMARY STEPS
1. enable
2. configure terminal
3. ip http server
4. ip http path flash:
5. ip http authentication {aaa | enable | local | tacacs}
6. exit
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ip http server Enables the HTTP server on the Cisco Unified CME
router.
Example:
Router(config)# ip http server
Step 4 ip http path flash: Sets the location of the HTML files used by the HTTP
web server to flash memory on the router.
Example:
Router(config)# ip http path flash:
Cisco Unified Communications Manager Express System Administrator Guide
370 OL-10663-02
Enabling the GUI
How to Enable the GUI
Command or Action Purpose
Step 5 ip http authentication {aaa | enable | local | Specifies the method of authentication for the HTTP
tacacs} server. Default is the enable keyword.
• aaa—Indicates that the authentication method
Example: used for the AAA login service should be used
Router(config)# ip http authentication aaa for authentication. The AAA login service
method is specified by the aaa authentication
login command.
• enable—Uses the enable password. This is the
default if this command is not used.
• local—Uses login username, password, and
privilege level access combination specified in
the local system configuration (by the username
command).
• tacacs—Uses TACACS (or XTACACS) server.
Step 6 exit Returns to privileged EXEC mode.
Example:
Router(config)# exit
Enabling GUI Access for the System Administrator
To define an initial username and password for a system administrator to access the GUI and enable the
GUI to be used to set the time and to add directory listings, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. web admin system name username {password string | secret {0 | 5} string}
5. dn-webedit
6. time-webedit
7. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 371
Enabling the GUI
How to Enable the GUI
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 web admin system name username {password string | Defines username and password for a system
secret {0 | 5} string} administrator.
• name username—Unique alphanumeric string to
Example: identify a user for this authentication credential
Router(config-telephony)# web admin system name pwa3 only. Default is Admin.
secret 0 wp78pw
• password string—String to verify system
administrator’s identity. Default is empty string.
• secret {0 | 5} string—Digit specifies state of
encryption of the string that follows:
– 0—Password that follows is not encrypted.
– 5—Password that follows is encrypted using
Message Digest 5 (MD5).
Note The secret 5 keyword pair is used in the
output of show commands when encrypted
passwords are displayed. It indicates that the
password that follows is encrypted.
Step 5 dn-webedit (Optional) Enables the ability to add directory
numbers through the web interface.
Example: The no form of this command disables the ability to
Router(config-telephony)# dn-webedit create IP phone extension telephone numbers. That
ability could disrupt the network wide management
of telephone numbers.
If this command is not used, the ability to create
directory numbers is disabled by default.
Cisco Unified Communications Manager Express System Administrator Guide
372 OL-10663-02
Enabling the GUI
How to Enable the GUI
Command or Action Purpose
Step 6 time-webedit (Optional) Enables the ability to set the phone time
for the Cisco Unified CME system through the web
interface.
Example:
Router(config-telephony)# time-webedit Note We do not recommend this method for setting
network time. The router should be set up to
automatically synchronize its router clock
from a network-based clock source using
Network Time Protocol (NTP). In the rare
case that a network NTP clock source is not
available, use the time-webedit command to
allow manual setting and resetting of the
router clock through the GUI.
Step 7 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Accessing the Cisco Unified CME GUI
To access the Cisco Unified CME router through the GUI to make configuration changes, perform the
following steps.
Note In Cisco Unified CME GUI 4.2.1 and later versions, phone users can use the GUI to set up personal
speed dials for an Extension Mobility phone. The same credential for logging on to an Extension
Mobility phone can be used to log into the Cisco Unified CME GUI.
Restrictions
• The Cisco Unified CME GUI requires Microsoft Internet Explorer 5.5 or a later version. Other
browsers are not supported.
• Extension Mobility options in Cisco Unified CME GUI 4.2.1 and later versions cannot be accessed
from the System Administrator or Customer Administrator login screens.
DETAILED STEPS
Step 1 Go to the following URL:
http://router_ipaddress/ccme.html
where router_ipaddress is the IP address of your Cisco Unified CME router. For example, if the IP
address of your Cisco Unified CME router is 10.10.10.176, enter the following:
http://10.10.10.176/ccme.html
Step 2 Enter your username and password at the login screen.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 373
Enabling the GUI
How to Enable the GUI
The Cisco Unified CME system evaluates your privilege level and presents the appropriate window.
Note that users with Cisco IOS software privilege level 15 also have system-administrator-level
privileges in the Cisco Unified CME GUI after being authenticated locally or remotely through AAA.
The ip http authentication command that is configured on the Cisco Unified CME router determines
where authentication occurs.
Step 3 After you login and are authenticated, the system displays one of the following home pages, based on
your user level:
• System administrator home page.
• Customer administrator sees a reduced version of the options available on the system administrator
page, according to the XML configuration file that the system administrator created.
• Phone user home page.
After you log in successfully, access online help from the Help menu.
Creating a Customized XML File for Customer Administrator GUI
The XML configuration file specifies the parameters and features that are available to customer
administrators and the parameters and features that are restricted. The file follows a template named
xml.template, which conforms to the Cisco XML Document Type Definition (DTD), as documented in
the Cisco IP Phone Services Application Development Notes. This template is one of the first
Cisco Unified CME files that is downloaded during installation.
To edit and load the XML configuration file, perform the following steps.
SUMMARY STEPS
1. Copy the XML template and open it in any text editor.
2. Edit the XML template.
3. Copy the file to a TFTP or FTP server that can be accessed by the Cisco Unified CME router.
4. Copy your file to flash memory on the Cisco Unified CME router.
5. Load the XML file from router flash memory.
DETAILED STEPS
Step 1 Copy the XML template and open it in any text editor (see the “XML Configuration File Template:
Example” section on page 379). Name the file something that is meaningful to you and use “xml” as its
suffix. For example, you could name the file “custadm.xml.”
Step 2 Edit the XML template. Within the template, each line that starts with a title enclosed in angle brackets
describes an XML object and matches an entity name in the Cisco CME GUI. For example,
“<AddExtension>” refers to the Add Extension capability, and “<Type>” refers to the Type field on the
Add Extension window. For each object in the template, you have a choice of actions. Your choices
appear within brackets; for example, “[Hide | Show]” indicates that you have a choice between whether
this object is hidden or visible when a customer administrator logs in to the GUI. Delete the action that
you do not want and the vertical bar and brackets around the actions.
Cisco Unified Communications Manager Express System Administrator Guide
374 OL-10663-02
Enabling the GUI
How to Enable the GUI
For example, to hide the Sequence Number field, change the following text in the template file:
<SequenceNumber> [Hide | Show] </SequenceNumber>
to the following text in your configuration file:
<SequenceNumber> Hide </SequenceNumber>
Edit every line in the template until you have changed each choice in brackets to a single action and you
have removed the vertical bars and brackets. A sample XML file is shown in the “XML Configuration
File: Example” section on page 380.
Step 3 Copy the file to a TFTP or FTP server that can be accessed by the Cisco Unified CME router.
Step 4 Copy your file to flash memory on the Cisco Unified CME router.
Router# copy tftp flash
Step 5 Load the XML file from router flash memory.
Router(config)# telephony-service
Router(config-telephony)# web customize load filename
Router(config-telephony)# exit
Enabling GUI Access for Customer Administrators
Perform one of the following procedures to enable GUI access for a customer administrator, depending
on the method you want to use:
• Using the Cisco Unified CME GUI to Define a Customer Administrator Account, page 375
• Using Cisco IOS Software Commands to Define a Customer Administrator Account, page 376
Prerequisites
• Enable a system administrator account for GUI access. See the “Enabling GUI Access for the
System Administrator” section on page 371.
• Create the XML configuration file for the customer administrator GUI. See the “Creating a
Customized XML File for Customer Administrator GUI” section on page 374.
• Reload the XML file using the web customize load command if you have made changes to the
customer administrator GUI.
Using the Cisco Unified CME GUI to Define a Customer Administrator Account
To allow the system administrator to use the GUI to create a customer administrator account, perform
the following steps.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 375
Enabling the GUI
How to Enable the GUI
DETAILED STEPS
Step 1 From the Configure System Parameters menu, choose Administrator’s Login Account.
Step 2 Complete the Admin User Name (username) and Admin User Type (Customer) fields. The username
must be a unique alphanumeric string to identify a user for this authentication credential only.
Step 3 Complete the New Password field for the user that you are defining as a customer administrator. Type
the password again to confirm it.
Step 4 Click Change for your changes to become effective.
Using Cisco IOS Software Commands to Define a Customer Administrator Account
To allow the system administrator to create a customer administrator account by using the Cisco IOS
software command line interface, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. web admin customer name username password string
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
376 OL-10663-02
Enabling the GUI
How to Enable the GUI
Command or Action Purpose
Step 4 web admin customer name username password string Defines a username and password for a customer
administrator.
Example: • name username—Unique alphanumeric string to
Router(config-telephony)# web admin customer name identify a user for this authentication credential
user44 password pw10293847 only. Default is Customer.
• password string—String to verify customer
administrator identity.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Enabling GUI Access for Phone Users
Perform one of the following procedures to enable GUI access for a phone user, depending on the
method you want to use:
• Using the Cisco Unified CME GUI to Define a Phone User Account, page 377
• Using Cisco IOS Software Commands to Define a Phone User Account, page 378
Prerequisites
• Enable a system administrator account for GUI access. See the “Enabling GUI Access for the
System Administrator” section on page 371.
Using the Cisco Unified CME GUI to Define a Phone User Account
To create a phone user account by using the Cisco Unified CME GUI, perform the following steps.
DETAILED STEPS
Step 1 From the Configure Phones menu, choose Add Phone to add GUI access for a user with a new phone or
Change Phone to add GUI access for a user with an existing phone. The Add Phone screen or the
Change Phone screen appears.
Step 2 Enter a username and password in the Login Account area of the screen. The username must be a unique
alphanumeric string to identify a user for this authentication credential only. If you are adding a new
phone, complete the other fields as appropriate.
Step 3 Click Change for your edits to become effective.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 377
Enabling the GUI
How to Enable the GUI
Using Cisco IOS Software Commands to Define a Phone User Account
To use commands in the ephone configuration mode to create credentials for phone users to log into the
Cisco Unified CME GUI, perform the following steps for each phone user/phone combination.
Note You can also create phone user credentials for accessing the Cisco Unified CME GUI by using the user
command in the voice user-profile configuration mode and the voice logout-profile mode. For
configuration information, see “Configuring Extension Mobility” on page 875.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. username username password password
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
Example:
Router(config)# ephone 2
Step 4 username username password password Assigns a phone user login account name and
password.
Example: • This allows the phone user to log in to the
Router(config-ephone)# username prx password pk59wq Cisco Unified CME GUI to change a limited
number of personal settings.
• username—Unique alphanumeric string to
identify a user for this authentication credential
only.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Cisco Unified Communications Manager Express System Administrator Guide
378 OL-10663-02
Enabling the GUI
Configuration Examples for Enabling the GUI
Troubleshooting the Cisco Unified CME GUI
If you are having trouble starting the Cisco Unified CME GUI, try the following actions:
Step 1 Verify you are using Microsoft Internet Explorer 5.5 or a later version. No other browser is supported.
Step 2 Clear your browser cache or history.
Step 3 Verify that the GUI files in router flash memory are the correct version for the version of
Cisco Unified CME that you have. Compare the filenames in flash memory with the list in the
Cisco Unified CME software archive that you downloaded. Compare the sizes of files in flash memory
with the sizes of the files in the tar archive for the Cisco Unified CME GUI to ensure that you have the
most recent files installed in flash memory. If necessary, download the latest version from the Software
Download website at http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp.
Configuration Examples for Enabling the GUI
This section contains the following examples:
• HTTP and Account Configuration: Example, page 379
• XML Configuration File Template: Example, page 379
• XML Configuration File: Example, page 380
HTTP and Account Configuration: Example
The following example sets up the HTTP server and creates a system administrator account for pwa3, a
customer administrator account for user44, and a user account for prx.
ip http server
ip http path flash:
ip http authentication aaa
telephony-service
web admin system name pwa3 secret 0 wp78pw
web admin customer name user44 password pw10293847
dn-webedit
time-webedit
ephone 25
username prx password pswd
XML Configuration File Template: Example
<Presentation>
<MainMenu>
<!-- Take Higher Precedence over CLI "dn-web-edit" -->
<AddExtension> [Hide | Show] </AddExtension>
<DeleteExtension> [Hide | Show] </DeleteExtension>
<AddPhone> [Hide | Show] </AddPhone>
<DeletePhone> [Hide | Show] </DeletePhone>
</MainMenu>
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 379
Enabling the GUI
Configuration Examples for Enabling the GUI
<Extension>
<!-- Control both view and change, and possible add or delete -->
<SequenceNumber> [Hide | Show] </SequenceNumber>
<Type> [Hide | Show] </Type>
<Huntstop> [Hide | Show] </Huntstop>
<Preference> [Hide | Show] </Preference>
<HoldAlert> [Hide | Show] </HoldAlert>
<TranslationRules> [Hide | Show] </TranslationRules>
<Paging> [Hide | Show] </Paging>
<Intercom> [Hide | Show] </Intercom>
<MWI> [Hide | Show] </MWI>
<MoH> [Hide | Show] </MoH>
<LBDN> [Hide | Show] </LBDN>
<DualLine> [Hide | Show] </DualLine>
<Reg> [Hide | Show] </Reg>
<PGroup> [Hide | Show] </PGroup>
</Extension>
<Phone>
<!-- control both view and change, and possible add and delete --->
<SequenceNumber> [Hide | Show] </SequenceNumber>
</Phone>
<System>
<!-- Control View Only -->
<PhoneURL> [Hide | Show] </PhoneURL>
<PhoneLoad> [Hide | Show]</PhoneLoad>
<CallHistory> [Hide | Show] </CallHistory>
<MWIServer> [Hide | Show] </MWIServer>
<!-- Control Either View and Change or Change Only -->
<TransferPattern attr=[Both | Change]> [Hide | Show] </TransferPattern>
<VoiceMailNumber attr=[Both | Change]> [Hide | Show] </VoiceMailNumber>
<MaxNumberPhone attr=[Both | Change]> [Hide | Show] </MaxNumberPhone>
<DialplanPattern attr=[Both | Change]> [Hide | Show] </DialplanPattern>
<SecDialTone attr=[Both | Change]> [Hide | Show] </SecDialTone>
<Timeouts attr=[Both | Change]> [Hide | Show] </Timeouts>
<CIDBlock attr=[Both | Change]> [Hide | Show] </CIDBlock>
<HuntGroup attr=[Both | Change]> [Hide | Show] </HuntGroup>
<NightSerBell attr=[Both | Change]> [Hide | Show] </NightSerBell>
<!-- Control Change Only -->
<!-- Take Higher Precedence over CLI "time-web-edit" -->
<Time> [Hide | Show] </Time>
</System>
<Function>
<AddLineToPhone> [No | Yes] </AddLineToPhone>
<DeleteLineFromPhone> [No | Yes] </DeleteLineFromPhone>
<NewDnDpCheck> [No | Yes] </NewDnDpCheck>
<MaxLinePerPhone> [1-6] </MaxLinePerPhone>
</Function>
</Presentation>
XML Configuration File: Example
sample.xml
<Presentation>
<MainMenu>
<AddExtension> Hide </AddExtension>
<DeleteExtension> Hide </DeleteExtension>
<AddPhone> Hide </AddPhone>
<DeletePhone> Hide </DeletePhone>
Cisco Unified Communications Manager Express System Administrator Guide
380 OL-10663-02
Enabling the GUI
Configuration Examples for Enabling the GUI
</MainMenu>
<Extension>
<SequenceNumber> Hide </SequenceNumber>
<Type> Hide </Type>
<Huntstop> Hide </Huntstop>
<Preference> Hide </Preference>
<HoldAlert> Hide </HoldAlert>
<TranslationRule> Hide </TranslationRule>
<Paging> Show </Paging>
<Intercom> Hide </Intercom>
<MWI> Hide </MWI>
<MoH> Hide </MoH>
<LBDN> Hide </LBDN>
<DualLine> Hide </DualLine>
<Reg> Hide </Reg>
<PGroup> Show </PGroup>
</Extension>
<Phone>
<SequenceNumber> Hide </SequenceNumber>
</Phone>
<System>
<PhoneURL> Hide </PhoneURL>
<PhoneLoad> Hide </PhoneLoad>
<CallHistory> Hide </CallHistory>
<MWIServer> Hide </MWIServer>
<TransferPattern attr=Both> Hide </TransferPattern>
<VoiceMailNumber attr=Both> Hide </VoiceMailNumber>
<MaxNumberPhone attr=Both> Hide </MaxNumberPhone>
<DialplanPattern attr=Change> Hide </DialplanPattern>
<SecDialTone attr=Both> Hide </SecDialTone>
<Timeouts attr=Both> Hide </Timeouts>
<CIDBlock attr=Both> Hide </CIDBlock>
<HuntGroup attr=Change> Hide </HuntGroup>
<NightSerBell attr=Change> Hide </NightSerBell>
<Time> Hide </Time>
</System>
<Function>
<AddLineToPhone> No </AddLineToPhone>
<DeleteLineFromPhone> No </DeleteLineFromPhone>
<MaxLinePerPhone> 4 </MaxLinePerPhone>
</Function>
</Presentation>
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 381
Enabling the GUI
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
382 OL-10663-02
Enabling the GUI
Feature Information for Enabling the GUI
Feature Information for Enabling the GUI
Table 26 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note The following table lists the Cisco Unified CME version that introduced support for a given feature.
Unless noted otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 26 Feature Information for Enabling the GUI
Cisco Unified CME
Feature Name Version Feature Information
Support for Extension Mobility Phone 4.2(1) Allows a phone user to use a name and password from an
Users in Cisco Unified CME GUI Extension Mobility profile to log into the
Cisco Unified CME GUI for configuring personal speed
dials on an Extension Mobility phone.
Cisco Unified CME GUI 2.0 The Cisco Unified CME GUI was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 383
Enabling the GUI
Feature Information for Enabling the GUI
Cisco Unified Communications Manager Express System Administrator Guide
384 OL-10663-02
Integrating Voice Mail
Last Updated: June 07, 2010
This chapter describes how to integrate your voice-mail system with Cisco Unified
Communications Manager Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Voice-Mail
Integration” section on page 427.
Contents
• Prerequisites, page 385
• Information About Voice-Mail Integration, page 387
• How to Configure Voice-Mail Integration, page 393
• Configuration Examples for Voice-Mail Integration, page 422
• Additional References, page 426
• Feature Information for Voice-Mail Integration, page 427
Prerequisites
• Calls can be successfully completed between phones on the same Cisco Unified CME router.
• If your voice-mail system is something other than Cisco Unity Express, such as Cisco Unity, voice
mail must be installed and configured on your network.
• If your voice-mail system is Cisco Unity Express:
Note When you order Cisco Unity Express, Cisco Unity Express software and the purchased license
are installed on the module at the factory. Spare modules also ship with the software and license
installed. If you are adding Cisco Unity Express to an existing Cisco router, you will be required
to install hardware and software components.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 385
Integrating Voice Mail
Prerequisites
– Interface module for Cisco Unity Express is installed. For information about the AIM-CUE or
NM-CUE, access documents located at
http://www.cisco.com/en/US/products/hw/modules/ps2797/prod_installation_guides_list.html
– The recommended Cisco IOS release and feature set plus the necessary Cisco Unified CME
phone firmware and GUI files to support Cisco Unity Express are installed on the
Cisco Unified CME router.
If the GUI files are not installed, see the “Installing Cisco Unified CME Software” section on
page 58.
To determine whether the Cisco IOS software release and Cisco Unified CME software version
are compatible with the Cisco Unity Express version, Cisco router model, and
Cisco Unity Express hardware that you are using, see the Cisco Unity Express Compatibility
Matrix.
To verify installed Cisco Unity Express software version, enter the Cisco Unity Express
command environment and use the show software version user EXEC command. For
information about the command environment, see the appropriate Cisco Unity Express CLI
Administrator Guide at
http://www.cisco.com/en/US/docs/voice_ip_comm/unity_exp/roadmap/cuedocs.html.
– The proper license for Cisco Unified CME, not Cisco Unified Communications Manager, is
installed. To verify installed license, enter the Cisco Unity Express command environment and
use the show software license user EXEC command. For information about the command
environment, see the appropriate Cisco Unity Express CLI Administrator Guide at
http://www.cisco.com/en/US/docs/voice_ip_comm/unity_exp/roadmap/cuedocs.html.
This is an example of the Cisco Unified CME license:
se-10-0-0-0> show software licenses
Core:
- application mode: CCME
- total usable system ports: 8
Voicemail/Auto Attendant:
- max system mailbox capacity time: 6000
- max general delivery mailboxes: 15
- max personal mailboxes: 50
Languages:
- max installed languages: 1
- max enabled languages: 1
– Voicemail and Auto Attendant (AA) applications are configured. For configuration information,
see “Configuring the System Using the Initialization Wizard” in the appropriate Cisco Unity
Express GUI Administrator Guide at
http://www.cisco.com/en/US/docs/voice_ip_comm/unity_exp/roadmap/cuedocs.html.
Cisco Unified Communications Manager Express System Administrator Guide
386 OL-10663-02
Integrating Voice Mail
Information About Voice-Mail Integration
Information About Voice-Mail Integration
To enable voice-mail support, you should understand the following concepts:
• Cisco Unity Connection Integration, page 387
• Cisco Unity Express Integration, page 387
• Cisco Unity Integration, page 388
• DTMF Integration for Legacy Voice-Mail Applications, page 388
• Mailbox Selection Policy, page 388
• RFC 2833 DTMF MTP Passthrough, page 389
• MWI Line Selection, page 389
• AMWI, page 389
• SIP MWI Prefix Specification, page 390
• SIP MWI - QSIG Translation, page 390
• VMWI, page 391
• Transfer to Voice Mail, page 392
• Live Record, page 392
• Cisco Unity Express AXL Enhancement, page 392
Cisco Unity Connection Integration
Cisco Unity Connection transparently integrates messaging and voice recognition components with your
data network to provide continuous global access to calls and messages. These advanced,
convergence-based communication services help you use voice commands to place calls or listen to
messages in “hands-free” mode and check voice messages from your desktop, either integrated into an
e-mail inbox or from a Web browser. Cisco Unity Connection also features robust automated-attendant
functions that include intelligent routing and easily customizable call-screening and
message-notification options.
For instructions on how to integrate Cisco Unified CME with Cisco Unity Connection, see the
Cisco CallManager Express 3.x Integration Guide for Cisco Unity Connection 1.1.
Cisco Unity Express Integration
Cisco Unity Express offers easy, one-touch access to messages and commonly used voice-mail features
that enable users to reply, forward, and save messages. To improve message management, users can
create alternate greetings, access envelope information, and mark or play messages based on privacy or
urgency. For instructions on how to configure Cisco Unity Express, see the administrator guides for
Cisco Unity Express.
For configuration information, see the “Enabling DTMF Integration Using SIP NOTIFY” section on
page 411.
Note Cisco Unified CME and Cisco Unity Express must both be configured before they can be integrated.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 387
Integrating Voice Mail
Information About Voice-Mail Integration
Cisco Unity Integration
Cisco Unity is a Microsoft Windows-based communications solution that brings you voice mail and
unified messaging and integrates them with the desktop applications you use daily. Cisco Unity gives
you the ability to access all of your messages, voice, fax, and e-mail, by using your desktop PC, a
touchtone phone, or the Internet. The Cisco Unity voice mail system supports voice-mail integration
with Cisco Unified CME. This integration requires that you configure the Cisco Unified CME router and
Cisco Unity software to get voice-mail service.
For configuration instructions, see the “Enabling DTMF Integration Using RFC 2833” section on
page 408.
DTMF Integration for Legacy Voice-Mail Applications
For dual-tone multifrequency (DTMF) integrations, information on how to route incoming or forwarded
calls is sent by a telephone system in the form of DTMF digits. The DTMF digits are sent in a pattern
that is based on the integration file in the voice-mail system connected to the Cisco Unified CME router.
These patterns are required for DTMF integration of Cisco Unified CME with most voice-mail systems.
Voice-mail systems are designed to respond to DTMF after the system answers the incoming calls.
After configuring the DTMF integration patterns on the Cisco Unified CME router, you set up the
integration files on the third-party legacy voice-mail system by following the instructions in the
documents that accompany the voice-mail system. You must design the DTMF integration patterns
appropriately so that the voice-mail system and the Cisco Unified CME router work with each other.
For configuration information, see the “Enabling DTMF Integration for Analog Voice-Mail
Applications” section on page 406.
Mailbox Selection Policy
Typically a voice-mail system uses the number that a caller has dialed to determine the mailbox to which
a call should be sent. However, if a call has been diverted several times before reaching the voice-mail
system, the mailbox that is selected might vary for different types of voice-mail systems. For example,
Cisco Unity Express uses the last number to which the call was diverted before it was sent to voice mail
as the mailbox number. Cisco Unity and some legacy PBX systems use the originally called number as
the mailbox number.
The Mailbox Selection Policy feature allows you to provision the following options from the
Cisco Unified CME configuration.
• For Cisco Unity Express, you can select the originally dialed number.
• For PBX voice-mail systems, you can select the last number to which the call was diverted before it
was sent to voice mail. This option is configured on the outgoing dial peer for the voice-mail
system's pilot number.
• For Cisco Unity voice mail, you can select the last number to which the call was diverted before it
was sent to voice mail. This option is configured on the ephone-dn that is associated with the
voice-mail pilot number.
To enable Mailbox Selection Policy, see the “SCCP: Setting a Mailbox Selection Policy for
Cisco Unity Express or a PBX Voice-Mail Number” section on page 395 or the “SCCP: Setting Mailbox
Selection Policy for Cisco Unity” section on page 396.
Cisco Unified Communications Manager Express System Administrator Guide
388 OL-10663-02
Integrating Voice Mail
Information About Voice-Mail Integration
RFC 2833 DTMF MTP Passthrough
In Cisco Unified CME 4.1, the RFC 2833 Dual-Tone Multifrequency (DTMF) Media Termination Point
(MTP) Passthrough feature provides the capability to pass DTMF tones transparently between SIP
endpoints that require transcoding or Resource Reservation Protocol (RSVP) agents.
This feature supports DTMF Relay across SIP WAN devices that support RFC 2833, such as Cisco Unity
and SIP trunks. Devices registered to a Cisco Unified CME SIP back-to-back user agent (B2BUA) can
exchange RFC 2833 DTMF MTP with other devices that are not registered with the Cisco Unified CME
SIP B2BUA, or with devices that are registered in one of the following:
• Local or remote Cisco Unified CME
• Cisco Unified Communications Manager
• Third party proxy
By default, the RFC 2833 DTMF MTP Passthrough feature uses payload type 101 on MTP, and MTP
accepts all the other dynamic payload types if it is indicated by Cisco Unified CME. For configuration
information, see the “Enabling DTMF Integration Using RFC 2833” section on page 408.
MWI Line Selection
Message waiting indicator (MWI) line selection allows you to choose the phone line that is monitored
for voice-mail messages and that lights an indicator when messages are present.
Before Cisco Unified CME 4.0, the MWI lamp on a phone running SCCP could be associated only with
the primary line of the phone.
In Cisco Unified CME 4.0 and later versions, you can designate a phone line other than the primary line
to be associated with the MWI lamp. Lines other than the one associated with the MWI lamp display an
envelope icon when a message is waiting. A logical phone “line” is not the same as a phone button. A
button with one or more directory numbers is considered one line. A button with no directory number
assigned does not count as a line.
In Cisco Unified CME 4.0 and later versions, a SIP directory number that is used for call forward all,
presence BLF status, and MWI features must be configured by using the dn keyword in the number
command; direct line numbers are not supported.
For configuration information, see the“SCCP: Configuring a Voice Mailbox Pilot Number” section on
page 393 or “SIP: Configuring a Directory Number for MWI” section on page 416.
AMWI
The AMWI (Audible Message Line Indicator) feature provides a special stutter dial tone to indicate
message waiting. This is an accessibility feature for vision-impaired phone users. The stutter dial tone
is defined as 10 ms ON, 100 ms OFF, repeat 10 times, then steady on.
In Cisco Unified CME 4.0(3), you can configure the AMWI feature on the Cisco Unified IP Phone 7911
and Cisco Unified IP Phone 7931G to receive audible, visual, or audible and visual MWI notification
from an external voice-messaging system. AMWI cannot be enabled unless the number command is
already configured for the IP phone to be configured.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 389
Integrating Voice Mail
Information About Voice-Mail Integration
Cisco Unified CME applies the following logic based on the capabilities of the IP phone and how MWI
is configured:
• If the phone supports (visual) MWI and MWI is configured for the phone, activate the Message
Waiting light.
• If the phone supports (visual) MWI only, activate the Message Waiting light regardless of the
configuration.
• If the phone supports AMWI and AMWI is configured for the phone, send the stutter dial tone to
the phone when it goes off-hook.
• If the phone supports AMWI only and AMWI is configured, send the stutter dial tone to the phone
when it goes off-hook regardless of the configuration.
If a phone supports (visual) MWI and AMWI and both options are configured for the phone, activate the
Message Waiting light and send the stutter dial tone to the phone when it goes off-hook.
For configuration informations, see the “SCCP: Configuring a Phone for MWI Outcall” section on
page 413.
SIP MWI Prefix Specification
Central voice-messaging servers that provide mailboxes for several Cisco Unified CME sites may use
site codes or prefixes to distinguish among similarly numbered ranges of extensions at different sites. In
Cisco Unified CME 4.0 and later versions, you can specify that your Cisco Unified CME system should
accept unsolicited SIP Notify messages for MWI that include a prefix string as a site identifier.
For example, an MWI message might indicate that the central mailbox number 555-0123 has a voice
message. In this example, the digits 555 are set as the prefix string or site identifier using the mwi prefix
command. The local Cisco Unified CME system is able to convert 555-0123 to 0123 and deliver the
MWI to the correct phone. Without this prefix string manipulation, the system would reject an MWI for
555-0123 as not matching the local Cisco Unified CME extension 0123.
To enable SIP MWI Prefix Specification, see the “Enabling SIP MWI Prefix Specification” section on
page 419.
SIP MWI - QSIG Translation
In Cisco Unified CME 4.1 and later, the SIP MWI - QSIG Translation feature extends MWI functionality
for SIP MWI and QSIG MWI interoperation to enable sending and receiving MWI over QSIG to a PBX.
When the SIP Unsolicited NOTIFY is received from voice mail, the Cisco router translates this event to
activate QSIG MWI to the PBX, via PSTN. The PBX will switch on, or off, the MWI lamp on the
corresponding IP phone. This feature supports only Unsolicited NOTIFY. Subscribe NOTIFY is not
supported by this feature.
In Figure 19, the Cisco router receives the SIP Unsolicited NOTIFY, performs the protocol translation,
and initiates the QSIG MWI call to the PBX, where it is routed to the appropriate phone.
Cisco Unified Communications Manager Express System Administrator Guide
390 OL-10663-02
Integrating Voice Mail
Information About Voice-Mail Integration
Figure 19 SIP MWI to ISDN QSIG When Voice Mail and Cisco Router are On the Same LAN
SIP MWI NOTIFY message QSIG MWI message
Cisco Unified CME PBX
146430
LAN
It makes no difference if the SIP Unsolicited NOTIFY is received via LAN or WAN if the PBX is
connected to the Cisco router, and not to the remote voice-mail server.
In Figure 20, a voice mail server and Cisco Unified CME are connected to the same LAN and a remote
Cisco Unified CME is connected across the WAN. In this scenario, the protocol translation is performed
at the remote Cisco router and the QSIG MWI message is sent to the PBX.
Figure 20 SIP MWI to ISDN QSIG When PBX is Connected to a Remote Cisco Router
WAN
SIP MWI NOTIFY message QSIG MWI message
U SIP MWI NOTIFY message
146570
PBX
Cisco Unified CME Cisco Unified CME
LAN
VMWI
There are two types of visual message waiting indicator (VMWI) features: Frequency-shift Keying
(FSK) and DC voltage. The message-waiting lamp can be enabled to flash on an analog phone that
requires an FSK message to activate a visual indicator. The DC Voltage VMWI feature is used to flash
the message-waiting lamp on an analog phone which requires DC voltage instead of an FSK message.
For all other applications, such as MGCP, FSK VMWI is used even if the voice gateway is configured
for DC voltage VMWI. The configuration for DC voltage VMWI is supported only for Foreign Exchange
Station (FXS) ports on the Cisco VG224 analog voice gateway with analog device version V1.3 and
V2.1.
The Cisco VG224 can only support 12 Ringer Equivalency Number (REN) for ringing 24 onboard analog
FXS voice ports. To support ringing and DC Voltage VMWI for 24 analog voice ports, stagger-ringing
logic is used to maximize the limited REN resource. When a system runs out of REN because too many
voice ports are being rung, the MWI lamp temporarily turns off to free up REN to ring the voice ports.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 391
Integrating Voice Mail
Information About Voice-Mail Integration
DC voltage VMWI is also temporarily turned off any time the port's operational state is no longer idle
and onhook, such as when one of the following events occur:
• Incoming call on voice port
• Phone goes off hook
• The voice port is shut down or busied out
Once the operational state of the port changes to idle and onhook again, the MWI lamp resumes flashing
until the application receives a requests to clear it; for example, if there are no more waiting messages.
For configuration information, see the “Transfer to Voice Mail” section.
Transfer to Voice Mail
The Transfer to Voice Mail feature allows a phone user to transfer a caller directly to a voice-mail
extension. The user presses the TrnsfVM soft key to place the call on hold, enters the extension number,
and then commits the transfer by pressing the TrnsfVM soft key again. The caller hears the complete
voice mail greeting. This feature is supported using the TrnsfVM soft key or feature access code (FAC).
For example, a receptionist might screen calls for five managers. If a call comes in for a manager who
is not available, the receptionist can transfer the caller to the manager's voice-mail extension by using
the TrnsfVM soft key and the caller hears the personal greeting of the individual manager.
For configuration information, see the “SCCP: Enabling Transfer to Voice Mail” section on page 398.
Live Record
The Live Record feature enables IP phone users in a Cisco Unified CME system to record a phone
conversation if Cisco Unity Express is the voice mail system. An audible notification, either by
announcement or by periodic beep, alerts participants that the conversation is being recorded. The
playing of the announcement or beep is under the control of Cisco Unity Express.
Live Record is supported for two-party calls and ad hoc conferences. In normal record mode, the
conversation is recorded after the LiveRcd soft key is pressed. This puts the other party on-hold and
initiates a call to Cisco Unity Express at the configured live-record number. To stop the recording
session, the phone user presses the LiveRcd soft key again, which toggles between on and off.
The Live-Record number is configured globally and must match the number configured in
Cisco Unity Express. You can control the availability of the feature on individual phones by modifying
the display of the LiveRcd soft key using an ephone template. This feature must be enabled on both
Cisco Unified CME and Cisco Unity Express.
To enable Live Record in Cisco Unified CME, see the “SCCP: Configuring Live Record” section on
page 401.
Cisco Unity Express AXL Enhancement
In Cisco Unified CME 7.0(1) and later versions, the Cisco Unity Express AXL enhancement in
Cisco Unified CME provides better administrative integration between Cisco Unified CME and
Cisco Unity Express by automatically synchronizing passwords.
No configuration is required to enable this feature.
Cisco Unified Communications Manager Express System Administrator Guide
392 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
How to Configure Voice-Mail Integration
This section contains the following tasks:
• SCCP: Configuring a Voice Mailbox Pilot Number, page 393 (required)
• SCCP: Configuring a Mailbox Selection Policy, page 394 (optional)
• SCCP: Enabling Transfer to Voice Mail, page 398 (optional)
• SCCP: Configuring Live Record, page 401 (optional)
• SIP: Configuring a Voice Mailbox Pilot Number, page 404 (required)
• Enabling DTMF Integration, page 406 (required)
• SCCP: Configuring a Phone for MWI Outcall, page 413 (optional)
• SIP: Enabling MWI at the System-Level, page 415 (required)
• SIP: Configuring a Directory Number for MWI, page 416 (required)
• Enabling SIP MWI Prefix Specification, page 419 (optional)
• SIP: Configuring VMWI, page 420 (required)
• Verifying Voice-Mail Integration, page 422 (optional)
SCCP: Configuring a Voice Mailbox Pilot Number
To configure the telephone number that is speed-dialed when the Message button on a SCCP phone is
pressed, perform the following steps.
Note The same telephone number is configured for voice messaging for all SCCP phones in
Cisco Unified CME.
Prerequisites
• Voicemail phone number must be a valid number; directory number and number for voicemail phone
number must be configured. For configuration information, see “Configuring Phones to Make Basic
Calls” on page 139.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. voicemail phone-number
5. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 393
Integrating Voice Mail
How to Configure Voice-Mail Integration
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters voice register global configuration mode to set
parameters for all supported phones in Cisco Unified CME.
Example:
Router(config)# telephony-service
Step 4 voicemail phone-number Defines the telephone number that is speed-dialed when the
Messages button on a Cisco Unified IP phone is pressed.
Example: • phone-number—Same phone number is configured for
Router(config-telephony)# voice mail 0123 voice messaging for all SCCP phones in a
Cisco Unified CME.
Step 5 end Exits to privileged EXEC mode.
Example:
Router(config-telephony)# end
What to Do Next
• (Cisco Unified CME 4.0 or a later version only) To set up a mailbox selection policy, see the “SCCP:
Configuring a Mailbox Selection Policy” section on page 394.
• To set up DTMF integration patterns for connecting to analog voice-mail applications, see the
“Enabling DTMF Integration for Analog Voice-Mail Applications” section on page 406.
• To connect to a remote SIP-based IVR or Cisco Unity, or to connect to a remote SIP-PSTN that goes
through the PSTN to a voice-mail or IVR application, see the “Enabling DTMF Integration Using
RFC 2833” section on page 408.
• To connect to a Cisco Unity Express system, configure a nonstandard SIP NOTIFY format. See the
“Enabling DTMF Integration Using SIP NOTIFY” section on page 411.
SCCP: Configuring a Mailbox Selection Policy
Perform one of the following tasks, depending on which voice-mail application is used:
• SCCP: Setting a Mailbox Selection Policy for Cisco Unity Express or a PBX Voice-Mail Number,
page 395
• SCCP: Setting Mailbox Selection Policy for Cisco Unity, page 396
Cisco Unified Communications Manager Express System Administrator Guide
394 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
SCCP: Setting a Mailbox Selection Policy for Cisco Unity Express or a PBX Voice-Mail Number
To set a policy for selecting a mailbox for calls from a Cisco Unified CME system that are diverted
before being sent to a Cisco Unity Express or PBX voice-mail pilot number, perform the following steps.
Prerequisites
Cisco Unified CME 4.0 or a later version.
Restrictions
In the following scenarios, the mailbox selection policy can fail to work properly:
• The last redirecting endpoint is not hosted on Cisco Unified CME. This may rarely occur with a
PBX.
• A call is forwarded across several SIP trunks. Multiple SIP Diversion Headers (stacking hierarchy)
are not supported in Cisco IOS software.
• A call is forwarded across non-Cisco voice gateways that do not support the optional H450.3
originalCalledNr field.
SUMMARY STEPS
1. enable
2. configure terminal
3. dial-peer voice tag voip
or
dial-peer voice tag pots
4. mailbox-selection [last-redirect-num | orig-called-num]
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 395
Integrating Voice Mail
How to Configure Voice-Mail Integration
Command or Action Purpose
Step 3 dial-peer voice tag voip Enters dial-peer configuration mode.
or
• tag—Identifies the dial peer. Valid entries are
dial-peer voice tag pots 1 to 2147483647.
Note Use this command on the outbound dial peer
Example: associated with the pilot number of the voice-mail
Router(config)# dial-peer voice 7000 voip system. For systems using Cisco Unity Express,
or this is a VoIP dial peer. For systems using
Router(config)# dial-peer voice 35 pots PBX-based voice mail, this is a POTS dial peer.
Step 4 mailbox-selection [last-redirect-num | Sets a policy for selecting a mailbox for calls that are
orig-called-num] diverted before being sent to a voice-mail line.
• last-redirect-num—(PBX voice mail only) The
Example: mailbox number to which the call will be sent is the last
Router(config-dial-peer)# mailbox-selection number to divert the call (the number that sends the call
orig-called-num
to the voice-mail pilot number).
• orig-called-num—(Cisco Unity Express only) The
mailbox number to which the call will be sent is the
number that was originally dialed before the call was
diverted.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
What to Do Next
• To use voice mail on a SIP network that connects to a Cisco Unity Express system, configure a
nonstandard SIP NOTIFY format. See the “Enabling DTMF Integration Using SIP NOTIFY”
section on page 411.
SCCP: Setting Mailbox Selection Policy for Cisco Unity
To set a policy for selecting a mailbox for calls that are diverted before being sent to a Cisco Unity
voice-mail pilot number, perform the following steps.
Prerequisites
• Cisco Unified CME 4.0 or a later version.
• Directory number to be configured is associated with a voice mailbox.
Restrictions
This feature might not work properly in certain network topologies, including when:
• The last redirecting endpoint is not hosted on Cisco Unified CME. This may rarely occur with a
PBX.
• A call is forwarded across several SIP trunks. Multiple SIP Diversion Headers (stacking hierarchy)
are not supported in Cisco IOS software.
Cisco Unified Communications Manager Express System Administrator Guide
396 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
• A call is forwarded across other voice gateways that do not support the optional H450.3
originalCalledNr field.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
4. mailbox-selection last-redirect-num
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 exit Exits dial-peer configuration mode.
Example:
Router(config-dial-peer)# exit
Step 4 ephone-dn Enters ephone-dn configuration mode.
Example:
Router(config)# ephone-dn 752
Step 5 mailbox-selection [last-redirect-num] Sets a policy for selecting a mailbox for calls that are
diverted before being sent to a Cisco Unity voice-mail pilot
number.
Example:
Router(config-ephone-dn)# mailbox-selection
last-redirect-num
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
What to Do Next
• To use a remote SIP-based IVR or Cisco Unity, or to connect Cisco Unified CME to a remote
SIP-PSTN that goes through the PSTN to a voice-mail or IVR application, see the “Enabling DTMF
Integration Using RFC 2833” section on page 408.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 397
Integrating Voice Mail
How to Configure Voice-Mail Integration
SCCP: Enabling Transfer to Voice Mail
To enable a phone user to transfer a call to voice mail by using the TrnsfVM soft key or a FAC, perform
the following steps.
Prerequisites
• Cisco Unified CME 4.3 or a later version.
• Cisco Unity Express 3.0 or a later version, installed and configured.
• For information about standard and custom FACs, see“Configuring Feature Access Codes” on
page 893.
Restrictions
The TrnsfVM soft key is not supported on the Cisco Unified IP Phone 7905, 7912, or 7921, or analog
phones connected to the Cisco VG224 or Cisco ATA. These phones support the trnsfvm FAC.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-template template-tag
4. softkeys connected {[Acct] [ConfList] [Confrn] [Endcall] [Flash] [HLog] [Hold] [Join]
[LiveRcd] [Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]}
5. exit
6. ephone phone-tag
7. ephone-template template-tag
8. exit
9. telephony-service
10. voicemail phone-number
11. fac {standard | custom trnsfvm custom-fac}
12. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
398 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
Command or Action Purpose
Step 3 ephone-template template-tag Enters ephone-template configuration mode to create an ephone
template.
Example: • template-tag—Unique identifier for the ephone template.
Router(config)# ephone-template 5 Range: 1 to 20.
Step 4 softkeys connected {[Acct] [ConfList] (Optional) Modifies the order and type of soft keys that display on
[Confrn] [Endcall] [Flash] [HLog] [Hold] an IP phone during the connected call state.
[Join] [LiveRcd] [Park] [RmLstC] [Select]
[TrnsfVM] [Trnsfer]} • You can enter any of the keywords in any order.
• Default is all soft keys are displayed in alphabetical order.
Example: • Any soft key that is not explicitly defined is disabled.
Router(config-ephone-template)# softkeys
connected TrnsfVM Park Acct ConfList
Confrn Endcall Trnsfer Hold
Step 5 exit Exits ephone-template configuration mode.
Example:
Router(config-ephone-template)# exit
Step 6 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique number that identifies this ephone
Example: during configuration tasks.
Router(config)# ephone 12
Step 7 ephone-template template-tag Applies the ephone template to the phone.
• template-tag—Unique identifier of the ephone template that
Example: you created in Step 3.
Router(config-ephone)# ephone-template 5
Step 8 exit Exits ephone configuration mode.
Example:
Router(config-ephone)# exit
Step 9 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 10 voicemail phone-number Defines the telephone number that is speed-dialed when the
Messages button on a Cisco Unified IP phone is pressed.
Example: • phone-number—Same phone number is configured for voice
Router(config-telephony)# voicemail 8900 messaging for all SCCP phones in a Cisco Unified CME.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 399
Integrating Voice Mail
How to Configure Voice-Mail Integration
Command or Action Purpose
Step 11 fac {standard | custom trnsfvm Enables standard FACs or creates a custom FAC or alias.
custom-fac}
• standard—Enables standard FACs for all phones. Standard
FAC for transfer to voice mail is *6.
Example:
Router(config-telephony)# fac custom
• custom—Creates a custom FAC for a FAC type.
trnsfvm #22 • custom-fac—User-defined code to be dialed using the keypad
on an IP or analog phone. Custom FAC can be up to 256
characters long and contain numbers 0 to 9 and * and #.
Step 12 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Example
The following example shows a configuration where the display order of the TrnsfVM soft key is
modified for the connected call state in ephone template 5 and assigned to ephone 12. A custom FAC for
transfer to voice mail is set to #22.
telephony-service
max-ephones 100
max-dn 240
timeouts transfer-recall 60
voicemail 8900
max-conferences 8 gain -6
transfer-system full-consult
fac custom trnsfvm #22
!
!
ephone-template 5
softkeys connected TrnsfVM Park Acct ConfList Confrn Endcall Trnsfer Hold
max-calls-per-button 3
busy-trigger-per-button 2
!
!
ephone 12
ephone-template 5
mac-address 000F.9054.31BD
type 7960
button 1:10 2:7
What to Do Next
• If you are finished modifying parameters for phones in Cisco Unified CME, generate a new
configuration file and restart the phones. See the “SCCP: Generating Configuration Files for SCCP
Phones” section on page 263.
• For information on how phone users transfer a call to voice mail, see the Cisco Unified IP Phone
documentation for Cisco Unified CME.
Cisco Unified Communications Manager Express System Administrator Guide
400 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
SCCP: Configuring Live Record
To configure the Live Record feature so that a phone user can record a conversation by pressing the
LiveRcd soft key, perform the followings steps.
Prerequisites
• Cisco Unified CME 4.3 or a later version.
• Cisco Unity Express 3.0 or a later version, installed and configured. For information on configuring
Live Record in Cisco Unity Express, see “Configuring Live Record” in the Cisco Unity Express
Voice-Mail and Auto-Attendant CLI Administrator Guide for 3.0 and Later Versions.
• Ad hoc hardware conference resource is configured and ready to use. See “Configuring
Conferencing” on page 753.
• If phone user wants to view the live record session, include ConfList soft key using the softkeys
connected command.
Restrictions
• Only one live record session is allowed for each conference.
• Only the conference creator can initiate a live record session. In an ad hoc conference, participants
who are not the conference creator cannot start a live record session. In a two-party call, the party
who starts the live record session is the conference creator.
Note For legal disclaimer information about this feature, see page 16.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. live-record number
5. voicemail number
6. exit
7. ephone-dn dn-tag
8. number number [secondary number] [no-reg [both | primary]]
9. call-forward all target-number
10. exit
11. ephone-template template-tag
12. softkeys connected {[Acct] [ConfList] [Confrn] [Endcall] [Flash] [HLog] [Hold] [Join]
[LiveRcd] [Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]}
13. exit
14. ephone phone-tag
15. ephone-template template-tag
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 401
Integrating Voice Mail
How to Configure Voice-Mail Integration
16. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 live record number Defines the extension number that is dialed when the
LiveRcd soft key is pressed on an SCCP IP phone.
Example:
Router(config-telephony)# live record 8900
Step 5 voicemail number Defines the extension number that is speed-dialed when
the Messages button is pressed on an IP phone.
Example: • Number—Cisco Unity Express voice-mail pilot
Router(config-telephony)# voicemail 8000 number.
Step 6 exit Exits telephony-service configuration mode.
Example:
Router(config-telephony)# exit
Step 7 ephone-dn dn-tag Creates a directory number that forwards all calls to the
Cisco Unity Express voice-mail pilot number.
Example:
Router(config)# ephone-dn 10
Step 8 number number [secondary number] [no-reg [both | Assigns an extension number to this directory number.
primary]]
• Number—Must match the Live Record pilot-number
configured in Step 4.
Example:
Router(config-ephone-dn)# number 8900
Step 9 call-forward all target-number Forwards all calls to this extension to the specified
voice-mail number.
Example: • target-number—Phone number to which calls are
Router(config-ephone-dn)# call-forward all 8000 forwarded. Must match the voice-mail pilot number
configured in Step 5.
Note Phone users can activate and cancel the
call-forward-all state from the phone using the
CFwdAll soft key or a FAC.
Cisco Unified Communications Manager Express System Administrator Guide
402 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
Command or Action Purpose
Step 10 exit Exits ephone-dn configuration mode.
Example:
Router(config-ephone-dn)# exit
Step 11 ephone-template template-tag Enters ephone-template configuration mode to create an
ephone template.
Example: • template-tag—Unique identifier for the ephone
Router(config)# ephone-template 5 template. Range: 1 to 20.
Step 12 softkeys connected {[Acct] [ConfList] [Confrn] Modifies the order and type of soft keys that display on
[Endcall] [Flash] [HLog] [Hold] [Join] [LiveRcd] an IP phone during the connected call state.
[Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]}
Example:
Router(config-ephone-template)# softkeys
connected LiveRcd Confrn Hold Park Trnsfer
TrnsfVM
Step 13 exit Exits ephone-template configuration mode.
Example:
Router(config-ephone-template)# exit
Step 14 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique number that identifies this
Example: ephone during configuration tasks.
Router(config)# ephone 12
Step 15 ephone-template template-tag Applies the ephone template to the phone.
• template-tag—Unique identifier of the ephone
Example: template that you created in Step 11.
Router(config-ephone)# ephone-template 5
Step 16 end Exits to privileged EXEC mode.
Example:
Router(config-ephone)# end
Example
The following example shows Live Record is enabled at the system-level for extension 8900. All
incoming calls to extension 8900 are forwarded to the voice-mail pilot number 8000 when the LiveRcd
soft key is pressed, as configured under ephone-dn 10. Ephone template 5 modifies the display order of
the LiveRcd soft key on IP phones.
telephony-service
privacy-on-hold
max-ephones 100
max-dn 240
timeouts transfer-recall 60
live-record 8900
voicemail 8000
max-conferences 8 gain -6
transfer-system full-consult
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 403
Integrating Voice Mail
How to Configure Voice-Mail Integration
fac standard
!
!
ephone-template 5
softkeys remote-in-use CBarge Newcall
softkeys hold Resume Newcall Join
softkeys connected LiveRcd Confrn Hold Park Trnsfer TrnsfVM
max-calls-per-button 3
busy-trigger-per-button 2
!
!
ephone-dn 10
number 8900
call-forward all 8000
SIP: Configuring a Voice Mailbox Pilot Number
To configure the telephone number that is speed-dialed when the Message button on a SIP phone is
pressed, follow the steps in this section.
Note The same telephone number is configured for voice messaging for all SIP phones in Cisco Unified CME.
The call forward b2bua command enables call forwarding and designates that calls that are forwarded
to a busy or no-answer extension be sent to a voicemail box.
Prerequisites
• Directory number and number for voicemail phone number must be configured. For configuration
information, see “Configuring Phones to Make Basic Calls” on page 139.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. voicemail phone-number
5. exit
6. voice register dn dn-tag
7. call-forward b2bua busy directory-number
8. call-forward b2bua mailbox directory-number
9. call-forward b2bua noan directory-number
10. end
Cisco Unified Communications Manager Express System Administrator Guide
404 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Step 4 voicemail phone-number Defines the telephone number that is speed-dialed when the
Messages button on a Cisco Unified IP phone is pressed.
Example: • phone-number—Same phone number is configured for
Router(config-register-global)# voice mail 1111 voice messaging for all SIP phones in a
Cisco Unified CME.
Step 5 exit Exits voice register global configuration mode.
Example:
Router(config-register-global)# exit
Step 6 voice register dn dn-tag Enters voice register dn mode to define a directory number
for a SIP phone, intercom line, voice port, or an MWI.
Example:
Router(config)# voice register dn 2
Step 7 call-forward b2bua busy directory-number Enables call forwarding for a SIP back-to-back user agent
so that incoming calls to an extension that is busy will be
forwarded to the designated directory number.
Example:
Router(config-register-dn)# call-forward b2bua
busy 1000
Step 8 call-forward b2bua mailbox directory-number Designates the voice mailbox to use at the end of a chain of
call forwards.
Example: • Incoming calls have been forwarded to a busy or
Router(config-register-dn)# call-forward b2bua no-answer extension will be forwarded to the
mailbox 2200 directory-number specified.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 405
Integrating Voice Mail
How to Configure Voice-Mail Integration
Command or Action Purpose
Step 9 call-forward b2bua noan directory-number Enables call forwarding for a SIP back-to-back user agent
timeout seconds so that incoming calls to an extension that does not answer
will be forwarded to the designated directory number.
Example: • seconds—Number of seconds that a call can ring with
Router(config-register-dn)# call-forward b2bua no answer before the call is forwarded to another
noan 2201 timeout 15
extension. Range: 3 to 60000. Default: 20.
Step 10 end Exits to privileged EXEC mode.
Example:
Router(config-register-dn)# end
What to Do Next
• To set up DTMF integration patterns for connecting to analog voice-mail applications, see the
“Enabling DTMF Integration for Analog Voice-Mail Applications” section on page 406.
• To use a remote SIP-based IVR or Cisco Unity, or to connect to a remote SIP-PSTN that goes
through the PSTN to a voice-mail or IVR application, see the “Enabling DTMF Integration Using
RFC 2833” section on page 408.
• To connect to a Cisco Unity Express system, configure a nonstandard SIP NOTIFY format, see the
“Enabling DTMF Integration Using SIP NOTIFY” section on page 411.
Enabling DTMF Integration
Perform one of the following tasks, depending on which DTMF-relay method is required:
• Enabling DTMF Integration for Analog Voice-Mail Applications, page 406—To set up DTMF
integration patterns for connecting to analog voice-mail applications.
• Enabling DTMF Integration Using RFC 2833, page 408—To connect to a remote SIP-based IVR or
voice-mail application such as Cisco Unity or when SIP is used to connect Cisco Unified CME to a
remote SIP-PSTN voice gateway that goes through the PSTN to a voice-mail or IVR application.
• Enabling DTMF Integration Using SIP NOTIFY, page 411—To configure a SIP dial peer to point to
Cisco Unity Express.
Enabling DTMF Integration for Analog Voice-Mail Applications
To set up DTMF integration patterns for analog voice-mail applications, perform the following steps.
Note You can configure multiple tags and tokens for each pattern, depending on the voice-mail system and
type of access.
SUMMARY STEPS
1. enable
2. configure terminal
3. vm-integration
Cisco Unified Communications Manager Express System Administrator Guide
406 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
4. pattern direct tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}]
[tag3 {CGN | CDN | FDN}] [last-tag]
5. pattern ext-to-ext busy tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}]
[tag3 {CGN | CDN | FDN}] [last-tag]
6. pattern ext-to-ext no-answer tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}]
[tag3 {CGN | CDN | FDN}] [last-tag]
7. pattern trunk-to-ext busy tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}]
[tag3 {CGN | CDN | FDN}] [last-tag]
8. pattern trunk-to-ext no-answer tag1 {CGN | CDN | FDN} [tag2 {CGN | CDN | FDN}]
[tag3 {CGN | CDN | FDN}] [last-tag]
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 vm-integration Enters voice-mail integration configuration mode and
enables voice-mail integration with DTMF and an analog
voice-mail system.
Example:
Router(config) vm-integration
Step 4 pattern direct tag1 {CGN | CDN | FDN} [tag2 Configures the DTMF digit pattern forwarding necessary to
{CGN | CDN | FDN}] [tag3 {CGN | CDN | FDN}] activate the voice-mail system when the user presses the
[last-tag]
messages button on the phone.
• The tag attribute is an alphanumeric string fewer than
Example: four DTMF digits in length. The alphanumeric string
Router(config-vm-integration) pattern direct
consists of a combination of four letters (A, B, C, and D),
2 CGN *
two symbols (* and #), and ten digits (0 to 9). The tag
numbers match the numbers defined in the voice-mail
system’s integration file, immediately preceding either
the number of the calling party, the number of the called
party, or a forwarding number.
• The keywords, CGN, CDN, and FDN, configure the type
of call information sent to the voice-mail system, such as
calling number (CGN), called number (CDN), or
forwarding number (FDN).
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 407
Integrating Voice Mail
How to Configure Voice-Mail Integration
Command or Action Purpose
Step 5 pattern ext-to-ext busy tag1 {CGN | CDN | Configures the DTMF digit pattern forwarding necessary to
FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | activate the voice-mail system when an internal extension
CDN | FDN}] [last-tag]
attempts to connect to a busy extension and the call is
forwarded to voice mail.
Example:
Router(config-vm-integration) pattern
ext-to-ext busy 7 FDN * CGN *
Step 6 pattern ext-to-ext no-answer tag1 {CGN | CDN Configures the DTMF digit pattern forwarding necessary to
| FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | activate the voice-mail system when an internal extension
CDN | FDN}] [last-tag]
fails to connect to an extension and the call is forwarded to
voice mail.
Example:
Router(config-vm-integration) pattern
ext-to-ext no-answer 5 FDN * CGN *
Step 7 pattern trunk-to-ext busy tag1 {CGN | CDN | Configures the DTMF digit pattern forwarding necessary to
FDN} [tag2 {CGN | CDN | FDN}] [tag3 {CGN | activate the voice-mail system when an external trunk call
CDN | FDN}] [last-tag]
reaches a busy extension and the call is forwarded to voice
mail.
Example:
Router(config-vm-integration) pattern
trunk-to-ext busy 6 FDN * CGN *
Step 8 pattern trunk-to-ext no-answer tag1 {CGN | Configures the DTMF digit pattern forwarding necessary to
CDN | FDN} [tag2 {CGN | CDN | FDN}] [tag3 activate the voice-mail system when an external trunk call
{CGN | CDN | FDN}] [last-tag]
reaches an unanswered extension and the call is forwarded to
voice mail.
Example:
Router(config-vm-integration)# pattern
trunk-to-ext no-answer 4 FDN * CGN *
Step 9 end Exits configuration mode and enters privileged EXEC mode.
Example:
Router(config-vm-integration)# exit
What to Do Next
After configuring DTMF relay, you are ready to configure Message Waiting Indicator (MWI)
notification for either the MWI outcall, unsolicited notify, or subscribe/notify mechanism. See the
“SCCP: Configuring a Phone for MWI Outcall” section on page 413.
Enabling DTMF Integration Using RFC 2833
To configure a SIP dial peer to point to Cisco Unity and enable SIP dual-tone multifrequency (DTMF)
relay using RFC 2833, use the commands in this section on both the originating and terminating
gateways.
This DTMF relay method is required in the following situations:
• When SIP is used to connect Cisco Unified CME to a remote SIP-based IVR or voice-mail
application such as Cisco Unity.
Cisco Unified Communications Manager Express System Administrator Guide
408 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
• When SIP is used to connect Cisco Unified CME to a remote SIP-PSTN voice gateway that goes
through the PSTN to a voice-mail or IVR application.
Note If the T.38 Fax Relay feature is also configured on this IP network, we recommend that you either
configure the voice gateways to use a payload type other than PT96 or PT97 for fax relay negotiation,
or depending on whether the SIP endpoints support different payload types, configure
Cisco Unified CME to use a payload type other than PT96 or PT97 for DTMF.
Prerequisites
• Configure the codec or voice-class codec command for transcoding between G.711 and G.729. See
“Configuring Phones to Make Basic Calls” on page 139.
SUMMARY STEPS
1. enable
2. configure terminal
3. dial-peer voice tag voip
4. description string
5. destination-pattern string
6. session protocol sipv2
7. session target {dns:address | ipv4:destination-address}
8. dtmf-relay rtp-nte
9. dtmf-interworking rtp-nte
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 dial-peer voice tag voip Enters dial-peer configuration mode to define a VoIP dial
peer for the voice-mail system.
Example: • tag—Defines the dial peer being configured. Range is
Router (config)# dial-peer voice 123 voip 1 to 2147483647.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 409
Integrating Voice Mail
How to Configure Voice-Mail Integration
Command or Action Purpose
Step 4 description string (Optional) Associates a description with the dial peer being
configured. Enter a string of up to 64 characters.
Example:
Router (config-voice-dial-peer)# description CU
pilot
Step 5 destination-pattern string Specifies the pattern of the numbers that the user must dial
to place a call.
Example: • string—Prefix or full E.164 number.
Router (config-voice-dial-peer)#
destination-pattern 20
Step 6 session protocol sipv2 Specifies that Internet Engineering Task Force (IETF)
Session Initiation Protocol (SIP) is protocol to be used for
calls between local and remote routers using the packet
Example:
Router (config-voice-dial-peer)# session
network.
protocol sipv2
Step 7 session target {dns:address | Designates a network-specific address to receive calls from
ipv4:destination-address} the dial peer being configured.
• dns:address—Specifies the DNS address of the
Example: voice-mail system.
Router (config-voice-dial-peer)# session target
ipv4:10.8.17.42 • ipv4:destination- address—Specifies the IP address of
the voice-mail system.
Step 8 dtmf-relay rtp-nte Sets DTMF relay method for the voice dial peer being
configured.
Example: • rtp-nte— Provides conversion from the out-of-band
Router (config-voice-dial-peer)# dtmf-relay SCCP indication to the SIP standard for DTMF relay
rtp-nte (RFC 2833). Forwards DTMF tones by using
Real-Time Transport Protocol (RTP) with the Named
Telephone Event (NTE) payload type.
• This command can also be configured in
voice-register-pool configuration mode. For individual
phones, the phone-level configuration for this
command overrides the system-level configuration for
this command.
Note The need to use out-of-band conversion is limited to
SCCP phones. SIP phones natively support in-band.
Cisco Unified Communications Manager Express System Administrator Guide
410 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
Command or Action Purpose
Step 9 dtmf-interworking rtp-nte (Optional) Enables a delay between the dtmf-digit begin
and dtmf-digit end events in the RFC 2833 packets.
Example: • This command is supported in Cisco IOS Release
Router (config-voice-dial-peer)# 12.4(15)XZ and later releases and in
dtmf-interworking rtp-nte Cisco Unified CME 4.3 and later versions.
• This command can also be configured in voice-service
configuration mode.
Step 10 end Exits to privileged EXEC mode.
Example:
Router(config-voice-dial-peer)# end
What to Do Next
After configuring DTMF relay, you are ready to configure Message Waiting Indicator (MWI)
notification for either the MWI outcall, unsolicited notify, or subscribe/notify mechanism. See the
“SCCP: Configuring a Phone for MWI Outcall” section on page 413.
Enabling DTMF Integration Using SIP NOTIFY
To configure a SIP dial peer to point to Cisco Unity Express and enable SIP dual-tone
multifrequency (DTMF) relay using SIP NOTIFY format, follow the steps in this task.
SUMMARY STEPS
1. enable
2. configure terminal
3. dial-peer voice tag voip
4. description string
5. destination-pattern string
6. b2bua
7. session protocol sipv2
8. session target {dns:address | ipv4:destination-address}
9. dtmf-relay sip-notify
10. codec g711ulaw
11. no vad
12. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 411
Integrating Voice Mail
How to Configure Voice-Mail Integration
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal#
Step 3 dial-peer voice tag voip Enters dial-peer configuration mode to define a VoIP dial
peer for the voice-mail system.
Example: • tag—Defines the dial peer being configured. Range is
Router (config)# dial-peer voice 2 voip 1 to 2147483647.
Step 4 description string (Optional) Associates a description with the dial peer being
configured. Enter a string of up to 64 characters.
Example:
Router (config-voice-dial-peer)# description
cue pilot
Step 5 destination-pattern string Specifies the pattern of the numbers that the user must dial
to place a call.
Example: • string—Prefix or full E.164 number.
Router (config-voice-dial-peer)#
destination-pattern 20
Step 6 b2bua (Optional) Includes the Cisco Unified CME address as part
of contact in 3XX response to point to Cisco Unity Express
and enables SIP-to-SCCP call forward.
Example:
Router (config-voice-dial-peer)# b2bua
Step 7 session protocol sipv2 Specifies that Internet Engineering Task Force (IETF)
Session Initiation Protocol (SIP) is protocol to be used for
calls between local and remote routers using the packet
Example:
Router (config-voice-dial-peer)# session
network.
protocol sipv2
Step 8 session target {dns:address | Designates a network-specific address to receive calls from
ipv4:destination-address} the dial peer being configured.
• dns:address—Specifies the DNS address of the
Example: voice-mail system.
Router (config-voice-dial-peer)# session target
ipv4:10.5.49.80 • ipv4:destination- address—Specifies the IP address of
the voice-mail system.
Cisco Unified Communications Manager Express System Administrator Guide
412 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
Command or Action Purpose
Step 9 dtmf-relay sip-notify Sets the DTMF relay method for the voice dial peer being
configured.
Example: • sip-notify— Forwards DTMF tones using SIP NOTIFY
Router (config-voice-dial-peer)# dtmf-relay messages.
sip-notify
• This command can also be configured in
voice-register-pool configuration mode. For individual
phones, the phone-level configuration for this
command overrides the system-level configuration for
this command.
Step 10 codec g711ulaw Specifies the voice coder rate of speech for a dial peer being
configured.
Example:
Router (config-voice-dial-peer)# codec g711ulaw
Step 11 no vad Disables voice activity detection (VAD) for the calls using
the dial peer being configured.
Example:
Router (config-voice-dial-peer)# no vad
Step 12 end Exits to privileged EXEC mode.
Example:
Router(config-voice-dial-peer)# end
What to Do Next
After configuring DTMF relay, you are ready to configure Message Waiting Indicator (MWI). See the
“SCCP: Configuring a Phone for MWI Outcall” section on page 413.
SCCP: Configuring a Phone for MWI Outcall
To designate a phone line or directory number on an individual SCCP phone to be monitored for
voice-mail messages, or to enable audible MWI, perform the following steps.
Prerequisites
• Directory number and number for MWI line must be configured. For configuration information, see
“Configuring Phones to Make Basic Calls” on page 139.
Restrictions
• Audible MWI is supported only in Cisco Unified CME 4.0(2) and later versions.
• Audible MWI is supported only on Cisco Unified IP Phone 7931G and Cisco Unified IP
Phone 7911.
SUMMARY STEPS
1. enable
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 413
Integrating Voice Mail
How to Configure Voice-Mail Integration
2. configure terminal
3. ephone phone-tag
4. mwi-line line-number
5. exit
6. ephone-dn dn-tag
7. mwi {off | on | on-off}
8. mwi-type {visual | audio | both}
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
Example:
Router(config)# ephone 36
Step 4 mwi-line line-number (Optional) Selects a phone line to receive MWI treatment.
• line-number—Number of phone line to receive MWI
Example: notification. Range: 1 to 34. Default: 1.
Router(config-ephone)# mwi-line 3
Step 5 exit Exits ephone configuration mode.
Example:
Router(config-ephone)# exit
Step 6 ephone-dn dn-tag Enters ephone-dn configuration mode.
Example:
Router(config)# ephone-dn 11
Step 7 mwi {off | on | on-off} (Optional) Enables a specific directory number to receive MWI
notification from an external voice-messaging system.
Example: Note This command can also be configured in
Router(config-ephone-dn)# mwi on-off ephone-dn-template configuration mode. The value that
you set in ephone-dn configuration mode has priority over
the value set in ephone-dn-template mode.
Cisco Unified Communications Manager Express System Administrator Guide
414 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
Command or Action Purpose
Step 8 mwi-type {visual | audio | both} (Optional) Specifies which type of MWI notification to be
received.
Example: Note This command is supported only on the Cisco Unified IP
Router(config-ephone-dn)# mwi-type Phone 7931G and Cisco Unified IP Phone 7911.
audible
Note This command can also be configured in
ephone-dn-template configuration mode. The value that
you set in ephone-dn configuration mode has priority over
the value set in ephone-dn-template mode. For
configuration information, see “SCCP: Enabling
Ephone-dn Templates” on page 1132.
Step 9 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
SIP: Enabling MWI at the System-Level
To enable a message waiting indicator (MWI) at a system-level, perform the following steps.
Prerequisites
• Cisco CME 3.4 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. mwi reg-e164
5. mwi stutter
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 415
Integrating Voice Mail
How to Configure Voice-Mail Integration
Command or Action Purpose
Step 3 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Step 4 mwi reg-e164 Registers full E.164 number to the MWI server in
Cisco Unified CME and enables MWI.
Example:
Router(config-register-global)# mwi reg-e164
Step 5 mwi stutter Enables Cisco Unified CME router at the central site to
relay MWI notification to remote SIP phones.
Example:
Router(config-register-global)# mwi stutter
Step 6 end Exits to privileged EXEC mode.
Example:
Router(config-register-global)# end
SIP: Configuring a Directory Number for MWI
Perform one of the following tasks, depending on whether you want to configure MWI outcall or MWI
notify (unsolicited notify or subscribe/notify) for SIP endpoints in Cisco Unified CME.
• SIP: Defining Pilot Call Back Number for MWI Outcall, page 416
• SIP: Configuring a Directory Number for MWI NOTIFY, page 417
SIP: Defining Pilot Call Back Number for MWI Outcall
To designate a phone line on an individual SIP directory number to be monitored for voice-mail
messages, perform the following steps.
Prerequisites
• Cisco CME 3.4 or a later version.
• Directory number and number for receiving MWI must be configured. For configuration
information, see “Configuring Phones to Make Basic Calls” on page 139.
Restrictions
• For Cisco Unified CME 4.1 and later versions, the Call Forward All, Presence, and MWI features
require that SIP phones must be configured with a directory number by using the number command
with the dn keyword; direct line numbers are not supported.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
416 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
3. voice register dn dn-tag
4. mwi
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register dn dn-tag Enters voice register dn configuration mode to define a
directory number for a SIP phone, intercom line, voice port,
or an MWI.
Example:
Router(config)# voice register dn 1
Step 4 mwi Enables a specific directory number to receive MWI
notification.
Example:
Router(config-register-dn)# mwi
Step 5 end Exits to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
SIP: Configuring a Directory Number for MWI NOTIFY
To identify the MWI server and specify a directory number for receiving MWI Subscribe/NOTIFY or
MWI Unsolicited NOTIFY, follow the steps in this section.
Note We recommend using the Subscribe/NOTIFY method instead of an Unsolicited NOTIFY when possible.
Prerequisites
• Cisco CME 3.4 or a later version.
• For Cisco Unified CME 4.0 and later, QSIQ supplementary services must be configured on the
Cisco router. For information, see “Enabling H.450.7 and QSIG Supplementary Services at a
System-Level” on page 633 or “Enabling H.450.7 and QSIG Supplementary Services on a Dial
Peer” section on page 634.
• Directory number and number for receiving MWI must be configured. For configuration
information, see “Configuring Phones to Make Basic Calls” on page 139.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 417
Integrating Voice Mail
How to Configure Voice-Mail Integration
Restrictions
• For Cisco Unified CME 4.1 and later versions, the Call Forward All, Presence, and MWI features
require that SIP phones must be configured with a directory number by using the number command
with the dn keyword; direct line numbers are not supported.
• The SIP MWI - QSIG Translation feature in Cisco Unified CME 4.1 does not support Subscribe
NOTIFY.
• Cisco Unified IP Phone 7960, 7940, 7905, and 7911 support only Unsolicited NOTIFY for MWI.
SUMMARY STEPS
1. enable
2. configure terminal
3. sip-ua
4. mwi-server {ipv4:destination-address | dns:host-name} [unsolicited]
5. exit
6. voice register dn dn-tag
7. mwi
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 sip-ua Enters Session Initiation Protocol (SIP) user agent (ua)
configuration mode for configuring the user agent.
Example:
Router(config)# sip-ua
Step 4 mwi-server {ipv4:destination-address | Specifies voice-mail server settings on a voice gateway or
dns:host-name} [unsolicited] UA.
Note The sip-server and mwi expires commands under
Example: the telephony-service configuration mode have
Router(config-sip-ua)# mwi-server been migrated to mwi-server to support DNS
ipv4:1.5.49.200
format of the SIP server.
or
Router(config-sip-ua)# mwi-server
dns:server.yourcompany.com unsolicited
Cisco Unified Communications Manager Express System Administrator Guide
418 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
Command or Action Purpose
Step 5 exit Exits to the next highest mode in the configuration mode
hierarchy.
Example:
Router(config-sip-ua)# exit
Step 6 voice register dn dn-tag Enters voice register dn configuration mode to define a
directory number for a SIP phone, intercom line, voice port,
or an MWI.
Example:
Router(config)# voice register dn 1
Step 7 mwi Enables a specific directory number to receive MWI
notification.
Example:
Router(config-register-dn)# mwi
Step 8 end Exits to privileged EXEC mode.
Example:
Router(config-register-dn)# end
Enabling SIP MWI Prefix Specification
To accept unsolicited SIP Notify messages for MWI that include a prefix string as a site identifier,
perform the following steps.
Prerequisites
• Cisco Unified CME 4.0 or a later version.
• Directory number for receiving MWI Unsolicited NOTIFY must be configured. For information, see
“SIP: Configuring a Directory Number for MWI NOTIFY” section on page 417.
SUMMARY STEPS
1. enable
2. telephony-service
3. mwi prefix prefix-string
4. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 419
Integrating Voice Mail
How to Configure Voice-Mail Integration
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 3 mwi prefix prefix-string Specifies a string of digits that, if present before a known
Cisco Unified CME extension number, are recognized as a
prefix.
Example:
Router(config-telephony)# mwi prefix 555 • prefix-string—Digit string. The maximum prefix length
is 32 digits.
Step 4 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
SIP: Configuring VMWI
To enable a VMWI, perform the following steps.
Prerequisites
• Cisco IOS Release 12.4(6)T or a later version
SUMMARY STEPS
1. enable
2. configure terminal
3. voice-port port
4. mwi
5. vmwi dc-voltage
or
vmwi fsk
6. exit
7. sip-ua
8. mwi-server {ipv4:destination-address | dns:host-name} [unsolicited]
9. end
Cisco Unified Communications Manager Express System Administrator Guide
420 OL-10663-02
Integrating Voice Mail
How to Configure Voice-Mail Integration
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice-port port Enters voice-port configuration mode.
• port—Syntax is platform-dependent. Type ? to
Example: determine.
Router(config)# voice-port 2/0
Step 4 mwi Enables MWI for a specified voice port.
Example:
Router(config-voiceport)# mwi
Step 5 vmwi dc-voltage (Optional) Enables DC voltage or FSK VMWI on a
Cisco VG224 onboard analog FXS voice port.
or
You do not need to perform this step for the Cisco VG202
vmwi fsk
and Cisco VG204. They support FSK only. VMWI is
configured automatically when MWI is configured on the
Example: voice port.
Router(config-voiceport)# vmwi dc-voltage
This step is required for the VG224. If an FSK phone is
connected to the voice port, use the fsk keyword. If a DC
voltage phone is connected to the voice port, use the
dc-voltage keyword.
Step 6 exit Exits to the next highest mode in the configuration mode
hierarchy.
Example:
Router(config-sip-ua)# exit
Step 7 sip-ua Enters Session Initiation Protocol user agent configuration
mode for configuring the user agent.
Example:
Router(config)# sip-ua
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 421
Integrating Voice Mail
Configuration Examples for Voice-Mail Integration
Command or Action Purpose
Step 8 mwi-server {ipv4:destination-address | Specifies voice-mail server settings on a voice gateway or
dns:host-name} [unsolicited] user agent (ua).
Note The sip-server and mwi expires commands under
Example: the telephony-service configuration mode have
Router(config-sip-ua)# mwi-server been migrated to mwi-server to support DNS
ipv4:1.5.49.200
format of the Session Initiation Protocol (SIP)
or
server.
Router(config-sip-ua)# mwi-server
dns:server.yourcompany.com unsolicited
Step 9 end Exits voice-port configuration mode and returns to
privileged EXEC mode.
Example:
Router(config-voiceport)# end
Verifying Voice-Mail Integration
• Press the Messages button on a local phone in Cisco Unified CME and listen for the voice mail
greeting.
• Dial an unattended local phone and listen for the voice mail greeting.
• Leave a test message.
• Go to the phone that you called. Verify that the [Message] indicator is lit.
• Press the Messages button on this phone and retrieve the voice mail message.
Configuration Examples for Voice-Mail Integration
This section contains the following examples:
• Mailbox Selection Policy for SCCP Phones: Example, page 423
• Voice Mailbox for SIP Phones: Example, page 423
• DTMF Integration Using RFC 2833: Example, page 423
• DTMF Integration Using SIP Notify: Example, page 423
• DTMF Integration for Legacy Voice-Mail Applications: Example, page 424
• SCCP Phone Line for MWI: Example, page 424
• SIP MWI Prefix Specification: Example, page 425
• SIP Directory Number for MWI Outcall: Example, page 425
• SIP Directory Number for MWI Unsolicited Notify: Example, page 425
• SIP Directory Number for MWI Subscribe/NOTIFY: Example, page 425
Cisco Unified Communications Manager Express System Administrator Guide
422 OL-10663-02
Integrating Voice Mail
Configuration Examples for Voice-Mail Integration
Mailbox Selection Policy for SCCP Phones: Example
The following example sets a policy to select the mailbox of the originally called number when a call is
diverted to a Cisco Unity Express or PBX voice-mail system with the pilot number 7000.
dial-peer voice 7000 voip
destination-pattern 7000
session target ipv4:10.3.34.211
codec g711ulaw
no vad
mailbox-selection orig-called-num
The following example sets a policy to select the mailbox of the last number that the call was diverted
to before being diverted to a Cisco Unity voice-mail system with the pilot number 8000.
ephone-dn 825
number 8000
mailbox-selection last-redirect-num
Voice Mailbox for SIP Phones: Example
The following example shows how to configure the call forward b2bua mailbox for SIP endpoints:
voice register global
voicemail 1234
!
voice register dn 2
number 2200
call-forward b2bua all 1000
call-forward b2bua mailbox 2200
call-forward b2bua noan 2201 timeout 15
mwi
DTMF Integration Using RFC 2833: Example
The following example shows the configuration for DTMF Relay using RFC 2833:
dial-peer voice 1 voip
destination-pattern 4…
session target ipv4:10.8.17.42
session protocol sipv2
dtmf-relay sip-notify rtp-nte
DTMF Integration Using SIP Notify: Example
The following example shows the configuration for DTMF using SIP Notify:
dial-peer voice 1 voip
destination-pattern 4…
session target ipv4:10.5.49.80
session protocol sipv2
dtmf-relay sip-notify
b2bua
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 423
Integrating Voice Mail
Configuration Examples for Voice-Mail Integration
DTMF Integration for Legacy Voice-Mail Applications: Example
The following example sets up DTMF integration for an analog voice-mail system.
vm-integration
pattern direct 2 CGN *
pattern ext-to-ext busy 7 FDN * CGN *
pattern ext-to-ext no-answer 5 FDN * CGN *
pattern trunk-to-ext busy 6 FDN * CGN *
pattern trunk-to-ext no-answer 4 FDN * CGN *
SCCP Phone Line for MWI: Example
The following example enables MWI on ephone 18 for line 2 (button 2), which has overlaid ephone-dns.
Only a message waiting for the first ephone-dn (2021) on this line will activate the MWI lamp. Button 4
is unused. The line numbers in this example are as follows:
• Line 1—Button 1—Extension 2020
• Line 2—Button 2—Extension 2021, 2022, 2023, 2024
• Line 3—Button 3—Extension 2021, 2022, 2023, 2024 (rollover line)
• Button 4—Unused
• Line 4—Button 5—Extension 2025
ephone-dn 20
number 2020
ephone-dn 21
number 2021
ephone-dn 22
number 2022
ephone-dn 23
number 2023
ephone-dn 24
number 2024
ephone-dn 25
number 2025
ephone 18
button 1:20 2o21,22,23,24,25 3x2 5:26
mwi-line 2
The following example enables MWI on ephone 17 for line 3 (extension 609). In this example, the button
numbers do not match the line numbers because buttons 2 and 4 are not used. The line numbers in this
example are as follows:
• Line 1—Button 1—Extension 607
• Button 2—Unused
• Line 2—Button 3—Extension 608
• Button 4—Unused
• Line 3—Button 5—Extension 609
Cisco Unified Communications Manager Express System Administrator Guide
424 OL-10663-02
Integrating Voice Mail
Configuration Examples for Voice-Mail Integration
ephone-dn 17
number 607
ephone-dn 18
number 608
ephone-dn 19
number 609
ephone 25
button 1:17 3:18 5:19
mwi-line 3
SIP MWI Prefix Specification: Example
The following example identifies the SIP server for MWI notification at the IP address 172.16.14.22. It
states that the Cisco Unified CME system will accept unsolicited SIP Notify messages for known
mailbox numbers using the prefix 555.
sip-ua
mwi-server 172.16.14.22 unsolicited
telephony-service
mwi prefix 555
SIP Directory Number for MWI Outcall: Example
The following example shows an MWI callback pilot number:
voice register dn
number 9000….
mwi
SIP Directory Number for MWI Unsolicited Notify: Example
The following example shows how to specify voice-mail server settings on a UA. The example includes
the unsolicited keyword, enabling the voice-mail server to send a SIP notification message to the UA if
the mailbox status changes and specifies that voice dn 1, number 1234 on the SIP phone in
Cisco Unified CME will receive the MWI notification:
sip-ua
mwi-server dns:server.yourcompany.com expires 60 port 5060 transport udp unsolicited
voice register dn 1
number 1234
mwi
SIP Directory Number for MWI Subscribe/NOTIFY: Example
The following example shows how to define an MWI server and specify that directory number 1,
number 1234 on a SIP phone in Cisco Unified CME is to receive the MWI notification:
sip-ua
mwi-server ipv4:1.5.49.200
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 425
Integrating Voice Mail
Additional References
voice register dn 1
number 1234
mwi
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
426 OL-10663-02
Integrating Voice Mail
Feature Information for Voice-Mail Integration
Feature Information for Voice-Mail Integration
Table 27 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 27 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 27 Feature Information for Voice-Mail Integration
Cisco Unified CME
Feature Name Version Feature Information
Audible MWI 4.0(2) Provides support for selecting audible, visual, or audible
and visual Message Waiting Indicator (MWI) on supported
Cisco Unified IP phones.
Cisco Unity Express AXL Enhancement 7.0(1) Cisco Unified CME and Cisco Unity Express passwords
are automatically synchronized. No configuration is
required for this feature.
DTMF Integration 3.4 Added support for voice messaging systems connected via
a SIP trunk or SIP user agent.
The standard Subscribe/NOTIFY method is preferred over
an Unsolicited NOTIFY.
2.0 DTMF integration patterns were introduced.
Live Record 4.3 Enables IP phone users in a Cisco Unified CME system to
record a phone conversation if Cisco Unity Express is the
voice mail system.
Mailbox Selection Policy 4.0 Mailbox selection policy was introduced.
MWI 4.0 MWI line selection of a phone line other than the primary
line on a SCCP phone was introduced.
3.4 Voice messaging systems (including Cisco Unity)
connected via a SIP trunk or SIP user agent can pass a
Message Waiting Indicator (MWI) that will be received and
understood by a SIP phone directly connected to
Cisco Unified CME.
SIP MWI Prefix Specification 4.0 SIP MWI prefix specification was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 427
Integrating Voice Mail
Feature Information for Voice-Mail Integration
Table 27 Feature Information for Voice-Mail Integration
Cisco Unified CME
Feature Name Version Feature Information
SIP MWI - QSIG Translation 4.1 Extends message waiting indicator (MWI) functionality for
SIP MWI and QSIG MWI interoperation to enable sending
and receiving of MWI over QSIG to PBX.
Transfer to Voice Mail 4.3 Enables a phone user to transfer a caller directly to a
voice-mail extension.
Cisco Unified Communications Manager Express System Administrator Guide
428 OL-10663-02
Configuring Security
Last Updated: January 5, 2009
This chapter describes the phone authentication support in Cisco Unified Communications Manager
Express (Cisco Unified CME) and the Media Encryption (SRTP) on Cisco Unified CME feature which
provides the following secure voice call capabilities:
• Secure call control signaling and media streams in Cisco Unified CME networks using Secure
Real-Time Transport Protocol (SRTP) and H.323 protocols.
• Secure supplementary services for Cisco Unified CME networks using H.323 trunks.
• Secure Cisco VG224 Analog Phone Gateway endpoints.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Security” section
on page 495.
Contents
• Prerequisites for Security, page 428
• Restrictions for Security, page 428
• Information About Security, page 429
• How to Configure Security, page 441
• Configuration Examples for Security, page 479
• Where to Go Next, page 493
• Additional References, page 494
• Feature Information for Security, page 495
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 427
Configuring Security
Prerequisites for Security
Prerequisites for Security
• Cisco Unified CME 4.0 or a later version for Phone Authentication.
• Cisco Unified CME 4.2 or a later version for Media Encryption (SRTP) on Cisco Unified CME.
• Cisco IOS feature set Advanced Enterprise Services (adventerprisek9) or Advanced IP Services
(advipservicesk9) on supported platforms.
• System clock must be set by using one of the following methods:
– Configure Network Time Protocol (NTP). For configuration information, see “Enabling
Network Time Protocol on the Cisco Unified CME Router” on page 88.
– Manually set the software clock using the clock set command. For information about this
command, see the Cisco IOS Network Management Command Reference.
Restrictions for Security
Phone Authentication
• Cisco Unified CME phone authentication is not supported on the Cisco IAD 2400 series or the
Cisco 1700 series.
Media Encryption
• Secure three-way software conference is not supported. A secure call beginning with SRTP will
always fall back to nonsecure Real-Time Transport Protocol (RTP) when it is joined to a conference.
• If a party drops from a three-party conference, the call between the remaining two parties returns to
secure if the two parties are SRTP-capable local Skinny Client Control Protocol (SCCP) endpoints
to a single Cisco Unified CME and the conference creator is one of the remaining parties. If either
of the two remaining parties are only RTP-capable, the call remains nonsecure. If the two remaining
parties are connected through FXS, PSTN, or VoIP, the call remains nonsecure.
• Calls to Cisco Unity Express are not secure.
• Music on Hold (MOH) is not secure.
• Video calls are not secure.
• Modem relay and T.3 fax relay calls are not secure.
• Media flow-around is not supported for call transfer and call forward.
• Conversion between inband tone and RFC 2833 DTMF is not supported. RFC 2833 DTMF handling
is supported when encryption keys are sent to secure DSP farm devices but is not supported for
codec passthrough.
• Secure Cisco Unified CME does not support SIP trunks; only H.323 trunks are supported.
• Secure calls are supported in the default session application only.
Cisco Unified Communications Manager Express System Administrator Guide
428 OL-10663-02
Configuring Security
Information About Security
Information About Security
To enable security, you should understand the following concepts:
Phone Authentication
• Phone Authentication Overview, page 429
• Public Key Infrastructure, page 430
• Phone Authentication Components, page 431
• Phone Authentication Process, page 434
• Startup Messages, page 435
• Configuration File Maintenance, page 435
• CTL File Maintenance, page 435
• CTL Client and Provider, page 436
• Manually Importing MIC Root Certificate, page 436
Media Encryption
• Feature Design of Media Encryption, page 436
• Secure Cisco Unified CME, page 437
• Secure Supplementary Services, page 438
• Secure Transcoding for Remote Phones with DSP Farm Transcoding Configured, page 439
• Secure Cisco Unified CME with Cisco Unity Express, page 440
• Secure Cisco Unified CME with Cisco Unity, page 440
Phone Authentication Overview
Phone authentication is a security infrastructure for providing secure SCCP signaling between
Cisco Unified CME and IP phones. The goal of Cisco Unified CME phone authentication is to create a
secure environment for a Cisco Unified CME IP telephony system.
Phone authentication addresses the following security needs:
• Establishing the identity of each endpoint in the system
• Authenticating devices
• Providing signaling-session privacy
• Providing protection for configuration files
Cisco Unified CME phone authentication implements authentication and encryption to prevent identity
theft of the phone or Cisco Unified CME system, data tampering, call-signaling tampering, or
media-stream tampering. To prevent these threats, the Cisco Unified IP telephony network establishes
and maintains authenticated communication streams, digitally signs files before they are transferred to
phones, and encrypts call signaling between Cisco Unified IP phones.
Cisco Unified CME phone authentication depends upon the following processes:
• Phone Authentication, page 430
• File Authentication, page 430
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 429
Configuring Security
Information About Security
• Signaling Authentication, page 430
Phone Authentication
The phone authentication process occurs between the Cisco Unified CME router and a supported device
when each entity accepts the certificate of the other entity; only then does a secure connection between
the entities occur. Phone authentication relies on the creation of a Certificate Trust List (CTL) file, which
is a list of known, trusted certificates and tokens. Phones communicate with Cisco Unified CME using
a secure transport-layer-session (TLS) connection, which requires that the following criteria be met:
• A certificate must exist on the phone.
• A phone configuration file must exist on the phone, and the Cisco Unified CME entry and certificate
must exist in the file.
File Authentication
The file authentication process validates digitally signed files that a phone downloads from a Trivial File
Transfer Protocol (TFTP) server—for example, configuration files, ring list files, locale files, and CTL
files. When the phone receives these types of files from the TFTP server, the phone validates the file
signatures to verify that file tampering did not occur after the files were created.
Signaling Authentication
The signaling authentication process, also known as signaling integrity, uses the TLS protocol to validate
that signaling packets have not been tampered with during transmission. Signaling authentication relies
on the creation of the CTL file.
Public Key Infrastructure
Cisco Unified CME phone authentication uses the public-key-infrastructure (PKI) capabilities in
Cisco IOS software for certificate-based authentication of IP phones. PKI provides customers with a
scalable, secure mechanism for distributing, managing, and revoking encryption and identity
information in a secured data network. Every entity (a person or a device) participating in the secured
communication is enrolled in the PKI using a process in which the entity generates a
Rivest-Shamir-Adleman (RSA) key pair (one private key and one public key) and has its identity
validated by a trusted entity (also known as a certification authority [CA] or trustpoint).
After each entity enrolls in a PKI, every peer (also known as an end host) in a PKI is granted a digital
certificate that has been issued by a CA.
When peers must negotiate a secured communication session, they exchange digital certificates. Based
on the information in the certificate, a peer can validate the identity of another peer and establish an
encrypted session with the public keys contained in the certificate.
For more information about PKI, see the “Implementing and Managing a PKI Features Roadmap”
section of the Cisco IOS Security Configuration Guide for your Cisco IOS release.
Cisco Unified Communications Manager Express System Administrator Guide
430 OL-10663-02
Configuring Security
Information About Security
Phone Authentication Components
A variety of components work together to ensure secure communications in a Cisco Unified CME
system. Table 28 describes the Cisco Unified CME phone authentication components.
Table 28 Cisco Unified CME Phone Authentication Components
Component Definition
certificate An electronic document that binds a user's or device's name to its
public key. Certificates are commonly used to validate digital
signatures. Certificates are needed for authentication during secure
communication. An entity obtains a certificate by enrolling with the
CA.
signature An assurance from an entity that the transaction it accompanies is
authentic. The entity’s private key is used to sign transactions and the
corresponding public key is used for decryption.
RSA key pair RSA is a public key cryptographic system developed by Ron Rivest,
Adi Shamir, and Leonard Adleman.
An RSA key pair consists of a public key and a private key. The public
key is included in a certificate so that peers can use it to encrypt data
that is sent to the router. The private key is kept on the router and used
both to decrypt the data sent by peers and to digitally sign transactions
when negotiating with peers.
You can configure multiple RSA key pairs to match policy
requirements, such as key length, key lifetime, and type of keys, for
different certificate authorities or for different certificates.
certificate server A certificate server generates and issues certificates on receipt of
legitimate requests. A trustpoint with the same name as the certificate
trustpoint
server stores the certificates. Each trustpoint has one certificate plus
a copy of the CA certificate.
certification authority (CA) The root certificate server. It is responsible for managing certificate
requests and issuing certificates to participating network devices.
This service provides centralized key management for participating
devices and is explicitly trusted by the receiver to validate identities
and to create digital certificates. The CA can be a Cisco IOS CA on
the Cisco Unified CME router, a Cisco IOS CA on another router, or
a third-party CA.
registration authority (RA) Records or verifies some or all of the data required for the CA to issue
certificates. It is required when the CA is a third-party CA or
Cisco IOS CA is not on the Cisco Unified CME router.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 431
Configuring Security
Information About Security
Table 28 Cisco Unified CME Phone Authentication Components (continued)
Component Definition
certificate trust list (CTL) file A mandatory structure that contains the public key information
(server identities) of all the servers with which the IP phone needs to
CTL client
interact (for example, the Cisco Unified CME server, TFTP server,
CTL provider and CAPF server). The CTL file is digitally signed by the system
administrator security token (SAST).
After you configure the CTL client, it creates the CTL file and makes
it available in the TFTP directory. The CTL file is signed using the
SAST certificate’s corresponding private key. An IP phone is then
able to download this CTL file from the TFTP directory. The filename
format for each phone’s CTL file is CTLSEP<mac-addr>.tlv.
When the CTL client is run on a router in the network that is not a
Cisco Unified CME router, you must configure a CTL provider on
each Cisco Unified CME router in the network. Similarly, if a CTL
client is running on one of two Cisco Unified CME routers in a
network, a CTL provider must be configured on the other
Cisco Unified CME router. The CTL protocol transfers information to
and from the CTL provider that allows the second Cisco Unified CME
router to be trusted by phones and vice versa.
certificate revocation list File that contains certificate expiration dates and used to determine
(CRL) whether a certificate that is presented is valid or revoked.
system administrator security Part of the CTL client that is responsible for signing the CTL file. The
token (SAST) Cisco Unified CME certificate and its associated key pair are used for
the SAST function. There are actually two SAST records pertaining
to two different certificates in the CTL file for security reasons. They
are known as SAST1 and SAST2. If one of the certificates is lost or
compromised, then the CTL client regenerates the CTL file using the
other certificate. When a phone downloads the new CTL file, it
verifies with only one of the two original public keys that was
installed earlier. This mechanism is to prevent IP phones from
accepting CTL files from unknown sources.
certificate authority proxy Entity that issues certificates (LSCs) to phones that request them. The
function (CAPF) CAPF is a proxy for the phones, which are unable to directly
communicate with the CA. The CAPF can also perform the following
certificate-management tasks:
• Upgrade existing locally significant certificates on the phones.
• Retrieve phone certificates for viewing and troubleshooting.
• Delete locally significant certificates on the phone.
Cisco Unified Communications Manager Express System Administrator Guide
432 OL-10663-02
Configuring Security
Information About Security
Table 28 Cisco Unified CME Phone Authentication Components (continued)
Component Definition
manufacture-installed Phones need certificates to engage in secure communications. Many
certificate (MIC) phones come from the factory with MICs, but MICs may expire or
become lost or compromised. Some phones do not come with MICs.
locally significant certificate
LSCs are certificates that are issued locally to the phones using the
(LSC)
CAPF server.
transport Layer Security (TLS) IETF standard (RFC 2246) protocol, based on Netscape Secure
protocol Socket Layer (SSL) protocol. TLS sessions are established using a
handshake protocol to provide privacy and data integrity.
The TLS record layer fragments and defragments, compresses and
decompresses, and performs encryption and decryption of application
data and other TLS information, including handshake messages.
Figure 21 shows the components in a Cisco Unified CME phone authentication environment.
Figure 21 Cisco Unified CME Phone Authentication
External CA
server Cisco Unified CME
(optional)
CA CTL provider
Primary
Cisco Unified CME router
CTL
protocol
Cisco IOS CA Cisco IOS RA
CTL file
CTL client
Signed
configuration
Secure Telephony files
CAPF server TFTP store
SCCP server services module
Signaling Certificate
TFTP server
TLS TLS
Note This illustration shows both an external
Port 2443 Port 3804 CA server and a Cisco IOS CA on the
Cisco Unified CME router. In practice,
you would have only one or the other.
146624
IP
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 433
Configuring Security
Information About Security
Phone Authentication Process
The following is a high-level summary of the phone-authentication process.
To enable Cisco Unified CME phone authentication:
1. Certificates are issued.
The CA issues certificates to Cisco Unified CME, SAST, CAPF, and TFTP functions.
2. The CTL file is created, signed and published.
a. The CTL file is created by the CTL client, which is configuration driven. Its goal is to create a
CTLfile.tlv for each phone and deposit it in the TFTP directory. To complete its task, the CTL
client needs the certificates and public key information of the CAPF server, Cisco Unified CME
server, TFTP server, and SASTs.
b. The CTL file is signed by the SAST credentials. There are two SAST records pertaining to two
different certificates in the CTL file for security reasons. If one of the certificates is lost or
compromised, then the CTL client regenerates the CTL file using the other certificate. When a
phone downloads the new CTL file, it verifies the download with only one of the two original
public keys that was installed earlier. This mechanism prevents IP phones from accepting CTL
files from unknown sources.
c. The CTL file is published on the TFTP server. Because an external TFTP server is not supported
in secure mode, the configuration files are generated by the Cisco Unified CME system itself
and are digitally signed by the TFTP server’s credentials. The TFTP server credentials can be
the same as the Cisco Unified CME credentials. If desired, a separate certificate can be
generated for the TFTP function if the appropriate trustpoint is configured under the CTL-client
interface.
3. The telephony service module signs phone configuration files and each phone requests its file.
4. When an IP phone boots up, it requests the CTL file (CTLfile.tlv) from the TFTP server and
downloads its digitally signed configuration file, which has the filename format of
SEP<mac-address>.cnf.xml.sgn.
5. The phone then reads the CAPF configuration status from the configuration file. If a certificate
operation is needed, the phone initiates a TLS session with the CAPF server on TCP port 3804 and
begins the CAPF protocol dialogue. The certificate operation can be an upgrade, delete, or fetch
operation. If an upgrade operation is needed, the CAPF server makes a request on behalf of the
phone for a certificate from the CA. The CAPF server uses the CAPF protocol to obtain the
information it needs from the phone, such as the public key and phone ID. After the phone
successfully receives a certificate from the server, the phone stores it in its flash memory.
6. With the certificate in its flash, the phone initiates a TLS connection with the secure
Cisco Unified CME server on a well-known TCP port (2443), if the device security mode settings
in the .cnf.xml file are set to authenticated or encrypted. This TLS session is mutually authenticated
by both parties. The IP phone knows the Cisco Unified CME server’s certificate from the CTL file,
which it initially downloaded from the TFTP server. The phone’s LSC is a trusted party for the
Cisco Unified CME server, because the issuing CA certificate is present in the router.
Cisco Unified Communications Manager Express System Administrator Guide
434 OL-10663-02
Configuring Security
Information About Security
Startup Messages
If the certificate server is part of your startup configuration, you may see the following messages during
the boot procedure:
% Failed to find Certificate Server's trustpoint at startup
% Failed to find Certificate Server's cert.
These messages are informational messages that show a temporary inability to configure the certificate
server because the startup configuration has not been fully parsed yet. The messages are useful for
debugging, if the startup configuration has been corrupted.
Configuration File Maintenance
In a secure environment, several types of configuration files must be digitally signed before they can be
hosted and used. The filenames of all signed files have a .sgn suffix.
The Cisco Unified CME telephony service module creates phone configuration files (.cnf.xml suffix)
and hosts them on a Cisco IOS TFTP server. These files are signed by the TFTP server’s credentials.
In addition to the phone configuration files, other Cisco Unified CME configuration files such as the
network and user-locale files must be signed. These files are internally generated by
Cisco Unified CME, and the signed versions are automatically created in the current code path whenever
the unsigned versions are updated or created.
Other configuration files that are not generated by Cisco Unified CME, such as ringlist.xml,
distinctiveringlist.xml, audio files, and so forth, are often used for Cisco Unified CME features. Signed
versions of these configuration files are not automatically created. Whenever a new configuration file
that has not been generated by Cisco Unified CME is imported into Cisco Unified CME, use the
load-cfg-file command, which does all of the following:
• Hosts the unsigned version of the file on the TFTP server.
• Creates a signed version of the file.
• Hosts the signed version of the file on the TFTP server.
You can also use the load-cfg-file command instead of the tftp-server command when only the unsigned
version of a file needs to be hosted on the TFTP server.
CTL File Maintenance
The CTL file contains the SAST records and other records. (A maximum of two SAST records may
exist.) The CTL file is digitally signed by one of the SAST credentials that are listed in the CTL file
before the CTL file is downloaded by the phone and saved in its flash. After receiving the CTL file, a
phone trusts a newer or changed CTL file only if it is signed by one of the SAST credentials that is
present in the original CTL file.
For this reason, you should take care to regenerate the CTL file only with one of the original SAST
credentials. If both SAST credentials are compromised and a CTL file must be generated with a new
credential, you must reset the phone to its factory defaults.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 435
Configuring Security
Information About Security
CTL Client and Provider
The CTL client generates the CTL file. The CTL client must be provided with the names of the
trustpoints it needs for the CTL file. It can run on the same router as Cisco Unified CME or on another,
standalone router. When the CTL client runs on a standalone router (not a Cisco Unified CME router),
you must configure a CTL provider on each Cisco Unified CME router. The CTL provider securely
communicates the credentials of the Cisco Unified CME server functions to the CTL client that is
running on another router.
When the CTL client is running on either a primary or secondary Cisco Unified CME router, you must
configure a CTL provider on each Cisco Unified CME router on which the CTL client is not running.
The CTL protocol is used to communicate between the CTL client and a CTL provider. Using the CTL
protocol ensures that the credentials of all Cisco Unified CME routers are present in the CTL file and
that all Cisco Unified CME routers have access to the phone certificates that were issued by the CA.
Both elements are prerequisites to secure communications.
To enable CTL clients and providers, see the “Configuring the CTL Client” section on page 450 and the
“Configuring the CTL Provider” section on page 462.
Manually Importing MIC Root Certificate
When a phone uses a MIC for authentication during the TLS handshake with the CAPF server, the CAPF
server must have a copy of the MIC in order to verify it. Different certificates are used for different types
of IP phones.
A phone uses a MIC for authentication when it has a MIC but no LSC. For example, you have a
Cisco Unified IP Phone 7970 that has a MIC by default but no LSC. When you schedule a certificate
upgrade with the authentication mode set to MIC for this phone, the phone presents its MIC to the
Cisco Unified CME CAPF server for authentication. The CAPF server must have a copy of the MIC's
root certificate to verify the phone's MIC. Without this copy, the CAPF upgrade operation fails.
To ensure that the CAPF server has copies of the MICs it needs, you must manually import certificates
to the CAPF server. The number of certificates that you must import depends on your network
configuration. Manual enrollment refers to copy-and-paste or TFTP transfer methods.
For more information on certificate enrollment, see the “Configuring Cut-and-Paste Certificate
Enrollment”section of the “Configuring Certificate Enrollment for a PKI” chapter in the Cisco IOS
Security Configuration Guide for your Cisco IOS release.
To manually import the MIC root certificate, see the “Manually Importing the MIC Root Certificate”
section on page 469.
Feature Design of Media Encryption
Companion voice security Cisco IOS features provide an overall architecture for secure end-to-end IP
telephony calls on supported network devices that enable the following:
• SRTP-capable Cisco Unified CME networks with secure interoperability
• Secure Cisco IP phone calls
• Secure Cisco VG224 Analog Phone Gateway endpoints
• Secure supplementary services
Cisco Unified Communications Manager Express System Administrator Guide
436 OL-10663-02
Configuring Security
Information About Security
We implement these features using media and signaling authentication and encryption in Cisco IOS
H.323 networks. H.323, the ITU-T standard that describes packet-based video, audio, and data
conferencing, refers to a set of other standards, including H.450, to describe its actual protocols. H.323
allows dissimilar communication devices to communicate with each other by using a standard
communication protocol, and defines a common set of codecs, call setup and negotiating procedures, and
basic data transport methods. H.450, a component of the H.323 standard, defines signaling and
procedures that are used to provide telephony-like supplementary services. We use H.450 messages in
H.323 networks to implement secure supplementary service support, and also empty capability set (ECS)
messaging for media capability negotiation.
Secure Cisco Unified CME
The secure Cisco Unified CME solution includes secure-capable voice ports, SCCP endpoints, and a
secure H.323 trunk between Cisco Unified CME and Cisco Unified Communications Manager for audio
media. SIP trunks are not supported. Figure 22 shows the components of a secure Cisco Unified CME
system.
Figure 22 Secure Cisco Unified CME System
H.323 gateway
VoIP
Cisco VG224 analog V IP
V phone gateway Nonsecure
H.323 secure phone D
DSP farm
Cisco Unified CME 2
U
Cisco Unity
V
Cisco Unified CME 1
Cisco Unity Express Cisco 800 series router
WAN
IP IP
170910
Local phone A Local phone B IP
Remote phone C
Secure Cisco Unified CME implements call control signaling using Transport Layer Security (TLS) or
IPsec (IP Security) for the secure channel, and uses SRTP for media encryption. Secure
Cisco Unified CME manages the SRTP keys to endpoints and to gateways.
The Media Encryption (SRTP) on Cisco Unified CME feature supports the following features:
• Secure voice calls using SRTP for SCCP endpoints
• Secure voice calls in a mixed shared line environment that allows both RTP and SRTP capable
endpoints; shared line media security depends on the endpoint configuration.
• Secure supplementary services using H.450 including:
– Call forward
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 437
Configuring Security
Information About Security
– Call transfer
– Call hold and resume
– Call park and call pickup
– Nonsecure software conference
Note SRTP conference calls over H.323 may experience a 0 to 2 second noise interval when the call is joined
to the conference.
• Secure calls in a nonH.450 environment
• Secure Cisco Unified CME interaction with secure Cisco Unity
• Secure Cisco Unified CME interaction with Cisco Unity Express (interaction is supported and calls
are downgraded to nonsecure mode)
• Secure transcoding for remote phones with DSP farm transcoding configured
These features are discussed in the following sections.
Secure Supplementary Services
The Media Encryption (SRTP) feature supports secure supplementary services in both H.450 and
nonH.450 Cisco Unified CME networks. A secure Cisco Unified CME network should be either H.450
or nonH.450, not a hybrid.
Secure Cisco Unified CME in an H.450 Environment
Signaling and media encryption among secure endpoints is supported, enabling supplementary services
such as call transfer (H.450.2) and call forward (H.450.3) between secure endpoints. Call park and pick
up use H.450 messages. Secure Cisco Unified CME is H.450-enabled by default; however, secure music
on hold (MOH) and secure conferences (three-way calling) are not supported. For example, when
supplementary services are initiated as shown in Figure 23, ECS and Terminal Capabilities Set (TCS)
are used to negotiate the initially secure call between A and B down to RTP so A can hear MOH. When
B resumes the call to A, the call goes back to SRTP. Similarly, when a transfer is initiated, the party being
transferred is put on hold, and the call is negotiated down to RTP. When the call is transferred, it goes
back to SRTP if the other end is SRTP capable.
Figure 23 Music on Hold in an H.450 Environment
1 A calls B 2 B initiates supplementary
(starts as services by putting
secure call) A on hold, then calling C
IP IP IP
231361
Phone A Phone B Phone C
SRST-capable SRST-capable
3 A hears music
on hold
Cisco Unified Communications Manager Express System Administrator Guide
438 OL-10663-02
Configuring Security
Information About Security
Secure Cisco Unified CME in a Non H.450 Environment
Security for supplementary services requires midcall key negotiation or midcall media renegotiation. In
an H.323 network where there are no H.450 messages, media renegotiation is implemented using ECS
for scenarios such as mismatched codecs and secure calls. If you disable H.450 on the router globally,
the configuration is applied to RTP and SRTP calls. The signaling path is hairpin on XOR for
Cisco Unified CME and Cisco Unified Communications Manager. For example, in Figure 24 the
signaling path goes from A through B, the supplementary services initiator, to C. When deploying voice
security in this scenario, consider that the media security keys will pass through XOR, that is, through
B, the endpoint that issued the transfer request. To avoid the man-in-the-middle attack, the XOR must
be a trusted entity.
Figure 24 Transfer in a NonH.45 Environment
2 B initiates supplementary
1 A calls B services by calling
C to transfer the call
IP IP IP
231360
Phone A Phone B Phone C
The media path is optional. The default media path for Cisco Unified CME is hairpin. However,
whenever possible media flow around can be configured on Cisco Unified CME. When configuring
media flow through, which is the default, remember that chaining multiple XOR gateways in the media
path introduces more delay and thus reduces voice quality. Router resources and voice quality limit the
number of XOR gateways that can be chained. The requirement is platform dependent, and may vary
between signaling and media. The practical chaining level is three.
A transcoder is inserted when there is a codec mismatch and ECS and TCS negotiation fails. For
example, if Phone A and Phone B are SRTP capable, but Phone A uses the G.711 codec and Phone B
uses the G.729 codec, a transcoder is inserted if Phone B has one. However, the call is negotiated down
to RTP to fulfill the codec requirement, so the call is not secure.
Secure Transcoding for Remote Phones with DSP Farm Transcoding
Configured
Transcoding is supported for remote phones that have the dspfarm-assist keyword of the codec
command configured. A remote phone is a phone that is registered to a Cisco Unified CME and that is
residing on a remote location across the WAN. To save bandwidth across the WAN connection, calls to
such a phone can be made to use the G.729r8 codec by configuring the codec g729r8 dspfarm assist
command for the ephone. The g729r8 keyword forces calls to such a phone to use the G.729 codec. The
dspfarm-assist keyword enables using available DSP resources, if an H.323 call to the phone needs to
be transcoded.
Note Transcoding is enabled only if an H.323 call with a different codec from the remote phone tries to make
a call to the remote phone. If a local phone on the same Cisco Unified CME as the remote phone makes
a call to remote phone, the local phone is forced to change its codec to G.729 instead of using
transcoding.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 439
Configuring Security
Information About Security
Secure transcoding for point-to-point SRTP calls can only occur when both the SCCP phone which is to
be serviced by Cisco Unified CME transcoding and its peer in the call are SRTP-capable and have
successfully negotiated the SRTP keys. Secure transcoding for point-to-point SRTP calls cannot occur
when only one of the peers in the call is SRTP-capable.
If Cisco Unified CME transcoding is to be performed on a secure call, the Media Encryption (SRTP) on
Cisco Unified CME feature allows Cisco Unified CME to provide the DSP farm with the encryption
keys for the secure call as additional parameters, so that Cisco Unified CME transcoding can be
performed successfully. Without the encryption keys, the DSP farm would not be able to read the
encrypted voice data in order to transcode it.
Note The secure transcoding described here does not apply to IP-IP gateway transcoding.
Cisco Unified CME transcoding is different from IP-to-IP gateway transcoding because it is invoked for
an SCCP endpoint only, instead of for bridging VoIP call legs. Cisco Unified CME transcoding and
IP-to-IP gateway transcoding are mutually exclusive, that is, only one type of transcoding can be invoked
for a call. If no DSP farm capable of SRTP transcoding is available, Cisco Unified CME secure
transcoding is not performed and the call goes through using G.711.
For configuration information, see the HERE Registering the DSP Farm with Cisco Unified CME 4.2 or
a Later Version in Secure Mode section of the Configuring Transcoding Support module.
Secure Cisco Unified CME with Cisco Unity Express
Cisco Unity Express does not support secure signaling and media encryption. Secure
Cisco Unified CME interoperates with Cisco Unity Express, but calls between Cisco Unified CME and
Cisco Unity Express are not secure.
In a typical Cisco Unity Express deployment with Cisco Unified CME in a secure H.323 network,
Session Initiation Protocol (SIP) is used for signaling, and the media path is G.711 with RTP. For Call
Forward No Answer (CFNA) and Call Forward All (CFA), before the media path is established,
signaling messages are sent to negotiate an RTP media path. If codec negotiation fails, a transcoder is
inserted. The Media Encryption (SRTP) on Cisco Unified CME feature’s H.323 service provider
interface (SPI) supports fast start calls. In general, calls transferred or forwarded back to
Cisco Unified CME from Cisco Unity Express fall into existing call flows and are treated as regular SIP
and RTP calls.
The Media Encryption (SRTP) on Cisco Unified CME feature supports blind transfer back to
Cisco Unified CME only. When midcall media renegotiation is configured, the secure capability for the
endpoint is renegotiated regardless of which transfer mechanism, H.450.2 or Empty Capability Set
(ECS), was used.
Secure Cisco Unified CME with Cisco Unity
The Media Encryption (SRTP) on Cisco Unified CME feature supports Cisco Unity 4.2 or a later version
and Cisco Unity Connection 1.1 or a later version using SCCP. Secure Cisco Unity for
Cisco Unified CME acts like a secure SCCP phone. Some provisioning is required before secure
signaling can be established. Cisco Unity receives Cisco Unified CME device certificates from the
Certificate Trust List (CTL) and Cisco Unity certificates are inserted into Cisco Unified CME manually.
Cisco Unity with SIP is not supported.
Cisco Unified Communications Manager Express System Administrator Guide
440 OL-10663-02
Configuring Security
How to Configure Security
The certificate for the Cisco Unity Connection is in the Cisco Unity administration web application
under the “port group settings.”
How to Configure Security
This section contains the following tasks:
Phone Authentication
• Configuring the Cisco IOS Certification Authority, page 441 (required)
• Obtaining Certificates for Server Functions, page 445 (required)
• Configuring Telephony-Service Security Parameters, page 448 (required)
• Configuring the CTL Client, page 450 (required)
• Configuring the CAPF Server, page 455 (required)
• Configuring Ephone Security Parameters, page 459 (required)
• Configuring the CTL Provider, page 462 (optional)
• Configuring the Registration Authority, page 465 (optional)
• Entering the Authentication String on the Phone, page 468 (optional)
• Manually Importing the MIC Root Certificate, page 469 (optional)
Media Encryption
• Configuring Media Encryption (SRTP) in Cisco Unified CME, page 472 (required)
• Configuring Cisco Unified CME SRTP Fallback for H.323 Dial Peers, page 474 (optional)
• Configuring Cisco Unity for Secure Cisco Unified CME Operation, page 476 (optional)
Configuring the Cisco IOS Certification Authority
To configure a Cisco IOS Certification Authority (CA) on a local or external router, perform the
following steps.
Tip For more information, see “Configuring and Managing a Cisco IOS Certificate Server for PKI
Deployment” in the “Implementing and Managing a PKI Features Roadmap” section of the
Cisco IOS Security Configuration Guide.
Note If you use a third-party CA, follow the provider’s instructions instead of performing these steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. ip http server
4. crypto pki server label
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 441
Configuring Security
How to Configure Security
5. database level {minimal | names | complete}
6. database url root-url
7. lifetime certificate time
8. issuer-name CN=label
9. exit
10. crypto pki trustpoint label
11. enrollment url ca-url
12. exit
13. crypto pki server label
14. grant auto
15. no shutdown
16. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ip http server Enables the Cisco web-browser user interface on the local
Cisco Unified CME router.
Example:
Router(config)# ip http server
Step 4 crypto pki server label Defines a label for the Cisco IOS CA and enters
certificate-server configuration mode.
Example:
Router(config)# crypto pki server sanjose1
Step 5 database level {minimal | names | complete} (Optional) Controls the type of data stored in the certificate
enrollment database.
Example: • minimal—Enough information is stored only to
Router(config-cs-server)# database level continue issuing new certificates without conflict. This
complete is the default value.
• names—In addition to the minimal information given,
the serial number and subject name of each certificate.
• complete—In addition to the information given in the
minimal and names levels, each issued certificate is
written to the database. If you use this keyword, you
must also specify an external TFTP server in which to
store the data by using the database url command.
Cisco Unified Communications Manager Express System Administrator Guide
442 OL-10663-02
Configuring Security
How to Configure Security
Command or Action Purpose
Step 6 database url root-url (Optional) Specifies the location, other than NVRAM,
where all database entries for the certificate server are to be
written out.
Example:
Router(config-cs-server)# database url nvram: • Required if you configured the complete keyword with
the database level command in the previous step.
• root-url—URL that is supported by the Cisco IOS file
system and where database entries are to be written out.
If the CA is going to issue a large number of
certificates, select an appropriate storage location like
flash or other storage device to store the certificates.
• When the storage location chosen is flash and the file
system type on this device is Class B (LEFS), make
sure to check free space on the device periodically and
use the squeeze command to free the space used up by
deleted files. This process may take several minutes and
should be done during scheduled maintenance periods
or off-peak hours.
Step 7 lifetime certificate time (Optional) Specifies the lifetime, in days, of certificates
issued by this Cisco IOS CA.
Example: • time—Number of days until a certificate expires. Range
Router(config-cs-server) lifetime certificate is 1 to 1825 days. Default is 365. The maximum
888 certificate lifetime is 1 month less than the lifetime of
the CA certificate.
• Configure this command before the Cisco IOS CA is
enabled by using the no shutdown command.
Step 8 issuer-name CN=name (Optional) Specifies a distinguished name (DN) as issuer
name for the Cisco IOS CA.
Example: • Default is already-configured label for the Cisco IOS
Router(config-cs-server)# issuer-name CA. See Step 4.
CN=sanjose1
Step 9 exit Exits certificate-server configuration mode.
Example:
Router(config-cs-server)# exit
Step 10 crypto pki trustpoint label (Optional) Declares a trustpoint and enters ca-trustpoint
configuration mode.
Example: • For local CA only. This command is not required for
Router(config)# crypto pki trustpoint sanjose1 Cisco IOS CA on an external router.
• If you must use a specific RSA key for the
Cisco IOS CA, use this command to create your own
trustpoint by using the same label to be used with the
crypto pki server command. If the router sees a
configured trustpoint with the same label as the crypto
pki server, it uses this trustpoint and does not
automatically create a trustpoint.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 443
Configuring Security
How to Configure Security
Command or Action Purpose
Step 11 enrollment url ca-url Specifies the enrollment URL of the issuing Cisco IOS CA.
• For local Cisco IOS CA only. This command is not
Example: required for Cisco IOS CA on an external router.
Router(config-ca-trustpoint)# enrollment url
http://ca-server.company.com
• ca-url—URL of the router on which the Cisco IOS CA
is installed.
Step 12 exit Exits ca-trustpoint configuration mode.
Example:
Router(config-ca-trustpoint)# exit
Step 13 crypto pki server label Enters certificate-server configuration mode.
• label—Name of the Cisco IOS CA being configured.
Example:
Router(config)# crypto pki server sanjose1
Step 14 grant auto (Optional) Allows certificates to be issued automatically to
any requester.
Example: • Default and recommended method is manual
Router(config-cs-server)# grant auto enrollment.
• Use this command only when testing and building
simple networks. Use the no grant auto command after
configuration is complete to prevent certificates from
being automatically granted.
Step 15 no shutdown (Optional) Enables the Cisco IOS CA.
• Use this command only after you are finished
Example: configuring the Cisco IOS CA.
Router(config-cs-server)# no shutdown
Step 16 end Returns to privileged EXEC mode.
Example:
Router(config-cs-server)# end
Examples
The following partial output form the show running-config command shows the configuration for a
Cisco IOS CA named “sanjose1” running on the local Cisco Unified CME router:
ip http server
crypto pki server sanjose1
database level complete
database url nvram:
crypto pki trustpoint sanjose1
enrollment url http://ca-server.company.com
crypto pki server authority1
no grant auto
no shutdown
Cisco Unified Communications Manager Express System Administrator Guide
444 OL-10663-02
Configuring Security
How to Configure Security
Obtaining Certificates for Server Functions
The CA issues certificates for the following server functions:
• Cisco Unified CME—Requires a certificate for TLS sessions with phones.
• TFTP—Requires a key pair and certificate for signing configuration files.
• CAPF—Requires a certificate for TLS sessions with phones.
• SAST—Required for signing the CTL file. We recommend creating two SAST certificates, one for
primary use and one for backup.
To obtain a certificate for a server function, perform the following steps for each server function.
Note You can configure a different trustpoint for each server function (see the “Examples” section on
page 447) or you can configure the same trustpoint for more than one server function as shown in the
“Configuration Examples for Security” section on page 479 at the end of this module.
SUMMARY STEPS
1. enable
2. configure terminal
3. crypto pki trustpoint trustpoint-label
4. enrollment url url
5. revocation-check method1 [method2 [method3]]
6. rsakeypair key-label [key-size [encryption-key-size]]
7. exit
8. crypto pki authenticate trustpoint-label
9. crypto pki enroll trustpoint-label
10. exit
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 crypto pki trustpoint trustpoint-label Declares the trustpoint that the CA should use and enters
ca-trustpoint configuration mode.
Example: • trustpoint-label—Label for server function being
Router(config)# crypto pki trustpoint capf configured.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 445
Configuring Security
How to Configure Security
Command or Action Purpose
Step 4 enrollment url url Specifies the enrollment URL of the issuing CA.
• url—URL of the router on which the issuing CA is
Example: installed.
Router(config-ca-trustpoint)# enrollment url
http://ca-server.company.com
Step 5 revocation-check method1 [method2 [method3]] (Optional) Specifies method to be used to check the
revocation status of a certificate.
Example: • method—If a second and third method are specified,
Router(config-ca-trustpoint)# revocation-check each subsequent method is used only if the previous
none method returns an error, such as a server being down.
– crl—Certificate checking is performed by a
certificate revocation list (CRL). This is the default
behavior.
– none—Certificate checking is not required.
– ocsp—Certificate checking is performed by an
Online Certificate Status Protocol (OCSP) server.
Step 6 rsakeypair key-label [key-size (Optional) Specifies a key pair to use with a certificate.
[encryption-key-size]]
• key-label—Name of the key pair, which is generated
during enrollment if it does not already exist or if the
Example: auto-enroll regenerate command is configured.
Router(config-ca-trustpoint)# rsakeypair capf
1024 1024 • key-size— Size of the desired RSA key. If not specified,
the existing key size is used.
• encryption-key-size—Size of the second key, which is
used to request separate encryption, signature keys, and
certificates.
• Multiple trustpoints can share the same key.
Step 7 exit Exits ca-trustpoint configuration mode.
Example:
Router(config-ca-trustpoint)# exit
Step 8 crypto pki authenticate trustpoint-label Retrieves the CA certificate and authenticates it and checks
the certificate fingerprint if prompted.
Example: • This command is optional if the CA certificate is
Router(config)# crypto pki authenticate capf already loaded into the configuration
• trustpoint-label—Already-configured label for server
function being configured.
Cisco Unified Communications Manager Express System Administrator Guide
446 OL-10663-02
Configuring Security
How to Configure Security
Command or Action Purpose
Step 9 crypto pki enroll trustpoint-label Enrolls with the CA and obtains the certificate for this
trustpoint.
Example: • trustpoint-label—Already-configured label for server
Router(config)# crypto pki enroll capf function being configured.
Step 10 exit Returns to privileged EXEC mode.
Example:
Router(config)# exit
Examples
The partial output from the show running-config shows how to obtain certificates for a variety of server
functions.
Obtaining a certificate for the CAPF server function
!configuring a trust point
crypto pki trustpoint capf-server
enrollment url http://192.168.1.1:80
revocation-check none
!authenticate w/ the CA and download its certificate
crypto pki authenticate capf-server
! enroll with the CA and obtain this trustpoint's certificate
crypto pki enroll capf-server
Obtaining a certificate for the Cisco Unified CME server function:
crypto pki trustpoint cme-server
enrollment url http://192.168.1.1:80
revocation-check none
crypto pki authenticate cme-server
crypto pki enroll cme-server
Obtaining a certificate for the TFTP server function:
crypto pki trustpoint tftp-server
enrollment url http://192.168.1.1:80
revocation-check none
crypto pki authenticate tftp-server
crypto pki enroll tftp-server
Obtaining a certificate for the first SAST server function (sast1):
crypto pki trustpoint sast1
enrollment url http://192.168.1.1:80
revocation-check none
crypto pki authenticate sast1
crypto pki enroll sast1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 447
Configuring Security
How to Configure Security
Obtaining a certificate for the second SAST server function (sast2):
crypto pki trustpoint sast2
enrollment url http://192.168.1.1:80
revocation-check none
crypto pki authenticate sast2
crypto pki enroll sast2
Configuring Telephony-Service Security Parameters
To configure security parameters for telephony service, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. secure-signaling trustpoint label
5. tftp-server-credentials trustpoint label
6. device-security-mode {authenticated | none | encrypted}
7. cnf-file perphone
8. load-cfg-file file-url alias file-alias [sign] [create]
9. server-security-mode {erase | non-secure | secure}
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 secure-signaling trustpoint label Configures trustpoint to be used for secure signalling.
• label—Name of a configured PKI trustpoint with a
Example: valid certificate to be used for TLS handshakes with IP
Router(config-telephony)# secure-signaling phones on TCP port 2443.
trustpoint cme-sccp
Cisco Unified Communications Manager Express System Administrator Guide
448 OL-10663-02
Configuring Security
How to Configure Security
Command or Action Purpose
Step 5 tftp-server-credentials trustpoint label Configures the TFTP server credentials (trustpoint) to be
used for signing the configuration files.
Example: • label—Name of a configured PKI trustpoint with a
Router(config-telephony)# valid certificate to be used to sign the phone
tftp-server-credentials trustpoint cme-tftp configuration files. This can be the CAPF trustpoint
that was used in the previous step or any trustpoint with
a valid certificate
Step 6 device-security-mode {authenticated | none | Enables security mode for endpoints.
encrypted}
• authenticated—Instructs device to establish a TLS
connection with no encryption. There is no Secure
Example: Real-Time Transport Protocol (SRTP) in the media
Router(config-telephony)# device-security-mode path.
authenticated
• none—SCCP signaling is not secure. This is the
default.
• encrypted—Instructs device to establish an encrypted
TLS connection to secure media path using SRTP.
• This command can also be configured in ephone
configuration mode. The value set in ephone
configuration mode has priority over the value set in
telephony-service configuration mode.
Step 7 cnf-file perphone Specifies that system generate a separate configuration
XML file for each IP phone.
Example: • Separate configuration files for each endpoint are
Router(config-telephony)# cnf-file perphone required for security.
Step 8 load-cfg-file file-url alias file-alias [sign] (Optional) Signs configuration files that are not created by
[create] Cisco Unified CME. Also loads the signed and unsigned
versions of a file on the TFTP server.
Example: • file-url—Complete path of a configuration file in a
Router(config-telephony)# load-cfg-file local directory.
slot0:Ringlist.xml alias Ringlist.xml sign
create • alias file-alias—Alias name of the file to be served on
the TFTP server.
• sign—(Optional) The file needs to be digitally signed
and served on the TFTP server.
• create—(Optional) Creates the signed file in the local
directory.
• The first time that you use this command for each file,
use the create keyword in addition to the sign keyword.
The create keyword is not maintained in the running
configuration to prevent signed files from being
recreated during every reload.
• To serve an already-signed file on the TFTP server, use
this command without the sign and create keywords.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 449
Configuring Security
How to Configure Security
Command or Action Purpose
Step 9 server-security-mode {erase | non-secure | (Optional) Changes the security mode of the server.
secure}
• erase—Deletes the CTL file.
• non-secure—Nonsecure mode.
Example:
Router(config-telephony)# server-security-mode • secure—Secure mode.
non-secure
• This command has no impact until the CTL file is
initially generated by the CTL client. When the CTL
file is generated, the CTL client automatically sets
server security mode to secure.
Step 10 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Verifying Telephony-Service Security Parameters
Step 1 show telephony-service security-info
Use this command to display the security-related information that is configured in telephony-service
configuration mode.
Router# show telephony-service security-info
Skinny Server Trustpoint for TLS: cme-sccp
TFTP Credentials Trustpoint: cme-tftp
Server Security Mode: Secure
Global Device Security Mode: Authenticated
Step 2 show running-config
Use this command to display the running configuration to verify telephony and per-phone security
configuration.
Router# show running-config
telephony-service
secure-signaling trustpoint cme-sccp
server-security-mode secure
device-security-mode authenticated
tftp-server-credentials trustpoint cme-tftp
.
.
.
Configuring the CTL Client
Perform one of the following tasks, depending upon your network configuration:
• Configuring the CTL Client on a Cisco Unified CME Router, page 451
• Configuring the CTL Client on a Router That is Not a Cisco Unified CME Router, page 453
Cisco Unified Communications Manager Express System Administrator Guide
450 OL-10663-02
Configuring Security
How to Configure Security
Configuring the CTL Client on a Cisco Unified CME Router
To configure a CTL client on a local Cisco Unified CME router for creating a list of known, trusted
certificates and tokens, perform the following steps.
Note If you have primary and secondary Cisco Unified CME routers, you can configure the CTL client on
either one of them.
SUMMARY STEPS
1. enable
2. configure terminal
3. ctl-client
4. sast1 trustpoint trustpoint-label
5. sast2 trustpoint trustpoint-label
6. server {capf | cme | cme-tftp | tftp} ip-address trustpoint trustpoint-label
7. server cme ip-address username string password 0 string
8. regenerate
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ctl-client Enters CTL-client configuration mode.
Example:
Router(config)# ctl-client
Step 4 sast1 trustpoint label Configures credentials for the primary SAST.
• label—Name of SAST1 trustpoint.
Example: Note SAST1 and SAST2 certificates must be different
Router(config-ctl-client)# sast1 trustpoint
sast1tp
from each other. The CTL file is always signed by
SAST1. The SAST2 credentials are included in the
CTL file so that if the SAST1 certificate is
compromised, the file can be signed by SAST2 to
prevent phones from being reset to the factory
default.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 451
Configuring Security
How to Configure Security
Command or Action Purpose
Step 5 sast2 trustpoint label Configures credentials for the secondary SAST.
• label—name of SAST2 trustpoint.
Example: Note SAST1 and SAST2 certificates must be different
Router(config-ctl-client)# sast2 trustpoint
from each other. The CTL file is always signed by
SAST1. The SAST2 credentials are included in the
CTL file so that if the SAST1 certificate is
compromised, the file can be signed by SAST2 to
prevent phones from being reset to the factory
default.
Step 6 server {capf | cme | cme-tftp | tftp} Configures a trustpoint for each server function that is
ip-address trustpoint trustpoint-label running locally on the Cisco Unified CME router.
• ip-address—IP address of the Cisco Unified CME
Example: router. If there are multiple network interfaces, use the
Router(config-ctl-client)# server capf 10.2.2.2 interface address in the local LAN to which the phones
trustpoint capftp
are connected.
• trustpoint trustpoint-label—Name of the PKI
trustpoint for the server function being configured.
• Repeat this command for server each function that is
running locally on the Cisco Unified CME router.
Step 7 server cme ip-address username name-string (Optional) Provides information for another
password {0 | 1} password-string Cisco Unified CME router (primary or secondary) in the
network.
Example: • ip-address—IP address of the another
Router(config-ctl-client)# server cme 10.2.2.2 Cisco Unified CME router.
username user3 password 0 38h2KL
• username name-string—Username that is configured
on the CTL provider.
• password—Defines the way that you want the
password to appear in show command output and not to
the way that you enter the password.
– 0—Not encrypted.
– 1—Encrypted using Message Digest 5 (MD5).
• password-string—Administrative password of the CTL
provider running on the remote Cisco Unified CME
router.
Step 8 regenerate Creates a new CTLFile.tlv after you make changes to the
CTL client configuration.
Example:
Router(config-ctl-client)# regenerate
Step 9 end Returns to privileged EXEC mode.
Example:
Router(config-ctl-client)# end
Cisco Unified Communications Manager Express System Administrator Guide
452 OL-10663-02
Configuring Security
How to Configure Security
Examples
The following sample output from the show ctl-client command displays the trustpoints in the system.
Router# show ctl-client
CTL Client Information
-----------------------------
SAST 1 Certificate Trustpoint: cmeserver
SAST 1 Certificate Trustpoint: sast2
List of Trusted Servers in the CTL
CME 10.1.1.1 cmeserver
TFTP 10.1.1.1 cmeserver
CAPF 10.1.1.1 cmeserver
What to do Next
You are finished configuring the CTL client, see the “Configuring the CAPF Server” section on
page 455.
Configuring the CTL Client on a Router That is Not a Cisco Unified CME Router
To configure a CTL client on a stand-alone router that is not a Cisco Unified CME router, perform the
following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. ctl-client
4. sast1 trustpoint trustpoint-label
5. sast2 trustpoint trustpoint-label
6. server cme ip-address username name-string password {0 | 1} password-string
7. regenerate
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 453
Configuring Security
How to Configure Security
Command or Action Purpose
Step 3 ctl-client Enters ctl-client configuration mode.
Example:
Router(config)# ctl-client
Step 4 sast1 trustpoint label Configures credentials for the primary SAST.
• label—Name of SAST1 trustpoint.
Example: Note SAST1 and SAST2 certificates must be different
Router(config-ctl-client)# sast1 trustpoint
sast1tp
from each other, but either of them may use the
same certificate as the Cisco Unified CME router to
conserve memory. The CTL file is always signed by
SAST1. The SAST2 credentials are included in the
CTL file, so that if the SAST1 certificate is
compromised, the file can be signed by SAST2 to
prevent phones from being reset to the factory
default.
Step 5 sast2 trustpoint label Configures credentials for the secondary SAST.
• label—name of SAST2 trustpoint.
Example: Note SAST1 and SAST2 certificates must be different
Router(config-ctl-client)# sast2 trustpoint
from each other, but either of them may use the
same certificate as the Cisco Unified CME router to
conserve memory. The CTL file is always signed by
SAST1. The SAST2 credentials are included in the
CTL file, so that if the SAST1 certificate is
compromised, the file can be signed by SAST2 to
prevent phones from being reset to the factory
default.
Step 6 server cme ip-address username name-string (Optional) Provides information about another
password {0 | 1} password-string Cisco Unified CME router (primary or secondary) in the
network, if one exists.
Example: • ip-address—IP address of the other
Router(config-ctl-client)# server cme 10.2.2.2 Cisco Unified CME router.
username user3 password 0 38h2KL
• username name-string—Username that is configured
on the CTL provider.
• password—Encryption status of the password string.
– 0—Not encrypted.
– 1—Encrypted using Message Digest 5 (MD5).
Note This option refers to the way that you want the
password to appear in show command output and
not to the way that you enter the password in this
command.
• password-string—Administrative password of the CTL
provider running on the remote Cisco Unified CME
router.
Cisco Unified Communications Manager Express System Administrator Guide
454 OL-10663-02
Configuring Security
How to Configure Security
Command or Action Purpose
Step 7 regenerate Creates a new CTLFile.tlv after you make changes to the
CTL client configuration.
Example:
Router(config-ctl-client)# regenerate
Step 8 end Returns to privileged EXEC mode.
Example:
Router(config-ctl-client)# end
Examples
The following sample output from the show ctl-client command displays the trustpoints in the system.
Router# show ctl-client
CTL Client Information
-----------------------------
SAST 1 Certificate Trustpoint: cmeserver
SAST 1 Certificate Trustpoint: sast2
List of Trusted Servers in the CTL
CME 10.1.1.1 cmeserver
TFTP 10.1.1.1 cmeserver
CAPF 10.1.1.1 cmeserver
Configuring the CAPF Server
A certificate must be obtained for the CAPF server so that it can establish a TLS session with the phone
during certificate operation. The CAPF server can install, fetch, or delete locally significant certificates
(LSCs) on security-enabled phones. To enable the CAPF server on the Cisco Unified CME router,
perform the following steps.
Tip When you use the CAPF server to install phone certificates, arrange to do so during a scheduled period
of maintenance. Generating many certificates at the same time may cause call-processing interruptions.
SUMMARY STEPS
1. enable
2. configure terminal
3. capf-server
4. trustpoint-label label
5. cert-enroll-trustpoint label password {0 | 1} password-string
6. source-addr ip-address
7. auth-mode {auth-string | LSC | MIC | none | null-string}
8. auth-string {delete | generate} {all | ephone-tag} [auth-string]
9. phone-key-size {512 | 1024 | 2048}
10. port tcp-port
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 455
Configuring Security
How to Configure Security
11. keygen-retry number
12. keygen-timeout minutes
13. cert-oper {delete all | fetch all | upgrade all}
14. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 capf-server Enters capf-server configuration mode.
Example:
Router(config)# capf-server
Step 4 trustpoint-label label Specifies the label for the trustpoint.
• label—Name of trustpoint whose certificate is to be
Example: used for TLS connection between the CAPF server and
Router(config-capf-server)# trustpoint-label the phone.
tp1
Step 5 cert-enroll-trustpoint trustpoint-label Enrolls the CAPF with the CA (or RA if the CA is not local
password {0 | 1} password-string to the Cisco Unified CME router).
• trustpoint-label—PKI trustpoint label for CA and RA
Example: that was previously configured by using the crypto pki
Router(config-capf-server)# trustpoint command in global configuration mode.
cert-enroll-trustpoint ra1 password 0 x8oWiet
• password—Encryption status of the password string.
• password-string—Password to use for certificate
enrollment. This password is the revocation password
that is sent along with the certificate request to the CA.
Step 6 source-addr ip-address Defines the IP address of the CAPF server on the
Cisco Unified CME router.
Example:
Router(config-capf-server)# source addr
10.10.10.1
Cisco Unified Communications Manager Express System Administrator Guide
456 OL-10663-02
Configuring Security
How to Configure Security
Command or Action Purpose
Step 7 auth-mode {auth-string | LSC | MIC | none | Specifies the type of authentication mode for CAPF
null-string} sessions to verify endpoints that request certificates.
• auth-string—The phone user enters a special
Example: authentication string at the phone. The string is
Router(config-capf-server)# auth-mode provided to the user by the system administrator and is
auth-string
configured using the auth-string generate command.
• LSC—The phone provides its LSC for authentication,
if one exists.
• MIC—The phone provides its MIC for authentication,
if one exists. If this option is chosen, the MIC’s issuer
certificate must be imported into a PKI trustpoint.
• none—No certificate upgrade is initiated. This is the
default.
• null-string—No authentication.
Step 8 auth-string {delete | generate} {all | (Optional) Creates or removes authentication strings for one
ephone-tag} [digit-string] or all secure phones.
• Use this command if the auth-string keyword is
Example: specified in the previous step. Strings become part of
Router(config-capf-server)# auth-string the ephone configuration.
generate all
• delete—Remove authentication strings for the
specified secure devices.
• generate—Create authentication strings for the
specified secure devices.
• all—All phones.
• ephone-tag—Identifier for the ephone to receive the
authentication string.
• digit-string—Digits that phone user must dial for
CAPF authentication. Length of string is 4 to 10 digits
that can be pressed on the keypad. If this value is not
specified, a random string is generated for each phone.
• You can also define an authentication string for an
individual SCCP IP phone by using the capf-auth-str
command in ephone configuration mode.
Step 9 phone-key-size {512 | 1024 | 2048} (Optional) Specifies the size of the RSA key pair that is
generated on the phone for the phone’s certificate, in bits.
Example: • 512—512.
Router(config-capf-server)# phone-key-size 2048
• 1024—1024. This is the default.
• 2048—2048.
Step 10 port tcp-port (Optional) Defines the TCP port number on which the
CAPF server listens for socket connections from the
phones.
Example:
Router(config-capf-server)# port 3804 • tcp-port—TCP port number. Range is 2000 to 9999.
Default is 3804.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 457
Configuring Security
How to Configure Security
Command or Action Purpose
Step 11 keygen-retry number (Optional) Specifies the number of times that the server
sends a key generation request.
Example: • number—Number of retries. Range is 0 to 100. Default
Router(config-capf-server)# keygen-retry 5 is 3.
Step 12 keygen-timeout minutes (Optional) Specifies the amount of time that the server waits
for a key generation response from the phone.
Example: • minutes—Number of minutes before the generation
Router(config-capf-server)# keygen-timeout 45 process times out. Range is 1 to 120. Default is 30.
Step 13 cert-oper {delete all | fetch all | upgrade (Optional) Initiates the indicated certificate operation on all
all} configured endpoints in the system.
• delete all—Remove all phone certificates.
Example:
Router(config-capf-server)# cert-oper upgrade
• fetch all—Retrieve all phone certificates for
all troubleshooting.
• upgrade all—Upgrade all phone certificates.
• This command can also be configured in ephone
configuration mode to initiate certificate operations on
individual phones. This command in ephone
configuration mode has priority over this command in
CAPF-server configuration mode.
Step 14 end Returns to privileged EXEC mode.
Example:
Router(config-capf-server)# end
Verifying the CAPF Server
show capf-server summary
Use this command to display CAPF-server configuration information.
Router# show capf-server summary
CAPF Server Configuration Details
Trustpoint for TLS With Phone: tp1
Trustpoint for CA operation: ra1
Source Address: 10.10.10.1
Listening Port: 3804
Phone Key Size: 1024
Phone KeyGen Retries: 3
Phone KeyGen Timeout: 30 minutes
Cisco Unified Communications Manager Express System Administrator Guide
458 OL-10663-02
Configuring Security
How to Configure Security
Configuring Ephone Security Parameters
To configure security parameters for individual phones, perform the following steps for each phone.
Prerequisites
• Phones to be configured for security must be configured for basic calling in Cisco Unified CME. For
configuration information, see “Configuring Phones to Make Basic Calls” on page 139.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. device-security-mode {authenticated | none | encrypted}
5. codec {g711ulaw | g722r64 | g729r8 [dspfarm-assist]}
6. capf-auth-str digit-string
7. cert-oper {delete | fetch | upgrade} auth-mode {auth-string | LSC | MIC | null-string}
8. reset
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique identifier of phone to be
Example: configured.
Router(config)# ephone 24
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 459
Configuring Security
How to Configure Security
Command or Action Purpose
Step 4 device-security-mode {authenticated | none | (Optional) Enables security mode for an individual SCCP
encrypted} IP phone.
• authenticated—Instructs device to establish a TLS
Example: connection with no encryption. There is no Secure
Router(config-ephone)# device-security-mode Real-Time Transport Protocol (SRTP) in the media
authenticated
path.
• none—SCCP signaling is not secure. This is the
default.
• encrypted—Instructs device to establish an encrypted
TLS connection to secure media path using SRTP.
• This command can also be configured in
telephony-service configuration mode. The value set in
ephone configuration mode has priority over the value
set in telephony-service configuration mode.
Step 5 codec {g711ulaw | g722r64 | g729r8 (Optional) Sets the security mode for SCCP signaling for a
[dspfarm-assist]} phone communicating with the Cisco Unified CME router.
• dspfarm-assist—Required for secure transcoding with
Example: Cisco Unified CME. Causes the system to attempt to
Router(config-ephone)# codec g711ulaw use DSP-farm resources for transcoding the segment
dspfarm-assist
between the phone and the Cisco Unified CME router if
G.711 is negotiated for the call. This keyword is
ignored if the SCCP endpoint type is ATA, VG224, or
VG248.
Step 6 capf-auth-str digit-string (Optional) Defines a string to use as a personal
identification number (PIN) for CAPF authentication.
Example: Note For instructions on how to enter the string on a
Router(config-ephone)# capf-auth-str 2734 phone, see the “Entering the Authentication String
on the Phone” section on page 468.
• digit-string—Digits that the phone user must dial for
CAPF authentication. The length of string is 4 to 10
digits.
• This command can also be configured in
telephony-service configuration mode. The value set in
ephone configuration mode has priority over the value
set in telephony-service configuration mode.
• You can also define a PIN for CAPF authentication by
using the auth-string command in CAPF-server
configuration mode.
Cisco Unified Communications Manager Express System Administrator Guide
460 OL-10663-02
Configuring Security
How to Configure Security
Command or Action Purpose
Step 7 cert-oper {delete | fetch | upgrade} auth-mode (Optional) Initiates the indicated certificate operation on the
{auth-string | LSC | MIC | null-string} ephone being configured.
• delete—Removes the phone certificate.
Example:
Router(config-ephone)# cert-oper upgrade
• fetch—Retrieves the phone certificate for
auth-mode auth-string troubleshooting.
• upgrade—Upgrades the phone certificate.
• auth-mode—Type of authentication to use during
CAPF sessions to verify endpoints that request
certificates.
• auth-string—Authentication string to be entered on
the phone by the phone user. Use the capf-auth-str
command to configure the auth-string. For
configuration information, see the “Entering the
Authentication String on the Phone” section on
page 468.
• LSC—Phone provides its phone certificate for
authentication. Precedence is given to an LSC if one
exists.
• MIC—Phone provides its phone certificate for
authentication. Precedence is given to an MIC if one
exists. MIC’s issuer certificate must be imported into a
PKI trustpoint. For information, see the “Manually
Importing the MIC Root Certificate” section on
page 469.
• null-string—No authentication.
• This command can also be configured in CAPF-server
configuration mode to initiate certificate operations at
a global level. This command in ephone configuration
mode has priority over this command in CAPF-server
configuration mode.
• You can also use the auth-mode command in
CAPF-server configuration mode to configure
authentication at a global level.
Step 8 reset Performs a complete reboot of the phone.
Example:
Router(config-ephone)# reset
Step 9 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 461
Configuring Security
How to Configure Security
Verifying Ephone Security Parameters
show capf-server auth-string
Use this command to display configured authentication strings (PINs) that users enter at the phone to
establish CAPF authentication.
Router# show capf-server auth-string
Authentication Strings for configured Ephones
Mac-Addr Auth-String
-------- -----------
000CCE3A817C 2734
001121116BDD 922
000D299D50DF 9182
000ED7B10DAC 3114
000F90485077 3328
0013C352E7F1 0678
What to Do Next
• When you have more than one Cisco Unified CME router in your network, you must configure a
CTL provider on each Cisco Unified CME router that is not running the CTL client. To configure a
CTL provider on each Cisco Unified CME router on which the CTL client is not running, see the
“Configuring the CTL Provider” section on page 462.
• If the CA is a third-party CA or if the Cisco IOS CA is on a Cisco IOS router external to the
Cisco Unified CME router, you must configure a registration authority (RA) to issue certificates to
phones. For information, see “Configuring the Registration Authority” section on page 465
• If the specified authentication mode for the CAPF session is authentication-string, you must enter
an authentication string on each phone that is receiving an updated LSC. For information, see the
“Entering the Authentication String on the Phone” section on page 468.
• If the specified authentication mode for the CAPF session is MIC, the MIC’s issuer certificate must
be imported into a PKI trustpoint. For information, see the “Manually Importing the MIC Root
Certificate” section on page 469.
• To configure Media Encryption, see the “Configuring Media Encryption (SRTP) in
Cisco Unified CME” section on page 472.
Configuring the CTL Provider
When you have more than one Cisco Unified CME router in your network, you must configure a CTL
provider on each Cisco Unified CME router that is not running the CTL client. To configure a CTL
provider on each Cisco Unified CME router on which the CTL client is not running, perform the
following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. credentials
Cisco Unified Communications Manager Express System Administrator Guide
462 OL-10663-02
Configuring Security
How to Configure Security
4. ip source-address ip-address port port-number
5. trustpoint trustpoint-label
6. ctl-service admin username secret {0 | 1} password-string
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 credentials Enters credentials-interface mode to configure a CTL
provider.
Example:
Router(config)# credentials
Step 4 ip source-address [ip-address [port Identifies the local router on which this CTL provider is
[port-number]]] being configured.
• ip-address—Typically one of the addresses of the
Example: Ethernet port of the router.
Router(config-credentials)# ip source-address
172.19.245.1 port 2444 • port port-number—TCP port for credentials service
communication. Default is 2444 and we recommend
that you use the default value.
Step 5 trustpoint trustpoint-label Configures the trustpoint.
• trustpoint-label—Name of CTL provider trustpoint to
Example: be used for TLS sessions with the CTL client.
Router(config-credentials)# trustpoint ctlpv
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 463
Configuring Security
How to Configure Security
Command or Action Purpose
Step 6 ctl-service admin username secret {0 | 1} Specifies a username and password to authenticate the CTL
password-string client when it connects to retrieve the credentials during the
CTL protocol.
Example: • username—Name that will be used to authenticate the
Router(config-credentials)# ctl-service admin client.
user4 secret 0 c89L8o
• secret—Character string for login authentication and
whether the string should be encrypted when it is stored
in the running configuration.
– 0—Not encrypted.
– 1—Encrypted using Message Digest 5 (MD5).
• password-string—Character string for login
authentication.
Step 7 end Returns to privileged EXEC mode.
Example:
Router(config-credentials)# end
Verifying the CTL Provider
Step 1 show credentials
Use this command to display credentials settings.
Router# show credentials
Credentials IP: 172.19.245.1
Credentials PORT: 2444
Trustpoint: ctlpv
What to Do Next
• If the CA is a third-party CA or if the Cisco IOS CA is on a Cisco IOS router external to the
Cisco Unified CME router, you must configure a registration authority (RA) to issue certificates to
phones. For information, see “Configuring the Registration Authority” section on page 465
• If the specified authentication mode for the CAPF session is authentication-string, you must enter
an authentication string on each phone that is receiving an updated LSC. For information, see the
“Entering the Authentication String on the Phone” section on page 468.
• If the specified authentication mode for the CAPF session is MIC, the MIC’s issuer certificate must
be imported into a PKI trustpoint. For information, see the “Manually Importing the MIC Root
Certificate” section on page 469.
• To configure Media Encryption, see the “Configuring Media Encryption (SRTP) in
Cisco Unified CME” section on page 472.
Cisco Unified Communications Manager Express System Administrator Guide
464 OL-10663-02
Configuring Security
How to Configure Security
Configuring the Registration Authority
A registration authority (RA) is the authority charged with recording or verifying some or all of the data
required for the CA to issue certificates. In many cases the CA undertakes all of the RA functions itself,
but where a CA operates over a wide geographical area or when there is security concern over exposing
the CA at the edge of the network, it may be advisable to delegate some of the tasks to an RA and let the
CA concentrate on its primary tasks of signing certificates.
You can configure a CA to run in RA mode. When the RA receives a manual or Simple Certificate
Enrollment Protocol (SCEP) enrollment request, the administrator can either reject or grant it on the
basis of local policy. If the request is granted, it is forwarded to the issuing CA, and the CA automatically
generates the certificate and returns it to the RA. The client can later retrieve the granted certificate from
the RA.
To configure an RA, perform the following steps on the Cisco Unified CME router.
SUMMARY STEPS
1. enable
2. configure terminal
3. crypto pki trustpoint label
4. enrollment url ca-url
5. revocation-check method1 [method2 [method3]]
6. serial-number [none]
7. rsakeypair key-label [key-size [encryption-key-size]]
8. exit
9. crypto pki server label
10. mode ra
11. lifetime certificate time
12. grant auto
13. no shutdown
14. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 465
Configuring Security
How to Configure Security
Command or Action Purpose
Step 3 crypto pki trustpoint label Declares the trustpoint that your RA mode certificate server
should use and enters CA-trustpoint configuration mode.
Example: • label—Name for the trustpoint and RA.
Router(config)# crypto pki trustpoint ra12
Tip This label is also required for the
cert-enroll-trustpoint command when you set up
the CA proxy. See the “Configuring the CAPF
Server” section on page 455.
Step 4 enrollment url ca-url Specifies the enrollment URL of the issuing CA (root CA).
• ca-url—URL of the router on which the root CA has
Example: been installed.
Router(config-ca-trustpoint)# enrollment url
http://ca-server.company.com
Step 5 revocation-check method1 [method2 [method3]] (Optional) Checks the revocation status of a certificate and
specifies one or more methods to check the status. If a
second and third method are specified, each method is used
Example:
Router(config-ca-trustpoint)# revocation-check
only if the previous method returns an error, such as a server
none being down.
Valid values for methodn are as follows:
• crl—Certificate checking is performed by a certificate
revocation list (CRL). This is the default behavior.
• none—Certificate checking is not required.
• ocsp—Certificate checking is performed by an Online
Certificate Status Protocol (OCSP) server.
Step 6 serial-number [none] (Optional) Specifies whether the router serial number
should be included in the certificate request. When this
command is not used, you are prompted for the serial
Example:
Router(config-ca-trustpoint)# serial-number
number during certificate enrollment.
• none—(Optional) A serial number is not included in
the certificate request.
Step 7 rsakeypair key-label [key-size (Optional) Specifies an RSA key pair to use with a
[encryption-key-size]] certificate.
• key-label—Name of the key pair, which is generated
Example: during enrollment if it does not already exist or if the
Router(config-ca-trustpoint)# rsakeypair auto-enroll regenerate command is used.
exampleCAkeys 1024 1024
• key-size—(Optional) Size of the desired RSA key. If
not specified, the existing key size is used.
• encryption-key-size—(Optional) Size of the second
key, which is used to request separate encryption,
signature keys, and certificates.
• Multiple trustpoints can share the same key.
Step 8 exit Exits ca-trustpoint configuration mode.
Example:
Router(config-ca-trustpoint)# exit
Cisco Unified Communications Manager Express System Administrator Guide
466 OL-10663-02
Configuring Security
How to Configure Security
Command or Action Purpose
Step 9 crypto pki server label Defines a label for the certificate server and enters
certificate-server configuration mode.
Example: • label—Name for the trustpoint and RA. Use the same
Router(config)# crypto pki server ra12 label that you previously created as a trustpoint and RA
in Step 3.
Step 10 mode ra Places the PKI server into certificate-server mode for the
RA.
Example:
Router(config-cs-server)# mode ra
Step 11 lifetime certificate time (Optional) Specifies the lifetime, in days, of a certificate.
• time—Number of days until the certificate expires.
Example: Range is 1 to 1825. Default is 365. The maximum
Router(config-cs-server)# lifetime certificate certificate lifetime is 1 month less than the lifetime of
1800 the CA certificate.
• This command must be used before the server is
enabled with the no shutdown command.
Step 12 grant auto Allows a certificate to be issued automatically to any
requester.
Example: • Configure this command only during enrollment when
Router(config-cs-server)# grant auto testing and building simple networks.
• As a security best practice, use the no grant auto
command to disable this functionality after
configuration so that certificates are not continually
granted.
Step 13 no shutdown (Optional) Enables the certificate server.
• When prompted, provide input regarding acceptance of
Example: the CA certificate, the router certificate, the challenge
Router(config-cs-server)# no shutdown password, and a password for protecting the private
key.
• Use this command only after you have completely
configured your certificate server.
Step 14 end Returns to privileged EXEC mode.
Example:
Router(config-cs-server)# end
What to Do Next
• When you have more than one Cisco Unified CME router in your network, you must configure a
CTL provider on each Cisco Unified CME router that is not running the CTL client. To configure a
CTL provider on each Cisco Unified CME router on which the CTL client is not running, see the
“Configuring the CTL Provider” section on page 462.
• If the specified authentication mode for the CAPF session is authentication-string, you must enter
an authentication string on each phone that is receiving an updated LSC. For information, see the
“Entering the Authentication String on the Phone” section on page 468.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 467
Configuring Security
How to Configure Security
• If the specified authentication mode for the CAPF session is MIC, the MIC’s issuer certificate must
be imported into a PKI trustpoint. For information, see the “Manually Importing the MIC Root
Certificate” section on page 469.
• To configure Media Encryption, see the “Configuring Media Encryption (SRTP) in
Cisco Unified CME” section on page 472.
Entering the Authentication String on the Phone
This procedure is required only for the one-time installation of an LSC on a phone and only if you
configured that the authentication mode for the CAPF session is authentication-string. The
authentication string must be communicated to the phone user so that it can be entered on the phone
before the LSC is installed.
The phone user can perform the following procedure to install the certificate.
Note You can list authentication strings for phones by using the show capf-server auth-string command.
Prerequisites
• A signed image exists on the IP phone; see the Cisco Unified IP phone administration
documentation that supports your phone model.
• The IP phone is registered in Cisco Unified CME.
• The CAPF certificate exists in the CTL file. For information, see the “Configuring the CTL Client”
section on page 450.
• The authentication string to be entered was configured by using auth-string command in
CAPF-server configuration mode or the capf-auth-str command in ephone configuration mode. For
information, see the “Configuring Telephony-Service Security Parameters” section on page 448.
• The device-security-mode command was configured using the none keyword. For information, see
the “Configuring Telephony-Service Security Parameters” section on page 448.
Restrictions
• The authentication string applies for one-time use only.
DETAILED STEPS
Step 1 Press the Settings button. On the Cisco Unified IP Phone 7921, use the down arrow key to access the
Settings menu.
Step 2 If the configuration is locked, press **# (asterisk, asterisk, pound sign) to unlock it.
Step 3 Scroll down the Settings menu. Highlight Security Configuration and press the Select soft key.
Step 4 Scroll down the Security Configuration menu. Highlight LSC and press the Update soft key. On the
Cisco Unified IP Phone 7921, press **# to unlock the Security Configuration menu.
Step 5 When prompted for the authentication string, enter the string provided by the system administrator and
press the Submit soft key.
The phone installs, updates, deletes, or fetches the certificate, depending on the CAPF configuration.
Cisco Unified Communications Manager Express System Administrator Guide
468 OL-10663-02
Configuring Security
How to Configure Security
You can monitor the progress of the certificate operation by viewing the messages that display on the
phone. After you press Submit, the message “Pending” appears under the LSC option. The phone
generates the public and private key pair and displays the information on the phone. When the phone
successfully completes the process, the phone displays a successful message. If the phone displays a
failure message, you entered the wrong authentication string or did not enable the phone for upgrade.
You can stop the process by choosing Stop at any time.
Step 6 Verify that the certificate was installed on the phone. From the Settings menu on the phone screen,
choose Model Information and then press the Select soft key to display the Model Information.
Step 7 Press the navigation button to scroll to LSC. The value for this item indicates whether LSC is Installed
or Not Installed
What to Do Next
• When you have more than one Cisco Unified CME router in your network, you must configure a
CTL provider on each Cisco Unified CME router that is not running the CTL client. To configure a
CTL provider on each Cisco Unified CME router on which the CTL client is not running, see the
“Configuring the CTL Provider” section on page 462.
• If the CA is a third-party CA or if the Cisco IOS CA is on a Cisco IOS router external to the
Cisco Unified CME router, you must configure a registration authority (RA) to issue certificates to
phones. For information, see “Configuring the Registration Authority” section on page 465
• If the specified authentication mode for the CAPF session is MIC, the MIC’s issuer certificate must
be imported into a PKI trustpoint. For information, see the “Manually Importing the MIC Root
Certificate” section on page 469.
• To configure Media Encryption, see the “Configuring Media Encryption (SRTP) in
Cisco Unified CME” section on page 472.
Manually Importing the MIC Root Certificate
The MIC root certificate must be present in the Cisco Unified CME router to allow Cisco Unified CME
to authenticate the MIC that is presented to it. To manually import the MIC root certificate on the
Cisco Unified CME router, perform the following steps for each type of phone that requires a MIC for
authentication.
Prerequisites
One of the following must be true before you perform this task:
• The device-security-mode command was configured using the none keyword. For information, see
the “Configuring Telephony-Service Security Parameters” section on page 448.
• MIC is the specified authentication mode for phone authentication during a CAPF session.
• A phone’s MIC, rather than an LSC, is to be used to establish the TLS session for SCCP signaling.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 469
Configuring Security
How to Configure Security
3. crypto pki trustpoint name
4. revocation-check none
5. enrollment terminal
6. exit
7. crypto pki authenticate name
8. Download the four MIC root files, cut and paste the appropriate text for the certificate. Accept the
certificates.
9. exit
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 crypto pki trustpoint name Declares the CA that your router should use and enters
ca-trustpoint configuration mode.
Example: • name—Already-configured label for the CA.
Router(config)# crypto pki trustpoint sanjose1
Step 4 revocation-check none Specifies that revocation check is not performed and the
certificate is always accepted.
Example:
Router(ca-trustpoint)# revocation-check none
Step 5 enrollment terminal Specifies manual (copy-and-paste) certificate enrollment.
Example:
Router(ca-trustpoint)# enrollment terminal
Step 6 exit Exits ca-trustpoint configuration mode.
Example:
Router(ca-trustpoint)# exit
Step 7 crypto pki authenticate name Authenticates the CA by getting the certificate from the CA.
• name—Already-configured label for the CA.
Example:
Router(config)# crypto pki authenticate
sanjose1
Step 8 Download the four MIC root certificate files and copy
and paste the appropriate text for each certificate.
Cisco Unified Communications Manager Express System Administrator Guide
470 OL-10663-02
Configuring Security
How to Configure Security
Command or Action Purpose
a. Click on the link to the certificate: The certificates are available at the following links:
• CAP-RTP-001:
http://www.cisco.com/security/pki/certs/CAP-RTP-00
1.cer
• CAP-RTP-002:
http://www.cisco.com/security/pki/certs/CAP-RTP-00
2.cer
• CMCA:
http://www.cisco.com/security/pki/certs/cmca.cer
• CiscoRootCA2048:
http://www.cisco.com/security/pki/certs/crca2048.cer
b. When the “downloading certificate” dialog
window opens, select the option to “view” the
certificate. Do not install the certificate.
c. Select the “detail” tab on top.
d. Click “Export” on the bottom and save the
certificate into a file.
e. Open the file with WordPad.
f. Cut and paste the text between “-----BEGIN
CERTIFICATE-----” and “-----END
CERTIFICATE-----” into the IOS console.
g. When prompted, press Enter, and type quit. Press Enter after pasting the certificate, and type quit on a
line by itself.
h. Enter y to accept the certificate. The system responds to the pasted certificate text by
providing the MD5 and SHA1 fingerprints, and asks
whether you accept the certificate.
Enter y to accept the certificate or n to reject it.
i. Repeat steps a. through h. for each certificate.
Step 9 exit Returns to privileged EXEC mode.
Example:
Router(config)# exit
What to Do Next
• When you have more than one Cisco Unified CME router in your network, you must configure a
CTL provider on each Cisco Unified CME router that is not running the CTL client. To configure a
CTL provider on each Cisco Unified CME router on which the CTL client is not running, see the
“Configuring the CTL Provider” section on page 462.
• If the CA is a third-party CA or if the Cisco IOS CA is on a Cisco IOS router external to the
Cisco Unified CME router, you must configure a registration authority (RA) to issue certificates to
phones. For information, see “Configuring the Registration Authority” section on page 465
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 471
Configuring Security
How to Configure Security
• If the specified authentication mode for the CAPF session is authentication-string, you must enter
an authentication string on each phone that is receiving an updated LSC. For information, see the
“Entering the Authentication String on the Phone” section on page 468.
• To configure Media Encryption, see the “Configuring Media Encryption (SRTP) in
Cisco Unified CME” section on page 472.
Configuring Media Encryption (SRTP) in Cisco Unified CME
To configure the network for secure calls between Cisco Unified CME systems across an H.323 trunk,
perform the following steps on the Cisco Unified CME router.
Prerequisites
• Cisco Unified CME 4.2 or a later version.
• To make secure H.323 calls, telephony-service security parameters must be configured. See the
“Configuring Telephony-Service Security Parameters” section on page 448.
• Compatible Cisco IOS Release on the Cisco VG224 Analog Phone Gateway. For information, see
the Cisco Unified CME and Cisco IOS Release Compatibility Matrix.
Restrictions
• Secure three-way software conference is not supported. A secure call beginning with SRTP will
always fall back to nonsecure Real-Time Transport Protocol (RTP) when it is joined to a conference.
• If a party drops from a three-party conference, the call between the remaining two parties returns to
secure if the two parties are SRTP-capable local Skinny Client Control Protocol (SCCP) endpoints
to a single Cisco Unified CME and the conference creator is one of the remaining parties. If either
of the two remaining parties are only RTP-capable, the call remains nonsecure. If the two remaining
parties are connected through FXS, PSTN, or VoIP, the call remains nonsecure.
• Calls to Cisco Unity Express are not secure.
• Music on Hold (MOH) is not secure.
• Video calls are not secure.
• Modem relay and T.3 fax relay calls are not secure.
• Media flow-around is not supported for call transfer and call forward.
• Conversion between inband tone and RFC 2833 DTMF is not supported. RFC 2833 DTMF handling
is supported when encryption keys are sent to secure DSP farm devices but is not supported for
codec passthrough.
• Secure Cisco Unified CME does not support SIP trunks; only H.323 trunks are supported.
• Media Encryption (SRTP) supports secure supplementary services in both H.450 and nonH.450
Cisco Unified CME networks. A secure Cisco Unified CME network should be either H.450 or
nonH.450, not a hybrid.
• Secure calls are supported in the default session application only.
SUMMARY STEPS
1. enable
Cisco Unified Communications Manager Express System Administrator Guide
472 OL-10663-02
Configuring Security
How to Configure Security
2. configure terminal
3. voice service voip
4. supplementary-service media-renegotiate
5. srtp fallback
6. h323
7. emptycapability
8. exit
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice service voip Enters voice-service configuration mode.
• The voip keyword specifies VoIP encapsulation.
Example:
Router(config)# voice service voip
Step 4 supplementary-service media-renegotiate Enables midcall renegotiation of SRTP cryptographic keys.
Example:
Router(conf-voi-serv)# supplementary-service
media-renegotiate
Step 5 srtp fallback Globally enables secure calls using SRTP for media
encryption and authentication and enables SRTP-to-RTP
fallback to support for supplementary services such as
Example:
Router(conf-voi-serv)# srtp fallback
ringback tone and MOH.
• Skip this step if you are going to configure fallback on
individual dial peers.
• This command can also be configured in dial-peer
configuration mode. This command in dial-peer
configuration command takes precedence over this
command in voice service voip configuration mode.
Step 6 h323 Enters H.323 voice-service configuration mode.
Example:
Router(conf-voi-serv)# h323
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 473
Configuring Security
How to Configure Security
Command or Action Purpose
Step 7 emptycapability Eliminates the need for identical codec capabilities for all
dial peers in the rotary group.
Example:
Router(conf-serv-h323)# emptycapability
Step 8 exit Exits H.323 voice-service configuration mode.
Example:
Router(conf-serv-h323)# exit
What to Do Next
You have completed the required task for configuring Media Encryption (SRTP) on Cisco Unified CME.
You can now perform the following optional tasks:
• Configuring Cisco Unified CME SRTP Fallback for H.323 Dial Peers, page 474 (optional)
• Configuring Cisco Unity for Secure Cisco Unified CME Operation, page 476 (optional)
Configuring Cisco Unified CME SRTP Fallback for H.323 Dial Peers
To configure SRTP fallback for an individual dial peer, perform the following steps on the
Cisco Unified CME router.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice class codec tag
4. codec preference value codec-type
5. exit
6. dial-peer voice tag voip
7. srtp fallback
8. voice-class codec tag
9. exit
Cisco Unified Communications Manager Express System Administrator Guide
474 OL-10663-02
Configuring Security
How to Configure Security
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice class codec tag Enters voice-class configuration mode and assigns an
identification tag number for a codec voice class.
Example:
Router(config)# voice class codec 1
Step 4 codec preference value codec-type Specifies a list of preferred codecs to use on a dial peer.
• Repeat this step to build a list of preferred codecs.
Example: • Use the same preference order for the codec list on both
Router(config-voice-class)# codec preference 1
g711alaw
Cisco Unified CMEs on either side of the H.323 trunk.
Step 5 exit Exits voice-class configuration mode.
Example:
Router(config-voice-class)# exit
Step 6 dial-peer voice tag voip Enters dial peer voice configuration mode.
Example:
Router(config)# dial-peer voice 101 voip
Step 7 srtp fallback Enables secure calls that use SRTP for media encryption
and authentication and specifies fallback capability.
Example: • Using the no srtp command disables SRTP and causes
Router(config-dial-peer)# srtp fallback the dial peer to fall back to RTP mode.
• fallback—Enables fallback to nonsecure mode (RTP)
on an individual dial peer. The no srtp fallback
command disables fallback and disables SRTP.
• This command can also be configured in voice service
voip configuration mode. This command in dial-peer
configuration command takes precedence over this
command in voice service voip configuration mode.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 475
Configuring Security
How to Configure Security
Command or Action Purpose
Step 8 voice-class codec tag Assigns a previously configured codec selection preference
list (codec voice class) to a Voice over IP (VoIP) dial peer.
Example: • The tag argument in this step is the same as the tag in
Router(config-dial-peer)# voice-class codec 1 Step 3.
Step 9 exit Exits dial-peer voice configuration mode.
Example:
Router(config-dial-peer)# exit
Configuring Cisco Unity for Secure Cisco Unified CME Operation
This section contains the following tasks:
• Prerequisites, page 476
• Configuring Integration Between Cisco Unified CME and Cisco Unity, page 476
• Importing the Cisco Unity Root Certificate to Cisco Unified CME, page 477
• Configuring Cisco Unity Ports for Secure Registration, page 478
• Verifying that Cisco Unity are Registering Securely, page 479
Prerequisites
• Cisco Unity 4.2 or later version.
Configuring Integration Between Cisco Unified CME and Cisco Unity
To change the settings for the integration between Cisco Unified CME and Cisco Unity, perform the
following steps on the Cisco Unity server:
Step 1 If Cisco Unity Telephony Integration Manager (UTIM) is not already open, on the Cisco Unity server,
from the Windows Start menu, choose Programs > Cisco Unity > Manage Integrations. The UTIM
window appears.
Step 2 In the left pane, double-click Cisco Unity Server. The existing integrations appear.
Step 3 Click Cisco Unified Communications Manager integration.
Step 4 In the right pane, click the cluster for the integration.
Step 5 Click the Servers tab.
Step 6 In the Cisco Unified Communications Manager Cluster Security Mode field, click the applicable setting.
Step 7 If you clicked Non-secure, click Save and skip the remaining steps in this procedure.
If you clicked Authenticated or Encrypted, the Security tab and the Add TFTP Server dialog box
appear. In the Add TFTP Server dialog box, in the IP Address or Host Name field, enter the IP address
(or DNS name) of the primary TFTP server for the Cisco Unified Communications Manager cluster and
click OK.
Step 8 If there are more TFTP servers that Cisco Unity will use to download the Cisco Unified Communications
Manager certificates, click Add. The Add TFTP Server dialog box appears.
Cisco Unified Communications Manager Express System Administrator Guide
476 OL-10663-02
Configuring Security
How to Configure Security
Step 9 In the IP Address or Host Name field, enter the IP address (or DNS name) of the secondary TFTP server
for the Cisco Unified Communications Manager cluster, and click OK.
Step 10 Click Save.
Cisco Unity creates the voice messaging port device certificates, exports the Cisco Unity server root
certificate, and displays the Export Cisco Unity Root Certificate dialog box.
Step 11 Note the file name of the exported Cisco Unity server root certificate and click OK.
Step 12 On the Cisco Unity server, navigate to the CommServer\SkinnyCerts directory.
Step 13 Locate the Cisco Unity server root certificate file that you exported in Step 11.
Step 14 Right-click the file and click Rename.
Step 15 Change the file extension from .0 to .pem. For example, change the filename “12345.0” to “12345.pem”
for the exported Cisco Unity server root certificate file.
Step 16 Copy this file to a PC from which you can access the Cisco Unified CME router.
Importing the Cisco Unity Root Certificate to Cisco Unified CME
To import the Cisco Unity root certificate to Cisco Unified CME, perform the following steps on the
Cisco Unified CME router:
SUMMARY STEPS
1. enable
2. configure terminal
3. crypto pki trustpoint name
4. revocation-check none
5. enrollment terminal
6. exit
7. crypto pki authenticate trustpoint-label
8. Open the root certificate file that you copied from the Cisco Unity Server in Step 16.
9. You will be prompted to enter the CA certificate. Cut and paste the entire contents of the base 64
encoded certificate between “BEGIN CERTIFICATE” and “END CERTIFICATE” at the command
line. Press Enter, and type “quit.” The router prompts you to accept the certificate. Enter “yes” to
accept the certificate.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 477
Configuring Security
How to Configure Security
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 crypto pki trustpoint name Declares the trustpoint that your RA mode certificate server
should use and enters ca-trustpoint configuration mode.
Example: • label—Name for the trustpoint and RA.
Router(config)# crypto pki trustpoint PEM
Step 4 revocation-check none (Optional) Specifies that certificate checking is not
required.
Example:
Router(ca-trustpoint)# revocation-check none
Step 5 enrollment terminal Specifies manual cut-and-paste certificate enrollment.
Example:
Router(ca-trustpoint)# enrollment terminal
Step 6 exit Exits ca-trustpoint configuration mode.
Example:
Router(ca-trustpoint)# exit
Step 7 crypto pki authenticate trustpoint-label Retrieves the CA certificate and authenticates it. Checks the
certificate fingerprint if prompted.
Example: • trustpoint-label—Already-configured name for the
Router(config)# crypto pki authenticate pem trustpoint and RA. See Step 3.
Step 8 At the prompt, enter the CA certificate. Cut and paste Completes the copying of the Cisco Unity root certificate to
the entire contents of the base 64 encoded certificate the Cisco Unified CME router.
between “BEGIN CERTIFICATE” and “END
CERTIFICATE” at the command line. Press Enter,
and type “quit.” The router prompts you to accept the
certificate. Enter “yes” to accept the certificate.
Configuring Cisco Unity Ports for Secure Registration
To configure Cisco Unity ports for registration in secure mode, perform the following steps:
Step 1 Choose the Cisco voice-mail port that you want to update.
Step 2 From the Device Security Mode drop-down list, choose Encrypted.
Cisco Unified Communications Manager Express System Administrator Guide
478 OL-10663-02
Configuring Security
Configuration Examples for Security
Step 3 Click Update.
Verifying that Cisco Unity are Registering Securely
Use the show sccp connections command to verify that Cisco Unity ports are registered securely with
Cisco Unified CME.
show sccp connection: Example
In the following example, the secure value of the type field shows that the connections are secure.
Router# show sccp connections
sess_id conn_id stype mode codec ripaddr rport sport
16777222 16777409 secure-xcode sendrecv g729b 10.3.56.120 16772 19534
16777222 16777393 secure-xcode sendrecv g711u 10.3.56.50 17030 18464
Total number of active session(s) 1, and connection(s) 2
Configuration Examples for Security
This section contains the following examples:
Phone Authentication
• Cisco IOS CA: Example, page 479
• Manually Importing MIC Root Certificate on the Cisco Unified CME Router: Example, page 480
• Telephony-Service Security Parameters: Example, page 482
• CTL Client Running on Cisco Unified CME Router: Example, page 482
Media Encryption
• Secure Cisco Unified CME: Example, page 486
Cisco IOS CA: Example
crypto pki server iosca
grant auto
database url flash:
!
crypto pki trustpoint iosca
revocation-check none
rsakeypair iosca
!
crypto pki certificate chain iosca
certificate ca 01
308201F9 30820162 ...
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 479
Configuring Security
Configuration Examples for Security
Manually Importing MIC Root Certificate on the Cisco Unified CME Router:
Example
The following example shows three certificates imported to the router (7970, 7960, PEM).
Router(config)# crypto pki trustpoint 7970
Router(ca-trustpoint)# revocation-check none
Router(ca-trustpoint)# enrollment terminal
Router(ca-trustpoint)# exit
Router(config)# crypto pki authenticate 7970
Enter the base 64 encoded CA certificate.
End with a blank line or the word "quit" on a line by itself
MIIDqDCCApCgAwIBAgIQNT+yS9cPFKNGwfOprHJWdTANBgkqhkiG9w0BAQUFADAu
MRYwFAYDVQQKEw1DaXNjbyBTeXN0ZW1zMRQwEgYDVQQDEwtDQVAtUlRQLTAwMjAe
Fw0wMzEwMTAyMDE4NDlaFw0yMzEwMTAyMDI3MzdaMC4xFjAUBgNVBAoTDUNpc2Nv
IFN5c3RlbXMxFDASBgNVBAMTC0NBUC1SVFAtMDAyMIIBIDANBgkqhkiG9w0BAQEF
AAOCAQ0AMIIBCAKCAQEAxCZlBK19w/2NZVVvpjCPrpW1cCY7V1q9lhzI85RZZdnQ
2M4CufgIzNa3zYxGJIAYeFfcRECnMB3f5A+x7xNiEuzE87UPvK+7S80uWCY0Uhtl
AVVf5NQgZ3YDNoNXg5MmONb8lT86F55EZyVac0XGne77TSIbIdejrTgYQXGP2MJx
Qhg+ZQlGFDRzbHfM84Duv2Msez+l+SqmqO80kIckqE9Nr3/XCSj1hXZNNVg8D+mv
Hth2P6KZqAKXAAStGRLSZX3jNbS8tveJ3Gi5+sj9+F6KKK2PD0iDwHcRKkcUHb7g
lI++U/5nswjUDIAph715Ds2rn9ehkMGipGLF8kpuCwIBA6OBwzCBwDALBgNVHQ8E
BAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUUpIr4ojuLgmKTn5wLFal
mrTUm5YwbwYDVR0fBGgwZjBkoGKgYIYtaHR0cDovL2NhcC1ydHAtMDAyL0NlcnRF
bnJvbGwvQ0FQLVJUUC0wMDIuY3Jshi9maWxlOi8vXFxjYXAtcnRwLTAwMlxDZXJ0
RW5yb2xsXENBUC1SVFAtMDAyLmNybDAQBgkrBgEEAYI3FQEEAwIBADANBgkqhkiG
9w0BAQUFAAOCAQEAVoOM78TaOtHqj7sVL/5u5VChlyvU168f0piJLNWip2vDRihm
E+DlXdwMS5JaqUtuaSd/m/xzxpcRJm4ZRRwPq6VeaiiQGkjFuZEe5jSKiSAK7eHg
tup4HP/ZfKSwPA40DlsGSYsKNMm3OmVOCQUMH02lPkS/eEQ9sIw6QS7uuHN4y4CJ
NPnRbpFRLw06hnStCZHtGpKEHnY213QOy3h/EWhbnp0MZ+hdr20FujSI6G1+L39l
aRjeD708f2fYoz9wnEpZbtn2Kzse3uhU1Ygq1D1x9yuPq388C18HWdmCj4OVTXux
V6Y47H1yv/GJM8FvdgvKlExbGTFnlHpPiaG9tQ==
quit
Certificate has the following attributes:
Fingerprint MD5: F7E150EA 5E6E3AC5 615FC696 66415C9F
Fingerprint SHA1: 1BE2B503 DC72EE28 0C0F6B18 798236D8 D3B18BE6
% Do you accept this certificate? [yes/no]: y
Trustpoint CA certificate accepted.
% Certificate successfully imported
Router(config)# crypto pki trustpoint 7960
Router(ca-trustpoint)# revocation-check none
Router(ca-trustpoint)# enrollment terminal
Router(ca-trustpoint)# exit
Router(config)# crypto pki authenticate 7960
Enter the base 64 encoded CA certificate.
End with a blank line or the word "quit" on a line by itself
MIICKDCCAZGgAwIBAgIC8wEwDQYJKoZIhvcNAQEFBQAwQDELMAkGA1UEBhMCVVMx
GjAYBgNVBAoTEUNpc2NvIFN5c3RlbXMgSW5jMRUwEwYDVQQDEwxDQVBGLTdEN0Qw
QzAwHhcNMDQwNzE1MjIzODMyWhcNMTkwNzEyMjIzODMxWjBAMQswCQYDVQQGEwJV
UzEaMBgGA1UEChMRQ2lzY28gU3lzdGVtcyBJbmMxFTATBgNVBAMTDENBUEYtN0Q3
RDBDMDCBnzANBgkqhkiG9w0BAQEFAAOBjQAwgYkCgYEA0hvMOZZ9ENYWme11YGY1
it2rvE3Nk/eqhnv8P9eqB1iqt+fFBeAG0WZ5bO5FetdU+BCmPnddvAeSpsfr3Z+h
x+r58fOEIBRHQLgnDZ+nwYH39uwXcRWWqWwlW147YHjV7M5c/R8T6daCx4B5NBo6
kdQdQNOrV3IP7kQaCShdM/kCAwEAAaMxMC8wDgYDVR0PAQH/BAQDAgKEMB0GA1Ud
JQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDBTANBgkqhkiG9w0BAQUFAAOBgQCaNi6x
sL6M5NlDezpSBO3QmUVyXMfrONV2ysrSwcXzHu0gJ9MSJ8TwiQmVaJ47hSTlF5a8
YVYJ0IdifXbXRo+/EEO7kkmFE8MZta5rM7UWj8bAeR42iqA3RzQaDwuJgNWT9Fhh
GgfuNAlo5h1AikxsvxivmDlLdZyCMoqJJd7B2Q==
quit
Cisco Unified Communications Manager Express System Administrator Guide
480 OL-10663-02
Configuring Security
Configuration Examples for Security
Certificate has the following attributes:
Fingerprint MD5: 4B9636DF 0F3BA6B7 5F54BE72 24762DBC
Fingerprint SHA1: A9917775 F86BB37A 5C130ED2 3E528BB8 286E8C2D
% Do you accept this certificate? [yes/no]: y
Trustpoint CA certificate accepted.
% Certificate successfully imported
Router(config)# crypto pki trustpoint PEM
Router(ca-trustpoint)# revocation-check none
Router(ca-trustpoint)# enrollment terminal
Router(ca-trustpoint)# exit
Router(config)# crypto pki authenticate PEM
Enter the base 64 encoded CA certificate.
End with a blank line or the word "quit" on a line by itself
MIIDqDCCApCgAwIBAgIQdhL5YBU9b59OQiAgMrcjVjANBgkqhkiG9w0BAQUFADAu
MRYwFAYDVQQKEw1DaXNjbyBTeXN0ZW1zMRQwEgYDVQQDEwtDQVAtUlRQLTAwMTAe
Fw0wMzAyMDYyMzI3MTNaFw0yMzAyMDYyMzM2MzRaMC4xFjAUBgNVBAoTDUNpc2Nv
IFN5c3RlbXMxFDASBgNVBAMTC0NBUC1SVFAtMDAxMIIBIDANBgkqhkiG9w0BAQEF
AAOCAQ0AMIIBCAKCAQEArFW77Rjem4cJ/7yPLVCauDohwZZ/3qf0sJaWlLeAzBlq
Rj2lFlSij0ddkDtfEEo9VKmBOJsvx6xJlWJiuBwUMDhTRbsuJz+npkaGBXPOXJmN
Vd54qlpc/hQDfWlbrIFkCcYhHws7vwnPsLuy1Kw2L2cP0UXxYghSsx8H4vGqdPFQ
NnYy7aKJ43SvDFt4zn37n8jrvlRuz0x3mdbcBEdHbA825Yo7a8sk12tshMJ/YdMm
vny0pmDNZXmeHjqEgVO3UFUn6GVCO+K1y1dUU1qpYJNYtqLkqj7wgccGjsHdHr3a
U+bw1uLgSGsQnxMWeMaWo8+6hMxwlANPweufgZMaywIBA6OBwzCBwDALBgNVHQ8E
BAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQU6Rexgscfz6ypG270qSac
cK4FoJowbwYDVR0fBGgwZjBkoGKgYIYtaHR0cDovL2NhcC1ydHAtMDAxL0NlcnRF
bnJvbGwvQ0FQLVJUUC0wMDEuY3Jshi9maWxlOi8vXFxjYXAtcnRwLTAwMVxDZXJ0
RW5yb2xsXENBUC1SVFAtMDAxLmNybDAQBgkrBgEEAYI3FQEEAwIBADANBgkqhkiG
9w0BAQUFAAOCAQEAq2T96/YMMtw2Dw4QX+F1+g1XSrUCrNyjx7vtFaRDHyB+kobw
dwkpohfkzfTyYpJELzV1r+kMRoyuZ7oIqqccEroMDnnmeApc+BRGbDJqS1Zzk4OA
c6Ea7fm53nQRlcSPmUVLjDBzKYDNbnEjizptaIC5fgB/S9S6C1q0YpTZFn5tjUjy
WXzeYSXPrcxb0UH7IQJ1ogpONAAUKLoPaZU7tVDSH3hD4+VjmLyysaLUhksGFrrN
phzZrsVVilK17qpqCPllKLGAS4fSbkruq3r/6S/SpXS6/gAoljBKixP7ZW2PxgCU
1aU9cURLPO95NDOFN3jBk3Sips7cVidcogowPQ==
quit
Certificate has the following attributes:
Fingerprint MD5: 233C8E33 8632EA4E 76D79FEB FFB061C6
Fingerprint SHA1: F7B40B94 5831D2AB 447AB8F2 25990732 227631BE
% Do you accept this certificate? [yes/no]: y
Trustpoint CA certificate accepted.
% Certificate successfully imported
Use the show crypto pki trustpoint status command to show that enrollment has succeeded and that
five CA certificates were granted. The five certificates include the three certificates just entered and the
CA server certificate and the router certificate.
Router# show crypto pki trustpoint status
Trustpoint 7970:
Issuing CA certificate configured:
Subject Name:
cn=CAP-RTP-002,o=Cisco Systems
Fingerprint MD5: F7E150EA 5E6E3AC5 615FC696 66415C9F
Fingerprint SHA1: 1BE2B503 DC72EE28 0C0F6B18 798236D8 D3B18BE6
State:
Keys generated ............. Yes (General Purpose)
Issuing CA authenticated ....... Yes
Certificate request(s) ..... None
Trustpoint 7960:
Issuing CA certificate configured:
Subject Name:
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 481
Configuring Security
Configuration Examples for Security
cn=CAPF-508A3754,o=Cisco Systems Inc,c=US
Fingerprint MD5: 6BAE18C2 0BCE391E DAE2FE4C 5810F576
Fingerprint SHA1: B7735A2E 3A5C274F C311D7F1 3BE89942 355102DE
State:
Keys generated ............. Yes (General Purpose)
Issuing CA authenticated ....... Yes
Certificate request(s) ..... None
Trustpoint PEM:
Issuing CA certificate configured:
Subject Name:
cn=CAP-RTP-001,o=Cisco Systems
Fingerprint MD5: 233C8E33 8632EA4E 76D79FEB FFB061C6
Fingerprint SHA1: F7B40B94 5831D2AB 447AB8F2 25990732 227631BE
State:
Keys generated ............. Yes (General Purpose)
Issuing CA authenticated ....... Yes
Certificate request(s) ..... None
Trustpoint srstcaserver:
Issuing CA certificate configured:
Subject Name:
cn=srstcaserver
Fingerprint MD5: 6AF5B084 79C93F2B 76CC8FE6 8781AF5E
Fingerprint SHA1: 47D30503 38FF1524 711448B4 9763FAF6 3A8E7DCF
State:
Keys generated ............. Yes (General Purpose)
Issuing CA authenticated ....... Yes
Certificate request(s) ..... None
Trustpoint srstca:
Issuing CA certificate configured:
Subject Name:
cn=srstcaserver
Fingerprint MD5: 6AF5B084 79C93F2B 76CC8FE6 8781AF5E
Fingerprint SHA1: 47D30503 38FF1524 711448B4 9763FAF6 3A8E7DCF
Router General Purpose certificate configured:
Subject Name:
serialNumber=F3246544+hostname=c2611XM-sSRST.cisco.com
Fingerprint: 35471295 1C907EC1 45B347BC 7A9C4B86
State:
Keys generated ............. Yes (General Purpose)
Issuing CA authenticated ....... Yes
Certificate request(s) ..... Yes
Telephony-Service Security Parameters: Example
The following example shows Cisco Unified CME security parameters.
telephony-service
device-security-mode authenticated
secure-signaling trustpoint cme-sccp
tftp-server-credentials trustpoint cme-tftp
load-cfg-file slot0:Ringlist.xml alias Ringlist.xml sign create
ephone 24
device-security-mode authenticated
capf-auth-str 2734
cert-oper upgrade auth-mode auth-string
CTL Client Running on Cisco Unified CME Router: Example
Cisco Unified Communications Manager Express System Administrator Guide
482 OL-10663-02
Configuring Security
Configuration Examples for Security
ctl-client
server capf 10.1.1.1 trustpoint cmeserver
server cme 10.1.1.1 trustpoint cmeserver
server tftp 10.1.1.1 trustpoint cmeserver
sast1 trustpoint cmeserver
sast2 trustpoint sast2CTL Client Running on Another Router: Example
ctl-client
server cme 10.1.1.100 trustpoint cmeserver
server cme 10.1.1.1 username cisco password 1 0822455D0A16544541
sast1 trustpoint cmeserver
sast2 trustpoint sast1CAPF Server: Example
!
ip dhcp pool cme-pool
network 10.1.1.0 255.255.255.0
option 150 ip 10.1.1.1
default-router 10.1.1.1
!
capf-server
port 3804
auth-mode null-string
cert-enroll-trustpoint iosra password 1 00071A1507545A545C
trustpoint-label cmeserver
source-addr 10.1.1.1
!
crypto pki server iosra
grant auto
mode ra
database url slot0:
!
crypto pki trustpoint cmeserver
enrollment url http://10.1.1.100:80
serial-number
revocation-check none
rsakeypair cmeserver
!
crypto pki trustpoint sast2
enrollment url http://10.1.1.100:80
serial-number
revocation-check none
rsakeypair sast2
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 483
Configuring Security
Configuration Examples for Security
!
crypto pki trustpoint iosra
enrollment url http://10.1.1.200:80
revocation-check none
rsakeypair iosra
!
!
crypto pki certificate chain cmeserver
certificate 1B
30820207 30820170 A0030201 0202011B 300D0609 2A864886 F70D0101 04050030
....
quit
certificate ca 01
3082026B 308201D4 A0030201 02020101 300D0609 2A864886 F70D0101 04050030
...
quit
crypto pki certificate chain sast2
certificate 1C
30820207 30820170 A0030201 0202011C 300D0609 2A864886 F70D0101 04050030
....
quit
certificate ca 01
3082026B 308201D4 A0030201 02020101 300D0609 2A864886 F70D0101 04050030
.....
quit
crypto pki certificate chain capf-tp
crypto pki certificate chain iosra
certificate 04
30820201 3082016A A0030201 02020104 300D0609 2A864886 F70D0101 04050030
......
certificate ca 01
308201F9 30820162 A0030201 02020101 300D0609 2A864886 F70D0101 04050030
....
quit
!
!
credentials
ctl-service admin cisco secret 1 094F471A1A0A464058
ip source-address 10.1.1.1 port 2444
trustpoint cmeserver
!
!
telephony-service
no auto-reg-ephone
load 7960-7940 P00307010200
load 7914 S00104000100
load 7941GE TERM41.7-0-0-129DEV
load 7970 TERM70.7-0-0-77DEV
max-ephones 20
max-dn 10
ip source-address 10.1.1.1 port 2000 secondary 10.1.1.100
secure-signaling trustpoint cmeserver
cnf-file location flash:
cnf-file perphone
dialplan-pattern 1 2... extension-length 4
max-conferences 8 gain -6
transfer-pattern ....
tftp-server-credentials trustpoint cmeserver
server-security-mode secure
device-security-mode encrypted
load-cfg-file slot0:Ringlist.xml alias Ringlist.xml sign
load-cfg-file slot0:P00307010200.bin alias P00307010200.bin
load-cfg-file slot0:P00307010200.loads alias P00307010200.loads
load-cfg-file slot0:P00307010200.sb2 alias P00307010200.sb2
Cisco Unified Communications Manager Express System Administrator Guide
484 OL-10663-02
Configuring Security
Configuration Examples for Security
load-cfg-file slot0:P00307010200.sbn alias P00307010200.sbn
load-cfg-file slot0:cnu41.2-7-4-116dev.sbn alias cnu41.2-7-4-116dev.sbn
load-cfg-file slot0:Jar41.2-9-0-101dev.sbn alias Jar41.2-9-0-101dev.sbn
load-cfg-file slot0:CVM41.2-0-0-96dev.sbn alias CVM41.2-0-0-96dev.sbn
load-cfg-file slot0:TERM41.DEFAULT.loads alias TERM41.DEFAULT.loads
load-cfg-file slot0:TERM70.DEFAULT.loads alias TERM70.DEFAULT.loads
load-cfg-file slot0:Jar70.2-9-0-54dev.sbn alias Jar70.2-9-0-54dev.sbn
load-cfg-file slot0:cnu70.2-7-4-58dev.sbn alias cnu70.2-7-4-58dev.sbn
load-cfg-file slot0:CVM70.2-0-0-49dev.sbn alias CVM70.2-0-0-49dev.sbn
load-cfg-file slot0:DistinctiveRingList.xml alias DistinctiveRingList.xml sign
load-cfg-file slot0:Piano1.raw alias Piano1.raw sign
load-cfg-file slot0:S00104000100.sbn alias S00104000100.sbn
create cnf-files version-stamp 7960 Aug 13 2005 12:39:24
!
!
ephone 1
device-security-mode encrypted
cert-oper upgrade auth-mode null-string
mac-address 000C.CE3A.817C
type 7960 addon 1 7914
button 1:2 8:8
!
!
ephone 2
device-security-mode encrypted
capf-auth-str 2476
cert-oper upgrade auth-mode null-string
mac-address 0011.2111.6BDD
type 7970
button 1:1
!
!
ephone 3
device-security-mode encrypted
capf-auth-str 5425
cert-oper upgrade auth-mode null-string
mac-address 000D.299D.50DF
type 7970
button 1:3
!
!
ephone 4
device-security-mode encrypted
capf-auth-str 7176
cert-oper upgrade auth-mode null-string
mac-address 000E.D7B1.0DAC
type 7960
button 1:4
!
!
ephone 5
device-security-mode encrypted
mac-address 000F.9048.5077
type 7960
button 1:5
!
!
ephone 6
device-security-mode encrypted
mac-address 0013.C352.E7F1
type 7941GE
button 1:6
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 485
Configuring Security
Configuration Examples for Security
Secure Cisco Unified CME: Example
Router# show running-config
Building configuration...
Current configuration : 12735 bytes
!
! No configuration change since last restart
!
version 12.4
service timestamps debug datetime msec
service timestamps log datetime msec
no service password-encryption
service internal
!
hostname Router
!
boot-start-marker
boot-end-marker
!
card type e1 1 1
logging queue-limit 10000
logging buffered 9999999 debugging
logging rate-limit 10000
no logging console
!
aaa new-model
!
!
aaa accounting connection h323 start-stop group radius
!
aaa session-id common
!
resource policy
!
clock timezone IST 5
no network-clock-participate slot 1
!
!
ip cef
!
!
isdn switch-type primary-net5
!
voice-card 0
no dspfarm
!
voice-card 1
no dspfarm
!
!
ctl-client
server capf 10.13.32.11 trustpoint mytrustpoint1
server tftp 10.13.32.11 trustpoint mytrustpoint1
server cme 10.13.32.11 trustpoint mytrustpoint1
sast1 trustpoint mytrustpoint1
sast2 trustpoint sast2
!
capf-server
port 3084
auth-mode null-string
cert-enroll-trustpoint iosra password 1 mypassword
Cisco Unified Communications Manager Express System Administrator Guide
486 OL-10663-02
Configuring Security
Configuration Examples for Security
trustpoint-label mytrustpoint1
source-addr 10.13.32.11
phone-key-size 512
!
voice call debug full-guid
!
voice service voip
srtp fallback
allow-connections h323 to h323
no supplementary-service h450.2
no supplementary-service h450.3
no supplementary-service h450.7
supplementary-service media-renegotiate
h323
emptycapability
ras rrq ttl 4000
!
!
voice class codec 2
codec preference 1 g711alaw
codec preference 2 g711ulaw
!
voice class codec 3
codec preference 1 g729r8
codec preference 8 g711alaw
codec preference 9 g711ulaw
!
voice class codec 1
codec preference 1 g729r8
codec preference 2 g728
codec preference 3 g723ar63
codec preference 4 g711ulaw
!
!
voice iec syslog
voice statistics type iec
voice statistics time-range since-reset
!
!
!
crypto pki server myra
database level complete
grant auto
lifetime certificate 1800
!
crypto pki trustpoint myra
enrollment url http://10.13.32.11:80
revocation-check none
rsakeypair iosra
!
crypto pki trustpoint mytrustpoint1
enrollment url http://10.13.32.11:80
revocation-check none
rsakeypair mytrustpoint1
!
crypto pki trustpoint sast2
enrollment url http://10.13.32.11:80
revocation-check none
rsakeypair sast2
!
!
crypto pki certificate chain myra
certificate ca 01
308201F9 30820162 A0030201 02020101 300D0609 2A864886 F70D0101 04050030
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 487
Configuring Security
Configuration Examples for Security
10310E30 0C060355 04031305 696F7372 61301E17 0D303630 37303730 35343031
375A170D 30393037 30363035 34303137 5A301031 0E300C06 03550403 1305696F
73726130 819F300D 06092A86 4886F70D 01010105 0003818D 00308189 02818100
D8CE29F9 C9FDB1DD 0E1517E3 6CB4AAF7 52B83DE2 1C017ACA DFC4AF42 F9D10D08
E74BF95B 29378902 B49E32C4 85907384 84CAE4B2 7759BB84 8AB1F578 580793C4
B11A2DBE B2ED02CC DA0C3824 A5FCC377 18CE87EA C0C297BA BE54530F E62247D8
1483CD14 9FD89EFE 05DFBB37 E03FD3F8 B2B1C0B8 A1931BCC B1174A9E 6566F8F5
02030100 01A36330 61300F06 03551D13 0101FF04 05300301 01FF300E 0603551D
0F0101FF 04040302 0186301F 0603551D 23041830 168014B7 16F6FD67 29666C90
D0C62515 E14265A9 EB256230 1D060355 1D0E0416 0414B716 F6FD6729 666C90D0
C62515E1 4265A9EB 2562300D 06092A86 4886F70D 01010405 00038181 002B7F41
64535A66 D20D888E 661B9584 5E3A28DF 4E5A95B9 97E57CAE B07A7C38 7F3B60EE
75C7E5DE 6DF19B06 5F755FB5 190BABFC EF272CEF 865FE01B 1CE80F98 F320A569
CAFFA5D9 3DB3E7D8 8A86C66C F227FF81 6C4449F2 AF8015D9 8129C909 81AFDC01
180B61E8 85E19873 96DB3AE3 E6B70726 9BF93521 CA2FA906 99194ECA 8F
quit
crypto pki certificate chain mytrustpoint1
certificate 02
308201AB 30820114 A0030201 02020102 300D0609 2A864886 F70D0101 04050030
10310E30 0C060355 04031305 696F7372 61301E17 0D303630 37303730 35343233
385A170D 30393037 30363035 34303137 5A301A31 18301606 092A8648 86F70D01
09021609 32383531 2D434D45 32305C30 0D06092A 864886F7 0D010101 0500034B
00304802 4100B3ED A902646C 3851B7F6 CF94887F 0EC437E3 3B6FEDB2 2B4B45A6
3611C243 5A0759EA 1E8D96D1 60ABE028 ED6A3F2A E95DCE45 BE0921AF 82E53E57
17CC12F0 C1270203 010001A3 4F304D30 0B060355 1D0F0404 030205A0 301F0603
551D2304 18301680 14B716F6 FD672966 6C90D0C6 2515E142 65A9EB25 62301D06
03551D0E 04160414 4EE1943C EA817A9E 7010D5B8 0467E9B0 6BA76746 300D0609
2A864886 F70D0101 04050003 81810003 564A6DA1 868B2669 7C096F9A 41173CFC
E49246EE C645E30B A0753E3B E1A265D1 6EA5A829 F10CD0E8 3F2E3AD4 39D8DFE8
83525F2B D19F5E15 F27D6262 62852D1F 43629B68 86D91B5F 7B2E2C25 3BD2CCC3
00EF4028 714339B2 6A7E0B2F 131D2D9E 0BE08853 5CCAE47C 4F74953C 19305A20
B2C97808 D6E01351 48366421 A1D407
quit
certificate ca 01
308201F9 30820162 A0030201 02020101 300D0609 2A864886 F70D0101 04050030
10310E30 0C060355 04031305 696F7372 61301E17 0D303630 37303730 35343031
375A170D 30393037 30363035 34303137 5A301031 0E300C06 03550403 1305696F
73726130 819F300D 06092A86 4886F70D 01010105 0003818D 00308189 02818100
D8CE29F9 C9FDB1DD 0E1517E3 6CB4AAF7 52B83DE2 1C017ACA DFC4AF42 F9D10D08
E74BF95B 29378902 B49E32C4 85907384 84CAE4B2 7759BB84 8AB1F578 580793C4
B11A2DBE B2ED02CC DA0C3824 A5FCC377 18CE87EA C0C297BA BE54530F E62247D8
1483CD14 9FD89EFE 05DFBB37 E03FD3F8 B2B1C0B8 A1931BCC B1174A9E 6566F8F5
02030100 01A36330 61300F06 03551D13 0101FF04 05300301 01FF300E 0603551D
0F0101FF 04040302 0186301F 0603551D 23041830 168014B7 16F6FD67 29666C90
D0C62515 E14265A9 EB256230 1D060355 1D0E0416 0414B716 F6FD6729 666C90D0
C62515E1 4265A9EB 2562300D 06092A86 4886F70D 01010405 00038181 002B7F41
64535A66 D20D888E 661B9584 5E3A28DF 4E5A95B9 97E57CAE B07A7C38 7F3B60EE
75C7E5DE 6DF19B06 5F755FB5 190BABFC EF272CEF 865FE01B 1CE80F98 F320A569
CAFFA5D9 3DB3E7D8 8A86C66C F227FF81 6C4449F2 AF8015D9 8129C909 81AFDC01
180B61E8 85E19873 96DB3AE3 E6B70726 9BF93521 CA2FA906 99194ECA 8F
quit
crypto pki certificate chain sast2
certificate 03
308201AB 30820114 A0030201 02020103 300D0609 2A864886 F70D0101 04050030
10310E30 0C060355 04031305 696F7372 61301E17 0D303630 37303730 35343331
375A170D 30393037 30363035 34303137 5A301A31 18301606 092A8648 86F70D01
09021609 32383531 2D434D45 32305C30 0D06092A 864886F7 0D010101 0500034B
00304802 4100C703 840B11A7 81FCE5AE A14FE593 5114D3C2 5473F488 B8FB4CC5
41EAFA3A D99381D8 21AE6AA9 BA83A84E 9DF3E8C6 54978787 5EF6CC35 C334D55E
A3051372 17D30203 010001A3 4F304D30 0B060355 1D0F0404 030205A0 301F0603
551D2304 18301680 14B716F6 FD672966 6C90D0C6 2515E142 65A9EB25 62301D06
03551D0E 04160414 EB2146B4 EE24AA61 8B5D2F8D 2AD3B786 CBADC8F2 300D0609
2A864886 F70D0101 04050003 81810057 BA0053E9 8FD54B25 72D85A4C CAB47F26
8316F494 E94DFFB9 8E9D065C 9748465C F54719CA C7724F50 67FBCAFF BC332109
Cisco Unified Communications Manager Express System Administrator Guide
488 OL-10663-02
Configuring Security
Configuration Examples for Security
DC2FB93D 5AD86583 EDC3E648 39274CE8 D4A5F002 5F21ED3C 6D524AB7 7F5B1876
51867027 9BD2FFED 06984558 C903064E 5552015F 289BA9BB 308D327A DFE0A3B9
78CF2B02 2DD4C208 80CDC0A8 43A26A
quit
certificate ca 01
308201F9 30820162 A0030201 02020101 300D0609 2A864886 F70D0101 04050030
10310E30 0C060355 04031305 696F7372 61301E17 0D303630 37303730 35343031
375A170D 30393037 30363035 34303137 5A301031 0E300C06 03550403 1305696F
73726130 819F300D 06092A86 4886F70D 01010105 0003818D 00308189 02818100
D8CE29F9 C9FDB1DD 0E1517E3 6CB4AAF7 52B83DE2 1C017ACA DFC4AF42 F9D10D08
E74BF95B 29378902 B49E32C4 85907384 84CAE4B2 7759BB84 8AB1F578 580793C4
B11A2DBE B2ED02CC DA0C3824 A5FCC377 18CE87EA C0C297BA BE54530F E62247D8
1483CD14 9FD89EFE 05DFBB37 E03FD3F8 B2B1C0B8 A1931BCC B1174A9E 6566F8F5
02030100 01A36330 61300F06 03551D13 0101FF04 05300301 01FF300E 0603551D
0F0101FF 04040302 0186301F 0603551D 23041830 168014B7 16F6FD67 29666C90
D0C62515 E14265A9 EB256230 1D060355 1D0E0416 0414B716 F6FD6729 666C90D0
C62515E1 4265A9EB 2562300D 06092A86 4886F70D 01010405 00038181 002B7F41
64535A66 D20D888E 661B9584 5E3A28DF 4E5A95B9 97E57CAE B07A7C38 7F3B60EE
75C7E5DE 6DF19B06 5F755FB5 190BABFC EF272CEF 865FE01B 1CE80F98 F320A569
CAFFA5D9 3DB3E7D8 8A86C66C F227FF81 6C4449F2 AF8015D9 8129C909 81AFDC01
180B61E8 85E19873 96DB3AE3 E6B70726 9BF93521 CA2FA906 99194ECA 8F
quit
!
!
username admin password 0 mypassword2
username cisco password 0 mypassword2
!
!
controller E1 1/0
pri-group timeslots 1-31
!
controller E1 1/1
pri-group timeslots 1-31
gw-accounting aaa
!
!
!
!
!
interface GigabitEthernet0/0
ip address 10.13.32.11 255.255.255.0
duplex auto
speed auto
fair-queue 64 256 32
h323-gateway voip interface
h323-gateway voip id GK1 ipaddr 10.13.32.13 1719
h323-gateway voip id GK2 ipaddr 10.13.32.16 1719
h323-gateway voip h323-id 2851-CiscoUnifiedCME
h323-gateway voip tech-prefix 1#
ip rsvp bandwidth 1000 100
!
interface GigabitEthernet0/1
no ip address
shutdown
duplex auto
speed auto
!
interface Serial1/0:15
no ip address
encapsulation hdlc
isdn switch-type primary-net5
isdn protocol-emulate network
isdn incoming-voice voice
no cdp enable
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 489
Configuring Security
Configuration Examples for Security
!
interface Serial1/1:15
no ip address
encapsulation hdlc
isdn switch-type primary-net5
isdn protocol-emulate network
isdn incoming-voice voice
no cdp enable
!
ip route 0.0.0.0 0.0.0.0 10.13.32.1
!
!
ip http server
ip http authentication local
no ip http secure-server
ip http path flash:
!
!
!
!
!
!
tftp-server flash:music-on-hold.au
tftp-server flash:TERM70.DEFAULT.loads
tftp-server flash:TERM71.DEFAULT.loads
tftp-server flash:P00308000300.bin
tftp-server flash:P00308000300.loads
tftp-server flash:P00308000300.sb2
tftp-server flash:P00308000300.sbn
tftp-server flash:SCCP70.8-0-3S.loads
tftp-server flash:cvm70sccp.8-0-2-25.sbn
tftp-server flash:apps70.1-1-2-26.sbn
tftp-server flash:dsp70.1-1-2-26.sbn
tftp-server flash:cnu70.3-1-2-26.sbn
tftp-server flash:jar70sccp.8-0-2-25.sbn
radius-server host 10.13.32.241 auth-port 1645 acct-port 1646
radius-server timeout 40
radius-server deadtime 2
radius-server key cisco
radius-server vsa send accounting
!
control-plane
!
no call rsvp-sync
!
!
voice-port 1/0/0
!
voice-port 1/0/1
!
voice-port 1/0:15
!
voice-port 1/1:15
!
!
!
!
!
dial-peer voice 1 voip
destination-pattern ........
voice-class codec 2
session target ras
incoming called-number 9362....
dtmf-relay h245-alphanumeric
Cisco Unified Communications Manager Express System Administrator Guide
490 OL-10663-02
Configuring Security
Configuration Examples for Security
req-qos controlled-load audio
!
dial-peer voice 2 pots
destination-pattern 93621101
!
dial-peer voice 3 pots
destination-pattern 93621102
!
dial-peer voice 10 voip
destination-pattern 2668....
voice-class codec 1
session target ipv4:10.13.46.200
!
dial-peer voice 101 voip
shutdown
destination-pattern 5694....
voice-class codec 1
session target ipv4:10.13.32.10
incoming called-number 9362....
!
dial-peer voice 102 voip
shutdown
destination-pattern 2558....
voice-class codec 1
session target ipv4:10.13.32.12
incoming called-number 9362....
!
dial-peer voice 103 voip
shutdown
destination-pattern 9845....
voice-class codec 1
session target ipv4:10.13.32.14
incoming called-number 9362....
!
dial-peer voice 104 voip
shutdown
destination-pattern 9844....
voice-class codec 1
session target ipv4:10.13.32.15
incoming called-number 9362....
!
dial-peer voice 201 pots
destination-pattern 93625...
no digit-strip
direct-inward-dial
port 1/0:15
!
dial-peer voice 202 pots
destination-pattern 93625...
no digit-strip
direct-inward-dial
port 1/1:15
!
!
gateway
timer receive-rtp 1200
!
!
!
telephony-service
load 7960-7940 P00308000300
max-ephones 4
max-dn 4
ip source-address 10.13.32.11 port 2000
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 491
Configuring Security
Configuration Examples for Security
auto assign 1 to 4
secure-signaling trustpoint mytrustpoint1
cnf-file location flash:
cnf-file perphone
voicemail 25589000
max-conferences 4 gain -6
call-forward pattern .T
moh flash:music-on-hold.au
web admin system name admin password mypassword2
dn-webedit
time-webedit
transfer-system full-consult
transfer-pattern ........
tftp-server-credentials trustpoint mytrustpoint1
server-security-mode secure
device-security-mode encrypted
create cnf-files version-stamp 7960 Oct 25 2006 07:19:39
!
!
ephone-dn 1
number 93621000
name 2851-PH1
call-forward noan 25581101 timeout 10
!
!
ephone-dn 2
number 93621001
name 2851-PH2
call-forward noan 98441000 timeout 10
!
!
ephone-dn 3
number 93621002
name 2851-PH3
!
!
ephone-dn 4
number 93621003
name 2851-PH4
!
!
ephone 1
no multicast-moh
device-security-mode encrypted
mac-address 0012.4302.A7CC
type 7970
button 1:1
!
!
!
ephone 2
no multicast-moh
device-security-mode encrypted
mac-address 0017.94CA.9CCD
type 7960
button 1:2
!
!
!
ephone 3
no multicast-moh
device-security-mode encrypted
mac-address 0017.94CA.9833
type 7960
Cisco Unified Communications Manager Express System Administrator Guide
492 OL-10663-02
Configuring Security
Where to Go Next
button 1:3
!
!
!
ephone 4
no multicast-moh
device-security-mode none
mac-address 0017.94CA.A141
type 7960
button 1:4
!
!
!
line con 0
logging synchronous level all limit 20480000
line aux 0
line vty 0 4
!
scheduler allocate 20000 1000
ntp clock-period 17179791
ntp server 10.13.32.12
!
webvpn context Default_context
ssl authenticate verify all
!
no inservice
!
!
end
Where to Go Next
PKI Management
Cisco IOS public key infrastructure (PKI) provides certificate management to support security protocols
such as IP Security (IPsec), secure shell (SSH), and secure socket layer (SSL). For more information,
see the following documents:
• “Implementing and Managing a PKI Features Roadmap” in the Cisco IOS Security Configuration
Guide.
• Cisco IOS Security Command Reference.
Cisco VG224 Analog Phone Gateway
• To configure secure endpoints on the Cisco VG224 Analog Phone Gateway, see the “Configuring
Secure Signalling and Media Encryption on the Cisco VG224” section of the Supplementary
Services Features for FXS Ports on Cisco IOS Voice Gateways Configuration Guide, Release 12.4T.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 493
Configuring Security
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Cisco VG224 Analog Phone Gateway • Supplementary Services Features for FXS Ports on Cisco IOS
Voice Gateways Configuration Guide, Release 12.4
• Cisco VG224 Voice Gateway Software Configuration Guide
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
494 OL-10663-02
Configuring Security
Feature Information for Security
Feature Information for Security
Table 29 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 29 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 29 Feature Information for Security
Cisco Unified CME
Feature Name Version Feature Information
Media Encryption (SRTP) on 4.2 Media encryption on Cisco Unified CME was introduced.
Cisco Unified CME
Phone Authentication 4.0 Phone authentication for Cisco Unified CME phones was
introduced.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 495
Configuring Security
Feature Information for Security
Cisco Unified Communications Manager Express System Administrator Guide
496 OL-10663-02
Configuring Automatic Line Selection
Last Updated: January 2, 2008
This chapter describes automatic line selection features in Cisco Unified Communications Manager
Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Automatic Line
Selection” section on page 502.
Contents
• Information About Automatic Line Selection, page 497
• How to Configure Automatic Line Selection, page 498
• Configuration Examples for Automatic Line Selection, page 500
• Additional References, page 501
• Feature Information for Automatic Line Selection, page 502
Information About Automatic Line Selection
To enable automatic line selection, you should understand the following concept:
• Automatic Line Selection for Incoming and Outgoing Calls, page 497
Automatic Line Selection for Incoming and Outgoing Calls
On multiline IP phones, lifting the handset automatically selects the first ringing line on the phone or, if
no line is ringing, selects the first available idle line for outgoing calls. This is the default behavior for
all multiline IP phones.
Under some circumstances, however, you might want to require that a line button be explicitly pressed
to select an outgoing line or to answer an incoming call. In Cisco CME 3.0 and later, you have the
flexibility to assign the type of line selection that each IP phone uses.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 497
Configuring Automatic Line Selection
How to Configure Automatic Line Selection
The Automatic Line Selection feature allows you to specify, on a per-phone basis, the line that is
selected when you pick up a phone handset.
Any of the following behaviors can be assigned on a per-phone basis:
• Automatic line selection—Picking up the handset answers the first ringing line or, if no line is
ringing, selects the first idle line. Use the auto-line command with no keyword or argument. This
is the default.
• Manual line selection (no automatic line selection)—Pressing the Answer soft key answers the first
ringing line, and pressing a line button selects a line for an outgoing call. Picking up the handset
does not answer calls or provide dial tone. Use the no auto-line command.
• Automatic line selection for incoming calls only—Picking up the handset answers the first ringing
line, but if no line is ringing, it does not select an idle line for an outgoing call. Pressing a line button
selects a line for an outgoing call. Use the auto-line incoming command.
• Automatic line selection for outgoing calls only—Picking up the handset for an outgoing call selects
the line associated with the button-number argument. If a button number is specified and the line
associated with that button is unavailable (because it is a shared line in use on another phone), no
dial tone is heard when the handset is lifted. You must press an available line button to make an
outgoing call. Incoming calls must be answered by pressing the Answer soft key or pressing a
ringing line button. Use the auto-line command with the button-number argument.
• Automatic line selection for incoming and outgoing calls—Pressing the Answer soft key or picking
up the handset answers an incoming call on the line associated with the specified button. Picking up
the handset for outgoing calls selects the line associated with the specified button. Use the auto-line
command with the button-number argument and answer-incoming keyword.
How to Configure Automatic Line Selection
This section contains the following tasks:
• SCCP: Enabling Automatic Line Selection, page 498 (required)
• Verifying Automatic Line Selection, page 500 (optional)
SCCP: Enabling Automatic Line Selection
To enable automatic line selection for answering incoming calls or making outgoing calls, perform the
following steps:
Restrictions
Automatic line selection is bypassed if it is configured for a trunk directory number and the line is seized
by pressing the Park or Callfwd soft keys. The first available directory number is seized.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. auto-line [button-number [answer-incoming] | incoming]
Cisco Unified Communications Manager Express System Administrator Guide
498 OL-10663-02
Configuring Automatic Line Selection
How to Configure Automatic Line Selection
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number for the phone on
Example: which you want to configure automatic line selection.
Router(config)# ephone 24
Step 4 auto-line [button-number [answer-incoming] | Assigns a type of line selection behavior to this phone.
incoming]
• auto-line—Picking up the handset answers the first
ringing line or, if no line is ringing, selects the first idle
Example:
Router(config-ephone)# auto-line 5 line. This is the default.
answer-incoming • auto-line button-number—Picking up the handset for
an outgoing call selects the line associated with the
specified button. The default if this argument is not
used is the topmost available line.
• auto-line button-number answer-incoming—Picking
up the handset answers the incoming call on the line
associated with the specified button.
• auto-line incoming—Picking up the handset answers
the first ringing line but, if no line is ringing, does not
select an idle line for an outgoing call. Pressing a line
button selects a line for an outgoing call.
• no auto-line—Disables automatic line selection.
Pressing the Answer soft key answers the first ringing
line, and pressing a line button selects a line for an
outgoing call. Picking up the handset does not answer
calls or provide dial tone.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 499
Configuring Automatic Line Selection
Configuration Examples for Automatic Line Selection
Verifying Automatic Line Selection
Step 1 Use the show running-config command to verify your configuration. Automatic line selection is listed
in the ephone portion of the output.
Router# show running-config
ephone 2
headset auto-answer line 1
headset auto-answer line 4
ephone-template 1
mac-address 011F.9010.1790
paging-dn 48
type 7960
no dnd feature-ring
no auto-line
Step 2 Use the show telephony-service ephone command to display only ephone configuration information.
Router# show telephony-service ephone
ephone 4
device-security-mode none
username "Accounting"
mac-address FF0E.4857.5E91
button 1c34,35
no auto-line
Configuration Examples for Automatic Line Selection
This section contains the following example:
• Automatic Line Selection: Example, page 500
Automatic Line Selection: Example
The following example assigns no automatic line selection to phones 1 and 2 and assigns automatic line
selection for incoming calls only to phone 3:
ephone 1
mac-address 00e0.8646.9242
button 1:1 2:4 3:16
no auto-line
!
ephone 2
mac-address 01c0.4612.7142
button 1:5 2:4 3:16
no auto-line
!
ephone 3
mac-address 10b8.8945.3251
button 1:6 2:4 3:16
auto-line incoming
Cisco Unified Communications Manager Express System Administrator Guide
500 OL-10663-02
Configuring Automatic Line Selection
Additional References
The following example enables automatic selection of line button 1 when the handset is lifted to answer
incoming calls or to make outgoing calls.
ephone 1
mac-address 0001.0002.0003
type 7960
auto-line 1 answer-incoming
button 1:1 2:2 3:3
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 501
Configuring Automatic Line Selection
Feature Information for Automatic Line Selection
Feature Information for Automatic Line Selection
Table 30 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 30 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
.
Table 30 Feature Information for Automatic Line Selection
Cisco Unified CME
Feature Name Version Feature Information
Automatic Line Selection 4.0 The answer-incoming keyword was added to the auto-line
command.
3.1 The button-number argument was added to the auto-line
command.
3.0 Automatic line selection was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
502 OL-10663-02
Configuring Barge and Privacy
First Published: March 24, 2008
Last Updated: February 11, 2009
This module describes the Barge and Privacy features in a Cisco Unified Communications
Manager Express (Cisco Unified CME) system.
Contents
• Information About Barge and Privacy, page 503
• How to Configure Barge and Privacy, page 506
• Additional References, page 516
• Feature Information for Barge and Privacy, page 517
Information About Barge and Privacy
To configure Barge or Privacy features, you should understand the following concepts:
• Barge and cBarge, page 503
• Privacy and Privacy on Hold, page 505
Barge and cBarge
The Barge feature enables phone users who share a directory number to join an active call on the shared
line by pressing a soft key. When the initiator barges into a call, a conference is created between the
barge initiator, the target party, and the other party connected in the call. Parties see the call information
on their phones and, if the conference join tone is configured, hear a tone.
If a phone that is using the shared line has Privacy enabled, call information does not appear on the other
phones that share the line and the call cannot be barged. Connected parties hear the barge tone (single
beep) after the conference is set up. When a party leaves the conference, a barge leave tone is played to
the remaining parties.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 503
Configuring Barge and Privacy
Information About Barge and Privacy
Barge (SIP)
Barge uses the built-in conference bridge on the target phone (the phone that is being barged) which
limits the number of users allowed to barge. A barge conference supports up to three parties. If more
users want to join a call on a SIP shared line, cBarge must be used. The SIP phone requires the built-in
conference bridge to use Barge. Barge is supported for SIP shared-line directory numbers only.
Note If a phone user barges into a barge conference, the conference is converted to a cBarge conference.
cBarge (SCCP and SIP)
The cBarge feature uses a shared conference resource which allows more that one person to barge into
the call. A cBarge conference supports the maximum number of parties provisioned on the centralized
conference resource. The centralized conference resource must be provisioned to use cBarge. cBarge is
supported on SCCP shared octo-line directory numbers and SIP shared-line directory numbers.
When any party releases from the call, the call remains a conference call if at least three participants
remain on the line. If only two parties remain in the conference, they are reconnected as a point-to-point
call, which releases the conference bridge resources. When the target party parks the call or joins the call
with another call, the barge initiator and the other parties remain connected.
Table 31 describes the differences between Barge using a built-in conference bridge and cBarge using a
shared conference bridge.
Table 31 Barge and cBarge Call Differences between Built-In and Shared Conference Bridge-
Barge—Built-In Conference cBarge—Shared Conference
Action Bridge at Target Device Bridge
Media break occurs during No Yes
barge setup
User receives a Barge tone, if Yes Yes
configured
Displays name at barge To Barge To Barge
initiator phone
Displays name at target phone To/From Other To Barge
Displays name at other phones To/From Target To Barge
Allows second barge setup to Yes Yes
an already barged call
Maximum number of parties 3 Maximum allowed by the shared
conference resource.
Initiator releases call No media interruption occurs for Media break occurs to release the
the two original parties. shared conference bridge when
only two parties remain and to
reconnect the remaining parties as a
point-to-point call.
Cisco Unified Communications Manager Express System Administrator Guide
504 OL-10663-02
Configuring Barge and Privacy
Information About Barge and Privacy
Table 31 Barge and cBarge Call Differences between Built-In and Shared Conference Bridge-
Barge—Built-In Conference cBarge—Shared Conference
Action Bridge at Target Device Bridge
Target releases call Media break occurs to reconnect Media break occurs to release the
initiator with the other party as a shared conference bridge when
point-to-point call. only two parties remain and to
reconnect the remaining parties as a
point-to-point call.
Other party releases call All three parties are released. Media break occurs to release the
shared conference bridge when
only two parties remain and to
reconnect the remaining parties as a
point-to-point call.
Target puts call on hold and Initiator is released. Initiator and the other party remain
performs Transfer, connected.
Conference, or Call Park.
If no conference bridge is available, either built-in at the target device for barge or shared for cBarge, or
the maximum number of participants is reached, Cisco Unified CME rejects the barge request and an
error message displays on the initiating phone.
The barge and cBarge soft keys display by default when a phone user presses the shared-line button for
an active remote-in-use call. The user selects either barge or cBarge to join the shared-line call. When
there are multiple active calls on the shared line, the barge initiator can select which call to join by
highlighting the call.
You can customize the soft key display with a soft key template. For configuration information, see the
“SCCP: Configuring the cBarge Soft Key” section on page 506 or the “SIP: Enabling Barge and cBarge
Soft Keys” section on page 508.
Privacy and Privacy on Hold
The privacy feature enables phone users to block other users who share a directory number from seeing
call information, resuming a call, or barging into a call on the shared line. When a phone receives an
incoming call on a shared line, the user can make the call private by pressing the Privacy feature button,
which toggles between on and off to allow the user to alter the privacy setting on their phone. The
privacy state is applied to all new calls and current calls owned by the phone user.
Privacy is supported on SCCP octo-line directory numbers and SIP shared-line directory numbers.
Privacy is enabled for all phones in the system by default. You can disable privacy globally and enable
it only for specific phones, either individually or through an phone template. You can also enable the
privacy button on specific phones. After a phone with the privacy button enabled registers with
Cisco Unified CME, the line feature button on the phone gets labeled “Privacy,” a status icon displays,
and if the button has a monitor lamp, it lights when privacy is active. For Extension Mobility phones,
you can enable the privacy button in the user profile and logout profile.
The Privacy on Hold feature prevents other phone users from viewing call information or retrieving a
call put on hold by another phone sharing the directory number. Privacy on Hold is disabled for all
phones in the system by default. You can enable Privacy on Hold globally for all phones. To disable
Privacy on Hold on individual phones, you must disable Privacy on those phones.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 505
Configuring Barge and Privacy
How to Configure Barge and Privacy
The Privacy feature applies to all shared lines on a phone. If a phone has multiple shared lines and
Privacy is enabled, other phones cannot view or barge into calls on any of the shared lines.
For SCCP configuration information, see the “SCCP: Enabling Privacy and Privacy on Hold” section on
page 510. For SIP configuration information, see the “SIP: Enabling Privacy and Privacy on Hold”
section on page 513.
How to Configure Barge and Privacy
This section contains the following tasks:
• SCCP: Configuring the cBarge Soft Key, page 506
• SIP: Enabling Barge and cBarge Soft Keys, page 508
• SCCP: Enabling Privacy and Privacy on Hold, page 510
• SIP: Enabling Privacy and Privacy on Hold, page 513
SCCP: Configuring the cBarge Soft Key
To enable a phone user to join a call on an octo-line directory number by pressing the cBarge soft key,
perform the following steps. The cBarge soft key is enabled by default. This task is required only if you
want to change the order of the soft key display during the remote-in-use call state.
Prerequisites
• Cisco Unified CME 7.0 or a later version.
• Octo-line directory number is configured. See the “SCCP: Creating Directory Numbers” section on
page 158.
• Privacy is disabled on the phone. See the “SCCP: Enabling Privacy and Privacy on Hold” section on
page 510.
• Ad hoc hardware conference resource is configured and ready to use. See “Configuring
Conferencing” on page 753.
• Join and leave tones for hardware conference can be configured as barge entrance and exit tones.
See the “SCCP: Configuring Join and Leave Tones” section on page 766.
Restrictions
• Supported only on octo-line directory numbers.
• Not supported for meet-me conferences.
• Not supported if phone user is already connected to the same ad hoc conference on the octo-line.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-template template-tag
Cisco Unified Communications Manager Express System Administrator Guide
506 OL-10663-02
Configuring Barge and Privacy
How to Configure Barge and Privacy
4. softkeys remote-in-use {[CBarge] [Newcall]}
5. exit
6. ephone phone-tag
7. ephone-template template-tag
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-template template-tag Enters ephone-template configuration mode to create an
ephone template.
Example: • template-tag—Unique identifier for the ephone
Router(config)# ephone-template 5 template that is being created. Range: 1 to 20.
Step 4 softkeys remote-in-use {[CBarge] [Newcall]} Modifies the order and type of soft keys that display on
an IP phone during the remote-in-use call state.
Example:
Router(config-ephone-template)# softkeys
remote-in-use CBarge Newcall
Step 5 exit Exits ephone-template configuration mode.
Example:
Router(config-ephone-template)# exit
Step 6 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique number that identifies this
Example: ephone during configuration tasks.
Router(config)# ephone 12
Step 7 ephone-template template-tag Applies the ephone template to the phone.
• template-tag—Unique identifier of the ephone
Example: template that you created in Step 3.
Router(config-ephone)# ephone-template 5
Step 8 end Exits to privileged EXEC mode.
Example:
Router(config-ephone)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 507
Configuring Barge and Privacy
How to Configure Barge and Privacy
Examples
The following example shows that ephone template 5 modifies the soft keys displayed for the
remote-in-use call state and it is applied to ephone 12:
ephone-template 5
softkeys remote-in-use CBarge Newcall
softkeys hold Resume Newcall Join
softkeys connected TrnsfVM Park Acct ConfList Confrn Endcall Trnsfer Hold
max-calls-per-button 3
busy-trigger-per-button 2
!
!
ephone 12
no phone-ui speeddial-fastdial
ephone-template 5
mac-address 000F.9054.31BD
type 7960
button 1:10 2:7
SIP: Enabling Barge and cBarge Soft Keys
A phone user can join a call on a shared line by pressing the Barge or cBarge soft keys. The Barge and
cBarge soft keys are enabled by default on supported SIP phones. Perform the following steps only if
you want to change the order or appearance of soft keys displayed during the remote-in-use call state.
Prerequisites
• Cisco Unified CME 7.1 or a later version.
• Shared directory number is configured. See the “SIP: Creating Directory Numbers” section on
page 169.
• Privacy is disabled on the phone. See the “SIP: Enabling Privacy and Privacy on Hold” section on
page 513.
• Ad hoc hardware conference resource is configured and ready to use. See the "Configuring
Conferencing” section in the Cisco Unified CME System Administrator Guide.
• Join and leave tones for hardware conference can be configured as barge entrance and exit tones.
See the “SCCP: Configuring Join and Leave Tones” section in the Cisco Unified CME System
Administrator Guide.
Restrictions
• Supported only on shared lines.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register template template-tag
4. softkeys remote-in-use {[Barge] [Newcall] [cBarge]}
5. exit
Cisco Unified Communications Manager Express System Administrator Guide
508 OL-10663-02
Configuring Barge and Privacy
How to Configure Barge and Privacy
6. voice register pool phone-tag
7. template template-tag
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register template template-tag Enters ephone-template configuration mode to create an
ephone template.
Example: • template-tag—Unique identifier for the ephone
Router(config)# voice register template 5 template that is being created. Range: 1 to 10.
Step 4 softkeys remote-in-use {[Barge] [Newcall] Modifies the order and type of soft keys that display on
[cBarge]} a SIP phone during the remote-in-use call state.
Example:
Router(config-register-temp)# softkeys
remote-in-use cBarge Newcall
Step 5 exit Exits ephone-template configuration mode.
Example:
Router(config-register-temp)# exit
Step 6 voice register pool phone-tag Enters ephone configuration mode.
• phone-tag—Unique number that identifies this
Example: ephone during configuration tasks.
Router(config)# voice register pool 12
Step 7 template template-tag Applies the ephone template to the phone.
• template-tag—Unique identifier of the template that
Example: you created in Step 3
Router(config-register-pool)# template 5
Step 8 end Returns to privileged EXEC mode.
Example:
Router(config-register-pool)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 509
Configuring Barge and Privacy
How to Configure Barge and Privacy
Examples
The following example shows that ephone template 5 modifies the soft keys displayed for the
remote-in-use call state and it is applied to phone 120:
voice register template 5
softkeys hold Resume Newcall
softkeys connected Trnsfer Park Hold
softkeys remote-in-use cBarge Barge
!
voice register pool 120
id mac 0030.94C2.A22A
type 7962
number 1 dn 20
template 5
SCCP: Enabling Privacy and Privacy on Hold
To enable Privacy and Privacy on Hold on SCCP phones, perform the following steps.
• If all phones require access to privacy, leave the system-level privacy (telephony-service) command
set to enabled (default value) and leave the phone-level privacy (ephone) command set to the
default (use system value).
• If only specific phones require access to privacy, disable privacy at the system-level by using the
no privacy command in telephony-service configuration mode and enable privacy at the
phone-level by using the privacy on command in ephone or ephone-template configuration mode.
• Enable Privacy on Hold at the system-level. To disable Privacy on Hold on individual phones, you
must disable Privacy on those phones.
Prerequisites
• Cisco Unified CME 7.0 or a later version.
Restrictions
• Privacy and Privacy on Hold are supported for calls on shared octo-line directory numbers only.
• Privacy and Privacy on Hold are not supported on the Cisco Unified IP Phone 7935, 7936, 7937, or
7985, Nokia E61, analog phones connected to the Cisco VG224 or Cisco ATA, or any phone
without a display.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. privacy
5. privacy-on-hold
6. exit
7. ephone phone-tag
Cisco Unified Communications Manager Express System Administrator Guide
510 OL-10663-02
Configuring Barge and Privacy
How to Configure Barge and Privacy
8. privacy [off | on]
9. privacy-button
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 privacy (Optional) Enables privacy at the system-level for all
phones.
Example: • This command is enabled by default.
Router(config-telephony)# privacy
• To enable privacy for individual phones only,
disable privacy at the system-level with the
no privacy command and enable it for individual
phones as shown in Step 8.
Step 5 privacy-on-hold (Optional) Enables privacy on hold at the system-level
for all phones.
Example: • Blocks phone users on shared lines from viewing
Router(config-telephony)# privacy-on-hold call information or retrieving calls on hold. Default
is disabled.
Step 6 exit Exits telephony-service configuration mode.
Example:
Router(config-telephony)# exit
Step 7 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique number that identifies this
Example: ephone during configuration tasks.
Router(config)# ephone 10
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 511
Configuring Barge and Privacy
How to Configure Barge and Privacy
Command or Action Purpose
Step 8 privacy [off | on] (Optional) Modifies privacy support on the specific
phone.
Example: • off—Disables privacy on the phone.
Router(config-ephone)# privacy on
• on—Enables privacy on the phone.
• System-level privacy setting is the default. Use this
command only if you want to modify the
system-level setting in Step 4 for a specific phone.
• Using the no form of this command to reset to the
system-level value.
• This command can also be configured in
ephone-template configuration mode and applied to
one or more phones. The ephone configuration has
priority over the ephone-template configuration.
Step 9 privacy-button Enables the privacy feature button on the IP phone.
• Enable this command only on phones that share an
Example: octo-line directory number.
Router(config-ephone)# privacy-button
• This command can also be configured in
ephone-template configuration mode and applied to
one or more phones. The ephone configuration has
priority over the ephone-template configuration.
Step 10 end Exits to privileged EXEC mode.
Example:
Router(config-ephone)# end
Examples
The following example shows privacy disabled at the system-level and enabled on an individual phone.
It also shows Privacy on Hold enabled at the system-level.
telephony-service
no privacy
privacy-on-hold
max-ephones 100
max-dn 240
timeouts transfer-recall 60
voicemail 8900
max-conferences 8 gain -6
transfer-system full-consult
fac standard
!
!
ephone 10
privacy on
privacy-button
max-calls-per-button 3
busy-trigger-per-button 2
mac-address 00E1.CB13.0395
type 7960
button 1:7 2:10
Cisco Unified Communications Manager Express System Administrator Guide
512 OL-10663-02
Configuring Barge and Privacy
How to Configure Barge and Privacy
SIP: Enabling Privacy and Privacy on Hold
To enable Privacy and Privacy on Hold on SIP phones, perform the following steps.
• To enable Privacy on all phones, leave the system-level privacy (voice register global) command
set to enabled (default value) and leave the phone-level privacy (voice register pool) command set
to the default (use system value).
• To enable Privacy on specific phones only, disable privacy at the system-level by using the
no privacy command in voice register global configuration mode and enable privacy at the
phone-level by using the privacy on command in voice register pool or voice register template
configuration mode.
• To enable Privacy on Hold on all phones, enable it at the system-level with the privacy-on-hold
command. To disable Privacy on Hold on specific phones, disable Privacy on those phones using
the privacy off command in voice register pool or voice register template configuration mode.
Privacy must be enabled to support Privacy on Hold.
Prerequisites
• Cisco Unified CME 7.1 or a later version.
Restrictions
• Privacy and Privacy on Hold are supported for calls on shared-line directory numbers only.
• Privacy and Privacy on Hold are not supported on the Cisco Unified IP Phone 7935, 7936, 7937, or
7985, Nokia E6, analog phones connected to the Cisco VG224 or Cisco ATA, or any phone without
a display.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. privacy
5. privacy-on-hold
6. exit
7. voice register pool phone-tag
8. privacy {off | on}
9. privacy-button
10. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 513
Configuring Barge and Privacy
How to Configure Barge and Privacy
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters telephony-service configuration mode.
Example:
Router(config)# voice register global
Step 4 privacy (Optional) Enables privacy at the system-level for all
phones.
Example: • This command is enabled by default.
Router(config-register-global)# privacy
• To enable privacy for individual phones only,
disable privacy at the system-level with the
no privacy command and enable it for individual
phones as shown in Step 8.
Step 5 privacy-on-hold (Optional) Enables privacy on hold at the system-level
for all phones.
Example: • Blocks phone users on shared lines from viewing
Router(config-register-global)# privacy-on-hold call information or retrieving calls on hold. Default
is disabled.
Step 6 exit Exits voice register global configuration mode.
Example:
Router(config-register-global)# exit
Step 7 voice register pool phone-tag Enters voice register pool configuration mode.
• phone-tag—Unique number that identifies this
Example: phone during configuration tasks.
Router(config)# voice register pool 10
Cisco Unified Communications Manager Express System Administrator Guide
514 OL-10663-02
Configuring Barge and Privacy
How to Configure Barge and Privacy
Command or Action Purpose
Step 8 privacy {off | on} (Optional) Modifies phone-level privacy setting on this
phone. The default value is the system setting.
Example: • off—Sets privacy state to off on the phone.
Router(config-register-pool)# privacy on
• on—Sets privacy state to on for the phone
• Use this command only if you want to modify the
system-level setting in Step 4 for a specific phone.
• Using the no form of this command to reset to the
system-level value.
• This command can also be configured in voice
register template configuration mode and applied to
one or more phones. The phone configuration has
priority over the phone template configuration.
Step 9 privacy-button Enables the privacy feature button on the IP phone.
• Enable this command only on phones with a
Example: shared-line directory number.
Router(config-register-pool)# privacy-button
• This command can also be configured in voice
register template configuration mode and applied to
one or more phones. The phone configuration has
priority over the phone template configuration.
Step 10 end Returns to privileged EXEC mode.
Example:
Router(config-register-pool)# end
Examples
The following example shows privacy disabled at the system-level and enabled on an individual phone.
It also shows Privacy on Hold enabled at the system-level.
voice register global
mode cme
privacy-on-hold
no privacy
max-dn 300
max-pool 150
voicemail 8900
!
!
voice register pool 130
id mac 001A.A11B.500E
type 7941
number 1 dn 30
privacy ON
privacy-button
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 515
Configuring Barge and Privacy
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
516 OL-10663-02
Configuring Barge and Privacy
Feature Information for Barge and Privacy
Feature Information for Barge and Privacy
Table 32 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 32 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 32 Feature Information for Barge and Privacy
Cisco Unified CME
Feature Name Version Modification
Barge 7.1 Added Barge and cBarge support for SIP shared-line
directory numbers.
7.0/4.3 Added cBarge support for SCCP shared octo-line directory
numbers.
Privacy 7.1 Added support for Privacy on SIP shared-line directory
numbers.
7.0/4.3 Added support for Privacy on SCCP shared octo-line
directory numbers.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 517
Configuring Barge and Privacy
Feature Information for Barge and Privacy
Cisco Unified Communications Manager Express System Administrator Guide
518 OL-10663-02
Configuring Call Blocking
Last Updated: March 13, 2009
This chapter describes Call Blocking features in Cisco Unified Communications Manager Express
(Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Call Blocking” section
on page 536.
Contents
• Information About Call Blocking, page 519
• How to Configure Call Blocking, page 521
• Configuration Examples for Call Blocking, page 533
• Where to Go Next, page 534
• Additional References, page 535
• Feature Information for Call Blocking, page 536
Information About Call Blocking
To configure Call Blocking features, you should understand the following concepts:
• Call Blocking Based on Date and Time (After-Hours Toll Bar), page 519
• Call Blocking Override, page 520
• Class of Restriction, page 521
Call Blocking Based on Date and Time (After-Hours Toll Bar)
Call blocking to prevent unauthorized use of phones is implemented by matching dialed numbers against
a pattern of specified digits and matching the time against the time of day and day of week or date that
has been specified for Call Blocking. You can specify up to 32 patterns of digits for blocking.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 519
Configuring Call Blocking
Information About Call Blocking
When a user attempts to place a call to digits that match a pattern that has been specified for Call
Blocking during a time period that has been defined for Call Blocking, a fast busy signal is played for
approximately 10 seconds. The call is then terminated and the line is placed back in on-hook status.
The Cisco Unified CME session application accesses the current after-hours configuration and applies
it to calls originated by phones that are registered to the Cisco Unified CME router. Call blocking
applies to all IP phones in Cisco Unified CME, although individual IP phones can be exempted from all
call blocking.
In Cisco CME 3.4 and later versions, the same time-based call-blocking mechanism that is provided for
SCCP phone and on analog phones connected to SCCP-controlled analog telephone adaptors
(Cisco ATA) or SCCP-controlled foreign exchange station (FXS) ports is expanded to SIP endpoints.
In Cisco CME 3.4 and later, call-blocking configuration applies to all SCCP, H.323, SIP and POTS calls
that go through the Cisco Unified CME router. All incoming calls to the router, except calls from an
exempt phone, are also checked against the after-hours configuration.
Prior to Cisco Unified CME 4.2(1), all Call Blocking features are implemented globally and uniformly
on each phone in the system. All phones are similarly restricted according to time, date, location, and
other call blocking characteristics. Call Blocking is not supported on ephone-dns that are configured to
use the trunk feature, and Call Blocking did not apply to second-stage trunk dialing.
In Cisco Unified CME 4.2(1) and later versions, you have the flexibility to set different call block
calendars and call block patterns to phones in different departments, to block certain trunk dialing as
required, and to configure Call Blocking on a particular SCCP IP phone by creating and applying a
template to that phone.
For configuration information, see the “Configuring Call Blocking” section on page 521.
Call Blocking Override
The after-hours configuration applies globally to all dial peers in Cisco Unified CME. You can disable
the feature on phones using one of three mechanisms:
• directory number—To configure an exception for an individual directory number.
• phone-level—To configure an exception for all directory numbers associated to a Cisco Unified
IP phone regardless of any configuration for an individual directory number.
• dial peer—To configure an exception for a particular dial peer.
Individual phone users can be allowed to override call blocking associated with designated time periods
by entering personal identification numbers (PINs) that have been assigned to their phones. For IP
phones that support soft keys, such as the Cisco Unified IP Phone 7940G and the Cisco Unified IP
Phone 7960G, the call-blocking override feature allows individual phone users to override the call
blocking that has been defined for designated time periods. The system administrator must first assign
a personal identification number (PIN) to any phone that will be allowed to override Call Blocking.
Logging in to a phone with a PIN only allows the user to override call blocking that is associated with
particular time periods. Blocking patterns that are in effect 7 days a week, 24 hours a day, and they
cannot be overridden by using a PIN.
When PINs are configured for call-blocking override, they are cleared at a specific time of day or after
phones have been idle for a specific amount of time. The time of day and amount of time can be set by
the system administrator, or the defaults can be accepted.
For configuration information, see the following sections:
• “SCCP: Configuring Call Blocking Override for All Phones” section on page 525
Cisco Unified Communications Manager Express System Administrator Guide
520 OL-10663-02
Configuring Call Blocking
How to Configure Call Blocking
• “Configuring Call Blocking Exemption for a Dial Peer” section on page 524.
• “SCCP: Configuring Call Blocking Exemption for an Individual Phone” section on page 526.
• “SIP: Configuring Call Blocking Exemption for an Individual Phone or Directory Number” section
on page 527.
Class of Restriction
Class of restriction (COR) is the capability to deny certain call attempts based on the incoming and
outgoing class of restrictions provisioned on the dial peers. COR specifies which incoming dial peer can
use which outgoing dial peer to make a call. Each dial peer can be provisioned with an incoming and an
outgoing COR list.
COR functionality provides flexibility in network design by allowing users to block calls (for example,
calls to 900 numbers) and allowing different restrictions to call attempts from different originators.
For configuration information, see the “SCCP: Applying Class of Restriction to a Directory Number”
section on page 529.
How to Configure Call Blocking
This section contains the following tasks:
• Configuring Call Blocking, page 521 (required)
• Configuring Call Blocking Exemption for a Dial Peer, page 524 (optional)
• SCCP: Configuring Call Blocking Override for All Phones, page 525 (optional)
• SCCP: Configuring Call Blocking Exemption for an Individual Phone, page 526 (optional)
• SIP: Configuring Call Blocking Exemption for an Individual Phone or Directory Number, page 527
(optional)
• Verifying Call Blocking Configuration, page 528 (optional)
Class of Restriction
• SCCP: Applying Class of Restriction to a Directory Number, page 529 (required)
• SIP: Applying Class of Restriction to Directory Number, page 530 (required)
• Verifying Class of Restriction, page 531 (optional)
Configuring Call Blocking
To define blocking patterns and time periods during which calls to matching patterns are blocked for all
SCCP and SIP endpoints in Cisco Unified CME, to define blocking patterns to be matched to block calls
from PSTN lines, and to deactivate logins on SCCP phones at a specific time or for a specified time
period, perform the following steps.
Prerequisites
• Dial-peers are configured to provide PSTN access using router voice-ports or H.323/SIP trunk
connections.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 521
Configuring Call Blocking
How to Configure Call Blocking
Restrictions
• Prior to Cisco CME 3.3, Call Blocking is not supported on analog phones connected to Cisco ATAs
or FXS ports in H.323 mode.
• Prior to Cisco CME 3.4, Call Blocking is not supported on SIP IP phones connected directly in
Cisco Unified CME.
• Prior to Cisco Unified CME 4.2(1), selective Call Blocking on IP phones and PSTN trunk lines is
not supported.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. after-hours block pattern tag pattern [7-24]
5. after-hours day day start-time stop-time
6. after-hours date month date start-time stop-time
7. after-hours pstn-prefix tag pattern
8. login [timeout [minutes]] [clear time]
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony service Enters telephony service configuration mode.
Example:
Router(config)# telephony service
Step 4 after-hours block pattern pattern-tag pattern Defines pattern to be matched for blocking calls from IP
[7-24] phones.
• pattern-tag—Unique number pattern for call blocking.
Example: Define up to 32 call-blocking patterns in separate
Router(config-telephony)# after-hours block commands. Range is 1 to 32.
pattern 2 91
• This command can also be configured in
ephone-template configuration mode. The value set in
ephone-template configuration mode has priority over
the value set in telephony-service mode
Cisco Unified Communications Manager Express System Administrator Guide
522 OL-10663-02
Configuring Call Blocking
How to Configure Call Blocking
Command or Action Purpose
Step 5 after-hours date month date start-time Defines a recurring period based on date of month during
stop-time which outgoing calls that match defined block patterns are
blocked on IP phones.
Example: • Enter beginning and ending times for call blocking in
Router(config-telephony)# after-hours date jan an HH:MM format using a 24-hour clock. The stop-
1 0:00 23:59
time must be greater than the start-time. The value
24:00 is not valid. If you enter 00:00as a stop time, it is
changed to 23:59. If you enter 00:00 for both start time
and stop time, calls are blocked for the entire 24-hour
period on the specified date.
• This command can also be configured in
ephone-template configuration mode. The value set in
ephone-template configuration mode has priority over
the value set in telephony-service mode
Step 6 after-hours day day start-time stop-time Defines a recurring period based on day of the week during
which outgoing calls that match defined block patterns are
blocked on IP phones
Example:
Router(config-telephony)# after-hours day sun • Enter beginning and ending times for call blocking, in
0:00 23:59 an HH:MM format using a 24-hour clock. The stop-
time must be greater than the start-time. The value
24:00 is not valid. If you enter 00:00 as a stop time, it
is changed to 23:59. If you enter 00:00 for both start
time and stop time, calls are blocked for the entire
24-hour period on the specified day.
• This command can also be configured in
ephone-template configuration mode. The value set in
ephone-template configuration mode has priority over
the value set in telephony-service mode
Step 7 after-hours pstn-prefix tag pattern Defines the leading digits of the pattern to be skipped when
pattern matching dialed digits on a trunk ephone-dn.
Example: • tag: Unique number pattern for PSTN call blocking.
Router(config-telephony)# after-hours Define up to 4 call-blocking patterns in separate
pstn_prefix 1 9 commands. Range is 1-4.
• pattern: Identifies the unique leading digits, normally
used to dial a trunk PSTN line, that are blocked by this
configuration.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 523
Configuring Call Blocking
How to Configure Call Blocking
Command or Action Purpose
Step 8 login [timeout [minutes]] [clear time] Deactivates all user logins at a specific time or after a
designated period of idle time on a phone.
Example: • For SCCP phones only. Not supported on SIP endpoints
Router(config-telephony)# login timeout 120 in Cisco Unified CME.
clear 23:00
• minutes—(Optional) Range: 1 to 1440. Default: 60.
Before Cisco Unified CME 4.1, the minimum value for
this argument was 5 minutes.
Step 9 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Configuring Call Blocking Exemption for a Dial Peer
To allow H.323 and SIP trunk calls to utilize the voice gateway in spite of the the after-hours
configuration in Cisco Unified CME, follow the steps in this section.
SUMMARY STEPS
1. enable
2. configure terminal
3. dial-peer voice tag {pots | voatm | vofr | voip}
4. paramspace callsetup after-hours-exempt true
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 dial-peer voice tag {pots | voatm | vofr | Defines a particular dial peer, specifies the method of voice
voip} encapsulation, and enters dial-peer configuration mode.
Example:
Router(config)# dial peer voice 501 voip
Cisco Unified Communications Manager Express System Administrator Guide
524 OL-10663-02
Configuring Call Blocking
How to Configure Call Blocking
Command or Action Purpose
Step 4 paramspace callsetup after-hours-exempt true Exempts a dial peer from Call Blocking configuration.
Example:
Router(config-dialpeer)# paramspace callsetup
after-hours-exempt true
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-dialpeer)# end
or
Router(config-register-dn)# end
SCCP: Configuring Call Blocking Override for All Phones
To define the Call Blocking override code to be entered by a phone user to override all call-blocking
rules, perform the following steps.
Prerequisites
• Cisco Unified CME 4.2(1) or a later version
Restrictions
• Call Blocking override is supported only on phones that support soft-key display.
• If the after-hours override code is the same as the night-service code, after hours Call Blocking is
disabled.
• Both override codes defined in telephony-service and override codes defined in ephone-template are
enabled on all phones.
• If a global telephony-service override code overlaps an ephone-template override code and contains
more digits, an outgoing call is disabled wherever the telephony-service override code is used on
phones with the ephone template applied. For example, if the telephony-service override code is
6241 and the ephone-template override code is 62, those phones with the ephone template applied
will sound a fast busy tone if the 6241 override code is dialed.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. after-hours override-code pattern
5. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 525
Configuring Call Blocking
How to Configure Call Blocking
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony service configuration mode.
Example:
Router(config)# telephony-service
Step 4 after-hours override-code pattern Defines the pattern of digits (0-9) that overrides an
after-hours call blocking configuration.
Example: • pattern: Identifies the unique set of digits that, when
Router(config-telephony)# after-hours dialed after pressing the login soft key, can override the
override-code 1234 after-hours call blocking configuration.
• This command can also be configured in
ephone-template configuration mode. The value set in
ephone-template configuration mode has priority over
the value set in telephony-service mode
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
SCCP: Configuring Call Blocking Exemption for an Individual Phone
To exempt all directory numbers associated with an individual SCCP phone from the Call Blocking
configuration, follow the steps in this section.
Restrictions
• Call Blocking override is supported only on phones that support soft-key display.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. after-hour exempt
5. pin pin-number
Cisco Unified Communications Manager Express System Administrator Guide
526 OL-10663-02
Configuring Call Blocking
How to Configure Call Blocking
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—The unique sequence number for the phone
Example: that is to be exempt from call blocking.
Router(config)# ephone 4
Step 4 after-hour exempt Specifies that this phone is exempt from call blocking.
Phones exempted in this manner are not restricted from any
call-blocking patterns and no authentication of the phone
Example:
Router(config-ephone)# after-hour exempt
user is required.
Step 5 pin pin-number Declares a personal identification number (PIN) that is used
to log into an ephone.
Example: • pin-number—Number from four to eight digits in
Router(config-ephone)# pin 5555 length.
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
SIP: Configuring Call Blocking Exemption for an Individual Phone or Directory
Number
To exempt all extensions associated with an individual SIP phone or an individual directory number
from the Call Blocking configuration, follow the steps in this section.
Restrictions
• The Login toll-bar override is not supported on SIP IP phones; there is no pin to bypass blocking on
IP phones that are connected to Cisco Unified CME and running SIP.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 527
Configuring Call Blocking
How to Configure Call Blocking
3. voice register pool pool-tag
or
voice register dn dn-tag
4. after-hour exempt
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register pool pool-tag Enters voice register pool configuration mode to set
or parameters for specified SIP phone.
voice register dn dn-tag or
Enters voice register dn mode to define a directory number
Example: for a SIP phone, intercom line, voice port, or an MWI.
Router(config)# voice register pool 1
or
Router(config)# voice register dn 1
Step 4 after-hour exempt Exempts all numbers on a SIP phone from call blocking.
or
Example: Exempts an individual directory number from call blocking.
Router(config-register-pool)# after-hour exempt
or
Router(config-register-dn)# after-hour exempt
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-pool)# end
or
Router(config-register-dn)# end
Verifying Call Blocking Configuration
Step 1 Use the show running-config command to display an entire configuration, including call-blocking
number patterns and time periods and the phones that are marked as exempt from call blocking.
telephony-service
fxo hook-flash
load 7960-7940 P00305000600
load 7914 S00103020002
Cisco Unified Communications Manager Express System Administrator Guide
528 OL-10663-02
Configuring Call Blocking
How to Configure Call Blocking
max-ephones 100
max-dn 500
ip source-address 10.115.43.121 port 2000
timeouts ringing 10
voicemail 7189
max-conferences 8 gain -6
moh music-on-hold.au
web admin system name sys3 password sys3
dn-webedit
time-webedit
transfer-system full-consult
transfer-pattern .T
secondary-dialtone 9
after-hours block pattern 1 91900 7-24
after-hours block pattern 2 9976 7-24
after-hours block pattern 3 9011 7-24
after-hours block pattern 4 91...976.... 7-24
!
create cnf-files version-stamp 7960 Jul 13 2004 03:39:28
Step 2 Use the show ephone login command to display the login status of all phones.
Router# show ephone login
ephone 1 Pin enabled:TRUE Logged-in:FALSE
ephone 2 Pin enabled:FALSE
ephone 3 Pin enabled:FALSE
Step 3 The show voice register dial-peer command displays all the dial peers created dynamically by
SIP phones that have registered, along with configurations for after hours blocking.
SCCP: Applying Class of Restriction to a Directory Number
To apply a class of restriction to a directory number, perform the following steps.
Prerequisites
• COR lists must be created in dial peers. For information, see the “Class of Restrictions” section in
the “Dial Peer Configuration on Voice Gateway Routers” document in the Cisco IOS Voice
Configuration Library.
• Directory number to which COR is to be applied must be configured in Cisco Unified CME. For
configuration information, see “SCCP: Creating Directory Numbers” on page 158.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
4. corlist {incoming | outgoing} cor-list-name
5. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 529
Configuring Call Blocking
How to Configure Call Blocking
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode.
Example:
Router(config)# ephone-dn 12
Step 4 corlist {incoming | outgoing} Configures a COR on the dial peers associated with an ephone-dn.
cor-list-name
Example:
Router(config-ephone-dn)# corlist
outgoing localcor
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
SIP: Applying Class of Restriction to Directory Number
To apply a class of restriction to virtual dial peers for directory numbers associated with a SIP IP phone
connected to Cisco Unified CME, perform the following steps.
Prerequisites
• Cisco unified CME 3.4 or a later version.
• COR lists must be created in dial peers. For information, see the “Class of Restrictions” section in
the “Dial Peer Configuration on Voice Gateway Routers” document in the Cisco IOS Voice
Configuration Library.
• Individual phones to which COR is to be applied must be configured in Cisco Unified CME. For
configuration information, see “SIP: Creating Directory Numbers” on page 169.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register pool pool-tag
Cisco Unified Communications Manager Express System Administrator Guide
530 OL-10663-02
Configuring Call Blocking
How to Configure Call Blocking
4. cor {incoming | outgoing} cor-list-name {cor-list-number starting-number [- ending-number] |
default}
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for a SIP phone in
Cisco Unified CME.
Example:
Router(config)# voice register pool 3
Step 4 cor {incoming | outgoing} cor-list-name Configures a class of restriction (COR) for the dynamically
{cor-list-number starting-number [- created VoIP dial peers associated with directory numbers
ending-number] | default}
and specifies which incoming dial peer can use which
outgoing dial peer to make a call.
Example: • Each dial peer can be provisioned with an incoming and
Router(config-register-pool)# cor incoming
an outgoing COR list.
call91 1 91011
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-pool)# end
Verifying Class of Restriction
Step 1 Use the show running-config command or the show telephony-service ephone-dn command to verify
whether the COR lists have been applied to the appropriate ephone-dns.
Router# show running-config
ephone-dn 23
number 2835
corlist outgoing 5x
Step 2 Use the show dialplan dialpeer command to determine which outbound dial peer is matched for an
incoming call, based on the COR criteria and the dialed number specified in the command line. Use the
timeout keyword to enable matching variable-length destination patters associated with dial peers. This
can increase your chances of finding a match for the dial peer number you specify.
Router# show dialplan dialpeer 300 number 1900111
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 531
Configuring Call Blocking
How to Configure Call Blocking
VoiceOverIpPeer900
information type = voice,
description = `',
tag = 900, destination-pattern = `1900',
answer-address = `', preference=0,
numbering Type = `unknown'
group = 900, Admin state is up, Operation state is up,
incoming called-number = `', connections/maximum = 0/unlimited,
DTMF Relay = disabled,
modem passthrough = system,
huntstop = disabled,
in bound application associated: 'DEFAULT'
out bound application associated: ''
dnis-map =
permission :both
incoming COR list:maximum capability
outgoing COR list:to900
type = voip, session-target = `ipv4:1.8.50.7',
technology prefix:
settle-call = disabled
...
Time elapsed since last clearing of voice call statistics never
Connect Time = 0, Charged Units = 0,
Successful Calls = 0, Failed Calls = 0, Incomplete Calls = 0
Accepted Calls = 0, Refused Calls = 0,
Last Disconnect Cause is "",
Last Disconnect Text is "",
Last Setup Time = 0.
Matched: 19001111 Digits: 4
Target: ipv4:1.8.50.7
Step 3 Use the show dial-peer voice command to display the attributes associated with a particular dial peer.
Router# show dial-peer voice 100
VoiceEncapPeer100
information type = voice,
description = `',
tag = 100, destination-pattern = `',
answer-address = `', preference=0,
numbering Type = `unknown'
group = 100, Admin state is up, Operation state is up,
Outbound state is up,
incoming called-number = `555....', connections/maximum = 0/unlimited,
DTMF Relay = disabled,
huntstop = disabled,
in bound application associated: 'vxml_inb_app'
out bound application associated: ''
dnis-map =
permission :both
incoming COR list:maximum capability
outgoing COR list:minimum requirement
type = pots, prefix = `',
forward-digits default
session-target = `', voice-port = `',
direct-inward-dial = disabled,
digit_strip = enabled,
register E.164 number with GK = TRUE
Connect Time = 0, Charged Units = 0,
Successful Calls = 0, Failed Calls = 0, Incomplete Calls = 0
Accepted Calls = 0, Refused Calls = 0,
Last Disconnect Cause is "",
Last Disconnect Text is "",
Cisco Unified Communications Manager Express System Administrator Guide
532 OL-10663-02
Configuring Call Blocking
Configuration Examples for Call Blocking
Last Setup Time = 0.
Configuration Examples for Call Blocking
This section contains the following examples:
• Call Blocking: Example, page 533
• Class of Restriction: Example, page 533
Call Blocking: Example
The following example defines several patterns of digits for which outgoing calls are blocked. Patterns 1
and 2, which block calls to external numbers that begin with “1” and “011,” are blocked on Monday
through Friday before 7 a.m. and after 7 p.m., on Saturday before 7 a.m. and after 1 p.m., and all day
Sunday. Pattern 3 blocks calls to 900 numbers 7 days a week, 24 hours a day. The IP phone with tag
number 23 and MAC address 00e0.8646.9242 is not restricted from calling any of the blocked patterns.
telephony-service
after-hours block pattern 1 91
after-hours block pattern 2 9011
after-hours block pattern 3 91900 7-24
after-hours day mon 19:00 07:00
after-hours day tue 19:00 07:00
after-hours day wed 19:00 07:00
after-hours day thu 19:00 07:00
after-hours day fri 19:00 07:00
after-hours day sat 13:00 12:00
after-hours day sun 12:00 07:00
!
ephone 23
mac 00e0.8646.9242
button 1:33
after-hour exempt
!
ephone 24
mac 2234.1543.6352
button 1:34
The following example deactivates a phone’s login after three hours of idle time and
clears all logins at 10 p.m.:
ephone 1
pin 1000
!
telephony-service
login timeout 180 clear 2200
Class of Restriction: Example
The following example shows three dial peers for dialing local destinations, long distance, and 911.
COR list user1 can access the dial peers used to call 911 and local destinations. COR list user2 can access
all three dial peers. Ephone-dn 1 is assigned COR list user1 to call local destinations and 911, and
ephone-dn 2 is assigned COR list user2 to call 911, local destinations, and long distance.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 533
Configuring Call Blocking
Where to Go Next
dial-peer cor custom
name local
name longdistance
name 911
!
dial-peer cor list call-local
member local
!
dial-peer cor list call-longdistance
member longdistance
!
dial-peer cor list call-911
member 911
!
dial-peer cor list user1
member 911
member local
!
dial-peer cor list user2
member 911
member local
member longdistance
!
dial-peer voice 1 pots
corlist outgoing call-longdistance
destination-pattern 91..........
port 2/0/0
prefix 1
!
dial-peer voice 2 pots
corlist outgoing call-local
destination-pattern 9[2-9]......
port 2/0/0
forward-digits 7
!
dial-peer voice 3 pots
corlist outgoing call-911
destination-pattern 9911
port 2/0/0
prefix 911
!
ephone-dn 1
corlist incoming user1
corlist outgoing user1
!
ephone-dn 2
corlist incoming user2
corlist outgoing user2
Where to Go Next
After modifying a configuration for a Cisco Unified IP phone connected to Cisco Unified CME, you
must reboot the phone to make the changes take effect. For more information, see “Resetting and
Restarting Phones” on page 271.
Soft Key Control
To move or remove the Login soft key on one or more phones, create and apply an ephone template that
contains the appropriate softkeys commands.
For more information, see “Customizing Soft Keys” on page 1047.
Cisco Unified Communications Manager Express System Administrator Guide
534 OL-10663-02
Configuring Call Blocking
Additional References
Ephone-dn Templates
The corlist command can be included in an ephone-dn template that is applied to one or more
ephone-dns. For more information, see “Creating Templates” on page 1129.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 535
Configuring Call Blocking
Feature Information for Call Blocking
Feature Information for Call Blocking
Table 33 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 33 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 33 Feature Information for Call Blocking
Cisco Unified CME
Feature Name Version Feature Information
Call Blocking 4.2(1) Added support for selective call blocking on IP phones and
PSTN trunk lines.
3.4 • Support for Call Blocking on SIP IP phones connected
directly in Cisco Unified CME was introduced.
• All incoming calls to the router, except calls from an
exempt phone, are also checked against the after-hours
configuration.
3.3 Added support for Call Blocking on analog phones
connected to Cisco ATAs or FXS ports in H.323 mode.
3.0 • Call blocking based on date and time was introduced.
• Override of Call Blocking was introduced.
Class of Restriction 3.4 Added support for COR on SIP IP Phones connected
directly in Cisco Unified CME.
2.0 Class of restriction was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
536 OL-10663-02
Configuring Call Park
Last Updated: January 20, 2009
This chapter describes the call park feature in Cisco Unified Communications Manager Express
(Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Call Park” section on
page 553.
Contents
• Information About Call Park, page 537
• How to Configure Call Park, page 543
• Configuration Examples for Call Park, page 549
• Where to Go Next, page 550
• Additional References, page 551
• Feature Information for Call Park, page 553
Information About Call Park
To enable call park, you should understand the following concepts:
• Call Park Enhancements in Cisco Unified CME 7.1, page 538
• Basic Call Park, page 538
• Directed Call Park, page 540
• Park Reservation Groups, page 540
• Dedicated Call-Park Slots, page 540
• Call-Park Blocking, page 542
• Call-Park Redirect, page 542
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 537
Configuring Call Park
Information About Call Park
Call Park Enhancements in Cisco Unified CME 7.1
Cisco Unified CME 7.1 adds Call Park support for SIP phones, introduces Park Reservation Groups, and
enhances the Directed Call Park feature. Park slots can be shared among SCCP and SIP phones. For
example, a call parked on a SCCP phone can be retrieved by a SIP phone on the same
Cisco Unified CME router. Call Park features are available on SCCP and SIP phones that support the
Park soft key. The Park soft key displays on supported phones by default.
Table 34 describes how phone users park and retrieve calls in Cisco Unified CME 7.1 and later versions
compared to previous versions. For SCCP phones, the only change is in how users perform Directed Call
Park Retrieval. The Call Park method supported in previous versions of Cisco Unified CME is enabled
by default. You can change the park and retrieval method only when there are no parked calls.
Table 34 Parking and Retrieving a Call on an IP Phone
Cisco Unified CME 7.1 and Later Before Cisco Unified CME 7.1
Feature Versions (SCCP and SIP Phones)1 (SCCP Phones Only)
Call Park (Basic) Press Park soft key to park the call. Press Park soft key to park the call.
2
Call Park Retrieval Do one of the following: Do one of the following:
• Dial the park slot extension • Dial the park slot extension.
(SCCP and SIP).
• Press Pickup soft key and dial
• Press Pickup soft key and dial park-slot extension.
park-slot extension
• Press Pickup soft key and the
(SCCP only).
asterisk (*) on phone that
• Press Pickup soft key and the parked the call.
asterisk (*) on phone that
parked the call (SCCP only).
Directed Call Park Press Transfer soft key and dial Press Transfer soft key and dial
park-slot extension. park-slot extension.
Directed Call Park Retrieval Dial the retrieval FAC and Same as Basic Call Park Retrieval.
park-slot extension.
1. You must enable the call-park system application command.
2. SCCP phones support the Pickup soft key for Park Retrieval only if the service directed-pickup command is configured
(default). Otherwise, the Pickup soft key initiates Local Group Pickup.
To enable Call Park features, see the “Enabling Call Park or Directed Call Park” section on page 543.
Basic Call Park
The Call Park feature allows a phone user to place a call on hold at a special extension so it can be
retrieved from any other phone in the system. A user parks the call at the extension, known as the
call-park slot, by pressing the Park soft key. Cisco Unified CME chooses the next available call-park
slot and displays that number on the phone. A user on another phone can then retrieve the call by dialing
the extension number of the call-park slot.
Cisco Unified Communications Manager Express System Administrator Guide
538 OL-10663-02
Configuring Call Park
Information About Call Park
You can define either a single extension number or a range of extension numbers to use as call-park slots.
Each call-park slot can hold one call at a time so the number of calls that users can park is equal to the
number of slots you create. If the secondary number is used to group calls together, calls are retrieved
in the order in which they were parked; the call that has been parked the longest is the first call retrieved
from the call-park slot.
A caller who is parked in a park slot hears the music-on-hold (MOH) audio stream if the call uses the
G.711 codec or if the call uses G.729 with transcoding; otherwise, callers hear a tone on hold. Users who
attempt to park a call at a busy slot hear a busy tone.
Call-park slots can also be monitored by assigning the call-park slot to a monitor button using the
button m command. The line status shows “in use” when a call is parked in the monitored slot. A call
that is parked on the monitored call-park slot can be picked up by pressing the assigned monitor button.
You can create a call-park slot that is reserved for use by one extension by assigning that slot a number
whose last two digits are the same as the last two digits of the extension. When an extension starts to
park a call, the system searches first for a call-park slot that has the same final two digits as the extension.
If no such call-park slot exists, the system chooses an available call-park slot.
Multiple call-park slots can be created with the same extension number so that more than one call can
be parked for a particular department or group of people at a known extension number. For example, at
a hardware store, calls for the plumbing department can be parked at extension 101, calls for lighting
can be parked at 102, and so forth. Everyone in the plumbing department knows that calls parked at 101
are for them and can pick up calls from extension 101. When multiple calls are parked at the same
call-park slot number, they are picked up in the order in which they were parked; that is, the call that has
been parked the longest is the first call picked up from that call-park slot number.
If multiple call-park slots use the same extension number, you must configure each ephone-dn that uses
the extension number with the no huntstop command, except for the last ephone-dn to which calls are
sent. In addition, each ephone-dn must be configured with the preference command. The preference
numeric values must increase to match the order of the ephone-dns. That is, the lowest ephone-dn tag
park-slot must have the lowest numeric preference number, and so forth. Without the configuration of the
preference and huntstop commands, all calls that are parked after a second call has been parked will generate
a busy signal. The caller who is being transferred to park will hear a busy signal, while the phone user who
parked the call will receive no indication that the call was lost.
A reminder ring can be sent to the extension that parked the call by using the timeout keyword with the
park-slot command. The timeout keyword and argument set the interval length during which the
call-park reminder ring is timed out or inactive. If the timeout keyword is not used, no reminder ring is
sent to the extension that parked the call. The number of timeout intervals and reminder rings are
configured with the limit keyword and argument. For example, a limit of 3 timeout intervals sends 2
reminder rings (interval 1, ring 1, interval 2, ring 2, interval 3). The timeout and limit keywords and
arguments also set the maximum time that calls stay parked. For example, a timeout interval of 10
seconds and a limit of 5 timeout intervals (park-slot timeout 10 limit 5) will park calls for
approximately 50 seconds.
The reminder ring is sent only to the extension that parked the call unless the notify keyword is also used
to specify an additional extension number to receive a reminder ring. When an additional extension
number is specified using the notify keyword, the phone user at that extension can retrieve a call from
this slot by pressing the PickUp soft key and the asterisk (*) key.
You can define both the length of the timeout interval for calls parked at a call-park slot and the number
of timeout intervals that should occur before the call is either recalled or transferred. If you specify a
transfer target in the park-slot command, the call is transferred to the specified target after the timeout
intervals expire rather than to the primary number of the parking phone.
If a name has been specified for the call-park slot using the name command, that name will be displayed
on a recall or transfer rather than an extension number.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 539
Configuring Call Park
Information About Call Park
You can also specify an alternate target extension at which to transfer a parked call if the recall or
transfer target is in use (ringing or connected). For example, a call is parked at the private park slot for
the phone with the primary extension of 2001, as shown in Figure 25. After the timeouts expire, the
system attempts to recall the call to extension 2001, but that line is connected to another call. The system
then transfers the call to the alternate target, extension 3784.
Directed Call Park
The Directed Call Park feature allows a phone user to transfer a call to a specific call-park slot using the
Transfer soft key. For example, a customer calls a retail store and asks for the sporting goods department.
The operator who answers the call transfers the call to one of the park-slots associated with the sporting
goods department and pages the sporting goods department to retrieve the call. You can configure
phones that support the directed call-park Busy Lamp Field (BLF) to monitor the busy and idle status of
specific directed call-park slots.
In versions before Cisco Unified CME 4.0, callers can directly dial call-park slot numbers to be placed
in park. If another call is already parked in the slot, the caller hears a busy tone.
In Cisco Unified CME 4.0 to Cisco Unified CME 7.0, users retrieve a call from a directed call-park slot
by dialing the park-slot extension or using the PickUp soft key and dialing the park-slot extension. If no
call is parked in the slot, the caller hears a busy tone.
In Cisco Unified CME 7.1 and later versions, users retrieve a call from a directed call-park slot by dialing
a feature access code (FAC) and the number of the call-park slot.
Cisco Unified CME supports Directed Call Park from remote phones, however only phones that are local
to the directed call-park slot can retrieve a call.
Park Reservation Groups
Cisco Unified CME 7.1 and later versions allow you to assign ownership to call-park slots by using
Park Reservation Groups. A park slot configured with a park reservation group can only be used by
phones configured with the same park reservation group. A park slot without a park reservation group
can be used by any phone not assigned to a park reservation group.
In versions earlier than Cisco Unified CME 7.1, you could reserve a dedicated call-park slot for a
specific phone based on its primary line. All lines on that phone could use the dedicated park slot. The
new Park Reservation Group feature in Cisco Unified CME 7.1 provides an enhanced method of
reserving park slots that replaces the use of dedicated park slots.
Park reservation groups are not supported for directed call-park slots.
Dedicated Call-Park Slots
A dedicated, private call-park slot can be configured for an ephone using the reserved-for keyword in
the park-slot command. The dedicated call-park slot is associated with the primary extension of the
ephone. All extensions on this phone can park calls in the dedicated park slot. The extensions on this
phone are the only extensions that can park a call in the dedicated park slot. Only one call at a time can
be parked in a park slot; a busy tone is returned to any attempt to park a call in a slot that is already in use.
Calls can be parked in dedicated call-park slots using any of the following methods (the extension doing
the parking must be on a phone whose primary extension is associated with a dedicated park slot).
• With an active call, an IP phone user presses the Park soft key.
Cisco Unified Communications Manager Express System Administrator Guide
540 OL-10663-02
Configuring Call Park
Information About Call Park
• With an active call, an IP phone user presses the Transfer soft key and a standard or custom FAC
(feature access code) for the call-park feature. The standard FAC for call park is **6.
• With an active call, an analog phone user presses hookflash and the standard or custom FAC for the
call park feature.
Calls can be retrieved from dedicated call-park slots using any of the following methods:
• An IP phone user presses the Pickup soft key and dials the park-slot number.
• An IP phone user presses the New Call soft key and dials the park-slot number.
• An analog phone user lifts the handset, presses the standard or custom FAC for directed call pickup,
and dials the park-slot number. The standard FAC for directed pickup is **5.
If no dedicated park slot is found anywhere in the Cisco Unified CME system for an ephone-dn that is
attempting to park a call, the system uses the standard call-park procedure; that is, the system searches
for a preferred park slot (one with an ephone-dn number that matches the last two digits of the ephone-dn
attempting to park the call) and if none is found, uses any available call-park slot.
Figure 25 shows an example of a dedicated call-park slot.
If the configuration specifies that a call should be recalled to the parking phone after the timeout
intervals expire, the call is always returned to the phone’s primary extension number, regardless of
which extension on the phone did the parking. Figure 25 shows an ephone that is configured with the
extension numbers 2001, 2002, and 2003, and a private call-park slot at extension 3333. The private park
slot has been set up to recall calls to the parking phone when the parked call’s timeouts expire. In the
example, extension 2003 parks a call using the Park soft key. When the timeout intervals expire, the call
rings back on extension 2001.
The configuration in Figure 25 specifies that the call will recall or transfer from the park slot after 3
times the 60-second timeout, or after 180 seconds. Also, before the exhaustion of the 3 timeouts the
phone will receive reminder notifications that a parked call is waiting. The reminders are sent after each
60-second timeout interval expires (that is, at 60 seconds and at 120 seconds). You may want to set the
timeout command with a limit of 1 instead, so that the call simply parks and recalls or transfers without
sending a reminder ring.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 541
Configuring Call Park
Information About Call Park
Figure 25 Dedicated Call Park Example
2001 2 3754
2002
2003 1
Dedicated
Call-Park Slot 3
3333
1. A user on extension 2003
ephone-dn 1 parks a call using the Park
number 2001
soft key.
ephone-dn 2 2. After three intervals of 60
number 2002
seconds, the call is recalled to the
ephone-dn 3 phone’s primary number, 2001.
number 2003 3. If 2001 is busy, the call is
ephone-dn 4 transferred to 3754.
number 3333
name Park 2001
135130
park-slot reserved-for 2001 timeout 60 limit 3 recall alternate 3754
ephone 2
button 1:1 2:2 3:3
Call-Park Blocking
In Cisco Unified CME 4.0 and later versions, individual ephones can be prevented from making
transfers to call-park slots by using the transfer-park blocked command. This command prevents
transfers to park that use the Transfer soft key and a call-park slot number, while allowing call-parks
that use only the Park soft key. (To prevent use of the Park soft key, use an ephone template to remove
it from the phone. See “Customizing Soft Keys” on page 1047.)
An exception is made for phones with reserved, or dedicated, park slots. If the transfer-park blocked
command is used on an ephone that has a dedicated park slot, the phone is blocked from parking calls at
park slots other than the phone’s dedicated park slot but can still park calls at its own dedicated park slot.
Call-Park Redirect
By default, H.323 and SIP calls that use the call-park feature use hairpin call forwarding or transfer to
park calls and to pick up calls from park. The call-park system redirect command allows you to specify
that these calls should use H.450 or the SIP Refer method of call forwarding or transfer. The no form of
the command returns the system to the default behavior.
Cisco Unified Communications Manager Express System Administrator Guide
542 OL-10663-02
Configuring Call Park
How to Configure Call Park
How to Configure Call Park
This section contains the following tasks:
• Enabling Call Park or Directed Call Park, page 543
• Verifying Call Park, page 548
• Troubleshooting Call Park, page 549
Enabling Call Park or Directed Call Park
To enable Call Park on SCCP or SIP phones, perform the following steps.
Prerequisites
• SIP phones require Cisco Unified CME 7.1 or a later version.
• IP phone must support the Park soft key. The Park soft key displays by default on supported SCCP
and SIP phones. If previously disabled, you must use the softkeys connected command to enable
the Park soft key.
Restrictions
• For SIP phones, the Park soft key is not supported for Cisco Unified IP Phone 7905, 7912, 7921,
7940, or 7960.
• Park Retrieval is supported only on local phones. Phones can park calls remotely to another
Cisco Unified CME router but only phones that are registered to the local router hosting the
call-park slots can retrieve a call.
• In versions earlier than Cisco Unified CME 7.1, Call Park and Directed Call Park shared the same
call-park slots. In Cisco Unified CME 7.1 and later versions, if a user attempts to transfer a call to
a basic park slot when using Directed Call Park, Cisco Unified CME considers that a Park Retrieval.
• A user can retrieve a parked call on an SCCP phone by pressing the PickUp soft key and dialing the
extension number of the call-park slot or an asterisk (*) only if the service directed-pickup
command is enabled (default). Otherwise this initiates a local group pickup.
• Park Reservation Groups are not supported with Directed Call Park.
• Different directory numbers with the same extension number must have the same Call Park
configuration.
• Calls from H.323 trunks are not supported on SIP phones.
• Hold Pickup is not supported with the call-park system application command.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. call-park system {application | redirect}
5. fac {standard | custom dpark-retrieval custom-fac}
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 543
Configuring Call Park
How to Configure Call Park
6. exit
7. ephone-dn dn-tag
8. number number
9. park-slot [directed] [reservation-group group-number] [reserved-for extension-number]
[[timeout seconds limit count] [notify extension-number [only]] [recall] [transfer
extension-number] [alternate extension-number] [retry seconds limit count]]
10. exit
11. ephone phone-tag
or
voice register pool phone-tag
12. park reservation-group group-number
13. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 call-park system {application | redirect} Defines system parameters for the Call Park feature.
• application—Enables the Call Park and Directed Call Park
Example: features supported in Cisco Unified CME 7.1 and later
Router(config-telephony)# call-park versions.
system application
• redirect—Specifies that H.323 and SIP calls use H.450 or
the SIP Refer method of call forwarding or transfer to park
calls and pick up calls from park.
Cisco Unified Communications Manager Express System Administrator Guide
544 OL-10663-02
Configuring Call Park
How to Configure Call Park
Command or Action Purpose
Step 5 fac {standard | custom dpark-retrieval Enables standard FACs or creates a custom FAC or alias for the
custom-fac} Directed Park Retrieval feature on SCCP and SIP phones.
• Enable this command to use the Directed Park Retrieval
Example: feature in Cisco Unified CME 7.1 and later versions.
Router(config-telephony)# fac custom
dpark-retrieval #25 • standard—Enables standard FACs for all phones. Standard
FAC for Park Retrieval is **10.
• custom—Creates a custom FAC for a feature.
• custom-fac—User-defined code to dial using the keypad on
an IP or analog phone. Custom FAC can be up to
256 characters and contain numbers 0 to 9 and * and #.
Step 6 exit Returns to privileged EXEC mode.
Example:
Router(config-telephony)# exit
Step 7 ephone-dn dn-tag [dual-line] Enters ephone dn configuration mode to define a directory
number for an IP phone, intercom line, voice port, or a
message-waiting indicator (MWI).
Example:
Router(config)# ephone-dn 1 • dn-tag—Identifies a particular directory number during
configuration tasks. Range is 1 to the maximum number of
directory numbers allowed on the router platform. Type ? to
display the range.
Step 8 number number [secondary number] [no-reg Associates an extension number with this directory number.
[both | primary]]
• number—String of up to 16 digits that represents an
extension or E.164 telephone number.
Example:
Router(config-ephone-dn)# number 3001
Note The primary number must be unique for call-park slots.
Step 9 park-slot [directed] [reservation-group Creates an extension (call-park slot) at which calls can be
group-number] [reserved-for temporarily held (parked).
extension-number] [[timeout seconds limit
count] [notify extension-number [only]] • directed—(Optional) Enables Directed Call Park using this
[recall] [transfer extension-number] extension. This keyword is supported in Cisco Unified
[alternate extension-number] [retry
CME 7.1 and later versions.
seconds limit count]]
• reservation-group group-number—(Optional) Reserves this
slot for phones configured with the specified reservation
Example: group. This is the group assigned to the phone in Step 12.
Router(config-ephone-dn)# park-slot
directed
This keyword is supported in Cisco Unified CME 7.1 and
later versions.
• reserved-for extension-number—(Optional) Reserves this
slot as a private park-slot for the phone with the specified
extension number as its primary line.
Note The reservation-group and reserved-for keywords are
mutually exclusive. If you use the reservation-group
keyword, the reserved-for keyword is ignored.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 545
Configuring Call Park
How to Configure Call Park
Command or Action Purpose
Step 10 exit Exits configuration mode.
Example:
Router(config-ephone-dn)# exit
Step 11 ephone phone-tag Enters ephone configuration mode to set phone-specific
or parameters for an SCCP phone.
voice register pool phone-tag or
Enters voice register pool configuration mode to set
Example: phone-specific parameters for a SIP phone.
Router(config)# ephone 1
or • phone-tag—Unique sequence number that identifies the
phone. Range is version and platform-dependent; type ? to
Router(config)# voice register pool 1
display range.
Step 12 park reservation-group group-number (Optional) Assigns a call-park reservation group to a phone.
• group-number—Unique number that identifies the
Example: reservation group. String can contain up to 32 digits.
Router(config-ephone)# park
reservation-group 1
• This command can also be configured in ephone-template or
or voice register template configuration mode and applied to
one or more phones. The phone configuration has priority
Router(config-register-pool)# park
over the template configuration.
reservation-group 1
• This command is supported in Cisco Unified CME 7.1 and
later versions.
Step 13 end Exits configuration mode.
Example:
Router(config-ephone)# end
or
Router(config-register-pool)# end
Examples
Basic Call Park
The following example shows three basic call-park slots that can be used by either SCCP or SIP phones.
Any phone can retrieve calls parked at these extensions.
ephone-dn 23
number 8123
park-slot timeout 10 limit 2 recall
description park slot for Sales
!
ephone-dn 24
number 8124
park-slot timeout 10 limit 2 recall
description park slot for Sales
!
ephone-dn 25
number 8125
park-slot timeout 15 limit 3 recall retry 10 limit 2
description park slot for Service
Cisco Unified Communications Manager Express System Administrator Guide
546 OL-10663-02
Configuring Call Park
How to Configure Call Park
Directed Call Park
The following example shows that the enhanced Call Park and Directed Call Park features in
Cisco Unified CME 7.1 and later versions is enabled with the call-park system application command
in telephony-service configuration mode. Two call-park slots, extension 3110 and 3111, can be used to
park calls for the pharmacy using Directed Call Park.
telephony-service
load 7960-7940 P00308000500
max-ephones 100
max-dn 240
ip source-address 10.7.0.1 port 2000
cnf-file location flash:
cnf-file perphone
voicemail 8900
max-conferences 8 gain -6
call-park system application
transfer-system full-consult
fac standard
create cnf-files version-stamp 7960 Sep 25 2007 21:25:47
!
!
ephone-dn 10
number 3110
park-slot directed
description park-slot for Pharmacy
!
ephone-dn 11
number 3111
park-slot directed
description park-slot for Pharmacy
Park Reservation Groups
The following example shows park reservation groups set up for two call-park slots. Extension 8126 is
configured for group 1 and assigned to phones 3 and 4. Extension 8127 is configured for group 2 and
assigned to phones 10 and 11. When calls for the Pharmacy are parked at extension 8126, only phones 3
and 4 can retrieve them.
ephone-dn 26
number 8126
park-slot reservation-group 1 timeout 15 limit 2 transfer 8100
description park slot for Pharmacy
!
ephone-dn 27
number 8127
park-slot reservation-group 2 timeout 15 limit 2 transfer 8100
description park slot for Auto
!
!
ephone 3
park reservation-group 1
mac-address 002D.264E.54FA
type 7962
button 1:3
!
!
ephone 4
park reservation-group 1
mac-address 0030.94C3.053E
type 7962
button 1:4
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 547
Configuring Call Park
How to Configure Call Park
!
ephone 10
park reservation-group 2
mac-address 00E1.CB13.0395
type 7960
button 1:10
!
!
ephone 11
park reservation-group 2
mac-address 0016.9DEF.1A70
type 7960
button 1:11
Verifying Call Park
Step 1 Use the show running-config command to verify your configuration. Call-park slots are listed in the
ephone-dn portion of the output.
Router# show running-config
!
ephone-dn 23
number 853
park-slot timeout 10 limit 1 recall
description park slot for Sales
!
!
ephone-dn 24
number 8126
park-slot reserved-for 126 timeout 10 limit 1 transfer 8145
!
!
ephone-dn 25
number 8121 secondary 121
park-slot reserved-for 121 timeout 30 limit 1 transfer 8145
!
!
ephone-dn 26
number 8136 secondary 136
park-slot reserved-for 136 timeout 10 limit 1 recall
!
!
ephone-dn 30 dual-line
number 451 secondary 501
preference 10
huntstop channel
!
!
ephone-dn 31 dual-line
number 452 secondary 502
preference 10
huntstop channel
!
Cisco Unified Communications Manager Express System Administrator Guide
548 OL-10663-02
Configuring Call Park
Configuration Examples for Call Park
Step 2 Use the show telephony-service ephone-dn command to display call park configuration information.
Router# show telephony-service ephone-dn
ephone-dn 26
number 8136 secondary 136
park-slot reserved-for 136 timeout 10 limit 1 recall
Troubleshooting Call Park
Step 1 show ephone-dn park
Use this command to display configured call-park slots and their status.
Router# show ephone-dn park
DN 50 (1560) park-slot state IDLE
Notify to () timeout 30 limit 10
Step 2 Use the debug ephone commands to observe messages and states associated with an ephone. For more
information, see the Cisco Unified CME Command Reference.
Configuration Examples for Call Park
This section contains the following examples:
• Basic Call Park: Example, page 549
• Phone Blocked From Using Call Park: Example, page 550
• Call-Park Redirect: Example, page 550
Basic Call Park: Example
The following example creates a call-park slot with the number 1560. After a call is parked at this
number, the system provides 10 reminder rings at intervals of 30 seconds to the extension that parked
the call.
ephone-dn 50
number 1560
park-slot timeout 30 limit 10
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 549
Configuring Call Park
Where to Go Next
Phone Blocked From Using Call Park: Example
The following example prevents ephone 25 and extensions 234, 235, and 236 from parking calls at any
call-park slots.
ephone-dn 11
number 234
ephone-dn 12
number 235
ephone-dn 13
number 236
ephone 25
button 1:11 2:12 3:13
transfer-park blocked
The following example sets up a dedicated park slot for the extensions on ephone 6 and blocks transfers
to call park from extensions 2977, 2978, and 2979 on that phone. Those extensions can still park calls
at the phone’s dedicated park slot by using the Park soft key or the Transfer soft key and the FAC for call
park.
ephone-dn 3
number 2558
name Park 2977
park-slot reserved-for 2977 timeout 60 limit 3 recall alternate 3754
ephone-dn 4
number 2977
ephone-dn 5
number 2978
ephone-dn 6
number 2979
ephone 6
button 1:4 2:5 3:6
transfer-park blocked
Call-Park Redirect: Example
The following example specifies that H.323 and SIP calls that are parked should use H.450 or the SIP
Refer method to when they are parked or picked up.
telephony-service
call-park system redirect
Where to Go Next
Controlling Use of the Park Soft Key
To block the functioning of the call park (Park) soft key without removing the key display, create and
apply an ephone template that contains the features blocked command. For more information, see
“Customizing Soft Keys” on page 1047.
Cisco Unified Communications Manager Express System Administrator Guide
550 OL-10663-02
Configuring Call Park
Additional References
To remove the call park (Park) soft key from one or more phones, create and apply an ephone template
that contains the appropriate softkeys command. For more information, see “Customizing Soft Keys” on
page 1047.
Ephone Templates
The transfer-park blocked command, which blocks transfers to call-park slots, can be included in
ephone templates that are applied to individual ephones.
The Park soft key can be removed from the display of one or more phones by including the appropriate
softkeys command in an ephone template and applying the template to individual ephones.
For more information, see “Creating Templates” on page 1129.
Feature Access Codes
You can park calls using a feature access code (FAC) instead of a soft key on the phone if standard or
custom FACs have been enabled for your system. The call-park FAC is considered a transfer to a
call-park slot and therefore is valid only after the Trnsfer soft key (IP phones) or hookflash (analog
phones) has been used to initiate a transfer. The following are the standard FACs for call park:
• Dedicated park slot—Standard FAC is **6.
• Any available park slot—Standard FAC is **6 plus optional park-slot number.
For more information about FACs, see “Customizing Soft Keys” on page 1047.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 551
Configuring Call Park
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
552 OL-10663-02
Configuring Call Park
Feature Information for Call Park
Feature Information for Call Park
Table 35 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 35 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 35 Feature Information for Call Park
Cisco Unified CME
Feature Name Version Feature Information
Call Park 7.1 Adds Call Park support for SIP phones, introduces Park
Reservation Groups, and enhances Directed Call Park.
4.0 Dedicated call-park slots, alternative recall locations, and
call-park blocking were introduced. Direct calls to park
slots are now interpreted as attempts to pick up parked calls
rather than attempts to be parked at the slot.
3.2.1 Monitoring of call-park slots was introduced.
3.1 Call park was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 553
Configuring Call Park
Feature Information for Call Park
Cisco Unified Communications Manager Express System Administrator Guide
554 OL-10663-02
Call Restriction Regulations
First Published: October 7, 2009
This module describes the logical partitioning class of restriction (LPCOR) feature in Cisco Unified
Communications Manager Express (Cisco Unified CME).
Finding Feature Information
Your software release may not support all the features documented in this module. For the latest feature
information and caveats, see the release notes for your platform and software release. To find information
about the features documented in this module, and to see a list of the releases in which each feature is
supported, see the “Feature Information for LPCOR” section on page 594.
Use Cisco Feature Navigator to find information about platform support and Cisco IOS and Catalyst OS
software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An
account on Cisco.com is not required.
Contents
• Prerequisites for LPCOR, page 555
• Information About LPCOR, page 556
• How to Configure LPCOR, page 563
• Configuration Examples for LPCOR, page 581
• Additional References, page 592
• Feature Information for LPCOR, page 594
Prerequisites for LPCOR
• Cisco IOS Release 15.0(1)XA or a later release.
• Cisco Unified CME 8.0 or a later version.
Americas Headquarters:
Cisco Systems, Inc., 170 West Tasman Drive, San Jose, CA 95134-1706 USA
Call Restriction Regulations
Information About LPCOR
Information About LPCOR
To configure the LPCOR feature, you should understand the following concepts:
• LPCOR Overview, page 556
• LPCOR Policy and Resource Groups, page 557
• How LPCOR Policies are Associated with Resource Groups, page 558
• LPCOR Support for Supplementary Services, page 560
• Phone Display and Warning Tone for LPCOR, page 562
• LPCOR VSAs, page 563
LPCOR Overview
The Telecom Regulatory Authority of India (TRAI) has regulations that restrict the mixing of voice
traffic between the PSTN and VoIP networks. Previously, this required a user to have two phones to
handle both PSTN and VoIP calls; an IP phone connected to the Electronic Private Automatic Branch
Exchange (EPABX) for intra-office and inter-office VoIP calls and a separate phone connected to a
PABX for PSTN calls, as shown in Figure 1.
New regulations allow for a single network infrastructure and single EPABX to connect to both the
PSTN and VoIP networks by using a logical partitioning between the PSTN and IP leased lines.
The logical partitioning class of restriction (LPCOR) feature enables a single directory number on an
IP phone or analog phone registered to Cisco Unified CME to connect to both PSTN and VoIP calls
according to the connection restrictions specified by TRAI regulations. Cisco Unified CME can support
both VoIP and PSTN calls while restricting the mixing of voice traffic between the PSTN and VoIP
networks and preventing PSTN calls from connecting to remote locations over an IP trunk, as shown in
Figure 2.
Figure 1 Separate PBX and EPABX Systems
PABX-1 Domestic PSTN
PSTN
EPABX-2 IP Closed User Group
(CUG)
WAN
M
V
IP
IP
IP IP User desk with
two phones
Phone 1: For Phone 2: For
VoIP calling PSTN calling
4867
Cisco Unified Communications Manager Express System Administrator Guide
556 OL-10663-02
Call Restriction Regulations
Information About LPCOR
Figure 2 Single EPAPX System with PSTN and VoIP Calls Partitioning
Cisco Unified CME
logically PSTN
partitioned
PSTN Partition
CUG Partition
WAN
IP
IP
IP IP User desk with
one phone
274868
LPCOR Policy and Resource Groups
Cisco Unified CME supports a high-level class of restriction by allowing you to logically partition its
resources (PSTN trunks, IP trunks, IP phones, and analog phones) into different groups. The resources
of each group are scalable based on the voice interface, trunk group, or IP address subnet. In general,
you should not have to modify your existing dial plan to support LPCOR functionality. The dial peer
class of restriction (COR) feature remains unchanged when the LPCOR feature is added to
Cisco Unified CME.
LPCOR control is based on the location of resources, where calls are originating and terminating. You
must partition the resources of the Cisco Unified CME router into different resource groups and then
create a LPCOR policy for each group to which you want to apply call restrictions.
You create a LPCOR policy matrix for individual resource groups by defining its LPCOR policy to
either accept or reject calls that originate from any of the other resource groups. You can define one
LPCOR policy for each resource group.
The same LPCOR policy is applied to multiple directory numbers from the same resource. For example,
if multiple directory numbers are defined for a SCCP phone, the same LPCOR policy is enforced for all
calls to the different directory numbers on the SCCP phone.
In the following example, PSTN trunks, IP trunks (H.323 and SIP), analog FXS phones, and IP phones
for a Cisco Unified CME router are partitioned into five different resource groups (RG1 to RG5).
Table 1 LPCOR Policy Matrix Example
Resource Groups RG1 RG2 RG3 RG4 RG5
RG1 Yes No Yes No Yes
RG2 Yes Yes No Yes No
RG3 Yes Yes Yes Yes No
RG4 No No No Yes Yes
RG5 No Yes Yes Yes No
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 557
Call Restriction Regulations
Information About LPCOR
LPCOR validation is done at the target destination based on the configured LPCOR policy matrix. For
example:
• Call from RG1 to target RG1 is allowed
• Call from RG2 to target RG3 is not allowed
• Call from RG3 to target RG2 is allowed
• Call from RG5 to target RG5 is not allowed
Default LPCOR Policy
The default LPCOR policy means that there are no restrictions between the call source and its target
destination. When a call is presented to a target destination, Cisco Unified CME bypasses LPCOR
validation if either the incoming call is not associated with a LPCOR policy or the LPCOR policy is not
defined for the target destination.
TRAI regulations allow the same directory number on a local IP phone or SCCP analog Foreign
Exchange Station (FXS) phone in Cisco Unified CME to handle both PSTN and VoIP calls. Locally
connected phones do not have to be associated with any resource group.
How LPCOR Policies are Associated with Resource Groups
Call restrictions are applied to LPCOR resource groups based on the location of the resources. You
create LPCOR policies that define the call restrictions to apply to calls that originate or terminate at the
following types of resources.
• Analog Phones, page 558
• IP Phones, page 558
• PSTN Trunks, page 559
• VoIP Trunks, page 559
Analog Phones
TRAI regulations allow an analog FXS phone to accept both PSTN and VoIP calls if the phone is locally
registered to Cisco Unified CME. Locally connected phones do not have to be associated with any
resource group; the default LPCOR policy is applied to this phone type.
A specific LPCOR policy can be defined through the voice port or trunk group. For configuration
information, see the “Associating a LPCOR Policy with Analog Phone or PSTN Trunk Calls” section on
page 566.
IP Phones
LPCOR supports both SCCP and SIP IP phones. TRAI regulations allow an IP phone to accept both
PSTN and VoIP calls if the IP phone is registered locally to Cisco Unified CME through the LAN. If the
IP phone is registered to Cisco Unified CME through the WAN, PSTN calls must be blocked from the
remote IP phones.
If an IP phone always registers to Cisco Unified CME from the same local or remote region, the phone
is provisioned with a static LPCOR policy. For configuration information, see the “Associating a LPCOR
Policy with IP Phone or SCCP FXS Phone Calls” section on page 572.
Cisco Unified Communications Manager Express System Administrator Guide
558 OL-10663-02
Call Restriction Regulations
Information About LPCOR
If the phone is a mobile-type IP phone and moves between the local and remote regions, such as an
Extension Mobility phone, Cisco IP Communicator softphone, or a remote teleworker phone, the
LPCOR policy is provisioned dynamically based on the IP phone’s currently registered IP address. For
configuration information, see the “Associating LPCOR with Mobile Phone Calls” section on page 576.
PSTN Trunks
An incoming LPCOR resource group is associated with a PSTN trunk (digital or analog) through the
voice port or trunk group.
When a call is routed to the PSTN network, the LPCOR policy of the target PSTN trunk can block calls
from any resource group it is not explicitly configured to accept. Outgoing calls from a PSTN trunk are
associated with a LPCOR policy based on either the voice port or trunk group, whichever is configured
in the outbound POTS dial-peer.
For configuration information, see the “Associating a LPCOR Policy with Analog Phone or PSTN Trunk
Calls” section on page 566.
VoIP Trunks
An incoming VoIP trunk call (H.323 or SIP) is associated with a LPCOR policy based on the remote
IP address as follows:
Incoming H.323 trunk call
• IP address of the previous hub or originating gateway
Incoming SIP trunk call
• IP address of the originating gateway
• Hostname from the earliest Via header of an incoming INVITE message. If the hostname is in
domain name format, a DNS query is performed to resolve the name into an IP address.
Cisco Unified CME uses the resolved hostname or resolved IP address to determine the LPCOR policy
based on the entries in the IP-trunk subnet table. If the LPCOR policy cannot be found through the
IP address or hostname, the incoming H.323 or SIP trunk call is associated with the incoming LPCOR
policy configured in voice service configuration mode.
The LPCOR policy of the VoIP target is determined through the configuration of the outbound VoIP
dial-peer. The default LPCOR policy is applied to the VoIP target if an outgoing LPCOR policy is not
defined in the target VoIP dial-peer.
For configuration information, see the “Associating a LPCOR Policy with VoIP Trunk Calls” section on
page 569.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 559
Call Restriction Regulations
Information About LPCOR
LPCOR Support for Supplementary Services
Table 2 describes LPCOR support for calls using supplementary services.
Table 2 Supplementary Services Support with LPCOR
Feature Description SCCP Phone SIP Phone
Basic Call Cisco Unified CME invokes the LPCOR Yes Yes
policy validation if both the incoming call
and target destination are associated with a
LPCOR policy.
If the LPCOR policy validation fails,
cause-code 63 (no service available) or the
user-defined cause-code is returned to the
remote switch. The call can hunt to the next
destination.
Call Forward When a call is forwarded to a new Yes Yes
destination, Cisco Unified CME invokes
the LPCOR policy validation between the
source and the forwarding target. The call is
not forwarded to the target if the LPCOR
policy is restricted.
Call Transfer Blind and Consultative Call Transfer is Yes Yes
restricted if the LPCOR policy validation
fails between the transferee and transfer-to
parties.
For consultative call transfers, the reorder
tone plays and an error message displays on
the transferor phone. The call is not
disconnected between the transferee and
transferor.
Cisco Unified Communications Manager Express System Administrator Guide
560 OL-10663-02
Call Restriction Regulations
Information About LPCOR
Table 2 Supplementary Services Support with LPCOR
Feature Description SCCP Phone SIP Phone
Ad Hoc Conference Cisco Unified CME invokes the LPCOR Yes No
(software-based, 3-party) policy validation for each call joined to a
Ad Hoc Conference conference. A call is blocked from joining Yes Yes
(hardware-based) the conference if the LPCOR policy
validation fails.
The reorder tone plays and the conference
cannot complete message displays on the
IP phone that initiated the conference. The
call is resumed by the transferor who
initiated the conference.
Note If the LPCOR policy validation
fails during a blind transfer setup to
a conference bridge, the call is
released.
Note LPCOR validation is not supported
for additional call transfer or
conference operations from a
3-party software conference call.
Meet-Me Conference LPCOR policy of each conference party is Yes Yes
validated when a new call is joined to a (join only)
conference. The call is blocked from
joining the conference if the LPCOR policy
validation fails.
The reorder tone plays and the conference
cannot complete message displays on the
IP phone that initiated the Meet-Me
conference.
Call Pickup/Group Pickup Call Pickup and Pickup Groups enable Yes Yes
(Cisco Unified CME 7.1 phone users to answer a call that is ringing
and later versions) on a different extension. The pickup is
blocked if the LPCOR policy validation
between the call and the pickup phone fails.
The reorder tone plays and the unknown
number message displays on the IP phone
that attempts the call pickup.
Call Park Phone users can place a call on hold at a Yes Yes
(Cisco Unified CME 7.1 special extension so it can be retrieved by
and later versions) other phones.
Call Park Retrieval A phone is not allowed to retrieve a parked Yes Yes
call if the LPCOR policy validation fails.
The reorder tone plays and the unknown
number message displays on the IP phone
that attempts to retrieve the parked call. The
call remains parked at the call-park slot.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 561
Call Restriction Regulations
Information About LPCOR
Table 2 Supplementary Services Support with LPCOR
Feature Description SCCP Phone SIP Phone
Hunt Group Pilot Supported for sequential and longest idle Yes No
(ephone hunt group) hunt groups. The LPCOR policy validation
is performed when a call is directed to a
SCCP endpoint through the ephone
hunt-group.
Hunt Group Pilot Supported for parallel hunt groups only. A Yes Yes
(voice hunt group) hunt target can be a SCCP phone, SIP
phone, VoIP trunk, or PSTN trunk. The
LPCOR policy validation is performed
between the call and the pilot hunt target. A
call is blocked from a target if the LPCOR
policy is restricted.
Shared Line Phones with a shared directory number Yes Yes
must have the same LPCOR policy.
CBarge Phone users who share a directory number Yes Yes
can join an active call on the shared line.
Phones must have the same LPCOR policy.
Third-Party Call Control Cisco Unified CME supports out-of-dialog Yes Yes
refer (OOD-R) by a remote call-control
system. The LPCOR validation is
performed during the second outbound call
setup after the first outbound call is
established. The OOD-R request fails if the
LPCOR policy between the first and second
outbound call is restricted.
Phone Display and Warning Tone for LPCOR
Cisco Unified CME plays the reorder tone to callers when it blocks calls due to LPCOR policy
authentication. Table 3 lists the message that displays on the phone when a call is blocked.
Table 3 Message Display for Blocked LPCOR Calls
Call Block Type Phone Display Message
SCCP Phone SIP Phone
Call Transfer Unable to Transfer Transfer Failed
Conference Cannot Complete Conference
Meet-Me Conference No Screen Display Update
Pickup Unknown Number
Park Unknown Number
Cisco Unified Communications Manager Express System Administrator Guide
562 OL-10663-02
Call Restriction Regulations
How to Configure LPCOR
LPCOR VSAs
New vendor-specific attributes (VSAs) for the LPCOR policy associated with a call are included in the
call detail records (CDRs) generated by Cisco Unified CME for Remote Authentication Dial-in User
Services (RADIUS) accounting. A null value is used for call legs without an associated LPCOR policy,
which is the default LPCOR value. The incoming or outgoing LPCOR policy of a call is added to
RADIUS stop records.
Table 4 lists the new VSAs.
Table 4 VSAs Supported by Cisco Voice Calls
VSA No. Sample Value or
Attribute (Decimal) Format for Value or Text Text Description
in-lpcor-group 1 String pstn_group Logical partitioning class of
restriction (LPCOR)
resource-group policy associated
with an incoming call.
out-lpcor-group 1 String voip_group LPCOR resource-group policy
associated with an outgoing call.
How to Configure LPCOR
This section contains the following tasks:
• Defining a LPCOR Policy, page 563
• Associating a LPCOR Policy with Analog Phone or PSTN Trunk Calls, page 566
• Associating a LPCOR Policy with VoIP Trunk Calls, page 569
• Associating a LPCOR Policy with IP Phone or SCCP FXS Phone Calls, page 572
• Associating LPCOR with Mobile Phone Calls, page 576
• Verifying LPCOR Configuration, page 580
Defining a LPCOR Policy
To enable LPCOR functionality and define a policy for each resource group that requires call
restrictions, perform the following task. You can define one LPCOR policy for each resource group. Do
not create a LPCOR policy for resource groups that do not require call restrictions. A target resource
group without a LPCOR policy can accept incoming calls from any other resource group.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice lpcor enable
4. voice lpcor call-block cause cause-code
5. voice lpcor custom
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 563
Call Restriction Regulations
How to Configure LPCOR
6. group number lpcor-group
7. exit
8. voice lpcor policy lpcor-group
9. accept lpcor-group
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice lpcor enable Enables LPCOR functionality on the Cisco Unified CME
router.
Example:
Router(config)# voice lpcor enable
Step 4 voice lpcor call-block cause cause-code (Optional) Defines the cause code to use when a call is
blocked because LPCOR validation fails.
Example: • Range: 1 to 180. Default: 63
Router(config)# voice lpcor call-block cause 79 (serv/opt-unavail-unspecified). Type ? to display a
description of the cause codes.
Step 5 voice lpcor custom Defines the name and number of LPCOR resource groups
on the Cisco Unified CME router.
Example:
Router(config)# voice lpcor custom
Step 6 group number lpcor-group Adds a LPCOR resource group to the custom resource list.
• number—Group number of the LPCOR entry.
Example: Range: 1 to 64.
Router(cfg-lpcor-custom)# group 1 pstn_trunk
• lpcor-group—String that identifies the LPCOR
resource group.
Step 7 exit Exits LPCOR custom configuration mode.
Example:
Router(cfg-lpcor-custom)# exit
Step 8 voice lpcor policy lpcor-group Creates a LPCOR policy for a resource group.
• lpcor-group—Name of the resource group that you
Example: defined in Step 6.
Router(config)# voice lpcor policy pstn_trunk
Cisco Unified Communications Manager Express System Administrator Guide
564 OL-10663-02
Call Restriction Regulations
How to Configure LPCOR
Command or Action Purpose
Step 9 accept lpcor-group Allows a LPCOR policy to accept calls associated with the
specified resource group.
Example: • Default: Calls from other groups are rejected; calls
Router(cfg-lpcor-policy)# accept analog_phone from the same resource group are accepted.
• Repeat this command for each resource group whose
calls you want this policy to accept.
Step 10 end Returns to privileged EXEC mode.
Example:
Router(cfg-lpcor-policy)# end
Examples
The following example shows a LPCOR configuration where resources are partitioned into five groups.
Three of the resource groups have LPCOR policies that limit the calls they can accept. The other two
groups, ipphone_local and analog_phone, can accept calls from any of the other resource groups because
they do not have a LPCOR policy defined.
voice lpcor enable
voice lpcor call-block cause invalid-number
voice lpcor custom
group 1 pstn_trunk
group 2 analog_phone
group 3 iptrunk
group 4 ipphone_local
group 5 ipphone_remote
!
voice lpcor policy pstn_trunk
accept analog_phone
accept ipphone_local
!
voice lpcor policy iptrunk
accept analog_phone
accept ipphone_local
accept ipphone_remote
!
voice lpcor policy ipphone_remote
accept iptrunk
accept analog_phone
accept ipphone_local
The following example shows a LPCOR configuration where resources are partitioned into the following
four policy groups:
• siptrunk—Accepts all IP trunk calls.
• h323trunk—Accepts all IP trunk calls.
• pstn—Blocks all IP trunk and voice-mail calls.
• voicemail—Accepts both IP trunk and PSTN calls.
voice lpcor enable
voice lpcor custom
group 1 siptrunk
group 2 h323trunk
group 3 pstn
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 565
Call Restriction Regulations
How to Configure LPCOR
group 4 voicemail
!
voice lpcor policy siptrunk
accept h323trunk
accept voicemail
!
voice lpcor policy h323trunk
accept siptrunk
accept voicemail
!
voice lpcor policy pstn
!
voice lpcor policy voicemail
accept siptrunk
accept h323trunk
accept pstn
The following example shows a LPCOR policy that is configured to reject calls associated with itself.
Devices that belong to the local_phone resource group cannot accept calls from each other.
voice lpcor policy local_phone
no accept local_phone
accept analog_phone
Associating a LPCOR Policy with Analog Phone or PSTN Trunk Calls
To associate a LPCOR policy with calls that originate or terminate at an analog phone or PSTN trunk,
perform the following task. You can apply a specific LPCOR policy through the voice port or trunk
group to remote analog phones or to local analog phones that you do not want to associate with the
default LPCOR policy.
Note For an analog FXS phone that is locally registered to Cisco Unified CME through the LAN, see the
“Associating a LPCOR Policy with IP Phone or SCCP FXS Phone Calls” section on page 572.
Incoming calls from an analog phone or PSTN trunk are associated with a LPCOR resource group based
on the following configurations, in the order listed:
1. Voice port
2. Trunk group
Outgoing calls from an analog phone or PSTN trunk are associated with a LPCOR policy based on the
voice port or trunk group configuration in the outbound POTS dial-peer:
• If the outbound dial peer is configured with the port command, an outgoing call uses the LPCOR
policy specified in the voice port.
• If the outbound dial-peer is configured with the trunkgroup command, the call uses the LPCOR
policy specified in the trunk group.
Prerequisites
The LPCOR policy must be defined. See the “Defining a LPCOR Policy” section on page 563.
Cisco Unified Communications Manager Express System Administrator Guide
566 OL-10663-02
Call Restriction Regulations
How to Configure LPCOR
SUMMARY STEPS
1. enable
2. configure terminal
3. trunk group name
4. lpcor incoming lpcor-group
5. lpcor outgoing lpcor-group
6. exit
7. voice-port port
8. lpcor incoming lpcor-group
9. lpcor outgoing lpcor-group
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 trunk group name Enters trunk-group configuration mode to define a trunk
group.
Example:
Router(config)# trunk group isdn1
Step 4 lpcor incoming lpcor-group Associates a LPCOR resource-group policy with an
incoming call.
Example:
Router(config-trunk-group)# lpcor incoming
isdn_group1
Step 5 lpcor outgoing lpcor-group Associates a LPCOR resource-group policy with an
outgoing call.
Example:
Router(config-trunk-group)# lpcor outgoing
isdn_group1
Step 6 exit Exits LPCOR custom configuration mode.
Example:
Router(config-trunk-group)# exit
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 567
Call Restriction Regulations
How to Configure LPCOR
Command or Action Purpose
Step 7 voice-port port Enters voice-port configuration mode.
• Port argument is platform-dependent; type ? to display
Example: syntax.
Router(config)# voice-port 0/1/0
Step 8 lpcor incoming lpcor-group Associates a LPCOR resource-group policy with an
incoming call.
Example:
Router(config-voiceport)# lpcor incoming
vp_group3
Step 9 lpcor outgoing lpcor-group Associates a LPCOR resource-group policy with an
outgoing call.
Example:
Router(config-voiceport)# lpcor outgoing
vp_group3
Step 10 end Returns to privileged EXEC mode.
Example:
Router(config-voiceport)# end
Examples
PSTN Trunks
The following example shows a configuration for a PSTN trunk. Outbound calls from dial peer 201 use
LPCOR policy isdn_group1 because dial peer 201 is configured with trunk group isdn1. Outbound calls
from dial peer 202 use LPCOR policy vp_group3 because dial peer 202 is configured with voice port
3/1:15. A dial peer can be configured with either a voice port or trunk group; it cannot use both.
trunk group isdn1
lpcor incoming isdn_group1
lpcor outgoing isdn_group1
!
interface Serial2/0:15
isdn incoming-voice voice
trunk-group isdn1
...
voice-port 3/1:15
lpcor incoming vp_group3
lpcor outgoing vp_group3
!
!
dial-peer voice 201 pots
description TG outbound dial-peer
destination-pattern 201T
trunkgroup isdn1
!
dial-peer voice 202 pots
description VP outbound dial-peer
destination-pattern 202T
port 3/1:15
Cisco Unified Communications Manager Express System Administrator Guide
568 OL-10663-02
Call Restriction Regulations
How to Configure LPCOR
Analog Phones
The following example shows a LPCOR configuration for analog phones:
trunk group analog1
lpcor incoming analog_group1
lpcor outgoing analog_group1
!
voice-port 1/0/0
!
voice-port 1/0/1
!
voice-port 1/1/0
lpcor incoming vp_group1
lpcor outgoing vp_group1
!
dial-peer voice 100 pots
description VP dial-peer
destination-pattern 100
port 1/0/0
!
dial-peer voice 101 pots
description VP dial-peer
destination-pattern 101
port 1/0/1
!
dial-peer voice 110 pots
description VP dial-peer
destination-pattern 110
port 1/1/0
!
dial-peer voice 300 pots
description TG outbound dial-peer
destination-pattern 300
trunk-group analog1
Associating a LPCOR Policy with VoIP Trunk Calls
To associate a LPCOR policy with calls that originate or terminate at a VoIP trunk (H.323 or SIP),
perform the following task.
Incoming VoIP trunk calls are associated with a LPCOR policy based on the following configurations,
in the order listed:
1. IP-trunk subnet table
2. Voice service voip configuration
Outgoing VoIP trunk calls are associated with a LPCOR policy based on the following configurations,
in the order listed:
1. Outbound VoIP dial peer
2. Default LPCOR policy (no LPCOR policy is applied)
Prerequisites
The LPCOR policy must be defined. See the “Defining a LPCOR Policy” section on page 563.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 569
Call Restriction Regulations
How to Configure LPCOR
Restrictions
• The LPCOR IP-trunk subnet table is not supported for calls with an IPv6 address. The LPCOR
policy specified with the lpcor incoming command in voice service configuration mode is
supported for IPv6 trunk calls.
• Only a single LPCOR policy is applied to outgoing IP trunk calls if the outbound VoIP dial-peer is
configured with the session target command using the sip-server or ras keyword.
• If a dial peer COR and LPCOR are both defined in a dial peer, the dial peer COR configuration has
priority over LPCOR. For example, if the dial peer COR restricts the call and LPCOR allows the
call, the call fails because of the dial peer COR before ever considering LPCOR.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice lpcor ip-trunk subnet incoming
4. index index-number lpcor-group {ipv4-address network-mask | hostname hostname}
5. exit
6. voice service voip
7. lpcor incoming lpcor-group
8. exit
9. dial-peer voice tag voip
10. lpcor outgoing lpcor-group
11. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice lpcor ip-trunk subnet incoming Creates a LPCOR IP-trunk subnet table for incoming calls
from a VoIP trunk.
Example:
Router(config)# voice lpcor ip-trunk subnet
incoming
Cisco Unified Communications Manager Express System Administrator Guide
570 OL-10663-02
Call Restriction Regulations
How to Configure LPCOR
Command or Action Purpose
Step 4 index index-number lpcor-group {ipv4-address Adds a LPCOR resource group to the IP trunk subnet table.
network-mask | hostname hostname}
Example:
Router(cfg-lpcor-iptrunk-subnet)# index 1
h323_group1 172.19.33.0 255.255.255.0
Step 5 exit Exits LPCOR custom configuration mode.
Example:
Router(cfg-lpcor-iptrunk-subnet)# exit
Step 6 voice service voip Enters voice-service configuration mode to specify the
VoIP encapsulation type.
Example:
Router(config)# voice service voip
Step 7 lpcor incoming lpcor-group Associates a LPCOR resource-group policy with an
incoming call.
Example:
Router(conf-voi-serv)# lpcor incoming
voip_trunk_1
Step 8 exit Exits voice-service configuration mode.
Example:
Router(conf-voi-serv)# exit
Step 9 dial-peer voice tag voip Enters dial-peer configuration mode to define a dial peer for
VoIP calls.
Example:
Router(config)# dial-peer voice 233 voip
Step 10 lpcor outgoing lpcor-group Associates a LPCOR resource-group policy with an
outgoing call.
Example:
Router(config-dial-peer)# lpcor outgoing
h323_group1
Step 11 end Returns to privileged EXEC mode.
Example:
Router(config-dial-peer)# end
Examples
The following example shows a LPCOR configuration for VoIP trunks:
voice lpcor ip-trunk subnet incoming
index 1 h323_group1 172.19.33.0 255.255.255.0
index 2 sip_group1 172.19.22.0 255.255.255.0
index 3 sip_group2 hostname sipexample
!
voice service voip
lpcor incoming voip_trunk_1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 571
Call Restriction Regulations
How to Configure LPCOR
!
dial-peer voice 233 voip
description H323 trunk outbound dial-peer
destination-pattern 233T
session target ipv4:172.19.33.233
lpcor outgoing h323_group1
!
dial-peer voice 2255 voip
description SIP trunk outbound dial-peer
destination-pattern 255T
session protocol sipv2
session target ipv4:172.19.33.255
lpcor outgoing sip_group1
Associating a LPCOR Policy with IP Phone or SCCP FXS Phone Calls
To associate a LPCOR policy with calls that originate or terminate at a local or remote IP phone or local
SCCP analog (FXS) phone, perform the following task.
According to TRAI requirements, an IP phone or a SCCP FXS phone can accept both PSTN and VoIP
calls if it is locally registered to Cisco Unified CME through the LAN. If a phone is registered to
Cisco Unified CME through the WAN, then PSTN calls must be blocked from that remote phone.
Prerequisites
• The LPCOR policy must be defined. See the “Defining a LPCOR Policy” section on page 563.
• SCCP FXS phones are configured with the type anl command.
Restrictions
• Phones that share a directory number must be configured with the same LPCOR policy. A warning
message displays if you try to configure a different LPCOR policy between IP phones that share the
same directory number.
• Local and remote IP phones cannot use the same LPCOR policy.
• Software-based three-party ad hoc conferencing is not supported on SIP phones.
• Hardware-based ad hoc conferening is not supported on SIP phones.
• LPCOR feature is not supported on voice gateways such as the Cisco VG224 or Cisco integrated
service router if the voice gateway is registered to Cisco Unified Communications Manager.
Cisco Unified Communications Manager does not support LPCOR.
• If a third-party call-control application makes two separate calls to Cisco Unified CME and
performs a media bridging between the two calls, LPCOR validation is not supported because
Cisco Unified CME is not aware of the bridging.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
or
voice register pool phone-tag
Cisco Unified Communications Manager Express System Administrator Guide
572 OL-10663-02
Call Restriction Regulations
How to Configure LPCOR
4. lpcor type {local | remote}
5. lpcor incoming lpcor-group
6. lpcor outgoing lpcor-group
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode to set phone-specific
or parameters for an SCCP phone.
voice register pool phone-tag or
Enters voice register pool configuration mode to set
Example: phone-specific parameters for a SIP phone.
Router(config)# ephone 2
or • phone-tag—Unique sequence number that identifies
the phone. Range is version and platform-dependent;
Router(config)# voice register pool 4
type ? to display range.
Step 4 lpcor type {local | remote} Sets the LPCOR type for an IP phone.
• local—IP phone always registers to
Example: Cisco Unified CME through the LAN.
Router(config-ephone)# lpcor type remote
• remote—IP phone always registers to
or
Cisco Unified CME through the WAN.
Router(config-register-pool)# lpcor type local
• This command can also be configured in
ephone-template or voice register template
configuration mode and applied to one or more phones.
The phone configuration has precedence over the
template configuration.
Step 5 lpcor incoming lpcor-group Associates a LPCOR resource-group policy with an
incoming call.
Example: • If this phone shares a directory number with another
Router(config-ephone)# lpcor incoming phone, you cannot configure a LPCOR policy that is
ephone_group1 different than the LPCOR policy on the other phone.
or
• This command can also be configured in
Router(config-register-pool)# lpcor incoming
ephone-template or voice register template
remote_group3
configuration mode and applied to one or more phones.
The phone configuration has precedence over the
template configuration.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 573
Call Restriction Regulations
How to Configure LPCOR
Command or Action Purpose
Step 6 lpcor outgoing lpcor-group Associates a LPCOR resource-group policy with an
outgoing call.
Example: • If this phone shares a directory number with another
Router(config-ephone)# lpcor outgoing phone, you cannot configure a LPCOR policy that is
ephone_group2 different than the LPCOR policy on the other phone.
or
• This command can also be configured in
Router(config-register-pool)# lpcor outgoing
ephone-template or voice register template
remote_group3
configuration mode and applied to one or more phones.
The phone configuration has precedence over the
template configuration.
Step 7 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
or
Router(config-register-pool)# end
Examples
SCCP
The following example shows a LPCOR configuration for two SCCP phones. One configuration is
applied directly to the phone and the other is applied through a phone template:
ephone-template 1
lpcor type local
lpcor incoming ephone_group1
lpcor outgoing ephone_group1
!
ephone 1
mac-address 00E1.CB13.0395
ephone-template 1
type 7960
button 1:1
!
ephone 2
lpcor type remote
lpcor incoming ephone_group2
lpcor outgoing ephone_group2
mac-address 001C.821C.ED23
type 7960
button 1:2
SIP
The following example shows a LPCOR configuration for two SIP phones:
voice register template 1
lpcor type local
lpcor incoming test_group
lpcor outgoing test_group
!
voice register pool 3
id mac 001B.D584.E80A
type 7960
Cisco Unified Communications Manager Express System Administrator Guide
574 OL-10663-02
Call Restriction Regulations
How to Configure LPCOR
number 1 dn 2
template 1
codec g711ulaw
!
voice register pool 4
lpcor type remote
lpcor incoming remote_group3
lpcor outgoing remote_group3
id mac 0030.94C2.9A55
type 7960
number 1 dn 2
dtmf-relay rtp-nt
SCCP FXS Analog
The following example shows a LPCOR configuration for two SCCP FXS phones connected to a
Cisco VG224 and controlled by Cisco Unified CME:
dial-peer voice 102 pots
service stcapp
port 1/0/2
!
ephone 5
lpcor type local
lpcor incoming analog_vg224
lpcor outgoing analog_vg224
mac-address F9E5.8B28.2402
ephone-template 1
max-calls-per-button 2
type anl
button 1:5
!
ephone 6
lpcor type local
lpcor incoming analog_vg224
lpcor outgoing analog_vg224
mac-address F9E5.8B28.2403
ephone-template 1
max-calls-per-button 2
type anl
button 1:6
!
Figure 3 shows an example of a network with SCCP FXS phones managed by Cisco Unified CME.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 575
Call Restriction Regulations
How to Configure LPCOR
Figure 3 SCCP FXS Phones Managed by Cisco Unified CME
PSTN
IP Cisco Unified CME
IP
IP
Cisco VG224
252570
SCCP FXS analog phones
Associating LPCOR with Mobile Phone Calls
To associate a LPCOR policy with calls that originate or terminate at a mobile-type phone, perform the
following task.
A mobile-type phone can register to Cisco Unified CME through either the LAN or WAN. For example
an Extension Mobility phone, Cisco IP Communicator softphone, or a remote teleworker phone.
Incoming and outgoing calls to and from a mobile-type phone are associated with a LPCOR policy based
on the following configurations, in the order listed:
1. IP-phone subnet table
2. Default LPCOR policy for mobile-type phones
Prerequisites
The LPCOR policy must be defined. See the “Defining a LPCOR Policy” section on page 563.
Restrictions
The LPCOR IP-phone subnet table is not supported for calls with an IPv6 address.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
or
voice register pool phone-tag
4. lpcor type mobile
5. exit
Cisco Unified Communications Manager Express System Administrator Guide
576 OL-10663-02
Call Restriction Regulations
How to Configure LPCOR
6. voice lpcor ip-phone subnet {incoming | outgoing}
7. index index-number lpcor-group {ipv4-address network-mask [vrf vrf-name] | dhcp-pool
pool-name}
8. exit
9. voice lpcor ip-phone mobility {incoming | outgoing} lpcor-group
10. exit
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode to set phone-specific
or parameters for an SCCP phone.
voice register pool phone-tag or
Enters voice register pool configuration mode to set
Example: phone-specific parameters for a SIP phone.
Router(config)# ephone 1
or • phone-tag—Unique sequence number that identifies
the phone. Range is version and platform-dependent;
Router(config)# voice register pool 1
type ? to display range.
Step 4 lpcor type mobile Sets the LPCOR type for a mobile-type phone.
• This command can also be configured in
Example: ephone-template or voice register template
Router(config-ephone)# lpcor type mobile configuration mode and applied to one or more phones.
The phone configuration has precedence over the
template configuration.
Step 5 exit Exits the phone configuration.
Example:
Router(config-ephone)# exit
Step 6 voice lpcor ip-phone subnet {incoming | Creates a LPCOR IP-phone subnet table for calls to or from
outgoing} a mobile-type phone.
Example:
Router(config)# voice lpcor ip-phone subnet
incoming
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 577
Call Restriction Regulations
How to Configure LPCOR
Command or Action Purpose
Step 7 index index-number lpcor-group {ipv4-address Adds a LPCOR group to the IP-phone subnet table.
network-mask [vrf vrf-name] | dhcp-pool
pool-name}
Example:
Router(cfg-lpcor-ipphone-subnet)# index 1
local_group1 dhcp-pool pool1
Step 8 exit Exits LPCOR IP-phone configuration mode.
Example:
Router(cfg-lpcor-ipphone-subnet)# exit
Step 9 voice lpcor ip-phone mobility {incoming | Sets the default LPCOR policy for mobile-type phones.
outgoing} lpcor-group
Example:
Router(config)# voice lpcor ip-phone mobility
incoming remote_group1
Step 10 exit Exits to privileged EXEC mode.
Example:
Router(config)# exit
Examples
The following example shows the configuration for three mobile-type phones:
ephone 270
lpcor type mobile
mac-address 1234.4321.6000
type 7960
button 1:6
mtp
codec g729r8 dspfarm-assist
description teleworker remote phone
ephone 281
lpcor type mobile
mac-address 0003.4713.5554
type CIPC
button 1:5
...
voice register pool 6
lpcor type mobile
id mac 0030.94C2.9A66
type 7960
number 1 dn 3
dtmf-relay rtp-nte
Cisco Unified Communications Manager Express System Administrator Guide
578 OL-10663-02
Call Restriction Regulations
How to Configure LPCOR
The following example shows a LPCOR IP-phone subnet configuration with a single shared IP address
pool. Any mobile-type IP phones with a shared IP address from DHCP pool1 are considered local IP
phones and are associated with the local_group1 LPCOR policy. Other mobile-type IP phones without
a shared IP address are considered remote IP phones and are associated with remote_group1, the default
LPCOR policy for mobile-type phones.
ip dhcp pool pool1
network 10.0.0.0 255.255.0.0
option 150 ip 10.0.0.1
default-router 10.0.0.1
!
!
voice lpcor ip-phone subnet incoming
index 1 local_group1 dhcp-pool pool1
!
voice lpcor ip-phone subnet outgoing
index 1 local_group1 dhcp-pool pool1
!
voice lpcor ip-phone mobility incoming remote_group1
voice lpcor ip-phone mobility outgoing remote_group1
The following example shows a LPCOR IP-phone subnet configuration with a separate IP address DHCP
pools. Any mobile-type IP phones with separate DHCP pools are considered local IP phones and are
assigned the local_group1 LPCOR policy. Other mobile-type IP phones without a DHCP address are
considered remote IP phones and are assigned the remote_group1 LPCOR policy.
ip dhcp pool client1
network 10.0.0.0 255.255.0.0
mac-address 0003.4713.5554
option 150 ip 10.0.0.1
default-router 10.0.0.1
!
ip dhcp pool client2
network 10.0.0.0 255.255.0.0
mac-address 0030.94C2.9A66
option 150 ip 10.0.0.1
default-router 10.0.0.1
!
!
voice lpcor ip-phone subnet incoming
index 1 local_group1 dhcp-pool client1
index 2 local_group1 dhcp-pool client2
!
voice lpcor ip-phone subnet outgoing
index 1 local_group1 dhcp-pool client1
index 2 local_group1 dhcp-pool client2
!
voice lpcor ip-phone mobility incoming remote_group1
voice lpcor ip-phone mobility outgoing remote_group1
The following example shows a LPCOR IP phone subnet configuration with both an IP address network
mask and a single shared-address DHCP pool. A specific LPCOR policy can be associated with an IP
phone by matching the IP address network mask in the IP-phone subnet table. LPCOR policy
local_group2 is associated with the local IP phone with IP address 10.0.10.23. LPCOR local_group2 is
associated with the other local IP phones through the DHCP-pool match.
ip dhcp pool pool1
network 10.0.0.0 255.255.0.0
option 150 ip 10.0.0.1
default-router 10.0.0.1
!
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 579
Call Restriction Regulations
How to Configure LPCOR
voice lpcor ip-phone subnet incoming
index 1 local_g2 10.0.10.23 255.255.255.0 vrf vrf-group2
index 2 remote_g2 172.19.0.0 255.255.0.0
index 3 local_g1 dhcp-pool pool1
!
voice lpcor ip-phone subnet outgoing
index 1 local_g4 10.1.10.23 255.255.255.0 vrf vrf-group2
index 2 remote_g4 172.19.0.0 255.255.0.0
index 3 local_g5 dhcp-pool pool1
!
voice lpcor ip-phone mobility incoming remote_g1
voice lpcor ip-phone mobility outgoing remote_g1
Verifying LPCOR Configuration
Use the following show commands to display LPCOR configuration information and to verify the LPCOR
policy associated with calls.
• show call active voice—Displays the LPCOR information for incoming and outgoing call legs
(VoIP, ephone, SIP, PSTN).
• show call history voice—Displays the LPCOR information for incoming and outgoing call legs
(VoIP, ephone, SIP, PSTN). Also displays the LPCOR call-block cause code if the call is blocked
due to LPCOR policy validation.
• show dial-peer voice—Displays configuration settings for voice dial peers including the LPCOR
setting for incoming and outgoing calls.
• show trunk group—Displays configuration settings for trunk groups including the LPCOR setting
for incoming and outgoing calls.
• show voice lpcor—Displays information about LPCOR calls including the LPCOR policy
associated with each resource group and directory number, and statistics for failed calls.
• show voice port—Displays configuration settings for voice ports including the LPCOR setting for
incoming and outgoing calls.
Cisco Unified Communications Manager Express System Administrator Guide
580 OL-10663-02
Call Restriction Regulations
Configuration Examples for LPCOR
Configuration Examples for LPCOR
This section provides the following configuration examples:
• LPCOR for Cisco Unified CME: Example, page 581
• Cisco 3800 Series Integrated Services Router: Example, page 584
LPCOR for Cisco Unified CME: Example
Figure 4 shows an example of a Cisco Unified CME network using LPCOR. This network is organized
into the following four LPCOR resource groups:
• local_group—Analog and IP phones, including a mobile-type phone, connected locally to
Cisco Unified CME.
• pstn_group—Trunks between the PSTN and Cisco Unified CME.
• remote_group—IP phones, including a mobile-type phone, and a SIP proxy server connected
remotely to Cisco Unified CME through the WAN.
• voice_mail_group—Cisco Unity Express voice-mail system connected remotely to
Cisco Unified CME through the WAN.
Figure 4 LPCOR Resource Grouping in Cisco Unified CME Network
voice_mail_group
Cisco Unity Express
172.19.28.11
remote_group
local_group
Local
IP phone1 Cisco Unified SIP proxy
10.0.1.1 IP CME IP 172.19.34.29
WAN
Mobility
IP phone2 Remote IP phone3
IP IP
10.0.1.2 192.168.17.228
Mobility IP phone4
pstn_group IP 192.168.17.229
Analog Analog PSTN trunks
phone5 phone6
274947
PSTN
Figure 5 illustrates the access policy between resource groups that provides the following call
requirements:
• Blocks calls between remote_group and pstn_group
• Blocks calls from voice_mail_group to pstn_group and remote_group
• Allows calls between local_group and remote_group
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 581
Call Restriction Regulations
Configuration Examples for LPCOR
• Allows calls between local_group and pstn_group
• Allows all calls to voice_mail_group
Figure 5 LPCOR Policy Logic
local_group unity_mail_group
pstn_group remote_group
274948
The following output shows the LPCOR configuration for this example and describes the steps.
Comments describing the configuration are included in the output.
1. Enable LPCOR functionality in Cisco Unified CME and define custom LPCOR group.
voice lpcor enable
!
voice lpcor custom
group 1 pstn_group
group 2 local_group
group 3 remote_group
group 4 voice_mail_group
!
#Allow calls only from local group to PSTN group
voice lpcor policy pstn_group
accept local_group
!
# Allow calls from PSTN, remote, and voice_mail groups to local group
voice lpcor policy local_group
accept pstn_group
accept remote_group
accept voice_mail_group
!
# Allow calls only from local group to remote group
voice lpcor policy remote_group
accept local_group
!
# Allow calls from PSTN, remote, and local groups to voice_mail group
voice lpcor voice_mail_group
accept pstn_group
accept local_group
accept remote_group
!
2. Assign LPCOR to the phone, trunk, and IP resources.
# analog phone5
voice-port 1/0/0
lpcor incoming local_group
Cisco Unified Communications Manager Express System Administrator Guide
582 OL-10663-02
Call Restriction Regulations
Configuration Examples for LPCOR
lpcor outgoing local_group
!
# analog phone6
voice-port 1/0/1
lpcor incoming local_group
lpcor outgoing local_group
!
# TDM trunks
voice-port 2/1:23
lpcor incoming pstn_group
lpcor outgoing pstn_group
!
!
# Specific LPCOR setting for incoming calls from voice_mail_group
voice lpcor ip-trunk subnet incoming
voice_mail_group 172.19.28.11 255.255.255.255
!
!
# Default LPCOR setting for any incoming VoIP calls
voice service voip
lpcor incoming remote_group
!
# Cisco Unified CME is DHCP server
ip dhcp pool client1
network 10.0.0.0 255.255.0.0
mac-address 0003.4713.5554
option 150 ip 10.0.0.1
default-router 10.0.0.1
!
# IP phone1 (local)
ephone 1
lpcor type local
lpcor incoming local_group
lpcor outgoing local_group
!
# IP phone2 (mobile)
ephone 2
lpcor type mobile
!
# IP phone3 (remote)
ephone 3
lpcor type remote
lpcor incoming remote_group
lpcor outgoing remote_group
!
# IP phone4 (mobile)
ephone 4
lpcor type mobile
!
# IP-phone subnet tables for mobile IP phones
voice lpcor ip-phone subnet incoming
local_group dhcp-pool pool1
!
voice lpcor ip-phone subnet outgoing
local_group dhcp-pool client1
!
# Default LPCOR policy for mobile IP phones that
# are not provisioned through IP-phone subnet tables
voice lpcor ip-phone mobility incoming remote_group
voice lpcor ip-phone mobility outgoing remote_group
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 583
Call Restriction Regulations
Configuration Examples for LPCOR
3. Define outgoing LPCOR setting for outgoing VoIP calls.
# VoIP outbound dial-peer to Cisco Unity Express mail
dial-peer voice 1234 voip
destination-pattern 56800
session target ipv4:172.19.281.1
pcor outgoing voice_mail_group
!
# VoIP outbound dial-peer to SIP proxy
dial-peer voice 1255 voip
destination-pattern 1255T
session protocol sipv2
session target sip-server
lpcor outgoing remote
Cisco 3800 Series Integrated Services Router: Example
Router# show running-config
Building configuration...
Current configuration : 10543 bytes
!
version 12.4
service timestamps debug datetime msec
service timestamps log datetime msec
no service password-encryption
!
hostname Router
!
boot-start-marker
boot-end-marker
!
card type t1 2 1
logging message-counter syslog
logging buffered 2000000
no logging console
!
no aaa new-model
network-clock-participate slot 2
!
ip source-route
ip cef
!
!
ip dhcp excluded-address 192.168.20.1
ip dhcp excluded-address 192.168.20.1 192.168.20.5
!
ip dhcp pool voice
network 192.168.20.0 255.255.255.0
option 150 ip 192.168.20.1
default-router 192.168.20.1
!
!
no ip domain lookup
no ipv6 cef
multilink bundle-name authenticated
!
!
isdn switch-type primary-5ess
!
Cisco Unified Communications Manager Express System Administrator Guide
584 OL-10663-02
Call Restriction Regulations
Configuration Examples for LPCOR
voice-card 0
!
voice-card 2
!
!
voice service voip
notify redirect ip2pots
allow-connections sip to sip
sip
bind control source-interface GigabitEthernet0/1
bind media source-interface GigabitEthernet0/1
registrar server expires max 120 min 60
!
!
!
voice class custom-cptone leavetone
dualtone conference
frequency 400 800
cadence 400 50 200 50 200 50
!
voice class custom-cptone jointone
dualtone conference
frequency 600 900
cadence 300 150 300 100 300 50
!
!
voice iec syslog
voice register global
mode cme
source-address 192.168.20.1 port 5060
max-dn 20
max-pool 20
load 7970 SIP70.8-4-2S
load 7960-7940 P0S3-08-11-00
authenticate realm cisco.com
tftp-path flash:
telnet level 2
create profile sync 0000312474383825
!
voice register dn 1
number 4000
name cme-sip1
label 4000
!
voice register dn 2
number 4001
name cme-sip-2
label 4001
!
voice register dn 3
number 4002
name cme-remote
label 4002
!
voice register template 1
softkeys remote-in-use cBarge Barge Newcall
!
voice register pool 1
lpcor type local
lpcor incoming local_sip
lpcor outgoing local_sip
id mac 001B.D4C6.AE44
type 7960
number 1 dn 1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 585
Call Restriction Regulations
Configuration Examples for LPCOR
dtmf-relay rtp-nte
codec g711ulaw
!
voice register pool 2
lpcor type local
lpcor incoming local_sip
lpcor outgoing local_sip
id mac 001E.BE8F.96C1
type 7940
number 1 dn 2
dtmf-relay rtp-nte
codec g711ulaw
!
voice register pool 3
lpcor type remote
lpcor incoming remote_sip
lpcor outgoing remote_sip
id mac 001E.BE8F.96C0
type 7940
number 1 dn 3
dtmf-relay rtp-nte
codec g711ulaw
!
!
voice lpcor enable
voice lpcor call-block cause invalid-number
voice lpcor custom
group 1 voip_siptrunk
group 2 voip_h323trunk
group 3 pstn_trunk
group 4 cue_vmail_local
group 5 cue_vmail_remote
group 6 vmail_unity
group 7 local_sccp
group 8 local_sip
group 9 remote_sccp
group 10 remote_sip
group 11 analog_vg224
group 12 analog_fxs
group 13 mobile_phone
!
voice lpcor policy voip_siptrunk
accept cue_vmail_local
accept local_sccp
accept local_sip
accept analog_vg224
!
voice lpcor policy cue_vmail_local
accept voip_siptrunk
accept voip_h323trunk
accept local_sccp
accept local_sip
!
voice lpcor policy local_sccp
accept local_sip
accept remote_sccp
accept remote_sip
accept analog_vg224
accept analog_fxs
!
voice lpcor policy remote_sccp
accept local_sccp
accept local_sip
accept remote_sip
Cisco Unified Communications Manager Express System Administrator Guide
586 OL-10663-02
Call Restriction Regulations
Configuration Examples for LPCOR
!
voice lpcor policy analog_vg224
accept local_sccp
accept local_sip
accept remote_sccp
accept remote_sip
!
voice lpcor policy analog_fxs
accept local_sccp
accept local_sip
!
voice lpcor ip-phone subnet incoming
index 1 local_sccp dhcp-pool voice
!
voice lpcor ip-phone subnet outgoing
index 1 local_sccp dhcp-pool voice
!
!
!
archive
log config
hidekeys
!
!
controller T1 2/0
cablelength short 133
pri-group timeslots 1-24
!
controller T1 2/1
!
!
interface Loopback1
ip address 192.168.21.1 255.255.255.0
ip ospf network point-to-point
!
interface GigabitEthernet0/0
ip address 192.168.160.1 255.255.255.0
duplex auto
speed auto
media-type rj45
!
interface GigabitEthernet0/1
ip address 192.168.20.1 255.255.255.0
duplex auto
speed auto
media-type rj45
!
interface FastEthernet0/2/0
ip address 192.168.98.1 255.255.255.0
duplex auto
speed auto
!
interface FastEthernet0/2/1
no ip address
duplex auto
speed auto
!
interface Service-Engine1/0
ip unnumbered Loopback1
service-module ip address 192.168.21.100 255.255.255.0
service-module ip default-gateway 192.168.21.1
!
interface Serial2/0:23
no ip address
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 587
Call Restriction Regulations
Configuration Examples for LPCOR
encapsulation hdlc
isdn switch-type primary-5ess
isdn incoming-voice voice
no cdp enable
!
router ospf 1
log-adjacency-changes
network 192.168.160.0 0.0.0.255 area 0
network 192.168.20.0 0.0.0.255 area 0
network 192.168.21.0 0.0.0.255 area 0
!
ip forward-protocol nd
ip route 192.168.21.100 255.255.255.255 Service-Engine1/0
!
!
no ip http server
!
!
tftp-server flash:term41.default.loads
tftp-server flash:term61.default.loads
tftp-server flash:SCCP41.8-3-1S.loads
tftp-server flash:apps41.8-3-0-50.sbn
tftp-server flash:cnu41.8-3-0-50.sbn
tftp-server flash:P003-08-11-00.bin
tftp-server flash:P003-08-11-00.sbn
tftp-server flash:P0S3-08-11-00.sb2
tftp-server flash:P0S3-08-11-00.loads
tftp-server flash:term71.default.loads
tftp-server flash:term70.default.loads
tftp-server flash:jar70sccp.8-2-2TR2.sbn
tftp-server flash:dsp70.8-2-2TR2.sbn
tftp-server flash:cvm70sccp.8-2-2TR2.sbn
tftp-server flash:apps70.8-2-2TR2.sbn
tftp-server flash:SCCP70.8-2-2SR2S.loads
!
control-plane
!
!
voice-port 0/1/0
lpcor incoming analog_fxs
lpcor outgoing analog_fxs
station-id name FXS-Phone
station-id number 3000
caller-id enable
!
voice-port 0/1/1
!
voice-port 2/0:23
!
ccm-manager fax protocol cisco
!
mgcp fax t38 ecm
!
!
!
dial-peer voice 2 voip
destination-pattern 2...
lpcor outgoing voip_siptrunk
session protocol sipv2
session target ipv4:192.168.97.1
codec g711ulaw
ip qos dscp cs5 media
ip qos dscp cs4 signaling
!
Cisco Unified Communications Manager Express System Administrator Guide
588 OL-10663-02
Call Restriction Regulations
Configuration Examples for LPCOR
dial-peer voice 5050 voip
description *** VMAIL Dial-Peer ***
destination-pattern 5...
lpcor outgoing cue_vmail_local
session protocol sipv2
session target ipv4:192.168.21.100
dtmf-relay sip-notify
codec g711ulaw
no vad
!
dial-peer voice 30 pots
destination-pattern 3000
direct-inward-dial
port 0/1/0
!
!
sip-ua
mwi-server ipv4:192.168.21.100 expires 3600 port 5060 transport udp
registrar ipv4:192.168.21.1 expires 3600
!
!
telephony-service
em logout 0:0 0:0 0:0
max-ephones 15
max-dn 15
ip source-address 192.168.20.1 port 2000
service phone videoCapability 1
load 7941 SCCP41.8-3-1S
date-format dd-mm-yy
voicemail 5050
max-conferences 12 gain -6
transfer-system full-consult
transfer-pattern .T
transfer-pattern ....
fac standard
create cnf-files version-stamp Jan 01 2002 00:00:00
!
!
ephone-template 1
softkeys hold Join Newcall Resume Select
softkeys idle Cfwdall ConfList Dnd Join Newcall Pickup Redial RmLstC
softkeys seized Endcall Redial Cfwdall Pickup
!
!
ephone-template 2
lpcor type remote
lpcor incoming remote_sccp
lpcor outgoing remote_sccp
!
!
ephone-dn 1 dual-line
number 5000
call-forward busy 5050
call-forward noan 5050 timeout 10
mwi sip
!
!
ephone-dn 2 dual-line
number 5001
call-forward busy 5050
call-forward noan 5050 timeout 10
mwi sip
!
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 589
Call Restriction Regulations
Configuration Examples for LPCOR
ephone-dn 3 dual-line
number 5010
description vg224-1/1
name analog-1
!
!
ephone-dn 4 dual-line
number 5011
description vg224-1/2
name analog-2
!
!
ephone-dn 5 dual-line
number 5012
description vg224-1/3
name analog-3
!
!
ephone-dn 6 dual-line
number 5013
description vg224-1/4
name analog-4
!
!
ephone-dn 7 dual-line
number 5020
name SCCP-Remote
mwi sip
!
!
ephone 1
lpcor type local
lpcor incoming local_sccp
lpcor outgoing local_sccp
mac-address 001E.7A26.EB60
ephone-template 1
type 7941
button 1:1
!
!
!
ephone 2
lpcor type local
lpcor incoming local_sccp
lpcor outgoing local_sccp
mac-address 001E.7AC2.CCF9
ephone-template 1
type 7941
button 1:2
!
!
!
ephone 3
lpcor type local
lpcor incoming analog_vg224
lpcor outgoing analog_vg224
mac-address F9E5.8B28.2400
ephone-template 1
max-calls-per-button 2
type anl
button 1:3
!
!
!
Cisco Unified Communications Manager Express System Administrator Guide
590 OL-10663-02
Call Restriction Regulations
Configuration Examples for LPCOR
ephone 4
lpcor type local
lpcor incoming analog_vg224
lpcor outgoing analog_vg224
mac-address F9E5.8B28.2401
ephone-template 1
max-calls-per-button 2
type anl
button 1:4
!
!
!
ephone 5
lpcor type local
lpcor incoming analog_vg224
lpcor outgoing analog_vg224
mac-address F9E5.8B28.2402
ephone-template 1
max-calls-per-button 2
type anl
button 1:5
!
!
!
ephone 6
lpcor type local
lpcor incoming analog_vg224
lpcor outgoing analog_vg224
mac-address F9E5.8B28.2403
ephone-template 1
max-calls-per-button 2
type anl
button 1:6
!
!
!
ephone 7
mac-address 001B.D52C.DF1F
ephone-template 2
type 7970
button 1:7
!
!
alias exec cue ser ser 1/0 sess
!
line con 0
line aux 0
line 66
no activation-character
no exec
transport preferred none
transport input all
transport output pad telnet rlogin lapb-ta mop udptn v120
line vty 0 4
login
!
exception data-corruption buffer truncate
scheduler allocate 20000 1000
end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 591
Call Restriction Regulations
Additional References
Additional References
The following sections provide references related to the LPCOR feature.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified Communications Manager Express System
Administrator Guide
• Cisco Unified Communications Manager Express Command
Reference
Cisco IOS voice configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Voice Command Reference
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Standards
Standard Title
No new or modified standards are supported by this —
feature, and support for existing standards has not been
modified by this feature.
MIBs
MIB MIBs Link
No new or modified MIBs are supported by this To locate and download MIBs for selected platforms, Cisco IOS
feature, and support for existing MIBs has not been releases, and feature sets, use Cisco MIB Locator found at the
modified by this feature. following URL:
http://www.cisco.com/go/mibs
RFCs
RFC Title
No new or modified RFCs are supported by this —
feature, and support for existing RFCs has not been
modified by this feature.
Cisco Unified Communications Manager Express System Administrator Guide
592 OL-10663-02
Call Restriction Regulations
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 593
Call Restriction Regulations
Feature Information for LPCOR
Feature Information for LPCOR
Table 5 lists the release history for this feature.
Not all commands may be available in your Cisco IOS software release. For release information about
a specific command, see the command reference documentation.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS and Catalyst OS software images
support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 5 lists only the Cisco IOS software release that introduced support for a given feature in a given
Cisco IOS software release train. Unless noted otherwise, subsequent releases of that Cisco IOS
software release train also support that feature.
Table 5 Feature Information for LPCOR
Cisco Unified CME
Feature Name Version Feature Information
Call Restriction Regulations for 8.0 Introduced support for LPCOR feature.
Cisco Unified CME
CCDE, CCENT, Cisco Eos, Cisco HealthPresence, the Cisco logo, Cisco Lumin, Cisco Nexus, Cisco StadiumVision, Cisco TelePresence,
Cisco WebEx, DCE, and Welcome to the Human Network are trademarks; Changing the Way We Work, Live, Play, and Learn and Cisco Store 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. (0812R)
Any Internet Protocol (IP) addresses used in this document are not intended to be actual addresses. Any examples, command display output, and
figures included in the document are shown for illustrative purposes only. Any use of actual IP addresses in illustrative content is unintentional and
coincidental.
© 2009 Cisco Systems, Inc. All rights reserved.
Cisco Unified Communications Manager Express System Administrator Guide
594 OL-10663-02
Configuring Call Transfer and Forwarding
Last Updated: March 22, 2010
This chapter describes call transfer and forwarding features in Cisco Unified Communications Manager
Express (Cisco Unified CME) to enable interworking with various network requirements.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Call Transfer and
Forwarding” section on page 660.
Contents
• Information About Call Transfer and Forwarding, page 595
• How to Configure Call Transfer and Forwarding, page 614
• Configuration Examples for Call Transfer and Forwarding, page 651
• Where to Go Next, page 658
• Additional References, page 659
• Feature Information for Call Transfer and Forwarding, page 660
Information About Call Transfer and Forwarding
To configure transfer and forwarding features, you should understand the following concepts:
• Call Forwarding, page 596
• B2BUA Call Forwarding for SIP Devices, page 597
• Call Forward All Synchronization for SIP Phones, page 597
• Call Transfer, page 598
• H.450.2 and H.450.3 Support, page 600
• Transfer Method Recommendations by Cisco Unified CME Version, page 603
• H.450.12 Support, page 604
• Hairpin Call Routing, page 604
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 595
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
• H.450 Tandem Gateways, page 607
• Dial Peers, page 609
• QSIG Supplementary Services, page 609
• Disabling SIP Supplementary Services for Call Forward and Call Transfer, page 610
• Typical Network Scenarios for Call Transfer and Call Forwarding, page 611
Call Forwarding
Call forwarding diverts calls to a specified number under one or more of the following conditions:
• All calls—When all-call call forwarding is activated by a phone user, all incoming calls are diverted.
The target destination for diverted calls can be specified in the router configuration or by the phone
user with a soft key or feature access code. The most recently entered destination is recognized by
Cisco Unified CME, regardless of how it was entered.
• No answer—Incoming calls are diverted when the extension does not answer before the timeout
expires. The target destination for diverted calls is specified in the router configuration.
• Busy—Incoming calls are diverted when the extension is busy and call waiting is not active. The
target destination for diverted calls is specified in the router configuration.
• Night service—All incoming calls are automatically diverted during night-service hours. The target
destination for diverted calls is specified in the router configuration.
A directory number can have all four types of call forwarding defined at the same time with a different
forwarding destination defined for each type of call forwarding. If more than one type of call forwarding
is active at one time, the order for evaluating the different types is as follows:
1. Call forward night-service
2. Call forward all
3. Call forward busy and call forward no-answer
H.450.3 capabilities are enabled globally on the router by default, and can be disabled either globally or
for individual dial peers. You can configure incoming patterns for using the H.450.3 standard.
Calling-party numbers that do not match the patterns defined with this command are forwarded using
Cisco-proprietary call forwarding for backward compatibility. For information about configuring
H.450.3 on a Cisco Unified CME system, see the “SCCP: Enabling Call Forwarding for a Directory
Number” section on page 620.
Selective Call Forwarding
You can apply call forwarding to a busy or no-answer directory number based on the number that is
dialed to reach the directory number: the primary number, the secondary number, or either of those
numbers expanded by a dial-plan pattern.
Cisco Unified CME automatically creates one POTS dial peer for each ephone-dn when it is assigned a
primary number. If the ephone-dn is assigned a secondary number, it creates a second POTS dial peer.
If the dialplan-pattern command is used to expand the primary and secondary numbers for ephone-dns,
it creates two more dial peers, resulting in the creation of the following four dial peers for the ephone-dn:
• A POTS dial peer for the primary number
• A POTS dial peer for the secondary number
• A POTS dial peer for the primary number as expanded by the dialplan-pattern command
Cisco Unified Communications Manager Express System Administrator Guide
596 OL-10663-02
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
• A POTS dial peer for the secondary number as expanded by the dialplan-pattern command
Call forwarding is normally applied to all dial peers created for an ephone-dn. Selective call forwarding
allows you to apply call forwarding for busy or no-answer calls only for the dial peers you have specified,
based on the called number that was used to route the call to the ephone-dn.
For example, the following commands set up a single ephone-dn (ephone-dn 5) with four dial
peers:
telephony-service
dialplan-pattern 1 40855501.. extension-length 4 extension-pattern 50..
ephone-dn 5
number 5066 secondary 5067
In this example, selective call forwarding can be applied so that calls are forwarded when:
• callers dial the primary number 5066.
• when callers dial the secondary number 5067.
• when callers dial the expanded numbers 4085550166 or 4085550167.
For configuration information, see the “SCCP: Enabling Call Forwarding for a Directory Number”
section on page 620.
B2BUA Call Forwarding for SIP Devices
Cisco Unified CME 3.4 an d later versions acts as both UA server and UA client; that is, as a B2BUA.
Calls into a SIP phone can be forwarded to other SIP or SCCP devices (including Cisco Unity or
Cisco Unity Express, third-party voice mail systems, an auto attendant or an IVR system, such as
Cisco Unified IPCC and Cisco Unified IPCC Express). In addition, SCCP phones can be forwarded to
SIP phones.
Cisco Unity or other voice-messaging systems connected by a SIP trunk or SIP user agent are able to
pass an MWI to a SIP phone when a call is forwarded. The SIP phone then displays the MWI when
indicated by the voice-messaging system.
The call-forward busy response is triggered when a call is sent to a SIP phone using a VoIP dial peer and
a busy response is received back from the phone. SIP-to-SIP call forwarding is invoked only if the phone
is dialed directly. Call forwarding is not invoked when the phone number is called through a sequential,
longest-idle, or peer hunt group.
You can configure call forwarding for an individual directory number, or for every number on a SIP
phone. If the information is configured in both, the information under voice register dn takes precedence
over the information configured under voice register pool.
For configuration information, see the “SIP: Configuring SIP-to-SIP Phone Call Forwarding” section on
page 644.
Call Forward All Synchronization for SIP Phones
The Call Forward All feature allows users to forward all incoming calls to a phone number that they
specify. This feature is supported on all SIP phones and can be provisioned from either
Cisco Unified CME or the individual SIP phone. Before Cisco Unified CME 4.1, there was no method
for exchanging the Call Forward All configuration between Cisco Unified CME and the SIP phone. If
Call Forward All was enabled on the phone, the configuration in Cisco Unified CME was not updated;
conversely, the configuration in Cisco Unified CME was not sent to the phone.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 597
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
In Cisco Unified CME 4.1 and later, the following enhancements are supported for the
Cisco Unified IP Phone 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE to keep the
configuration consistent between Cisco Unified CME and the SIP phone:
• When Call Forward All is configured on Cisco Unified CME with the call-forward b2bua all
command, the configuration is sent to the phone which updates the CfwdAll soft key to indicate that
Call forward All is enabled. Because Call Forward All is configured on a per line basis, the CfwdAll
soft key is updated only when Call Forward All is enabled for the primary line.
• When a user enables Call Forward All on a phone using the CfwdAll soft key, the uniform resource
identifier (URI) for the service (defined with the call-feature-uri command) and the call forward
number (unless Call Forward All is disabled) is sent to Cisco Unified CME. It updates its voice
register pool and voice register dn configuration with the call-forward b2bua all command to be
consistent with the phone configuration.
• Call Forward All supports KPML so that a user does not need to press the Dial or # key, or wait for
the interdigit timeout, to configure the Call Forward All number. Cisco Unified CME collects the
Call Forward All digits until it finds a match in the dial peers.
For configuration information, see the “SIP: Configuring Call-Forwarding-All Soft Key URI” section on
page 647.
Call Transfer
When you are connected to another party, call transfer allows you to shift the connection of the other
party to a different number. Call transfer methods must interoperate with systems in the other networks
with which you interface. Cisco CME 3.2 and later versions provide full call-transfer and
call-forwarding interoperability with call processing systems that support H.450.2, H.450.3, and
H.450.12 standards. For call processing systems that do not support H.450 standards, Cisco CME 3.2
and later versions provide VoIP-to-VoIP hairpin call routing.
Call transfers can be blind or consultative. A blind transfer is one in which the transferring extension
connects the caller to a destination extension before ringback begins. A consultative transfer is one in
which the transferring party either connects the caller to a ringing phone (ringback heard) or speaks with
the third party before connecting the caller to the third party.
You can configure blind or consultative transfer on a systemwide basis or for individual extensions. For
example, in a system that is set up for consultative transfer, a specific extension with an auto-attendant
that automatically transfers incoming calls to specific extension numbers can be set to use blind transfer,
because auto-attendants do not use consultative transfer.
Call Transfer Blocking
Transfers to all numbers except those on local phones are automatically blocked by default. During
configuration, you can allow transfers to nonlocal numbers. In Cisco Unified CME 4.0 and later
versions, you can prevent individual phones from transferring calls to numbers that are globally enabled
for transfer. This ensures that individual phones do not incur toll charges by transferring calls outside
the Cisco Unified CME system. Call transfer blocking can be configured for individual phones or
configured as part of a template that is applied to a set of phones.
Another way to eliminate toll charges on call transfers is to limit the number of digits that phone users
can dial when transferring calls. For example, if you specify a maximum of eight digits in the
configuration, users who are transferring calls can dial one digit for external access and seven digits
more, which is generally enough for a local number but not a long-distance number. In most locations,
this plan will limit transfers to nontoll destinations. Long-distance calls, which typically require ten
Cisco Unified Communications Manager Express System Administrator Guide
598 OL-10663-02
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
digits or more, will not be allowed. This configuration is only necessary when global transfer to numbers
outside the Cisco Unified CME system has been enabled using the transfer-pattern (telephony-service)
command. Transfers to numbers outside the Cisco Unified CME system are not permitted by default.
For configuration information, see the “SCCP: Configuring Call Transfer Options for Phones” section
on page 624.
Call-Transfer Recall
The Call-Transfer Recall feature in Cisco Unified CME 4.3 and later versions returns a transferred call
to the phone that initiated the transfer if the destination is busy or does not answer. After a phone user
completes a transfer to a directory number on a local phone, if the transfer-to party does not answer
before the configured recall timer expires, the call is directed back to the transferor phone. The message
“Transfer Recall From xxxx” displays on the transferor phone.
The transfer-to directory number cannot have Call Forward Busy enabled and cannot be a member of
any hunt group. If the transfer-to directory number has Call Forward No Answer (CFNA) enabled,
Cisco Unified CME recalls the call only if the transfer-recall timeout is set to less than the CFNA
timeout. If the transfer-recall timeout is set to more than the CFNA timeout, the call is forwarded to the
CFNA target number after the transfer-to party does not answer.
If the transferor phone is busy, Cisco Unified CME attempts the recall again after a 15-second
retry-timer expires. Cisco Unified CME attempts a recall up to three times. If the transferor phone
remains busy, the call is disconnected after the third recall attempt.
The transferor phone and transfer-to phone must be registered to the same Cisco Unified CME, however
the transferee phone can be remote.
For configuration information, see the “Enabling Call Transfer and Forwarding at System-Level” section
on page 615.
Consultative-Transfer Enhancements in Cisco Unified CME 4.3 and Later Versions
Cisco Unified CME 4.3 modifies the digit-collection process for consultative call transfers. After a
phone user presses the Transfer soft key to make a consultative transfer, a new consultative call leg is
created and the Transfer soft key is not displayed again until the dialed digits of the transfer-to number
are matched to a transfer pattern and the consultative call leg is in the alerting state.
Transfer-to digits dialed by the phone user are no longer buffered. The dialed digits, except the call park
FAC code, are collected on the seized consultative call-leg until the digits match a pattern for
consultative transfer, blind transfer, park-slot transfer, park-slot transfer blocking, or PSTN transfer
blocking. The existing pattern matching process is unchanged, and you have the option of using this new
transfer digit-collection method or reverting to the former method.
Before Cisco Unified CME 4.3, the consultative transfer feature collects dialed digits on the original call
leg until the digits either match a transfer pattern or blocking pattern. When the transfer-to number is
matched, and PSTN blocking is not enabled, the original call is put on hold and an idle line or channel
is seized to send the dialed digits from the buffer.
The method of matching a pattern for consultative transfer, blind transfer, park-slot transfer, park-slot
transfer blocking, PSTN transfer blocking, and after-hours blocking remain the same. When the
transfer-to number matches the pattern for a blind transfer or park-slot transfer, Cisco Unified CME
terminates the consultative call leg and transfers the call.
After the transfer-to digits are collected, if the transfer is not committed before the transfer-timeout
expires in 30 seconds, the consultation call leg is disconnected.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 599
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
These enhancements are supported only if:
• The transfer-system full-consult command (default) is set in telephony-service configuration
mode.
• The transfer-mode consult command (default) is set for the transferor's directory number
(ephone-dn).
• An idle line or channel is available for seizing, digit collection, and dialing.
Cisco Unified CME 4.3 and later versions enable these transfer enhancements by default.
To revert to the digit-collection method used in previous versions of Cisco Unified CME, see the
“Enabling Call Transfer and Forwarding at System-Level” section on page 615.
Consultative Transfer With Direct Station Select
Direct Station Select (DSS) is a feature that allows a multibutton phone user to transfer calls to an idle
monitored line by pressing the Transfer key and the appropriate monitored line button. A monitored line
is one that appears on two phones; one phone can use the line to make and receive calls and the other
phone simply monitors whether the line is in use. For Cisco CME 3.2 and later versions, consultative
transfers can occur during Direct Station Select (transferring calls to idle monitored lines).
If the person sharing the monitored line does not want to accept the call, the person announcing the call
can reconnect to the incoming call by pressing the EndCall soft key to terminate the announcement call
and pressing the Resume soft key to reconnect to the original caller.
Direct Station Select consultative transfer is enabled with the transfer-system full-consult dss
command, which defines the call transfer method for all lines served by the router. The transfer-system
full-consult dss command supports the keep-conference command. See “Configuring Conferencing” on
page 753.
H.450.2 and H.450.3 Support
H.450.2 is a standard protocol for exchanging call-transfer information across a network, and H.450.3
is a standard protocol for exchanging call-forwarding information across a network. Cisco CME 3.0 and
later versions support the H.450.2 call-transfer standards and the H.450.3 call-forwarding standards that
were introduced in Cisco ITS V2.1. Using the H.450.2 and H.450.3 standards to manage call transfer
and forwarding in a VoIP network provides the following benefits:
• The final call path from the transferred party to the transfer destination is optimal, with no
hairpinned routes or excessive use of resources.
• Call parameters (for example, codec) can be different for the different call legs.
• This solution is scalable.
• There is no limit to the number of times a call can be transferred.
Considerations for using the H.450.2 and H.450.3 standards include the following:
• Cisco IOS Release 12.2(15)T or a later release is required on all voice gateways in the network.
• Support of H.450.2 and H.450.3 is required on all voice gateways in the network. H.450.2 and
H.450.3 are used regardless of whether the transfer-to or forward-to target is on the same
Cisco Unified CME system as the transferring party or the forwarding party, so the transferred party
must also support H.450.2 and the forwarded party must also support H.450.3. The exception is calls
that can be reoriginated through hairpin call routing or through the use of an H.450 tandem gateway.
Cisco Unified Communications Manager Express System Administrator Guide
600 OL-10663-02
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
• Call forwarding over SIP networks uses the 302 Moved Temporarily SIP response, which works in
a manner similar to the way in which the H.450.3 standard is used for H.323 networks. To enable
call forwarding, you must specify a pattern that matches the calling-party numbers of the calls that
you want to be able to forward.
• Cisco Unified CME supports all SIP Refer method call transfer scenarios, but you must ensure that
call transfer is enabled using H.450.2 standards.
• H.450 standards are not supported by Cisco Unified Communications Manager, Cisco BTS, or
Cisco PGW, although hairpin call routing or an H.450 tandem gateway can be set up to handle calls
to and from those types of systems.
The following series of figures depicts a call being transferred using H.450.2 standards. Figure 6 on
page 601 shows A calling B. Figure 7 on page 601 shows B consulting with C and putting A on hold.
Figure 8 on page 602 shows that B has connected A and C, and Figure 9 on page 602 shows A and C
directly connected, with B no longer involved in the call.
Figure 6 Call Transfer Using H.450.2: A Calls B
H.323
V
Media Termination
Cisco Unified CME 1 Point (MTP)
IP
Phone A Phone C
Cisco Unified CME 2
146629
IP
Phone B
Figure 7 Call Transfer Using H.450.2: B Consults with C
H.323 V
Non-H.450
Cisco Unified CME 1 gateway
IP
Cisco Unified CME 2 Phone C
Phone A
H.450.2 connection H.450.2 connection
146634
IP
Phone B
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 601
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
Figure 8 Call Transfer Using H.450.2: B Transfers A to C
H.323 V
Non-H.450
Unified
Cisco CME 1 CME 1 gateway
IP
Phone A Cisco Unified CME 2 Phone C
146633
IP
Phone B
Figure 9 Call Transfer Using H.450.2: A and C Are Connected
H.323 V
Non-H.450
Cisco Unified CME 1 gateway
IP
Cisco Unified CME 2 Phone C
Phone A
H.450.2 connection H.450.2 connection
IP 146634
Phone B
Tips for Using H.450 Standards
Use H.450 standards when a network meets the following conditions:
• The router that you are configuring uses Cisco CME 3.0 or a later version, or Cisco ITS V2.1.
• For Cisco CME 3.0 or Cisco ITS V2.1 systems, all endpoints in the network must support H.450.2
and H.450.3 standards. For Cisco CME 3.1 or later systems, if some of the endpoints do not support
H.450 standards (for example, Cisco Unified Communications Manager, Cisco BTS, or
Cisco PGW), you can use hairpin call routing or an H.450 tandem gateway to handle transfers and
forwards with those endpoints. Also, either you must explicitly disable H.450.2 and H.450.3 on the
dial peers that handle those calls or you must enable H.450.12 capability to automatically detect the
calls that support H.450.2 and H.450.3 and those calls that do not.
Support for the H.450.2 standard and the H.450.3 standard is enabled by default and can be disabled
globally or for individual dial peers. For configuration information, see the “Enabling Call Transfer and
Forwarding at System-Level” section on page 615.
Cisco Unified Communications Manager Express System Administrator Guide
602 OL-10663-02
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
Transfer Method Recommendations by Cisco Unified CME Version
You must specify the method to use for call transfers: H.450.2 standard signaling or Cisco proprietary
signaling, and whether transfers should be blind or allow consultation. Table 6 summarizes transfer
method recommendations for all Cisco Unified CME versions.
Table 6 Transfer Method Recommendations
Cisco Unified CME transfer-system transfer-system
Version Command Default Keyword to Use Transfer Method Recommendation
4.0 and later full-consult full-consult Use H.450.2 for call transfer, which is the default for this
or version. You do not need to use the transfer-system command
full-blind unless you want to use the full-blind or dss keyword.
Optionally, you can use the proprietary Cisco method by using
the transfer-system command with the blind or local-consult
keyword.
Use H.450.7 for call transfer using QSIG supplementary
services
3.0 to 3.3 blind full-consult Use H.450.2 for call transfer. You must explicitly configure the
or transfer-system command with the full-consult or full-blind
full-blind keyword because H.450.2 is not the default for this version.
Optionally, you can use the proprietary Cisco method by using
the transfer-system command with the blind or local-consult
keyword.
2.1 blind blind Use the Cisco proprietary method, which is the default for this
or version. You do not need to use the transfer-system command
local-consult unless you want to use the local-consult keyword.
Optionally, you can use the transfer-system command with the
full-consult or full-blind keyword. You must also configure the
router with a Tcl script that is contained in the
app-h450-transfer.x.x.x.x.zip file. This file is available from the
Cisco Unified CME software download website at
http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp.
Earlier than 2.1 blind blind Use the Cisco proprietary method, which is the default for this
version. You do not need to use the transfer-system command
unless you want to use the local-consult keyword.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 603
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
H.450.12 Support
Cisco CME 3.1 and later versions support the H.450.12 call capabilities standard, which provides a
means to advertise and dynamically discover H.450.2 and H.450.3 capabilities in voice gateway
endpoints on a call-by-call basis. When discovered, the calls associated with non-H.450 endpoints can
be directed to use non-H.450 methods for transfer and forwarding, such as hairpin call routing or H.450
tandem gateway.
When H.450.12 is enabled, H.450.2 and H.450.3 services are disabled for call transfers and call forwards
unless a positive H.450.12 indication is received from all other VoIP endpoints involved in the call. If a
positive H.450.12 indication is received, the router uses the H.450.2 standard for call transfers and the
H.450.3 standard for call forwarding. If a positive H.450.12 indication is not received, the router uses
the alternative method that you have configured for call transfers and forwards, either hairpin call routing
or an H.450 tandem gateway.
You can have either of the following situations in your network:
• All gateway endpoints support H.450.2 and H.450.3 standards. In this situation, no special
configuration is required because support for H.450.2 and H.450.3 standards is enabled on the
Cisco CME 3.1 or later router by default. H.450.12 capability is disabled by default, but it is not
required because all calls can use H.450.2 and H.450.3 standards.
• Not all gateway endpoints support H.450.2 and H.450.3 standards. Therefore, specify how
non-H.450 calls are to be handled by choosing one of the following options:
– Enable the H.450.12 capability in Cisco CME 3.1 and later to dynamically determine, on a
call-by-call basis, whether each call has H.450.2 and H.450.3 support. If H.450.12 is enabled
and a call is determined to have H.450 support, the call is transferred using H.450.2 standards
or forwarded using H.450.3 standards. See the “Enabling H.450.12 Capabilities” section on
page 627.
Support for the H.450.12 standard is disabled by default and can be enabled globally or for
individual dial peers.
If the call does not have H.450 support, it can be handled by a VoIP-to-VoIP connection that you
configure using dial peers and the “Enabling H.323-to-H.323 Connection Capabilities” section
on page 629. The connection can be used for hairpin call routing or routing to an H.450 tandem
gateway.
– Explicitly disable H.450.2 and H.450.3 capability on a global basis or by individual dial peer,
which forces all calls to be handled by a VoIP-to-VoIP connection that you configure using dial
peers and the“Enabling H.323-to-H.323 Connection Capabilities” section on page 629. This
connection can be used for hairpin call routing or routing to an H.450 tandem gateway.
Hairpin Call Routing
Cisco CME 3.1 and later supports hairpin call routing using a VoIP-to-VoIP connection to transfer and
forward calls that cannot use H.450 standards. When a call that originally terminated on a voice gateway
is transferred or forwarded by a phone or other application attached to the gateway, the gateway
reoriginates the call and routes the call as appropriate, making a VoIP-to-VoIP, or hairpin, connection.
This approach avoids any protocol dependency on the far-end transferred-party endpoint or
transfer-destination endpoint. Hairpin routing of transferred and forwarded calls also causes the
generation of separate billing records for each call leg, so that the transferred or forwarded call leg is
typically billed to the user who initiates the transfer or forward.
Cisco Unified Communications Manager Express System Administrator Guide
604 OL-10663-02
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
In Cisco CME 3.2 and later versions, transcoding between G.711 and G.729 is supported when one leg
of a VoIP-to-VoIP hairpin call uses G.711 and the other leg uses G.729. For information about
transcoding, see “Configuring Transcoding Resources” on page 329.
Hairpin call routing provides the following benefits:
• Call transfer and forwarding is provided to non-H.450 endpoints, such as
Cisco Unified Communications Manager, Cisco BTS, or Cisco PGW.
• The network can also contain Cisco CME 3.0 or Cisco ITS 2.1 systems.
Hairpin call routing has the following disadvantages:
• End-to-end signaling and media delay are increased significantly.
• A single hairpinned call uses as much WAN bandwidth as two directly connected calls.
VoIP-to-VoIP hairpin connections can be made using dial peers if the allow-connections h323 to h323
command is enabled and at least one of the following is true:
• H.450.12 is used to detect calls on which H.450.2 or H.450.3 is not supported by the remote system.
• H.450.2 or H.450.3 is explicitly disabled.
• Cisco Unified CME automatically detects that the remote system is a
Cisco Unified Communications Manager.
Figure 10 on page 605 shows a call that is made from A to B. Figure 11 on page 606 shows that B has
forwarded all calls to C. Figure 12 on page 606 shows that A and C are connected by an H.323 hairpin.
Figure 10 Hairpin with H.323: A Calls B
H.323
V
Media Termination
Cisco Unified CME 1 Point (MTP)
IP
Phone A Phone C
Cisco Unified CME 2
146629
IP
Phone B
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 605
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
Figure 11 Hairpin with H.323: Call is Forwarded to C
H.323 V
Non-H.450
Cisco Unified CME 1 gateway
IP
Phone A Phone C
Cisco Unified CME 2
146630
IP Calls are forwarded
Phone B to phone C
Figure 12 Hairpin with H.323: A is Connected to C via B
H.323 V
Non-H.450
Cisco Unified CME 1 gateway
IP
Phone A Phone C
Cisco Unified CME 2
IP 146631
Phone B
Tips for Using Hairpin Call Routing
Use hairpin call routing when a network meets the following three conditions:
• The router that you are configuring uses Cisco CME 3.1 or a later version.
• Some or all calls require VoIP-to-VoIP routing because they cannot use H.450 standards, which can
happen for any of the following reasons:
– H.450 capabilities have been explicitly disabled on the router.
– H.450 capabilities do not exist in the network.
– H.450 capabilities are supported on some endpoints and not supported on other endpoints,
including those handled by Cisco Unified Communications Manager, Cisco BTS, and
Cisco PGW. When some endpoints support H.450 and others do not, you must enable H.450.12
capabilities on the router to detect which endpoints are H.450-capable or designate some dial
peers as H.450-capable. For more information about enabling H.450.12 capabilities, see the
“Enabling H.450.12 Capabilities” section on page 627.
• No voice gateway is available to act as an H.450 tandem gateway.
For information about configuring Cisco Unified CME to forward calls using local hairpin routing, see
the “Forwarding Calls Using Local Hairpin Routing” section on page 631.
Cisco Unified Communications Manager Express System Administrator Guide
606 OL-10663-02
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
Support for VoIP-to-VoIP connections is disabled by default and can be enabled globally. For
configuration information, see the “Enabling H.323-to-H.323 Connection Capabilities” section on
page 629.
H.450 Tandem Gateways
H.450 tandem gateways address the limitations of hairpin call routing using a manner similar to hairpin
call routing but without the double WAN link traversal created by hairpin connections. An H.450 tandem
gateway is an additional voice gateway that serves as a “front-end” for a call processor that does not
support the H.450 standards, such as Cisco Unified Communications Manager, Cisco BTS Softswitch
(Cisco BTS), or Cisco PSTN Gateway (Cisco PGW). Transferred and forwarded calls that are intended
for non-H.450 endpoints are terminated instead on the H.450 tandem gateway and reoriginated there for
delivery to the non-H.450 endpoints. The H.450 tandem gateway can also serve as a PSTN gateway.
An H.450 tandem gateway is configured with a dial peer that points to the
Cisco Unified Communications Manager or other system for which the H.450 tandem gateway is
serving as a front end. The H.450 tandem voice gateway is also configured with dial peers that point to
all the Cisco Unified CME systems in the private H.450 network. In this way, Cisco Unified CME and
the Cisco Unified Communications Manager are not directly linked to each other, but are instead both
linked to an H.450 tandem gateway that provides H.450 services to the non-H.450 platform.
An H.450 tandem gateway can also work as a PSTN gateway for remote Cisco Unified CME systems
and for Cisco Unified Communications Manager (or other non-H.450 system). Use different inbound
dial peers to separate Cisco Unified Communications Manager-to-PSTN G.711 calls from tandem
gateway-to-Cisco Unified CME G.729 calls.
Note An H.450 tandem gateway that is used in a network to support non-H.450-capable call processing
systems requires the Integrated Voice and Video Services feature license. This feature license, which was
introduced in March 2004, includes functionality for H.323 gatekeeper, IP-to-IP Gateway, and H.450
tandem gateway. With Cisco IOS Release 12.3(7)T, an H.323 gatekeeper feature license is required with a
JSX Cisco IOS image on the selected router. Consult your Cisco Unified CME SE regarding the required
feature license. With Cisco IOS Release 12.3(7)T, you cannot use Cisco Unified CME and H.450 tandem
gateway functionality on the same router.
VoIP-to-VoIP connections can be made for an H.450 tandem gateway if the allow-connections h323 to
h323 command is enabled and one or more of the following is true:
• H.450.12 is used to dynamically detect calls on which H.450.2 or H.450.3 is not supported by the
remote VoIP system.
• H.450.2 or H.450.3 is explicitly disabled.
• Cisco CME 3.1 or later automatically detects that the remote system is a
Cisco Unified Communications Manager.
For Cisco CME 3.1 and earlier, the only type of VoIP-to-VoIP connection supported by
Cisco Unified CME is H.323-to-H.323. For Cisco CME 3.2 and later versions, H.323-to-SIP
connections are allowed only for Cisco Unified CME systems running Cisco Unity Express.
Figure 13 on page 608 shows a tandem voice gateway that is located between the central hub of the
network of a CPE-based Cisco CME 3.1 or later network and a Cisco Unified Communications Manager
network. This topology would work equally well with a Cisco BTS or Cisco PGW in place of the
Cisco Unified Communications Manager.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 607
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
In the network topology in Figure 13 on page 608, the following events occur (refer to the event numbers
on the illustration):
1. A call is generated from extension 4002 on phone 2, which is connected to a
Cisco Unified Communications Manager. The H.450 tandem gateway receives the H.323 call and,
acting as the H.323 endpoint, the H.450 tandem gateway handles the call connection to a
Cisco Unified IP phone in a CPE-based Cisco CME 3.1 or later network.
2. The call is received by extension 1001 on phone 3, which is connected to Cisco Unified CME 1.
Extension 1001 performs a consultation transfer to extension 2001 on phone 5, which is connected
to Cisco Unified CME 2.
3. When extension 1001 transfers the call, the H.450 tandem gateway receives an H.450.2 message
from extension 1001.
4. The H.450 tandem gateway terminates the call leg from extension 1001 and reoriginates a call leg
to extension 2001, which is connected to Cisco Unified CME 2.
5. Extension 4002 is connected with extension 2001.
Figure 13 H.450 Tandem Gateway
IP-to-IP
Gateway
Public VoIP Cisco Unified CallManager
323 323
1
H.323 Connection
IP IP in ICT mode using slow start
Phone 1 Phone 2
4001 4002 Media Termination Point (MTP)
V
Private H.450 Network H.450
H.450Tandem
Tandem
Gateway
Gateway
3 PSTN
V
H.450.2 Message
Private VoIP Telephone
Cisco Unified CME 1
2 Cisco Unified CME 2
V V
2 5
4
IP IP IP IP
Phone 3 Phone 4 Phone 5 Phone 6
1001 1002 3001 3002
146622
Cisco Unified Communications Manager Express System Administrator Guide
608 OL-10663-02
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
Tips for Using H.450 Tandem Gateways
Use this procedure when a network meets the following conditions:
• The router that you are configuring uses Cisco CME 3.1 or a later version.
• Some endpoints in the network are not H.450-capable, including those handled by
Cisco Unified Communications Manager, Cisco BTS, and Cisco PGW.
Support for VoIP-to-VoIP connections is disabled by default and can be enabled globally. For more
information, see the “Enabling H.323-to-H.323 Connection Capabilities” section on page 629.
Use dial peers to set up an H.450 tandem gateway. See the “Dial Peers” section on page 609.
Dial Peers
Dial peers describe the virtual interfaces to or from which a call is established. All voice technologies
use dial peers to define the characteristics associated with a call leg. Attributes applied to a call leg
include specific quality of service (QoS) features, compression/decompression (codec), voice activity
detection (VAD), and fax rate. Dial peers are also used to establish the routing paths in your network,
including special routing paths such as hairpins and H.450 tandem gateways. Dial peer settings override
the global settings for call forward and call transfer. For information about configuring dial peers, see
the Dial Peer Configuration on Voice Gateway Routers guide.
QSIG Supplementary Services
QSIG is an intelligent inter-PBX signaling system widely adopted by PBX vendors. It supports a range
of basic services, generic functional procedures, and supplementary services. Cisco Unified CME 4.0
introduces supplementary services features that allow Cisco Unified CME phones to seamlessly
interwork using QSIG with phones connected to a PBX. One benefit is that IP phones can use a PBX
message center with proper MWI notifications. Figure 14 illustrates a topology for a Cisco Unified CME
system with some phones under the control of a PBX.
Figure 14 Cisco Unified CME System with PBX
IP 1001 IP 2001
IP 1002 IP 2002
IP 1003 IP 2003
Remote Cisco CME IP network Local Cisco CME
QSIG 3001
3002
PBX
3003
Message
135562
center
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 609
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
The following QSIG supplementary service features are supported in Cisco Unified CME systems. They
follow the standards from the European Computer Manufacturers Association (ECMA) and the
International Organization for Standardization (ISO) on PRI and BRI interfaces.
• Basic calls between IP phones and PBX phones.
• Calling Line/Name Identification (CLIP/CNIP) presented on an IP phone when called by a PBX
phone; in the reverse direction, such information is provided to the called endpoint.
• Connected Line/Name Identification (COLP/CONP) information provided when a PBX phone calls
an IP phone and is connected; in the reverse direction, such information presented on an IP phone.
• Call Forward using QSIG and H.450.3 to support any combination of IP phone and PBX phone,
including an IP phone in the Cisco Unified CME system that is connected to a PBX or an IP phone
in another Cisco Unified CME system across an H.323 network.
• Call forward to the PBX message center according to the configured policy. The other two endpoints
can be a mixture of IP phone and PBX phones.
• Hairpin call transfer, which interworks with a PBX in transfer-by-join mode. Note that
Cisco Unified CME does not support the actual signaling specified for this transfer mode (including
the involved FACILITY message service APDUs) which are intended for an informative purpose
only and not for the transfer functionality itself. As a transferrer (XOR) host, Cisco Unified CME
simply hairpins two call legs to create a connection; as a transferee (XEE) or transfer-to (XTO) host,
it will not be aware of a transfer that is taking place on an existing leg. As a result, the final endpoint
may not be updated with the accurate identity of its peer. Both blind transfer and consult transfer are
supported.
• Message-waiting indicator (MWI) activation or deactivation requests are processed from the PBX
message center.
• The PBX message center can be interrogated for the MWI status of a particular ephone-dn.
• A user can retrieve voice messages from a PBX message center by making a normal call to the
message center access number.
For information about enabling QSIG supplementary services, see the “Enabling H.450.7 and QSIG
Supplementary Services at a System-Level” section on page 633 and “Enabling H.450.7 and QSIG
Supplementary Services on a Dial Peer” section on page 634.
For more information about configuring Cisco Unified CME to integrate with voice-mail systems, see
“Integrating Voice Mail” on page 385.
Disabling SIP Supplementary Services for Call Forward and Call Transfer
If a destination gateway does not support supplementary services, you can disable REFER messages for
call transfers and the redirect responses for call forwarding from being sent by Cisco Unified CME.
Disabling supplementary services is supported if all endpoints use SCCP or all endpoints use SIP. It is
not supported for a mix of SCCP and SIP endpoints.
For configuration information, see the “Disabling SIP Supplementary Services for Call Forward and Call
Transfer” section on page 636.
Cisco Unified Communications Manager Express System Administrator Guide
610 OL-10663-02
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
Typical Network Scenarios for Call Transfer and Call Forwarding
In a mixed network that involves two or more types of call agents or call-control systems, there can be
communication protocol discrepancies and dependencies, and therefore the opportunity for
interoperability errors. These discrepancies show up most often when a call is being transferred or
forwarded. This section provides descriptions of the specific mixed-network scenarios you might
encounter when configuring a router running Cisco CME 3.1 or a later version. Each of the following
sections point to the configuration instructions necessary to ensure call transfer and forwarding
capabilities throughout the network.
• Cisco CME 3.1 or Later and Cisco IOS Gateways, page 611
• Cisco CME 3.0 or an Earlier Version and Cisco IOS Gateways, page 612
• Cisco CME 3.1 or Later, Non-H.450 Gateways, and Cisco IOS Gateways, page 612
• Cisco Unified CME, Non-H.450 Gateways, and Cisco IOS Gateways, page 613
• Cisco CME 3.1 or Later, Cisco Unified Communications Manager, and Cisco IOS Gateways,
page 613
• Cisco CME 3.0 or an Earlier Version, Cisco Unified Communications Manager, and Cisco IOS
Gateways, page 614
Note Cisco Communications Manager Express 3.2 (Cisco CME 3.2) and later versions provide full
call-transfer and call-forwarding with call processing systems on the network that support H.450.2,
H.450.3, and H.450.12 standards. For interoperability with call processing systems that do not support
H.450 standards, Cisco CME 3.2 and later versions provide VoIP-to-VoIP hairpin call routing without
requiring the special Tool Command Language (Tcl) script that was needed in earlier versions of
Cisco Unified CME.
Cisco CME 3.1 or Later and Cisco IOS Gateways
In a network with Cisco CME 3.1 or a later version and Cisco IOS gateways, all systems that might
participate in calls that involve call transfer and call forwarding are capable of supporting the H.450.2,
H.450.3, and H.450.12 standards. This is the simplest environment for operating the Cisco CME 3.1 or
later features.
Configuration for this type of network consists of:
1. Setting up call-transfer and call-forwarding parameters for transfers and forwards that are initiated
on this router (H.450.2 and H.450.3 capabilities for transferred parties, transfer destinations,
forwarded parties, and forwarding destinations are enabled by default). See the “Enabling Call
Transfer and Forwarding at System-Level” section on page 615.
2. Enabling H.450.12 globally to detect any calls on which H.450.2 and H.450.3 standards are not
supported. Although this step is optional, we recommend it. See the “Enabling H.450.12
Capabilities” section on page 627.
3. Optionally setting up VoIP-to-VoIP connections (hairpin call routing or H.450 tandem gateway) to
route calls that do not support H.450.2 or H.450.3 standards. See the “Enabling H.323-to-H.323
Connection Capabilities” section on page 629.
4. Setting up dial peers to manage call legs within the network. See Dial Peer Configuration on Voice
Gateway Routers.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 611
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
Cisco CME 3.0 or an Earlier Version and Cisco IOS Gateways
Before Cisco CME 3.1, H.450.2 and H.450.3 standards are used for all calls by default and routers do
not support the H.450.12 standard.
Configuration for this type of network consists of:
1. Setting up call-transfer and call-forwarding parameters for transfers and forwards that are initiated
on this router (H.450.2 and H.450.3 capabilities for transferred parties, transfer destinations,
forwarded parties, and forwarding destinations are enabled by default). See the “Enabling Call
Transfer and Forwarding at System-Level” section on page 615.
2. Enabling H.450.12 in advertise-only mode on Cisco CME 3.1 or later systems. As each
Cisco CME 3.0 system is upgraded to Cisco CME 3.1 or later, enable H.450.12 in advertise-only
mode. Note that no checking for H.450.2 or H.450.3 support is done in advertise-only mode. When
all Cisco CME 3.0 systems in the network have been upgraded to Cisco CME 3.1 or later, remove
the advertise-only restriction. See the “Enabling H.450.12 Capabilities” section on page 627.
3. Optionally setting up VoIP-to-VoIP connections (hairpin call routing or H.450 tandem gateway) to
route calls that cannot use H.450.2 or H.450.3 standards. See the “Enabling H.323-to-H.323
Connection Capabilities” section on page 629.
4. Setting up dial peers to manage call legs within the network. See Dial Peer Configuration on Voice
Gateway Routers.
Cisco CME 3.1 or Later, Non-H.450 Gateways, and Cisco IOS Gateways
In a network with Cisco CME 3.1 or later, non-H.450 gateways, and Cisco IOS gateways, the H.450.2
and H.450.3 services are provided only to calling endpoints that use H.450.12 to explicitly indicate that
they are capable of H.450.2 and H.450.3 operations. Because the Cisco BTS and Cisco PGW do not
support the H.450.12 standard, calls to and from these systems that involve call transfer or forwarding
are handled using H.323-to-H.323 hairpin call routing.
Configuration for this type of network consists of:
1. Setting up call-transfer and call-forwarding parameters for transfers and forwards that are initiated
on this router (H.450.2 and H.450.3 capabilities for transferred parties, transfer destinations,
forwarded parties, and forwarding destinations are enabled by default). Optionally disable H.450.2
and H.450.3 capabilities on dial peers that point to non-H.450-capable systems such as
Cisco Unified Communications Manager, Cisco BTS, or Cisco PGW. See the “Enabling Call
Transfer and Forwarding at System-Level” section on page 615.
2. Enabling H.450.12 to detect any calls on which H.450.2 and H.450.3 standards are not supported,
either globally or for specific dial peers. See the “Enabling H.450.12 Capabilities” section on
page 627.
3. Setting up VoIP-to-VoIP connections (hairpin call routing or H.450 tandem gateway) to route calls
that do not support H.450.2 or H.450.3 standards. See the “Enabling H.323-to-H.323 Connection
Capabilities” section on page 629.
4. Setting up dial peers to manage call legs within the network. See Dial Peer Configuration on Voice
Gateway Routers.
Note If your network contains a Cisco Unified Communications Manager, also see the instructions in the
“Enabling Interworking with Cisco Unified Communications Manager” section on page 638.
Cisco Unified Communications Manager Express System Administrator Guide
612 OL-10663-02
Configuring Call Transfer and Forwarding
Information About Call Transfer and Forwarding
Cisco Unified CME, Non-H.450 Gateways, and Cisco IOS Gateways
Note Cisco CME 3.0 and Cisco ITS V2.1 systems do not have H.450.12 capabilities.
In a network that contains a mix of Cisco Unified CME versions and at least one non-H.450 gateway, the
simplest configuration approach is to globally disable all H.450.2 and H.450.3 services and force
H.323-to-H.323 hairpin call routing for all transferred and forwarded calls. In this case, you would
enable H.450.12 detection capabilities globally. Alternatively, you could select to enable H.450.12
capability for specific dial peers. In this case, you would not configure H.450.12 capability globally; you
would leave it in its default disabled state.
Configuration for this type of network consists of:
1. Setting up call-transfer and call-forwarding parameters for transfers and forwards that are initiated
on this router (H.450.2 and H.450.3 capabilities for transferred parties, transfer destinations,
forwarded parties, and forwarding destinations are enabled by default). See the “Enabling Call
Transfer and Forwarding at System-Level” section on page 615.
2. Enabling H.450.12 to detect any calls on which H.450.2 and H.450.3 standards are not supported,
either globally or on specific dial peers. See the “Enabling H.450.12 Capabilities” section on
page 627.
3. Setting up VoIP-to-VoIP connections (hairpin call routing or H.450 tandem gateway) to route all
transferred and forwarded calls. See the “Enabling H.323-to-H.323 Connection Capabilities”
section on page 629.
4. Setting up dial peers to manage call legs within the network. See Dial Peer Configuration on Voice
Gateway Routers.
Note If your network contains a Cisco Unified Communications Manager, also see the instructions in the
“Enabling Interworking with Cisco Unified Communications Manager” section on page 638.
Cisco CME 3.1 or Later, Cisco Unified Communications Manager, and Cisco IOS Gateways
In a network with Cisco CME 3.1 or later, Cisco Unified Communications Manager, and Cisco IOS
gateways, Cisco CME 3.1 and later versions support automatic detection of calls to and from
Cisco Unified Communications Manager using proprietary signaling elements that are included with the
standard H.323 message exchanges. The Cisco CME 3.1 or later system uses these detection results to
determine the H.450.2 and H.450.3 capabilities of calls rather than using H.450.12 supplementary
services capabilities exchange, which Cisco Unified Communications Manager does not support. If a
call is detected to be coming from or going to a Cisco Unified Communications Manager endpoint, the
call is treated as a non-H.450 call. All other calls in this type of network are treated as though they
support H.450 standards. Therefore, this type of network should contain only Cisco CME 3.1 or later
and Cisco Unified Communications Manager call-processing systems.
Configuration for this type of network consists of:
1. Setting up call-transfer and call-forwarding parameters for transfers and forwards that are initiated
on this router (H.450.2 and H.450.3 capabilities for transferred parties, transfer destinations,
forwarded parties, and forwarding destinations are enabled by default). See the “Enabling Call
Transfer and Forwarding at System-Level” section on page 615.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 613
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
2. Enabling H.450.12 to detect any calls on which H.450.2 and H.450.3 standards are not supported,
either globally or on specific dial peers. See the “Enabling H.450.12 Capabilities” section on
page 627.
3. Setting up VoIP-to-VoIP connections (hairpin call routing or H.450 tandem gateway) to route all
transferred and forwarded calls that are detected as being to or from
Cisco Unified Communications Manager. See the “Enabling H.323-to-H.323 Connection
Capabilities” section on page 629.
4. Setting up specific parameters for Cisco Unified Communications Manager. See the instructions in
the “Enabling Interworking with Cisco Unified Communications Manager” section on page 638.
5. Setting up dial peers to manage call legs within the network. See Dial Peer Configuration on Voice
Gateway Routers.
Cisco CME 3.0 or an Earlier Version, Cisco Unified Communications Manager, and Cisco IOS
Gateways
Calls between the Cisco Unified Communications Manager and the older Cisco CME 3.0 or
Cisco ITS V2.1 networks need special consideration. Because Cisco CME 3.0 and Cisco ITS V2.1
systems do not support automatic Cisco Unified Communications Manager detection and also do not
natively support H.323-to-H.323 call routing, alternative arrangements are required for these systems.
To configure call transfer and forwarding on the Cisco CME 3.0 router, you can select from the
following three options:
• Use a Tcl script to handle call transfer and forwarding by invoking Tcl-script-based H.323-to-H.323
hairpin call routing (app-h450-transfer.2.0.0.9.tcl or a later version). Enable this script on all VoIP
dial peers and also under telephony-service mode, and set the local-hairpin script parameter to 1.
• Use a loopback-dn mechanism. See “Configuring Loopback Call Routing” on page 929.
• Configure a loopback call path using router physical voice ports.
All three options force use of H.323-to-H.323 hairpin call routing for all calls regardless of whether the
call is from a Cisco Unified Communications Manager or other H.323 endpoint (including
Cisco CME 3.1 or later).
How to Configure Call Transfer and Forwarding
This section contains the following procedures:
SCCP
• Enabling Call Transfer and Forwarding at System-Level, page 615 (required)
• SCCP: Enabling Call Forwarding for a Directory Number, page 620 (required)
• SCCP: Enabling Call Transfer for a Directory Number, page 623 (required)
• SCCP: Configuring Call Transfer Options for Phones, page 624 (optional))
• SCCP: Verifying Call Transfer, page 626 (optional)
• Enabling H.450.12 Capabilities, page 627 (optional)
• Enabling H.323-to-H.323 Connection Capabilities, page 629 (optional)
• Forwarding Calls Using Local Hairpin Routing, page 631 (optional)
Cisco Unified Communications Manager Express System Administrator Guide
614 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
• Enabling H.450.7 and QSIG Supplementary Services at a System-Level, page 633 (optional)
• Enabling H.450.7 and QSIG Supplementary Services on a Dial Peer, page 634 (optional)
• Disabling SIP Supplementary Services for Call Forward and Call Transfer, page 636 (optional)
• Enabling Interworking with Cisco Unified Communications Manager, page 638 (optional)
SIP B2BUA
• SIP: Configuring SIP-to-SIP Phone Call Forwarding, page 644 (required)
• SIP: Configuring Call-Forwarding-All Soft Key URI, page 647 (optional)
• SIP: Specifying Number of 3XX Responses To be Handled, page 648 (optional)
• SIP: Configuring Call Transfer, page 649 (required)
• Disabling SIP Supplementary Services for Call Forward and Call Transfer, page 636 (optional)
Enabling Call Transfer and Forwarding at System-Level
To enable H.450 call transfers and forwards for transferring or forwarding parties; that is, to allow
transfers and forwards to be initiated from a Cisco Unified CME system, perform the following steps.
Note H.450.2 and H.450.3 capabilities are enabled by default for transferred or forwarded parties and
transfer-destination or forward-destination parties. Dial peer settings override the global setting.
Prerequisites
Cisco CME 3.0 or a later version, or Cisco ITS V2.1.
Restrictions
• Call transfers are handled differently depending on the Cisco Unified CME version. See Table 6 on
page 603 for recommendations on selecting a transfer method for your Cisco Unified CME version.
• The transfer-system local-consult command is not supported if the transfer-to destination is on the
Cisco ATA, Cisco VG224, or a SCCP-controlled FXS port.
• The H.450.2 and H.450.3 standards are not supported by Cisco Unified Communications Manager,
Cisco BTS, or Cisco PGW.
• In versions earlier than Cisco Unified CME 4.2, the caller ID displays correctly only after connect;
caller ID does not display correctly at Call Transfer or Call Forward.
Call-Transfer Recall
• Requires Cisco Unified CME 4.3 or a later version.
• Transferor and transfer-to party must be on the same Cisco Unified CME router; transferee party can
be remote to the Cisco Unified CME router.
• Transfer recall is not supported if the transfer-to party has Call Forward Busy enabled or is a member
of any hunt group.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 615
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
• If the transfer-to party has Call Forward No Answer enabled, Cisco Unified CME recalls a
transferred call only if the transfer-recall timeout is set to less than the timeout value set with the
call-forward noan command.
• Recall timer for trunk-line directory number has precedence (set on transferor using trunk
command with transfer-timeout keyword) over the transfer-recall timer. Transfer recall is not
initiated for hairpin transfers.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. transfer-system {blind | full-blind | full-consult [dss] | local-consult}
5. transfer-pattern transfer-pattern [blind]
6. call-forward pattern pattern
7. timeouts transfer-recall seconds
8. transfer-digit-collect {new-call | orig-call}
9. exit
10. voice service voip
11. supplementary-service h450.2
12. supplementary-service h450.3
13. exit
14. dial-peer voice tag voip
15. supplementary-service h450.2
16. supplementary-service h450.3
17. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
616 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 4 transfer-system {blind | full-blind | Specifies the call transfer method.
full-consult [dss] | local-consult}
• blind—Calls are transferred without consultation using
the Cisco proprietary method and a single phone line.
Example: This is the default in versions earlier than
Router(config-telephony)# transfer-system Cisco Unified CME 4.0.
full-consult
• full-blind—Calls are transferred without consultation
using H.450.2 standard methods.
• full-consult—Calls are transferred with consultation
using H.450.2 standard methods and a second phone
line if available. Calls fall back to full-blind if the
second line is unavailable. This is the default in
Cisco Unified CME 4.0 and later versions.
Transfer-system needs to be set at full-consult for the
“transfer by directory” to work. Transfer by directory is
supported by full-consult or blind transfer.
If you want to transfer using
directory/placed/missed/received calls, the
transfer-system needs to be set at full-consult for this to
work appropriately.
When changed to full-consult, you can do "blind
transfer" by selecting the number from the directory
and when the other phone rings, you can press the
soft-key "Transfer" and the call will be transferred to
the number selected and then you can hang up.
• dss—(Optional) Calls are transferred with consultation
to idle monitored lines. All other call-transfer behavior
is identical to full-consult.
• local-consult—Calls are transferred with local
consultation using a second phone line if available. The
calls fall back to blind for nonlocal consultation or
nonlocal transfer target. Not supported if transfer-to
destination is on the Cisco ATA, Cisco VG224, or a
SCCP-controlled FXS port.
• Cisco CME 3.0 and later versions—Use only the
full-blind or full-consult keyword.
• Before Cisco CME 3.0—Use the local-consult or
blind keyword. (Cisco ITS 2.1 can use the full-blind or
full-consult keyword by also using the Tcl script in the
file called app-h450-transfer.x.x.x.x.zip.)
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 617
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 5 transfer-pattern transfer-pattern [blind] Allows transfer of telephone calls by Cisco Unified IP
phones to specified phone number patterns. If no transfer
pattern is set, the default is that transfers are permitted only
Example:
Router(config-telephony)# transfer-pattern .T
to other local IP phones.
• transfer-pattern—String of digits for permitted call
transfers. Wildcards are allowed. A pattern of .T
transfers all calling parties using the H.450.2 standard.
• blind—(Optional) When H.450.2 consultative call
transfer is configured, forces transfers that match the
pattern specified in this command to be executed as
blind transfers. Overrides settings made using the
transfer-system and transfer-mode commands.
Note For transfers to nonlocal numbers, transfer-pattern
digit matching is performed before translation-rule
operations. Therefore, you should specify in this
command the digits actually entered by phone users
before they are translated. For more information,
see “Configuring Dialing Plans” on page 283.
Step 6 call-forward pattern pattern Specifies the H.450.3 standard for call forwarding.
• pattern—Digits to match for call forwarding using the
Example: H.450.3 standard. If an incoming calling-party number
Router(config-telephony)# call-forward pattern matches the pattern, it can be forwarded using the
.T H.450.3 standard. A pattern of .T forwards all calling
parties using the H.450.3 standard.
• Calling-party numbers that do not match the patterns
defined with this command are forwarded using Cisco
proprietary call forwarding for backward compatibility.
Note For forwarding to nonlocal numbers, pattern
matching is performed before translation-rule
operations. Therefore, you should specify in this
command the digits actually entered by phone users
before they are translated. For more information,
see “Configuring Dialing Plans” on page 283.
Step 7 timeouts transfer-recall seconds (Optional) Enables Cisco Unified CME to recall a
transferred call if the transfer-to party is busy or does not
answer.
Example:
Router(config-telephony)# timeouts • seconds—Duration, in seconds, to wait before recalling
transfer-recall 30 a transferred call. Range: 1 to 1800. Default: 0
(disabled).
• This command is supported in Cisco Unified CME 4.3
and later versions.
• This command can also be configured in ephone-dn and
ephone-dn-template configuration mode.
Cisco Unified Communications Manager Express System Administrator Guide
618 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 8 transfer-digit-collect {new-call | orig-call} (Optional) Selects the digit-collection method used for
consultative call transfers.
Example: • new-call—Digits are collected from the new call leg.
Router(config-telephony)# transfer-digit-collec Default value in Cisco Unified CME 4.3 and later
t orig-call versions.
• orig-call—Digits are collected from original call-leg.
Default behavior in versions earlier than
Cisco Unified CME 4.3.
• This command is supported in Cisco Unified CME 4.3
and later versions.
Step 9 exit Exits telephony-service configuration mode.
Example:
Router(config-telephony)# exit
Step 10 voice service voip (Optional) Enters voice-service configuration mode to
establish global call transfer and forwarding parameters.
Example:
Router(config)# voice service voip
Step 11 supplementary-service h450.2 (Optional) Enables H.450.2 supplementary services
capabilities globally.
Example: • Default is enabled. Use the no form of this command to
Router(conf-voi-serv)# supplementary-service disable H.450.2 capabilities globally.
h450.2
• You can also use this command in dial-peer
configuration mode to enable H.450.2 services for a
single dial peer.
Step 12 supplementary-service h450.3 (Optional) Enables H.450.3 supplementary services
capabilities globally.
Example: • Default is enabled. Use the no form of this command to
Router(conf-voi-serv)# supplementary-service disable H.450.3 capabilities globally.
h450.3
• You can also use this command in dial-peer
configuration mode to enable H.450.3 services for a
single dial peer.
Step 13 exit (Optional) Exits voice-service configuration mode.
Example:
Router(conf-voi-serv)# exit
Step 14 dial-peer voice tag voip (Optional) Enters dial-peer configuration mode.
Example:
Router(config)# dial-peer voice 1 voip
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 619
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 15 supplementary-service h450.2 (Optional) Enables H.450.2 supplementary services
capabilities for an individual dial peer.
Example: • Default is enabled. You can also use this command in
Router(config-dial-peer)# no voice-service configuration mode to enable H.450.2
supplementary-service h450.2 services globally.
• If this command is enabled globally and enabled on a
dial peer, the functionality is enabled for the dial peer.
This is the default.
• If this command is enabled globally and disabled on a
dial peer, the functionality is disabled for the dial peer.
• If this command is disabled globally and either enabled
or disabled on a dial peer, the functionality is disabled
for the dial peer.
Step 16 supplementary-service h450.3 (Optional) Enables H.450.3 supplementary services
capabilities exchange for an individual dial peer.
Example: • Default is enabled. You can also use this command in
Router(config-dial-peer)# no voice-service configuration mode to enable H.450.3
supplementary-service h450.3 services globally.
• If this command is enabled globally and enabled on a
dial peer, the functionality is enabled for the dial peer.
This is the default.
• If this command is enabled globally and disabled on a
dial peer, the functionality is disabled for the dial peer.
• If this command is disabled globally and either enabled
or disabled on a dial peer, the functionality is disabled
for the dial peer.
Step 17 end Returns to privileged EXEC mode.
Example:
Router(config-dial-peer)# end
SCCP: Enabling Call Forwarding for a Directory Number
To define the conditions and target numbers for call forwarding for individual ephone-dns, and set other
restrictions for call forwarding, perform the following steps.
Note When defining call forwarding to nonlocal numbers, it is important to note that pattern digit matching is
performed before translation-rule operations. Therefore, you should specify in this command the digits
actually entered by phone users before they are translated. For more information, see the “Voice
Translation Rules and Profiles” section in “Configuring Dialing Plans” on page 283.
SUMMARY STEPS
1. enable
Cisco Unified Communications Manager Express System Administrator Guide
620 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
2. configure terminal
3. telephony-service
4. call-forward pattern pattern
5. exit
6. ephone-dn dn-tag [dual-line]
7. number number [secondary number] [no-reg [both | primary]]
8. call-forward all target-number
9. call-forward busy target-number [primary | secondary] [dialplan-pattern]
10. call-forward noan target-number timeout seconds [primary | secondary] [dialplan-pattern]
11. call-forward night-service target-number
12. call-forward max-length length
13. no forward local-calls
14. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)#
Step 4 call-forward pattern pattern Specifies the H.450.3 standard for call forwarding.
Calling-party numbers that do not match the patterns
defined with this command are forwarded using
Example:
Router(config-telephony)# call-forward pattern
Cisco-proprietary call forwarding for backward
.T compatibility.
• pattern—Digits to match for call forwarding using the
H.450.3 standard. If an incoming calling-party number
matches the pattern, it is forwarded using the H.450.3
standard. A pattern of .T forwards all calling parties
using the H.450.3 standard.
Step 5 exit Exits telephony-service configuration mode.
Example:
Router(config-telephony)# exit
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 621
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 6 ephone-dn dn-tag [dual-line] Enters ephone-dn configuration mode, creates an
ephone-dn, and optionally assigns it dual-line status.
Example: • dual-line—(Optional) Enables an ephone-dn with one
Router(config)# ephone-dn 20 voice port and two voice channels, which supports
features such as call waiting, call transfer, and
conferencing with a single ephone-dn.
Step 7 number number [secondary number] [no-reg [both Configures a valid extension number for this ephone-dn
| primary]] instance.
Example:
Router(config-ephone-dn)# number 2777 secondary
2778
Step 8 call-forward all target-number Forwards all calls for this extension to the specified number.
• target-number—Phone number to which calls are
Example: forwarded.
Router(config-ephone-dn)# call-forward all 2411
Note After you use this command to specify a target
number, the phone user can activate and cancel the
call-forward-all state from the phone using the
CFwdAll soft key or a feature access code (FAC).
Step 9 call-forward busy target-number [primary | Forwards calls for a busy extension to the specified number.
secondary] [dialplan-pattern]
Example:
Router(config-ephone-dn)# call-forward busy
2513
Step 10 call-forward noan target-number timeout seconds Forwards calls for an extension that does not answer.
[primary | secondary] [dialplan-pattern]
Example:
Router(config-ephone-dn)# call-forward noan
2513 timeout 45
Step 11 call-forward night-service target-number Automatically forwards incoming calls to the specified
number when night service is active.
Example: • target-number—Phone number to which calls are
Router(config-ephone-dn)# call-forward forwarded.
night-service 2879
Note Night service must also be configured. See
“Configuring Call-Coverage Features” on page 663.
Step 12 call-forward max-length length (Optional) Limits the number of digits that can be entered
for a target number when using the CfwdAll soft key on an
IP phone.
Example:
Router(config-ephone-dn)# call-forward • length—Number of digits that can be entered using the
max-length 5 CfwdAll soft key on an IP phone.
Cisco Unified Communications Manager Express System Administrator Guide
622 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 13 no forward local-calls (Optional) Specifies that local calls (calls from ephone-dns
on the same Cisco Unified CME system) will not be
forwarded from this extension.
Example:
Router(config-ephone-dn)# no forward • If this extension is busy, an internal caller hears a busy
local-calls signal.
• If this extension does not answer, the internal caller
hears ringback.
Step 14 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
SCCP: Enabling Call Transfer for a Directory Number
To enable call transfer for a specific directory number, perform the following steps. This procedure
overrides the global setting for blind or consultative transfer for individual directory numbers.
Prerequisites
Call transfer must be enabled globally. See the “Enabling Call Transfer and Forwarding at
System-Level” section on page 615.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag [dual-line]
4. transfer-mode {blind | consult}
5. timeouts transfer-recall seconds
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 623
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 3 ephone-dn dn-tag [dual-line] Enters ephone-dn configuration mode, creates an ephone-dn,
and optionally assigns it dual-line status.
Example: • dual-line—(Optional) Enables an ephone-dn with one
Router(config)# ephone-dn 20 voice port and two voice channels, which supports
features such as call waiting, call transfer, and
conferencing with a single ephone-dn.
Step 4 transfer-mode {blind | consult} Specifies the type of call transfer for an individual directory
number using the H.450.2 standard, allowing you to override
the global setting.
Example:
Router(config-ephone-dn)# transfer-mode blind • Default: system-level value set with the transfer-system
command.
Step 5 timeouts transfer-recall seconds (Optional) Enables call-transfer recall and sets the number of
seconds that Cisco Unified CME waits before recalling a
transferred call if the transfer-to party does not answer or is
Example:
Router(config-ephone-dn)# timeouts
busy.
transfer-recall 30 • seconds—Duration, in seconds, to wait before recalling a
transferred call. Range: 1 to 1800. Default: 0 (disabled).
• This command is supported in Cisco Unified CME 4.3
and later versions.
• This command can also be configured in
ephone-dn-template and telephony-service configuration
mode.
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
SCCP: Configuring Call Transfer Options for Phones
To specify a maximum number of digits for transfer destinations or block transfers to external
destinations by individual phones, perform the following steps.
Restrictions
• Transfers made to speed-dial numbers are not blocked when the transfer-pattern blocked
command is used.
• Transfers made using speed-dial are not blocked by the after-hours block pattern command.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-template template-tag
4. transfer-pattern blocked
Cisco Unified Communications Manager Express System Administrator Guide
624 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
5. transfer max-length digit-length
6. exit
7. ephone phone-tag
8. ephone-template template-tag
9. restart
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-template template-tag Enters ephone-template configuration mode.
• template-tag—Unique number that identifies this
Example: template during configuration tasks. Range: 1 to 20.
Router(config)# ephone-template 1
Step 4 transfer-pattern blocked (Optional) Prevents directory numbers on the phone to
which this template is applied from transferring calls to
patterns specified in the transfer-pattern
Example:
Router(config-ephone-template)#
(telephony-service) command.
transfer-pattern blocked Note This command is also available in ephone
configuration mode to block external transfers from
individual phones without using a template.
Step 5 transfer max-length digit-length (Optional) Specifies the maximum number of digits the user
can dial when transferring a call.
Example: • digit-length—Number of digits allowed in a number to
Router(config-ephone-template)# transfer which a call is being transferred. Range: 3 to 16.
max-length 8 Default: 16.
Step 6 exit Exits ephone-template configuration mode.
Example:
Router(config-ephone-template)# exit
Step 7 ephone phone-tag Enters ephone configuration mode.
Example:
Router(config)# ephone 25
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 625
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 8 ephone-template template-tag Applies a template to a phone.
• template-tag—Template number that you want to apply
Example: to this phone.
Router(config-ephone)# ephone-template 1
Step 9 restart Performs a fast reboot of this phone without contacting the
DHCP server for updated information.
Example: • Repeat Step 6 to Step 9 for each phone on which you
Router(config-ephone)# restart want to limit transfer capabilities.
Step 10 end Exits to privileged EXEC mode.
Example:
Router(config-ephone)# end
SCCP: Verifying Call Transfer
Step 1 Use the show running-config command to verify your configuration. Transfer method and patterns are
listed in the telephony-service portion of the output. You can also use the show telephony-service
command to display this information.
Router# show running-config
!
telephony-service
fxo hook-flash
load 7910 P00403020214
load 7960-7940 P00305000600
load 7914 S00103020002
load 7905 CP7905040000SCCP040701A
max-ephones 100
max-dn 500
ip source-address 10.115.33.177 port 2000
max-redirect 20
no service directed-pickup
timeouts ringing 10
voicemail 7189
max-conferences 8 gain -6
moh music-on-hold.au
web admin system name cisco password cisco
dn-webedit
time-webedit
transfer-system full-consult
transfer-pattern 92......
transfer-pattern 91..........
transfer-pattern 93......
transfer-pattern 94......
transfer-pattern 95......
transfer-pattern 96......
transfer-pattern 97......
transfer-pattern 98......
transfer-pattern 99......
transfer-pattern .T
secondary-dialtone 9
!
create cnf-files version-stamp 7960 Jul 13 2004 03:39:28
Cisco Unified Communications Manager Express System Administrator Guide
626 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Step 2 If you have used the transfer-mode command to override the global transfer mode for an individual
ephone-dn, use the show running-config or show telephony-service ephone-dn command to verify that
setting.
Router# show running-config
!
ephone-dn 40 dual-line
number 451
description Main Number
huntstop channel
no huntstop
transfer-mode blind
Step 3 Use the show telephony-service ephone-template command to view ephone-template configurations.
Enabling H.450.12 Capabilities
To enable H.450.12 capabilities globally or by individual dial peer when not all gateway endpoints in
your network support H.450.2 and H.450.3 standards, perform the following steps. H.450.12 capabilities
are disabled by default to minimize the risk of compatibility issues with other types of H.323 systems.
Settings for individual dial peers override the global setting.
Restrictions
Cisco CME 3.0 and earlier versions do not support H.450.12.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice service voip
4. supplementary-service h450.12 [advertise-only]
5. exit
6. dial-peer voice tag voip
7. supplementary-service h450.12
8. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 627
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice service voip (Optional) Enters voice service configuration mode to
establish global call transfer and forwarding parameters.
Example:
Router(config)# voice service voip
Step 4 supplementary-service h450.12 [advertise-only] (Optional) Enables H.450.12 supplementary services
capabilities globally for VoIP endpoints.
Example: • This command enables call-by-call detection of H.450
Router(conf-voi-serv)# supplementary-service capabilities when some endpoints in your mixed
h450.12 network are H.450-capable and other endpoints are not.
This command is disabled by default.
• advertise-only—(Optional) Advertises H.450
capabilities to the remote end but does not require
H.450.12 responses. Use this keyword on
Cisco CME 3.1 or later systems if you have a mixed
network containing Cisco CME 3.0 systems.
This command is also used in dial-peer configuration mode
to affect an individual dial peer.
Step 5 exit (Optional) Exits voice-service configuration mode.
Example:
Router(conf-voi-serv)# exit
Step 6 dial-peer voice tag voip (Optional) Enters dial-peer configuration mode.
Example:
Router(config)# dial-peer voice 1 voip
Cisco Unified Communications Manager Express System Administrator Guide
628 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 7 supplementary-service h450.12 (Optional) Enables H.450.12 supplementary services
capabilities for an individual dial peer. This command is
disabled by default.
Example:
Router(config-dial-peer)# supplementary-service This command is also used in voice-service configuration
h450.12 mode to enable H.450.12 services globally.
• If this command is enabled globally and enabled on a
dial peer, the functionality is enabled for the dial peer.
• If this command is enabled globally and disabled on a
dial peer, the functionality is enabled for the dial peer.
• If this command is disabled globally and enabled on a
dial peer, the functionality is enabled for the dial peer.
• If this command is disabled globally and disabled on a
dial peer, the functionality is disabled for the dial peer.
This is the default.
Step 8 end Returns to privileged EXEC mode.
Example:
Router(config-dial-peer)# end
Enabling H.323-to-H.323 Connection Capabilities
VoIP-to-VoIP connections permit the termination and reorigination of transferred and forwarded calls
over the VoIP network. VoIP-to-VoIP connections are used for hairpin call routing and for H.450 tandem
gateways. The only type of VoIP-to-VoIP connection that is supported by Cisco CME 3.1 or a later
version is H.323-to-H.323 connection.
VoIP-to-VoIP connections are disabled on the router by default, and they must be explicitly enabled to
make use of hairpin call routing or an H.450 tandem gateway. In addition, you must configure a
mechanism to direct transferred or forwarded calls to the hairpin or the H.450 tandem gateway, using
one of the following methods:
• Enable H.450.12 capabilities globally or on the routes that your transfers and forwards take. See the
“Enabling H.450.12 Capabilities” section on page 627.
• Explicitly disable H.450.2 and H.450.3 capabilities globally or on the routes that your transfers and
forwards take. See the “Enabling Call Transfer and Forwarding at System-Level” section on
page 615.
Restrictions
• Codecs on all the VoIP dial peers of the H.450 tandem gateway must be the same.
• Only one codec type is supported in the VoIP network at a time, and there are only two codec
choices: G.711 (A-law or mu-law) or G.729.
• Transcoding is not supported.
• Codec renegotiation is not supported. For example, if an H.323 call that uses a G.729 codec is
received by a Cisco Unified CME system and is forwarded to a voice-mail system that requires a
G.711 codec, the codec cannot be renegotiated from G.729 to G.711.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 629
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
• H.323-to-SIP hairpin call routing is supported only with Cisco Unity Express. For more
information, see Integrating Cisco CallManager Express with Cisco Unity Express.
• Cisco Unified Communications Manager must use a media termination point (MTP), intercluster
trunk (ICT) mode, and slow start.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice service voip
4. allow-connections h323 to h323
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice service voip Enters voice service configuration mode to establish global
call transfer and forwarding parameters.
Example:
Router(config)# voice service voip
Step 4 allow-connections h323 to h323 Enables VoIP-to-VoIP call connections. Use the no form of
the command to disable VoIP-to-VoIP connections; this is
the default.
Example:
Router(conf-voi-serv)# allow-connections h323
to h323
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-voi-serv)# end
Cisco Unified Communications Manager Express System Administrator Guide
630 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Forwarding Calls Using Local Hairpin Routing
When Cisco Unified CME is used to forward calls that originate on phones that do not support the
H.450.3 standard such as Cisco Unified Communications Manager phones, local hairpin routing must be
used to forward the calls. For calling parties whose numbers match the pattern specified, the system
automatically detects whether H.450.3 is supported and uses the appropriate method to forward calls.
To enable hairpin routing, you must denote the originating and terminating legs of the hairpin. To
forward calls to Cisco Unity Express, connections must be allowed to a SIP trunk.
Optionally, you can disable the use of H.450.3 but this is not required because the system automatically
detects calls on which H.450.3 is not supported and local hairpin routing is required when the
calling-party numbers match the pattern specified.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. call-forward pattern pattern
5. calling-number local
6. exit
7. voice service voip
8. allow connections from-type to to-type
9. supplementary-service h450.3
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 631
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 4 call-forward pattern pattern Specifies the calling-party numbers for which to allow call
forwarding with automatic detection of whether H.450.3 is
supported. If H.450.3 is supported, H.450.3 is used for the
Example:
Router(config-telephony)# call-forward pattern
forward and, if not, local hairpin is used.
6000 • pattern—Digits to match for call forwarding. A pattern
of .T forwards all calling parties.
Step 5 calling-number local (Optional) Replaces a calling-party number and name with
the forwarding-party (local) number and name for
hairpin-forwarded calls only.
Example:
Router(config-telephony)# calling-number local • Before Cisco CME 3.3, this command must be used
with Tool Command Language (Tcl) script
app-h450-transfer.2.0.0.7 or a later version. The
local-hairpin attribute-value (AV) pair must be set to 1.
Step 6 exit Exits telephony-service configuration mode.
Example:
Router(config-telephony)# exit
Step 7 voice service voip Enters voice-service configuration mode.
Example:
Router(config)# voice service voip
Step 8 allow connections from-type to to-type Allows connections between specific types of endpoints in
a network.
Example: • from-type—Originating endpoint type. Valid choices
Router(conf-voi-serv)# allow connections h323 are h323 and sip.
to sip
• to-type—Terminating endpoint type. Valid choices are
h323 and sip.
Step 9 supplementary-service h450.3 (Optional) Enables H.450.3 supplementary services
capabilities exchange globally. This is the default. Use the
no form of this command to disable H.450.3 capabilities
Example:
Router(conf-voi-serv)# no supplementary-service
globally. This command can also be used in dial-peer
h450.3 configuration mode to disable H.450.3 functionality for a
single dial peer.
Note If this command is disabled globally and either
enabled or disabled on a dial peer, the functionality
is disabled for the dial peer.
Step 10 end Exits to privileged EXEC mode.
Example:
Router(config-voi-serv)# end
Cisco Unified Communications Manager Express System Administrator Guide
632 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Enabling H.450.7 and QSIG Supplementary Services at a System-Level
To enable H.4350.7 capabilities and QSIG supplementary services on all dial peers, perform the
following steps.
Prerequisites
Cisco Unified CME 4.0 or a later version.
Restrictions
• QSIG integration supports SCCP phones only.
• QSIG integration is exclusive; once QSIG integration is configured, QSIG transit node capability is
disabled. There is no dial-peer control to enable either transit or originate/terminate capability on a
call by call basis.
• If you enable QSIG supplementary services at a system-level, you cannot disable the capability on
individual dial peers.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice service voip
4. supplementary-service h450.7
5. qsig decode
6. exit
7. voice service pots
8. supplementary-service qsig call-forward
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 633
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 3 voice service voip Enters VoIP voice-service configuration mode to define
global call transfer and forwarding parameters.
Example:
Router(config)# voice service voip
Step 4 supplementary-service h450.7 Enables H.450.7 supplementary services capabilities
exchange at a system-level.
Example:
Router(config-voi-serv)# supplementary-service
h450.7
Step 5 qsig decode Enables decoding for QSIG supplementary services.
Example:
Router(config-voi-serv)# qsig decode
Step 6 exit Exits VoIP voice-service configuration mode.
Example:
Router(config-voi-serv)# exit
Step 7 voice service pots Enters POTS voice-service configuration mode to define
global call transfer and forwarding parameters.
Example:
Router(config)# voice service pots
Step 8 supplementary-service qsig call-forward Enables QSIG call-forwarding supplementary services
(ISO 13873) to forward calls to another number.
Example:
Router(config-voi-serv)# supplementary-service
qsig call-forward
Step 9 end Exits to privileged EXEC mode.
Example:
Router(config-voi-serv)# end
Enabling H.450.7 and QSIG Supplementary Services on a Dial Peer
To enable H.4350.7 capabilities and QSIG supplementary services on an individual dial peer, perform
the following steps.
Prerequisites
Cisco Unified CME 4.0 or a later version.
Restrictions
• QSIG integration supports SCCP phones only.
Cisco Unified Communications Manager Express System Administrator Guide
634 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
• QSIG integration is exclusive; once QSIG integration is configured, QSIG transit node capability is
disabled. There is no dial-peer control to enable either transit or originate/terminate capability on a
call by call basis.
• If you enable QSIG supplementary services at a system-level, you cannot enable or disable the
capability on individual dial peers.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice service voip
4. qsig decode
5. exit
6. dial-peer voice tag voip
7. supplementary-service h450.7
8. exit
9. dial-peer voice tag pots
10. supplementary-service qsig call-forward
11. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice service voip Enters VoIP voice-service configuration mode to define
global call transfer and forwarding parameters.
Example:
Router(config)# voice service voip
Step 4 qsig decode Enables decoding for QSIG supplementary services.
Example:
Router(config-voi-serv)# qsig decode
Step 5 exit Exits VoIP voice-service configuration mode.
Example:
Router(config-voi-serv)# exit
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 635
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 6 dial-peer voice tag voip Enters dial-peer configuration mode to define parameters
for an individual dial peer.
Example:
Router(config)# dial-peer voice 1 voip
Step 7 supplementary-service h450.7 Enables H.450.7 supplementary services capabilities
exchange on a single dial peer.
Example:
Router(config-dial-peer)# supplementary-service
h450.7
Step 8 exit Exits dial-peer configuration mode.
Example:
Router(config-dial-peer)# exit
Step 9 dial-peer voice tag pots Enters dial-peer configuration mode to define parameters
for an individual dial peer.
Example:
Router(config)# dial-peer voice 2 pots
Step 10 supplementary-service qsig call-forward Enables QSIG call-forwarding supplementary services
(ISO 13873) to forward calls to another number.
Example:
Router(config-dial-peer)# supplementary-service
qsig call-forward
Step 11 end Exits to privileged EXEC mode.
Example:
Router(config-dial-peer)# end
Disabling SIP Supplementary Services for Call Forward and Call Transfer
To disable REFER messages for call transfers or redirect responses for call forwarding from being sent
to the destination by Cisco Unified CME, perform the following steps. You can disable these
supplementary features if the destination gateway does not support them.
Prerequisites
Cisco Unified CME 4.1 or a later version.
Restrictions
• Disabling supplementary services is supported only when all endpoints are SCCP or all endpoints
are SIP. It does not support a mix of SCCP and SIP endpoints.
Cisco Unified Communications Manager Express System Administrator Guide
636 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
• In Cisco Unified CME 4.2 and 4.3, when the supplementary-service sip refer command is enabled
(default) and both the caller being transferred (transferee) and the phone making the transfer
(transferor) are SIP, but the transfer-to phone is SCCP, Cisco Unified CME hairpins the call to the
transfer-to phone after receiving the REFER request from transferor instead of sending the REFER
request to the transferee.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice service voip
or
dial-peer voice tag voip
4. no supplementary-service sip moved-temporarily
5. no supplementary-service sip refer
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice service voip Enters voice-service configuration mode to set global
or parameters for VoIP features.
dial-peer voice tag voip or
Enters dial peer configuration mode to set parameters for a
Example: specific dial peer.
Router(config)# voice service voip
or
Router(config)# dial-peer voice 99 voip
Step 4 no supplementary-service sip moved-temporarily Disables SIP redirect response for call forwarding either
globally or for a dial peer.
Example: • Sending redirect message to the destination is the
Router(conf-voi-serv)# no supplementary-service default behavior.
sip moved-temporarily
or
Router(config-dial-peer)# no
supplementary-service sip moved-temporarily
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 637
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 5 no supplementary-service sip refer Disables SIP REFER message for call transfers either
globally or for a dial peer.
Example: • Sending REFER message to the destination is the
Router(conf-voi-serv)# no supplementary-service default behavior.
sip refer
or
Router(config-dial-peer)# no
supplementary-service sip refer
Step 6 end Exits to privileged EXEC mode.
Example:
Router(config-voi-serv)# end
or
Router(config-dial-peer)# end
Enabling Interworking with Cisco Unified Communications Manager
If Cisco CME 3.1 or later and Cisco Unified Communications Manager are used in the same network,
some additional configuration is necessary, as described in the following sections:
• Configuring Cisco CME 3.1 or Later to Interwork with Cisco Unified Communications Manager,
page 639
• Enabling Cisco Unified Communications Manager to Interwork with Cisco Unified CME, page 642
• Troubleshooting Transfer and Forwarding Configuration, page 643
Figure 15 shows a network containing Cisco Unified CME and Cisco Unified Communications
Manager systems.
Cisco Unified Communications Manager Express System Administrator Guide
638 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Figure 15 Network with Cisco Unified CME and Cisco Unified Communications Manager
Cisco Unified CallManager 1 Cisco Unified CallManager 2
IP IP
Cisco Unified CallManager 3
Phone 1 Phone 2
4001 4002 H.323 Connection
in ICT mode using slow start
Media Termination Point (MTP)
V
Cisco Unified CallManager Network VoIP
Cisco Unified CME Network
PSTN
Cisco Unified CME 1 Cisco Unified CME 2 Cisco Unified CME 3
V V V
Telephone
IP IP IP IP IP IP
146621
Phone 3 Phone 4 Phone 5 Phone 6 Phone 7 Phone 8
1001 1002 2001 2002 3001 3002
Prerequisites
• Cisco Unified CME must be configured to forward calls using local hairpin routing. For
configuration information, see the “Forwarding Calls Using Local Hairpin Routing” section on
page 631.
Configuring Cisco CME 3.1 or Later to Interwork with Cisco Unified Communications Manager
All of the commands in this section are optional because they are set by default to work with
Cisco Unified Communications Manager. They are included here only to explain how to implement
optional capabilities or return nondefault settings to their defaults.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice service voip
4. h323
5. telephony-service ccm-compatible
6. h225 h245-address on-connect
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 639
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
7. exit
8. supplementary-service h225-notify cid-update
9. exit
10. voice class h323 tag
11. telephony-service ccm-compatible
12. h225 h245-address on-connect
13. exit
14. dial-peer voice tag voip
15. supplementary-service h225-notify cid-update
16. voice-class h323 tag
17. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice service voip Enters voice-service configuration mode to establish global
parameters.
Example:
Router(config)# voice service voip
Step 4 h323 Enters H.323 voice-service configuration mode.
Example:
Router(conf-voi-serv)# h323
Step 5 telephony-service ccm-compatible (Optional) Globally enables a Cisco CME 3.1 or later
system to detect Cisco Unified Communications Manager
and exchange calls with it. This is the default.
Example:
Router(conf-serv-h323)# telephony-service • Use the no form of this command to disable
ccm-compatible Cisco Unified Communications Manager detection and
exchange. We do not recommend using the no form of
the command.
• Using this command in an H.323 voice class definition
allows you to specify this behavior for an individual
dial peer.
Cisco Unified Communications Manager Express System Administrator Guide
640 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 6 h225 h245-address on-connect (Optional) Globally enables a delay for the H.225 message
exchange of an H.245 transport address until a call is
connected. The delay allows
Example:
Router(conf-serv-h323)# h225 h245-address
Cisco Unified Communications Manager to generate local
on-connect ringback for calls to Cisco Unified CME phones. This is the
default.
• The no form of this command disables the delay. We do
not recommend using the no form of the command.
• Using this command in an H.323 voice class definition
allows you to specify this behavior for an individual
dial peer.
Step 7 exit Exits H.323 voice-service configuration mode.
Example:
Router(conf-serv-h323)# exit
Step 8 supplementary-service h225-notify cid-update (Optional) Globally enables H.225 messages with caller-ID
updates to be sent to Cisco Unified Communications
Manager. This is the default.
Example:
Router(conf-voi-serv)# supplementary-service • The no form of the command disables caller-ID update.
h225-notify cid-update We do not recommend using the no form of the
command.
This command is also used in dial-peer configuration mode
to affect a single dial peer.
• If this command is enabled globally and enabled on a
dial peer, the functionality is enabled for that dial peer.
This is the default.
• If this command is enabled globally and disabled on a
dial peer, the functionality is disabled for that dial peer.
• If this command is disabled globally and either enabled
or disabled on a dial peer, the functionality is disabled
for that dial peer.
Step 9 exit Exits voice-service configuration mode.
Example:
Router(config-voice-service)# exit
Step 10 voice class h323 tag (Optional) Creates a voice class that contains commands to
be applied to one or more dial peers.
Example:
Router(config)# voice class h323 48
Step 11 telephony-service ccm-compatible (Optional) Enables the dial peer to exchange calls with a
Cisco Unified Communications Manager system when this
voice class is applied to a dial peer. This is the default.
Example:
Router(config-voice-class)# telephony-service • The no form of the command disables call exchange
ccm-compatible with Cisco Unified Communications Manager. We do
not recommend using the no form of the command.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 641
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 12 h225 h245-address on-connect (Optional) Enables the calls that use this dial peer to delay
the exchange of H.225 messages that contain the H.245
transport address until calls are connected, when this voice
Example:
Router(config-voice-class)# h225 h245-address
class is applied to a dial peer. The delay allows the playing
on-connect of local ringback for calls from
Cisco Unified Communications Manager. This is the
default.
• The no form of this command disables the delay. We do
not recommend using the no form of the command.
Step 13 exit Exits voice-class configuration mode.
Example:
Router(config-voice-class)# exit
Step 14 dial-peer voice tag voip (Optional) Enters dial-peer configuration mode to set
parameters for an individual dial peer.
Example:
Router(config)# dial-peer voice 28 voip
Step 15 supplementary-service h225-notify cid-update (Optional) Enables H.225 messages with caller-ID updates
to Cisco Unified Communications Manager for a specific
dial peer. This is the default.
Example:
Router(config-dial-peer)# no • The no form of the command disables caller-ID
supplementary-service h225-notify cid-update updates. We do not recommend using the no form of the
command.
Step 16 voice-class h323 tag (Optional) Applies the previously defined voice class with
the specified tag number to this dial peer.
Example:
Router(config-dial-peer)# voice-class h323 48
Step 17 end Exits to privileged EXEC mode.
Example:
Router(config-dial-peer)# end
What to Do Next
Set up Cisco Unified Communications Manager using the configuration procedure in the “Enabling
Cisco Unified Communications Manager to Interwork with Cisco Unified CME” section on page 642.
Enabling Cisco Unified Communications Manager to Interwork with Cisco Unified CME
To enable Cisco Unified Communications Manager to interwork with Cisco CME 3.1 or a later version,
perform the following steps in addition to the normal Cisco Unified Communications Manager
configuration.
SUMMARY STEPS
1. Set Cisco Unified Communications Manager service parameters.
Cisco Unified Communications Manager Express System Administrator Guide
642 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
2. Configure Cisco Unified CME as an ICT in the Cisco Unified Communications Manager network.
3. Ensure that the Cisco Unified Communications Manager network uses an MTP.
4. Set up dial peers to establish routing.
DETAILED STEPS
Step 1 Set Cisco Unified Communications Manager service parameters. From Cisco Unified Communications
Manager Administration, choose Service Parameters. Choose the Cisco Unified Communications
Manager service, and make the following settings:
• Set the H323 FastStart Inbound service parameter to False.
• Set the Send H225 User Info Message service parameter to H225 Info for Ring Back.
Step 2 Configure Cisco Unified CME as an ICT in the Cisco Unified Communications Manager network. For
information about different intercluster trunk types and configuration instructions, see the
Cisco Unified Communications Manager documentation.
Step 3 Ensure that the Cisco Unified Communications Manager network uses an MTP. The MTP is required to
provide DSP resources for transcoding and for sending and receiving G.729 calls to Cisco Unified CME.
All media streams between Cisco Unified Communications Manager and Cisco Unified CME must pass
through the MTP because Cisco CME 3.1 does not support transcoding. For more information, see the
Cisco Unified Communications Manager documentation.
Step 4 Set up dial peers to establish routing using the instructions in the Dial Peer Configuration on Voice
Gateway Routers guide.
Troubleshooting Transfer and Forwarding Configuration
Step 1 If you encounter lack of ringback on direct calls from a Cisco Unified Communications Manager phone
to an IP phone on a Cisco Unified CME system, check the show running-config command output to
ensure that the following two commands do not appear: no h225 h245-address on-connect and no
telephony-service ccm-compatible. These commands should be enabled, which is their default state.
Step 2 Use the debug h225 asn1 command to display the H.323 messages that are sent from the
Cisco Unified CME system to the Cisco Unified Communications Manager system to see if the H.245
address is being sent too early.
Step 3 For calls that are routed using VoIP-to-VoIP connections, use the show voip rtp connections detail
command to display the call identification number, IP addresses, and port numbers involved for all VoIP
call legs. This command includes VoIP-to-POTS and VoIP-to-VoIP call legs. The following is sample
output for this command:
Router# show voip rtp connections detail
VoIP RTP active connections :
No. CallId dstCallId LocalRTP RmtRTP LocalIP RemoteIP
1 7 8 16586 22346 172.27.82.2 172.29.82.2
2 8 7 17010 16590 172.27.82.2 209.165.202.129
Found 2 active RTP connections
Step 4 Use the show call prompt-mem-usage detail command to see information on ringback tone generation
that uses the interactive voice response (IVR) prompt playback mechanism. This ringback is needed for
hairpin transfers that are committed during the alerting-of-the-transfer-destination phase of the call and
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 643
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
for calls to destinations that do not provide in-band ringback tone, such as IP phones (FXS analog ports
do provide in-band ringback tone). Ringback tone is played to the transferred party by the
Cisco Unified CME system that performs the transfer (the system attached to the transferring party). The
system automatically generates tone prompts as needed based on the network-locale setting for the
Cisco Unified CME system.
If you are not getting ringback tone when you should, use the show call prompt-mem-usage command
to ensure that the correct prompt is loaded and playing. The following sample output indicates that a
prompt is playing (“Number of prompts playing”) and indicates the country code used for the prompt
(GB for Great Britain) and the codec.
Router# show call prompt-mem-usage detail
Prompt memory usage:
config'd wait active free mc total ms total
file(s) 0200 0001 -001 00200 00001 00002
memory 02097152 00003000 00000000 02094152 00003000
Prompt load counts: (counters reset 0)
success 0(1st try) 0(2nd try), failure 0
Other mem block usage:
mcDynamic mcReader
gauge 00001 00001
Number of prompts playing: 1
Number of start delays : 0
MCs in the ivr MC sharing table
===============================
Media Content: NoPrompt (0x83C64554)
URL:
cid=0, status=MC_READY size=24184 coding=g711ulaw refCount=0
Media Content: tone://GB_g729_tone_ringback (0x83266EC8)
URL: tone://GB_g729_tone_ringback
SIP: Configuring SIP-to-SIP Phone Call Forwarding
To configure SIP-to-SIP call forwarding using a back-to-back user agent (B2BUA) which allows call
forwarding on any dial peer, perform the following steps.
Prerequisites
• Cisco CME 3.4 or a later version.
• Connections between specific types of endpoints in a Cisco IP-to-IP gateway must be configured by
using the allow-connections command. For configuration information, see the “Enabling Calls in
Your VoIP Network” on page 80.
Restrictions
• SIP-to-SIP call forwarding is invoked only if that phone is dialed directly. Call forwarding is not
invoked when the phone number is called through a sequential, longest-idle, or peer hunt group.
• If call forwarding is configured for a hunt group member, call forward is ignored by the hunt group.
• In Cisco Unified CME 4.1 and later versions, Call Forward All requires SIP phones to be configured
with a directory number (using dn keyword in number command); direct line numbers are not
supported.
Cisco Unified Communications Manager Express System Administrator Guide
644 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register dn dn-tag
4. call-forward b2bua all directory-number
5. call-forward b2bua busy directory-number
6. call-forward b2bua mailbox directory-number
7. call-forward b2bua noan directory-number timeout seconds
8. call-forward b2bua unreachable directory-number
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register dn dn-tag Enters voice register dn mode to define a directory number
for a SIP phone, intercom line, voice port, or an MWI.
Example:
Router(config)# voice register dn 1
Step 4 call-forward b2bua all directory- number Enables call forwarding for a SIP back-to-back user agent so
that all incoming calls will be forwarded to the designated
directory-number.
Example:
Router(config-register-dn)# call-forward b2bua • In Cisco CME 3.4 and Cisco Unified CME 4.0, this
all 5005 command is also available in voice register pool
configuration mode. The configuration under voice
register dn takes precedence over the configuration
under voice register pool.
• If the call-forward b2bua all command is configured in
voice register pool configuration mode, it applies to all
directory numbers on the phone.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 645
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 5 call-forward b2bua busy directory- number Enables call forwarding for a SIP back-to-back user agent so
that incoming calls to an extension that is busy will be
forwarded to the designated directory number.
Example:
Router(config-register-dn)# call-forward b2bua • In Cisco CME 3.4 and Cisco Unified CME 4.0, this
busy 5006 command is also available in voice register pool
configuration mode. The configuration under voice
register dn takes precedence over the configuration
under voice register pool.
Step 6 call-forward b2bua mailbox directory- number Enables call forwarding for a SIP back-to-back user agent so
that incoming calls that have been forwarded to a busy or
no-answer extension will be forwarded to the recipient’s
Example:
Router(config-register-dn)# call-forward b2bua
voice mail.
mailbox 5007 • In Cisco CME 3.4 and Cisco Unified CME 4.0, this
command is also available in voice register pool
configuration mode. The configuration under voice
register dn takes precedence over the configuration
under voice register pool.
Step 7 call-forward b2bua noan directory- number Enables call forwarding for a SIP back-to-back user agent so
timeout seconds that incoming calls to an extension that does not answer will
be forwarded to the designated directory number.
Example: • In Cisco CME 3.4 and Cisco Unified CME 4.0, this
Router(config-register-dn)# call-forward b2bua command is also available in voice register pool
noan 5010 timeout 10
configuration mode. The configuration under voice
or
register dn takes precedence over the configuration
Router(config-register-pool)# call-forward under voice register pool.
b2bua noan 5010 timeout 10
• timeout seconds—Duration that a call can ring before it
is forwarded to the destination directory number. Range:
3 to 60000. Default: 20.
Step 8 call-forward b2bua unreachable directory- (Optional) Enables call forwarding for a SIP back-to-back
number user agent so that calls can be forwarded to a phone that has
not registered in Cisco Unified CME.
Example: • Target directory-number must be configured in
Router(config-register-dn)# call-forward b2bua Cisco Unified CME.
unreachable 5009
or • In Cisco CME 3.4 and Cisco Unified CME 4.0, this
command is also available in voice register pool
Router(config-register-pool)# call-forward
b2bua unreachable 5009 configuration mode. The configuration under voice
register dn takes precedence over the configuration
under voice register pool.
• This command was removed in Cisco Unified CME 4.1.
Step 9 end Exits to privileged EXEC mode.
Example:
Router(config-register-dn)# end
Cisco Unified Communications Manager Express System Administrator Guide
646 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
SIP: Configuring Call-Forwarding-All Soft Key URI
To specify the uniform resource identifier (URI) for the call forward all (CfwdAll) soft key on supported
SIP phones, perform the following steps. This URI and the call forward number is sent to
Cisco Unified CME when a user enables Call Forward All on a SIP phone.
Prerequisites
• Cisco Unified CME 4.1 or a later version.
• The mode cme command must be enabled in Cisco Unified CME.
• Call Forward All must be enabled on the directory number. For information, see “SIP: Configuring
SIP-to-SIP Phone Call Forwarding” on page 644.
Restrictions
• This feature is supported only on Cisco Unified IP Phone 7911G, 7941G, 7941GE, 7961G, 7961GE,
7970G, and 7971GE.
• If a user enables Call Forward All using the CfwdAll soft key, it is enabled on the primary line.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. call-feature-uri cfwdall service-uri
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to set
global parameters for all supported SIP phones in a
Cisco Unified CME environment.
Example:
Router(config)# voice register global
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 647
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 4 call-feature-uri cfwdall service-uri Specifies the URI for soft keys on SIP phones connected to
a Cisco Unified CME router.
Example:
Router(config-register-global)#
call-feature-uri cfwdall
http://1.4.212.11/cfwdall
Step 5 end Exits to privileged EXEC mode.
Example:
Router(config-register-global)# end
SIP: Specifying Number of 3XX Responses To be Handled
To specify how many subsequent 3XX responses an originating SIP phone can handle for a single call
when the terminating side is a forwarding party which does not use B2BUA, perform the following steps.
Prerequisites
• Cisco CME 3.4 or a later version.
• The mode cme command must be enabled
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. phone-redirect-limit number
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
648 OL-10663-02
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
Command or Action Purpose
Step 3 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Step 4 phone-redirect-limit number Changes the default number of 3XX responses a SIP phone
that originates a call can handle for a single call.
Example: • Default: 5.
Router(config-register-global)#
phone-redirect-limit 8
Step 5 end Exits to privileged EXEC mode.
Example:
Router(config-register-global)# end
SIP: Configuring Call Transfer
To create and apply a template to enable call transfer softkeys on an individual SIP phone in
Cisco Unified CME, perform the following steps.
Prerequisites
Cisco CME 3.4 or a later version.
Restrictions
• Blind transfer is not supported on certain phones such as Cisco Unified IP Phone 7911G, 7941G,
7941GE, 7961G, 7961GE, 7970G, or 7971GE.
• In Cisco Unified CME 4.1, the soft key display can be customized only for certain IP phones, such
as Cisco Unified IP Phone 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE. For
configuration information, see “SIP: Modifying Soft-Key Display” on page 1054.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register template template-tag
4. transfer-attended
5. transfer-blind
6. exit
7. voice register pool pool-tag
8. template template-tag
9. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 649
Configuring Call Transfer and Forwarding
How to Configure Call Transfer and Forwarding
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register template template-tag Enters voice register template configuration mode to define
a template of common parameters for SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register template 1 • Range: 1 to 5.
Step 4 transfer-attended Enable a soft key for attended transfer on any supported SIP
phone that uses a template in which this command is
configure.
Example:
Router(config-register-template)#
transfer-attended
Step 5 transfer-blind Enable a soft key for blind transfer on any supported SIP
phone that uses a template in which this command is
configure.
Example:
Router(config-register-template)#
transfer-blind
Step 6 exit Exits configuration mode to the next highest mode in the
configuration mode hierarchy.
Example:
Router(config-register-template)# exit
Step 7 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for SIP phones.
Example:
Router(config)# voice register pool 3
Step 8 template template-tag Applies a template created with the voice register template
command.
Example: • template-tag—Range: 1 to 5.
Router(config-register-pool)# voice register
pool 1
Step 9 end Exits to privileged EXEC mode.
Example:
Router(config-register-pool)# end
Cisco Unified Communications Manager Express System Administrator Guide
650 OL-10663-02
Configuring Call Transfer and Forwarding
Configuration Examples for Call Transfer and Forwarding
Configuration Examples for Call Transfer and Forwarding
The following configuration examples are included in this section:
• H.450.2 and H.450.3: Example, page 651
• Basic Call Forwarding: Example, page 651
• Call Forwarding Blocked for Local Calls: Example, page 652
• Selective Call Forwarding: Example, page 652
• Call Transfer: Example, page 652
• Call-Transfer Recall: Example, page 653
• H.450.12: Example, page 653
• H.450.7 and QSIG Supplementary Services: Example, page 653
• Cisco Unified CME and Cisco Unified Communications Manager in Same Network: Example,
page 654
• H.450 Tandem Gateway Working with Cisco Unified CME and
Cisco Unified Communications Manager: Example, page 656
• Forwarding Calls to Cisco Unity Express: Example, page 658
H.450.2 and H.450.3: Example
The following example sets all transfers and forwards that are initiated by a Cisco CME 3.0 or later
system to use the H.450 standards, globally enables H.450.2 and H.450.3 capabilities, and disables those
capabilities for dial peer 37. The supplementary-service commands under voice-service configuration
mode are not necessary because these values are the default, but they are shown here for illustration.
telephony-service
transfer-system full-consult
transfer-pattern .T
call-forward pattern .T
!
voice service voip
supplementary-service h450.2
supplementary-service h450.3
!
dial-peer voice 37 voip
destination-pattern 555....
session target ipv4:10.5.6.7
no supplementary-service h450.2
no supplementary-service h450.3
Basic Call Forwarding: Example
The following example sets up forwarding for extension 2777 to extension 2513 on all calls, busy, and
no answer. During night service hours, calls are forwarded to a different number, extension 2879.
ephone-dn 20
number 2777
call-forward all 2513
call-forward busy 2513
call-forward noan 2513 timeout 45
call-forward night-service 2879
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 651
Configuring Call Transfer and Forwarding
Configuration Examples for Call Transfer and Forwarding
Call Forwarding Blocked for Local Calls: Example
In the following example, extension 2555 is configured to not forward local calls that are internal to the
Cisco Unified CME system. Extension 2222 dials extension 2555. If 2555 is busy, the caller hears a busy
tone. If 2555 does not answer, the caller hears ringback. The internal call is not forwarded.
ephone-dn 25
number 2555
no forward local-calls
call-forward busy 2244
call-forward noan 2244 timeout 45
Selective Call Forwarding: Example
The following example sets call forwarding on busy and no answer for ephone-dn 38 only for its primary
number, 2777. Callers who dial 2778 will hear a busy signal if the ephone-dn is busy or ringback if there
is no answer.
ephone-dn 38
number 2777 secondary 2778
call-forward busy 3000 primary
call-forward noan 3000 primary timeout 45
Call Transfer: Example
The following example limits transfers from ephone 6, extension 2977, to numbers containing a
maximum of 8 digits.
telephony-service
load 7910 P00403020214
load 7960-7940 P00305000600
load 7914 S00103020002
load 7905 CP7905040000SCCP040701A
load 7912 CP7912040000SCCP040701A
max-ephones 100
max-dn 500
ip source-address 10.104.8.205 port 2000
max-redirect 20
system message XYZ Inc.
create cnf-files version-stamp 7960 Jul 13 2004 03:39:28
voicemail 7189
max-conferences 8 gain -6
moh music-on-hold.au
web admin system name admin1 password admin1
dn-webedit
time-webedit
transfer-system full-consult
transfer-pattern 91..........
transfer-pattern 92......
transfer-pattern 93......
transfer-pattern 94......
transfer-pattern 95......
transfer-pattern 96......
transfer-pattern 97......
transfer-pattern 98......
transfer-pattern 99......
secondary-dialtone 9
fac standard
Cisco Unified Communications Manager Express System Administrator Guide
652 OL-10663-02
Configuring Call Transfer and Forwarding
Configuration Examples for Call Transfer and Forwarding
ephone-template 2
transfer max-length 8
ephone-dn 4
number 2977
ephone 6
button 1:4
ephone-template 2
Call-Transfer Recall: Example
The following example shows that transfer recall is enabled globally. After 60 seconds an unanswered
call is forwarded back to the phone that initiated the transfer (transferor).
telephony-service
max-ephones 100
max-dn 240
timeouts transfer-recall 60
max-conferences 8 gain -6
transfer-system full-consult
The following example shows that transfer recall is enabled for extension 1030 (ephone-dn 103), which
is assigned to ephone 3. If extension 1030 forwards a call and the transfer-to party does not answer, after
60 seconds the unanswered call is sent back to extension 1030 (transferor). The timeouts transfer-recall
command can also be set in an ephone-dn template and applied to one or more directory numbers.
ephone-dn 103
number 1030
name Smith, John
timeouts transfer-recall 60
!
ephone 3
mac-address 002D.264E.54FA
type 7962
button 1:103
H.450.12: Example
The following example globally disables H.450.12 capabilities and then enables them only on
dial peer 24.
voice service voip
no supplementary-service h450.12
!
dial-peer voice 24 voip
destination-pattern 555....
session target ipv4:10.5.6.7
supplementary-service h450.12
H.450.7 and QSIG Supplementary Services: Example
The following example implements QSIG supplementary services on extension 74367 and globally
enables H.450.7 supplementary services and QSIG call-forwarding supplementary services.
telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 653
Configuring Call Transfer and Forwarding
Configuration Examples for Call Transfer and Forwarding
voicemail 74398
transfer-system full-consult
ephone-dn 25
number 74367
mwi qsig
call-forward all 74000
voice service voip
supplementary-service h450.7
voice service pots
supplementary-service qsig call-forward
Cisco Unified CME and Cisco Unified Communications Manager in Same
Network: Example
The following example shows a running configuration for a Cisco CME 3.1 or later router that has a
Cisco Unified Communications Manager in its network.
Router# show running-config
version 12.3
service timestamps debug datetime msec
service timestamps log datetime msec
no service password-encryption
!
hostname Router
!
enable password pswd
!
aaa new-model
!
!
aaa session-id common
no ip subnet-zero
!
ip dhcp pool phone1
host 172.24.82.3 255.255.255.0
client-identifier 0100.07eb.4629.9e
default-router 172.24.82.2
option 150 ip 172.24.82.2
!
ip dhcp pool phone2
host 172.24.82.4 255.255.255.0
client-identifier 0100.0b5f.f932.58
default-router 172.24.82.2
option 150 ip 172.24.82.2
!
ip cef
no ip domain lookup
no mpls ldp logging neighbor-changes
no ftp-server write-enable
!
voice service voip
allow-connections h323 to h323
!
voice class codec 1
codec preference 1 g711ulaw
!
no voice hpi capture buffer
Cisco Unified Communications Manager Express System Administrator Guide
654 OL-10663-02
Configuring Call Transfer and Forwarding
Configuration Examples for Call Transfer and Forwarding
no voice hpi capture destination
!
interface FastEthernet0/0
ip address 172.24.82.2 255.255.255.0
duplex auto
speed auto
h323-gateway voip interface
h323-gateway voip bind srcaddr 172.24.82.2
!
ip classless
ip route 0.0.0.0 0.0.0.0 172.24.82.1
ip route 192.168.254.254 255.255.255.255 172.24.82.1
!
ip http server
!
tftp-server flash:P00303020700.bin
!
voice-port 1/0/0
!
voice-port 1/0/1
!
dial-peer cor custom
!
dial-peer voice 1001 voip
description points-to-CCM
destination-pattern 1.T
voice-class codec 1
session target ipv4:172.26.82.10
!
dial-peer voice 1002 voip
description points to router
destination-pattern 4...
voice-class codec 1
session target ipv4:172.25.82.2
!
dial-peer voice 1 pots
destination-pattern 3000
port 1/0/0
!
dial-peer voice 1003 voip
destination-pattern 26..
session target ipv4:10.22.22.38
!
!
telephony-service
load 7960-7940 P00303020700
max-ephones 48
max-dn 15
ip source-address 172.24.82.2 port 2000
create cnf-files version-stamp Jan 01 2002 00:00:00
keepalive 10
max-conferences 4
moh minuet.au
transfer-system full-consult
transfer-pattern ....
!
ephone-dn 1
number 3001
name abcde-1
call-forward busy 4001
!
ephone-dn 2
number 3002
name abcde-2
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 655
Configuring Call Transfer and Forwarding
Configuration Examples for Call Transfer and Forwarding
!
ephone-dn 3
number 3003
name abcde-3
!
ephone-dn 4
number 3004
name abcde-4
!
ephone 1
mac-address 0003.EB27.289E
button 1:1 2:2
!
ephone 2
mac-address 000D.39F9.3A58
button 1:3 2:4
!
line con 0
exec-timeout 0 0
logging synchronous
line aux 0
line vty 0 4
password pswd
!
end
H.450 Tandem Gateway Working with Cisco Unified CME and
Cisco Unified Communications Manager: Example
The following example shows a sample configuration for a Cisco CME 3.1 or later system that is linked
to an H.450 tandem gateway that serves as a proxy for Cisco Unified Communications Manager.
Router# show running-config
Building configuration...
Current configuration : 1938 bytes
!
version 12.3
service timestamps debug datetime msec
service timestamps log datetime msec
no service password-encryption
!
hostname Router
!
boot-start-marker
boot-end-marker
!
enable password pswd
!
aaa new-model
!
aaa session-id common
no ip subnet-zero
!
ip cef
no ip domain lookup
no ftp-server write-enable
no scripting tcl init
no scripting tcl encdir
!
Cisco Unified Communications Manager Express System Administrator Guide
656 OL-10663-02
Configuring Call Transfer and Forwarding
Configuration Examples for Call Transfer and Forwarding
voice call send-alert
!
voice service voip
allow-connections h323 to h323
supplementary-service h450.12
h323
!
voice class codec 1
codec preference 1 g711ulaw
codec preference 2 g729r8
codec preference 3 g729br8
!
interface FastEthernet0/0
ip address 172.27.82.2 255.255.255.0
duplex auto
speed auto
h323-gateway voip interface
h323-gateway voip h323-id host24
!
ip classless
ip route 0.0.0.0 0.0.0.0 172.26.82.1
ip route 0.0.0.0 0.0.0.0 172.27.82.1
ip http server
!
dial-peer cor custom
!
dial-peer voice 1001 voip
description points-to-CCM
destination-pattern 4...
session target ipv4:172.24.89.150
!
dial-peer voice 1002 voip
description points to CCME1
destination-pattern 28..
session target ipv4:172.24.22.38
!
dial-peer voice 1003 voip
description points to CCME3
destination-pattern 9...
session target ipv4:192.168.1.29
!
dial-peer voice 1004 voip
description points to CCME2
destination-pattern 29..
session target ipv4:172.24.22.42
!
line con 0
exec-timeout 0 0
logging synchronous
line aux 0
line vty 0 4
password pswd
!
end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 657
Configuring Call Transfer and Forwarding
Where to Go Next
Forwarding Calls to Cisco Unity Express: Example
The following example enables the ability to forward calls that originate from
Cisco Unified Communications Manager phones and are routed through a Cisco Unified CME system to
a Cisco Unity Express extension. Call forwarding is enabled for all calling parties, H.450.3 is disabled,
and connections are allowed to SIP endpoints.
telephony-service
call-forward pattern .T
voice service voip
no supplementary-service h450.3
allow connections from h323 to sip
Where to Go Next
If you are finished modifying the configuration, generate a new configuration file and restart the phones.
See “Generating Configuration Files for Phones” on page 261.
Soft Keys
To block the function of the call-forward-all or transfer soft key without removing the key display or to
remove the soft key from one or more phones, see the “How to Customize Soft Keys” section on
page 1050.
Feature Access Codes (FACs)
Phone users can activate and deactivate a phone’s call-forward-all setting by using a feature access code
(FAC) instead of a soft key on the phone if standard or custom FACs have been enabled for your system.
The following are the standard FACs for call forward all:
• callfwd all—Call forward all calls. Standard FAC is **1 plus an optional target extension.
• callfwd cancel—Cancel call forward all calls. Standard FAC is **2.
For more information about FACs, see “Configuring Feature Access Codes” on page 893.
Night Service
Calls can be automatically forwarded during night service hours, but you must define the night-service
periods, which are the dates or days and hours during which night service will be active. For instance,
you may want to designate night service periods that include every weeknight between 5 p.m. and 8 a.m.
and all day every Saturday and Sunday. For more information, see “Configuring Call-Coverage
Features” on page 663.
Cisco Unified Communications Manager Express System Administrator Guide
658 OL-10663-02
Configuring Call Transfer and Forwarding
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 659
Configuring Call Transfer and Forwarding
Feature Information for Call Transfer and Forwarding
Feature Information for Call Transfer and Forwarding
Table 7 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 7 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 7 Feature Information for Call Transfer and Forwarding
Cisco Unified CME
Feature Name Version Feature Information
Call Forwarding 4.1 • Call Forward All synchronization between
Cisco Unified CME and SIP phones was added.
• Disabling SIP supplementary services for call forward
and call transfer was added.
4.0 • Automatic call forwarding during night service was
introduced.
• Selective call forwarding was introduced.
• Forwarding of local (internal) calls can be blocked.
• H.450.7 standards support and QSIG supplementary
services capability was introduced.
3.4 Calls into a SIP device can be forwarded to other SIP or
SCCP devices including Cisco Unity, third- party voice
mail systems, or an auto-attendant (AA) or other interactive
voice response (IVR) devices. SCCP devices may also be
forwarded to SIP devices.
3.1 • Number of digits that can be entered using the
CfwdALL (call-forward all) soft key can be limited.
• H.450.12 standards support, which provide dynamic
detection of H.450.2 and H.450.3 capabilities on a
call-by-call basis, was introduced.
3.0 • CFwdALL soft key was introduced.
• Local hairpin call routing was supported as an option
for networks that cannot support H.450 call transfer and
forwarding. This feature requires installation of the Tcl
script app_h450_transfer.2.0.0.8.tcl or a later version.
2.1 Call forwarding using the H.450.3 standard was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
660 OL-10663-02
Configuring Call Transfer and Forwarding
Feature Information for Call Transfer and Forwarding
Table 7 Feature Information for Call Transfer and Forwarding
Cisco Unified CME
Feature Name Version Feature Information
Call Forwarding 1.0 Call forwarding for all calls, busy conditions, and
no-answer conditions was introduced, using a
Cisco-proprietary method.
Call Transfer 4.3 • Call-Transfer Recall was added.
• Consultative Call Transfer digit-collection process was
modified.
4.1 • Disabling SIP supplementary services for call transfer
and call forward was added.
4.0 • Default for the transfer-system command was changed
from the blind keyword to the full-consult keyword.
• Transfers to phones outside the Cisco Unified CME
system can be blocked for individual ephones.
• Number of digits in transfer destination numbers can be
limited.
3.4 Support for attended and blind transfer s using SIP IP phone
directly connected to Cisco CME.
3.2 • Consultative transfer to monitored lines using direct
station select was introduced.
• Transcoding between G.711 and G.729 is supported
when one leg of a Voice over IP (VoIP)-to-VoIP hairpin
call uses G.711 and the other leg uses G.729.
3.1 Support was introduced for the following:
• Enhancements for VoIP networks which contain a mix
of platforms that support H.450.2 and H.450.3
standards, such as Cisco CME 3.1, Cisco CME 3.0,
Cisco ITS V2.1, and platforms that do not support
H.450.2 and H.450.3 standards, such as
Cisco Unified Communications Manager, Cisco BTS
Softswitch (BTS), and Cisco PSTN Gateway (PGW).
• H.450.12 standards, which provide dynamic detection
of H.450.2 and H.450.3 capabilities on a call-by-call
basis.
• Automatic detection of Cisco Unified Communications
Manager endpoints.
• Hairpin VoIP-to-VoIP call routing and routing to an
H.450 tandem gateway.
• Hairpin call routing does not require a Tcl script.
3.0 Local hairpin call routing was supported as an option for
networks that cannot support H.450 call transfer and
forwarding. This feature requires installation of the Tcl
script app_h450_transfer.2.0.0.8.tcl or a later version.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 661
Configuring Call Transfer and Forwarding
Feature Information for Call Transfer and Forwarding
Table 7 Feature Information for Call Transfer and Forwarding
Cisco Unified CME
Feature Name Version Feature Information
2.1 Consultative transfer using the ITU-T H.450.2 standard was
introduced.
1.0 Call transfer was introduced, using a Cisco proprietary
method.
Cisco Unified Communications Manager Express System Administrator Guide
662 OL-10663-02
Configuring Call-Coverage Features
Last Updated: October 7, 2009
This chapter describes features that can be used to provide appropriate, flexible coverage for incoming
calls in Cisco Unified Communications Manager Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Call Coverage”
section on page 741.
Contents
• Information About Call Coverage Features, page 663
• How to Configure Call Coverage Features, page 686
• Configuration Examples for Call Coverage Features, page 724
• Where to Go Next, page 738
• Additional References, page 740
• Feature Information for Call Coverage Features, page 741
Information About Call Coverage Features
To configure call coverage features, you should understand the following concepts:
• Call-Coverage Summary, page 664
• Call Hunt, page 665
• Call Pickup, page 666
• Call Waiting, page 668
• Callback Busy Subscriber, page 669
• Hunt Groups, page 669
• Night Service, page 680
• Overlaid Ephone-dns, page 682
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 663
Configuring Call-Coverage Features
Information About Call Coverage Features
Call-Coverage Summary
Call coverage features are used to ensure that all incoming calls to Cisco Unified CME are answered by
someone, regardless of whether the called number is busy or does not answer.
Some single-dialed-number call-coverage features, such as hunt groups, can send incoming calls to a
single extension to a pool of phone agents, while other features, such as call hunt, call waiting, and call
forwarding increase the chance of a call being answered by giving it another chance for a connection if
the dialed number is not available.
Multiple-dialed-number call-coverage features, such as call pickup, night service, and overlaid directory
numbers, provide different ways for one person to answer incoming calls to multiple numbers.
Any of the call-coverage features can be combined with other call-coverage features and with shared
lines and secondary numbers to design the call coverage plan that is best suited to your needs.
Table 8 summarizes call-coverage features.
Table 8 Call-Coverage Feature Summary
Feature Description Example How Configured
Call Forwarding Calls are automatically diverted Extension 3444 is configured to SCCP: Enabling Call
to a designated number on busy, send calls to extension 3555 Forwarding for a Directory
no answer, all calls, or only when it is busy or does not Number, page 620
during night-service hours. answer. or
SIP: Configuring SIP-to-SIP
Phone Call Forwarding,
page 644
Call Hunt System automatically searches Three ephone-dns have the same SCCP: Configuring Call
for an available directory extension number, 755. One is Hunt, page 687
number from a matching group on the manager’s phone and the or
of directory numbers until the others are on the assistants’
call is answered or the hunt is phones. Preference and huntstop SIP: Configuring Call Hunt,
stopped. are used to make sure that calls page 689
always come to the manager’s
phone first but if they can’t be
answered, they will ring on the
first assistant’s phone and if not
answered, on the second
assistant’s phone.
Call Pickup Calls to unstaffed phones can be Extension 201 and 202 are both Enabling Call Pickup,
answered by other phone users in pickup group 22. A call is page 691
using a soft key or by dialing a received by 201, but no one is
short code. there to answer. The agent at 202
presses the GPickUp soft key to
answer the call.
Call Waiting Calls to busy numbers are Extension 564 is in conversation SCCP: Configuring
presented to phone users, giving when a call-waiting beep is Call-Waiting Indicator Tone,
them the option to answer them heard. The phone display shows page 696
or let them be forwarded. the call is from extension 568 or
and the phone user decides to let
the call go to voice mail. SIP: Enabling Call Waiting,
page 700
Cisco Unified Communications Manager Express System Administrator Guide
664 OL-10663-02
Configuring Call-Coverage Features
Information About Call Coverage Features
Table 8 Call-Coverage Feature Summary (continued)
Feature Description Example How Configured
Cisco CME B-ACD Calls to a pilot number are The DID number 555-0125 is the See Cisco Unified CME
automatically answered by an pilot number for the XYZ B-ACD and Tcl
interactive application that Company. Incoming calls to this Call-Handling Applications.
presents callers with a menu of pilot number hear a menu of
choices before sending them to a choices; they can press 1 for
queue for a hunt group. sales, 2 for service, or 3 to leave
a message. The call is forwarded
appropriately when callers make
a choice.
Hunt Groups Calls are forwarded through a Extension 200 is a pilot number SCCP: Configuring Ephone
pool of agents until answered or for the sales department. Hunt Groups, page 702
sent to a final number. Extensions 213, 214, and 215
or
belong to sales agents in the hunt
group. When a call to extension Configuring Voice Hunt
200 is received, it proceeds Groups, page 710.
through the list of agents until
one answers. If all the agents are
busy or do not answer, the call is
sent to voice mail.
Night Service Calls to ephone-dns that are not Extension 7544 is the cashier’s SCCP: Configuring Night
staffed during certain hours can desk but the cashier only works Service, page 714.
be answered by other phones until 3 p.m. A call is received at
using call pickup. 4:30 p.m. and the service
manager’s phone is notified. The
service manager uses call pickup
to answer the call.
Overlaid Ephone-dns Calls to several numbers can be Extensions 451, 452, and 453 all SCCP: Configuring Overlaid
answered by a single agent or appear on button 1 of a phone. A Ephone-dns, page 720.
multiple agents. call to any of these numbers can
be answered from button 1.
Call Hunt
Call hunt allows you to use multiple directory numbers to provide coverage for a single called number.
You do this by assigning the same number to several primary or secondary ephone-dns or by using
wildcards in the number associated with the directory numbers.
Calls are routed based on a match between the number dialed and the destination patterns that are
associated with dial peers. Through the use of wildcards in destination patterns, multiple dial peers can
match a particular called number. Call hunt is the ability to search through the dial peers that match the
called number until the call is answered. Call hunt uses a technique called preference to control the order
in which dial peers are matched to an incoming call and a technique called huntstop to determine when
the search for another matching peer ends.
In Cisco Unified CME, incoming calls search through the virtual dial peers that are automatically
created when you define directory numbers. These virtual dial peers are not directly configurable; you
must configure the directory number to control call hunt for virtual dial peers.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 665
Configuring Call-Coverage Features
Information About Call Coverage Features
Channel huntstop is used to stop the search for the two channels of a dual-line directory number. Channel
huntstop keeps incoming calls from hunting to the second channel if the first channel is busy or does not
answer. This keeps the second channel free for call transfer, call waiting, or three-way conferencing.
Huntstop prevents hunt-on-busy from redirecting a call from a busy phone into a dial peer that has been
setup with a catch-all default destination.
For configuration information, see the “SCCP: Configuring Call Hunt” section on page 687 or the “SIP:
Configuring Call Hunt” section on page 689.
Call Pickup
Call Pickup allows a phone user to answer a call that is ringing on another phone. Cisco Unified
CME 7.1 introduces Call Pickup features for SIP phones. SCCP and SIP phones support three types of
Call Pickup:
• Directed Call Pickup—Call pickup, explicit ringing extension. Any local phone user can pick up a
ringing call on another phone by pressing a soft key and then dialing the extension. A phone user
does not need to belong to a pickup group to use this method. The soft key that the user presses,
either GPickUp or PickUp, depends on your configuration.
• Group Pickup, Different Group—Call pickup, explicit group ringing extension. A phone user can
answer a ringing phone in any pickup group by pressing the GPickUp soft key and then dialing the
pickup group number. If there is only one pickup group defined in the Cisco Unified CME system,
the phone user can pick up the call simply by pressing the GPickUp soft key. A phone user does not
need to belong to a pickup group to use this method.
• Local Group Pickup—Call pickup, local group ringing extension. A phone user can pick up a
ringing call on another phone by pressing a soft key and then the asterisk (*) if both phones are in
the same pickup group. The soft key that the user presses, either GPickUp or PickUp, depends on
your configuration.
The specific soft keys used to access different Call Pickup features on SCCP and SIP phones depends
on the configuration in Cisco Unified CME. See the service directed-pickup command in the
Cisco Unified CME Command Reference for a description.
You can assign each directory number to only one pickup group and a directory number must have a
pickup group configured to use Local Group Pickup. There is no limit to the number of directory
numbers that can be assigned to a single pickup group, or to the number of pickup groups that can be
defined in a Cisco Unified CME system.
If more than one call is ringing on the same number, the calls are picked up in the order in which they
were received; the call that has been ringing the longest is the first call picked up from that extension
number. Remote call pickup is not supported.
Call Pickup features are enabled globally for all phones through Cisco Unified CME. The PickUp and
GpickUp soft keys display on supported SCCP and SIP phones by default and can be modified by using
a phone template. For configuration information, see the “Enabling Call Pickup” section on page 691.
Cisco Unified Communications Manager Express System Administrator Guide
666 OL-10663-02
Configuring Call-Coverage Features
Information About Call Coverage Features
Figure 16 shows four call-pickup scenarios.
Figure 16 Call Pickup
Call Pickup, No Group or Unknown Group ephone-dn 55
number 5555
1 Extension 5555 rings. 2 User at phone 4 presses PickUp pickup-group 33
soft key and dials 5555.
ephone-dn 56
Phone 1 Phone 2 number 5556
Extension 5555 Extension 5556 pickup-group 33
IP IP
Pickup group 33 Pickup group 33
Phone 3 Phone 4 ephone-dn 57
Extension 5557 Extension 5558 number 5557
IP IP
Pickup group 44 No pickup group pickup-group 44
ephone-dn 58
Call Pickup in the Same Group number 5558
.
1 Extension 5555 rings. 2 User at phone 2 presses GPickUp .
soft key and * (asterisk). .
ephone 1
Phone 1 Phone 2 mac-address 1111.1111.1111
Extension 5555 Extension 5556 button 1:55
IP IP
Pickup group 33 Pickup group 33
Phone 3 Phone 4 ephone 2
Extension 5557 Extension 5558 mac-address 2222.2222.2222
IP IP
Pickup group 44 No pickup group button 1:56
ephone 3
mac-address 3333.3333.3333
button 1:57
Call Pickup from a Different Group
ephone 4
mac-address 4444.4444.4444
1 Extension 5555 rings. 2 User at phone 3 presses
button 1:58
GPickUp soft key and dials 33.
.
.
Phone 1 Phone 2
.
Extension 5555 Extension 5556
IP IP
Pickup group 33 Pickup group 33
Phone 3 Phone 4
IP Extension 5557 IP Extension 5558
Pickup group 44 No pickup group
Call Pickup, a Single Group for All Cisco CME Phones
1 Extension 5555 rings. 2 User at phone 2 presses
GPickUp soft key.
Phone 1 Phone 2
Extension 5555 Extension 5556
IP Pickup group 33 IP Pickup group 33
88954
This scenario assumes that every phone in the Cisco CME system is in pickup group
33, which differs slightly from the sample configuration shown to the right.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 667
Configuring Call-Coverage Features
Information About Call Coverage Features
Call Waiting
Call waiting allows phone users to be alerted when they receive an incoming call while they are on
another call. Phone users hear a call-waiting tone when another party is trying to reach them and, on IP
phones, see the calling party information on the phone screen.
Call-waiting calls to IP phones with soft keys can be answered using the Answer soft key. Call-waiting
calls to analog phones controlled by Cisco Unified CME systems are answered using hookflash. When
phone users answer a call-waiting call, their original call is automatically put on hold. If a phone user
does not respond to a call-waiting notification, the call is forwarded as specified in the call-forward
noan command for that extension.
For an IP phone running SCCP, call waiting for single-line ephone-dns requires two ephone-dns to
handle the two calls. Call waiting on a dual-line ephone-dn requires only one ephone-dn because the two
channels of the ephone-dn handle the two calls. The audible call-waiting indicator can be either a
call-waiting beep or a call-waiting ring. For configuration information, see the “SCCP: Configuring
Call-Waiting Indicator Tone” section on page 696.
For a SIP phone, call waiting is automatically enabled when you configure a voice register pool. For SIP
phones directly connected to Cisco Unified CME, call waiting can be disabled at the phone-level. For
configuration information, see the “SIP: Enabling Call Waiting” section on page 700.
For information on call waiting using Overlaid ephone-dns, see the “Overlaid Ephone-dns” section on
page 682.
Call-Waiting Beep for SCCP Phones
Call-waiting beeps are enabled by default. You can disable the call-waiting beeps that are generated
from and accepted by directory numbers. If beep generation is disabled, incoming calls to the directory
number do not generate call-waiting beeps. If beep acceptance is disabled, the phone user does not hear
beeps when using the directory number for an active call.
Table 9 shows the possible beep behaviors of one ephone-dn calling another ephone-dn that is connected
to another caller.
Table 9 Call-Waiting Beep Behavior
Incoming
Active Call Call Expected
Ephone-dn 1 Configuration Ephone-dn 2 Configuration on DN on DN Behavior
— no call-waiting beep DN 1 DN 2 No beep
no call-waiting beep — DN 1 DN 2 No beep
— no call-waiting beep generate DN 1 DN 2 No beep
— no call-waiting beep accept DN 1 DN 2 Beep
— no call-waiting beep accept DN 1 DN 2 No beep
no call-waiting beep generate
no call-waiting beep — DN 1 DN 1 No beep
no call-waiting beep generate — DN 1 DN 1 No beep
no call-waiting beep accept — DN 1 DN 1 No beep
no call-waiting beep accept no — DN 1 DN 1 No beep
call-waiting beep generate
no call-waiting beep generate — DN 1 DN 2 Beep
Cisco Unified Communications Manager Express System Administrator Guide
668 OL-10663-02
Configuring Call-Coverage Features
Information About Call Coverage Features
Table 9 Call-Waiting Beep Behavior (continued)
Incoming
Active Call Call Expected
Ephone-dn 1 Configuration Ephone-dn 2 Configuration on DN on DN Behavior
no call-waiting beep accept — DN 1 DN 2 No beep
— no call-waiting beep DN 1 DN 1 Beep
Call-Waiting Ring for SCCP Phones
Instead of the standard call waiting beep sound through the handset, you can use a short ring for
call-waiting notification. The default is for directory numbers to accept call interruptions, such as call
waiting, and to issue a beeping sound for notification.
To use a ring sound, the directory number must accept call-waiting indicator tones. For configuration
information, see the “SCCP: Configuring Call-Waiting Indicator Tone” section on page 696 or the “SIP:
Enabling Call Waiting” section on page 700.
Cancel Call Waiting
Cancel Call Waiting (CCW) enables an SCCP phone user to disable Call Waiting for a call they
originate. The user activates CCW, and thereby disables call waiting, by pressing the cancel call waiting
(CW Off) soft key or by dialing the feature access code (FAC) before placing a call. Call Waiting is
inactive during that call; anyone calling the user receives normal busy treatment and no call waiting tone
interrupts the user's active call. CCW automatically deactivates when the user disconnects from the call.
CCW is supported on all lines that support the Call Waiting feature, including dual-lines and octo-lines.
This feature is supported in Cisco Unified CME 8.0 and later versions for SCCP IP phones and SCCP
analog phones; it is not supported on SIP phones.
For configuration information, see the “SCCP: Configuring Cancel Call Waiting” section on page 698.
Callback Busy Subscriber
This feature allows callers who dial a busy extension number to request a callback from the system when
the called number is available. Callers can also request callbacks for extensions that do not answer, and
the system will notify them after the called phone is next used.
There can be only one callback request pending against a particular extension number, although a caller
can initiate more than one callback to different numbers. If a caller attempts to place a callback request
on a number that already has a pending callback request, the caller hears a fast-busy tone. If the called
number has call forwarding enabled, the callback request is placed against the final destination number.
No configuration is required for this feature. To display a list of phones that have pending callback
requests, use the show ephone-dn callback command.
Hunt Groups
Hunt groups allow incoming calls to a specific number (pilot number) to be directed to a defined group
of extension numbers.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 669
Configuring Call-Coverage Features
Information About Call Coverage Features
Incoming calls are redirected from the pilot number to the first extension number as defined by the
configuration. If the first number is busy or does not answer, the call is redirected to the next phone in
the list. A call continues to be redirected on busy or no answer from number to number in the list until
it is answered or until the call reaches the number that is defined as the final number.
The redirect from one directory number to the next in the list is also known as a hop. You can set the
maximum number of redirects for specific peer or longest-idle hunt groups, and for the maximum
number of redirects allowed in a Cisco Unified CME system, both inside and outside hunt groups. If a
call makes the maximum number of hops or redirects without being answered, the call is dropped.
For information on displaying statistics for ephone hunt groups, see Cisco Unified CME B-ACD and Tcl
Call-Handling Applications.
There are four different types of hunt groups. Each type uses a different strategy to determine the first
number that rings for successive calls to the pilot number, as described below.
• Sequential Hunt Groups—Numbers always ring in the left-to-right order in which they are listed
when the hunt group is defined. The first number in the list is always the first number to be tried
when the pilot number is called. Maximum number of hops is not a configurable parameter for
sequential hunt groups. Figure 17 on page 672 shows an illustrated example.
• Peer Hunt Groups—The first number to ring is the number to the right of the directory number that was
the last to ring when the pilot number was last called. Ringing proceeds in a circular manner, left to
right, for the number of hops specified in the hunt group configuration. Figure 18 on page 673 shows
an illustrated example.
• Longest-Idle Hunt Groups—Calls go first to the number that has been idle the longest for the number of
hops specified when the hunt group was defined. The longest-idle time is determined from the last time
that a phone registered, reregistered, or went on-hook. Figure 19 on page 674 shows an illustrated
example.
• Parallel Hunt Groups (Call Blast)—Calls ring all numbers in the hunt group simultaneously.
Hunt-group chains can be configured in any length, but the actual number of hops that can be reached
in a chain is determined by the max-redirect command configuration. In the following example, a
maximum redirect number 15 or greater must be configured for callers to reach the final 5000 number.
If a lower number is configured, the call disconnects.
ephone-hunt 1 sequential
pilot 8000
list 8001, 8002, 8003, 8004
final 9000
ephone-hunt 2 sequential
pilot 9000
list 9001, 9002, 9003, 9004
final 7000
ephone-hunt 3 sequential
pilot 7000
list 7001, 7002, 7003, 7004
final 5000
Cisco Unified CME 4.3 and later versions support the following Voice Hunt Group features:
• Call Forwarding to a Parallel Voice Hunt-Group (Call Blast)
• Call Transfer to a Voice Hunt-Group
• Member of Voice Hunt-Group can be a SIP phone, SCCP phone, FXS analog phone, DS0-group,
PRI-group, or SIP trunk.
Cisco Unified Communications Manager Express System Administrator Guide
670 OL-10663-02
Configuring Call-Coverage Features
Information About Call Coverage Features
Ephone Hunt Groups and Voice Hunt Groups Comparison
SIP phones support Voice Hunt Groups. SCCP phones support Ephone Hunt Groups, and in
Cisco Unified CME 4.3 and later versions, SCCP phones also support Voice Hunt Groups. Table 10
compares the features of Ephone Hunt Groups and Voice Hunt Groups.
Table 10 Feature Comparison of Ephone Hunt Groups and Voice Hunt Groups
Feature Ephone Hunt Voice Hunt Group
Endpoints Supported SCCP only SIP, SCCP, PSTN, and FXS
Parallel Hunt Groups (Call Blast) No (for alternative, see the Yes
“Shared-Line Overlays” section
on page 683)
Hunt Statistics Support Yes No
B-ACD Support Yes No
Features such as present-call and Yes No
login/logout
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 671
Configuring Call-Coverage Features
Information About Call Coverage Features
Sequential Hunt Groups
In a sequential hunt group, extensions always ring in the order in which they are listed, left to right, when
the hunt group is defined. The first number in the list is always the first number to be tried when the pilot
number is called. Maximum number of hops is not a configurable parameter for sequential hunt groups.
Figure 17 Sequential hunt Group
ephone-dn 88
1 Any phone dials the pilot number, 5601.
number 5001
2 Extension 5001, the leftmost number in the hunt group list, rings first ephone-dn 89
on phone 1. If extension 5001 is busy or does not answer, the call is number 5002
redirected to extension 5002 on phone 2.
3 If extension 5002 on phone 2 is busy or does not answer, the call is ephone-dn 90
redirected to extension 5017 on phone 3. number 5017
4 If phone 3 is busy or does not answer, the call is redirected to the final
number, extension 6000, which is associated with a voice-mail server. ephone 1
mac-address 1111.1111.1111
button 1:88
Any phone dials the pilot number.
IP ephone 2
mac-address 2222.2222.2222
6000 Voice-mail server button 1:89
5601
Pilot number
ephone 3
mac-address 3333.3333.3333
V button 1:90
Phone 1 ephone-hunt 1 sequential
Button 1 is extension 5001
IP
pilot 5601
list 5001, 5002, 5017
Phone 2 final 6000
Button 1 is extension 5002
IP preference 1
timeout 30
88955
Phone 3
Button 1 is extension 5017
IP
Cisco Unified Communications Manager Express System Administrator Guide
672 OL-10663-02
Configuring Call-Coverage Features
Information About Call Coverage Features
Peer Hunt Groups
In a peer hunt group, extensions ring in a round-robin order. The first extension to ring is the number in
the list to the right of the last extension to ring when the pilot number was last called. Ringing proceeds in a
circular manner, left to right, for the number of hops specified when the hunt group was defined.
Figure 18 illustrates a peer hunt group.
Figure 18 Peer hunt Group
1 Any phone dials the pilot number, 5601, which is not associated with a
physical phone instrument.
ephone-dn 88
2 Extension 5017 on phone 3 is selected to ring first because extension
5002 was the last number to ring the last time that the pilot number number 5001
was called.
ephone-dn 89
3 If extension 5017 is busy or does not answer, the call is redirected to number 5002
extension 5044 on phone 4 (first hop).
4 If extension 5044 is busy or does not answer, the call is redirected to ephone-dn 90
extension 5001 on phone 1 (second hop). number 5017
5 If extension 5001 is busy or does not answer, the call has reached the ephone-dn 91
maximum number of hops (3), and it is redirected to the final number, number 5044
extension 6000, which is associated with a voice-mail server.
ephone 1
Any phone dials the pilot number. mac-address 1111.1111.1111
IP button 1:88
Voice-mail server
Pilot number ephone 2
6000
5601 mac-address 2222.2222.2222
button 1:89
V ephone 3
mac-address 3333.3333.3333
Phone 1 button 1:90
Button 1 is extension 5001 IP
ephone 4
mac-address 4444.4444.4444
Phone 2
Button 1 is extension 5002 IP button 1:91
ephone-hunt 1 peer
Phone 3 pilot 5601
Button 1 is extension 5017
IP
list 5001, 5002, 5017, 5044
final 6000
Phone 4 hops 3
Button 1 is extension 5044 IP preference 1
timeout 30 88956
no-reg
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 673
Configuring Call-Coverage Features
Information About Call Coverage Features
Longest-Idle Hunt Groups
In a longest-idle hunt group, the algorithm for choosing the next extension to receive a call is based on
a comparison of on-hook time stamps. The extension with the smallest on-hook time stamp value is
chosen when the next call comes to the hunt group.
The default behavior is that an on-hook time stamp value for an extension is updated only when the agent
answers a call. In Cisco Unified CME 4.0 and later versions, you can specify that an on-hook time stamp
is updated when a call rings an extension and also when a call is answered by an agent.
Figure 19 illustrates a longest-idle hunt group.
Figure 19 Longest-Idle hunt Group
1 Any phone dials the pilot number, 5601, which is not associated with a
physical phone instrument. ephone-dn 88
number 5001
2 Extension 5001 on phone 1 is selected to ring first because it has
been idle the longest. ephone-dn 89
3 If extension 5001 does not answer, the call is redirected to extension number 5002
5002 on phone 2 because it has been idle the longest (first hop).
ephone-dn 90
4 If extension 5002 does not answer, the call is redirected to extension
number 5017
5044 on phone 4 because it has been idle the longest (second hop).
5 If extension 5044 does not answer, the call has reached the maximum ephone-dn 91
number of hops (3), and it is redirected to the final number, extension 6000, number 5044
which is associated with a voice-mail server
ephone 1
Any phone dials the pilot number. mac-address 1111.1111.1111
IP button 1:88
Voice-mail server
Pilot number ephone 2
6000
5601 mac-address 2222.2222.2222
button 1:89
V ephone 3
mac-address 3333.3333.3333
Phone 1 button 1:90
Button 1 is extension 5001 IP
ephone 4
mac-address 4444.4444.4444
Phone 2
Button 1 is extension 5002 IP button 1:91
ephone-hunt 1 longest-idle
Phone 3 pilot 5601
Button 1 is extension 5017
IP
list 5001, 5002, 5017, 504
final 6000
Phone 4 hops 3
Button 1 is extension 5044 IP preference 1
103299
timeout 30
no-reg
Cisco Unified Communications Manager Express System Administrator Guide
674 OL-10663-02
Configuring Call-Coverage Features
Information About Call Coverage Features
Parallel Hunt Groups (Call Blast)
In a parallel hunt group, calls simultaneously ring multiple phones. Using parallel hunt groups is also
referred to as application-level forking because it enables the forking of a call to multiple destinations.
In versions earlier than Cisco Unified CME 4.3, only SIP phones support parallel hunt groups. In
Cisco Unified CME 4.3 and later versions, SCCP phones also support voice hunt groups.
You can enable functionality similar to parallel hunt groups on SCCP phones by using the ephone-dn
overlay feature for shared lines. See the “Shared-Line Overlays” section on page 683.
In the following parallel hunt group example, when callers dial extension 1000, extension 1001, 1002,
and so on ring simultaneously. The first extension to answer is connected. If none of the extensions
answers, the call is forwarded to extension 2000, which is the number for the voice-mail service.
voice hunt-group 4 parallel
pilot 1000
list 1001, 1002, 1003, 1004
final 2000
timeout 20
The number of ringing calls that a parallel hunt group can support depends on whether call-waiting is
enabled on the SIP phones.
If call-waiting is enabled (the default), parallel hunt groups support multiple calls up to the limit of
call-waiting calls supported by a particular SIP phone model. You may not want to use unlimited
call-waiting however with parallel hunt-groups if agents do not want a large number of waiting calls
when they are already handling a call.
If call waiting is disabled, parallel hunt groups support only one call at a time in the ringing state. After
a call is answered (by one of the phones in the hunt group), a second call is allowed. The second and
subsequent calls ring only the idle phones in the hunt group, and bypass the busy phone that answered
the first call (because this phone is connected to the first call). After the second call is answered, a third
call is allowed, and so on until all the phones in the parallel hunt group are busy. The hunt group does
not accept further calls until at least one phone returns to the idle/on-hook state.
When two or more phones within the same parallel hunt group attempt to answer the same call, only one
phone can connect to the call. Phones that fail to connect must return to the on-hook state before they
can receive subsequent calls. Calls that arrive before a phone is placed on-hook are not presented to the
phone. For example, if a second call arrives after Phone 1 has answered the original call, but before
Phone 2 goes back on-hook, the second call bypasses Phone 2 (because it is offhook).
When a phone returns to the idle/on-hook state, it does not automatically re-synchronize to the next call
waiting to be answered. For example, in the previous scenario, if the second call is still ringing Phone 3
when Phone 2 goes on-hook, Phone 2 does not ring because it was offhook when the second call arrived.
For configuration information, see the “Configuring Voice Hunt Groups” section on page 710.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 675
Configuring Call-Coverage Features
Information About Call Coverage Features
Hunt Group Agent Availability Options
Three options increase the flexibility of hunt group agents by allowing them to dynamically join and
leave hunt groups or to temporarily enter a not-ready state in which they do not receive calls.
Table 11 compares the following agent availability features:
• Dynamic Hunt Group Membership, page 678
• Agent Status Control, page 678
• Automatic Agent Status Not-Ready, page 679
Table 11 Comparison of Hunt Group Agent Availability Features
Comparison
Factor Dynamic Membership Agent Status Control Automatic Agent Status Not-Ready
Purpose Allows an authorized agent to join Allows an agent to manually Automatically puts an agent’s
and leave hunt groups. activate a toggle to temporarily phone in a not-ready state after a
enter a not-ready state, in which specified number of hunt-group
hunt-group calls bypass the calls are unanswered by the
agent’s phone. agent’s phone.
Example Agent A joins a hunt group at Agent A takes a coffee break at Agent B is suddenly called away
8 a.m. and takes calls until 1 p.m., 10 a.m. and puts his phone into a from her desk before she can
when he leaves the hunt group. not-ready status while he is on manually put her phone into the
While Agent A is a member of the break. When he returns he puts his not-ready status. After a
hunt group, he occupies one of the phone back into the ready status hunt-group call is unanswered at
wildcard slots in the list of and immediately starts receiving Agent B’s phone, the phone is
numbers configured for the hunt hunt-group calls again. He automatically placed in the
group. At 1 p.m., Agent B joins retained his wildcard slot while he not-ready status and it is not
the hunt group using the same was in the not-ready status. presented with further hunt-group
wildcard slot that Agent A calls. When Agent B returns, she
relinquished when he left. manually puts her phone back into
the ready status.
Hunt-group slot An agent joining a hunt group An agent who enters the not-ready An agent who enters the not-ready
availability occupies a wildcard slot in the state does not give up a slot in the does not give up a slot in the hunt
hunt group list. An agent leaving hunt group. The agent continues to group. The agent continues to
the group relinquishes the slot, occupy the slot regardless of occupy the slot regardless of
which becomes available for whether the agent is in the whether the agent is in the
another agent. not-ready status. not-ready status.
Cisco Unified Communications Manager Express System Administrator Guide
676 OL-10663-02
Configuring Call-Coverage Features
Information About Call Coverage Features
Table 11 Comparison of Hunt Group Agent Availability Features (continued)
Comparison
Factor Dynamic Membership Agent Status Control Automatic Agent Status Not-Ready
Agent activation An authorized agent uses a feature An agent uses the HLog soft key An agent who is a member of a
method access code (FAC) to join a hunt to toggle agent status between hunt group configured with the
group and a different FAC to leave ready and not ready. Agents can auto logout command does not
the hunt group. also use the HLog ephone FAC or answer the specified number of
the HLog ephone-dn FAC to calls, and the agent’s phone is
toggle between ready and automatically changed to the
not-ready if FACs are enabled. not-ready status. The agent uses
the HLog soft key or a FAC to
If the HLog soft key is not
return to the ready status.
enabled, the DND soft key can be
used to put an agent in the If the HLog soft key or FAC has
not-ready status and the agent will not been enabled in the
not receive any calls. configuration, the agent uses the
DND soft key to return to the
ready status.
Configuration The system administrator uses the The system administrator uses the The system administrator uses the
list command to configure up to HLog keyword with the auto logout command to enable
20 wildcard slots in a hunt group hunt-group logout command to automatic agent status not-ready
and uses the ephone-hunt login provide an HLog soft key on for a hunt group.
command to authorize certain display phones and uses the fac
This functionality is disabled by
directory numbers to use these command to enable standard
default.
wildcard slots. FACs or create a custom FAC.
See SCCP: Configuring Ephone
See SCCP: Configuring Ephone See SCCP: Configuring Ephone Hunt Groups, page 702.
Hunt Groups, page 702. Hunt Groups, page 702.
Optional The system administrator can The system administrator can use The system administrator can use
customizations establish custom FACs for agents the softkeys commands to change the auto logout command to
to use to enter or leave a hunt the position or prevent the display specify the number of unanswered
group. of the HLog soft key on individual calls that will trigger an agent
phones. status change to not-ready and
whether this feature applies to
dynamic hunt-group members,
static hunt-group members, or
both.
The system administrator can use
the hunt-group logout command
to specify whether an automatic
change to the not-ready status also
places a phone in DND mode.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 677
Configuring Call-Coverage Features
Information About Call Coverage Features
Dynamic Hunt Group Membership
Hunt groups allow you to set up pools of extension numbers to answer incoming calls. Up to 20 wildcard
slots can be entered in the list of hunt group extension numbers to allow dynamic group membership, in
which authorized phone users can join a hunt group whenever a vacant wildcard slot is available and
they can leave when they like. Each phone user who joins a group occupies one slot. If no slots are
available, a user who tries to join a group hears a busy signal.
Allowing dynamic membership in a hunt group is a three-step process:
1. Use the list command in ephone-hunt configuration mode to specify up to 20 wildcard slots in the
hunt group.
2. Use the ephone-hunt login command under each directory number that should be allowed to
dynamically join and leave hunt groups. Directory numbers are disallowed from joining hunt groups
by default, so you have to explicitly allow this behavior for each directory number that you want to
be able to log in to hunt groups.
3. Use the fac standard command to enable standard FACs or the fac custom command to define
custom FACs. FACs must be enabled so that agents can use them to join and leave hunt groups.
To dynamically join a hunt group, a phone user dials a standard or custom FAC for joining a hunt group.
The standard FAC to join a hunt group is *3. If multiple hunt groups have been created that allow
dynamic membership, the phone user must also dial the hunt group pilot number. For example, if the
following hunt groups are defined, a phone user dials *38000 to join the Sales hunt group:
ephone-hunt 24 sequential
pilot 8000
list 8001, 8002, *, *
description Sales Group
final 9000
ephone-hunt 25 sequential
pilot 7000
list 7001, 7002, *, *
description Service Group
final 9000
To leave a hunt group, a phone user dials the standard or custom FAC for leaving a hunt group. The
standard FAC to leave a hunt group is #3. See “Customizing Soft Keys” on page 1047.
Note The Dynamic Membership feature is different from the Agent Status Control feature and the Automatic
Agent Status Not-Ready feature. Table 11 on page 676 compares the features.
Agent Status Control
The Agent Status Control feature allows ephone-hunt-group agents to control whether their phones are
in the ready or not-ready status. A phone in the ready status is available to receive calls from the hunt
group. A phone in the not-ready status blocks calls from the hunt group. Agents should use the not-ready
status for short breaks or other temporary interruptions during which they do not want to receive
hunt-group calls.
Agents who put their phones into the not-ready status do not relinquish their slots in the hunt group list.
Cisco Unified Communications Manager Express System Administrator Guide
678 OL-10663-02
Configuring Call-Coverage Features
Information About Call Coverage Features
Agents use the HLog soft key or the DND soft key to put a phone into the not-ready status. When the
HLog soft key is used to put a phone in the not-ready status, it does not receive hunt group calls but can
receive other calls. If the DND soft key is used, the phone does not receive any calls until it is returned
to the ready status. The HLog and DND soft keys toggle the feature: if the phone is in the ready status,
pressing the key puts the phone in the not-ready status and vice-versa.
The DND soft key is visible on phones by default, but the HLog soft key must be enabled in the
configuration using the hunt-group logout command, which has the following options:
• HLog—Enables both an HLog soft key and a DND soft key on phones in the idle, seized, and
connected call states. When you press the HLog soft key, the phone is changed from the ready to
not-ready status or from the not-ready to ready status. When the phone is in the not-ready status, it
does not receive calls from the hunt group, but it is still able to receive calls that do not come through
the hunt group (calls that directly dial its extension). The DND soft key is also available to block all
calls to the phone if that is the preferred behavior.
• DND—Enables only a DND soft key on phones. The DND soft key also changes a phone from the
ready to not-ready status or from the not-ready to ready status, but the phone does not receive any
incoming calls, including those from outside hunt groups.
Phones without soft-key displays can use a FAC to toggle their status from ready to not-ready and back
to ready. The fac command must be used to enable the standard set of FACs or to create custom FACs.
The standard FAC to toggle the not-ready status at the directory number (extension) level is *4 and the
standard FAC to toggle the not-ready status at the ephone level (all directory numbers on the phone) is
*5. See Where to Go Next, page 738.
Note The Agent Status Control feature is different from the Dynamic Membership feature and the Automatic
Agent Status Not-Ready feature. Table 11 on page 676 compares the features.
Automatic Agent Status Not-Ready
Before Cisco Unified CME 4.0, this feature was known as Automatic Hunt Group Logout. If the auto
logout command was enabled for a hunt group, a phone was placed in DND mode when a line on the
phone did not answer a call for that hunt group within the time limit specified in the timeout command.
In Cisco Unified CME 4.0 and later versions, the name and behavior of this feature has changed,
although the Cisco IOS command remains the same. The auto logout command now specifies the
number of unanswered hunt group calls after which the agent status of an directory number is
automatically changed to not-ready. You can limit Automatic Agent Status Not-Ready to dynamic hunt
group members (those who log in using a wildcard slot in the list command) or to static hunt group
members (those who are explicitly named in the list command), or you can apply this behavior to all
hunt group members.
A related command, hunt-group logout, specifies whether the phones that are automatically changed to
the not-ready status should also be placed into DND mode. Phones in the not-ready status do not accept
calls from hunt groups, but they do accept calls that directly dial their extensions. Phones in DND mode
do not accept any calls. The default if the hunt-group logout command is not used is that the phones
that are automatically placed in the not-ready status are also placed in DND mode.
Agents whose phones are automatically placed into the not-ready status do not relinquish their slots in
the hunt group list.
Note The Automatic Agent Status Not-Ready feature is different from the Dynamic Membership feature and
the Agent Status Control feature. Table 11 on page 676 compares the features.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 679
Configuring Call-Coverage Features
Information About Call Coverage Features
Night Service
The night-service feature allows you to provide coverage for unstaffed extensions during hours that you
designate as “night-service” hours. During the night-service hours, calls to the designated extensions,
known as night-service directory numbers or night-service lines, send a special “burst” ring to
night-service phones that have been specified to receive this special ring. Phone users at the
night-service phones can then use the call-pickup feature to answer the incoming calls from the
night-service directory numbers.
For example, the night-service feature can allow an employee working after hours to intercept and
answer calls that are presented to an unattended receptionist’s phone. This feature is useful for sites at
which all incoming public switched telephone network (PSTN) calls have to be transferred by a
receptionist because the PSTN connection to the Cisco Unified CME system does not support Direct
Inward Dialing (DID). When a call arrives at the unattended receptionist’s phone during hours that are
specified as night service, a ring burst notifies a specified set of phones of the incoming call. A phone
user at any of the night-service phones can intercept the call using the call-pickup feature. Night-service
call notification is sent every 12 seconds until the call is either answered or aborted.
A user can enter a night-service code to manually toggle night-service treatment off and on from any
phone that has a line assigned to night service. Before Cisco CME 3.3, using the night-service code turns
night service on or off only for directory numbers on the phone at which the code is entered. In
Cisco CME 3.3 and later versions, using the night-service code at any phone with a night-service
directory number turns night service on or off for all phones with night-service directory numbers.
Figure 20 illustrates night service.
Cisco Unified Communications Manager Express System Administrator Guide
680 OL-10663-02
Configuring Call-Coverage Features
Information About Call Coverage Features
Figure 20 Night Service
Phone 5
1 Extension 1000 has been designated as a night-service Button 1 is extension 1000
IP
extension (ephone-dn). When extension 1000 receives an Extension 1000 is a night-
incoming call during a night-service period, phone 5 rings service extension
and notification is made to the night-service phones.
2 Phones 14 and 15 have been designated as night-
service phones. When phone 5 starts ringing,
phones 14 and 15 ring once and display “Night Service
1000.” The incoming call on extension 1000 can be V
answered from phone 14 or phone 15 using call pickup.
telephony-service IP
night-service day fri 17:01 17:00
Phone 14
night-service day sat 17:01 17:00
Button 1 is extension 1010
night-service day sun 17:01 07:59
Phone 14 is a night-service phone
night-service date jan 1 00:00 00:00
night-service code *1234
!
ephone-dn 1 IP
number 1000
night-service bell Phone 15
! Button 1 is extension 1011
ephone-dn 10 Phone 15 is a night-service phone
number 1010
!
ephone-dn 11
number 1011
!
ephone 5
mac-address 1111.2222.0001
button 1:1
!
ephone 14
mac-address 1111.2222.0002
button 1:10
night-service bell
!
ephone 15
mac-address 1111.2222.0003
88951
button 1:11
night-service bell
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 681
Configuring Call-Coverage Features
Information About Call Coverage Features
Overlaid Ephone-dns
Overlaid ephone-dns are directory numbers that share the same button on a phone. Overlaid ephone-dns
can be used to receive incoming calls and place outgoing calls. Up to 25 ephone-dns can be assigned to
a single phone button. They can have the same extension number or different numbers. The same
ephone-dns can appear on more than one phone and more than one phone can have the same set of
overlaid ephone-dns.
The order in which overlaid ephone-dns are used by incoming calls can be determined by the call hunt
commands, preference and huntstop. For example, ephone-dn 1 to ephone-dn 4 have the same
extension number, 1001. Three phones are configured with the button 1o1,2,3,4 command. A call to
1001 will ring on the ephone-dn with the highest preference and display the caller ID on all phones that
are on hook. If another incoming call to 1001 is placed while the first call is active (and the first
ephone-dn with the highest preference is configured with the no huntstop command), the second call
will roll over to the ephone-dn with the next-highest preference, and so forth. For more information, see
the “Call Hunt” section on page 665.
If the ephone-dns in an ephone-dn overlay use different numbers, incoming calls go to the ephone-dn
with the highest preference. If no preferences are configured, the dial-peer hunt command setting is
used to determine which ephone-dns are used for incoming calls. The default setting for the dial-peer
hunt command is to randomly select an ephone-dn that matches the called number.
Note To continue or to stop the search for ephone-dns, you must use, respectively, the no huntstop and
huntstop commands under the individual ephone-dns. The huntstop setting is applied only to the dial
peers affected by the ephone-dn command in telephony-service mode. Dial peers configured in global
configuration mode comply with the global configuration huntstop setting.
Figure 21 shows an overlay set with two directory numbers and one number that is shared on two phones.
Ephone-dn 17 has a default preference value of 0, so it will receive the first call to extension 1001. The
phone user at phone 9 answers the call, and a second incoming call to extension 1001 can be answered
on phone 10 using directory number 18.
Figure 21 Overlaid Ephone-dn (Simple Case)
Phone 9 ephone-dn 17
Button 1 is two appearances number 1001
of extension 1001
ephone-dn 18
IP number 1001
preference 1
IP V ephone 9
Phone 10 button 1o17,18
88894
Button 1 is two appearances
of extension 1001 ephone 10
button 1o17,18
When a call is answered on an ephone-dn, that ephone-dn is no longer available to other phones that
share the ephone-dn in overlay mode. For example, if extension 1001 is answered by phone 1, caller ID
for extension 1001 displays on phone 1 and is removed from the screens of phone 2 and phone 3. All
actions pertaining to the call to extension 1001 (ephone-dn 17) are displayed on phone 1 only. If phone
1 puts extension 1001 on hold, the other phones will not be able to pick up the on-hold call using a simple
shared-line pickup. In addition, none of the other four phones will be able to make outgoing calls from
Cisco Unified Communications Manager Express System Administrator Guide
682 OL-10663-02
Configuring Call-Coverage Features
Information About Call Coverage Features
the ephone-dn while it is in use. When phone users press button 1, they will be connected to the next
available ephone-dn listed in the button command. For example, if phone 1 and phone 2 are using
ephone-dn 1 and ephone-dn 2, respectively, phone 3 must pick up ephone-dn 3 for an outgoing call.
If there are more phones than ephone-dns associated with an ephone-dn overlay set, it is possible for
some phones to find that all the ephone-dns within their overlay set are in use by other phones. For
example, if five phones have a line button configured with the button 1o1, 2, 3 command, there may be
times when all three of the ephone-dns in the overlay set are in use. When that occurs, the other two
phones will not be able to use an ephone-dn in the overlay set. When all ephone-dns in an overlay set
are in use, phones with this overlay set will display the remote-line-in-use icon (a picture of a phone with
a flashing X through it) for the corresponding line button. When at least one ephone-dn becomes
available within the overlay set (that is, an ephone-dn is either idle or ringing), the phone display reverts
to showing the status of the available ephone-dn (idle or ringing).
Shared-Line Overlays
Dual-line ephone-dns can also use overlays. The configuration parameters are the same as for single-line
ephone-dns, except that the huntstop channel command must be used to keep calls from hunting to the
ephone-dn’s second channel.
The primary ephone-dn in a shared-line overlay set should be unique to the phone to guarantee that the
phone has a line available for outgoing calls, and to ensure that the phone user can obtain dial-tone even
when there are no idle lines available in the rest of the shared-line overlay set. Use a unique ephone-dn
to provide for a unique calling party identity on outbound calls made by the phone so that the called user
can see which specific phone is calling.
The following example shows the configuration for a simple shared-line overlay set. The primary
ephone-dn that is configured for each phone is unique while the remaining ephone-dns 10, 11, and 12
are shared in the overlay set on both phones:
ephone 1
mac-address 1111.1111.1111
button 1o1,10,11,12
!
ephone 2
mac-address 2222.2222.2222
button 1o2,10,11,12
A more complex directory number configuration mixes overlaid directory numbers with shared directory
numbers and plain dual-line directory numbers on the same phones. Figure 22 on page 684 illustrates
the following example of a manager with two assistants. On the manager’s phone the same number, 2001,
appears on button 1 and button 2. The two line appearances of extension 2001 use two single-line
directory numbers, so the manager can have two active calls on this number simultaneously, one on each
button. The directory numbers are set up so that button 1 will ring first, and if a second call comes in,
button 2 will ring. Each assistant has a personal directory number and also shares the manager’s
directory numbers. Assistant 1 has all three directory numbers in an overlay set on one button, whereas
assistant 2 has one button for the private line and a second button with both of the manager’s lines in an
overlay set. A sequence of calls might be as follows.
1. An incoming call is answered by the manager on extension 2001 on button 1 (directory number 20).
2. A second call rings on 2001 and rolls over to the second button on the manager’s phone (directory
number 21). It also rings on both assistants’ phones, where it is also directory number 21, a shared
directory number.
3. Assistant 2 answers the call. This is a shared overlay line (one directory number, 21, is shared among
three phones, and on two of them this directory number is part of an overlay set). Because it is shared
with button 2 on the manager’s phone, the manager can see when assistant 2 answers the call.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 683
Configuring Call-Coverage Features
Information About Call Coverage Features
4. Assistant 1 makes an outgoing call on directory number 22. The button is available because of the
additional directory numbers in the overlay set on the assistant 1 phone.
At this point, the manager is in conversation on directory number 20, assistant 1 is in conversation on
directory number 22, and assistant 2 is in conversation on directory number 21.
Figure 22 Overlaid Ephone-dn (Complex Case)
Manager phone
Button 1 is extension 2001 ephone-dn 20
Button 2 is extension 2001 number 2001
no huntstop
IP ! Manager number
ephone-dn 21
number 2001
IP V preference 1
Assistant 1 phone ! Manager number
Button 1 is extension 2001
and extension 2002 ephone-dn 22
number 2002
! Assistant 1 personal number
IP
Assistant 2 phone ephone-dn 23
Button 1 is extension 2003 number 2003
Button 2 is extension 2001 ! Assistant 2 personal number
ephone 8
button 1:20 2:21
! Manager phone
ephone 9
button 1o22,20,21
! Assistant 1 phone
ephone 10
88895
button 1:23 2o20,21
! Assistant 2 phone
For configuration information, see the “SCCP: Configuring Overlaid Ephone-dns” section on page 720.
Call Waiting for Overlaid Ephone-dns
Call waiting allows phone users to know that another person is calling them while they are talking on
the phone. Phone users hear a call-waiting tone indicating that another party is trying to reach them.
Calls to IP phones with soft keys can be answered with the Answer soft key. Calls to analog phones are
answered using hookflash. When phone users answer a call-waiting call, their original call is
automatically put on hold. If phone users ignore a call-waiting call, the caller is forwarded if
call-forward no-answer has been configured.
In Cisco CME 3.2.1 and later versions, call waiting is available for overlaid ephone-dns. The difference
in configuration between overlaid ephone-dns with call waiting and overlaid ephone-dns without call
waiting is that overlaid ephone-dns with call waiting use the c keyword in the button command and
overlaid ephone-dns without call waiting use the o keyword. For configuration information, see the
“SCCP: Configuring Overlaid Ephone-dns” section on page 720.
The behavior of overlaid ephone-dns with call waiting and overlaid ephone-dns without call waiting is
the same, except for the following:
Cisco Unified Communications Manager Express System Administrator Guide
684 OL-10663-02
Configuring Call-Coverage Features
Information About Call Coverage Features
• Calls to numbers included in overlaid ephone-dns with call waiting will cause inactive phones to
ring and active phones connected to other parties to generate auditory call-waiting notification. The
default sound is beeping, but you can configure an ephone-dn to use a ringing sound. (See the
“SCCP: Configuring Call-Waiting Indicator Tone” section on page 696.) Visual call-waiting
notification includes the blinking of handset indicator lights and the display of caller IDs.
For example, if three of four phones are engaged in calls to numbers from the same overlaid
ephone-dn with call-waiting and another call comes in, the one inactive phone will ring, and the
three active phones will issue auditory and visual call-waiting notification.
• In Cisco Unified CME 4.0 and later versions, up to six waiting calls can be displayed on
Cisco Unified IP Phone 7940G, 7941G, 7941G-GE, 7960G, 7961G, 7961G-GE, 7970G, and
7971G-GE. For all other phones and earlier Cisco Unified CME versions, two calls to numbers in
an overlaid ephone-dn set can be announced. Subsequent calls must wait in line until one of the two
original calls has ended. The callers who are waiting in the line will hear a ringback tone.
For example, a Cisco Unified IP Phone 7910 (maximum two call-waiting calls) has a button configured
with a set of overlaid ephone-dns with call waiting (button 1c1,2,3,4). A call to ephone-dn 1 is
answered. A call to ephone-dn 2 generates call-waiting notification. Calls to ephone-dn 3 and ephone-dn
4 will wait in line and remain invisible to the phone user until one of the two original calls ends. When
the call to ephone-dn 1 ends, the phone user can then talk to the person who called ephone-dn 2. The call
to ephone-dn 3 issues call-waiting notification while the call to ephone-dn 4 waits in line. (The
Cisco Unified IP Phone 7960 supports six calls waiting.) Phones configured for call waiting do not
generate call-waiting notification when they are transferring calls or hosting conference calls.
Note that if an overlaid ephone-dn has call-forward-no-answer configured, calls to the ephone-dn that
are unanswered before the no-answer timeout expires are forwarded to the configured destination. If
call-forward-no-answer is not configured, incoming calls receive ringback tones until the calls are
answered.
More than one phone can use the same set of overlaid ephone-dns. In this case, the call-waiting behavior
is slightly different. The following example demonstrates call waiting for overlaid ephone-dns that are
shared on two phones.
ephone 1
button 1c1,2,3,4
!
ephone 2
button 1c1,2,3,4
1. A call to ephone-dn 1 rings on ephone 1 and on ephone 2. Ephone 1 answers, and the call is no longer
visible to ephone 2.
2. A call to ephone-dn 2 issues a call-waiting notification to ephone 1 and rings on ephone 2, which
answers. The second call is no longer visible to ephone 1.
3. A call to ephone-dn 3 issues a call-waiting notification to ephone 1 and ephone 2. Ephone 1 puts the
call to ephone-dn 1 on hold and answers the call to ephone-dn 3. The call to ephone-dn 3 is no longer
visible to ephone 2.
4. A call to ephone-dn 4 is issues a call-waiting notification on ephone 2. The call is not visible on
ephone 1 because it has met the two-call maximum by handling the calls to ephone-dn 1 and
ephone-dn 3. (Note that the call maximum is six for those phones that are able to handle six
call-waiting calls, as previously described.)
Note Ephone-dns accept call interruptions, such as call waiting, by default. For call waiting to work, the
default must be active. For more information, see the “SCCP: Configuring Call-Waiting Indicator Tone”
section on page 696.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 685
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Extending Calls for Overlaid Ephone-dns to Other Buttons on the Same Phone
Phones with overlaid ephone-dns can use the button command with the x keyword to dedicate one or
more additional buttons to receive overflow calls. If an overlay button is busy, an incoming call to any
of the other ephone-dns in the overlay set rings on the first available overflow button on each phone that
is configured to receive the overflow. This feature works only for overlaid ephone-dns that are
configured with the button command and the o keyword; it is not supported with overlaid ephone-dns
that are configured using the button command and the c keyword or other types of ephone-dns that are
not overlaid.
Using the button command with the c keyword results in multiple calls on one button (the button is
overlaid with multiple ephone-dns that have call waiting), whereas using the button command with the
o keyword and the x keyword results in one call per button and calls on multiple buttons.
For example, an ephone has an overlay button with ten numbers assigned to it using the button command
and the o keyword. The next two buttons on the phone are configured using the button command and
the x keyword. These buttons are reserved to receive additional calls to the overlaid extensions on the
first button when the first button is in use.
ephone 276
button 1o24,25,26,27,28,29,30,31,32,33 2x1 3x1
For configuration information, see the “SCCP: Configuring Overlaid Ephone-dns” section on page 720.
How to Configure Call Coverage Features
This section contains the following procedures:
Call Hunt
• SCCP: Configuring Call Hunt, page 687 (required)
• SCCP: Verifying Call Hunt, page 688 (optional)
• SIP: Configuring Call Hunt, page 689 (required)
Call Pickup
• Enabling Call Pickup, page 691 (required)
• SIP: Configuring GPickUp and PickUp Soft Key URIs, page 694 (required)
Call Waiting
• SCCP: Configuring Call-Waiting Indicator Tone, page 696 (optional)
• SCCP: Configuring Cancel Call Waiting, page 698 (optional)
• SIP: Enabling Call Waiting, page 700 (required)
Hunt Groups
• SCCP: Configuring Ephone Hunt Groups, page 702 (required)
• SCCP: Verifying Ephone Hunt Groups, page 708 (optional)
• Configuring Voice Hunt Groups, page 710 (required)
Night Service
• SCCP: Configuring Night Service, page 714 (required)
Cisco Unified Communications Manager Express System Administrator Guide
686 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
• SCCP: Verifying Night Service, page 718 (optional)
Overlaid Ephone-dns
• SCCP: Configuring Overlaid Ephone-dns, page 720 (required)
• SCCP: Verifying Overlaid Ephone-dns, page 723 (optional)
SCCP: Configuring Call Hunt
To configure a group of directory numbers to provide call coverage for a single called number, perform
the following steps for each directory number in the group.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag [dual-line]
4. number number [secondary number] [no-reg [both | primary]]
5. preference preference-order [secondary secondary-order]
6. huntstop
7. huntstop channel
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag [dual-line] Enters ephone-dn configuration mode for the purpose of
configuring a directory number.
Example:
Router(config)# ephone-dn 20 dual-line
Step 4 number number [secondary number] [no-reg Associates a telephone or extension number with the directory
[both | primary]] number.
• Assign the same number to several primary or secondary
Example: ephone-dns to create a group of virtual dial peers through
Router(config-ephone-dn)# number 101 which the incoming called number must search.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 687
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 5 preference preference-order [secondary Sets the preference value for the ephone-dn.
secondary-order]
• Default: 0.
• Increment the preference order for subsequent ephone-dns
Example:
Router(config-ephone-dn)# preference 2
with the same number. That is, the first directory number is
preference 0 by default and you must specify 1 for the second
ephone-dn with the same number, 2 for the next, and so on.
• secondary secondary-order—(Optional) Preference value
for the secondary number of an ephone-dn. Default is 9.
Step 6 no huntstop Explicitly enables call hunting behavior for a directory number.
or
• Configure no huntstop for all ephone-dns, except the final
huntstop ephone-dn, within a set of ephone-dns with the same number.
• Configure the huntstop command for the final ephone-dn
Example: within a set of ephone-dns with the same number.
Router(config-ephone-dn)# no huntstop
or
Router(config-ephone-dn)# huntstop
Step 7 huntstop channel (Optional) Enables channel huntstop, which keeps a call from
hunting to the next channel of a directory number if the first
channel is busy or does not answer.
Example:
Router(config-ephone-dn)# huntstop • Required for dual-line ephone-dns that are used for call
channel hunting.
Step 8 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
What to Do Next
If you want to collect statistics for hunt groups, see Cisco Unified CME B-ACD and Tcl Call-Handling
Applications.
SCCP: Verifying Call Hunt
To verify the configuration for call hunt, perform the following steps.
SUMMARY STEPS
1. show running-config
2. show telephony-service ephone-dn
3. show telephony-service all
or
show telephony-service dial-peer
Cisco Unified Communications Manager Express System Administrator Guide
688 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
DETAILED STEPS
Step 1 show running-config
This command displays your configuration. Preference and huntstop information is listed in the
ephone-dn portion of the output.
Router# show running-config
ephone-dn 2 dual-line
number 126
description FrontDesk
name Receptionist
preference 1
call-forward busy 500
huntstop channel
no huntstop
Step 2 show telephony-service ephone-dn
This command displays ephone-dn preference and huntstop configuration information.
Router# show telephony-service ephone-dn
ephone-dn 243
number 1233
preference 1
huntstop
Step 3 show telephony-service all
or
show telephony-service dial-peer
These commands display preference and huntstop configurations for ephone-dn dial peers.
Router# show telephony-service dial-peer
!
dial-peer voice 20026 pots
destination-pattern 5002
huntstop
call-forward noan 5001 timeout 45
port 50/0/2
SIP: Configuring Call Hunt
To configure the call hunting feature and prevent hunt-on-busy from redirecting a call from a busy phone
into a dial peer that has been setup with a catch-all default destination, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register dn dn-tag
4. number number
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 689
Configuring Call-Coverage Features
How to Configure Call Coverage Features
5. preference preference-order
6. huntstop
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register dn dn-tag Enters voice register dn configuration mode to define a
directory number for a SIP phone, intercom line, voice port,
or an MWI.
Example:
Router(config)# voice register dn 1
Step 4 number number Associates a phone number with the directory number.
• Assign the same number to several directory numbers
Example: to create a group of virtual dial peers through which the
Router(config-register-dn)# number 5001 incoming called number must search.
Step 5 preference preference-order Creates the preference order for matching the VoIP dial
peers created for the number associated with this directory
number to establish the hunt strategy for incoming calls.
Example:
Router(config-register-dn)# preference 4 • Default is 0, which is the highest preference.
Step 6 huntstop Disables call-hunting behavior for an extension on a SIP
phone.
Example:
Router(config-register-dn)# huntstop
Step 7 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-dn)# end
What to Do Next
If you want to collect statistics for hunt groups, see Cisco Unified CME B-ACD and Tcl Call-Handling
Applications.
Cisco Unified Communications Manager Express System Administrator Guide
690 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Enabling Call Pickup
To enable Call Pickup features on SCCP or SIP phones, perform the following steps.
Prerequisites
• SIP phones require Cisco Unified CME 7.1 or a later version.
• The PickUp and GPickUp soft keys display by default on supported SCCP and SIP phones. If
previously disabled, you must enable these soft keys with the softkeys idle command.
Restrictions
• SIP phones that do not support the PickUp and GpickUp soft keys must use feature access codes
(FACs) to access these features.
• Different directory numbers with the same extension number must have the same Pickup
configuration.
• A directory number can be assigned to only one pickup group.
• Pickup group numbers can vary in length, but must have unique leading digits. For example, if you
configure group number 17, you cannot also configure group number 177. Otherwise a pickup in
group 17 is always triggered before the user can enter the final 7 for 177.
• Calls from H.323 trunks are not supported on SIP phones.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. service directed-pickup [gpickup]
5. fac {standard | custom pickup {direct | group | local} custom-fac}
6. exit
7. ephone-dn dn-tag [dual-line | octo-line]
or
voice register dn dn-tag
8. pickup-group number
9. pickup-call any-group
10. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 691
Configuring Call-Coverage Features
How to Configure Call Coverage Features
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 service directed-pickup [gpickup] Enables Directed Call Pickup and modifies the function of the
GPickUp and PickUp soft keys.
Example: • gpickup—(Optional) Enables using the GPickUp soft key to
Router(config-telephony)# service perform Directed Call Pickup on SCCP phones. This
directed-pickup gpickup keyword is supported in Cisco Unified CME 7.1 and later
versions.
• This command determines the specific soft keys used to
access different Call Pickup features on SCCP and SIP
phones. For a description, see the service directed-pickup
command in the Cisco Unified CME Command Reference.
Step 5 fac {standard | custom pickup {direct | Enables standard FACs or creates a custom FAC or alias for
group | local} custom-fac} Pickup features on SCCP and SIP phones.
• standard—Enables standard FACs for all phones. Standard
Example: FAC for Park Retrieval is **10.
Router(config-telephony)# fac custom
pickup group #35 • custom—Creates a custom FAC for a feature.
• custom-fac—User-defined code to dial using the keypad on
an IP or analog phone. Custom FAC can be up to
256 characters and contain numbers 0 to 9 and * and #.
Step 6 exit Returns to privileged EXEC mode.
Example:
Router(config-telephony)# exit
Step 7 ephone-dn dn-tag [dual-line | octo-line] Enters directory number configuration mode.
or
voice register dn dn-tag
Example:
Router(config)# ephone-dn 20 dual-line
or
Router(config)# voice register dn 20
Cisco Unified Communications Manager Express System Administrator Guide
692 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 8 pickup-group group-number Creates a pickup group and assigns the directory number to the
group.
Example: • group-number—String of up to 32 characters. Group
Router(config-ephone-dn)# pickup-group 30 numbers can vary in length but must have unique leading
or digits. For example, if there is a group number 17, there
Router(config-register-dn)# pickup-group cannot also be a group number 177.
30
• This command can also be configured in ephone-dn-template
configuration mode and applied to one or more ephone-dns.
The ephone-dn configuration has priority over the template
configuration.
Step 9 pickup-call any-group Enables a phone user to pickup ringing calls on any extension
belonging to a pickup group by pressing the GPickUp soft key
and asterisk (*).
Example:
Router(config-ephone-dn)# pickup-call • The ringing extension must be configured with a pickup
any-group group using the pickup-group command.
or
• If this command is not configured, the user can pickup calls
Router(config-register-dn)# pickup-call
in other groups by pressing the GPickUp soft key and dialing
any-group
the pickup group number.
Step 10 end Exits configuration mode.
Example:
Router(config-ephone-dn)# end
or
Router(config-register-dn)# end
Examples
The following example shows the Group Pickup and Local Group Pickup features enabled with the
service directed-pickup gpickup command. Extension 1005 on phone 5 and extension 1006 on phone 6
are assigned to pickup group 1.
telephony-service
load 7960-7940 P00308000500
load E61 SCCP61.8-2-2SR2S
max-ephones 100
max-dn 240
ip source-address 15.7.0.1 port 2000
service directed-pickup gpickup
cnf-file location flash:
cnf-file perphone
voicemail 8900
max-conferences 8 gain -6
call-park system application
transfer-system full-consult
fac standard
create cnf-files version-stamp 7960 Sep 25 2007 21:25:47
!
!
!
ephone-dn 5
number 1005
pickup-group 1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 693
Configuring Call-Coverage Features
How to Configure Call Coverage Features
!
!
ephone-dn 6
number 1006
pickup-group 1
!
!
ephone 5
mac-address 0001.2345.6789
type 7962
button 1:5
!
!
!
ephone 6
mac-address 000F.F758.E70E
type 7962
button 1:6
SIP: Configuring GPickUp and PickUp Soft Key URIs
To specify the uniform resource identifier (URI) for the group pickup (GPickUp) and Pickup soft keys
on supported SIP phones, perform the following steps.
Prerequisites
• Cisco Unified CME 7.1 or a later version.
• The mode cme command must be enabled in Cisco Unified CME.
• Call Pickup must be enabled on the directory number. For information, see the “Enabling Call
Pickup” section on page 691.
Restrictions
• This feature is supported only on Cisco Unified IP Phone 7911G, 7941G, 7941GE, 7961G,
7961GE, 7970G, and 7971GE.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. call-feature-uri gpickup service-uri
5. call-feature-uri pickup service-uri
6. end
Cisco Unified Communications Manager Express System Administrator Guide
694 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to set
global parameters for all supported SIP phones in a
Cisco Unified CME environment.
Example:
Router(config)# voice register global
Step 4 call-feature-uri gpickup service-uri Specifies the URI for the GPickUp soft key on SIP phones
connected to a Cisco Unified CME router.
Example:
Router(config-register-global)#
call-feature-uri gpickup
http://10.4.212.11/gpickup
Step 5 call-feature-uri pickup service-uri Specifies the URI for the PickUp soft key on SIP phones
connected to a Cisco Unified CME router.
Example:
Router(config-register-global)#
call-feature-uri pickup
http://10.4.212.11/pickup
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-register-global)# end
Examples
The following example shows the service URIs set for the GPickUp and PickUp soft keys:
voice register global
mode cme
call-feature-uri pickup http://10.4.212.11/pickup
call-feature-uri gpickup http://10.4.212.11/gpickup
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 695
Configuring Call-Coverage Features
How to Configure Call Coverage Features
SCCP: Configuring Call-Waiting Indicator Tone
To specify the type of audible call-waiting indicator on a SCCP phone, perform the following steps. The
default is for directory numbers to accept call interruptions, such as call waiting, and to issue a beep tone.
Instead of the standard call waiting beep, you can enable a ring tone for call-waiting.
Restrictions
• The call-waiting ring option is not supported if the ephone-dn is configured with the no call-waiting
beep accept command.
• If you configure a button to have a silent ring, you will not hear a call-waiting beep or call-waiting
ring regardless of whether the ephone-dn associated with the button is configured to generate a
call-waiting beep or call-waiting ring. To configure a button for silent ring, see the “SCCP:
Assigning Directory Numbers to Phones” on page 165.
• The call-waiting beep volume cannot be adjusted through Cisco Unified CME for the
Cisco Unified IP Phone 7902G, Cisco Unified IP Phone 7905G, Cisco Unified IP Phone 7912G,
Cisco ATA-186, and Cisco ATA-188.
• The call-waiting ring option is not supported on the Cisco Unified IP Phone 7902G,
Cisco Unified IP Phone 7905G, or Cisco Unified IP Phone 7912G.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag [dual-line]
4. call-waiting beep [accept | generate]
5. call-waiting ring
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
696 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 3 ephone-dn dn-tag [dual-line] Enters ephone-dn configuration mode, creates an
ephone-dn, and optionally assigns it dual-line status.
Example:
Router(config)# ephone-dn 20 dual-line
Step 4 call-waiting beep [accept | generate] Enables an ephone-dn to generate or accept call-waiting
beeps.
Example: • Default is directory number both accepts and generates
Router(config-ephone-dn)# no call-waiting beep call waiting beep.
accept
• The beep is heard only if the other ephone-dn is
configured to accept call-waiting beeps (default).
Step 5 call-waiting ring (Optional) Enables an ephone-dn to use a ring indicator for
call-waiting notification.
Example: • To use this command, do not disable call-waiting beep
Router(config-ephone-dn)# call-waiting ring by using the no call-waiting beep accept command.
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
SCCP: Verifying Call-Waiting Indicator Tone
Step 1 Use the show running-config command to verify your configuration. Call-waiting settings are listed in
the ephone-dn portion of the output. If the no call-waiting beep generate and the no call-waiting beep
accept commands are configured, the show running-config command output will display the no
call-waiting beep command.
Router# show running-config
!
ephone-dn 3 dual-line
number 126
name Accounting
preference 2 secondary 9
huntstop
huntstop channel
call-waiting beep
!
Step 2 Use the show telephony-service ephone-dn command to display call-waiting configuration
information.
Router# show telephony-service ephone-dn
ephone-dn 1 dual-line
number 126 secondary 1261
preference 0 secondary 9
no huntstop
huntstop channel
call-forward busy 500 secondary
call-forward noan 500 timeout 10
call-waiting beep
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 697
Configuring Call-Coverage Features
How to Configure Call Coverage Features
SCCP: Configuring Cancel Call Waiting
To enable a phone user to cancel call waiting by using the CWOff soft key or a FAC, perform the
following steps.
Prerequisites
For information about standard and custom FACs, see “Configuring Feature Access Codes” on page 893.
Restrictions
• Call Waiting must be disabled by pressing the CWOff soft key or using the FAC before placing a
call; it cannot be activated or deactivated during a call.
• The CWOff soft key is not available when initiating Call Transfer.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-template template-tag
4. softkeys seized {[CallBack] [Cfwdall] [CWOff] [Endcall] [Gpickup] [HLog] [MeetMe]
[Pickup] [Redial]}
5. exit
6. ephone phone-tag
7. ephone-template template-tag
8. exit
9. telephony-service
10. fac {standard | custom ccw custom-fac}
11. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
698 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 3 ephone-template template-tag Enters ephone-template configuration mode to create an ephone
template.
Example: • template-tag—Unique identifier for the ephone template.
Router(config)# ephone-template 5 Range: 1 to 20.
Step 4 softkeys seized {[CallBack] [Cfwdall] (Optional) Modifies the order and type of soft keys that display on
[CWOff] [Endcall] [Gpickup] [HLog] an IP phone during the seized call state.
[MeetMe] [Pickup] [Redial]}
• You can enter any of the keywords in any order.
Example: • Default is all soft keys are displayed in alphabetical order.
Router(config-ephone-template)# softkeys • Any soft key that is not explicitly defined is disabled.
seized CWOff Cfwdall Endcall Redial
Step 5 exit Exits ephone-template configuration mode.
Example:
Router(config-ephone-template)# exit
Step 6 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique number that identifies this ephone
Example: during configuration tasks.
Router(config)# ephone 12
Step 7 ephone-template template-tag Applies the ephone template to the phone.
• template-tag—Unique identifier of the ephone template that
Example: you created in Step 3.
Router(config-ephone)# ephone-template 5
Step 8 exit Exits ephone configuration mode.
Example:
Router(config-ephone)# exit
Step 9 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 10 fac {standard | custom ccw custom-fac} Enables standard FACs or creates a custom FAC or alias.
• standard—Enables standard FACs for all phones. Standard
Example: FAC for cancel call waiting is *1.
Router(config-telephony)# fac custom ccw
**8
• custom—Creates a custom FAC for a FAC type.
• custom-fac—User-defined code to be dialed using the keypad
on an IP or analog phone. Custom FAC can be up to 256
characters long and contain numbers 0 to 9 and * and #.
Step 11 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 699
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Examples
The following example shows a configuration where the order of the CWOff soft key is modified for the
seized call state in ephone template 5 and assigned to ephone 12. A custom FAC for cancel call waiting
is set to **8.
telephony-service
max-ephones 100
max-dn 240
voicemail 8900
max-conferences 8 gain -6
transfer-system full-consult
fac custom cancel call waiting **8
!
!
ephone-template 5
softkeys seized CWOff Cfwdall Endcall Redial
!
!
ephone 12
ephone-template 5
mac-address 000F.9054.31BD
type 7960
button 1:10 2:7
SIP: Enabling Call Waiting
To enable call waiting on an individual SIP phone, perform the following steps.
Prerequisites
• Cisco Unified CME 3.4 or a later version.
• mode cme command must be configured in Cisco Unified CME.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register pool pool-tag
4. call-waiting
5. exit
6. voice register global
7. hold-alert timeout
8. end
Cisco Unified Communications Manager Express System Administrator Guide
700 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for a SIP phone in
Cisco Unified CME.
Example:
Router(config)# voice register pool 3
Step 4 call-waiting Configures call waiting on the SIP phone being configured.
Note This step is included to illustrate how to enable the
Example: command if it was previously disabled.
Router(config-register-pool)# call-waiting
• Default: Enabled.
Step 5 exit Exits voice register pool configuration mode.
Example:
Router(config-register-pool)# exit
Step 6 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Step 7 hold-alert timeout Sets an audible alert notification when a call is on hold on a
SIP phone. Default is disabled.
Example: • timeout—Interval after which an audible alert
Router(config-register-global)# hold-alert 30 notification is repeated, in seconds. Range: 15 to 300.
Step 8 end Exits to privileged EXEC mode.
Example:
Router(config-register-global)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 701
Configuring Call-Coverage Features
How to Configure Call Coverage Features
SCCP: Configuring Ephone Hunt Groups
To define a hunt group and optional agent availability parameters, perform the following steps.
Prerequisites
Directory numbers included in a hunt group must be configured in Cisco Unified CME. For
configuration information, see “SCCP: Creating Directory Numbers” on page 158.
Restrictions
• The HLog soft key is available only on display phones. It is not available on Cisco Unified IP
Phones 7902, 7905, and 7912; Cisco IP Communicator; and Cisco VG224.
• Shared ephone-dns cannot use the Agent Status Control or Automatic Agent Not-Ready feature.
• If directory numbers that are members of a hunt group are configured for called-name display, the
following restrictions apply:
– The primary or secondary pilot number must be defined using at least one wildcard character.
– The phone numbers in the list command cannot contain wildcard characters.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-hunt hunt-tag {longest-idle | peer | sequential}
4. pilot number [secondary number]
5. list number[, number...]
6. final final-number
7. hops number
8. timeout seconds[, seconds...]
9. max-timeout seconds
10. preference preference-order [secondary secondary-order]
11. no-reg [both | pilot]
12. fwd-final {orig-phone | final}
13. forward local-calls
14. secondary start [current | next | agent-position]
15. present-call {idle-phone | onhook-phone}
16. from-ring
17. description text-string
18. display-logout text-string
19. exit
20. telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
702 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
21. max-redirect number
22. hunt-group logout {DND | HLog}
23. exit
24. ephone-dn dn-tag
25. ephone-hunt login
26. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-hunt hunt-tag {longest-idle | peer | Enters ephone-hunt configuration mode to define an ephone
sequential} hunt group.
• hunt-tag—Unique sequence number that identifies this
Example: hunt group during configuration tasks. Range: 1 to 100.
Router(config)# ephone-hunt 23 peer
Cisco CME 3.3 and earlier—Range: 1 to 10
• longest-idle—Calls go to the ephone-dn that has been
idle the longest for the number of hops specified when
the ephone hunt group was defined. The longest-idle is
determined from the last time that a phone registered,
reregistered, or went on-hook.
• peer—First ephone-dn to ring is the number to the right
of the ephone-dn that was the last to ring when the pilot
number was last called. Ringing proceeds in a circular
manner, left to right, for the number of hops specified
when the ephone hunt group was defined.
• sequential—Ephone-dns ring in the left-to-right order
in which they are listed when the hunt group is defined.
Step 4 pilot number [secondary number] Defines the pilot number, which is the number that callers
dial to reach the hunt group.
Example: • number—E.164 number up to 27 characters. The
Router(config-ephone-hunt)# pilot 5601 dialplan pattern can be applied to the pilot number.
• secondary—(Optional) Defines an additional pilot
number for the ephone hunt group.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 703
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 5 list number[, number...] Defines the list of numbers (from 2 and 20) to which the
ephone hunt group redirects the incoming calls.
Example: • number—E.164 number up to 27 characters. Primary or
Router(config-ephone-hunt)# list 5001, 5002, secondary number assigned to an ephone-dn.
5017, 5028
Step 6 final final-number Defines the last number in the ephone hunt group, after
which the call is no longer redirected. Can be an ephone-dn
primary or secondary number, a voice-mail pilot number, a
Example:
Router(config-ephone-hunt)# final 6000
pilot number of another hunt group, or an FXS number.
Note When a final number is defined as a pilot number of
another hunt group, the pilot number of the first
hunt group cannot be configured as a final number
in any other hunt group.
Note This command is not used for ephone hunt groups
that are part of a Cisco Unified CME B-ACD
service. The final destination for those groups is
determined by the B-ACD service.
Step 7 hops number (Optional; peer and longest-idle hunt groups only) Sets the
number of hops before a call proceeds to the final number.
Example: • number—Number of hops before the call proceeds to
Router(config-ephone-hunt)# hops 7 the final ephone-dn. Range is 2 to 20, but the value
must be less than or equal to the number of extensions
that are specified in the list command. Default
automatically adjusts to the number of hunt group
members.
Step 8 timeout seconds[, seconds...] (Optional) Sets the number of seconds after which an
unanswered call is redirected to the next number in the
hunt-group list.
Example:
Router(config-ephone-hunt)# timeout 7, 10, 15 • seconds—Number of seconds. Range: 3 to 60000.
Multiple entries can be made, separated by commas,
that must correspond to the number of ephone-dns in
the list command. Each number in a multiple entry
specifies the time that the corresponding ephone-dn
will ring before a call is forwarded to the next number
in the list. If a single number is entered, it is used for
the no-answer period for each ephone-dn.
• If this command is not used, the default is the number
of seconds set by the timeouts ringing command,
which defaults to 180 seconds. Note that the default of
180 seconds may be greater than you desire.
Cisco Unified Communications Manager Express System Administrator Guide
704 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 9 max-timeout seconds (Optional) Sets the maximum combined timeout for the
no-answer periods for all ephone-dns in the ephone-hunt
list. The call proceeds to the final destination when this
Example:
Router(config-ephone-hunt)# max-timeout 25
timeout expires, regardless of whether it has completed the
hunt cycle.
• seconds—Number of seconds. Range is 3 to 60000.
• If this command is not used, the default is that no
combined timeout limit is set.
Step 10 preference preference-order [secondary (Optional) Sets a preference order for the ephone-dn
secondary-order] associated with the hunt-group pilot number.
• preference-order—See the CLI help for a range of
Example: numeric values, where 0 is the highest preference.
Router(config-ephone-hunt)# preference 1 Default is 0.
• secondary secondary-order—(Optional) Preference
order for the secondary pilot number. See the CLI help
for a range of numeric values, where 0 is the highest
preference. Default is 7.
Step 11 no-reg [both | pilot] (Optional) Prevents the hunt-group pilot number from
registering with an H.323 gatekeeper. If this command is
not used, the default is that the pilot number registers with
Example:
Router(config-ephone-hunt)# no-reg
the H.323 gatekeeper.
• both—(Optional) Both the primary and secondary pilot
numbers are not registered.
• pilot—(Optional) Only the primary pilot number is not
registered.
• In Cisco CME 3.1 and later versions, if this command
is used without the either the both or pilot keywords,
only the secondary number is not registered.
Step 12 fwd-final {orig-phone | final} (Optional) For calls that have been transferred into an
ephone hunt group by a local extension, determines the final
destination of a call that is not answered in the hunt group.
Example:
Router(config-ephone-hunt)# fwd-final • final—Forwards the call to the ephone-dn number that
orig-phone is specified in the final command.
• orig-phone—Forwards the call to the primary
directory number of the phone that transferred the call
into the hunt group.
Step 13 forward local-calls (Optional; sequential hunt groups only) Specifies that local
calls (calls from ephone-dns on the same
Cisco Unified CME system) will not be forwarded past the
Example:
Router(config-ephone-hunt)# no forward
first list member in a hunt group. If the first member is busy,
local-calls the internal caller hears busy. If the first number does not
answer, the internal caller hears ringback.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 705
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 14 secondary start [current | next | (Optional) For calls that are parked by hunt group member
list-position] phones, returns them to a different entry point in the hunt
group (as specified in this command) if the calls are recalled
Example: from park to the secondary pilot number or transferred from
Router(config-ephone-hunt)# secondary start park to an ephone-dn that forwards the call to the secondary
next pilot number.
• current—The ephone-dn that parked the call.
• next—The ephone-dn in the hunt group list that follows
the ephone-dn that parked the call.
• list-position—The ephone-dn at the specified position
in the list specified by the list command. Range is
1 to 10.
Step 15 present-call {idle-phone | onhook-phone} (Optional) Presents ephone-hunt-group calls only to
member phones that are idle or onhook, as specified.
Example: • idle-phone—A call from the ephone-hunt group is
Router(config-ephone-hunt)# present-call presented to an ephone only if all lines on the phone are
idle-phone idle. This option ignores monitored lines that have been
configured on the phone using the button m command.
• onhook-phone—A call from the ephone-hunt group is
presented to an ephone only if the phone is in the
on-hook state. When this keyword is configured, calls
in the ringing or hold state that are unrelated to the hunt
group do not prevent the presentation of calls from the
ephone-hunt group.
Step 16 from-ring (Optional) Specifies that on-hook time stamps should be
recorded when calls ring extensions and when calls are
answered. The default is that on-hook time stamps are
Example:
Router(config-ephone-hunt)# from-ring
recorded only when calls are answered.
Step 17 description text-string (Optional) Defines text that will appear in configuration
output.
Example:
Router(config-ephone-hunt)# description
Marketing Hunt Group
Step 18 display-logout text-string (Optional) Defines text that will appear on IP phones that
are members of a hunt group when all the hunt-group
members are in the not-ready status. This string can be used
Example:
Router(config-ephone-hunt)# display-logout
to inform hunt-group members where the calls are being
Night Service sent when all members are unavailable to take calls.
Step 19 exit Exits ephone-hunt configuration mode.
Example:
Router(config-ephone-hunt)# exit
Step 20 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
706 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 21 max-redirect number (Optional) Sets the number of times that a call can be
redirected within a Cisco Unified CME system.
Example: • number—Range is 5 to 20. Default is 10.
Router(config-telephony)# max-redirect 8
Note This command is required if the number of hops is
greater than 10.
Step 22 hunt-group logout {DND | HLog} (Optional) Specifies whether agent not-ready status applies
only to ephone hunt group extensions on a phone (HLog
mode) or to all extensions on a phone (DND mode). Agent
Example:
Router(config-telephony)# hunt-group logout
not-ready status can activated by an agent using the HLog
HLog soft key or a FAC, or it can be activated automatically after
the number of calls specified in the auto logout command
are not answered.
The default if this command is not used is DND.
• DND—When phones are placed in agent not-ready
status, all ephone-dns on the phone will not accept
calls.
• HLog—Enables the display of the HLog soft key.
When phones are placed in the agent not-ready status,
only the ephone-dns assigned to ephone hunt groups
will not accept calls.
Step 23 exit Exits telephony-service configuration mode.
Example:
Router(config-telephony)# exit
Step 24 ephone-dn dn-tag (Optional) Enters ephone-dn configuration mode.
• dn-tag—Tag number for the ephone-dn to be
Example: authorized to join and leave ephone hunt groups.
Router(config)# ephone-dn 29
Step 25 ephone-hunt login (Optional) Enables this ephone-dn to join and leave ephone
hunt groups (dynamic membership).
Example:
Router(config-ephone-dn)# ephone-hunt login
Step 26 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 707
Configuring Call-Coverage Features
How to Configure Call Coverage Features
SCCP: Verifying Ephone Hunt Groups
Step 1 Use the show running-config command to verify your configuration. Ephone hunt group parameters are
listed in the ephone-hunt portion of the output.
Router# show running-config
ephone-hunt 1 longest-idle
pilot 500
list 502, 503, *
max-timeout 30
timeout 10, 10, 10
hops 2
from-ring
fwd-final orig-phone
!
!
ephone-hunt 2 sequential
pilot 600
list 621, *, 623
final 5255348
max-timeout 10
timeout 20, 20, 20
fwd-final orig-phone
!
!
ephone-hunt 77 longest-idle
from-ring
pilot 100
list 101, *, 102
!
Step 2 To verify the configuration of ephone hunt group dynamic membership, use the show running-config
command. Look at the ephone-hunt portion of the output to ensure at least one wildcard slot is
configured. Look at the ephone-dn section to see whether particular ephone-dns are authorized to join
ephone hunt groups. Look at the telephony-service section to see whether FACs are enabled.
Router# show running-config
ephone-hunt 1 longest-idle
pilot 500
list 502, 503, *
max-timeout 30
timeout 10, 10, 10
hops 2
from-ring
fwd-final orig-phone
!
!
ephone-dn 2 dual-line
number 126
preference 1
call-forward busy 500
ephone-hunt login
!
telephony-service
fac custom alias 5 *5 to *35000
fac custom ephone-hunt cancel #5
Cisco Unified Communications Manager Express System Administrator Guide
708 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Step 3 Use the show ephone-hunt command for detailed information about hunt groups, including dial-peer
tag numbers, hunt-group agent status, and on-hook time stamps. This command also displays the
dial-peer tag numbers of all ephone-dns that have joined dynamically and are members of the group at
the time that the command is run.
Router# show ephone-hunt
Group 1
type: peer
pilot number: 450, peer-tag 20123
list of numbers:
451, aux-number A450A0900, # peers 5, logout 0, down 1
peer-tag dn-tag rna login/logout up/down
[20122 42 0 login up ]
[20121 41 0 login up ]
[20120 40 0 login up ]
[20119 30 0 login up ]
[20118 29 0 login down]
452, aux-number A450A0901, # peers 4, logout 0, down 0
peer-tag dn-tag rna login/logout up/down
[20127 45 0 login up ]
[20126 44 0 login up ]
[20125 43 0 login up ]
[20124 31 0 login up ]
453, aux-number A450A0902, # peers 4, logout 0, down 0
peer-tag dn-tag rna login/logout up/down
[20131 48 0 login up ]
[20130 47 0 login up ]
[20129 46 0 login up ]
[20128 32 0 login up ]
477, aux-number A450A0903, # peers 1, logout 0, down 0
peer-tag dn-tag rna login/logout up/down
[20132 499 0 login up ]
preference: 0
preference (sec): 7
timeout: 3, 3, 3, 3
max timeout : 10
hops: 4
next-to-pick: 1
E.164 register: yes
auto logout: no
stat collect: no
Group 2
type: sequential
pilot number: 601, peer-tag 20098
list of numbers:
123, aux-number A601A0200, # peers 1, logout 0, down 0
peer-tag dn-tag rna login/logout up/down
[20097 56 0 login up ]
622, aux-number A601A0201, # peers 3, logout 0, down 0
peer-tag dn-tag rna login/logout up/down
[20101 112 0 login up ]
[20100 111 0 login up ]
[20099 110 0 login up ]
623, aux-number A601A0202, # peers 3, logout 0, down 0
peer-tag dn-tag rna login/logout up/down
[20104 122 0 login up ]
[20103 121 0 login up ]
[20102 120 0 login up ]
*, aux-number A601A0203, # peers 1, logout 0, down 1
peer-tag dn-tag rna login/logout up/down
[20105 0 0 - down]
*, aux-number A601A0204, # peers 1, logout 0, down 1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 709
Configuring Call-Coverage Features
How to Configure Call Coverage Features
peer-tag dn-tag rna login/logout up/down
[20106 0 0 - down]
final number: 5255348
preference: 0
preference (sec): 9
timeout: 5, 5, 5, 5, 5
max timeout : 40
fwd-final: orig-phone
E.164 register: yes
auto logout: no
stat collect: no
Group 3
type: longest-idle
pilot number: 100, peer-tag 20142
list of numbers:
101, aux-number A100A9700, # peers 3, logout 0, down 3
on-hook time stamp 7616, off-hook agents=0
peer-tag dn-tag rna login/logout up/down
[20141 132 0 login down]
[20140 131 0 login down]
[20139 130 0 login down]
*, aux-number A100A9701, # peers 1, logout 0, down 1
on-hook time stamp 7616, off-hook agents=0
peer-tag dn-tag rna login/logout up/down
[20143 0 0 - down]
102, aux-number A100A9702, # peers 2, logout 0, down 2
on-hook time stamp 7616, off-hook agents=0
peer-tag dn-tag rna login/logout up/down
[20145 142 0 login down]
[20144 141 0 login down]
all agents down!
preference: 0
preference (sec): 7
timeout: 100, 100, 100
hops: 0
E.164 register: yes
auto logout: no
stat collect: no
Configuring Voice Hunt Groups
To redirect calls for a specific number (pilot number) to a defined group of directory numbers on SIP
phones, or for a parallel hunt group on SCCP phones, perform the following steps.
Prerequisites
• Cisco Unified CME 3.4 or a later version for SIP phones.
• Cisco Unified CME 4.3 or a later version is required to include a SCCP phone, FXS analog phone,
DS0-group, PRI-group, or SIP trunk in a voice hunt-group.
• Cisco Unified CME 4.3 or a later version is required for call transfer to a voice hunt-group.
• Directory numbers included in a hunt group must be configured in Cisco Unified CME. For
configuration information, see “Configuring Phones to Make Basic Calls” on page 139.
Cisco Unified Communications Manager Express System Administrator Guide
710 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Restrictions
• Before Cisco Unified CME 4.3, forwarding or transferring to a voice hunt group is not supported.
• In Cisco Unified CME 4.3 and later versions, Call Forwarding is supported to a parallel hunt-group
(blast hunt group) only.
• SIP-to-H.323 calls are not supported.
• If Call Forward All or Call Forward Busy is configured for a voice hunt-group member (directory
number), the hunt group ignores it.
• If Call Forward No Answer is configured for a voice hunt-group member, you must set the value of
the timeout command in the voice hunt group to a value that is less than the timeout value of the
call-forward noan command.
• Caller ID update is not supported for supplementary services.
• Voice hunt groups are subject to the max-redirect restriction.
• A pilot dial peer cannot be used for a voice hunt group and an ephone hunt group at the same time.
• Voice hunt groups do not support the expansion of pilot numbers using the dialplan-pattern
command. To enable external phones to dial the pilot number, you must configure a secondary pilot
number using a fully qualified E.164 number.
• If call-waiting is enabled (the default), parallel hunt groups support multiple calls up to the limit of
call-waiting calls supported by the particular SIP phone model. If call waiting is disabled, parallel
hunt groups support only one call at a time in the ringing state. Phones that fail to connect must
return to the on-hook state before they can receive other calls.
• A phone number associated with an FXO port is not supported in parallel hunt groups.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice hunt-group hunt-tag [longest-idle | parallel | peer | sequential]
4. pilot number [secondary number]
5. list dn-number, dn-number[, dn-number...]
6. final final-number
7. preference preference-order [secondary secondary-order]
8. hops number
9. timeout seconds
10. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 711
Configuring Call-Coverage Features
How to Configure Call Coverage Features
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice hunt-group hunt-tag [longest-idle | Enters voice hunt-group configuration mode to define a
parallel | peer | sequential] hunt group.
• hunt-tag—Unique sequence number of the hunt group
Example: to be configured. Range is 1 to 100.
Router(config)# voice hunt-group 1 longest-idle
• longest idle—Hunt group in which calls go to the
directory number that has been idle for the longest time.
• parallel—Hunt group in which calls simultaneously
ring multiple phones.
• peer—Hunt group in which the first directory number
is selected round-robin from the list.
• sequential—Hunt group in which directory numbers
ring in the order in which they are listed, left to right.
• To change the hunt-group type, remove the existing
hunt group first by using the no form of the command;
then, recreate the group.
Step 4 pilot number [secondary number] Defines the telephone number that callers dial to reach a
voice hunt group.
Example: • number—String of up to 16 characters that represents
Router(config-voice-hunt-group)# pilot number an E.164 telephone number.
8100
• Number string may contain alphabetic characters when
the number is to be dialed only by the
Cisco Unified CME router, as with an intercom
number, and not from telephone keypads.
• secondary number—(Optional) Keyword and
argument combination defines the number that follows
as an additional pilot number for the voice hunt group.
• Secondary numbers can contain wild cards. A wildcard
is a period (.), which matches any entered digit.
Cisco Unified Communications Manager Express System Administrator Guide
712 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 5 list directory-number, directory-number Creates a list of extensions that are members of a voice hunt
[,directory-number...] group. To remove a list from a router configuration, use the
no form of this command.
Example: • directory-numbers—List of extensions to be added as
Router(config-voice-hunt-group)# list 8000, members to the voice hunt group. Separate the
8010, 8020, 8030
extensions with commas.
• Add or delete all extensions in a hunt-group list at one
time. You cannot add or delete a single number in an
existing list.
• There must be from 2 to 10 extensions in the
hunt-group list, and each number must be a primary or
secondary number.
• Any number in the list cannot be a pilot number of a
parallel hunt group.
Step 6 final directory-number Defines the last extension in a voice hunt group.
• If a final number in one hunt group is configured as a
Example: pilot number of another hunt group, the pilot number of
Router(config-voice-hunt-group)# final 8888 the first hunt group cannot be configured as a final
number in any other hunt group.
Step 7 preference preference-order [secondary Sets the preference order for the directory number
secondary-order] associated with a voice hunt-group pilot number.
Note We recommend that the parallel hunt-group pilot
Example: number be unique in the system. Parallel hunt
Router(config-voice-hunt-group)# preference 6 groups may not work if there are more than one
partial or exact dial-peer match. For example, if the
pilot number is “8000” and there is another dial peer
that matches “8…”. If multiple matches cannot be
avoided, give parallel hunt groups the highest
priority to run by assigning a lower preference to the
other dial peers. Note that 8 is the lowest preference
value. By default, dial peers created by parallel hunt
groups have a preference of 0.
• preference-order—Range is 0 to 8, where 0 is the
highest preference and 8 is the lowest preference.
Default is 0.
• secondary secondary-order—(Optional) Keyword and
argument combination is used to set the preference
order for the secondary pilot number. Range is 1 to 8,
where 0 is the highest preference and 8 is the lowest
preference. Default is 7.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 713
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 8 hops number For configuring a peer or longest-idle voice hunt group
only. Defines the number of times that a call can hop to the
next number in a peer or longest-idle voice hunt group
Example:
Router(config-voice-hunt-group)# hops 2
before the call proceeds to the final number.
• number—Number of hops. Range is 2 to 10, and the
value must be less than or equal to the number of
extensions specified by the list command.
• Default is the same number as there are destinations
defined under the list command.
Step 9 timeout seconds Defines the number of seconds after which a call that is not
answered is redirected to the next directory number in a
voice hunt-group list.
Example:
Router(config-voice-hunt-group)# timeout 100 • Default: 180 seconds.
Step 10 end Exits to privileged EXEC mode.
Example:
Router(config-voice-hunt-group)# end
SCCP: Configuring Night Service
This procedure defines night-service hours, an optional night-service code, the ephone-dns that trigger
the notification process, and the ephones that will receive notification.
Restrictions
• Night service notification is not supported on analog endpoints connected to FXS ports on a
Cisco Integrated Services Router (ISR) or Cisco VG224 Analog Phone Gateway.
• In Cisco Unified CME 4.0 and later versions, silent ringing, configured on the phone by using the s
keyword with the button command, is suppressed when used with the night service feature. Silent
ringing is overridden and the phone audibly rings during designated night-service periods.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. night-service day day start-time stop-time
5. night-service date month date start-time stop-time
6. night-service everyday start-time stop-time
7. night-service weekday start-time stop-time
8. night-service weekend start-time stop-time
9. night-service code digit-string
10. timeouts night-service-bell seconds
Cisco Unified Communications Manager Express System Administrator Guide
714 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
11. exit
12. ephone-dn dn-tag
13. night-service bell
14. exit
15. ephone phone-tag
16. night-service bell
17. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 night-service day day start-time stop-time Defines a recurring time period associated with a day of the
week during which night service is active.
Example: • day—Day of the week abbreviation. The following are
Router(config-telephony)# night-service day mon valid day abbreviations: sun, mon, tue, wed, thu, fri,
19:00 07:00 sat.
• start-time stop-time—Beginning and ending times for
night service, in an HH:MM format using a 24-hour
clock. If the stop time is a smaller value than the start
time, the stop time occurs the day following the start
time. For example, “mon 19:00 07:00” means “from
Monday at 7 p.m. until Tuesday at 7 a.m.”
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 715
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 5 night-service date month date start-time Defines a recurring time period associated with a month and
stop-time date during which night service is active.
• month—Month abbreviation. The following are valid
Example: month abbreviations: jan, feb, mar, apr, may, jun, jul,
Router(config-telephony)# night-service date aug, sep, oct, nov, dec.
jan 1 00:00 00:00
• date—Date of the month. Range is 1 to 31.
• start-time stop-time—Beginning and ending times for
night service, in an HH:MM format using a 24-hour
clock. The stop time must be greater than the start time.
The value 24:00 is not valid. If 00:00 is entered as a
stop time, it is changed to 23:59. If 00:00 is entered for
both start time and stop time, calls are blocked for the
entire 24-hour period on the specified date.
Step 6 night-service everyday start-time stop-time Defines a recurring night-service time period to be effective
everyday.
Example: • start-time stop-time—Beginning and ending times for
Router(config-telephony)# night-service night service, in an HH:MM format using a 24-hour
everyday 1200 1300 clock. If the stop time is a smaller value than the start
time, the stop time occurs the day following the start
time. For example, “19:00 07:00” means “from 7 p.m.
to 7 a.m. the next morning.” The value 24:00 is not
valid. If 00:00 is entered as a stop time, it is changed to
23:59. If 00:00 is entered for both start time and stop
time, the night service feature will be activated for the
entire 24-hour period.
Step 7 night-service weekday start-time stop-time Defines a recurring night-service time period to be effective
on all weekdays.
Example: • start-time stop-time—Beginning and ending times for
Router(config-telephony)# night-service weekday night service, in an HH:MM format using a 24-hour
1700 0700 clock. If the stop time is a smaller value than the start
time, the stop time occurs the day following the start
time. For example, “19:00 07:00” means “from 7 p.m.
to 7 a.m. the next morning.” The value 24:00 is not
valid. If 00:00 is entered as a stop time, it is changed to
23:59. If 00:00 is entered for both start time and stop
time, the night service feature will be activated for the
entire 24-hour period.
Cisco Unified Communications Manager Express System Administrator Guide
716 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 8 night-service weekend start-time stop-time Defines a recurring night-service time period to be effective
on all weekend days (Saturday and Sunday).
Example: • start-time stop-time—Beginning and ending times for
Router(config-telephony)# night-service weekend night service, in an HH:MM format using a 24-hour
00:00 00:00 clock. If the stop time is a smaller value than the start
time, the stop time occurs the day following the start
time. For example, “19:00 07:00” means “from 7 p.m.
to 7 a.m. the next morning.” The value 24:00 is not
valid. If 00:00 is entered as a stop time, it is changed to
23:59. If 00:00 is entered for both start time and stop
time, the night service feature will be activated for the
entire 24-hour period.
Step 9 night-service code digit-string Designates a code that can be dialed from any night-service
line (ephone-dn) to toggle night service on and off for all
lines assigned to night service in the system.
Example:
Router(config-telephony)# night-service code • digit-string—String of up to 16 keypad digits. The code
*6483 must begin with an asterisk (*).
Step 10 timeouts night-service-bell seconds Defines the frequency of the night-service notification.
• seconds—Range: 4 to 30. Default: 12.
Example:
Router(config-telephony)# timeouts
night-service-bell 15
Step 11 exit Exits telephony-service configuration mode.
Example:
Router(config-telephony)# exit
Step 12 ephone-dn dn-tag Enters ephone-dn configuration mode to define an
ephone-dn to receive night-service treatment.
Example:
Router(config)# ephone-dn 55
Step 13 night-service bell Marks this ephone-dn for night-service treatment.
Example:
Router(config-ephone-dn)# night-service bell
Step 14 exit Exits ephone-dn configuration mode.
Example:
Router(config-ephone-dn)# exit
Step 15 ephone phone-tag Enters ephone configuration mode.
• phone-tag—The unique sequence number of the phone
Example: that will be notified when an incoming call is received
Router(config)# ephone 12 by a night-service ephone-dn during a night-service
period.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 717
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 16 night-service bell Marks this phone to receive night-service bell notification
when incoming calls are received on ephone-dns marked for
night service during the night-service time period.
Example:
Router(config-ephone)# night-service bell • Night service notification is not supported on analog
endpoints connected to SCCP FXS ports on a Cisco ISR
or Cisco VG224.
Step 17 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
SCCP: Verifying Night Service
Step 1 Use the show running-config command to verify the night-service parameters, which are listed in the
telephony-service portion of the output, or use the show telephony-service command to display the
same parameters.
Router# show running-config
telephony-service
fxo hook-flash
load 7910 P00403020214
load 7960-7940 P00303020214
max-ephones 48
max-dn 288
ip source-address 10.50.50.1 port 2000
application segway0
caller-id block code *321
create cnf-files version-stamp 7960 Mar 07 2003 11:19:18
voicemail 79000
max-conferences 8
call-forward pattern .....
moh minuet.wav
date-format yy-mm-dd
transfer-system full-consult
transfer-pattern .....
secondary-dialtone 9
night-service code *1234
night-service day Tue 00:00 23:00
night-service day Wed 01:00 23:59
!
!
Router# show telephony-service
CONFIG (Version=4.0(0))
=====================
Version 4.0(0)
Cisco Unified CallManager Express
For on-line documentation please see:
www.cisco.com/en/US/products/sw/voicesw/tsd_products_support_category_home.html
ip source-address 10.103.3.201 port 2000
load 7910 P00403020214
load 7961 TERM41.7-0-1-1
load 7961GE TERM41.7-0-1-1
Cisco Unified Communications Manager Express System Administrator Guide
718 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
load 7960-7940 P00307020300
max-ephones 100
max-dn 500
max-conferences 8 gain -6
dspfarm units 2
dspfarm transcode sessions 4
dspfarm 1 MTP00059a3d7441
dspfarm 2
hunt-group report delay 1 hours
Number of hunt-group configured: 14
hunt-group logout DND
max-redirect 20
voicemail 7189
cnf-file location: system:
cnf-file option: PER-PHONE-TYPE
network-locale[0] US (This is the default network locale for this box)
user-locale[0] US (This is the default user locale for this box)
moh flash:music-on-hold.au
time-format 12
date-format mm-dd-yy
timezone 0 Greenwich Standard Time
secondary-dialtone 9
call-forward pattern .T
transfer-pattern 92......
transfer-pattern 91..........
transfer-pattern .T
after-hours block pattern 1 91900 7-24
after-hours block pattern 2 9976 7-24
after-hours block pattern 4 91...976.... 7-24
night-service date Jan 1 00:00 23:59
night-service day Mon 17:00 07:00
night-service day Wed 17:00 07:00
keepalive 30
timeout interdigit 10
timeout busy 10
timeout ringing 100
caller-id name-only: enable
system message XYZ Company
web admin system name xyz password xxxx
web admin customer name Customer
edit DN through Web: enabled.
edit TIME through web: enabled.
Log (table parameters):
max-size: 150
retain-timer: 15
create cnf-files version-stamp Jan 01 2002 00:00:00
transfer-system full-consult
multicast moh 239.10.10.1 port 2000
fxo hook-flash
local directory service: enabled.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 719
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Step 2 Use the show running-config command to verify that the correct ephone-dns and ephones are
configured with the night-service bell command. You can also use the show telephony-service
ephone-dn and show telephony-service ephone commands to display these parameters.
Router# show running-config
ephone-dn 24 dual-line
number 2548
description FrontDesk
night-service bell
ephone 1
mac-address 110F.80C0.FE0B
type 7960 addon 1 7914
no dnd feature-ring
keep-conference
button 1f40 2f41 3f42 4:30
button 7m20 8m21 9m22 10m23
button 11m24 12m25 13m26
night-service bell
SCCP: Configuring Overlaid Ephone-dns
To create ephone-dns, then assign multiple ephone-dns to a single phone button by using the o or c
keyword with the button command, perform the following steps.
Restrictions
• Call waiting is disabled when you configure ephone-dn overlays using the o keyword with the
button command. To enable call waiting, you must configure ephone-dn overlays using the
c keyword with the button command.
• Rollover of overlay calls to another phone button by using the x keyword with the button command
only works to expand coverage if the overlay button is configured with the o keyword in the button
command. Overlay buttons with call waiting that use the c keyword in the button command are not
eligible for overlay rollover.
• In Cisco Unified CME 4.0(3), the Cisco Unified IP Phone 7931G cannot support overlays that
contain ephone-dn configured for dual-line mode.
• The primary ephone-dn on each phone in a shared-line overlay set should be an ephone-dn that is
unique to the phone to guarantee that the phone will have a line available for outgoing calls, and to
ensure that the phone user can obtain dial-tone even when there are no idle lines available in the rest
of the shared-line overlay set. Use a unique ephone-dn in this manner to provide for a unique calling
party identity on outbound calls made by the phone so that the called user can see which specific
phone is calling.
• Octo-line directory numbers are not supported in button overlay sets.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
720 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
3. ephone-dn dn-tag [dual-line]
4. number number
5. preference preference-value
6. huntstop
or
no huntstop
7. huntstop channel
8. call-forward noan
9. call-forward busy
10. exit
11. ephone phone-tag
12. mac-address mac-address
13. button button-number{o | c}dn-tag,dn-tag[,dn-tag...] button-number{x}overlay-button-number
14. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn phone-tag [dual-line] Enters ephone-dn configuration mode to create an extension
(ephone-dn) for a Cisco Unified IP phone line.
Example: • For shared-line overlay set: Primary ephone-dn on a
Router(config)# ephone-dn 10 dual-line phone should be an ephone-dn that is unique to the
phone.
Step 4 number number Associates a telephone or extension number with the
ephone-dn.
Example:
Router(config-ephone-dn)# number 1001
Step 5 preference preference-order Sets dial-peer preference order for an ephone-dn.
• preference-order—Preference order for the primary
Example: number associated with an extension (ephone-dn).
Router(config-ephone-dn)# preference 1 Type ? for a range of numeric options, where 0 is the
highest preference. Default: 0.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 721
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 6 no huntstop Explicitly enables call hunting behavior for a directory
or number.
huntstop • Set this command on all ephone-dns in the overlay set
except the final instance.
Example: • Required to allow call hunting allow call hunting across
Router(config-ephone-dn)# no huntstop multiple numbers on the same line button on an IP
or phone.
or
Example:
Router(config-ephone-dn)# huntstop
Disables call hunting behavior for a directory number.
• Set this command on the last ephone-dn within a
overlay set.
• Required to limit the call hunting to an overlay set.
Step 7 huntstop channel Only for dual-line ephone-dns in overlay set; keeps
incoming calls from hunting to the second channel if the
first channel is busy or does not answer.
Example:
Router(config-ephone-dn)# huntstop channel • Reserves the second channel for outgoing calls, such as
a consultation call to be placed during a call transfer
attempt, or for conferencing
Step 8 call-forward noan (Optional) Forwards incoming unanswered call to next line
in the overlay set.
Example: • Set this command on all ephone-dns in the overlay set.
Router(config-ephone-dn)# call-forward noan
Step 9 call-forward busy (Optional) Forwards incoming call if line is busy.
• Set this command on the last ephone-dn in the overlay
Example: set only.
Router(config-ephone-dn)# call-forward busy
Step 10 exit Exits ephone-dn configuration mode
Example:
Router(config-ephone-dn)# exit
Step 11 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies
Example: the phone to which you are adding an overlay set.
Router(config)# ephone 4
Step 12 mac-address mac-address Specifies the MAC address of the registering phone.
Example:
Router(config-ephone)# mac-address
1234.5678.abcd
Cisco Unified Communications Manager Express System Administrator Guide
722 OL-10663-02
Configuring Call-Coverage Features
How to Configure Call Coverage Features
Command or Action Purpose
Step 13 button Creates a set of ephone-dns overlaid on a single button.
button-number{o | c}dn-tag,dn-tag[,dn-tag...]
button-number{x}overlay-button-number • o—Overlay button. Multiple ephone-dns share this
button. A maximum of 25 ephone-dns can be specified
for a single button, separated by commas.
Example:
Router(config-ephone)# button 1o15,16,17,18,19 • c—Overlay button with call-waiting. Multiple
2c20,21,22 3x1 4x1 ephone-dns share this button. A maximum of
25 ephone-dns can be specified for a single button,
separated by commas.
• x—Separator that creates a rollover button for an
overlay button that was defined using the o keyword.
When the overlay button specified in this command is
occupied by an active call, a second call to one of its
ephone-dns will be presented on this button.
• dn-tag—Unique identifier previously defined with the
ephone-dn command for the ephone-dn to be added to
this overlay set.
• overlay-button-number—Number of the overlay button
that should overflow to this button. Note that the button
must have been defined using the o keyword and not the
c keyword.
Note For other keywords, see the button command in the
Cisco Unified Communications Manager Express
Command Reference.
Step 14 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
SCCP: Verifying Overlaid Ephone-dns
Step 1 Use the show running-config command or the show telephony-service ephone command to view
button assignments.
Router# show running-config
ephone 5
description Cashier1
mac-address 0117.FBC6.1985
type 7960
button 1o4,5,6,200,201,202,203,204,205,206 2x1 3x1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 723
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
Step 2 Use the show ephone overlay command to display the configuration and current status of registered
overlay ephone-dns.
Router# show ephone overlay
ephone-1 Mac:0007.0EA6.353A TCP socket:[1] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0
IP:10.2.225.205 52486 Telecaster 7960 keepalive 2771 max_line 6
button 1: dn 11 number 60011 CH1 IDLE overlay
button 2: dn 17 number 60017 CH1 IDLE overlay
button 3: dn 24 number 60024 CH1 IDLE overlay
button 4: dn 30 number 60030 CH1 IDLE overlay
button 5: dn 36 number 60036 CH1 IDLE CH2 IDLE overlay
button 6: dn 39 number 60039 CH1 IDLE CH2 IDLE overlay
overlay 1: 11(60011) 12(60012) 13(60013) 14(60014) 15(60015) 16(60016)
overlay 2: 17(60017) 18(60018) 19(60019) 20(60020) 21(60021) 22(60022)
overlay 3: 23(60023) 24(60024) 25(60025) 26(60026) 27(60027) 28(60028)
overlay 4: 29(60029) 30(60030) 31(60031) 32(60032) 33(60033) 34(60034)
overlay 5: 35(60035) 36(60036) 37(60037)
overlay 6: 38(60038) 39(60039) 40(60040)
Step 3 Use the show dialplan number command to display all the number resolutions of a particular phone
number, which allows you to detect whether calls are going to unexpected destinations. This command
is useful for troubleshooting cases in which you dial a number but the expected phone does not ring.
Configuration Examples for Call Coverage Features
This section contains the following configuration examples:
• Call Hunt: Examples, page 724
• Call Pickup: Examples, page 726
• Call-Waiting Beep: Example, page 727
• Call-Waiting Ring: Example, page 727
• Hunt Group: Examples, page 727
• Night Service: Examples, page 731
• Overlaid Ephone-dns Examples, page 732
Call Hunt: Examples
This section contains the following examples:
• Ephone-dn Dial-Peer Preference: Example, page 725
• Huntstop Disabled: Example, page 725
• Channel Huntstop: Example, page 726
• SIP Call Hunt: Example, page 726
Cisco Unified Communications Manager Express System Administrator Guide
724 OL-10663-02
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
Ephone-dn Dial-Peer Preference: Example
The following example sets a preference number of 2 for the primary number of ephone-dn 3:
ephone-dn 3
number 3001
preference 2
Huntstop Disabled: Example
The following example shows an instance in which huntstop is not desired and is explicitly disabled. In
this example, ephone 4 is configured with two lines, each with the same extension number 5001. This is
done to allow the second line to provide call waiting notification for extension number 5001 when the
first line is in use. Setting no huntstop on the first line (ephone-dn 1) allows incoming calls to hunt to
the second line (ephone-dn 2) on the same phone when the ephone-dn 1 line is busy.
Ephone-dn 2 has call forwarding set to extension 6000, which corresponds to a locally attached
answering machine connected to a foreign exchange station (FXS) voice port. The plain old telephone
service (POTS) dial peer for extension 6000 also has the dial-peer huntstop attribute explicitly set to
prevent further hunting.
ephone-dn 1
number 5001
no huntstop
preference 1
call-forward noan 6000
ephone-dn 2
number 5001
preference 2
call-forward busy 6000
call-forward noan 6000
ephone 4
button 1:1 2:2
mac-address 0030.94c3.8724
dial-peer voice 6000 pots
destination-pattern 6000
huntstop port 1/0/0
description answering-machine
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 725
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
Channel Huntstop: Example
The following is an example that uses the huntstop channel command. It shows a dual-line ephone-dn
configuration in which calls do not hunt to the second channel of any ephone-dn, but they do hunt
through each ephone-dn’s channel 1 in this order: ephone-dn 10, ephone-dn 11, ephone-dn 12.
ephone-dn 10 dual-line
number 1001
no huntstop
huntstop channel
ephone-dn 11 dual-line
number 1001
no huntstop
huntstop channel
preference 1
ephone-dn 12 dual-line
number 1001
no huntstop
huntstop channel
preference 2
SIP Call Hunt: Example
The following example shows a typical configuration in which huntstop is required. The huntstop
command is enabled and prevents calls to extension 5001 from being rerouted to the on-net H.323 dial
peer for 5... when extension 5001 is busy (three periods are used as wild cards).
voice register dn 1
number 5001
huntstop
voice register pool 4
number 1 dn 1
id-mac 0030.94c3.8724
dial-peer voice 5000 voip
destination-pattern 5...
session target ipv4:192.168.17.225
session protocol sipv2
Call Pickup: Examples
The following example assigns the line that has an ephone-dn tag of 55 to pickup group 2345:
ephone-dn 55
number 2555
pickup-group 2345
The following example globally disables directed call pickup and changes the action of the PickUp soft
key to perform local group call pickup rather than directed call pickup.
telephony-service
no service directed-pickup
Cisco Unified Communications Manager Express System Administrator Guide
726 OL-10663-02
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
Call-Waiting Beep: Example
In the following example, ephone-dn 10 neither accepts nor generates a beep, ephone-dn 11 does not
accept a beep, and ephone-dn 12 does not generate a beep.
ephone-dn 10
no call-waiting beep
number 4410
ephone-dn 11
no call-waiting beep accept
number 4411
ephone-dn 12
no call-waiting beep generate
number 4412
Call-Waiting Ring: Example
The following example specifies that a short ring will indicate a call is waiting for extension 5533.
ephone-dn 20
number 5533
call-waiting ring
Hunt Group: Examples
This section contains the following examples:
• Sequential Ephone Hunt Group: Example, page 727
• Peer Ephone Hunt Group: Example, page 728
• Longest-Idle Ephone Hunt Group: Example, page 728
• Longest-Idle Ephone Hunt Group Using From-Ring Option: Example, page 728
• Sequential Hunt Group: Example, page 728
• Logout Display: Example, page 729
• Dynamic Membership: Example, page 730
• Agent Status Control: Example, page 730
• Automatic Agent Not-Ready: Example, page 731
Sequential Ephone Hunt Group: Example
The following example defines a sequential ephone hunt group with the pilot number 5600 and the final
number 6000, with three numbers in the list of phones that answer for the pilot number.
ephone-hunt 2 sequential
pilot 5600
list 5621, *, 5623
final 6000
max-timeout 10
timeout 20, 20, 20
fwd-final orig-phone
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 727
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
Peer Ephone Hunt Group: Example
The following example defines peer ephone hunt group 10 with a pilot number 450, a final number 500,
and four numbers in the list. After a call is redirected four times (makes four hops), it is redirected to the
final number.
ephone-hunt 10 peer
pilot 450
list 451, 452, 453, 477
final 500
max-timeout 10
timeout 3, 3, 3, 3
Longest-Idle Ephone Hunt Group: Example
The following example defines longest-idle ephone hunt group 1 with a pilot number 7501 and 11
numbers in the list. After a call is redirected five times, it is redirected to the final number.
ephone-hunt 1 longest-idle
pilot 7501
list 7001, 7002, 7023, 7028, 7045, 7062, 7067, 7072, 7079, 7085, 7099
final 8000
preference 1
hops 5
timeout 20
no-reg
Longest-Idle Ephone Hunt Group Using From-Ring Option: Example
The following example defines longest-idle ephone hunt group 1 with a pilot number 7501, a final
number 8000, and 11 numbers in the list. Because the from-ring command is used, on-hook time stamps
will be recorded when calls ring extensions and when calls are answered. After a call is redirected six
times (makes six hops), it is redirected to the final number, 8000. The max-redirect command is used
to increase the number of redirects that are allowed because the number of hops (six) is larger than the
default number of redirects that are allowed in the system (five).
ephone-hunt 1 longest-idle
pilot 7501
list 7001, 7002, 7023, 7028, 7045, 7062, 7067, 7072, 7079, 7085, 7099
final 8000
from-ring
preference 1
hops 6
timeout 20
telephony-service
max-redirect 8
Sequential Hunt Group: Example
In the following parallel hunt-group example, when callers dial extension 1000, extension 1001, 1002,
1003, and 1004 ring simultaneously. The first extension to answer is connected. If none of the extensions
answers within 60 seconds, the call is forwarded to extension 2000, which is the number for voice mail.
voice hunt-group 4 parallel
final 2000
list 1001,1002,1003,1004
timeout 60
pilot 1000
Cisco Unified Communications Manager Express System Administrator Guide
728 OL-10663-02
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
preference 1 secondary 9
!
!
ephone-dn 1 octo-line
number 1001
!
ephone-dn 2
number 1002
!
ephone-dn 3 dual-line
number 1003
!
ephone-dn 4
number 1004
!
!
ephone 1
max-calls-per-button 4
mac-address 02EA.EAEA.0001
button 1:1
!
!
ephone 2
mac-address 001C.821C.ED23
button 1:2
!
!
ephone 3
mac-address 002D.264E.54FA
button 1:3
!
!
ephone 4
mac-address 0030.94C3.053E
button 1:4
Logout Display: Example
In the following example, the description is set to “Marketing Hunt Group.” This information will be
shown in the configuration output and also on the display of IP phones that are receiving calls from this
hunt group. The display-logout message is set to “Night Service,” which will be displayed on IP phones
that are members of the hunt group when all the members are logged out.
ephone-hunt 17 sequential
pilot 3000
list 3011, 3021, 3031
timeout 10
final 7600
description Marketing Hunt Group
display-logout Night Service
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 729
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
Dynamic Membership: Example
The following example creates four ephone-dns and a hunt group that includes the first ephone-dn and
two wildcard slots. The last three ephone-dns are enabled for group hunt dynamic membership. Each of
them can join and leave the hunt group whenever one of the wildcard slots is available. Standard FACs
have been enabled, and the agents use standard FACs to join (*3) and leave (#3) the hunt group. You
can also use the fac command to create custom FACs for these actions if you prefer.
ephone-dn 22
number 4566
ephone-dn 24
number 4568
ephone-hunt login
ephone-dn 25
number 4569
ephone-hunt login
ephone-dn 26
number 4570
ephone-hunt login
ephone-hunt 1 peer
list 4566,*,*
timeout 10
final 7777
telephony-service
fac standard
Agent Status Control: Example
The following example sets up a peer ephone hunt group. It also establishes the appearance and order of
soft keys for phones that are configured with ephone-template 7. These phones will have the HLog key
available when they are idle, when they have seized a line, or when they are connected to a call. Phones
without soft keys can use the standard HLog codes to toggle ready and not-ready status.
ephone-hunt 10 peer
pilot 450
list 451, 452, 453, 477
final 500
timeout 45
telephony-service
hunt-group logout HLog
fac standard
ephone-template 7
softkeys connected Endcall Hold Transfer HLog
softkeys idle Newcall Redial Pickup Cfwdall HLog
softkeys seized Endcall Redial Pickup Cfwdall HLog
Cisco Unified Communications Manager Express System Administrator Guide
730 OL-10663-02
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
Automatic Agent Not-Ready: Example
The following example enables automatic status change to not-ready after one unanswered hunt group
call (the default) for both dynamic and static hunt group members (the default). It also specifies that the
phones which are automatically put into the not-ready status should only be blocked from further
hunt-group calls and that they should be able to receive calls that directly dial their extensions.
ephone-hunt 3 peer
pilot 4200
list 1001, 1002, 1003
timeout 10
auto logout
final 4500
telephony-service
hunt-group logout HLog
The following example enables automatic status change to not-ready after two unanswered hunt group
calls for any ephone-dn that dynamically logs in to the hunt group using the wildcard slot in the hunt
group list. Phones that are automatically placed in the not-ready status when they do not answer two
hunt-group calls are also placed into DND status (they will also not accept directly dialed calls).
ephone-hunt 3 peer
pilot 4200
list 1001, 1002, *
timeout 10
auto logout 2 dynamic
final 4500
telephony-service
hunt-group logout DND
Night Service: Examples
The following example provides night service before 8 a.m. and after 5 p.m. Monday through Friday,
before 8 a.m. and after 1 p.m. on Saturday, and all day Sunday. Extension 1000 is designated as a
night-service extension. Incoming calls to extension 1000 during the night-service period ring on
extension 1000 and provide night-service notification to phones that are designated as night-service
phones. In this example, the night-service phones are ephone 14 and ephone 15. The night-service
notification consists of a single ring on the phone and a display of “Night Service 1000.” A night-service
toggle code has been configured, *6483 (*NITE), by which a phone user can activate or deactivate
night-service conditions during the hours of night service.
telephony-service
night-service day mon 17:00 08:00
night-service day tue 17:00 08:00
night-service day wed 17:00 08:00
night-service day thu 17:00 08:00
night-service day fri 17:00 08:00
night-service day sat 13:00 12:00
night-service day sun 12:00 08:00
night-service code *6483
!
ephone-dn 1
number 1000
night-service bell
!
ephone-dn 2
number 1001
night-service bell
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 731
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
!
ephone-dn 10
number 2222
!
ephone-dn 11
number 3333
!
ephone 5
mac-address 1111.2222.0001
button 1:1 2:2
!
ephone 14
mac-address 1111.2222.0002
button 1:10
night-service bell
!
ephone 15
mac-address 1111.2222.0003
button 1:11
night-service bell
Overlaid Ephone-dns Examples
This section contains the following examples:
• Overlaid Ephone-dn: Example, page 732
• Overlaid Dual-Line Ephone-dn: Example, page 733
• Shared-line Overlaid Ephone-dns: Example, page 734
• Overlaid Ephone-dn with Call Waiting: Example, page 734
• Overlaid Ephone-dns with Rollover Buttons: Example, page 735
• Called Directory Name Display for Overlaid Ephone-dns: Example, page 736
• Called Ephone-dn Name Display for Overlaid Ephone-dns: Example, page 737
Overlaid Ephone-dn: Example
The following example creates three lines (ephone-dns) that are shared across three IP phones to handle
three simultaneous calls to the same telephone number. Three instances of a shared line with the
extension number 1001 are overlaid onto a single button on each of three phones. A typical call flow is
as follows. The first call goes to ephone 1 (highest preference) and rings button 1 on all three phones
(huntstop is off). The call is answered on ephone 1. A second call to extension 1001 hunts onto
ephone-dn 2 and rings on the two remaining ephones, 11 and 12. The second call is answered by
ephone 12. A third simultaneous call to extension 1001 hunts onto ephone-dn 3 and rings on ephone 11,
where it is answered. Note that the no huntstop command is used to allow hunting for the first two
ephone-dns, and the huntstop command is used on the final ephone-dn to stop call-hunting behavior.
The preference command is used to create different selection preferences for each ephone-dn.
ephone-dn 1
number 1001
no huntstop
preference 0
ephone-dn 2
number 1001
no huntstop
preference 1
Cisco Unified Communications Manager Express System Administrator Guide
732 OL-10663-02
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
ephone-dn 3
number 1001
huntstop
preference 2
ephone 10
button 1o1,2,3
ephone 11
button 1o1,2,3
ephone 12
button 1o1,2,3
Overlaid Dual-Line Ephone-dn: Example
The following example shows how to overlay dual-line ephone-dns. In addition to using the huntstop
and preference commands, you must use the huntstop channel command to prevent calls from hunting
to the second channel of an ephone-dn. This example overlays five ephone-dns on button 1 on five
different ephones. This allows five separate calls to the same number to be connected simultaneously,
while occupying only one button on each phone.
ephone-dn 10 dual-line
number 1001
no huntstop
huntstop channel
preference 0
ephone-dn 11 dual-line
number 1001
no huntstop
huntstop channel
preference 1
ephone-dn 12 dual-line
number 1001
no huntstop
huntstop channel
preference 2
ephone-dn 13 dual-line
number 1001
preference 3
no huntstop
huntstop channel
ephone-dn 14 dual-line
number 1001
preference 4
huntstop
huntstop channel
ephone 33
mac 00e4.5377.2a33
button 1o10,11,12,13,14
ephone 34
mac 9c33.0033.4d34
button 1o10,11,12,13,14
ephone 35
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 733
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
mac 1100.8c11.3865
button 1o10,11,12,13,14
ephone 36
mac 0111.9c87.3586
button 1o10,11,12,13,14
ephone 37
mac 01a4.8222.3911
button 1o10,11,12,13,14
Shared-line Overlaid Ephone-dns: Example
The following is an example of a unique ephone-dn as the primary dn in a simple shared-line overlay
configuration. The no huntstop command is configured for all the ephone-dns except ephone-dn 12, the
last one in the overlay set. Because the ephone-dns are dual-line dns, the huntstop-channel command
is also configured to ensure that the second channel remains free for outgoing calls and for conferencing.
ephone-dn 1 dual-line
number 101
huntstop-channel
!
ephone-dn 2 dual-line
number 102
huntstop-channel
!
ephone-dn 10 dual-line
number 201
no huntstop
huntstop-channel
!
ephone-dn 11 dual-line
number 201
no huntstop
huntstop-channel
!
ephone-dn 12 dual-line
number 201
huntstop-channel
!
!The following ephone configuration includes (unique) ephone-dn 1 as the primary line in a
shared-line overlay
ephone 1
mac-address 1111.1111.1111
button 1o1,10,11,12
!
!The next ephone configuration includes (unique) ephone-dn 2 as the primary line in
another shared-line overlay
!
ephone 2
mac-address 2222.2222.2222
button 1o2,10,11,12
Overlaid Ephone-dn with Call Waiting: Example
In following example, button 1 on ephone 1 though ephone 3 uses the same set of overlaid ephone-dns
with call waiting that share the number 1111. The button also accept calls to each ephone’s unique
(nonshared) ephone-dn number. Note that if ephone-dn 10 and ephone-dn 11 are busy, the call will go
to ephone-dn 12. If ephone-dn 12 is busy, the call will go to voice mail.
Cisco Unified Communications Manager Express System Administrator Guide
734 OL-10663-02
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
ephone-dn 1 dual-line
number 1001
ephone-dn 2 dual-line
number 1001
ephone-dn 3 dual-line
number 1001
ephone-dn 10 dual-line
number 1111
no huntstop
huntstop channel
call-forward noan 7000 timeout 30
ephone-dn 11 dual-line
number 1111
preference 1
no huntstop
huntstop channel
call-forward noan 7000 timeout 30
ephone-dn 12 dual-line
number 1111
preference 2
huntstop channel
call-forward noan 7000 timeout 30
call-forward busy 7000
ephone 1
button 1c1,10,11,12
ephone 2
button 1c2,10,11,12
ephone 3
button 1c3,10,11,12
Overlaid Ephone-dns with Rollover Buttons: Example
The following example configures a “3x3” shared-line setup for three ephones and nine shared lines
(ephone-dns 20 to 28). Each ephone has a unique ephone-dn for each of its three buttons (ephone-dns
11 to 13 on ephone 1, ephone-dns 14 to 16 on ephone 2, and ephone-dns 17 to 19 on ephone 3). The rest
of the ephone-dns are shared among the three phones. Three phones with three buttons each can take
nine calls. The overflow buttons provide the ability for an incoming call to ring on the first available
button on each phone.
ephone-dn 11
number 2011
ephone-dn 12
number 2012
ephone-dn 13
number 2013
ephone-dn 14
number 2014
.
.
.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 735
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
ephone-dn 28
number 2028
ephone 1
button 1o11,12,13,20,21,22,23,24,25,26,27,28 2x1 3x1
ephone 2
button 1o14,15,16,20,21,22,23,24,25,26,27,28 2x1 3x1
ephone 3
button 1o17,18,19,20,21,22,23,24,25,26,27,28 2x1 3x1
Called Directory Name Display for Overlaid Ephone-dns: Example
The following example demonstrates the display of a directory name for a called ephone-dn that is part
of an overlaid ephone-dn set. For configuration information, see “Configuring Directory Services” on
page 805.
This configuration of overlaid ephone-dns uses wildcards in the secondary numbers for the ephone-dns.
Wildcards allow you to control the display according to the number that was dialed. The example is for
a medical answering service with three IP phones that accept calls for nine doctors on one button. When
a call to 5550101 rings on button 1 on phone 1 to phone 3, “doctor1” is displayed on all three phones.
telephony-service
service dnis dir-lookup
directory entry 1 5550101 name doctor1
directory entry 2 5550102 name doctor2
directory entry 3 5550103 name doctor3
directory entry 4 5550110 name doctor4
directory entry 5 5550111 name doctor5
directory entry 6 5550112 name doctor6
directory entry 7 5550120 name doctor7
directory entry 8 5550121 name doctor8
directory entry 9 5550122 name doctor9
ephone-dn 1
number 5500 secondary 555000.
ephone-dn 2
number 5501 secondary 555001.
ephone-dn 3
number 5502 secondary 555002.
ephone 1
button 1o1,2,3
mac-address 1111.1111.1111
ephone 2
button 1o1,2,3
mac-address 2222.2222.2222
ephone 3
button 1o1,2,3
mac-address 3333.3333.3333
Cisco Unified Communications Manager Express System Administrator Guide
736 OL-10663-02
Configuring Call-Coverage Features
Configuration Examples for Call Coverage Features
The following example shows a hunt-group configuration for a medical answering service with two
phones and four doctors. Each phone has two buttons, and each button is assigned two doctors’ numbers.
When a patient calls 5550341, Cisco Unified CME matches the hunt-group pilot secondary number
(555....), rings button 1 on one of the two phones, and displays “doctor1.” For more information about
hunt-group behavior, see the “Hunt Groups” section on page 669. Note that wildcards are used only in
secondary numbers and cannot be used with primary numbers.
telephony-service
service dnis dir-lookup
max-redirect 20
directory entry 1 5550341 name doctor1
directory entry 2 5550772 name doctor1
directory entry 3 5550263 name doctor3
directory entry 4 5550150 name doctor4
ephone-dn 1
number 1001
ephone-dn 2
number 1002
ephone-dn 3
number 1003
ephone-dn 4
number 104
ephone 1
button 1o1,2
button 2o3,4
mac-address 1111.1111.1111
ephone 2
button 1o1,2
button 2o3,4
mac-address 2222.2222.2222
ephone-hunt 1 peer
pilot 5100 secondary 555....
list 1001, 1002, 1003, 1004
final number 5556000
hops 5
preference 1
timeout 20
no-reg
Called Ephone-dn Name Display for Overlaid Ephone-dns: Example
The following example demonstrates the display of the name assigned to the called ephone-dn using the
name command. For information about configuring this feature, see “Configuring Directory Services”
on page 805.
In this example, three phones have button 1 assigned to pick up three shared 800 numbers for three
different catalogs.
The default display for the phones is the number of the first ephone-dn listed in the overlay set
(18005550100). A call is made to the first ephone-dn (18005550100), and the caller ID (for example,
4085550123) is visible on all phones. The user for phone 1 answers the call. The caller ID (4085550123)
remains visible on phone 1, and the displays on phone 2 and phone 3 return to the default display
(18005550100). A call to the second ephone-dn (18005550101) is made. The default display on phone
2 and phone 3 is replaced with the called ephone-dn's name (catalog1) and number (18005550101).
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 737
Configuring Call-Coverage Features
Where to Go Next
telephony-service
service dnis overlay
ephone-dn 1
number 18005550100
ephone-dn 2
name catalog1
number 18005550101
ephone-dn 3
name catalog2
number 18005550102
ephone-dn 4
name catalog3
number 18005550103
ephone 1
button 1o1,2,3,4
ephone 2
button 1o1,2,3,4
ephone 3
button 1o1,2,3,4
Where to Go Next
Dial-Peer Call Hunt and Hunt Groups
Dial peers other than ephone-dn dial peers can be directly configured as hunt groups or rotary groups,
in which multiple dial peers can match incoming calls. (These are not the same as Cisco Unified CME
ephone hunt groups.) For more information, see the “Hunt Groups” section of the “Dial Peers Features
and Configuration” chapter of Dial Peer Configuration on Voice Gateway Routers.
Called-Name Display
This feature allows you to specify that the name of the called party, rather than the number, should be
displayed for incoming calls. This feature is very helpful for agents answering calls for multiple
ephone-dns that appear on a single line button in an ephone-dn overlay set. For more information, see
“Configuring Directory Services” on page 805.
Soft Key Control
If the hunt-group logout command is used with the HLog keyword, the HLog soft key appears on
phones during the idle, connected, and seized call states. The HLog soft key is used to toggle an agent
from the ready to not-ready status or from the not-ready to ready status. To move or remove the HLog
soft key on one or more phones, create and apply an ephone template that contains the appropriate
softkeys commands.
For more information, see “Customizing Soft Keys” on page 1047.
Feature Access Codes (FACs)
Dynamic membership allows agents at authorized ephones to join or leave a hunt group using a feature
access code (FAC) after standard or custom FACs are enabled.
Cisco Unified Communications Manager Express System Administrator Guide
738 OL-10663-02
Configuring Call-Coverage Features
Where to Go Next
In Cisco Unified CME 4.0 and later versions, you can activate call pickup using a feature access code
(FAC) instead of a soft key when standard or custom FACs have been enabled for your system. The
following are the standard FACs for call pickup:
• Pickup group—Dial the FAC and a pickup group number to pick up a ringing call in a different
pickup group than yours. Standard FAC is **4.
• Pickup local—Dial the FAC to pick up a ringing call in your pickup group. Standard FAC is **3.
• Pickup direct—Dial the FAC and the extension number to pick up a ringing call at any extension.
Standard FAC is **5.
For more information about FACs, see “Configuring Feature Access Codes” on page 893.
Controlling Use of the Pickup Soft Keys
To block the functioning of the group pickup (GPickUp) or local pickup (Pickup) soft key without
removing the key display, create and apply an ephone template that contains the features blocked
command. For more information, see Configuring Call Blocking, page 519.
To remove the group pickup (GPickUp) or local pickup (Pickup) soft key from one or more phones,
create and apply an ephone template that contains the appropriate softkeys command. For more
information, see “Customizing Soft Keys” on page 1047.
Ephone-dn Templates
The ephone-hunt login command authorizes an ephone-dn to dynamically join and leave an ephone
hunt group. It can be included in an ephone-dn template that is applied to one or more individual
ephone-dns. For more information, see “Creating Templates” on page 1129.
Ephone Hunt Group Statistics Reports
Several different types of statistics can help you track whether your current ephone hunt groups are
meeting your call-coverage needs. These statistics can be displayed on-screen or written to files.
For more information, see the “Cisco Unified CME Basic Automatic Call Distribution and
Auto-Attendant Service” chapter in Cisco Unified CME B-ACD and Tcl Call-Handling Applications.
Do Not Disturb
The Do Not Disturb (DND) feature can be used as an alternative to the HLog function for preventing
incoming calls from ringing on a phone. The difference is that HLog prevents only hunt group calls from
ringing, while DND prevents all calls from ringing. For more information, see “Configuring Do Not
Disturb” on page 825.
Automatic Call Forwarding During Night-Service
To have an ephone-dn forward all its calls automatically during night-service hours, use the
call-forward night-service command. For more information, see the “SCCP: Enabling Call Forwarding
for a Directory Number” section on page 620.
Ephone Templates
The night-service bell command specifies that a phone will receive night-service notification when calls
are received at ephone-dns configured as night-service ephone-dns. This command can be included in
an ephone template that is applied to one or more individual ephones.
For more information, see “Creating Templates” on page 1129.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 739
Configuring Call-Coverage Features
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
740 OL-10663-02
Configuring Call-Coverage Features
Feature Information for Call Coverage Features
Feature Information for Call Coverage Features
Table 12 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified Communications Manager Express and Cisco IOS Software Version Compatibility
Matrix at http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 12 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 12 Feature Information for Call Coverage
Cisco Unified CME
Feature Name Version Modification
Call Hunt 3.4 Added support for configuring call hunt features on SIP IP
phones connected directly to Cisco Unified CME.
3.0 • Preference for secondary numbers was introduced.
• Channel huntstop was introduced.
1.0 • Ephone-dn dial-peer preference was introduced.
• Huntstop was introduced.
Call Pickup 7.1 Added Call Pickup support for SIP phones.
4.0 • The ability to globally disable directed call pickup was
introduced.
• Feature access codes for call pickup were introduced.
• The ability to block call pickup on individual phones
was introduced.
3.2 The ability to remove or rearrange soft keys on individual
phones was introduced.
3.0 Call pickup groups were introduced.
Call Waiting 8.0 Added Cancel Call Waiting feature.
3.4 Added support for configuring call waiting for SIP phones
directly connected to Cisco Unified CME.
Callback Busy Subscriber 3.0 Callback busy subscriber was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 741
Configuring Call-Coverage Features
Feature Information for Call Coverage Features
Table 12 Feature Information for Call Coverage
Cisco Unified CME
Feature Name Version Modification
Hunt Groups 7.0/4.3 Added support for the following:
• SCCP phones in Voice Hunt-Groups
• Call Forwarding to a Parallel Voice Hunt-Group (Blast
Hunt Group)
• Call Transfer to a Voice Hunt-Group
• Member of Voice Hunt-Group can be a SCCP phone,
FXS analog phone, DS0-group, PRI-group, SIP phone,
or SIP trunk
Cisco Unified Communications Manager Express System Administrator Guide
742 OL-10663-02
Configuring Call-Coverage Features
Feature Information for Call Coverage Features
Table 12 Feature Information for Call Coverage
Cisco Unified CME
Feature Name Version Modification
Hunt Groups 4.0 Added support for the following on IP phones running
SCCP:
• Maximum number of hunt groups in a system was
increased from 20 to 100 and maximum number of
agents in a hunt group was increased from 10 to 20.
• Maximum number of hops automatically adjusts to the
number of agents.
• A description can be added to phone displays and
configuration output to provide hunt group information
associated with ringing and answered calls.
• A configurable message can be displayed on agent
phones when all agents are in the not-ready status to
advise the destination to which calls are being
forwarded or other useful information.
• No-answer timeouts can be set individually for each
ephone-dn in the list and a cumulative no-answer
timeout can be set for all ephone-dns.
• Automatic logout trigger criterion was changed from
exceeding the specified timeout to exceeding the
specified number of calls. The name of this feature was
changed from automatic logout to automatic agent
status not-ready.
• Dynamic hunt group membership is introduced. Agents
can join and leave hunt groups whenever a wildcard
slot is available.
• Agent status control using an HLog soft key or feature
access code (FAC) is introduced. Agents can put their
lines into not-ready state to temporarily block hunt
group calls without relinquishing their slots in group.
• Calls can be blocked from agent phones that are not idle
or on hook.
• Calls that are not answered by the hunt group can be
returned to the party who transferred them into the hunt
group.
• Calls parked by hunt group agents can be returned to a
different entry point.
• (Sequential hunt groups only) Local calls to a hunt
group can be restricted so that they will not be
forwarded past the initial agent that is rung.
• (Longest-idle hunt groups only) A new command, the
from-ring command, specifies that on-hook time
stamps should be updated when a call rings an agent
and when a call is answered by an agent.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 743
Configuring Call-Coverage Features
Feature Information for Call Coverage Features
Table 12 Feature Information for Call Coverage
Cisco Unified CME
Feature Name Version Modification
3.4 Added support for configuring hunt groups for SIP phones
directly connected to Cisco Unified CME.
3.2.1 • Maximum number of hunt groups in a system was
increased to 20.
• Automatic logout capability was introduced.
3.2 Longest-idle hunt groups were introduced.
3.1 Secondary pilot numbers were introduced.
3.0 Peer and sequential ephone hunt groups were introduced.
Night Service 4.0 The night-service everyday, night-service weekday, and
night-service weekend commands were introduced.
3.3 The behavior of the night-service code was changed.
Previously, using the night-service code at a phone either
enabled or disabled night service for the ephone-dns on that
phone. Now, using the night-service code at a phone
enables or disables night service for all night-service
ephone-dns.
3.0 Night service was introduced.
Overlaid Ephone-dns 4.0 • The number of ephone-dns that can be overlaid on a
single button using the button command and the o or c
keyword was increased from 10 to 25.
• The ability to extend calls for overlaid ephone-dns to
other buttons (rollover buttons) on the same phone was
introduced. Rollover buttons are created by using the x
keyword with the button command.
• The number of waiting calls that can be displayed for
overlaid ephone-dns that have call waiting configured
has been increased to six for the following phone types:
Cisco Unified IP Phone 7940G, 7941G, 7941G-GE,
7960G, 7961G, 7961G-GE, 7970G, and 7971G-GE.
3.2.1 Call waiting for overlaid ephone-dns was introduced and
the c keyword was added to the button command.
3.0 Overlaid ephone-dns were introduced and the o keyword
was added to the button command.
Cisco Unified Communications Manager Express System Administrator Guide
744 OL-10663-02
Configuring Caller ID Blocking
Last Updated: January 3, 2008
This chapter describes the Caller ID (CLID) Blocking feature in Cisco Unified Communications
Manager Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Caller ID Blocking”
section on page 752.
Contents
• Restrictions for Caller ID Blocking, page 745
• Information about Caller ID Blocking, page 745
• How to Configure Caller ID Blocking, page 746
• Configuration Examples for Caller ID Blocking, page 750
• Additional References, page 750
• Feature Information for Caller ID Blocking, page 752
Restrictions for Caller ID Blocking
Caller ID blocking on outbound calls does not apply to PSTN calls through foreign exchange office
(FXO) ports. Caller ID features on FXO-connected subscriber lines are under the control of the PSTN
service provider, who may require you to subscribe to their caller ID blocking service.
Information about Caller ID Blocking
To enable Caller ID Blocking, you should understand the following concept:
• Caller ID Blocking on Outbound Calls, page 746
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 745
Configuring Caller ID Blocking
How to Configure Caller ID Blocking
Caller ID Blocking on Outbound Calls
Phone users can block caller-ID displays on calls from a particular ephone-dn, or you can selectively
choose to block the name or number on outbound calls from a particular dial peer.
The display of caller ID information for outgoing calls from a particular ephone-dn can be blocked on a
per-call basis, allowing users to maintain their privacy when necessary. The system administrator
defines a code for caller ID blocking in Cisco Unified CME. Users then dial the code before making any
call on which they do not want their number displayed on the called-party phone. The caller ID is sent,
but its presentation parameter is set to “restricted” so that the caller ID is not displayed.
Blocking CLID displays for local calls from a particular extension tells the far-end gateway device to
block display of calling-party information for the calls received from this ephone-dn.
Alternatively, you can allow the local display of CLID information and independently block the CLID
name or number on outbound VoIP calls. This configuration has the benefit of allowing caller-ID display
for local calls while preventing caller-ID display for external calls going over VoIP. This feature can be
used for PSTN calls that go out over ISDN.
How to Configure Caller ID Blocking
This section contains the following tasks:
• SCCP: Blocking Caller ID For All Outbound Calls, page 746 (optional)
• SCCP: Blocking Caller ID From a Directory Number, page 747 (optional)
• Verifying Caller ID Blocking, page 749 (optional)
SCCP: Blocking Caller ID For All Outbound Calls
To block the CLID name or number on outbound VoIP calls from a particular dial peer, perform the
following steps.
Restrictions
• Caller ID continues to be displayed for local calls. To block caller ID display on all outbound calls
from a particular directory number, use the caller-id block command. See the “SCCP: Blocking
Caller ID From a Directory Number” section on page 747 or the “Verifying Caller ID Blocking”
section on page 749.
SUMMARY STEPS
1. enable
2. configure terminal
3. dial-peer voice tag [pots | voip]
4. clid strip
5. clid strip name
6. end
Cisco Unified Communications Manager Express System Administrator Guide
746 OL-10663-02
Configuring Caller ID Blocking
How to Configure Caller ID Blocking
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 dial-peer voice tag [pots | voip] Enters dial-peer configuration mode.
Note You can configure caller-ID blocking on POTS dial
Example: peers if the POTS interface is ISDN. This feature is not
Router(config)# dial-peer voice 3 voip available on FXO/CAS lines.
Step 4 clid strip (Optional) Removes the calling-party number from the CLID
information being sent with VoIP calls.
Example:
Router(config-dial-peer)# clid strip
Step 5 clid strip name (Optional) Removes the calling-party name from the CLID
information being sent with VoIP calls.
Example:
Router(config-dial-peer)# clid strip name
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-dial-peer)# end
SCCP: Blocking Caller ID From a Directory Number
To define a code that phone users can dial to block caller ID display on selected outbound calls from a
particular directory number or to block caller ID display on all calls from a directory number, perform
the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. caller-id block code code-string
5. exit
6. ephone-dn dn-tag
7. caller-id block
8. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 747
Configuring Caller ID Blocking
How to Configure Caller ID Blocking
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 caller-id block code code-string (Optional) Defines a code that users can enter before making
calls on which the caller ID should not be displayed.
Example: • code-string—Digit string of up to 16 characters. The first
Router(config-telephony)# caller-id block character must be an asterisk (*).
code *1234
Step 5 exit Exits telephony-service configuration mode.
Example:
Router(config-telephony)# exit
Step 6 ephone-dn dn-tag Enters ephone-dn configuration mode.
Example:
Router(config)# ephone-dn 3
Step 7 caller-id block (Optional) Blocks display of caller-ID information for all
outbound calls that originate from this dirceory number.
Example: • This command can also be configured in
Router(config-ephone-dn)# caller-id block ephone-dn-template configuration mode and applied to one
or more directory number. The ephone-dn configuration
has priority over the ephone-dn-template configuration.
Step 8 end Returns to privileged EXEC mode.
Example:
Router(config-dial-peer)# end
Cisco Unified Communications Manager Express System Administrator Guide
748 OL-10663-02
Configuring Caller ID Blocking
How to Configure Caller ID Blocking
Verifying Caller ID Blocking
Step 1 Use the show running-config command to display caller ID blocking parameters, which may appear in
the telephony-service, ephone-dn, or dial-peer portions of the output.
Router# show running-config
dial-peer voice 450002 voip
translation-profile outgoing 457-456
destination-pattern 457
session target ipv4:10.43.31.81
dtmf-relay h245-alphanumeric
codec g711ulaw
no vad
clid strip
!
telephony-service
fxo hook-flash
load 7960-7940 P00305000600
load 7914 S00103020002
max-ephones 100
max-dn 500
ip source-address 10.115.34.131 port 2000
max-redirect 20
no service directed-pickup
timeouts ringing 10
system message XYZ Company
voicemail 7189
max-conferences 8 gain -6
moh music-on-hold.au
caller-id block code *1234
web admin system name cisco password cisco
dn-webedit
time-webedit
transfer-system full-consult
transfer-pattern 92......
transfer-pattern 91..........
transfer-pattern 93......
transfer-pattern 94......
transfer-pattern 95......
transfer-pattern 96......
transfer-pattern 97......
transfer-pattern 98......
transfer-pattern .T
secondary-dialtone 9
after-hours block pattern 1 91900 7-24
after-hours block pattern 2 9976 7-24
!
create cnf-files version-stamp 7960 Jul 13 2004 03:39:28
!
ephone-dn 2 dual-line
number 126
preference 1
call-forward busy 500
caller-id block
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 749
Configuring Caller ID Blocking
Configuration Examples for Caller ID Blocking
Configuration Examples for Caller ID Blocking
This section contains the following examples:
• Caller ID Blocking Code: Example, page 750
• SCCP: Caller ID Blocking for Outbound Calls from a Directory Number: Example, page 750
• Additional References, page 750
Caller ID Blocking Code: Example
The following example defines a code of *1234 for phone users to enter to block caller ID on their
outgoing calls:
telephony-service
caller-id block code *1234
SCCP: Caller ID Blocking for Outbound Calls from a Directory Number: Example
The following example sets CLID blocking for the ephone-dn with tag 3.
ephone-dn 3
number 2345
caller-id block
The following example blocks the display of CLID name and number on VoIP calls but allows CLID
display for local calls:
ephone-dn 3
number 2345
dial-peer voice 2 voip
clid strip
clid strip name
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Cisco Unified Communications Manager Express System Administrator Guide
750 OL-10663-02
Configuring Caller ID Blocking
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 751
Configuring Caller ID Blocking
Feature Information for Caller ID Blocking
Feature Information for Caller ID Blocking
Table 13 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 13 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 13 Feature Information for Caller ID Blocking
Cisco Unified CME
Feature Name Version Feature Information
Caller ID Blocking 3.0 Caller ID blocking per local call was introduced.
1.0 Caller ID blocking for outbound calls was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
752 OL-10663-02
Configuring Conferencing
Last Updated: August 5, 2009
This chapter describes the conferencing support in Cisco Unified Communications Manager Express
(Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Conferencing”
section on page 804.
Contents
• Restrictions for Conferencing, page 753
• Information About Conferencing, page 754
• How to Configure Conferencing, page 759
• Configuration Examples for Conferencing, page 787
• Where to Go Next, page 802
• Additional References, page 803
• Feature Information for Conferencing, page 804
Restrictions for Conferencing
When you are configuring dial peers or ephone-dns, including park slots and conferencing extensions,
on Cisco Integrated Services Router Voice Bundles, the following message may appear to warn you that
free memory is not available:
%DIALPEER_DB-3-ADDPEER_MEM_THRESHOLD: Addition of dial-peers limited by available
memory
To configure more dial peers or ephone-dns, increase the DRAM in the system. A moderately complex
configuration may exceed the default 256 MB DRAM and require 512 MB DRAM. Note that many
factors contribute to memory usage, in addition to the number of dial peers and ephone-dns configured.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 753
Configuring Conferencing
Information About Conferencing
Information About Conferencing
To enable conferencing, you should understand the following concepts:
• Conferencing Overview, page 754
• Conferencing with Octo-Lines, page 754
• Secure Conferencing Limitation, page 754
• Ad Hoc Conferencing, page 755
• Meet-Me Conferencing in Cisco Unified CME 4.1 and Later versions, page 756
• Meet-Me Conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0, page 757
Conferencing Overview
Conferencing allows you to join three or more parties in a telephone conversation. Two types of
conferencing are available in Cisco Unified CME: ad hoc and meet-me.
Ad hoc conferences can be hardware-based or software-based. Software-based conferences use the
router CPU to provide audio mixing (G.711) and are limited to 3 parties. Hardware-based multi-party ad
hoc conferencing uses digital signal processors (DSPs) to allow more parties than software-based ad hoc
conferencing and also provides additional features such as Join and Conference Participant List
(ConfList).
Meet-me conferences are created by parties calling a designated conference number. Meet-me
conferencing is hardware-based only. If you configure software-based conferencing, you cannot have
meet-me conferences.
Conferencing with Octo-Lines
In Cisco Unified CME 4.3 and later versions, when a conference initiator is an octo-line directory
number, Cisco Unified CME selects an idle channel from that directory number and the user must
establish a new call to complete the conference. If an idle channel is not available on the same octo-line
directory number, the conference aborts and a “No Line Available” message displays.
Cisco Unified CME does not select an idle channel from another directory number and the user cannot
select “hold” calls on the other channels of the directory number or other directory numbers, which is
the behavior for single-line and dual-line directory numbers.
With octo-line directory numbers, only one directory number is required for an 8-party meet-me or
ad hoc conference. Up to eight select and join instances are supported.
Secure Conferencing Limitation
Cisco Unified CME cannot use the secure conference DSP farm capability. If Cisco Unified CME needs
a conference DSP farm resource for multiparty ad hoc or meet-me conferencing, it will use a secure or
nonsecure DSP farm resource depending on what resources have been registered with
Cisco Unified CME. If Cisco Unified CME happens to pick a secure DSP farm resource, the conference
itself will not be secure, which is a waste, in terms of sessions capacity, of the more expensive secure
DSP farm resource.
Cisco Unified Communications Manager Express System Administrator Guide
754 OL-10663-02
Configuring Conferencing
Information About Conferencing
To avoid using valuable secure DSP farm resources, we recommend that you do not register a secure
conference DSP Farm profile to a Cisco Unified CME because Cisco Unified CME cannot use the DSP
farm’s secure capabilities.
Ad Hoc Conferencing
Before Cisco Unified CME 4.1, support for conferencing is limited to three-party ad hoc conference
calls using a G.711 codec. To have an ad hoc conference with a party that is not using a G.711 codec,
transcoding is necessary. For more information, see the “Transcoding When a Remote Phone Uses
G.729r8” section on page 333.
The maximum number of simultaneous conferences is platform-specific to the type of
Cisco Unified CME router, and each individual Cisco Unified IP phone can host a maximum of one
conference at a time. You cannot create a second conference on a phone if you already have an existing
conference on hold.
Conference Gain Levels
In Cisco Unified CME 3.3 and later versions, you can adjust the gain level of an external call to provide
more adequate volume. This functionality is applied to inbound audio packets so that conference
participants can more clearly hear a remote PSTN or VoIP caller joining their call. Note that this
functionality cannot discriminate between a remote VoIP/foreign exchange office (FXO) source, which
requires a volume gain, and a remote VoIP/IP phone, which does not require a volume gain and may
therefore incur some sound distortions.
End-of-Conference Options
For Cisco CME 3.2 and later versions, a person who initiates a conference call and hangs up can either
keep the remaining parties connected or disconnect them.
Cisco Unified IP phones can be configured to keep the remaining conference parties connected when the
conference initiator hangs up (places the handset back in the on-hook position). Conference originators
can disconnect from their conference calls by pressing the Confrn (conference) soft key. When an
initiator uses the Confrn key to disconnect from the conference call, the oldest call leg will be put on
hold, leaving the initiator connected to the most recent call leg. The conference initiator can then
navigate between the two parties by pressing either the Hold soft key or the line buttons to select the
desired call.
In Cisco Unified CME 4.0 and later versions, behavior for the end of three-way conferences can be
configured at a phone level. The options specify whether the last party that joined a conference can be
dropped from the conference and whether the remaining two parties should be allowed to continue their
connection after the conference initiator has left the conference.
Multi-Party Ad Hoc Conferencing for More Than Three Parties
In Cisco Unified CME 4.1 and later versions, hardware-based multi-party ad hoc conferences allow
more than three parties. Ad hoc conferences are created when one party calls another, then either party
decides to add another party to the call. Ad hoc conferences can be created in several ways.
The conference shown in Figure 23 is created when extension 1215 dials extension 1225. The two parties
decide to add a third party, extension 1235. Extensions 1215, 1225, and 1235 are now parties in an ad
hoc conference. Extension 1215 is the creator.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 755
Configuring Conferencing
Information About Conferencing
Figure 23 Simple Ad Hoc Conference Using the Conf Soft Key
x1215 x1225
1
IP IP
x1235
170458
IP
You can configure ad hoc conferencing so that only the creator can add parties to the conference. The
default is that any party can add other parties to the conference.
You can configure conferencing so that the conference drops when the creator hangs up, and you can
configure it so that the conference drops when the last local party hangs up. The default is that the
conference is not dropped, regardless of whether the creator hangs up, provided three parties remain in
the conference.
For configuration information, see the “SCCP: Configuring Conferencing Options for a Phone” section
on page 776 for more information.
Meet-Me Conferencing in Cisco Unified CME 4.1 and Later versions
In Cisco Unified CME 4.1 and later versions, meet-me conferences consist of at least three parties
dialing a meet-me conference number predetermined by a system administrator. For example, the
conference shown in Figure 24 is created when the conference creator at extension 1215 presses the
MeetMe soft key and hears a confirmation tone, then dials the meet-me conference number 1500.
Extension 1225 and extension 1235 join the meet-me conference by dialing 1500. Extensions 1215,
1225, and 1235 are now parties in a meet-me conference on extension 1500.
Figure 24 Simple Meet-Me Conference Scenario
x1500
1 3 2
IP IP
x1215 x1225
170459
IP
x1235
Cisco Unified Communications Manager Express System Administrator Guide
756 OL-10663-02
Configuring Conferencing
Information About Conferencing
Configuring Maximum Parties
You can configure the maximum number of conference parties to be lower than the actual maximum of
32 for meet-me conferences. See the “SCCP: Configuring the DSP Farm” section on page 769 for more
information.
Freeing Conference Resources
If only one party remains in the meet-me conference, for example, if one party has forgotten to hang up,
the conference call is disconnected after five minutes to free system resources.
If the creator is waiting for parties to join the conference and is the only party on the conference, the
conference is not disconnected because significant resources are not being used.
Soft Keys for Conference Functions
In Cisco Unified CME 4.1 and later versions, the following soft keys provide conferencing functions for
hard-ware based multi-party conferencing enhancements on your phone and require the appropriate DSP
farm configuration. For configuration information, see the “SCCP: Configuring Multi-Party Ad Hoc and
Meet-Me Conferencing in Cisco Unified CME 4.1 and Later Versions” section on page 765.
• ConfList—Conference list. Lists all parties in a conference. For multi-party ad hoc conferences, this
soft key is available for all parties in a conference. For meet-me conferences, this soft key is
available for the creator only. Press Update to update the list of parties in the conference, for
instance, to verify that a party has been removed from the conference.
• Join—Joins an established call to a conference. You must first press Select to choose each connected
call that you want to join in a conference, then press Join to join the selected calls to the conference.
• RmLstC—Remove last caller. Removes the last party added to the conference. This soft key works
for the creator only.
• Select—Selects a call or conference to join to a conference and selects a call to remove from a
conference. The creator can remove other parties by pressing the ConfList soft key, then use the
Select and Remove soft keys to remove the appropriate parties.
• MeetMe—Initiates a meet-me conference. The creator presses this soft key before dialing the
conference number. Other meet-me conference parties only dial the conference number to join the
conference. This soft key must be configured before you can initiate meet-me conferences.
Meet-Me Conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0
Unlike the built-in Cisco Unified CME conference feature, a meet-me conference does not have a
three-party limit. Meet-me Conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0 requires
Cisco Unity Express auto-attendant to transfer callers to the correct Meet-Me bridge and a dual T-1/E-1
VWIC card for providing DSP resources. By default three Meet-Me bridge’s with 8 callers each are
defined with the maximum number of callers restricted by the number of DSP resources available in the
Cisco router. A maximum of 96 callers in conference is supported. Multicast conferences can be
accessed from IP phones, public switched telephone network (PSTN) callers, and Cisco Land Mobile
Radio (LMR) devices connected to ear and mouth (E&M) voice ports on the Cisco Unified CME router.
The only limiting factor for this solution is the number of T1 or E1 loopback ports and
digital-signal-processor (DSP) resources available.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 757
Configuring Conferencing
Information About Conferencing
Figure 25 illustrates the callflow for Meet-Me Conferencing on a Cisco router with Cisco CME 3.2 to
Cisco Unified CME 4.0 and Cisco Unity Express. IP phones and PSTN callers dial into Cisco Unity
Express Auto Attendant using separate access numbers. Cisco Unity Express Auto Attendant routes
calls to a multicast conference based on which access number is called. In this example, local IP phones
call 202 and PSTN users call 203 to dial into Cisco Unity Express.
Figure 25 Meet-Me Conference in Cisco CME 3.2 to Cisco Unified CME 4.0
CallManager Express
with Unity Express
1 IP
2
DSP 202
E1/T1 203
202 DSP IP WAN
loopback
4
DSP
3
Meet-me conference
142509
LMR systems
1. In order to send or receive audio from a multicast conference, calls must pass through a DSP for
audio mixing. By default, IP phone calls are not passed through a DSP. IP phone calls can be routed
to T1 or E1 loopback, forcing the call to pass through a DSP. In this example, Cisco Unity Express
routes callers who dialed 202, through the E1/T1 loopback.
2. The T1/E1 loopback ports are permanently trunked to the multicast conference. Incoming calls to
T1 loopback are routed back to the multicast conference on Cisco CME.
3. All PSTN calls must pass through a DSP, so incoming PSTN calls do not have to be routed to T1
loopback. The Auto Attendant routes PSTN calls directly to the multicast conference. In this
example, Cisco Unity Express routes callers who dialed 203 directly into the multicast conference.
4. Cisco LMR ports are permanently trunked into the multicast conference, so radio parties can listen
to audio from both the IP phone and the PSTN. Pushing the “talk” button on a radio handset keys
the M lead on the Cisco CME E&M port and the radio handset can transmit audio.
Note Cisco LMR devices typically cannot transmit and receive audio at the same time. If a Cisco LMR device
receives audio from a multicast conference, it cannot transmit audio. In order for a Cisco LMR device
to transmit audio to the conference, all IP phone and PSTN parties must be on mute so the LMR device
does not receive any audio. If a single IP phone or PSTN device in the conference is transmitting audio,
the individual using the Cisco LMR device cannot talk.
Cisco Unified Communications Manager Express System Administrator Guide
758 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
Dial Plan
Before configuring Cisco Unified CME and Cisco Unity Express, you should plan your dial plan for
Meet-Me Conferencing. Table 14 lists the dial-plan parameters that must be defined before you can
configure Meet-Me Conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0.
To prevent IP phones from dialing into the multicast bridge directly, the multicast bridge numbers should
be set to nondialable numbers starting with an alphabetical character.
IP phones that dial into the multicast bridge cannot send or receive audio, so IP phone calls must be
routed to the loopback number. These numbers are required to configure Cisco Unity Express Auto
Attendant, which controls all access to the multicast bridge.
Table 14 Dial Plan for Support Meet-Me Conferencing
Sample
Parameter Number Description
External Number 203 Number used by external callers from PSTN to dial into
Cisco Unity Express Auto Attendant conference bridge.
Internal Number 202 Number used by internal callers from local IP phones to dial
into Cisco Unity Express Auto Attendant conference bridge.
bridge1 212 Number used by Cisco Unified CME to route calls to E1 or T1
loopback that is trunked to multicast bridge 1.
bridge2 213 Number used by Cisco Unified CME to route calls to E1 or T1
loopback that is trunked to multicast bridge 2
bridge3 214 Number used by Cisco Unified CME to route calls to E1 or T1
loopback that is trunked to multicast bridge 3.
bridge1_pstn A212 Nondialable number used by Cisco Unified CME to route calls
into multicast bridge 1. Number should start with an
alphabetical number.
bridge2_pstn A213 Nondialable number used by Cisco Unified CME to route calls
into multicast bridge 2. Number should start with an
alphabetical number.
bridge3_pstn A214 Nondialable number used by Cisco Unified CME to route calls
into multicast bridge 3. Number should start with an
alphabetical number.
operator 150 Number dialed if user needs assistance.
How to Configure Conferencing
This section contains the following tasks:
(Software-based) Three-Party Ad Hoc Conferencing
• Modifying the Default Configuration for Three-Party Ad Hoc Conferencing, page 760 (optional)
• SCCP: Configuring Conferencing Options on a Phone, page 761 (optional)
• SIP: Configuring Conferencing Options on a Phone, page 763 (optional)
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 759
Configuring Conferencing
How to Configure Conferencing
(Hardware-based) Multi-Party Ad Hoc and Meet-Me Conferencing in Cisco Unified CME 4.1 and Later Versions
• SCCP: Configuring Multi-Party Ad Hoc and Meet-Me Conferencing in Cisco Unified CME 4.1 and
Later Versions, page 765 (required)
• SCCP: Verifying Multi-Party Ad Hoc and Meet-Me Conferencing, page 779 (optional)
Meet-Me Conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0
• SCCP: Configuring Meet-Me Conferencing in Cisco CME 3.2 to Cisco Unified CME 4.0, page 779
(required)
Modifying the Default Configuration for Three-Party Ad Hoc Conferencing
To globally modify the default configuration and change any of the following parameters for three-party
ad hoc conferencing, perform the following steps.
• Maximum number of three-party conferences that are supported simultaneously by the
Cisco Unified CME router. Maximum number of simultaneous three-party conferences supported
by a router is platform-dependent. The default value is half of the maximum number.
• Increase the sound volume of VoIP and public switched telephony network (PSTN) parties joining
a conference call
Restrictions
• When a three-way conference is established, a participant cannot use call transfer to join the
remaining conference participants to a different number.
• Three-party ad hoc conferencing does not support meet-me conferences.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. max-conferences max-conference-number [gain -6 | 0 | 3 | 6]
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
760 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
Command or Action Purpose
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)#
Step 4 max-conferences max-conference-number Sets the maximum number of simultaneous three-party
[gain -6 | 0 | 3 | 6] conferences supported by the router.
• max-conference-number—Maximum value is
Example: platform-dependent. Type ? for maximum value. Default is
Router(config-telephony)# max-conferences half of the maximum value.
6
• gain—(Optional) Amount to increase the sound volume of
VoIP and PSTN calls joining a conference call, in decibels.
Valid values are -6, 0, 3, and 6. The default is -6.
Step 5 end Exits to privileged EXEC mode.
Example:
Router(config-telephony)# end
SCCP: Configuring Conferencing Options on a Phone
To configure optional end-of-conference options for three-party ad hoc conferencing on a
Cisco Unified IP phone running Skinny Client Control Protocol (SCCP), perform the following steps for
each phone to be configured.
Prerequisites
• Conferencing uses call transfer to connect the two remaining parties of a conference when a
conference initiator leaves the conference. To use this feature, you must configure the
transfer-system command. For configuration information, see “Configuring Call Transfer and
Forwarding” on page 595.
• Drop-last feature of Keep Conference on analog phones connected to the Cisco Unified CME
system through a Cisco VG 224 requires Cisco IOS Release 12.4(9)T or later release.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. keep-conference [drop-last] [endcall] [local-only]
5. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 761
Configuring Conferencing
How to Configure Conferencing
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies this
Example: ephone during configuration tasks.
Router(config)# ephone 1
Step 4 keep-conference [drop-last] [endcall] Allows conference initiators to exit from conference calls and to
[local-only] either end or maintain the conference for the remaining parties.
• no keep-conference—(Default; the no form of the
Example: command) The conference initiator can hang up or press the
Router(config-ephone)# keep-conference EndCall soft key to end the conference and disconnect all
endcall
parties or press the Confrn soft key to drop only the last party
that was connected to the conference.
• keep-conference—(No keywords used) The conference
initiator can press the EndCall soft key to end the conference
and disconnect all parties or hang up to leave the conference
and keep the other two parties connected. The conference
initiator can also use the Confrn soft key (IP phone) or
hookflash (analog phone) to break up the conference but stay
connected to both parties.
• drop-last—The action of the Confrn soft key is changed; the
conference initiator can press the Confrn soft key (IP phone)
or hookflash (analog phone) to drop the last party.
• endcall—The action of the EndCall soft key is changed; the
conference initiator can hang up or press the EndCall soft key
to leave the conference and keep the other two parties
connected.
• local-only—The conference initiator can hang up to end the
conference and leave the other two parties connected only if
one of the remaining parties is local to the
Cisco Unified CME system (an internal extension).
Step 5 end Exits to privileged EXEC mode.
Example:
Router(config)# end
Cisco Unified Communications Manager Express System Administrator Guide
762 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
What to Do Next
If you are finished modifying the configuration, you are ready to generate configuration files for the
phones to be connected. See “SCCP: Generating Configuration Files for SCCP Phones” on page 263.
SIP: Configuring Conferencing Options on a Phone
To configure optional end-of-conference options for three-party ad hoc conferencing on a
Cisco Unified IP phone running SIP, perform the following steps for each phone to be configured.
Prerequisites
• To facilitate call transfer by using the Confrn soft key, conference and transfer attended or transfer
blind must be enabled. For configuration information, see “Configuring Call Transfer and
Forwarding” on page 595.
Restrictions
Music on hold (MOH) is not supported for call hold invoked from a SIP phone. A caller hears only
silence when placed on hold by a SIP phone.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register pool pool-tag
4. keep-conference
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for SIP phones.
Example: • pool-tag—Unique sequence number of the SIP phone
Router(config)# voice register pool 3 to be configured. Range is 1 to 100 or the upper limit as
defined by max-pool command.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 763
Configuring Conferencing
How to Configure Conferencing
Command or Action Purpose
Step 4 keep-conference Allows a Cisco Unified IP phone conference initiator to exit
from conference calls and keeps the remaining parties
connected.
Example:
Router(config-register-pool)# keep-conference Note This step is included to illustrate how to enable the
command if it was previously disabled.
• Default is enabled.
• Remaining calls are transferred without consultation as
enabled by the transfer-attended (voice register
template) or transfer-blind (voice register template)
commands.
Step 5 end Exits to privileged EXEC mode.
Example:
Router(config-register-pool)# end
What to Do Next
• If you are finished modifying the configuration, you are ready to generate configuration files for the
phones to be connected. See “SIP: Generating Configuration Profiles for SIP Phones” on page 265.
Verifying Three-Party Ad Hoc Conferencing
Step 1 Use the show running-config command to verify your configuration. Any non-default conferencing
parameters are listed in the telephony-service portion of the output, and end-of-conference options are
listed in the ephone portion.
Router# show running-config
!
ephone-dn 1 dual-line
ring feature secondary
number 126 secondary 1261
description Sales
name Smith
call-forward busy 500 secondary
call-forward noan 500 timeout 10
huntstop channel
no huntstop
no forward local-calls
!
ephone 1
mac-address 011F.92A0.C10B
type 7960 addon 1 7914
no dnd feature-ring
keep-conference
Cisco Unified Communications Manager Express System Administrator Guide
764 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
Troubleshooting Three-Party Ad Hoc Conferencing
Step 1 Use the debug ephone commands to observe messages and states associated with an ephone. For more
information, see the Cisco Unified CME Command Reference.
SCCP: Configuring Multi-Party Ad Hoc and Meet-Me Conferencing in
Cisco Unified CME 4.1 and Later Versions
To configure multi-party ad hoc conference support for 3-8 parties plus Meet-Me conferencing for up to
32 parties, perform the following tasks:
• SCCP: Enabling DSP Farm Services for a Voice Card, page 766 (required)
• SCCP: Configuring Join and Leave Tones, page 766 (optional)
• SCCP: Configuring SCCP for Cisco Unified CME, page 768 (required)
• SCCP: Configuring the DSP Farm, page 769 (required)
• SCCP: Associating Cisco Unified CME with a DSP Farm Profile, page 771 (required)
• SCCP: Enabling Multi-Party Ad Hoc and Meet-Me Conferencing, page 772 (required)
• SCCP: Configuring Multi-Party Ad Hoc Conferencing and Meet-Me Numbers, page 774 (required)
• SCCP: Configuring Conferencing Options for a Phone, page 776 (required)
• SCCP: Verifying Multi-Party Ad Hoc and Meet-Me Conferencing, page 779 (optional)
Prerequisites
• Cisco Unified CME 4.1 or a later version
• You must have a PVDM2-8, PVDM2-16, PVDM2-32, or PVDM2-64 high-density packet voice
digital signal processor module hosted on the motherboard or on a module such as the NM-HDV2
or NM-HD-2VE.
• For Cisco Unified IP Phone 7985, firmware version 4-1-2-0 or a later version
Restrictions
• The maximum number of meet-me conference parties is 32 for one DSP using the G.711 codec and
16 for the G.729 codec.
• A participant cannot join more than one conference at the same time.
• Hardware-based multi-party ad hoc conferencing for more than three parties is not supported on
phones that do not support soft keys.
• Hardware-based multi-party ad hoc conferencing for more than three parties is not supported on
Cisco Unified IP phones running SIP.
• Hardware-based multi-party ad hoc conferencing does not support the local-consult transfer method
(transfer-system local-consult command).
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 765
Configuring Conferencing
How to Configure Conferencing
SCCP: Enabling DSP Farm Services for a Voice Card
To enable DSP farm services for a voice card to support multi-party ad hoc and meet-me conferences,
perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice-card slot
4. dsp services dspfarm
5. exit
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice-card slot Enters voice-card configuration mode and configure a voice
card.
Example:
Router(config)# voice-card 2
Step 4 dsp services dspfarm Enables digital-signal-processor (DSP) farm services for a
particular voice network module.
Example:
Router(config-voicecard)# dsp services dspfarm
Step 5 exit Exits voice-card configuration mode.
Example:
Router(config-voicecard)# exit
SCCP: Configuring Join and Leave Tones
To configure tones to be played when parties join and leave multi-party ad hoc conferences and meet-me
conferences, perform the following steps for each tone to be configured.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
766 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
3. voice class custom-cptone cptone-name
4. dualtone conference
5. frequency frequency-1 [frequency-2]
6. cadence {cycle-1-on-time cycle-1-off-time [cycle-2-on-time cycle-2-off-time] [cycle-3-on-time
cycle-3-off-time] [cycle-4-on-time cycle-4-off-time] | continuous}
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice class custom-cptone cptone-name Creates a voice class for defining custom call-progress
tones to be detected.
Example:
Router(config)# voice class custom-cptone
jointone
Step 4 dualtone conference Configures conference join and leave tones.
Example:
Router(cfg-cptone)# dualtone conference
Step 5 frequency frequency-1 [frequency-2] Defines the frequency components for a call-progress tone.
Example:
Router(cfg-cp-dualtone)# frequency 600 900
Step 6 cadence {cycle-1-on-time cycle-1-off-time Defines the tone-on and tone-off durations for a
[cycle-2-on-time cycle-2-off-time] call-progress tone.
[cycle-3-on-time cycle-3-off-time]
[cycle-4-on-time cycle-4-off-time] |
continuous}
Example:
Router(cfg-cp-dualtone)# cadence 300 150 300
100 300 50
Step 7 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(cfg-cp-dualtone)# exit
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 767
Configuring Conferencing
How to Configure Conferencing
SCCP: Configuring SCCP for Cisco Unified CME
To enable SCCP on Cisco Unified CME to support multi-party ad hoc and meet-me conferences,
perform the following steps:
SUMMARY STEPS
1. enable
2. configure terminal
3. sccp local interface-type interface-number [port port-number]
4. sccp ccm {ip-address | dns} identifier identifier-number [port port-number]
[version version-number]
5. sccp ccm group group-number
6. bind interface interface-type interface-number
7. exit
8. sccp
9. exit
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 sccp local interface-type interface-number Selects the local interface that SCCP applications
[port port-number] (transcoding and conferencing) use to register with
Cisco Unified CME.
Example:
Router(config)# sccp local FastEthernet0/0
Step 4 sccp ccm {ip-address | dns} identifier Enables the Cisco Unified CME router to register SCCP
identifier-number [port port-number] [version applications.
version-number]
• version-number—Must be set to 4.0 or later.
Example:
Router(config)# sccp ccm 10.4.158.3 identifier
100 version 4.0
Step 5 sccp ccm group group-number Creates a Cisco Unified CME group.
Example:
Router(config)# sccp ccm group 123
Cisco Unified Communications Manager Express System Administrator Guide
768 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
Command or Action Purpose
Step 6 bind interface interface-type interface-number Binds an interface to a Cisco Unified CME group.
Example:
Router(config-sccp-cm)# bind interface
fastethernet 0/0
Step 7 exit Exits SCCP Cisco Unified CME configuration mode.
Example:
Router(config-sccp-cm)# exit
Step 8 sccp Enables SCCP and its related applications (transcoding and
conferencing).
Example:
Router(config)# sccp
Step 9 exit Exits global configuration mode.
Example:
Router(config)# exit
SCCP: Configuring the DSP Farm
To configure the DSP farm profile for multi-party ad hoc and meet-me conferencing, perform the
following steps.
Note The DSP farm can be on the same router as the Cisco Unified CME or on a different router.
SUMMARY STEPS
1. enable
2. configure terminal
3. dspfarm profile profile-identifier conference
4. codec {codec-type | pass-through}
5. conference-join custom-cptone cptone-name
6. conference-leave custom-cptone cptone-name
7. maximum conference-participants max-participants
8. maximum sessions number
9. associate application sccp
10. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 769
Configuring Conferencing
How to Configure Conferencing
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 dspfarm profile profile-identifier conference Enters DSP farm profile configuration mode and defines a
profile for DSP farm services.
Example:
Router(config)# dspfarm profile 1 conference
Step 4 codec {codec-type | pass-through} Specifies the codecs supported by a DSP farm profile.
Note Repeat this step as necessary to specify all the
Example: supported codecs.
Router(config-dspfarm-profile)# codec g711ulaw
Step 5 conference-join custom-cptone cptone-name Associates a custom call-progress tone to indicate joining a
conference with a DSP farm profile.
Example: Note The cptone-name argument in this step must be the
Router(config-dspfarm-profile)# conference-join same as the cptone-argument in the voice class
custom-cptone jointone custom-cptone command configured in the “SCCP:
Enabling DSP Farm Services for a Voice Card”
section on page 766.
Step 6 conference-leave custom-cptone cptone-name Associates a custom call-progress tone to indicate leaving a
conference with a DSP farm profile.
Example: Note The cptone-name argument in this step must be the
Router(config-dspfarm-profile)# same as the cptone-argument in the voice class
conference-leave custom-cptone leavetone custom-cptone command configured in the “SCCP:
Enabling DSP Farm Services for a Voice Card”
section on page 766.
Step 7 maximum conference-participants (Optional) Configures the maximum number of conference
max-participants parties allowed in each meet-me conference. The maximum
is codec-dependent.
Example:
Router(config-dspfarm-profile)# maximum
conference-participants 32
Step 8 maximum sessions number Specifies the maximum number of sessions that are
supported by the profile.
Example:
Router(config-dspfarm-profile)# maximum
sessions 8
Cisco Unified Communications Manager Express System Administrator Guide
770 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
Command or Action Purpose
Step 9 associate application sccp Associates SCCP with the DSP farm profile.
Example:
Router(config-dspfarm-profile)# associate
application sccp
Step 10 end Exits to privileged EXEC mode.
Example:
Router(config-dspfarm-profile)# end
SCCP: Associating Cisco Unified CME with a DSP Farm Profile
To associate a DSP farm profile with a group of Cisco Unified CME routers that control DSP services,
perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. sccp ccm group group-number
4. associate ccm identifier-number priority priority-number
5. associate profile profile-identifier register device-name
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 sccp ccm group group-number Creates a Cisco Unified CME group.
Example:
Router(config)# sccp ccm group 1
Step 4 associate ccm identifier-number priority Associates a Cisco Unified CME router with the group and
priority-number establishes its priority within the group.
Example:
Router(config-sccp-ccm)# associate ccm 100
priority 1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 771
Configuring Conferencing
How to Configure Conferencing
Command or Action Purpose
Step 5 associate profile profile-identifier register Associates a DSP farm profile with the Cisco Unified CME
device-name group.
• device-name is a maximum of 16 characters.
Example:
Router(config-sccp-ccm)# associate profile 2
Note Repeat this step for every conferencing DSP farm
register confdsp1 and transcoding DSP farm.
Step 6 end Exits to privileged EXEC mode.
Example:
Router(config-sccp-ccm)# end
SCCP: Enabling Multi-Party Ad Hoc and Meet-Me Conferencing
To allow hardware-based multi-party ad hoc conferences with more than three parties and meet-me
conferences, perform the following steps.
Note Configuring multi-party ad hoc conferencing in Cisco Unified CME disables three-party
(software-based) ad hoc conferencing.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. conference hardware
5. transfer-system full-consult
6. sdspfarm units number
7. sdspfarm tag number device-name
8. sdspfarm conference mute-on mute-on-digits mute-off mute-off-digits
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
772 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
Command or Action Purpose
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 conference hardware Configures a Cisco Unified CME system for multi-party
conferencing only.
Example:
Router(config-telephony)# conference hardware
Step 5 transfer-system full-consult Transfers calls using H.450.2 with consultation using a
second phone line, if available.
Example: • The calls fall back to full-blind if a second line is not
Router(config-telephony)# transfer-system available.
full-consult
• This is the default transfer method in
Cisco Unified CME 4.0 and later versions.
Step 6 sdspfarm units number Specifies the maximum number of DSP farms that are
allowed to be registered to the SCCP server.
Example:
Router(config-telephony)# sdspfarm units 3
Step 7 sdspfarm tag number device-name Permits a DSP farm to register to Cisco Unified CME and
associates it with a SCCP client interface's MAC address.
Example: Note The device-name in this step must be the same as the
Router(config-telephony)# sdspfarm tag 2 device-name in the associate profile command in
confdsp1 Step 5 of the “SCCP: Associating Cisco Unified
CME with a DSP Farm Profile” section on
page 771.
Step 8 sdspfarm conference mute-on mute-on-digits Defines mute-on and mute-off digits for conferencing.
mute-off mute-off-digits
• Maximum: 3 digits. Valid values are the numbers and
symbols that appear on your telephone keypad: 1, 2, 3,
Example: 4, 5, 6, 7, 8, 9, 0, *, and #.
Router(config-telephony)# sdspfarm conference
mute-on 111 mute-off 222 • Mute-on and mute-off digits can be the same.
Step 9 end Exits to privileged EXEC mode.
Example:
Router(config-telephony)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 773
Configuring Conferencing
How to Configure Conferencing
SCCP: Configuring Multi-Party Ad Hoc Conferencing and Meet-Me Numbers
To configure extension numbers for hardware-based multi-party ad hoc and meet-me ad hoc
conferencing, based on the maximum number of conference participants you configure, perform the
following steps. Ad hoc conferences require four extensions per conference, regardless of how many
extensions are actually used by the conference parties.
Note Ensure that you configure enough directory numbers to accommodate the anticipated number of
conferences. The maximum number of parties in a multi-party ad hoc conference on an IP phone is eight;
the maximum on an analog phone is three.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag [dual-line]
4. number number [secondary number] [no-reg [both | primary]]
5. conference {ad-hoc | meetme}
6. preference preference-order [secondary secondary-order]
7. no huntstop [channel]
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
774 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
Command or Action Purpose
Step 3 ephone-dn dn-tag dual-line Enters ephone-dn configuration mode to configure an
extension (ephone-dn) for a phone line.
Example: • Each ephone-dn can carry two parties if it is configured
Router(config)# ephone-dn 18 dual-line as a dual line.
• Configure enough ephone-dns to accommodate the
maximum number of conference participants to be
supported.
• For multi-party ad hoc conferencing, maximum number
of directory numbers is 8, but you can configure a lower
maximum.
• For meet-me conferencing, maximum number of
directory numbers is 32, but you can configure a lower
maximum.
• Minimum number of directory numbers required: 2.
Step 4 number number [secondary number] [no-reg [both Associates a telephone or extension number with an
| primary]] ephone-dn in a Cisco Unified CME system.
• Each DN for a conference must have the same primary
Example: and secondary number.
Router(config-ephone-dn)# number 6789
Step 5 conference ad-hoc Configures a number as a placeholder for ad hoc
or conferencing to associate the call with the DSP farm.
conference meetme or
(Optional) Associates meet-me conferencing with a
Example: directory number.
Router(config-ephone-dn)# conference ad-hoc
or
Router(config-ephone-dn)# conference meetme
Step 6 preference preference-order [secondary Sets dial-peer preference order for an extension
secondary-order] (ephone-dn) associated with a Cisco Unified IP phone.
• Remember to configure “preference x” with low value
Example: to last DN.
Router(config-ephone-dn)# preference 1
• The lower the value of the preference-order argument,
the higher the preference of the extension.
Step 7 no huntstop [channel] Continues call hunting behavior for an extension
(ephone-dn) or an extension channel.
Example: • Remember to configure no huntstop for all DNs except
Router(config-ephone-dn)# no huntstop the last one.
Step 8 end Exits to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 775
Configuring Conferencing
How to Configure Conferencing
SCCP: Configuring Conferencing Options for a Phone
To configure a template of conferencing features such as the add party mode, drop party mode, and soft
keys for hardware-based multi-party ad hoc and meet-me conferences and apply the template to a phone,
perform the following steps.
Note The following commands can also be configured in ephone configuration mode. Commands configured
in ephone configuration mode have priority over commands in ephone-template configuration mode.
Prerequisites
• The RmLstC, ConfList, Join, and Select functions and soft keys are supported for hardware-based
conferencing only and require the appropriate DSP farm configuration. For configuration
information, see these tasks in this module:
– “SCCP: Enabling DSP Farm Services for a Voice Card” section on page 766
– “SCCP: Configuring the DSP Farm” section on page 769
– “SCCP: Associating Cisco Unified CME with a DSP Farm Profile” section on page 771
Restrictions
• The ConfList (including the Remove, Update, and Exit soft keys within the ConfList function) and
RmLstC soft keys do not work on a Cisco Unified IP Phone 7902, 7935, and 7936.
• The RmLstC, ConfList, Join, and Select functions and soft keys are not supported for
software-based conferencing.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-template template-tag
4. conference add-mode [creator]
5. conference drop-mode [creator | local]
6. conference admin
7. softkeys connected {[Acct] [ConfList] [Confrn] [Endcall] [Flash] [HLog] [Hold] [Join]
[LiveRcd] [Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]}
8. softkeys hold {[Join] [Newcall] [Resume] [Select]}
9. softkeys idle {[Cfwdall] [ConfList] [Dnd] [Gpickup] [HLog] [Join] [Login] [Newcall] [Pickup]
[Redial] [RmLstC]}
10. softkeys seized {[CallBack] [Cfwdall] [Endcall] [Gpickup] [HLog] [MeetMe] [Pickup]
[Redial]}
11. exit
12. ephone phone-tag
13. ephone-template template-tag
14. end
Cisco Unified Communications Manager Express System Administrator Guide
776 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-template template-tag Enter ephone-template configuration mode to create an
ephone template to configure a set of phone features.
Example:
Router(config)# ephone-template 1
Step 4 conference add-mode [creator] (Optional) Configures the mode for adding parties to
conferences.
Example: • creator—Only the creator can add parties to the
Router(config-ephone-template)# conference conference.
add-mode creator
Step 5 conference drop-mode [creator | local] (Optional) Configures the mode for dropping parties from
multi-party ad hoc conferences.
Example: • creator—The active conference terminates when the
Router(config-ephone-template)# conference creator hangs up.
drop-mode creator
• local—The active conference terminates when the last
local party in the conference hangs up or drops out of
the conference.
Step 6 conference admin (Optional) Configures the ephone as the conference
administrator. The administrator can:
Example: • Dial in to any conference directly through the
Router(config-ephone-template)# conference conference number
admin
• Use the ConfList soft key to list conference parties
• Remove any party from any conference
Step 7 softkeys connected {[Acct] [ConfList] [Confrn] Configures an ephone template for soft-key display during
[Endcall] [Flash] [HLog] [Hold] [Join] the connected call stage.
[LiveRcd] [Park] [RmLstC] [Select] [TrnsfVM]
[Trnsfer]} • The soft keys used for multi-party conferencing are
RmLstC, ConfList, Join, and Select. These soft keys
are supported for hard-ware based conferencing only
Example:
and require the appropriate DSP farm configuration.
Router(config-ephone-template)# softkeys
connected Hold Trnsfer Park Endcall Confrn • The number and order of soft key keywords you enter
ConfList Join Select RmLstC in this command correspond to the number and order of
soft keys on your phone.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 777
Configuring Conferencing
How to Configure Conferencing
Command or Action Purpose
Step 8 softkeys hold {[Join] [Newcall] [Resume] Configures an ephone template to modify soft-key display
[Select]} during the call-hold call stage.
• The soft keys used for multi-party conferencing are
Example: Join and Select. These soft keys are supported for
Router(config-ephone-template)# softkeys hold hard-ware based conferencing only and require the
Join Newcall Resume Select
appropriate DSP farm configuration.
• The number and order of soft key keywords you enter
in this command correspond to the number and order of
soft keys on your phone.
Step 9 softkeys idle {[Cfwdall] [ConfList] [Dnd] Configures an ephone template for soft-key display during
[Gpickup] [HLog] [Join] [Login] [Newcall] the idle call stage.
[Pickup] [Redial] [RmLstC]}
• The soft keys used for multi-party conferencing are
RmLstC, ConfList, and Join. These soft keys are
Example: supported for hard-ware based conferencing only and
Router(config-ephone-template)# softkeys idle
require the appropriate DSP farm configuration.
ConfList Gpickup Join Login Newcall Pickup
Redial RmLstC • The number and order of soft key keywords you enter
in this command correspond to the number and order of
soft keys on your phone.
Step 10 softkeys seized {[CallBack] [Cfwdall] [Endcall] (Optional) Configures an ephone template for soft-key
[Gpickup] [HLog] [MeetMe] [Pickup] [Redial]} display during the seized call stage.
• You must configure the MeetMe soft key in the seized
Example: state for the ephone to initiate a meet-me conference.
Router(config-ephone-template)# softkeys seized
Redial Endcall Cfwdall Pickup Gpickup Callback • The number and order of soft key keywords you enter
Meetme in this command correspond to the number and order of
soft keys on your phone.
Step 11 exit Exits ephone-template configuration mode.
Example:
Router(config-ephone-template)# exit
Step 12 ephone phone-tag Enters ephone configuration mode to create and configure
an ephone.
Example:
Router(config)# ephone 1
Step 13 ephone-template template-tag Applies an ephone-dn template to an ephone-dn.
Note The template-tag must be the same as the
Example: template-tag in Step 3.
Router(config-ephone)# ephone-dn-template 1
Step 14 end Exits to privileged EXEC mode.
Example:
Router(config-ephone)# exit
Cisco Unified Communications Manager Express System Administrator Guide
778 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
What to Do Next
If you are finished modifying the configuration, you are ready to generate configuration files for the
phones to be connected. See “SCCP: Generating Configuration Files for SCCP Phones” on page 263.
SCCP: Verifying Multi-Party Ad Hoc and Meet-Me Conferencing
Use the following show commands to verify multi-party ad hoc and meet-me conferencing:
• show ephone-dn conference—Displays information about ad hoc and meet-me conferences.
• show telephony-service conference hardware—Displays information about hardware-based
conferences.
show ephone-dn conference: Example
type active inactive numbers
=======================================
Meetme 0 8 2345
DN tags: 9, 10, 11, 12
Ad-hoc 0 8 A001
DN tags: 13, 14, 15, 16
Meetme 0 8 1234
DN tags: 20, 21, 22, 23
show telephony-service conference hardware detail: Example
Conference Type Active Max Peak Master MasterPhone Last
cur(initial)
==================================================================
8889 Ad-hoc 3 8 3 8044 29 ( 29) 8012
Conference parties:
8012
8006
8044
SCCP: Configuring Meet-Me Conferencing in Cisco CME 3.2 to
Cisco Unified CME 4.0
Refer to the “Examples” section on page 781 to configure Meet-Me Conferencing on a Cisco router with
Cisco CME 3.2 or a later version and Cisco Unity Express.
Note To configure Meet-Me Conferencing in Cisco Unified CME 4.1 or a later version, see the “SCCP:
Configuring Multi-Party Ad Hoc and Meet-Me Conferencing in Cisco Unified CME 4.1 and Later
Versions” section on page 765
Prerequisites
• Cisco CME 3.2 to Cisco Unified CME 4.0.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 779
Configuring Conferencing
How to Configure Conferencing
• A dual VWIC-2MFT-T1 or E-1 loopback for internal callers. The number of VWIC-2MFT-T1 cards
required depends on the number of local IP phones parties that need to dial into the meet-me
conference. Each VWIC-2MFT-T1 card can support 24 local IP phone parties.
• Packet Voice DSP Modules (PVDM DSPs) to handle the number of callers in conference. A
maximum of 96 conference parties is supported using an approved platform, such as a Cisco 3800
router, with at least two PVDM2-64DSPs installed.
• Your IP network is operational and you can access Cisco web.
• You have a valid Cisco.com account.
• The recommended Cisco IOS release and Cisco Unified CME phone firmware and GUI files to
support Cisco Unity Express are installed on the Cisco Unified CME router.
To determine whether the Cisco IOS software release and Cisco Unified CME software version are
compatible with the Cisco Unity Express version, Cisco router model, and Cisco Unity Express
hardware that you are using, see the Cisco Unity Express Compatibility Matrix.
To verify installed Cisco Unity Express software version, enter the Cisco Unity Express command
environment and use the show software version user EXEC command. For information about the
command environment, see the appropriate Cisco Unity Express CLI Administrator Guide at
http://www.cisco.com/en/US/docs/voice_ip_comm/unity_exp/roadmap/cuedocs.html.
• The proper Cisco Unity Express license for Cisco Unified CME, not Cisco Unified Communications
Manager, is installed. To verify installed license, enter the Cisco Unity Express command
environment and use the show software license user EXEC command. For information about the
command environment, see the appropriate Cisco Unity Express CLI Administrator Guide at
http://www.cisco.com/en/US/docs/voice_ip_comm/unity_exp/roadmap/cuedocs.html.
This is an example of the Cisco Unified CME license:
se-10-0-0-0> show software licenses
Core:
- application mode: CCME
- total usable system ports: 8
Voicemail/Auto Attendant:
- max system mailbox capacity time: 6000
- max general delivery mailboxes: 15
- max personal mailboxes: 50
Languages:
- max installed languages: 1
- max enabled languages: 1
• Calls can be successfully completed between phones on the same Cisco Unified CME router.
• Dial plan for Meet-Me Conferencing is defined. For information, see “Dial Plan” section on
page 759.
Restrictions
• The number of meet-me conferences and parties per conference is limited by the number of DSP
resources and number of voice ports available to handle callers.
• There is no set maximum for the number of parties per conference. However, since only the three
loudest parties on a multicast conference can be heard, we recommend that the maximum number
of parties per conference be limited to eight.
Cisco Unified Communications Manager Express System Administrator Guide
780 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
• Only a minimal set of features are provided. Conference bridges can be accessed by any user
knowing the correct number to dial (internal or external) with no option to set a password. Callers
entering a Meet-Me conference though Cisco Unity Express auto-attendant application are
prompted to record their name for playback to all callers on the bridge. No exit tone is played when
users leave a conference, nor can a Meet-Me bridge be reserved for use at a future time or date.
Examples
The following partial output from the show running-config command shows the configuration on a
Cisco 2821 router with Cisco Unified CME and Cisco Unity Express, with comments describing the
configuration for setting up Meet-Me Conferencing.
Router# show running-config
building configuration...
.
.
.
.
.
!
!---Two T1 ports connected back-to-back to bridge VOIP to Multicast
controller T1 0/3/0
framing esf
linecode b8zs
ds0-group 1 timeslots 1 type e&m-immediate-start
ds0-group 2 timeslots 2 type e&m-immediate-start
ds0-group 3 timeslots 3 type e&m-immediate-start
ds0-group 4 timeslots 4 type e&m-immediate-start
ds0-group 5 timeslots 5 type e&m-immediate-start
ds0-group 6 timeslots 6 type e&m-immediate-start
ds0-group 7 timeslots 7 type e&m-immediate-start
ds0-group 8 timeslots 8 type e&m-immediate-start
ds0-group 9 timeslots 9 type e&m-immediate-start
ds0-group 10 timeslots 10 type e&m-immediate-start
ds0-group 11 timeslots 11 type e&m-immediate-start
ds0-group 12 timeslots 12 type e&m-immediate-start
ds0-group 13 timeslots 13 type e&m-immediate-start
ds0-group 14 timeslots 14 type e&m-immediate-start
ds0-group 15 timeslots 15 type e&m-immediate-start
ds0-group 16 timeslots 16 type e&m-immediate-start
ds0-group 17 timeslots 17 type e&m-immediate-start
ds0-group 18 timeslots 18 type e&m-immediate-start
ds0-group 19 timeslots 19 type e&m-immediate-start
ds0-group 20 timeslots 20 type e&m-immediate-start
ds0-group 21 timeslots 21 type e&m-immediate-start
ds0-group 22 timeslots 22 type e&m-immediate-start
ds0-group 23 timeslots 23 type e&m-immediate-start
ds0-group 24 timeslots 24 type e&m-immediate-start
!
controller T1 0/3/1
framing esf
clock source internal
linecode b8zs
ds0-group 1 timeslots 1 type e&m-immediate-start
ds0-group 2 timeslots 2 type e&m-immediate-start
ds0-group 3 timeslots 3 type e&m-immediate-start
ds0-group 4 timeslots 4 type e&m-immediate-start
ds0-group 5 timeslots 5 type e&m-immediate-start
ds0-group 6 timeslots 6 type e&m-immediate-start
ds0-group 7 timeslots 7 type e&m-immediate-start
ds0-group 8 timeslots 8 type e&m-immediate-start
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 781
Configuring Conferencing
How to Configure Conferencing
ds0-group 9 timeslots 9 type e&m-immediate-start
ds0-group 10 timeslots 10 type e&m-immediate-start
ds0-group 11 timeslots 11 type e&m-immediate-start
ds0-group 12 timeslots 12 type e&m-immediate-start
ds0-group 13 timeslots 13 type e&m-immediate-start
ds0-group 14 timeslots 14 type e&m-immediate-start
ds0-group 15 timeslots 15 type e&m-immediate-start
ds0-group 16 timeslots 16 type e&m-immediate-start
ds0-group 17 timeslots 17 type e&m-immediate-start
ds0-group 18 timeslots 18 type e&m-immediate-start
ds0-group 19 timeslots 19 type e&m-immediate-start
ds0-group 20 timeslots 20 type e&m-immediate-start
ds0-group 21 timeslots 21 type e&m-immediate-start
ds0-group 22 timeslots 22 type e&m-immediate-start
ds0-group 23 timeslots 23 type e&m-immediate-start
ds0-group 24 timeslots 24 type e&m-immediate-start
!
!
!
!--- Disable keepalive packet to multicast network on voice class and apply to LMR port
!
voice class permanent 1
signal timing oos restart 50000
signal timing oos timeout disabled
signal keepalive disabled
signal sequence oos no-action
!---Loopback0 used as source for all H323 and SCCP packets generated by CME
interface Loopback0
ip address 11.1.1.1 255.255.255.255
h323-gateway voip interface
h323-gateway voip bind srcaddr 11.1.1.1
!
!---Vif1 (virtual host interface) used as source for all multicast packets generated by
CME
!
interface Vif1
ip address 192.168.11.1 255.255.255.252
ip pim dense-mode
!
interface FastEthernet0/0
no ip address
shutdown
!
!---Service-engine interface used to access Cisco Unity Express
!
interface Service-Engine0/0
ip unnumbered Vlan10
service-module ip address 192.168.1.2 255.255.255.0
service-module ip default-gateway 192.168.1.1
!
interface FastEthernet0/1
no ip address
shutdown
!
interface FastEthernet0/0/0
switchport access vlan 10
no ip address
!
interface FastEthernet0/0/1
switchport access vlan 10
no ip address
!
interface FastEthernet0/0/2
Cisco Unified Communications Manager Express System Administrator Guide
782 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
switchport access vlan 10
no ip address
!
interface FastEthernet0/0/3
switchport access vlan 10
no ip address
!
interface Vlan1
no ip address
!
!---All IP phones reside on VLAN 10
interface Vlan10
ip address 192.168.1.1 255.255.255.0
ip pim dense-mode
!
ip classless
!--- Static route to reach other devices on network
ip route 0.0.0.0 0.0.0.0 192.168.1.2
!--- Static route to reach Cisco Unity Express
ip route 192.168.1.2 255.255.255.255 Service-Engine0/0
!
ip http server
ip http path flash:
!
!
tftp-server flash:P00305000301.sbn
!
control-plane
!
!
!
!---VOIP side of the Back-to-Back T1 used for bridging VOIP to
!---Multicast (Hoot n' Holler)
!---Port 0/3/0:x connects to Port 0/3/1:x
voice-port 0/3/0:1
auto-cut-through
!
voice-port 0/3/0:2
auto-cut-through
!
.
.
.
!
voice-port 0/3/0:24
auto-cut-through
!
!---Multicast side of the Back-to-Back T1 used for bridging VOIP to
!---Multicast (Hoot n' Holler)
!--- Port 0/3/1:1 - 8 is permanently trunked to multicast bridge A212
!--- Port 0/3/1:9 - 16 is permanently trunked to multicast bridge A213
!--- Port 0/3/1:17 - 24 is permanently trunked to multicast bridge A214
voice-port 0/3/1:1
auto-cut-through
timeouts call-disconnect 3
connection trunk A212
!
.
.
.
!
voice-port 0/3/1:9
auto-cut-through
timeouts call-disconnect 3
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 783
Configuring Conferencing
How to Configure Conferencing
connection trunk A213
!
.
.
.
!
voice-port 0/3/1:17
auto-cut-through
timeouts call-disconnect 3
connection trunk A214
.
.
.
!
!--- Analog FXO lines on port 0/2/x route incoming calls to CUE AA external extension 203
voice-port 0/2/0
connection plar opx 203
!
voice-port 0/2/1
connection plar opx 203
!
voice-port 0/2/2
connection plar opx 203
!
voice-port 0/2/3
connection plar opx 203
!
!--- LMR devices are connected to E&M ports 0/1/x. The E&M ports are permanently trunked
to multicast conference bridges. Port 0/1/0 will send and receive audio from conference
A212 and port 0/1/1 will send and receive audio from conference A213.
voice-port 0/1/0
voice-class permanent 1
lmr m-lead audio-gate-in
lmr e-lead voice
auto-cut-through
operation 4-wire
type 3
signal lmr
timeouts call-disconnect 3
connection trunk A212
!
voice-port 0/1/1
voice-class permanent 1
lmr m-lead audio-gate-in
lmr e-lead voice
auto-cut-through
operation 4-wire
type 3
signal lmr
timeouts call-disconnect 3
connection trunk A213
!
!--- Dial-peers to route extension 212 to T1 loopback, which is trunked to bridge A212
dial-peer voice 1 pots
preference 1
destination-pattern 212
port 0/3/0:1
!
.
.
.
!
dial-peer voice 8 pots
preference 8
Cisco Unified Communications Manager Express System Administrator Guide
784 OL-10663-02
Configuring Conferencing
How to Configure Conferencing
destination-pattern 212
port 0/3/0:8
!
!--- Dial-peers to route extension 213 to T1 loopback, which is trunked to bridge A213
dial-peer voice 9 pots
preference 1
destination-pattern 213
port 0/3/0:9
!
.
.
.
!
dial-peer voice 16 pots
preference 8
destination-pattern 213
port 0/3/0:16
!
!--- Dial-peers to route extension 214 to T1 loopback, which is trunked to bridge A214
dial-peer voice 17 pots
preference 1
destination-pattern 214
port 0/3/0:17
!
.
.
.
!
dial-peer voice 24 pots
preference 8
destination-pattern 214
port 0/3/0:24
!--- Dial-peer to route calls to CUE AA for internal ext. 202 and external ext. 203
dial-peer voice 200 voip
destination-pattern 20.
session protocol sipv2
session target ipv4:192.168.1.2
dtmf-relay sip-notify
codec g711ulaw
no vad
!
!--- Dial-peers for multicast bridges
dial-peer voice 212 voip
destination-pattern A212
voice-class permanent 1
session protocol multicast
session target ipv4:237.111.0.0:22222
dtmf-relay cisco-rtp
codec g711ulaw
vad aggressive
!
dial-peer voice 213 voip
destination-pattern A213
voice-class permanent 1
session protocol multicast
session target ipv4:237.111.0.1:22222
dtmf-relay cisco-rtp
codec g711ulaw
vad aggressive
!
dial-peer voice 214 voip
destination-pattern A214
voice-class permanent 1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 785
Configuring Conferencing
How to Configure Conferencing
session protocol multicast
session target ipv4:237.111.0.2:22222
dtmf-relay cisco-rtp
codec g711ulaw
vad aggressive
!
telephony-service
load 7960-7940 P00305000301
max-ephones 24
max-dn 144
ip source-address 11.1.1.1 port 2000
create cnf-files version-stamp Jan 01 2002 00:00:00
voicemail 200
web admin system name cisco password cisco
max-conferences 8 gain -6
transfer-system full-consult
!
!
ephone-dn 1 dual-line
number 150
!
.
.
.
What to Do Next
Load and configure the auto-attendant script file for Meet-me Conferencing. For information about
logging into and GUI windows and menus, see the appropriate Cisco Unity Express GUI Administrator
Guide at http://www.cisco.com/en/US/docs/voice_ip_comm/unity_exp/roadmap/cuedocs.html.
Step 1 Go to the Download Software site. Download the Conference Express TCL and AA voice files
(conf-express.zip). Unzip the archive to a folder on your PC.
Step 2 Log into Cisco Unity Express as administrator.
Step 3 Navigate to the Voice mail> Auto Attendant menu and click Add. The Add a New Automated Attendant
window appears.
Step 4 In the Select Automated Attendant area, configure the parameters listed in the following table. Enter the
required information in the corresponding field.
.
Parameter Name Value
Select Automated Attendant Script mp-exp.aef
Application Name (lower case) conference-express
Destination file name mp-exp.aef
Step 5 Click Next. The Upload window appears.
Step 6 Upload the script (mp-exp.aef) from your PC to the auto-attendant application. For information, see
online help.
Step 7 On the Add a New Automated Attendant window, configure parameters with numbers as defined in your
dial plan and with the values listed in following table. Enter the required information in the
corresponding field. For dial plan information, see the “Dial Plan” section on page 759.
Cisco Unified Communications Manager Express System Administrator Guide
786 OL-10663-02
Configuring Conferencing
Configuration Examples for Conferencing
Field Name Value
Script Parameters
BridgeDir bridge.wav
record_name record_name.wav
SystemProblems SystemProblems.wav
Call Handling
Call-in Number InternalNumber as defined in dial plan
Maximum Sessions 4
Step 8 Click Finish.
Step 9 Navigate to the Administration>Call-In Numbers menu and click Add.
Step 10 On the Add a Call-In Number window, configure the parameters listed in the following table. Enter the
required information in the corresponding field.
Field Name Value
Application conference-express
Call-in Number ExternalNumber as defined in dial plan
Maximum Sessions 4
Step 11 Click Add.
Step 12 Confirm that two call-in numbers for the conference-express application are enabled on the
Administration>Call-In Numbers window.
Configuration Examples for Conferencing
This section provides the following configuration examples:
• Basic Conferencing: Example, page 787
• End of Conference Options: Example, page 788
• DSP Farm and Cisco Unified CME on the Same Router: Example, page 789
• DSP Farm and Cisco Unified CME on Different Routers: Example, page 793
Basic Conferencing: Example
The following example sets the maximum number of conferences for a Cisco Unified IP phone to 4 and
configures a gain of 6 db for inbound audio packets from remote PSTN or VoIP calls joining a
conference:
telephony-service
max-conferences 4 gain 6
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 787
Configuring Conferencing
Configuration Examples for Conferencing
End of Conference Options: Example
In the following example, extension 3555 initiates a three-way conference. After the conference is
established, extension 3555 can press the Confrn soft key to disconnect the last party that was connected
and remain connected to the first party that was connected. If extension 3555 hangs up from the
conference, the other two parties remain connected if one of them is local to the Cisco Unified CME
system.
ephone-dn 35
number 3555
ephone 24
button 1:35
keep-conference drop-last local-only
In the following example, extension 3666 initiates a three-way conference. After the conference is
established, extension 3666 can press the Confrn soft key to disconnect the last party that was connected
and remain connected to the first party that was connected. Also, extension 3666 can hang up or press
the EndCall soft key to leave the conference and keep the other two parties connected.
ephone-dn 36
number 3666
ephone 25
button 1:36
keep-conference drop-last endcall
In the following example, extension 3777 initiates a three-way conference. After the conference is
established, extension 3777 can press the Confrn soft key to disconnect the last party that was connected
and remain connected to the first party that was connected. Also, extension 3777 can hang up or press
the EndCall soft key to leave the conference and keep the other two parties connected only if one of the
two parties is local to the Cisco Unified CME system.
ephone-dn 38
number 3777
ephone 27
button 1:38
keep-conference drop-last endcall local-only
In the following example, extension 3999 initiates a three-way conference. After the conference is
established, extension 3999 can hang up or press the EndCall soft key to leave the conference and keep
the other two parties connected only if one of the two parties is local to the Cisco Unified CME system.
Extension 3999 can also use the Confrn soft key to break up the conference but stay connected to both
parties.
ephone-dn 39
number 3999
ephone 29
button 1:39
keep-conference endcall local-only
Cisco Unified Communications Manager Express System Administrator Guide
788 OL-10663-02
Configuring Conferencing
Configuration Examples for Conferencing
DSP Farm and Cisco Unified CME on the Same Router: Example
In this example, the DSP farm and Cisco Unified CME are on the same router as shown in Figure 26.
Figure 26 CME and the DSP Farm on the Same Router
IP
Cisco Unified CME
DSP farm SIP
WAN
LAN
SCCP FXS VG224 H323 FXS
SCCP
IP
PSTN
IPC
170540
IP link
Current configuration : 16345 bytes
!
version 12.4
service timestamps debug datetime msec
service timestamps log uptime
no service password-encryption
service internal
!
hostname cmedsprtr
!
boot-start-marker
boot-end-marker
!
logging buffered 90000 debugging
!
no aaa new-model
!
resource policy
!
no network-clock-participate slot 1
no network-clock-participate wic 0
ip cef
!
!
ip dhcp pool phone1
host 10.4.188.66 255.255.0.0
client-identifier 0100.0ab7.b144.4a
default-router 10.4.188.65
option 150 ip 10.4.188.65
!
ip dhcp pool phone2
host 1.4.188.67 255.255.0.0
client-identifier 0100.3094.c269.35
default-router 10.4.188.65
option 150 ip 10.4.188.65
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 789
Configuring Conferencing
Configuration Examples for Conferencing
!
voice-card 1
dsp services dspfarm
!
!
voice call send-alert
voice call carrier capacity active
!
voice service voip
allow-connections h323 to h323
supplementary-service h450.12
h323
!
!
!
!
controller E1 1/0
framing NO-CRC4
!
controller E1 1/1
!
!
interface FastEthernet0/0
ip address 10.4.188.65 255.255.0.0
duplex auto
speed auto
no keepalive
no cdp enable
no clns route-cache
!
interface FastEthernet0/1
no ip address
shutdown
duplex auto
speed auto
no clns route-cache
!
ip route 10.4.0.0 255.255.0.0 FastEthernet0/0
ip route 192.168.254.254 255.255.255.255 10.4.0.1
!
ip http server
!
!
control-plane
!
!
sccp local FastEthernet0/0
sccp ccm 10.4.188.65 identifier 1 version 4.0
sccp
!
sccp ccm group 123
associate ccm 1 priority 1
associate profile 1 register mtp00097c5e9ce0
keepalive retries 5
!
!
dspfarm profile 1 conference
codec g711ulaw
codec g711alaw
codec g729ar8
codec g729abr8
codec g729r8
codec g729br8
maximum sessions 6
Cisco Unified Communications Manager Express System Administrator Guide
790 OL-10663-02
Configuring Conferencing
Configuration Examples for Conferencing
associate application SCCP
!
dial-peer cor custom
!
!
!
dial-peer voice 6 voip
destination-pattern 6...
session target ipv4:10.4.188.90
!
telephony-service
conference hardware
load 7960-7940 P00307020400
load 7905 CP7905060100SCCP050309A.sbin
max-ephones 48
max-dn 180
ip source-address 10.4.188.65 port 2000
timeouts ringing 500
system message MY MELODY (2611)
sdspfarm units 4
sdspfarm tag 1 mtp00097c5e9ce0
max-conferences 4 gain -6
call-forward pattern ....
transfer-system full-consult
transfer-pattern 7...
transfer-pattern ....
create cnf-files version-stamp Jan 01 2002 00:00:00
!
!
ephone-template 1
softkeys hold Newcall Resume Select Join
softkeys idle Cfwdall ConfList Dnd Gpickup HLog Join Login Newcall Pickup Redial RmLstC
softkeys seized Redial Pickup Gpickup HLog Meetme Endcall
softkeys connected Acct ConfList Confrn Endcall Flash HLog Hold Join Park RmLstC Select
Trnsfer
!
!
ephone-dn 1 dual-line
number 8001
name melody-8001
!
!
ephone-dn 2 dual-line
number 8002
!
!
ephone-dn 3 dual-line
number 8003
!
!
ephone-dn 4 dual-line
number 8004
!
!
ephone-dn 5 dual-line
number 8005
!
!
ephone-dn 6 dual-line
number 8006
!
!
ephone-dn 7 dual-line
number 8007
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 791
Configuring Conferencing
Configuration Examples for Conferencing
!
!
ephone-dn 8 dual-line
number 8008
!
!
ephone-dn 60 dual-line
number 8887
conference meetme
no huntstop
!
!
ephone-dn 61 dual-line
number 8887
conference meetme
preference 1
no huntstop
!
!
ephone-dn 62 dual-line
number 8887
conference meetme
preference 2
no huntstop
!
!
ephone-dn 63 dual-line
number 8887
conference meetme
preference 3
!
!
ephone-dn 64 dual-line
number 8889
name Conference
conference ad-hoc
no huntstop
!
!
ephone-dn 65 dual-line
number 8889
name Conference
conference ad-hoc
preference 1
no huntstop
!
!
ephone-dn 66 dual-line
number 8889
name Conference
conference ad-hoc
preference 2
no huntstop
!
!
ephone-dn 67 dual-line
number 8889
name Conference
conference ad-hoc
preference 3
!
!
ephone 1
ephone-template 1
Cisco Unified Communications Manager Express System Administrator Guide
792 OL-10663-02
Configuring Conferencing
Configuration Examples for Conferencing
mac-address 0030.94C2.6935
type 7960
button 1:1 2:2
!
!
ephone 2
ephone-template 1
mac-address 000A.B7B1.444A
type 7940
button 1:4 2:8
!
line con 0
exec-timeout 0 0
line aux 0
exec-timeout 0 0
line vty 0 4
exec-timeout 0 0
login
line vty 5 15
login
!
!
end
DSP Farm and Cisco Unified CME on Different Routers: Example
In this example, the DSP farm and Cisco Unified CME are on different routers as shown in Figure 27.
Figure 27 Cisco Unified CME and the DSP Farm on Different Routers
IP
Cisco Unified CME SIP
WAN
LAN
SCCP FXS VG224 H323 FXS
SCCP
IP
PSTN
IPC
PSTN call
IP link
170541
DSP farm
This section contains configuration examples for the following routers:
• Cisco Unified CME Router Configuration: Example, page 794
• DSP Farm Router Configuration: Example, page 800
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 793
Configuring Conferencing
Configuration Examples for Conferencing
Cisco Unified CME Router Configuration: Example
Current configuration : 5659 bytes
!
version 12.4
no service timestamps debug uptime
no service timestamps log uptime
no service password-encryption
!
boot-start-marker
boot-end-marker
!
!
card type command needed for slot 1
logging buffered 3000000 debugging
!
no aaa new-model
!
resource policy
!
no network-clock-participate slot 1
no network-clock-participate aim 0
!
voice-card 1
no dspfarm
!
voice-card 3
dspfarm
!
ip cef
!
!
no ip dhcp use vrf connected
!
ip dhcp pool IPPhones
network 10.15.15.0 255.255.255.0
option 150 ip 10.15.15.1
default-router 10.15.15.1
!
!
interface FastEthernet0/0
ip address 10.3.111.102 255.255.0.0
duplex auto
speed auto
!
interface FastEthernet0/1
no ip address
duplex auto
speed auto
!
interface FastEthernet0/1.1
encapsulation dot1Q 10
ip address 10.15.14.1 255.255.255.0
!
interface FastEthernet0/1.2
encapsulation dot1Q 20
ip address 10.15.15.1 255.255.255.0
!
ip route 0.0.0.0 0.0.0.0 10.5.51.1
ip route 0.0.0.0 0.0.0.0 10.3.0.1
!
ip http server
!
Cisco Unified Communications Manager Express System Administrator Guide
794 OL-10663-02
Configuring Conferencing
Configuration Examples for Conferencing
!
!
!
control-plane!
!
!
!
dial-peer voice 1 voip
destination-pattern 3...
session target ipv4:10.3.111.101
!
!
telephony-service
conference hardware
load 7910 P00403020214
load 7960-7940 P003-07-5-00
max-ephones 50
max-dn 200
ip source-address 10.15.15.1 port 2000
sdspfarm units 4
sdspfarm transcode sessions 12
sdspfarm tag 1 confer1
sdspfarm tag 4 xcode1
max-conferences 8 gain -6
moh flash:music-on-hold.au
multicast moh 239.0.0.0 port 2000
transfer-system full-consult
create cnf-files version-stamp Jan 01 2002 00:00:00
!
!
ephone-template 1
softkeys hold Resume Newcall Select Join
softkeys idle Redial Newcall ConfList RmLstC Cfwdall Join Pickup Login HLog Dnd Gpickup
softkeys seized Endcall Redial Cfwdall Meetme Pickup Callback
softkeys alerting Endcall Callback
softkeys connected Hold Endcall Confrn Trnsfer Select Join ConfList RmLstC Park Flash
!
ephone-dn 1 dual-line
number 6000
!
!
ephone-dn 2 dual-line
number 6001
!
!
ephone-dn 3 dual-line
number 6002
!
!
ephone-dn 4 dual-line
number 6003
!
!
ephone-dn 5 dual-line
number 6004
!
!
ephone-dn 6 dual-line
number 6005
!
!
ephone-dn 7 dual-line
number 6006
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 795
Configuring Conferencing
Configuration Examples for Conferencing
!
ephone-dn 8 dual-line
number 6007
!
!
ephone-dn 9 dual-line
number 6008
!
!
ephone-dn 10 dual-line
number 6009
!
!
ephone-dn 11
number 6011
!
!
ephone-dn 12
number 6012
!
!
ephone-dn 13
number 6013
!
!
ephone-dn 14
number 6014
!
!
ephone-dn 15
number 6015
!
!
ephone-dn 16
number 6016
!
!
ephone-dn 17
number 6017
!
!
ephone-dn 18
number 6018
!
!
ephone-dn 19
number 6019
!
!
ephone-dn 20
number 6020
!
!
ephone-dn 21
number 6021
!
!
ephone-dn 22
number 6022
!
!
ephone-dn 23
number 6023
!
Cisco Unified Communications Manager Express System Administrator Guide
796 OL-10663-02
Configuring Conferencing
Configuration Examples for Conferencing
!
ephone-dn 24
number 6024
!
!
ephone-dn 25 dual-line
number 6666
conference meetme
preference 1
no huntstop
!
!
ephone-dn 26 dual-line
number 6666
conference meetme
preference 2
no huntstop
!
!
ephone-dn 27 dual-line
number 6666
conference meetme
preference 3
no huntstop
!
!
ephone-dn 28 dual-line
number 6666
conference meetme
preference 4
no huntstop
!
!
ephone-dn 29 dual-line
number 8888
conference meetme
preference 1
no huntstop
!
!
ephone-dn 30 dual-line
number 8888
conference meetme
preference 2
no huntstop
!
!
ephone-dn 31 dual-line
number 8888
conference meetme
preference 3
no huntstop
!
!
ephone-dn 32 dual-line
number 8888
conference meetme
preference 4
!
!
ephone-dn 33
number 6033
!
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 797
Configuring Conferencing
Configuration Examples for Conferencing
ephone-dn 34
number 6034
!
!
ephone-dn 35
number 6035
!
!
ephone-dn 36
number 6036
!
!
ephone-dn 37
number 6037
!
!
ephone-dn 38
number 6038
!
!
ephone-dn 39
number 6039
!
!
ephone-dn 40
number 6040
!
!
ephone-dn 41 dual-line
number 6666
conference meetme
preference 5
no huntstop
!
!
ephone-dn 42 dual-line
number 6666
conference meetme
preference 6
no huntstop
!
!
ephone-dn 43 dual-line
number 6666
conference meetme
preference 7
no huntstop
!
!
ephone-dn 44 dual-line
number 6666
conference meetme
preference 8
no huntstop
!
!
ephone-dn 45 dual-line
number 6666
conference meetme
preference 9
no huntstop
!
!
ephone-dn 46 dual-line
Cisco Unified Communications Manager Express System Administrator Guide
798 OL-10663-02
Configuring Conferencing
Configuration Examples for Conferencing
number 6666
conference meetme
preference 10
no huntstop
!
!
ephone-dn 47 dual-line
number 6666
conference meetme
preference 10
no huntstop
!
!
ephone-dn 48 dual-line
number 6666
conference meetme
preference 10
!
!
ephone-dn 51 dual-line
number A0001
name conference
conference ad-hoc
preference 1
no huntstop
!
!
ephone-dn 52 dual-line
number A0001
name conference
conference ad-hoc
preference 2
no huntstop
!
!
ephone-dn 53 dual-line
number A0001
name conference
conference ad-hoc
preference 3
no huntstop
!
!
ephone-dn 54 dual-line
number A0001
name conference
conference ad-hoc
preference 4
!
!
ephone 1
ephone-template 1
mac-address C863.B965.2401
type anl
button 1:1
!
!
!
ephone 2
ephone-template 1
mac-address 0016.C8BE.A04A
type 7920
!
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 799
Configuring Conferencing
Configuration Examples for Conferencing
!
ephone 3
ephone-template 1
mac-address C863.B965.2400
type anl
button 1:2
!
!
!
ephone 4
no multicast-moh
ephone-template 1
mac-address 0017.952B.7F5C
type 7912
button 1:4
!
!
!
ephone 5
ephone-template 1
ephone 6
no multicast-moh
ephone-template 1
mac-address 0017.594F.1468
type 7961GE
button 1:6
!
!
!
ephone 11
ephone-template 1
mac-address 0016.C8AA.C48C
button 1:10 2:15 3:16 4:17
button 5:18 6:19 7:20 8:21
button 9:22 10:23 11:24 12:33
button 13:34 14:35 15:36 16:37
button 17:38 18:39 19:40
!
!
line con 0
line aux 0
line vty 0 4
login
!
!
end
DSP Farm Router Configuration: Example
Current configuration : 2179 bytes
!
! Last configuration change at 05:47:23 UTC Wed Jul 12 2006
!
version 12.4
service timestamps debug datetime msec localtime
no service timestamps log uptime
no service password-encryption
hostname dspfarmrouter
!
boot-start-marker
boot-end-marker
!
Cisco Unified Communications Manager Express System Administrator Guide
800 OL-10663-02
Configuring Conferencing
Configuration Examples for Conferencing
!
card type command needed for slot 1
logging buffered 4096 debugging
enable password lab
!
no aaa new-model
!
resource policy
!
no network-clock-participate slot 1
!
!
ip cef
!
!
no ip domain lookup
!
!
voice-card 0
no dspfarm
!
voice-card 1
no dspfarm
dsp services dspfarm
interface GigabitEthernet0/0
ip address 10.3.111.100 255.255.0.0
duplex auto
speed auto
!
interface GigabitEthernet0/1.1
encapsulation dot1Q 100
ip address 192.168.1.10 255.255.255.0
!
interface GigabitEthernet0/1.2
encapsulation dot1Q 200
ip address 192.168.2.10 255.255.255.0
!
interface GigabitEthernet0/1.3
encapsulation dot1Q 10
ip address 10.15.14.10 255.255.255.0
!
interface GigabitEthernet0/1.4
encapsulation dot1Q 20
ip address 10.15.15.10 255.255.255.0
!
ip route 10.0.0.0 255.0.0.0 10.3.0.1
ip route 192.168.0.0 255.0.0.0 10.3.0.1
!
!
ip http server
!
!
!
!
control-plane
!
sccp local GigabitEthernet0/0
sccp ccm 10.15.15.1 identifier 1 version 4.1
!
!
sccp ccm group 1
associate ccm 1 priority 1
associate profile 101 register confer1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 801
Configuring Conferencing
Where to Go Next
associate profile 103 register xcode1
!
!
dspfarm profile 103 transcode
codec g711ulaw
codec g711alaw
codec g729r8
maximum sessions 6
associate application SCCP
!
dspfarm profile 101 conference
codec g711ulaw
codec g711alaw
codec g729r8
maximum sessions 5
associate application SCCP
!
!
!
!
line con 0
exec-timeout 0 0
line aux 0
line vty 0 4
session-timeout 300
exec-timeout 0 0
password
no login
!
scheduler allocate 20000 1000
!
end
Where to Go Next
Controlling Use of the Conference Soft Key
To block the functioning of the conference (Confrn) soft key without removing the key display, create
and apply an ephone template that contains the features blocked command. For more information, see
“Creating Templates” on page 1129.
To remove the conference (Confrn) soft key from one or more phones, create and apply an ephone
template that contains the appropriate softkeys command. For more information, see “Customizing Soft
Keys” on page 1047.
Cisco Unified Communications Manager Express System Administrator Guide
802 OL-10663-02
Configuring Conferencing
Additional References
Additional References
The following sections provide references related to conferencing.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 803
Configuring Conferencing
Feature Information for Conferencing
Feature Information for Conferencing
Table 15 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 15 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 15 Feature Information for Conferencing
Cisco Unified CME
Feature Name Version Feature Information
Meet-me Conferences 4.1 Added support for hardware-based meet-me conferences
created by parties calling a designated conference number.
Multi-party Ad Hoc Conferencing 4.1 Added support for hardware-based Multi-party
Conferencing Enhancements which uses DSPs to enhance
ad hoc conferencing by allowing more parties than
software-based ad hoc conferencing. Configuring
multi-party ad hoc conferencing disables three-party ad
hoc conferencing.
Three-Party Ad Hoc Conferencing 4.0 • End-of-conference options were introduced.
• Phones connected in a three-way conference display
“Conference.”
3.2.2 Conference gain control for external calls was introduced.
3.2 Conference initiator drop-off control was introduced.
2.0 Support for software-based conferencing was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
804 OL-10663-02
Configuring Directory Services
Last Updated: April 15, 2009
This chapter describes the directory services support available in Cisco Unified Communications
Manager Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Directory Services”
section on page 824.
Contents
• Information About Directory Services, page 805
• How to Configure Directory Services, page 807
• Configuration Examples for Directory Services, page 818
• Additional References, page 823
• Feature Information for Directory Services, page 824
Information About Directory Services
To enable directory services, you should understand the following concepts:
• Local Directory, page 806
• External Directory, page 806
• Called-Name Display, page 806
• Directory Search, page 806
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 805
Configuring Directory Services
Information About Directory Services
Local Directory
Cisco Unified CME automatically creates a local phone directory containing the telephone numbers that
are assigned in the directory number configuration of the phone. You can make additional entries to the
local directory in telephony services configuration mode. Additional entries can be nonlocal numbers
such as telephone numbers on other Cisco Unified CME systems used by your company.
When a phone user selects the Directories > Local Directory menu, the phone displays a search page
from Cisco Unified CME. After a user enters the search information, the phone sends the information to
Cisco Unified CME, which searches for the requested number or name pattern in the directory number
configuration and sends the response back to the phone, which displays the matched results. The phone
can display up to 32 directory entries. If a search results in more than 32 entries, the phone displays an
error message and the user must refine the search criteria to narrow the results.
The order of the names in the directory entries is first-name-first or last-name-first. Character strings for
directory names can contain a spaces and a comma (,) and cannot contain an ampersand (&).
The local directory that is displayed on an IP phone is an XML page that is accessed through HTTP
without password protection. The directory HTTP service can be disabled to suppress the availability of
the local directory.
For configuration information, see the “Configuring Local Directory Service” section on page 807.
External Directory
Cisco Unified IP Phones can support URLs in association with the four programmable feature buttons
on IP phones, including the Directories button. Operation of these services is determined by the Cisco
Unified IP phone capabilities and the content of the referenced URL. Provisioning the directory URL to
select an external directory resource disables the Cisco Unified CME local directory service.
Called-Name Display
When phone agents answer calls for several different departments or people, it is often helpful for them
to see a display of the name, rather than the number, of the called party. For example, if order-entry
agents are servicing three catalogs with individual 800 numbers configured in one overlay ephone-dn
set, they need to know which catalog is being called to give the correct greeting, such as “Thank you for
calling catalog N. May I take your order?” The called-name display feature can display either of the
following types of name:
• Name for a directory number in a local directory
• Name associated with an overlay directory number. Calls to the first directory number in a set of
overlay numbers will display a caller ID. Calls to the remaining directory numbers in the overlay
set will display the name associated with the directory number.
Directory Search
Cisco Unified CME 4.3 increases the number of entries supported in a search results list from 32 to up
to 240 when using the directory search feature. For example, if a user enters “smith” as the last name,
all 240 matches are displayed on eight different pages, with 30 entries per page. If multiple pages are
Cisco Unified Communications Manager Express System Administrator Guide
806 OL-10663-02
Configuring Directory Services
How to Configure Directory Services
required, the phone displays two new soft keys, “Next” and “Prev” that the phone user can press to move
back and forth between the previous and next pages. Text such as “Page 2 of 3" displays to indicate the
current and total pages on the search results.
How to Configure Directory Services
This section contains the following tasks:
• Configuring Local Directory Service, page 807
• SCCP: Defining a Name for a Directory Number, page 808
• SCCP: Adding an Entry to a Local Directory, page 809
• SCCP: Configuring External Directory Service, page 810
• SCCP: Enabling Called-Name Display, page 813
• Verifying Called-Name Display, page 814
• SIP: Defining a Name for a Directory Number, page 815
• SIP: Configuring External Directory Service, page 816
• Verifying Directory Services, page 817
Configuring Local Directory Service
To define the format for local directory names or block the local directory display on all phones, perform
the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. directory {first-name-first | last-name-first}
5. no service local-directory
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 807
Configuring Directory Services
How to Configure Directory Services
Command or Action Purpose
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 directory {first-name-first | Defines the format for entries in the local directory.
last-name-first}
• Default is first-name-first.
Example:
Router(config-telephony)# directory
last-name-first
Step 5 no service local-directory Disables local directory service on IP phones.
Example:
Router(config-telephony)# no service
local-directory
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
SCCP: Defining a Name for a Directory Number
To define a name to be used for caller-ID displays and as a local directory entry, perform the following
steps.
Prerequisites
• Cisco CME 3.0 or a later version.
• Directory number for which you are defining a directory entry must already have a number assigned
by using the number (ephone- dn) command. For configuration information, see “SCCP: Creating
Directory Numbers” on page 158.
Restrictions
• The name to be associated with a directory number cannot contain special characters, such as an
ampersand (&). The only special characters allowed in the name are the comma (,) and the percent
sign (%).
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
4. name name
5. end
Cisco Unified Communications Manager Express System Administrator Guide
808 OL-10663-02
Configuring Directory Services
How to Configure Directory Services
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode.
Example:
Router(config)# ephone-dn 55
Step 4 name name Associates a name with this directory number.
• Must follow the name order that is specified with the
Example: directory command: first-name-first or
Router(config-ephone-dn)# name Smith, John last-name-first.
or
Router(config-ephone-dn)# name Shipping and • name—Alphanumeric string to be displayed.
Handling
– You must separate the two parts, first last or
last first, of the name string with a space.
– The second part of the name string can contain
spaces, such as “and Shipping.” The first part of
the name string cannot contain spaces.
– You can include a comma (,) in the name string for
display purposes, for example, when you use the
last-name-first pattern (last, first).
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
SCCP: Adding an Entry to a Local Directory
To add an entry to the local directory, perform the following steps.
Restrictions
• If the directory entry being configured is to be used for called-name display, the number being
configured must contain at least one wildcard character.
• Entry for local directory cannot include opening or closing quotation marks (‘, ‘, “, or ”).
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 809
Configuring Directory Services
How to Configure Directory Services
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. directory entry {directory-tag number name name | clear}
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 directory entry {directory-tag number Creates a telephone directory entry that is displayed on an IP
name name | clear} phone. Entries appear in the order in which they are entered.
• directory-tag—Unique sequence number that identifies this
Example: directory entry during all configuration tasks. Range is
Router(config-telephony)# directory entry 1 to 250.
1 5550111 name Sales
• If this name is to be used for called-name display, the number
associated with the names must contain at least one wildcard
character.
• name—1 to 24 alphanumeric characters, including spaces.
Name cannot include opening or closing quotation marks (‘,
’ , “, or ”).
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
SCCP: Configuring External Directory Service
To enable an external directory resource on supported Cisco Unified IP phones and disable local
directory services on those same phones, perform the following steps.
Cisco Unified Communications Manager Express System Administrator Guide
810 OL-10663-02
Configuring Directory Services
How to Configure Directory Services
Prerequisites
To use a Cisco Unified Communications Manager directory as an external directory source for Cisco
Unified CME phones, the Cisco Unified Communications Manager must be made aware of the phones.
You must list the MAC addresses of the Cisco Unified CME phones in the Cisco Unified
Communications Manager and reset the phones from the Cisco Unified Communications Manager. It is
not necessary for you to assign ephone-dns to the phones or for the phones to register with Cisco Unified
Communications Manager.
Restrictions
Provisioning of the directory URL to select an external directory resource disables the
Cisco Unified CME local directory service.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony -service
4. url directories url
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 811
Configuring Directory Services
How to Configure Directory Services
Command or Action Purpose
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 url directories url Associates a URL with the programmable Directories
feature button on supported Cisco Unified IP phones in
Cisco Unified CME.
Example:
Router(config-telephony)# url directories • Provisioning the directories URL to select an external
http://10.0.0.11/localdirectory directory resource disables the Cisco Unified CME
local directory service.
• Operation of these services is determined by the
Cisco Unified IP phone capabilities and the content of
the specified URL.
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-telephony)# end
Cisco Unified Communications Manager Express System Administrator Guide
812 OL-10663-02
Configuring Directory Services
How to Configure Directory Services
SCCP: Enabling Called-Name Display
To enable called-name display, perform the following steps.
Prerequisites
• For directory numbers other than overlaid directory numbers—To display a name in the called-name
display, the name to be displayed must be defined in the local directory. See the “SCCP: Adding an
Entry to a Local Directory” section on page 809.
• For overlaid directory numbers—To display a name in the called-name display for a directory
number that is in a set of overlaid directory numbers, the name to be displayed must be defined. See
the “SCCP: Defining a Name for a Directory Number” section on page 808
Restrictions
• The service dnis overlay command can only be used to configure overlaid ephone-dns.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. service dnis dir-lookup
5. service dnis overlay
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)#
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 813
Configuring Directory Services
How to Configure Directory Services
Command or Action Purpose
Step 4 service dnis dir-lookup Specifies that incoming calls to a called number should display
the name that was defined for this directory number with the
directory entry command.
Example:
Router(config-telephony)# service dnis • If the service dnis dir-lookup and service dnis overlay
dir-lookup commands are both used in one configuration, the service
dnis dir-lookup command takes precedence.
Step 5 service dnis overlay (For overlaid directory numbers only.) Specifies that incoming
calls to a called number should display the name that was defined
for this directory number with the name command.
Example:
Router(config-telephony)# service dnis Note If the service dnis dir-lookup and service dnis overlay
overlay commands are both used in one configuration, the service
dnis dir-lookup command takes precedence.
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Verifying Called-Name Display
Step 1 Use the show running-config command to verify your configuration. Called-name display is shown in
the telephony-service part of the output.
Router# show running-config
telephony-service
service dnis overlay
Step 2 Use the show telephony-service directory-entry command to display current directory entries.
Router# show telephony-service directory-entry
directory entry 1 5550341 name doctor1
directory entry 2 5550772 name doctor1
directory entry 3 5550263 name doctor3
Step 3 Use the show telephony-service ephone-dn command to verify that you have used at least one wildcard
(period or .) in the ephone-dn primary or secondary number or to verify that you have entered a name
for the number.
Router# show telephony-service ephone-dn
ephone-dn 2
number 5002 secondary 200.
name catalogN
huntstop
call-forward noan 5001 timeout 8
Step 4 Use the show ephone overlay command to verify the contents of overlaid ephone-dn sets.
Router# show ephone overlay
ephone-1 Mac:0007.0EA6.353A TCP socket:[1] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0
Cisco Unified Communications Manager Express System Administrator Guide
814 OL-10663-02
Configuring Directory Services
How to Configure Directory Services
IP:10.2.225.205 52486 Telecaster 7960 keepalive 2771 max_line 6
button 1: dn 11 number 60011 CH1 IDLE overlay
button 2: dn 17 number 60017 CH1 IDLE overlay
button 3: dn 24 number 60024 CH1 IDLE overlay
button 4: dn 30 number 60030 CH1 IDLE overlay
button 5: dn 36 number 60036 CH1 IDLE CH2 IDLE overlay
button 6: dn 39 number 60039 CH1 IDLE CH2 IDLE overlay
overlay 1: 11(60011) 12(60012) 13(60013) 14(60014) 15(60015) 16(60016)
overlay 2: 17(60017) 18(60018) 19(60019) 20(60020) 21(60021) 22(60022)
overlay 3: 23(60023) 24(60024) 25(60025) 26(60026) 27(60027) 28(60028)
overlay 4: 29(60029) 30(60030) 31(60031) 32(60032) 33(60033) 34(60034)
overlay 5: 35(60035) 36(60036) 37(60037)
overlay 6: 38(60038) 39(60039) 40(60040
SIP: Defining a Name for a Directory Number
To define name for a directory number on a SIP phone, perform the following steps.
Prerequisites
• Cisco CME 3.4 or a later version.
• Directory number for which you are defining a name must already have a number assigned by using
the number (voice register dn) command. For configuration information, see “SIP: Creating
Directory Numbers” on page 169.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register dn dn-tag
4. name name
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 815
Configuring Directory Services
How to Configure Directory Services
Command or Action Purpose
Step 3 voice register dn dn-tag Enters voice register dn configuration mode to define a
directory number for a SIP phone, intercom line, voice port,
or a message-waiting indicator (MWI).
Example:
Router(config-register-global)# voice register
dn 17
Step 4 name name Associates a name with a directory number in
Cisco Unified CME and provides caller ID for calls
originating from a SIP phone.
Example:
Router(config-register-dn)# name Smith, John • Name must follow the order specified by using the
or directory (telephony-service) command.
Example:
Router(config-register-dn)# name John Smith
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-dn)# end
SIP: Configuring External Directory Service
To enable an external directory resource on supported Cisco Unified IP phones and disable local
directory services on those same phones, perform the following steps.
Prerequisites
Cisco CME 3.4 or a later version.
Restrictions
• Provisioning of the directory URL to select an external directory resource disables the
Cisco Unified CME local directory service.
• Supported only on Cisco Unified IP Phone 7960s and 7960Gs and Cisco Unified IP Phone 7940s
and 7940Gs.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. url directory url
5. end
Cisco Unified Communications Manager Express System Administrator Guide
816 OL-10663-02
Configuring Directory Services
How to Configure Directory Services
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Step 4 url {directory url Associates a URL with the programmable Directories
feature button on supported Cisco Unified IP phones in
Cisco Unified CME.
Example:
Router(config-register-global)# url directory • Provisioning the directory URL to select an external
http://10.0.0.11/localdirectory directory resource disables the Cisco Unified CME
local directory service.
• Operation of these services is determined by the
Cisco Unified IP phone capabilities and the content of
the specified URL.
Step 5 end Exits to privileged EXEC mode.
Example:
Router(config-register-global)# end
Verifying Directory Services
To verify the configuration for local directory services, perform the following steps.
SUMMARY STEPS
1. show running-config
2. show telephony-service
3. show telephony-service directory-entry
DETAILED STEPS
Step 1 show running-config
This command displays the running configuration. Directory configuration commands are listed in the
telephony-service portion of the output.
Router# show running-config
.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 817
Configuring Directory Services
Configuration Examples for Directory Services
.
.
timeout busy 10
timeout ringing 100
caller-id name-only: enable
system message XYZ Company
web admin system name admin1 password admin1
web admin customer name Customer
edit DN through Web: enabled.
edit TIME through web: enabled.
Log (table parameters):
max-size: 150
retain-timer: 15
create cnf-files version-stamp Jan 01 2002 00:00:00
transfer-system full-consult
multicast moh 239.12.20.123 port 2000
fxo hook-flash
local directory service: enabled.
Step 2 show telephony-service
This command displays only the telephony-service configuration information.
Step 3 Use the show telephony-service directory-entry command to display the entries made using the
directory entry command.
Configuration Examples for Directory Services
This section contains the following examples:
• Local Directory, page 818
• Called-Name Display, page 819
Local Directory
The following example defines the naming order for the local directory on IP phones served by the
Cisco Unified CME router:
telephony-service
directory last-name-first
The following example creates a directory of three telephone listings:
telephony-service
directory entry 1 14045550111 name Sales
directory entry 2 13125550122 name Marketing
directory entry 3 12135550144 name Support Center
The following example disables the local directory on IP phones served by the Cisco Unified CME
router:
telephony-service
no service local-directory
Cisco Unified Communications Manager Express System Administrator Guide
818 OL-10663-02
Configuring Directory Services
Configuration Examples for Directory Services
Called-Name Display
This section contains the following examples:
• First Ephone-dn in the Overlay Set: Example, page 819
• Directory Name for an Overlaid Ephone-dn Set: Example, page 819
• Directory Name for a Hunt Group with Overlaid Ephone-dns: Example, page 820
• Directory Name for Non-Overlaid Ephone-dns: Example, page 821
• Ephone-dn Name for Overlaid Ephone-dns: Example, page 822
First Ephone-dn in the Overlay Set: Example
The following example shows a configuration for three phones that use the same set of overlaid
ephone-dns for each phone’s button 1.
telephony-service
service dnis overlay
ephone-dn 1
number 18005550100
ephone-dn 2
name department1
number 18005550101
ephone-dn 3
name department2
number 18005550102
ephone 1
button 1o1,2,3
ephone 2
button 1o1,2,3
ephone 3
button 1o1,2,3
The default display for all three phones is the number of the first ephone-dn listed in the overlay set
(18005550100). A call is made to the first ephone-dn (18005550100), and the caller ID (for example,
4085550123) is displayed on all three phones. The user for phone 1 answers the call. The caller ID
(4085550123) remains displayed on phone 1, and the displays on phone 2 and phone 3 return to the
default display (18005550100). A call to the next ephone-dn is made. The default display on phone 2
and phone 3 is replaced with the called ephone-dn’s name (18005550101).
Directory Name for an Overlaid Ephone-dn Set: Example
The following is an example of a configuration of overlaid ephone-dns that uses wildcards in the
secondary numbers for the ephone-dns. The wildcards allow you to control the display according to the
number that was dialed. The example is for a medical answering service with three IP phones that accept
calls for nine doctors on one button. When a call to 5550001 rings on button 1 on ephone 1 through
ephone 3, “doctor1” is displayed on all three ephones.
telephony-service
service dnis dir-lookup
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 819
Configuring Directory Services
Configuration Examples for Directory Services
directory entry 1 5550001 name doctor1
directory entry 2 5550002 name doctor2
directory entry 3 5550003 name doctor3
directory entry 4 5550010 name doctor4
directory entry 5 5550011 name doctor5
directory entry 6 5550012 name doctor6
directory entry 7 5550020 name doctor7
directory entry 8 5550021 name doctor8
directory entry 9 5550022 name doctor9
ephone-dn 1
number 5500 secondary 555000.
ephone-dn 2
number 5501 secondary 555001.
ephone-dn 3
number 5502 secondary 555002.
ephone 1
button 1o1,2,3
mac-address 1111.1111.1111
ephone 2
button 1o1,2,3
mac-address 2222.2222.2222
ephone 3
button 1o1,2,3
mac-address 3333.3333.3333
For more information about making directory entries, see the “Local Directory” section on page 806. For
more information about overlaid ephone-dns, see “Configuring Call-Coverage Features” on page 663.
Directory Name for a Hunt Group with Overlaid Ephone-dns: Example
The following example shows a hunt-group configuration for a medical answering service with two
phones and four doctors. Each phone has two buttons, and each button is assigned two doctors’ numbers.
When a patient calls 5550341, Cisco Unified CME matches the hunt-group pilot secondary number
(555....), rings button 1 on one of the two phones, and displays “doctor1.”
telephony-service
service dnis dir-lookup
max-redirect 20
directory entry 1 5550341 name doctor1
directory entry 2 5550772 name doctor1
directory entry 3 5550263 name doctor3
directory entry 4 5550150 name doctor4
ephone-dn 1
number 1001
ephone-dn 2
number 1002
ephone-dn 3
number 1003
ephone-dn 4
number 104
Cisco Unified Communications Manager Express System Administrator Guide
820 OL-10663-02
Configuring Directory Services
Configuration Examples for Directory Services
ephone 1
button 1o1,2
button 2o3,4
mac-address 1111.1111.1111
ephone 2
button 1o1,2
button 2o3,4
mac-address 2222.2222.2222
ephone-hunt 1 peer
pilot 5100 secondary 555....
list 1001, 1002, 1003, 1004
final number 5556000
hops 5
preference 1
timeout 20
no-reg
For more information about hunt-group behavior, see “Configuring Call-Coverage Features” on
page 663. Note that wildcards are used only in secondary numbers and cannot be used with primary
numbers. For more information about making directory entries, see the “Local Directory” section on
page 806. For more information about overlaid ephone-dns, see “Configuring Call-Coverage Features”
on page 663.
Directory Name for Non-Overlaid Ephone-dns: Example
The following is a configuration for three IP phones, each with two buttons. Button 1 receives calls from
doctor1, doctor2, and doctor3, and button 2 receives calls from doctor4, doctor5, and doctor6.
telephony-service
service dnis dir-lookup
directory entry 1 5550001 name doctor1
directory entry 2 5550002 name doctor2
directory entry 3 5550003 name doctor3
directory entry 4 5550010 name doctor4
directory entry 5 5550011 name doctor5 directory entry 6 5550012 name doctor6
ephone-dn 1
number 1001 secondary 555000.
ephone-dn 2
number 1002 secondary 555001.
ephone 1
button 1:1
button 2:2
mac-address 1111.1111.1111
ephone 2
button 1:1
button 2:2
mac-address 2222.2222.2222
ephone 3
button 1:1
button 2:2
mac-address 3333.3333.3333
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 821
Configuring Directory Services
Configuration Examples for Directory Services
For more information about making directory entries, see the “Local Directory” section on page 806.
Ephone-dn Name for Overlaid Ephone-dns: Example
The following example shows three phones that have button 1 assigned to pick up three 800 numbers for
three different catalogs.
The default display for all four phones is the number of the first ephone-dn listed in the overlay set
(18005550000). A call is made to the first ephone-dn (18005550000), and the caller ID (for example,
4085550123) is displayed on all phones. The user for phone 1 answers the call. The caller ID
(4085550123) remains displayed on phone 1, and the displays on phone 2 and phone 3 return to the
default display (18005550000). A call to the second ephone-dn (18005550001) is made. The default
display on phone 2 and phone 3 is replaced with the called ephone-dn's name (catalog1) and number
(18005550001).
telephony-service
service dnis overlay
ephone-dn 1
number 18005550000
ephone-dn 2
name catalog1
number 18005550001
ephone-dn 3
name catalog2
number 18005550002
ephone-dn 4
name catalog3
number 18005550003
ephone 1
button 1o1,2,3,4
ephone 2
button 1o1,2,3,4
ephone 3
button 1o1,2,3,4
For more information about overlaid ephone-dns, see “Configuring Call-Coverage Features” on
page 663.
Cisco Unified Communications Manager Express System Administrator Guide
822 OL-10663-02
Configuring Directory Services
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 823
Configuring Directory Services
Feature Information for Directory Services
Feature Information for Directory Services
Table 16 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 16 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 16 Feature Information for Directory Services
Cisco Unified CME
Feature Name Version Feature Information
Directory Search 7.0/4.3 Number of entries supported in a search results list was
increased from 32 to 240 when using directory search.
Called-Name Display 3.2 Called-name display was introduced.
Local Directory Service 4.0(2) Added support for transferring a call directly to a selected
External Directory Service number listed in the directory. If directory transfer is not
supported, the user must press Transfer and then use the
keypad to manually enter the number of the monitored line
to transfer the incoming call.
3.4 Added support of directory services for SIP phones directly
connected in Cisco Unified CME.
3.0 The ability to add local directory entries in addition to
those that are automatically added from phone
configurations was introduced. Authentication for local
directory display was introduced.
2.1 The ability to block the display of the local directory on
phones was introduced.
2.0 The specification of name format in the local directory was
introduced.
Cisco Unified Communications Manager Express System Administrator Guide
824 OL-10663-02
Configuring Do Not Disturb
Last Updated: January 20, 2009
This chapter describes the do-not-disturb feature in Cisco Unified Communications Manager Express
(Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Do Not Disturb”
section on page 833.
Contents
• Information About Do Not Disturb, page 825
• How to Configure Do Not Disturb, page 827
• Where to Go Next, page 831
• Additional References, page 832
• Feature Information for Do Not Disturb, page 833
Information About Do Not Disturb
To configure do not disturb, you should understand the following concept:
• SCCP: Do Not Disturb, page 825
• SIP: Do Not Disturb, page 826
SCCP: Do Not Disturb
The Do Not Disturb (DND) feature allows phone users to disable audible ringing for incoming calls.
When DND is enabled, incoming calls do not ring on the phone, however there is visual alerting and the
call information displays, and a call can be answered if desired. When a local IP phone calls another
local IP phone that is in the DND state, the message “Ring out DND” displays on the calling phone
indicating that the target phone is in the DND state.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 825
Configuring Do Not Disturb
Information About Do Not Disturb
Phone users can toggle DND on and off by using the DND soft key in the idle or ringing call states. A
SSCP phone user can toggle DND on or off in the ringing state only if DND in not already active on the
phone. If DND is already active when a new call comes in, the SCCP phone user cannot change the DND
state by pressing the DND soft key.
If an SSCP phone user toggles DND on during an incoming call, the DND state remains active for the
current call only. If a SIP phone user toggles DND on during an incoming call, the DND state remains
active during the current call and for all future calls until the user explicitly toggles DND off.
Pressing the DND soft key during an incoming call forwards the call to the call-forward no answer
destination if Call Forward No Answer is enabled. If Call Forward is not enabled, pressing the DND soft
key disables audible ringing and visual alerting, but the call information is visible on the phone display.
In Cisco CME 3.2.1 and later versions, DND can be blocked from phones with the feature-ring function.
A feature ring is a triple-pulse ring, a type of ring cadence in addition to internal call and external call
ring cadences. For example, an internal call in the United States rings for 2 seconds on and 4 seconds
off (single-pulse ring), and an external call rings for 0.4 seconds on, 0.2 seconds off, 0.4 seconds on, and
0.2 seconds off (double-pulse ring).
The triple-pulse ring is used as an audio identifier for phone users. For example, each salesperson in a
sales department could have an IP phone with a button sharing the same set of ephone-dns with the sales
staff and another button for their private line for preferred customers. To help a salesperson identify an
incoming call to his or her private line, the private line can be configured with the feature-ring function.
You can disable the DND function on feature-ring lines. In the preceding example, salespeople could
activate DND on their phones and still hear calls to their private lines.
SIP: Do Not Disturb
In Cisco Unified CME 7.1 and later versions, the Do Not Disturb (DND) feature for SIP phones prevents
incoming calls from audibly ringing a phone. When DND is enabled, the phone flashes an alert to
visually indicate an incoming call instead of ringing and the call can be answered if desired. The message
“Do Not Disturb is active” displays on the phone and calls are logged to the Missed Calls directory.
In versions earlier than Cisco Unified CME 7.1, the DND feature blocks incoming calls to a SIP phone
with a busy tone. Cisco Unified CME rejects calls to all lines on the phone and plays a busy tone to the
caller. Received calls are not logged to the Missed Calls directory on the phone.
DND applies to all lines on the phone. If DND and Call Forward All are both enabled on a phone,
Call Forward All takes precedence on incoming calls.
You must enable DND for a SIP phone through Cisco Unified CME. The DND soft key displays by
default on supported SIP phones in both the Ringing and Idle states. You can remove or change the order
of this soft key using a voice register template.
A phone user can toggle DND on and off at the phone by using the DND soft key. If a SIP phone user
activates DND during an incoming call, the DND state remains active during the current call and for all
future calls until the user explicitly toggles DND off.
If a phone user toggles DND on or off at the phone, Cisco Unified CME restores the DND state after the
phone resets or restarts, if you save the running configuration before Cisco Unified CME reboots.
For configuration information, see the “SIP: Configuring Do Not Disturb” section on page 829.
Cisco Unified Communications Manager Express System Administrator Guide
826 OL-10663-02
Configuring Do Not Disturb
How to Configure Do Not Disturb
Table 17 compares the DND configuration for SIP phones with different phone load versions:
Table 17 DND Feature Comparison for SIP Phones
Cisco Unified IP Phone 7911, 7941,
Cisco Unified IP Phone 7911, 7941, 7961, 7970, or 7971 with 8.2 Phone
7961, 7970, or 7971 with 8.3 Phone Load or Cisco Unified
Load IP Phone 7940 or 7960
DND support dnd command in voice register dnd command in voice register
pool mode pool mode
DND soft key display softkey idle and softkey ringIn dnd-control command in voice
command in voice register template register template mode
mode
Behavior when configured Ringer is turned off for incoming Call is rejected and busy tone is
calls. Visual alerting is provided. played to the caller.
How to Configure Do Not Disturb
This section contains the following tasks:
• SCCP: Blocking Do Not Disturb, page 827 (required)
• SCCP: Verifying Do Not Disturb, page 829 (optional)
• SIP: Configuring Do Not Disturb, page 829 (required)
SCCP: Blocking Do Not Disturb
To block DND on phones that have buttons configured for feature ringing, perform the following steps.
DND is enabled by using the DND soft key on Cisco Unified IP phones that support soft keys.
Prerequisites
• Cisco Unified 3.2.1 or a later version.
• Phone line must be configured for feature ring with the button f command.
• Call-forwarding no-answer must be set for a phone to use DND to forward calls. For configuration
information, see “Configuring Call Transfer and Forwarding” on page 595. No other configuration
is necessary for basic DND.
Restrictions
• Phone users cannot enable DND for a shared line in a hunt group. The soft key displays in the idle
and ringing states but does not enable DND for shared lines in hunt groups.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 827
Configuring Do Not Disturb
How to Configure Do Not Disturb
3. ephone phone-tag
4. no dnd feature-ring
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies
Example: the ephone to be configured.
Router(config)# ephone 10
Step 4 no dnd feature-ring Enables ringing on phone buttons configured for
feature ring when the phone is in DND mode.
Example:
Router(config-ephone)# no dnd feature-ring
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Examples
In the following configuration example, when DND is activated on ephone 1 and ephone 2, button 1 will
ring, but button 2 will not.
ephone-dn 1
number 1001
ephone-dn 2
number 1002
ephone-dn 10
number 1110
preference 0
no huntstop
ephone-dn 11
number 1111
preference 1
ephone 1
button 1f1
button 2o10,11
no dnd feature-ring
Cisco Unified Communications Manager Express System Administrator Guide
828 OL-10663-02
Configuring Do Not Disturb
How to Configure Do Not Disturb
ephone 2
button 1f2
button 2o10,11
no dnd feature-ring
SCCP: Verifying Do Not Disturb
show ephone dnd
Use this command to display a list of SCCP phones that have DND enabled.
Router# show ephone dnd
ephone-1 Mac:0007.0EA6.353A TCP socket:[1] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0
IP:1.2.205.205 52486 Telecaster 7960 keepalive 2729 max_line 6 DnD
button 1: dn 11 number 60011 CH1 IDLE
SIP: Configuring Do Not Disturb
To enable the Do Not Disturb (DND) feature on a SIP phone, perform the following steps.
Prerequisites
• Cisco CME 3.4 or a later version.
• Cisco Unified CME 7.1 or a later version to use the DND soft key.
• Call-forwarding busy must be set for a SIP IP phone to use DND to forward calls. For configuration
information, see “Configuring Call Transfer and Forwarding” in the Cisco Unified CME System
Administrator Guide.
Restrictions
• In versions earlier than Cisco Unified CME 7.1, you enable the DND soft key on SIP phones by
using the dnd-control command.
• If you enable DND on the phone and remove the DND soft key, the user cannot toggle DND off at
the phone.
Cisco Unified IP Phone 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE
• For SIP phones using firmware 8.3 or a later version, the DND feature prevents calls from ringing;
it does not block calls or play a busy tone to the caller.
• If DND is disabled by a phone user, it is not enabled after the phone resets or restarts. DND must
be enabled both in Cisco Unified CME and by using the DND soft key on the phone.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 829
Configuring Do Not Disturb
How to Configure Do Not Disturb
3. voice register template template-tag
4. softkeys idle {[Cfwdall] [DND] [Gpickup] [Newcall] [Pickup] [Redial]}
5. softkeys ringIn [Answer] [DND]
6. exit
7. voice register pool phone-tag
8. dnd
9. template template-tag
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register template template-tag Enters ephone-template configuration mode to create an
ephone template.
Example: • template-tag—Unique identifier for the ephone
Router(config)# voice register template 5 template that is being created. Range: 1 to 10.
Step 4 softkeys idle {[Cfwdall] [DND] [Gpickup] Modifies the order and type of soft keys that display on a
[Newcall] [Pickup] [Redial]} SIP phone during the idle call state.
Example:
Router(config-register-temp)# softkeys idle
Step 5 softkeys ringIn [Answer] [DND] Modifies the order and type of soft keys that display on a
SIP phone during the ringing call state.
Example:
Router(config-register-temp)# softkeys ringin
dnd answer
Step 6 exit Exits ephone-template configuration mode.
Example:
Router(config-register-temp)# exit
Step 7 voice register pool phone-tag Enters voice register pool configuration mode to set
parameters for the SIP phone.
Example:
Router(config)# voice register pool 1
Cisco Unified Communications Manager Express System Administrator Guide
830 OL-10663-02
Configuring Do Not Disturb
Where to Go Next
Command or Action Purpose
Step 8 dnd Enables DND on the phone.
• If Call Forward No Answer is not configured for the
Example: extension, pressing the DND soft key mutes the ringer
Router(config-register-pool)# dnd for incoming calls.
Step 9 template template-tag Applies the ephone template to the phone.
• template-tag—Unique identifier of the template that
Example: you created in Step 3
Router(config-register-pool)# template 5
Step 10 end Returns to privileged EXEC mode.
Example:
Router(config-register-pool)# end
Examples
The following example shows DND is enabled on phone 130, and the DND soft key is modified in
template 6, which is assigned to the phone:
voice register template 6
softkeys idle Gpickup Pickup DND Redial
softkeys ringIn DND Answer
!
voice register pool 130
id mac 001A.A11B.500E
type 7941
number 1 dn 30
template 6
dnd
Where to Go Next
Agent Status Control for Ephone Hunt Groups and Cisco Unified CME B-ACD
Ephone hunt group agents can control their ready/not-ready status (their ability to receive calls) using
the DND function or the HLog function of their phones. When they use the DND soft key, they do not
receive calls on any extension on their phones. When they use the HLog soft key, they do not receive
calls on hunt group extensions, but they do receive calls on other extensions. For more information on
agent status control and the HLog function, see “Configuring Call-Coverage Features” on page 663.
Call Forwarding
To use the DND soft key to forward calls, enable call-forwarding no-answer for SCCP phones or
call-forward busy for SIP IP phones. See “Configuring Call Transfer and Forwarding” on page 595.
Feature Access Codes (FACs)
DND can be activated and deactivated using a feature access code (FAC) instead of the DND soft key
when standard or custom FACs are enabled. The following is the standard FAC for DND:
• DND—**7
See “Configuring Feature Access Codes” on page 893.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 831
Configuring Do Not Disturb
Additional References
Soft-Key Display
You can remove or change the position of the DND soft key. See “Customizing Soft Keys” on page 1047.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
832 OL-10663-02
Configuring Do Not Disturb
Feature Information for Do Not Disturb
Feature Information for Do Not Disturb
Table 18 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 18 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 18 Feature Information for Do Not Disturb
Cisco Unified CME
Feature Name Version Feature Information
Do Not Disturb 7.1 Enhanced DND support on SIP phones to allow incoming
calls to visually flash an alert.
3.4 Added support for Do-not-disturb (DND) soft key on SIP
phones.
3.2.1 DND bypass for feature-ring phones was introduced.
3.2 DND was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 833
Configuring Do Not Disturb
Feature Information for Do Not Disturb
Cisco Unified Communications Manager Express System Administrator Guide
834 OL-10663-02
Configuring Enhanced 911 Services
Last Updated: December 17, 2007
This chapter describes the Enhanced 911 Services feature in Cisco Unified Communications
Manager Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Enhanced 911
Services” section on page 892.
Contents
• Prerequisites for Enhanced 911 Services, page 853
• Restrictions for Enhanced 911 Services, page 854
• Information About Enhanced 911 Services, page 854
• How to Configure Enhanced 911 Services, page 866
• Configuration Examples for Enhanced 911 Services, page 882
• Additional References, page 890
• Feature Information for Enhanced 911 Services, page 892
Prerequisites for Enhanced 911 Services
• SCCP or SIP phones must be registered to Cisco Unified CME.
• At least one CAMA or ISDN trunk must be configured from Cisco Unified CME to each of the 911
service provider’s public safety answering point (PSAP).
• An Enhanced 911 network must be designed for each customer’s voice network.
• Cisco Unified CME has an FXS, FXO, SIP, or H.323 trunk interface configured.
Cisco Unified CME
• Cisco Unified CME 4.2 or a later version.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 853
Configuring Enhanced 911 Services
Restrictions for Enhanced 911 Services
Cisco Unified CME in SRST Fallback Mode
• Cisco Unified CME 4.1 or a later version, configured in SRST fallback mode. See “Configuring
SRST Fallback Mode” on page 1187.
Note For information about configuring ephones, ephone-dns, voice register pools, and voice register
dns, see “Configuring Phones to Make Basic Calls” on page 139.
Restrictions for Enhanced 911 Services
• Enhanced 911 Services for Cisco Unified CME does not interface with the
Cisco Emergency Responder.
• The information about the most recent phone that called 911 is not preserved after a reboot of
Cisco Unified CME.
• Cisco Emergency Responder does not have access to any updates made to the emergency call
history table when remote Cisco Unified IP phones are in SRST fallback mode. Therefore, if the
PSAP calls back after the IP phones register back to Cisco Unified Communications Manager,
Cisco Emergency Responder has no history of those calls. As a result, those calls are not routed to
the original 911 caller. Instead, the calls are routed to the default destination that is configured on
Cisco Emergency Responder for the corresponding ELIN.
• For Cisco Unified Wireless 7920 and 7921 IP phones, a caller’s location can only be determined by
the static information configured by the system administrator. For more information, see the
“Precautions for Mobile Phones” section on page 860.
• The extension numbers of 911 callers can be translated to only two emergency location
identification numbers (ELINs) for each emergency response location (ERL). For more information,
see the “Overview of Enhanced 911 Services” section on page 855.
• Using ELINs for multiple purposes can result in unexpected interactions with existing
Cisco Unified CME features. These multiple uses of an ELIN can include configuring an ELIN for
use as an actual phone number (ephone-dn, voice register dn, or FXS destination-pattern), a Call
Pickup number, or an alias rerouting number. For more information, see the “Multiple Usages of an
ELIN” section on page 863.
• Your configuration of Enhanced 911 Services can interact with existing Cisco Unified CME
features and cause unexpected behavior. For a complete description of interactions between
Enhanced 911 Services and existing Cisco Unified CME features, see the “Interactions with
Existing Cisco Unified CME Features” section on page 863.
Information About Enhanced 911 Services
To configure Enhanced 911 Services, you should understand the following concepts:
• Overview of Enhanced 911 Services, page 855
• Call Processing for E911 Services, page 857
• Precautions for Mobile Phones, page 860
• Planning Your Implementation of Enhanced 911 Services, page 861
• Interactions with Existing Cisco Unified CME Features, page 863
Cisco Unified Communications Manager Express System Administrator Guide
854 OL-10663-02
Configuring Enhanced 911 Services
Information About Enhanced 911 Services
Overview of Enhanced 911 Services
Enhanced 911 Services enable 911 operators to:
• Immediately pinpoint the location of the 911 caller based on the calling number
• Callback the 911 caller if a disconnect occurs
Before this feature was introduced, Cisco Unified CME supported only outbound calls to 911. With
basic 911 functionality, calls were simply routed to a public safety answering point (PSAP). The 911
operator at the PSAP then had to verbally gather the emergency information and location from the caller,
before dispatching a response team from the ambulance service, fire department, or police department.
Calls could not be routed to different PSAPs, based on the specific geographic areas that they cover.
With Enhanced 911 Services, 911 calls are selectively routed to the closest PSAP based on the caller’s
location. In addition, the caller’s phone number and address automatically display on a terminal at the
PSAP. Therefore, the PSAP can quickly dispatch emergency help, even if the caller is unable to
communicate the location. Also, if the caller disconnects prematurely, the PSAP has the information it
needs to contact the 911 caller.
To use Enhanced 911 Services, you must define an emergency response location (ERL) for each of the
geographic areas needed to cover all of the phones supported by Cisco Unified CME. The geographic
specifications for ERLs are determined by local law. For example, you might have to define an ERL for
each floor of a building because an ERL must be less than 7000 square feet in area. Because the ERL
defines a known, specific location, this information is uploaded to the PSAP’s database and is used by
the 911 dispatcher to help the emergency response team to quickly locate a caller.
To determine which ERL is assigned to a 911 caller, the PSAP uses the caller’s unique phone number,
which is also known as the emergency location identification number (ELIN). Before you can use
Enhanced 911 Services you must supply the PSAP with a list of your ELINs and street addresses for each
ERL. This information is saved in the PSAP’s automatic location identification (ALI) database.
Typically, you give this information to the PSAP when your phone system is installed.
With the address information in the ALI database, the PSAP can find the caller’s location and can also
use the ELIN to callback the 911 caller within a specified time limit. This limit applies to the Last Caller
table, which provides the PSAP with the 911 caller’s ELIN. If no time limit is specified for the Last
Caller table, the default expiry time is three hours.
In addition to saving call formation in the temporary Last Caller table, you can configure permanent call
detail records. You can view the attributes in these records from RADIUS accounting, the syslog service,
or Cisco IOS show commands.
You have the option of configuring zero, one, or two ELINs for each ERL. If you configure two ELINs,
the system uses a round-robin algorithm to select which ELIN is sent to the PSAP. If you do not define
an ELIN for an ERL, the PSAP sees the original calling number. You may not want to define an ELIN
if Cisco Unified CME is using direct-inward-dial numbers or the call is from another Cisco voice
gateway that has already translated the extension to an ELIN.
Optionally define a default ELIN that the PSAP can use if a 911 caller's IP phone's address does not
match the IP subnet of any location in any zone. This default ELIN can be an existing ELIN that is
already defined for one of the ERLs or it can be a unique ELIN. If no default ELIN is defined and the
911 caller’s IP Address does not match any of the ERLs’ IP subnets, a syslog message is issued stating
that no default ELIN is defined, and the original ANI remains intact.
You can also define a designated callback number that is used when the callback information is lost in
the Last Caller table because of an expiry timeout or system restart. You can use this designated callback
number if the PSAP cannot reach the 911 caller at the caller’s ELIN or the default ELIN for any other
reason. You can further customize your system by specifying the expiry time for data in the Last Caller
table and by enabling syslog messages that announce all emergency calls.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 855
Configuring Enhanced 911 Services
Information About Enhanced 911 Services
For large installations, you can optionally specify that calls from specific ERLs are routed to specific
PSAPs. This is done by configuring emergency response zones, which lists the ERLs within each zone.
This list of ERLs also includes a ranking of the locations which controls the order of ERL searches when
there are multiple PSAPs. You do not need to configure emergency response zones if all 911 calls on
your system are routed to a single PSAP.
One or more ERLs can be grouped into a zone which could be equivalent to the area serviced by a PSAP.
When an outbound emergency call is placed, configured emergency response zones allow the searching
of a subset of the ERLs in any order. The ERLs can be ranked in the order of desired usage.
Zones are also used to selectively route 911 calls to different PSAPs.You can configure selective routing
by creating a zone with a list of unique locations and assigning each zone to a different outbound dial
peer. In this case, zones route the call based on the caller’s ERL. When an emergency call is made, each
dial peer matching the called number uses the zone’s list of locations to find a matching IP subnet to the
calling phone’s IP address. If an ERL and ELIN are found, the dial peer’s interface is used to route the
call. If no ERL or ELIN is found, the next matched dial peer checks its zone.
Note • If a caller’s IP address does not match any location in its dial-peers zone, the last dial peer that
matched is used for routing and the default ELIN is used.
• If you want 911 calls from any particular phone to always use the same dial peer when you have
multiple dial peers going to the same destination-pattern (911) and the zones are different, you must
configure the preferred dial peer to be the highest priority by setting the preference field.
Duplicate location tags are not allowed in the same zone. However, the same location tag can be defined
in multiple zones. You are allowed to enter duplicate location priorities in the same zone, however, the
existing location’s priority is then increased to the next number. For example, if you configure “location
36 priority 5” followed by “location 19 priority 5,” location 19 has priority 5 and location 36 becomes
priority 6. Also, if two locations are assigned priority 100, rather than bump the first location to priority
101, the first location becomes the first nonprioritized location.
Figure 28 shows an example configuration for 911 services. In this example, the phone system handles
calls from multiple floors in multiple buildings. Five ERLs are defined, with one ELIN defined for each
ERL. At the PSAP, the ELIN is used to find the caller’s physical address from the ALI database.
Building 2 is closer to the PSAP in San Francisco and Building 40 is closer to the PSAP in San Jose.
Therefore, in this case, we recommend that you configure two emergency response zones to ensure that
911 calls are routed to the PSAP closest to the caller. In this example, you can configure an emergency
response zone that includes all of the ERLS in building 2 and another zone that includes the ERLs in
building 40. If you choose to not configure emergency response zones, 911 calls are routed based on
matching the destination number configured for the outgoing dial peers.
Cisco Unified Communications Manager Express System Administrator Guide
856 OL-10663-02
Configuring Enhanced 911 Services
Information About Enhanced 911 Services
Figure 28 Implementation of Enhanced 911 for Cisco Unified CME
Building 2
ERL 1: ELIN 408 555 0102
ERL 2: ELIN 408 555 0101 Service
ext. 22 ERL 3: ELIN 408 555 0100 provider’s
network
CAMA San Francisco
PSAP
CAMA
Service
provider’s ELIN ALI
Building 40 network
ERL 5: ELIN 408 555 0160 San Jose
PSAP 408 555 0161
ERL 4: ELIN 408 555 0161
230079
801 Main Street,
ext. 44 Floor 1, San Jose
Call Processing for E911 Services
When a 911 call is received by Cisco Unified CME, the initial call processing is the same as for any other
call. Cisco Unified CME takes the called-number and searches for dial peers that can be used to route
the call to that called-number.
The Enhanced 911 feature also analyzes the outgoing dial peer to see if it is going to a PSAP. If the
outgoing dial peer is configured with the emergency response zone command, the system is notified
that the call needs Enhanced 911 handling. If the outgoing dial peer is not configured with the
emergency response zone command, the Enhanced 911 functionality is not activated and the caller’s
number is not translated to an ELIN.
When the Enhanced 911 functionality is activated, the first step in Enhanced 911 handling is to
determine which ERL is assigned to the caller. There are two ways to determine the caller’s ERL.
• Explicit Assignment—If a 911 call arrives on an inbound dial peer that has an ERL assignment, this
ERL is automatically used as the caller’s location.
• Implicit Assignment—If a 911 call arrives from an IP phone, its IP address is determined and
Enhanced 911 searches for the IP address of the caller’s phone in one of the IP subnets configured
in the ERLs. The ERLs are stored as an ordered list according to their tag numbers, and each subnet
is compared to the caller’s IP address in the order listed.
After the caller’s ERL is determined, the caller’s number is translated to that ERL’s ELIN. If no ERLs
are implicitly or explicitly assigned to a call, you can define a default ERL for IP phones. This default
ERL does not apply to nonIP-phone endpoints, such as phones on VoIP trunks or FXS/FXO trunks.
After an ELIN is determined for the call, the following information is saved to the Last Caller table:
• Caller’s ELIN
• Caller’s original extension
• Time the call originated
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 857
Configuring Enhanced 911 Services
Information About Enhanced 911 Services
The Last Caller table contains this information for the most recent emergency callers from each ERL.
A caller’s information is purged from the table when the specified expiry time has passed after the call
was originated. If no time limit is specified, the default expiry time is three hours.
After the 911 call information is saved to the Last Caller table, the system determines whether an
emergency response zone is configured that contains the caller’s ERL. If no emergency response zone
is configured with the ERL, all ERLs are searched sequentially to match the caller’s IP address and then
route the 911 call to the appropriate PSAP. If an ERL is included in a zone, the 911 call is routed to the
PSAP associated with that zone.
After the 911 call is routed to appropriate PSAP, Enhanced 911 processing is complete. Call processing
then proceeds as it does for basic calls, except that the ELIN replaces the original calling number for the
outbound setup request.
Cisco Unified Communications Manager Express System Administrator Guide
858 OL-10663-02
Configuring Enhanced 911 Services
Information About Enhanced 911 Services
Figure 29 summarizes the procedure for processing a 911 call.
Figure 29 Processing a 911 Call
Extension 1100 calls 911
The called-number (911)
is used to match dial-peer(s).
Does the PSAP's
dial-peer have the No
emergency response
tag configured?
Yes
Is an ERL found from either the: No
1) Inbound dial-peer configuration
2) Phone’s IP address
Yes
Does ERL have an
ELIN configured?
Yes
No
Replace calling Calling number
number 1100 remains intact.
with ELIN.
911 call information is saved in a
table for PSAP to use for callback.
230228
Call setup request
continues as usual.
The 911 operator is unable to find information about a call in the Last Caller table if the router was
rebooted or specified expiry time (three hours by default) has passed after the call was originated. If this
is the case, the 911 operator hears the reorder tone. To prevent the 911 operator from getting this tone,
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 859
Configuring Enhanced 911 Services
Information About Enhanced 911 Services
you can configure the default callback as described in the “Configuring Customized Settings” section on
page 877. Alternately, you can configure a call forward number on the dial peer that goes to an operator
or primary contact at the business.
Because the 911 callback feature tracks the last caller by its extension number, if you change the
configuration of your ephone-dns in-between a 911 call and a 911 callback and within the expiry time,
the PSAP might not be able to successfully contact the last 911 caller.
If two 911 calls are made from different phones in the same ERL within a short period of time, the first
caller’s information is overwritten in the Last Caller table with the information for the second caller.
Because the table can contain information about only one caller from each ERL, the 911 operator does
not have the information needed to contact the first caller.
In most cases, if Cisco Emergency Responder is configured, you should configure
Enhanced 911 Services with the same data for the ELIN and ERL as used by Cisco Emergency
Responder.
Precautions for Mobile Phones
Emergency calls placed from phones that have been removed from their primary site might not be
answered by local safety authorities. IP phones should not be used to place emergency calls if removed
from the site where it was initially configured. Therefore, we recommend that you require your mobile
phone users to agree to a policy similar to the one stated below.
Telecommuters, remote office, and traveling personnel must place emergency calls on a locally
configured hotel, office, or home phone (in other words, their landline). If they must use a remote
IP phone for emergency calls while away from their configured site, they must be prepared to provide
specific information regarding their location (their country, city, state, street address, and so on) to the
answering safety authority or security operations center personnel.
By accepting this policy your mobile phone users are confirming that they:
• Understand this advisory
• Agree to take reasonable precautions to prevent use of any remote IP phone device for emergency
calls when it is removed from its configured site
By not responding to or declining to accept this policy, your mobile phone users are confirming that they
understand that all remote IP phone devices associated with them will be disconnected, and no future
requests for these services will be fulfilled.
Cisco Unified Communications Manager Express System Administrator Guide
860 OL-10663-02
Configuring Enhanced 911 Services
Information About Enhanced 911 Services
Planning Your Implementation of Enhanced 911 Services
Before you configure Enhanced 911 Services for Cisco Unified CME:
Step 1 Make a list of your sites that are serviced by Cisco Unified CME, and the PSAPs serving each site.
Be aware that you must use a CAMA/PRI interface to connect to each PSAP. Table 19 shows an example
of the information that you need to gather.
.
Table 19 List of Sites and PSAPs
Interface to which Calls
Building Name and Address Responsible PSAP Are Routed
Building 2, 201 Maple Street, San Francisco San Francisco, CA Port 1/0:D
Building 40, 801 Main Street, San Jose San Jose, CA Port 1/1:D
Step 2 Use local laws to determine the number of ERLs you need to configure.
According to the National Emergency Number Association (NENA) model legislation, make the
location specific enough to provide a reasonable opportunity for the emergency response team to quickly
locate a caller anywhere within it. Table 20 shows an example.
Table 20 ERL Calculation
Number of ERLs
Building Size in Square Feet Number of Floors Required
Building 2 200,000 3 3
Building 40 7000 2 1
Step 3 (Optional) Assign one or two ELINs to each ERL.
You must contact your phone service provider to request phone numbers that are designated as ELINs.
Step 4 (Optional) Assign each of your ERLs to an emergency response zone to enable 911 calls to be routed to
the PSAP that is closest to the caller. Use the voice emergency response zone command.
Step 5 Configure one or more dial peers for your 911 callers with the emergency response zone command.
You might need to configure multiple dial peers for different destination-patterns.
Step 6 Configure one or more dial peers for the PSAP’s 911 callbacks with the emergency response callback
command.
Step 7 Decide what method to use to assign ERLs to phones.
You have the following choices:
• For a group of phones that are on the same subnet, you can create an IP subnet in the ERL that
includes each phone’s IP address. Each ERL can have one or two unique IP subnets. This is the
easiest option to configure. Table 21 shows an example.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 861
Configuring Enhanced 911 Services
Information About Enhanced 911 Services
Table 21 Definitions of ERL, Description, IP Subnets, and ELIN
ERL Number Description IP Address Assignment ELIN
1 Building 2, 1st floor 10.5.124.xxx 408 555-0142
2 Building 2, 2nd floor 10.7.xxx.xxx 408 555-0143
3&4 Building 2, 3rd floor 10.8.xxx.xxx and 408 555-0144 and
10.9.xxx.xxx 408 555-0145
• You can assign an ERL explicitly to a group of phones by using the ephone-template or voice
register template configurations. Instead of assigning an ERL to phones individually, you can use
these templates to save time if you want to apply the same set of features to several SCCP phones
or SIP phones.
• You can assign an ERL to a phone individually. Depending on which type of phone you have, you
can use one of three methods. You can assign an ERL to a phone’s:
– Dial-peer configuration
– Ephone configuration (SCCP phones)
– Voice register pool configuration (SIP phones)
Table 22 shows examples of each of these options.
Table 22 Explicit ERL Assignment Per Phone
Phone Configuration ERL
Dial-peer voice 213 pots 3
Dial-peer voice 214 voip 4
Ephone 100 3
Voice register pool 1 2
Step 8 (Optional) Define a default ELIN to be sent to the PSAP for use if a 911 caller's IP phone's address does
not match the IP subnet of any location in any zone.
Step 9 (Optional) Define a designated callback number that is used if the callback information is removed from
the Last Caller table because of an expiry timeout or system restart.
Step 10 (Optional) Change the expiry time for data in the Last Caller table from the default time of three hours.
Step 11 (Optional) Enable RADIUS accounting or the syslog service to permanently record call detail records.
Cisco Unified Communications Manager Express System Administrator Guide
862 OL-10663-02
Configuring Enhanced 911 Services
Information About Enhanced 911 Services
Interactions with Existing Cisco Unified CME Features
Enhanced 911 Services interacts with several Cisco Unified CME features. The interactions with each
of the following features are described in separate sections below:
Note Your version of Cisco Unified CME may not support all of these features.
• Multiple Usages of an ELIN, page 863
• Number Translation, page 863
• Call Transfer, page 864
• Call Forward, page 864
• Call Blocking Features, page 864
• Call Waiting, page 864
• Three-Way Conference, page 865
• Dial-Peer Rotary, page 865
• Dial Plan Patterns, page 865
• Caller ID Blocking, page 865
• Shared Line, page 865
Multiple Usages of an ELIN
Caution We recommend that you do not use ELINs for any other purpose because of possible unexpected
interactions with existing Cisco Unified CME features.
Examples of using ELINs for other purposes include configuring an ELIN for use as an actual phone
number (ephone-dn, voice register dn, FXS destination-pattern), a Call Pickup number, or an alias
rerouting number.
Using ELINs as an actual phone number causes problems when calls are made to that number. If a 911
call occurs and the last caller information has not expired from the Last Caller table, any outside callers
will reach the last 911 caller instead of the actual phone. We recommend that you do not share the phone
numbers used for ELINs with real phones.
There is no impact on outbound 911 calls if you use the same number for an ELIN and a real phone
number.
Number Translation
The Enhanced 911 feature translates the calling number to an ELIN during an outbound 911 call, and
translates the called-number to the last caller’s extension during a 911 callback (when the PSAP makes
a callback to the 911 caller). Alternative methods of number translation can conflict with the translation
done by the Enhanced 911 software, such as:
• Dialplan-pattern—Prefixes a pattern to an extension configured under telephony-service
• Num-expansion—Expands extensions to full E.164 numbers
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 863
Configuring Enhanced 911 Services
Information About Enhanced 911 Services
• Voice-port translation of called and calling numbers
• Outgoing number translation for dial peers
• Translate-profile for dial peers
• Voice translation profiles done for the dial peer, voice-port, POTS voice service, trunk group, trunk
group member, voice source-group, call-manager-fallback, and ephone-dn
• Ephone-dn translation
• Voice register dn’s outgoing translation
Configuring these translation features impacts the Enhanced 911 feature if they translate patterns that
are part of your ELINs’ patterns. For an outgoing 911 call, these features might translate an
Enhanced 911 ELIN to a different number, giving the PSAP a number they cannot look-up in their ALI
databases. If the 911 callback number (ELIN) is translated before Enhanced 911 callback processing, the
Enhanced 911 feature is unable to find the last caller’s history.
Call Transfer
If a phone in a Cisco Unified CME environment performs a semiattended or consultative transfer to the
PSAP that involves another phone that is in a different ERL, the PSAP will use the wrong ELIN. The
PSAP will see the ELIN of the transferor party, not the transferred party.
There is no impact on 911 callbacks (calls made by the PSAP back to a 911 caller) or transfers that are
made by the PSAP.
A 911 caller can transfer the PSAP to another party if there is a valid reason to do so. Otherwise, we
recommend that the 911 caller remain connected to the PSAP at all times.
Call Forward
There is no impact if an IP phone user calls another phone that is configured to forward calls to the
PSAP.
If the PSAP makes a callback to a 911 caller that is using a phone that has Call Forward enabled, the
PSAP is redirected to a party that is not the original 911 caller.
Call Blocking Features
Outbound 911 calls can be blocked by features such as After-Hours Call Blocking if the system
administrator does not create an exception to 911 calls.
911 callbacks will not reach the 911 caller if the phone is configured with a blocking feature (for
example, Do Not Disturb).
Call Waiting
After a 911 call is established with a PSAP, call waiting can interrupt the call. The 911 caller has the
choice of putting the operator on hold. Although holding is not prohibited, we recommend that the 911
caller remain connected to the PSAP until the call is over.
Cisco Unified Communications Manager Express System Administrator Guide
864 OL-10663-02
Configuring Enhanced 911 Services
Information About Enhanced 911 Services
Three-Way Conference
Although the 911 caller is allowed to activate three-way conferencing when talking to the PSAP, we
recommend that the 911 caller remain connected privately to the PSAP until the call is over.
Dial-Peer Rotary
If a 911 caller uses a rotary phone, you must configure each dial peer with the emergency response zone
command for the call to be processed as an Enhanced 911 call. Otherwise, calls received on dial peers
that are not configured for Enhanced 911 functionality are treated as regular calls and there is no ELIN
translation.
Do not configure two dial peers with the same destination-pattern to route to different PSAPs. The
caller’s number will not be translated to two different ELINs and the two dial peers will not route to
different PSAPs. However, you can route calls to different PSAPs if you configure the dial peers with
different destination-patterns (for example, 9911 and 95105558911). You might need to use the number
translation feature or add prefix/forward-digits to change the 95105558911 to 9911 for the second dial
peer if a specific called-number is required by the service provider.
Caution We recommend that you do not configure the same dial peer using both the emergency response zone
and emergency response callback commands.
Dial Plan Patterns
Dial plan patterns expand the caller’s original extension number into a fully qualified E.164 number. If
an ERL is found for a 911 caller, the expanded number is translated to an ELIN.
For 911 callbacks, the called-number is translated to the 911 caller’s expanded number.
Caller ID Blocking
When you set Caller ID Blocking for an ephone or voice-port configuration, the far-end gateway device
blocks the display of the calling party information. This feature is overridden when an Enhanced 911
call is placed because the PSAP must receive the ELIN (the calling party information).
The Caller ID Blocking feature does not impact callbacks.
Shared Line
The Shared Line feature allows multiple phones to share a common directory number. When a shared
line receives an incoming call, each phone rings. Only the first user that answers the call is connected to
the caller.
The Shared Line feature does not affect outbound 911 calls.
For 911 callbacks, all phones sharing the directory number will ring. Therefore, someone who did not
originate the 911 call might answer the phone and get connected to the PSAP. This could cause
confusion if the PSAP needs to talk only with the 911 caller.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 865
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
How to Configure Enhanced 911 Services
This section contains the following tasks:
• Configuring the Emergency Response Location, page 866 (required)
• Configuring Locations under Emergency Response Zones, page 868 (required)
• Configuring Outgoing Dial Peers for Enhanced 911 Services, page 869 (required)
• Configuring a Dial Peer for Callbacks from the PSAP, page 871 (required)
• Assigning ERLs to Phones, page 873 (required)
• Configuring Customized Settings, page 877 (optional)
• Using the Address Command for Two ELINS, page 879 (optional)
• Enabling Call Detail Records, page 879 (optional)
• Verifying E911 Configuration, page 880 (optional)
• Troubleshooting Enhanced 911 Services, page 882 (optional)
Configuring the Emergency Response Location
Perform this procedure to create the ERL. The ERL defines an area that allows emergency teams to
quickly locate a caller.
The ERL can define zero, one, or two ELINs. If one ELIN is defined, this ELIN is always used for
phones calling from this ERL. If you define two ELINs, the system alternates using each ELIN for
phones calling from this ERL. If you define no ELINs and phones use this ERL, the outbound calls do
not have their calling numbers translated. The PSAP sees the original calling numbers for these 911
calls.
If multiple ERLs are created, the Enhanced 911 software uses the ERL tag number to determine which
ELIN to use. The Enhanced 911 software searches the ERLs sequentially from tag 1 to 2147483647. The
first ERL that has a subnet mask encompassing the caller's IP address is used for ELIN translation.
Prerequisites
• Cisco Unified CME 4.1 or a later version.
• The address and name commands are supported in Cisco Unified CME 4.2 and later versions.
• Plan your 911 configuration as described in “Planning Your Implementation of Enhanced 911
Services” section on page 861.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice emergency response location tag
4. elin [1 | 2] E.164-number
5. address address
6. name name
Cisco Unified Communications Manager Express System Administrator Guide
866 OL-10663-02
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice emergency response location tag Enters emergency response location configuration mode to
define parameters for an ERL.
Example:
Router(config)# voice emergency response
location 4
Step 4 elin [1 | 2] E.164-number (Optional) Specifies the ELIN, an E.164 PSTN number that
replaces the caller's extension.
Example: • This number is displayed on the PSAP’s terminal and is
Router(cfg-emrgncy-resp-location)# elin 1 used by the PSAP to query the ALI database to locate
4085550100 the caller. It is also used by the PSAP for callbacks.
You can define a second ELIN using the optional elin 2
command. If an ELIN is not defined for the ERL, the
PSAP sees the original calling number.
Step 5 address address (Optional) Defines a comma-separated string used for the
automatic location identification (ALI) database upload of
the caller’s address.
Example:
Router(cfg-emrgncy-resp-location)# address • String must conform to the record format that is
I,604,5550100, ,184 ,Main St,Kansas City,KS,1, required by the service provider. The string maximum
is 247 characters.
• Address is saved as part of the E911 ERL
configuration. When used with the show voice
emergency addresses command, the address
information can be saved to a text file.
• This command is supported in Cisco Unified CME 4.2
and later versions.
Step 6 name name (Optional) Defines a 30-character string used internally to
identify or describe the emergency response location.
Example: • This command is supported in Cisco Unified CME 4.2
Router(cfg-emrgncy-resp-location)# name Bldg C, and later versions.
Floor 2
Step 7 end Returns to privileged EXEC mode.
Example:
Router(cfg-emrgncy-resp-location)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 867
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
Configuring Locations under Emergency Response Zones
In the configuration of emergency response zones, a list of locations within a zone is created using
location tags. The zone configuration allows a ranking of the locations which controls the order of ERL
searches when there are multiple PSAPs. The zone command is not used if all 911 calls on the system
are routed to a single PSAP.
Prerequisites
• Cisco Unified CME 4.2 or a later version
• Define your ERLs as described in the “Configuring the Emergency Response Location” section on
page 866.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice emergency response zone tag
4. location location-tag [priority number]
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice emergency response zone tag Enters voice emergency response zone configuration mode
to define parameters for an emergency response zone.
Example: • tag—Range is 1-100.
Router(config)# voice emergency response zone
10
Step 4 location location-tag [priority number] Each location tag must correspond to a location tag created
using the voice emergency response location command.
Example: • number—(optional) Ranks the location in the zone list.
Router(cfg-emrgncy-resp-zone)# location 8 Range is 1-100, with 1 being the highest priority.
priority 2
• Repeat this command for each location included in the
zone.
Cisco Unified Communications Manager Express System Administrator Guide
868 OL-10663-02
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
Command or Action Purpose
Step 5 end Returns to privileged EXEC mode.
Example:
Router(cfg-emrgncy-resp-zone)# end
Configuring Outgoing Dial Peers for Enhanced 911 Services
Depending on whether you decided to configure emergency response zones while you planned your 911
configuration as described in “Planning Your Implementation of Enhanced 911 Services” section on
page 861, use one of the following procedures:
• If you decided to not use zones, see the “Configuring Dial Peers for Emergency Calls” section on
page 869.
• If you decided to use zones, see the “Configuring Dial Peers for Emergency Response Zones”
section on page 870.
Configuring Dial Peers for Emergency Calls
Perform this procedure to create a dial peer for emergency calls to the PSAP. The destination-pattern of
this dial peer is usually some variation of 911, such as 9911. This dial peer uses the port number of the
CAMA or PRI network interface card. The new command emergency response zone specifies that this
dial peer translates the calling number of any outgoing call’s to an ELIN.
SUMMARY STEPS
1. enable
2. configure terminal
3. dial-peer voice number pots
4. destination-pattern n911
5. prefix number
6. emergency response zone
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 869
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
Command or Action Purpose
Step 3 dial-peer voice number pots Enters dial-peer configuration mode to define parameters
for an individual dial peer.
Example:
Router(config)# dial-peer voice 911 pots
Step 4 destination-pattern n911 Matches dialed digits to a telephony device. The digits
included in this command specify the E.164 or private
dialing plan telephone number. For Enhanced 911 Services,
Example:
Router(config-dial-peer)# destination-pattern
the digits are usually some variation of 911.
9911
Step 5 prefix number (Optional) Includes a prefix that the system adds
automatically to the front of the dial string before passing it
to the telephony interface. For Enhanced 911 Services, the
Example:
Router(config-dial-peer)# prefix 911
dial string is some variation of 911.
Step 6 emergency response zone Defines this dial peer as the one to use to route all ERLs
defined in the system to the PSAP.
Example:
Router(config-dial-peer)# emergency response
zone
Step 7 end Returns to privileged EXEC mode.
Example:
Router(config-dial-peer)# end
Configuring Dial Peers for Emergency Response Zones
You can selectively route a 911 call based on the ERL by assigning different zones to dial peers. The
emergency response zone command identifies the dial peer that routes the 911 call and the voice
interface to use. Only ERLs that are defined in the zone can be routed on the dial peer. Callers dialing
the same emergency number are routed to different voice interfaces based on the zone of the ERL.
Prerequisites
• Cisco Unified CME 4.2 or a later version
• Define your ERLs and emergency response zones as described in:
– Configuring the Emergency Response Location, page 866.
– Configuring Locations under Emergency Response Zones, page 868
SUMMARY STEPS
1. enable
2. configure terminal
3. dial-peer voice number pots
4. destination-pattern n911
5. prefix number
6. emergency response zone tag
Cisco Unified Communications Manager Express System Administrator Guide
870 OL-10663-02
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 dial-peer voice number pots Enters dial-peer configuration mode to define parameters
for an individual dial peer.
Example:
Router(config)# dial-peer voice 911 pots
Step 4 destination-pattern n911 Matches dialed digits to a telephony device. The digits
included in this command specify the E.164 or private
dialing plan telephone number. For E911 services, the digits
Example:
Router(config-dial-peer)# destination-pattern
are usually some variation of 911.
9911
Step 5 prefix number (Optional) Includes a prefix that the system adds
automatically to the front of the dial string before passing it
to the telephony interface. For E911 services, the dial string
Example:
Router(config-dial-peer)# prefix 911
is some variation of 911.
Step 6 emergency response zone tag Defines this dial peer as the one that is used to route ERLs
defined for that zone.
Example: • tag—Points to an existing configured zone. Range is
Router(config-dial-peer)# emergency response 1-100.
zone 10
Step 7 end Returns to privileged EXEC mode.
Example:
Router(config-dial-peer)# end
Configuring a Dial Peer for Callbacks from the PSAP
Perform this procedure to create a dial peer for 911 callbacks from the PSAP. This dial peer enables the
PSAP to use the ELIN to make callbacks. When a call arrives that matches this dial peer, the emergency
response callback command instructs the system to find the last caller that used the ELIN and translate
the destination number of the incoming call to the extension of the last caller.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 871
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
3. dial-peer voice number pots
4. incoming called-number number
5. direct-inward-dial
6. emergency response callback
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 dial-peer voice number pots Enters dial-peer configuration mode to define parameters
for an individual dial peer.
Example:
Router(config)# dial-peer voice 100 pots
Step 4 incoming called-number number (Optional) Selects the inbound dial peer based on the called
number to identify the last caller. This number is the ELIN.
Example:
Router(config-dial-peer)# incoming
called-number 4085550100
Step 5 direct-inward-dial (Optional) Enables the Direct Inward Dialing (DID) call
treatment for the incoming called number. For more
information, see the chapter “Configuring Voice Ports” in
Example:
Router(config-dial-peer)# direct-inward-dial
the Cisco Voice, Video, and Fax Configuration Guide.
Step 6 emergency response callback Identifies a dial peer as an ELIN dial peer.
Example:
Router(config-dial-peer)# emergency response
callback
Step 7 end Returns to privileged EXEC mode.
Example:
Router(config-dial-peer)# end
Cisco Unified Communications Manager Express System Administrator Guide
872 OL-10663-02
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
Assigning ERLs to Phones
You must specify an ERL for each phone. The type of phones that you have determines which of the
following tasks you use to associate an ERL with your phones, as explained in Step 7 in the “Planning
Your Implementation of Enhanced 911 Services” section on page 861.
• To create an IP subnet in the ERL that includes each phone’s IP address, you must also configure
each ERL to specify which phones are part of the ERL. See “Assigning an ERL to a Phone’s IP
Subnet” section on page 873. You can optionally specify up to two different subnets.
• To assign an ERL to a SIP phone, you must specify the ERL in the voice register pool configuration.
See “Assigning an ERL to a SIP Phone” section on page 874.
• To assign an ERL to a SCCP phone, you must specify the ERL in the ephone configuration. See
“Assigning an ERL to a SCCP Phone” section on page 875.
• To assign an ERL to a phone’s dial peer, you must specify the ERL in the dial-peer configuration.
See “Assigning an ERL to a Dial Peer” section on page 876.
Prerequisites
Define your ERLs and emergency response zones as described in the “Configuring the Emergency
Response Location” section on page 866.
Assigning an ERL to a Phone’s IP Subnet
Use this procedure when you have a group of phones that are on the same subnet. You can configure an
ERL to be associated with one or two unique IP subnets. This indicates that all IP phones in a specific
subnet use the ELIN defined in this ERL.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice emergency response location tag
4. subnet [1 | 2] IPaddress-mask
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 873
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
Command or Action Purpose
Step 3 voice emergency response location tag Enters emergency response location configuration mode to
define parameters for an ERL.
Example:
Router(config)# voice emergency response
location 4
Step 4 subnet [1 | 2] IPaddress-mask Defines the groups of IP phones that are part of this
location. You can create up to 2 different subnets.
Example: • To include all IP phones on a single ERL, use the
Router(cfg-emrgncy-resp-location)# subnet 1 command subnet 1 0.0.0.0 0.0.0.0 to configure a
192.168.0.0 255.255.0.0 default subnet. This subnet does not apply to
nonIP-phone endpoints, such as phones on VoIP trunks
or FXS/FXO trunks.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(cfg-emrgncy-resp-location)# end
Assigning an ERL to a SIP Phone
Perform this procedure if you chose to assign a specific ERL to a SIP phone instead of using the phone’s
IP address to match a subnet defined for an ERL. For more information about this decision, see Step 7
in the “Planning Your Implementation of Enhanced 911 Services” section on page 861.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register pool tag
4. emergency response location tag
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
874 OL-10663-02
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
Command or Action Purpose
Step 3 voice register pool tag Enters voice register pool mode to define parameters for an
individual voice register pool.
Example:
Router(config)# voice register pool 8
Step 4 emergency response location tag Assigns an ERL to a phone’s voice register pool using an
ERL’s tag.
Example: • tag—Range is 1 to 2147483647.
Router(config-register-pool)# emergency
response location 12
• If the ERL’s tag is not a configured tag, the phone is not
associated to an ERL and the phone defaults to its IP
address to find the inclusive ERL subnet.
• This command can also be configured in voice register
template configuration mode and applied to one or
more phones. The voice register pool configuration has
priority over the voice register template configuration.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-register-pool)# end
Assigning an ERL to a SCCP Phone
Perform this procedure if you chose to assign an ERL to a SCCP phone instead of configuring an ERL
to be associated with IP subnets. For more information about this decision, see Step 7 in the “Planning
Your Implementation of Enhanced 911 Services” section on page 861.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone tag
4. emergency response location tag
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 875
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
Command or Action Purpose
Step 3 ephone tag Enters ephone configuration mode to define parameters for
an individual ephone.
Example:
Router(config)# ephone 224
Step 4 emergency response location tag Assigns an ERL to a phone’s ephone configuration using an
ERL’s tag.
Example: • tag—Range is 1 to 2147483647.
Router(config-ephone)# emergency response
location 12
• If the ERL’s tag is not a configured tag, the phone is not
associated to an ERL and the phone defaults to its IP
address to find the inclusive ERL subnet.
• This command can also be configured in
ephone-template configuration mode and applied to
one or more phones. The ephone configuration has
priority over the ephone-template configuration.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Assigning an ERL to a Dial Peer
Perform this procedure to assign an ERL to a FXS/FXO or VoIP dial peer. Because these interfaces do
not have IP addresses associated with them, you must use this procedure instead of configuring an ERL
to be associated with IP subnets. For more information about this decision, see Step 7 in the “Planning
Your Implementation of Enhanced 911 Services” section on page 861.
SUMMARY STEPS
1. enable
2. configure terminal
3. dial-peer voice tag type
4. emergency response location tag
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
876 OL-10663-02
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
Command or Action Purpose
Step 3 dial-peer voice tag type Enters dial peer configuration mode to define parameters
for an individual dial peer.
Example:
Router(config)# dial-peer voice 100 pots
Step 4 emergency response location tag Assigns an ERL to a phone’s dial peer configuration using
an ERL’s tag. The tag is an integer from 1 to 2147483647.
If the ERL’s tag is not a configured tag, no translation
Example:
Router(config-dial-peer)# emergency response
occurs and no Enhanced 911 information is saved to the last
location 12 emergency caller table.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-dial-peer)# end
Configuring Customized Settings
The E911 settings you can customize are:
• Elin: The default ELIN. If a 911 caller’s IP phone address does not match the subnet of any location
in any zone, the default ELIN is used to replace the original automatic number identification (ANI).
The default ELIN can be already defined in one of the ERLs or can be unique. If a default ELIN is
not defined and there is no match for the 911 caller’s IP address, the PSAP sees the ANI for callback
purposes. A syslog message is sent requesting the default ELIN, and no caller location information
is available to the PSAP.
• Expiry: The number of minutes a 911 call is associated to an ELIN in case of a callback from the
911 operator. The callback expiry can be changed from a default of 3 hours to any time between
2 minutes and 48 hours. The timer is started the moment the 911 call goes to the PSAP. The PSAP
can call back the ELIN and reach the last caller within this expiry time.
• Callback: The default phone number to contact if a 911 callback cannot find the last 911 caller from
the Last Caller table. This can happen if the callback occurs after a router has rebooted or if the
expiration has elapsed.
• Logging: A syslog informational message is printed to the console every time an emergency call is
made. Such a message is required for third party applications to send an e-mail or page to an
in-house emergency administrator. This is a default feature that can be disabled using the no logging
command. The following is an example of a syslog notification message:
%E911-5-EMERGENCY_CALL_PLACED: calling #[4085550100] called
#[911] ELIN [4085550199]
Prerequisites
• Cisco Unified CME 4.2 or a later version
SUMMARY STEPS
1. enable
2. configure terminal
3. voice emergency response settings
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 877
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
4. expiry time
5. callback number
6. logging
7. elin number
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice emergency response settings Enters voice emergency response settings mode to define
settings you can customize for E911 calls.
Example:
Router(config)# voice emergency response
settings
Step 4 expiry time (Optional) Defines the time period (in minutes) that the
emergency caller history information for each ELIN is
stored in the Last Caller table. The time can be an integer in
Example:
Router(cfg-emrgncy-resp-settings)# expiry 300
the range of 2 minutes to 2880 minutes. The default value is
180 minutes.
Step 5 callback number (Optional) Defines the E.164 callback number (for
example, a company operator or main help desk) if a 911
callback cannot find the last caller associated to the ELIN.
Example:
Router(cfg-emrgncy-resp-settings)# callback
7500
Step 6 logging (Optional) Enables syslog messages that announce every
emergency call. The syslog messages can be tracked to send
pager or e-mail notifications to an in-house support number.
Example:
Router(cfg-emrgncy-resp-settings)# no logging
By default, logging is enabled. Use the no form of this
command to disable logging.
Step 7 elin number Specifies the E.164 number to be used as the default ELIN
if no ERL has a subnet mask that matches the current 911
caller’s IP phone address.
Example:
Router(cfg-emrgncy-resp-settings)# elin
4085550100
Step 8 end Returns to privileged EXEC mode.
Example:
Router (cfg-emrgncy-resp-settings)# end
Cisco Unified Communications Manager Express System Administrator Guide
878 OL-10663-02
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
Using the Address Command for Two ELINS
For ERLs that have two ELINs defined, you cannot use just one address field to have two address entries
for each ELIN in the ALI database. Instead of entering the specific phone number, a key phrase is entered
to represent each ELIN. The show voice emergency address command produces output that replaces
the key phrase with the ELIN information and generates two lines of addresses.
To define the expression, use the keyword elin (context-insensitive), followed by a period, the starting
position of the ELIN to use, followed by another period, and finally the ending position of the ELIN. For
example:
address I,ELIN.1.3,ELIN.4.7,678 ,Alder Drive ,Milpitas ,CA,95035
In the example, the second parameter of address following I are digits 1-3 of each ELIN. The third
parameter are digits 4-7 of each ELIN. When you enter the show voice emergency address command,
the output will replace the key phrase as seen in the following:
I,408,5550101,678,Alder Drive ,Milpitas ,CA,95035
I,408,5550190,678,Alder Drive ,Milpitas ,CA,95035
Enabling Call Detail Records
To conform to internal policy or external regulations, you may be required to save 911 call history data
including the following information:
• Original caller’s extension
• ELIN information
• ERL information (the integer tag and the text name)
• Original caller’s phone IP address
These attributes are visible from the RADIUS accounting server and syslog server output, or by using
the show call history voice command.
Note You must enable the RADIUS server or the syslog server to display these details. See your RADIUS or
syslog server documentation.
Output from a RADIUS Accounting Server
For RADIUS accounting, the emergency call information is under a feature-vsa record. The fields are:
• EMR: Emergency call
• CGN: Original calling number
• ELIN: Emergency line identification number; the translated number
• CDN: Called number
• ERL: Emergency response location tag number
• ERLN: Emergency response location name; the name entered for the ERL, if one exists
• CIP: Caller’s IP address; nonzero for implicit ERL assignments
• ETAG: ERL tag; nonzero for explicit ERL assignments
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 879
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
The following shows an output example from a RADIUS server:
*Jul 18 15:37:43.691: RADIUS: Cisco AVpair [1] 202 "feature-vsa=fn:EMR
,ft:07/18/2007 15:37:32.227,frs:0,fid:6,fcid:A2444CAF347B11DC8822F63A1B4078DE,
legID:57EC,cgn:6045550101,elin:6045550199,cdn:911,erl:2,erln:Fisco,cip:1.5.6.200,etag:0"
Output from a Syslog Server
If gateway accounting is directed to the syslog server, a VOIP_FEAT_HISTORY system message
appears. The feature-vsa parameters are the same ones described for RADIUS accounting.
The following shows an output example from a syslog server:
*Jul 18 15:37:43.675: %VOIPAAA-5-VOIP_FEAT_HISTORY: FEAT_VSA=fn:EMR,ft:07/18/2007
15:37:32.227,frs:0,fid:6,fcid:A2444CAF347B11DC8822F63A1B4078DE,legID:57EC,cgn:6045550199,
elin:6045550100,cdn:911,erl:2,erln:ABCDEFGHIJKLMNOPQRSTUVWXYZ123,cip:1.5.6.200,etag:0,
bguid:A23F6AD7347B11DC881DF63A1B4078DE
Output from the show call history voice Command
View emergency call information on the gateway using show call active voice and show call history
voice. Some emergency call information is already in existing fields. The original caller’s number is
under OriginalCallingNumber. The ELIN is at TranslatedCallingNumber. The four new fields are the
ERL, ERL name, the calling phone’s IP address, and any explicit ERL assignments. These fields only
appear if an ELIN translation occurs. For example, any 911 calls from an ERL with no ELIN defined do
not print the four emergency fields in the show call commands. If no ERLs match the calling phone and
the default ELIN is used, the ERL field displays No Match.
The following shows an output example using the show call history voice command:
EmergencyResponseLocation=3 (Cisco Systems 3)
ERLAssignment=3
DeviceIPAddress=1.5.6.202
Verifying E911 Configuration
New show commands are introduced to display E911 configuration or usage.
• Use the show voice emergency callers command to see the translations made by outbound 911
calls. This command lists the originating number, the ELIN used, and the time for each 911 call.
This history is active for only three hours after the call is placed. Expired calls are not shown in this
output.
router# show voice emergency callers
EMERGENCY CALLS CALL BACK TABLE
ELIN | CALLER | TIME
6045550100 | 6045550150 | Oct 12 2006 03:59:43
6045550110 | 8155550124 | Oct 12 2006 04:05:21
• Use the show voice emergency command to display IP addresses, subnet masks, and ELINs for each
ERL.
Router# show voice emergency
EMERGENCY RESPONSE LOCATIONS
ERL | ELIN 1 | ELIN2 | SUBNET 1 | SUBNET 2
1 | 6045550101 | | 10.0.0.0 | 255.0.0.0
2 | 6045550102 | 6045550106 | 192.168.0.0 | 255.255.0.0
Cisco Unified Communications Manager Express System Administrator Guide
880 OL-10663-02
Configuring Enhanced 911 Services
How to Configure Enhanced 911 Services
3 | | 6045550107 | 172.16.0.0 | 255.255.0.0
4 | 6045550103 | | 192.168.0.0 | 255.255.0.0
5 | 6045550105 | | 209.165.200.224 | 255.0.0.0
6 6045550198 | | 6045550109 | 209.165.201.0 | 255.255.255.224
• Use the show voice emergency addresses command to display address information for each ERL.
Router# show voice emergency addresses
3850 Zanker Rd, San Jose,604,5550101
225 W Tasman Dr, San Jose,604,5550102
275 W Tasman Dr, San Jose,604,5550103
518 Bellew Dr,Milpitas,604,5550104
400 Tasman Dr,San Jose,604,5550105
3675 Cisco Way,San Jose,604,5550106
• Use the show voice emergency all command to display all ERL information.
Router# show voice emergency all
VOICE EMERGENCY RESPONSE SETTINGS
Callback Number: 6045550103
Emergency Line ID Number: 6045550155
Expiry: 2 minutes
Logging Enabled
EMERGENCY RESPONSE LOCATION 1
Name: Cisco Systems 1
Address: 3850 Zanker Rd, San Jose,elin.1.3,elin.4.10
IP Address 1: 209.165.200.226 IP mask 1: 255.255.255.254
IP Address 2: 209.165.202.129 IP mask 2: 255.255.0.0
Emergency Line ID 1: 6045550180
Emergency Line ID 2:
Last Caller: 6045550188 [Jan 30 2007 16:05.52 PM]
Next ELIN For Emergency Call: 6045550166
EMERGENCY RESPONSE LOCATION 3
Name: Cisco Systems 3
Address: 225 W Tasman Dr, San Jose,elin.1.3,elin.4.10
IP Address 1: 209.165.202.133 IP mask 1: 255.255.0.0
IP Address 2: 209.165.202.130 IP mask 2: 255.0.0.0
Emergency Line ID 1:
Emergency Line ID 2: 6045550150
Last Caller:
Next ELIN For Emergency Call: 6045550151
• Use the show voice emergency zone command to display each zone’s list of locations in order of
priority.
Router# show voice emergency zone
EMERGENCY RESPONSE ZONES
zone 90
location 4
location 5
location 6
location 7
location 2147483647
zone 100
location 1 priority 1
location 2 priority 2
location 3 priority 3
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 881
Configuring Enhanced 911 Services
Configuration Examples for Enhanced 911 Services
Troubleshooting Enhanced 911 Services
Step 1 Use the debug voice application error and the debug voice application callsetup command. These are
existing commands for calls made using the default session or TCL applications.
This example shows the debug output when a call to 911 is made:
Router# debug voice application error
Router# debug voice application callsetup
Nov 10 23:49:05.855: //emrgncy_resp_xlate_callingNum: InDialPeer[20001], OutDialPeer[911]
callingNum[6046692003]
Nov 10 23:49:05.855: //ER_HistTbl_Find_CallHistory: 6046699100
Nov 10 23:49:05.855: //59//Dest:/DestProcessEmergencyCall: Emergency Call detected: Using
ELIN 6046699100
This example shows the debug output when a PSAP calls back an emergency caller:
Router# debug voice application error
Router# debug voice application callsetup
Nov 10 23:49:37.279: //emrgncy_resp_xlate_calledNum: calledNum[6046699100],
dpeerTag[6046699]
Nov 10 23:49:37.279: //ER_HistTbl_Find_CallHistory: 6046699100
Nov 10 23:49:37.279: //HasERHistoryExpired: elapsedTime[10 minutes]
Nov 10 23:49:37.279: //67//Dest:/DestProcessEmergencyCallback: Emergency Response
Callback: Forward to 6046692003.
Nov 10 23:49:37.279: //67//Dest:/DestCaptureCallForward: forwarded to 6046692003 reason 1
Error Messages
The Enhanced 911 feature introduces a new system error message. The following error message displays
if a 911 callback cannot route to the last 911 caller because the saved history was lost because of a
reboot, an expiration of an entry, or a software error:
%E911_NO_CALLER: Unable to contact last 911 caller.
Configuration Examples for Enhanced 911 Services
This section contains the following examples:
• Enhanced E911 Services with Cisco Unified CME 4.2: Example, page 882
• Enhanced E911 Services with Cisco Unified CME 4.1 in SRST Fallback Mode: Example, page 884
Enhanced E911 Services with Cisco Unified CME 4.2: Example
Emergency response settings are:
• default elin if no elin match is found: 604 555-0120
• expiry time for information in the Last Caller table: 180 minutes
• callback number if the PSAP operator must call back the 911 caller and the call back history has
expired: 604 555-0199
Cisco Unified Communications Manager Express System Administrator Guide
882 OL-10663-02
Configuring Enhanced 911 Services
Configuration Examples for Enhanced 911 Services
Zone 1 has four locations, 1, 2, 3, and 4, and a name, address, and elin are defined for each location.
Each of the four locations is assigned a priority. In this example, because location 4 has been assigned
the highest priority, it is the first that is searched for IP subnet matches to identify the ELIN assigned to
the 911 caller’s phone. A dial peer is configured to route 911 calls to the PSAP (voice port 1/0/0).
Callback dial peers are also configured.
!
voice emergency response settings
elin 6045550120
expiry 180
callback 6045550199
!
voice emergency response location 1
name Bldg C, Floor 1
address I,604,5550135, ,184 ,Main St,Kansas City,KS,1,
elin 1 6045550125
subnet 1 172.16.0.0 255.255.0.0
!
voice emergency response location 2
name Bldg C, Floor 2
address I,elin.1.3,elin.4.7, ,184 ,Main St,Kansas City,KS,2,
elin 1 6045550126
elin 2 6045550127
subnet 1 192.168.0.0 255.255.0.0
!
voice emergency response location 3
name Bldg C, Floor 3
address I,604,5550138, ,184 ,Main St,Kansas City,KS,3,
elin 2 6045550128
subnet 1 209.165.200.225 255.255.0.0
subnet 2 209.165.200.240 255.255.0.0
!
voice emergency response location 4
name Bldg D
address I,604,5550139, ,192 ,Main St,Kansas City,KS,
elin 1 6045550129
subnet 1 209.165.200.231 255.255.0.0
!
voice emergency response zone 1
location 4 priority 1
location 3 priority 2
location 2 priority 3
location 1 priority 4
!
dial-peer voice 911 pots
description Public Safety Answering Point
emergency response zone 1
destination-pattern 911
port 1/0/0
!
dial-peer voice 6045550 voip
emergency response callback
destination-pattern 6045550...
session target loopback:rtp
codec g711ulaw
!
dial-peer voice 1222 pots
emergency response location 4
destination-pattern 6045550130
port 1/0/1
!
dial-peer voice 5550144 voip
emergency response callback
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 883
Configuring Enhanced 911 Services
Configuration Examples for Enhanced 911 Services
session target ipv4:1.5.6.10
incoming called-number 604555....
codec g711ulaw
!
Enhanced E911 Services with Cisco Unified CME 4.1 in SRST Fallback Mode:
Example
In this example, Enhanced 911 Services is configured to assign an ERL to the following:
• The 10.20.20.0 IP subnet
• Two dial peers
• An ephone
• A SI P phone
Router#show running-config
Building configuration...
Current configuration : 7557 bytes
!
version 12.4
service timestamps debug datetime msec
service timestamps log datetime msec
no service password-encryption
!
hostname rm-uut3-2821
!
boot-start-marker
boot-end-marker
!
no logging console
!
no aaa new-model
network-clock-participate wic 1
network-clock-participate wic 2
no network-clock-participate wic 3
!
!
!
ip cef
no ip dhcp use vrf connected
!
ip dhcp pool sccp-7912-phone1
host 10.20.20.122 255.255.0.0
client-identifier 0100.1200.3482.cd
default-router 10.20.20.3
option 150 ip 10.21.20.218
!
ip dhcp pool sccp-7960-phone2
host 10.20.20.123 255.255.0.0
client-identifier 0100.131a.a67d.cf
default-router 10.20.20.3
option 150 ip 10.21.20.218
dns-server 10.20.20.3
!
ip dhcp pool sip-phone1
host 10.20.20.121 255.255.0.0
client-identifier 0100.15f9.b38b.a6
Cisco Unified Communications Manager Express System Administrator Guide
884 OL-10663-02
Configuring Enhanced 911 Services
Configuration Examples for Enhanced 911 Services
default-router 10.20.20.3
option 150 ip 10.21.20.218
!
ip dhcp pool sccp-7960-phone1
host 10.20.20.124 255.255.0.0
client-identifier 0100.14f2.37e0.00
default-router 10.20.20.3
option 150 ip 10.21.20.218
dns-server 10.20.20.3
!
!
no ip domain lookup
ip host rm-uut3-c2821 10.20.20.3
ip host RescuMe01 10.21.20.218
multilink bundle-name authenticated
!
isdn switch-type basic-net3
!
!
voice service voip
allow-connections h323 to h323
allow-connections h323 to sip
allow-connections sip to h323
allow-connections sip to sip
supplementary-service h450.12
sip
registrar server
!
!
voice register global
system message RM-SIP-SRST
max-dn 192
max-pool 48
!
voice register dn 1
number 32101
!
voice register dn 185
number 38301
!
voice register dn 190
number 38201
!
voice register dn 191
number 38202
!
voice register dn 192
number 38204
!
voice register pool 1
id mac DCC0.2222.0001
number 1 dn 1
emergency response location 2100
!
voice register pool 45
id mac 0015.F9B3.8BA6
number 1 dn 185
!
voice emergency response location 1
elin 1 22222
subnet 1 10.20.20.0 255.255.255.0
!
voice emergency response location 2
elin 1 21111
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 885
Configuring Enhanced 911 Services
Configuration Examples for Enhanced 911 Services
elin 2 21112
!
!
voice-card 0
no dspfarm
!
!
archive
log config
hidekeys
!
!
controller T1 0/1/0
framing esf
linecode b8zs
pri-group timeslots 8,24
!
controller T1 0/1/1
framing esf
linecode b8zs
pri-group timeslots 2,24
!
controller T1 0/2/0
framing esf
clock source internal
linecode b8zs
ds0-group 1 timeslots 2 type e&m-immediate-start
!
controller T1 0/2/1
framing esf
linecode b8zs
pri-group timeslots 2,24
!
!
translation-rule 5
Rule 0 ^37103 1
!
!
translation-rule 6
Rule 6 ^2 911
!
!
interface GigabitEthernet0/0
ip address 31.20.0.3 255.255.0.0
duplex auto
speed auto
!
interface GigabitEthernet0/1
ip address 10.20.20.3 255.255.0.0
duplex auto
speed auto
!
interface Serial0/1/0:23
no ip address
encapsulation hdlc
isdn switch-type primary-5ess
isdn incoming-voice voice
no cdp enable
!
interface Serial0/1/1:23
no ip address
encapsulation hdlc
isdn switch-type primary-net5
isdn incoming-voice voice
Cisco Unified Communications Manager Express System Administrator Guide
886 OL-10663-02
Configuring Enhanced 911 Services
Configuration Examples for Enhanced 911 Services
no cdp enable
!
interface Serial0/2/1:23
no ip address
encapsulation hdlc
isdn switch-type primary-net5
isdn incoming-voice voice
no cdp enable
!
interface BRI0/3/0
no ip address
isdn switch-type basic-5ess
isdn twait-disable
isdn point-to-point-setup
isdn autodetect
isdn incoming-voice voice
no keepalive
!
interface BRI0/3/1
no ip address
isdn switch-type basic-5ess
isdn point-to-point-setup
!
!
ip http server
!
!
voice-port 0/0/0
!
voice-port 0/0/1
!
voice-port 0/1/0:23
!
voice-port 0/2/0:1
!
voice-port 0/1/1:23
!
voice-port 0/2/1:23
!
voice-port 0/3/0
!
voice-port 0/3/1
!
!
dial-peer voice 2002 pots
shutdown
destination-pattern 2....
port 0/2/0:1
forward-digits all
!
dial-peer voice 2005 pots
description for-cme2-408-pri
emergency response location 2000
shutdown
incoming called-number 911
direct-inward-dial
port 0/2/1:23
forward-digits all
!
dial-peer voice 2004 voip
description for-cme2-408-thru-ip
emergency response location 2000
shutdown
session target loopback:rtp
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 887
Configuring Enhanced 911 Services
Configuration Examples for Enhanced 911 Services
incoming called-number 911
!
dial-peer voice 1052 pots
description 911callbackto-cme2-3
shutdown
incoming called-number .....
direct-inward-dial
port 0/1/1:23
forward-digits all
!
dial-peer voice 1013 pots
description for-analog
destination-pattern 39101
port 0/0/0
forward-digits all
!
dial-peer voice 1014 pots
description for-analog-2
destination-pattern 39201
port 0/0/1
forward-digits all
!
dial-peer voice 3111 pots
emergency response Zone
destination-pattern 9....
port 0/1/0:23
forward-digits all
!
dial-peer voice 3121 pots
emergency response callback
incoming called-number 2....
direct-inward-dial
port 0/1/0:23
forward-digits all
!
!
telephony-service
srst mode auto-provision none
load 7960-7940 P00307020200
load 7970 TERM70.7-0-1-0s
load 7912 CP7912060101SCCP050429B.sbin
max-ephones 50
max-dn 190
ip source-address 10.20.20.3 port 2000
system message RM-SCCP-CME-SRST
max-conferences 8 gain -6
moh flash:music-on-hold.au
multicast moh 236.1.1.1 port 3000
transfer-system full-consult
transfer-pattern .....
transfer-pattern 911
!
!
ephone-dn 1 dual-line
number 31101
!
!
ephone-dn 2 dual-line
number 31201
!
!
ephone-dn 3 dual-line
number 31301
!
Cisco Unified Communications Manager Express System Administrator Guide
888 OL-10663-02
Configuring Enhanced 911 Services
Configuration Examples for Enhanced 911 Services
!
ephone-dn 100 dual-line
number 37101 secondary 37111
name 7960-sccp-1
!
!
ephone-dn 101 dual-line
number 37102
!
!
ephone-dn 102 dual-line
number 37103
!
!
ephone-dn 105
number 37201
!
!
ephone-dn 106 dual-line
number 37101
!
!
ephone-dn 107 dual-line
number 37302
!
!
ephone-dn 108 dual-line
number 37303
!
!
ephone-dn 110 dual-line
number 37401
!
!
ephone-dn 111 dual-line
number 37402
!
!
ephone 1
mac-address DCC0.1111.0001
type 7960
button 1:1
!
!
ephone 2
mac-address DCC0.1111.0002
type 7960
button 1:2
!
!
ephone 3
mac-address DCC0.1111.0003
type 7970
button 1:3
!
!
ephone 40
mac-address 0013.1AA6.7DCF
type 7960
button 1:100 2:101 3:102
!
!
ephone 41
mac-address 0012.0034.82CD
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 889
Configuring Enhanced 911 Services
Additional References
type 7912
button 1:105
!
!
ephone 42
mac-address 0014.F237.E000
emergency response location 2
type 7940
button 1:107 2:108
!
!
ephone 43
mac-address 000F.90B0.BE0B
type 7960
button 1:110 2:111
!
!
line con 0
exec-timeout 0 0
line aux 0
line vty 0 4
login
!
scheduler allocate 20000 1000
!
end
Additional References
The following sections provide references related to Enhanced 911 Services.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Cisco Unified Communications Manager Express System Administrator Guide
890 OL-10663-02
Configuring Enhanced 911 Services
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 891
Configuring Enhanced 911 Services
Feature Information for Enhanced 911 Services
Feature Information for Enhanced 911 Services
Table 23 lists the enhancements to the Enhanced 911 Services feature by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 23 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 23 Feature Information for Enhanced 911 Services
Cisco Unified CME
Feature Name Version Feature Information
Enhanced 911 Services for 4.2 • Assigns ERLs to zones to enable routing to the PSAP
Cisco Unified CME that is closest to the caller
• Customizes E911 by defining a default ELIN,
identifying a designated number if the 911 caller
cannot be reached on callback, specifying the expiry
time for data in the Last Caller table, and enabling
syslog messages that announce all emergency calls
• Expands the E911 location information to include
name and address
• Uses templates to assign ERLs to a group of phones
• Adds new permanent call detail records
Enhanced 911 Services 4.1 Enhanced 911 Services was introduced for
Cisco Unified CME in SRST Fallback Mode.
Cisco Unified Communications Manager Express System Administrator Guide
892 OL-10663-02
Configuring Extension Mobility
Last Updated: August 20, 2008
This module describes features in Cisco Unified Communications Manager Express
(Cisco Unified CME) that provide support for phone mobility for end users.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Extension Mobility”
section on page 892.
Contents
• Prerequisites for Configuring Extension Mobility, page 875
• Information About Configuring Extension Mobility, page 876
• How to Enable Extension Mobility, page 878
• Configuration Examples for Extension Mobility, page 889
• Where to Go Next, page 890
• Additional References, page 891
• Feature Information for Extension Mobility, page 892
Prerequisites for Configuring Extension Mobility
• Cisco Unified CME 4.2 or a later version.
• To use the web-based Cisco Unified CME GUI to configure personal speed dials on an Extension
Mobility phone, Cisco Unified CME 4.2(1) or a later version must be installed.
• To use the phone user interface to configure personal speed dials directly on an Extension Mobility
phone, Cisco Unified CME 4.3 or a later version must be installed.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 875
Configuring Extension Mobility
Restrictions
Restrictions
• Extension Mobility on remote Cisco Unified CME routers is not supported; a phone user can log
into any local Cisco Unified IP phone only.
Information About Configuring Extension Mobility
To configure interoperability, you should understand the following concepts:
• Extension Mobility, page 876
• Personal Speed Dials on an Extension Mobility Phone, page 877
• Cisco Unified CME Extension Mobility Enhancements, page 877
• Privacy on an Extension Mobility Phone, page 878
Extension Mobility
Extension Mobility in Cisco Unified CME 4.2 and later versions provides the benefit of phone mobility
for end users.
A user login service allows phone users to temporarily access a physical phone other than their own
phone and utilize their personal settings, such as directory number, speed-dial lists, and services, as if
the phone is their own desk phone. The phone user can make and receive calls on that phone using the
same personal directory number as is on their own desk phone.
Each Cisco Unified IP phone that is enabled for Extension Mobility is configured with a logout profile.
This profile determines the default appearance of a phone that is enabled for Extension Mobility when
there is no phone user logged into that phone. Minimally, the logout profile allows calls to emergency
services such as 911. A single logout profile can be applied to multiple phones.
After a Cisco Unified IP phone that is enabled for Extension Mobility boots up, the Services feature
button on the phone is configured with a login service URL hosted by Cisco Unified CME that points to
the Extension Mobility Login page. No feature-button-specifc configuration is required to add Extension
Assigner to the Services feature button. The option for Extension Mobility appears last in the list of
options displayed when the phone user presses the Services feature button
A phone user logs in to a Cisco Unified IP phone that is enabled for Extension Mobility by pressing the
Services button or a Unified CCX agent can log in using a Unified CCX Cisco Agent Desktop. User
authentication and authorization is performed by Cisco Unified CME. If the login is successful,
Cisco Unified CME retrieves the appropriate user profile, based on user name and password match, and
replaces the phone’s logout profile with the user profile.
After the phone user is logged in, the service URL points to a logout URL hosted by Cisco Unified CME
to provide a logout prompt on the phone. Logging into a different device automatically closes the first
session and start a new session on the new device. When a phone user is not logged in to any phone,
incoming calls to the phone user’s directory number are sent to the phone user’s voice mailbox.
For button appearance, Extension Mobility associates directory numbers then speed-dial numbers in the
logout profile or user profile to phone buttons. The sequence in which directory numbers are associated
is based on line type and ring behavior as follows: first normal, then silent ring, beep ring, feature ring,
monitor ring, and overlay, followed by speed dials. If the profile contains more numbers than there are
buttons on the physical phone to which the profile is downloaded, the remaining numbers in the profile
are ignored.
Cisco Unified Communications Manager Express System Administrator Guide
876 OL-10663-02
Configuring Extension Mobility
Information About Configuring Extension Mobility
For configuration information, see the “How to Enable Extension Mobility” section on page 878.
Personal Speed Dials on an Extension Mobility Phone
In Cisco Unified CME 4.2(1) and later versions, phone users can use the web-based GUI to set up
personal speed dials on an Extension Mobility phone. Previously, the speed-dial configuration for a
phone could only be done in Cisco Unified CME using Cisco IOS commands.
The same credential for logging on to an Extension Mobility phone is used to log into the
Cisco Unified CME GUI. Any modifications made by using the phone user options in the GUI are
applied to the phone user’s user profile in Extension Mobility. Speed dial options in
Cisco Unified CME GUI cannot be accessed from the System Administrator or Customer Administrator
login screens.
For information about using the Cisco Unified CME GUI, see the Cisco Unified CME GUI User Guide.
The user name parameter of any authentication credential must be unique and cannot be the same as the
user name for any other credential. Do not use the same value for a user name when you configure any
two or more authentication credentials in Cisco Unified CME, such as the username for any
Cisco United CME GUI account and the user name in a logout or user profile for Extension Mobility.
For configuration information, see “Enabling the GUI” on page 367.
In Cisco Unified CME 4.3 and later versions, Extension Mobility users can configure their own
speed-dial settings directly on the phone. Speed-dial settings are added or modified on the phone by
using a menu available with the Services feature button. Any changes to the speed-dial settings made
through the phone user interface are applied to the user’s profile in Extension Mobility. For information
about using the phone user interface on a Cisco Unified IP phone, see the Cisco Unified IP Phone 7900
Series End-User Guides.
The phone user-interface is enabled by default on all phones with displays. You can disable the capability
for an individual phone to prevent a phone user from accessing the interface. For configuration
information, see the “SCCP: Enabling User Interface for Speed-Dial and Fast-Dial” section on
page 1078.
Cisco Unified CME Extension Mobility Enhancements
Enhancements to Extension Mobility in Cisco Unified CME 4.3 include the following:
• Configurable Automatic Logout
• Automatic Clear Call History
Automatic Logout
Cisco Unified CME 4.3 and later versions includes an Automatic Timeout feature for Extension
Mobility. After an automatic logout is executed, Cisco Unified CME sends the logout profile to the
phone and restarts the phone. After an automatic logout, Extension Mobility users can log in again.
You can configure up to three different times on a 24-hour clock for automatically logging out Extension
Mobility users based on time-of-day. The system clock triggers an alarm at the specified time and the
EM Manager in Cisco Unified CME logs outs every logged in Extension Mobility user in the system. If
an Extension Mobility user is using the phone when automatic logout occurs, the user is logged out after
the active call is completed.
For configuration information, see the “Configuring Cisco Unified CME for Extension Mobility”
section on page 878.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 877
Configuring Extension Mobility
How to Enable Extension Mobility
Users log out from Extension Mobility by pressing the Services button and choosing Logout. If a user
does not manually log out before leaving the phone, the phone is idle and the individual’s user profile
remains loaded on that phone. To automatically log out individual users from idle Extension Mobility
phones, configure an idle-duration timer for Extension Mobility. The timer monitors the phone and if the
specified maximum idle time is exceeded, the EM Manager logs out the user. The idle-duration timer is
reset whenever the phone goes offhook.
For configuration information, see the “Configuring a User Profile” section on page 886.
Automatic Clear Call History
In Cisco Unified CME 4.3 and later versions, the EM manager in Cisco Unified CME issues commands
to phones to clear call history whenever a user logs out of Extension Mobility. An HTTP GET/POST is
sent between the Extension Mobility phone and the authentication server in Cisco Unified CME. The
authentication server authorizes the request and the call history is cleared based on the result.
You can configure Cisco Unified CME to disable Automatic Clear Call History. For configuration
information, see the “Configuring Cisco Unified CME for Extension Mobility” section on page 878.
Privacy on an Extension Mobility Phone
In Cisco Unified CME 4.3 and later versions, the Privacy feature enables phone users to block other users
from seeing call information or barging into a call on a shared octo-line directory number. When a phone
receives an incoming call on a shared octo-line, the user can make the call private by pressing the Privacy
feature button, which toggles between on and off to allow the user to alter the privacy setting on their
phone. The privacy state is applied to all new calls and current calls owned by the phone user.
For Extension Mobility phones, you can enable the privacy button in the user profile and logout profile.
To enable the privacy button, see the “Configuring a Logout Profile for an IP Phone” section on page 882
and the “Configuring a User Profile” section on page 886.
For more information about Privacy, see “Configuring Barge and Privacy” on page 503.
How to Enable Extension Mobility
Perform the following tasks to enable Extension Mobility in Cisco Unified CME:
• Configuring Cisco Unified CME for Extension Mobility, page 878 (required)
• Configuring a Logout Profile for an IP Phone, page 882 (required)
• Enabling an IP Phone for Extension Mobility, page 884 (required)
• Configuring a User Profile, page 886 (required)
Configuring Cisco Unified CME for Extension Mobility
To configure Extension Mobility in Cisco Unified CME, perform the following steps.
Prerequisites
• For authentication server in Cisco Unified CME, Cisco Unified CME 4.3 or a later version.
• For Automatic Logout, Cisco Unified CME 4.3 or a later version.
Cisco Unified Communications Manager Express System Administrator Guide
878 OL-10663-02
Configuring Extension Mobility
How to Enable Extension Mobility
SUMMARY STEPS
1. enable
2. configure terminal
3. ip http server
4. telephony-service
5. url authentication url-address application-name password
6. authentication credential
7. em keep-history
8. em logout time1 [time2] [time3]
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ip http server Enables the HTTP server on the Cisco Unified CME router
that hosts the service URL for the Extension Mobility Login
and Logout pages.
Example:
Router(config)# ip http server
Step 4 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 879
Configuring Extension Mobility
How to Enable Extension Mobility
Command or Action Purpose
Step 5 url authentication url application-name Instructs phones to send HTTP requests to the
password authentication server and specifies which credential to use
in the requests.
Example: • This command is supported in Cisco Unified CME 4.3
Router(config-telephony)# url authentication and later versions. Required to support Automatic
http://192.0.2.0/CCMCIP/authenticate.asp
Clear Call history.
secretname psswrd
or • URL for internal authentication server in
Cisco Unified CME is http://CME IP
To support Extension Mobility and VoiceView Express 3.2 or Address/CCMCIP/authenticate.asp.
earlier versions
• To support Extension Mobility and Cisco VoiceView
Router(config-telephony)# url authentication Express 3.2 or an earlier version only:
http://192.0.2.0/voiceview/authentication/authe
nticate.do secretname psswrd – In Cisco Unified CME: Configure the url
authentication command using the URL for
Cisco Unity Express.
The URL for Cisco Unity Express is
http://CUE IP Address/voiceview/authentication
/authenticate.do.
– In Cisco Unity Express: Configure the
fallback-url command using the URL for the
authentication server in Cisco Unified CME.
– See the “Examples” section on page 881.
Step 6 authentication credential application-name (Optional) Creates an entry for an application's credential in
password the database used by the Cisco Unified CME authentication
server.
Example: • This command is supported in Cisco Unified CME 4.3
Router(config-telephony)#authentication and later versions.
credential secretname psswrd
• Required to support requests requests from applications
other than Extension Mobility, such as
Cisco VoiceView Express.
Step 7 em keep-history (Optional) Specifies that Extension Mobility will keep, and
not automatically clear, call histories when users log out
from Extension Mobility phones.
Example:
Router(config-telephony)# em keep-history • This command is supported in Cisco Unified CME 4.3
and later versions.
• Default: Automatic Clear Call History is enabled.
Cisco Unified Communications Manager Express System Administrator Guide
880 OL-10663-02
Configuring Extension Mobility
How to Enable Extension Mobility
Command or Action Purpose
Step 8 em logout time1 [time2] [time3] (Optional) Defines up to three time-of-day timers for
automatically logging out all Extension Mobility users.
Example: • This command is supported in Cisco Unified CME 4.3
Router(config-telephony)# em logout 19:00 24:00 and later versions.
• time—Time of day after which logged-in users are
automatically logged out from Extension Mobility.
Range: 00:00 to 24:00 on a 24-hour clock.
• To configure a idle-duration timer for automatically
logging out an individual user, see the “Configuring a
User Profile” section on page 886.
Step 9 end Exits configuration mode and returns to privileged EXEC
mode.
Example:
Router(config-telephony)# end
Examples
The following example shows how to configure Cisco Unified CME 4.3 or a later version and
Cisco Unity Express 3.2 or an earlier version to support Extension Mobility and Cisco VoiceView
Express.
Note When running Extension Mobility and Cisco VoiceView Express 3.2 or an earlier version, you must also
configure the fallback-url command in Cisco Unity Express. For configuration information, see the
appropriate Cisco Unity Express Administrator Guide.
Cisco Unified CME 4.3 or a later version
telephony-service
url authentication http://192.0.2.0/voiceview/authentication/authenticate.do secretname
psswrd
authentication credentials secretname psswrd
Cisco Unity Express 3.2 or an earlier version
service phone-authentication
fallback-url http://192.0.2.0/CCMCIP/authenticate.asp?UserID=secretname&Password=psswrd
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 881
Configuring Extension Mobility
How to Enable Extension Mobility
Configuring a Logout Profile for an IP Phone
To create a logout profile to define the default appearance for a Cisco Unified IP phone that is enabled
for Extension Mobility, perform the following steps.
Prerequisites
• All directory numbers to be included in a logout profile or a user profile must be already configured
in Cisco Unified CME. For configuration information, see “Configuring Phones to Make Basic
Calls” on page 139.
• For Privacy on extension mobility phones, Cisco Unified 4.3 or a later version.
Restrictions
• For button appearance, Extension Mobility associates directory numbers, then speed-dial definitions
in the logout profile or user profile to phone buttons. The sequence in which directory numbers are
associated is based on line type and ring behavior as follows: first normal, then silent ring, beep ring,
feature ring, monitor ring, and overlay, followed by speed dials. If the profile contains more
directory numbers and speed-dial numbers than there are buttons on the physical phone to which the
profile is downloaded, not all numbers are downloaded to buttons.
• The first number to be configured for line appearance cannot be a monitored directory number.
• The user name parameter of any authentication credential must be unique. Do not use the same value
for a user name when you configure any two or more authentication credentials in
Cisco Unified CME, such as the user name for any Cisco Unified CME GUI account and the user
name in a logout or user profile for Extension Mobility.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice logout-profile tag
4. user name password password
5. number number type type
6. speed-dial speed-tag number [label label] [blf]
7. pin number
8. privacy-button
9. end
Cisco Unified Communications Manager Express System Administrator Guide
882 OL-10663-02
Configuring Extension Mobility
How to Enable Extension Mobility
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice logout-profile profile-tag Enters voice logout-profile configuration mode for creating
a logout profile to define the default appearance for a
Cisco Unified IP phone enabled for Extension Mobility.
Example:
Router(config)# voice logout-profile 1 • profile-tag—Unique number that identifies this profile
during configuration tasks. Range: 1 to maximum
number of phones supported by the
Cisco Unified CME router. Type ? to display the
maximum number.
Step 4 user name password password Creates credential to be used by a TAPI phone device to log
into Cisco Unified CME.
Example: • name—Unique alphanumeric string to identify a user
Router(config-logout-profile)# user 23C2-8 for this authentication credential only.
password 43214
• password—Alphanumeric string.
Step 5 number number[,...number] type type Creates line definition.
• number—Directory number to be associated with and
Example: displayed next to a button on a Cisco Unified IP phone
Router(config-logout-profile)# number 3001 type that is configured with this profile.
silent-ring
Router(config-logout-profile)# number 3002 type • [, ...number]—(Optional) For overlay lines only, with
beep-ring or without call waiting. The directory number that is the
Router(config-logout-profile)# number 3003 type far left in command list is the highest priority. Can
feature-ring contain up to 25 numbers. Individual numbers must be
Router(config-logout-profile)# number 3004 type
monitor-ring
separated by commas (,).
Router(config-logout-profile)# number 3005,3006 • type type—Denotes characteristics to be associated
type overlay
with this line. Type ? for list of options.
Router(config-logout-profile)# number 3007,3008
type cw-overly
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 883
Configuring Extension Mobility
How to Enable Extension Mobility
Command or Action Purpose
Step 6 speed-dial speed-tag number [label label] [blf] Creates speed-dial definition.
• speed-tag—Unique sequence number that identifies a
Example: speed-dial definition during configuration tasks.
Router(config-logout-profile)# speed-dial 1 Range: 1 to 36.
2001
Router(config-logout-profile)# speed-dial 2 • number—Digits to be dialed when the speed-dial
2002 blf button is pressed.
• label label—(Optional) String that contains identifying
text to be displayed next to the speed-dial button.
Enclose the string in quotation marks if the string
contains a space.
• blf—(Optional) Enables Busy Lamp Field (BLF)
monitoring for a speed-dial number.
Step 7 pin number Sets a personal identification number (PIN) to be used by a
phone user to disable the call blocking configuration for a
Cisco Unified IP phone on which this profile is
Example:
Router(config-logout-profile)# pin 1234
downloaded.
• number—Numeric string containing four to eight
digits.
Step 8 privacy-button (Optional) Enables the privacy feature button on the IP
phone.
Example: • Enable this command only on phones that share an
Router(config-logout-profile)# privacy-button octo-line directory number.
• This command is supported in Cisco Unified CME 4.3
and later versions.
Step 9 end Exits to privileged EXEC mode.
Example:
Router(config-logout-profile)# end
Enabling an IP Phone for Extension Mobility
To enable the Extension Mobility feature on an individual Cisco Unified IP phone in
Cisco Unified CME, perform the following steps.
Note All SCCP Cisco Unified IP phones with displays that support URL provisioning for Feature buttons are
supported by Extension Mobility, including the Cisco Unified Wireless IP Phone 7920, Cisco Unified
Wireless IP Phone 7921, and Cisco IP Communicator.
Prerequisites
• HTTP server is enabled on the Cisco Unified CME router. For configuration information, see the
“Configuring Cisco Unified CME for Extension Mobility” section on page 878.
• Logout profile to be assigned to a phone must be configured in Cisco Unified CME.
Cisco Unified Communications Manager Express System Administrator Guide
884 OL-10663-02
Configuring Extension Mobility
How to Enable Extension Mobility
• Cisco IP Communicator to be enabled for Extension Mobility must be already registered in
Cisco Unified CME.
Restrictions
• Extension Mobility is not supported on Cisco Unified IP phones without phone screens.
• Extension Mobility is not supported for SIP phones.
• Extension Mobility is not supported for analog devices.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. mac-address mac-address
5. type phone-type
6. logout-profile profile-tag
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enables phone configuration mode.
• phone-tag—Unique number that identifies this phone
Example: during configuration tasks. Range is 1 to maximum
Router(config)# ephone 1 number supported phones, where maximum is platform
and version dependent and defined by using the
max-ephone command.
Step 4 mac-address mac-address Associates a physical phone with this ephone configuration.
Example:
Router(config-ephone)# mac-address
000D.EDAB.3566
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 885
Configuring Extension Mobility
How to Enable Extension Mobility
Command or Action Purpose
Step 5 logout-profile profile-tag Enables Cisco Unified IP phone for Extension Mobility and
assigns a logout profile to this phone.
Example: • tag—Unique identifier of logout profile to be used
Router(config-ephone)# logout-profile 1 when no phone user is logged in to this phone. This tag
number corresponds to a tag number created when this
logout profile was configured by using the voice
logout-profile command.
Step 6 type phone-type Defines a phone type for the phone being configured.
Example:
Router(config-ephone)# type 7960
Step 7 end Exits to privileged EXEC mode.
Example:
Router(config-ephone)# end
Configuring a User Profile
To configure a user profile for a phone user who logs into a Cisco Unified IP phone that is enabled for
Extension Mobility, perform the following steps.
Note Templates created using the ephone-template and ephone-dn-template commands can be applied to a
user profile for Extension Mobility.
Prerequisites
• All directory numbers to be included in a logout profile or user profile must be already configured
in Cisco Unified CME. For configuration information, see “Configuring Phones to Make Basic
Calls” on page 139.
• For Automatic Logout, Cisco Unified CME 4.3 or a later version.
• For and Privacy on extension mobility phones, Cisco Unified CME 4.3 or a later version.
Restrictions
• For button appearance, Extension Mobility associates directory numbers, then speed-dial definitions
in the logout profile or user profile to phone buttons. The sequence in which directory numbers are
associated is based on line type and ring behavior as follows: first normal, then silent ring, beep ring,
feature ring, monitor ring, and overlay, followed by speed dials. If the profile contains more
directory numbers and speed-dial numbers than there are buttons on the physical phone to which the
profile is downloaded, not all numbers are downloaded to buttons.
• The first number to be configured for line appearance cannot be a monitored directory number.
Cisco Unified Communications Manager Express System Administrator Guide
886 OL-10663-02
Configuring Extension Mobility
How to Enable Extension Mobility
• The user name parameter of any authentication credential must be unique. Do not use the same value
for a user name when you configure any two or more authentication credentials in
Cisco Unified CME, such as the user name for any Cisco Unified CME GUI account and the user
name in a logout or user profile for Extension Mobility.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice user-profile profile-tag
4. user name password password
5. number number type type
6. speed-dial speed-tag number [label label] [blf]
7. pin number
8. max-idle-time minutes
9. privacy-button
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice user-profile profile-tag Enters voice user-profile configuration mode for
configuring a user profile for Extension Mobility.
Example: • profile-tag—Unique number that identifies this profile
Router(config)# voice user-profile 1 during configuration tasks. Range: 1 to three times the
maximum number supported phones, where maximum
is platform dependent. Type ? to display value.
Step 4 user name password password Creates credential to be authenticated by
Cisco Unified CME before allowing the phone user to log
into a Cisco Unified IP phone phone enabled for Extension
Example:
Router(config-user-profile)# user me password
Mobility.
pass123 • name—Unique alphanumeric string to identify a user
for this authentication credential only.
• password—Password for authorized user.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 887
Configuring Extension Mobility
How to Enable Extension Mobility
Command or Action Purpose
Step 5 number number[,...number] type type Creates line definition.
• number—Directory number to be associated with and
Example: displayed next to a button on a phone that is configured
Router(config-user-profile)# number 2001 type with this profile.
silent-ring
Router(config-user-profile)# number 2002 type • [, ...number]—(Optional) For overlay lines only, with
beep-ring or without call waiting. The directory number that is far
Router(config-user-profile)# number 2003 type left in the command list is given the highest priority.
feature-ring Can contain up to 25 numbers. Individual numbers
Router(config-user-profile)# number 2004 type
monitor-ring
must be separated by commas (,)
Router(config-user-profile)# number 2005,2006 • type type—Denotes characteristics to be associated
type overlay
with this line. Type ? for list of options.
Router(config-user-profile)# number 2007,2008
type cw-overly
Step 6 speed-dial speed-tag number [label label] [blf] Creates speed-dial definition.
• speed-tag—Unique sequence number that identifies a
Example: speed-dial definition during configuration tasks.
Router(config-user-profile)# speed-dial 1 3001 Range: 1 to 36.
Router(config-user-profile)# speed-dial 2 3002
blf • number—Digits to be dialed when the speed-dial
button is pressed.
• label label—(Optional) String that contains identifying
text to be displayed next to the speed-dial button.
Enclose the string in quotation marks if the string
contains a space.
• blf—(Optional) Enables Busy Lamp Field (BLF)
monitoring for a speed-dial number.
Step 7 pin number Sets a personal identification number (PIN) to be used by a
phone user to disable the call blocking configuration for a
Cisco Unified IP phone on which this profile is
Example:
Router(config-user-profile)# pin 12341
downloaded.
• number—Numeric string containing four to eight
digits.
Step 8 max-idle-time minutes (Optional) Creates an idle-duration timer for automatically
logging out an Extension Mobility user.
Example: • This command is supported in Cisco Unified CME 4.3
Router(config-user-profile)# max-idle-time 30 and later versions.
• minutes—Maximum number of minutes after which a
user is logged out from an idle Extension Mobility
phone. Range:1 to 9999.
Cisco Unified Communications Manager Express System Administrator Guide
888 OL-10663-02
Configuring Extension Mobility
Configuration Examples for Extension Mobility
Command or Action Purpose
Step 9 privacy-button (Optional) Enables the privacy feature button on the IP
phone.
Example: • Enable this command only on phones that share an
Router(config-user-profile)# privacy-button octo-line directory number.
• This command is supported in Cisco Unified CME 4.3
and later versions.
Step 10 end Exits to privileged EXEC mode.
Example:
Router(config-user-profile)# end
Configuration Examples for Extension Mobility
This section contains the following configuration examples:
• Logout Profile: Example, page 889
• Enabling an IP Phone for Extension Mobility: Example, page 890
• User Profile: Example, page 890
Logout Profile: Example
The following example shows the configuration for a logout profile that defines the default appearance
for a Cisco Unified IP phone that is enabled for Extension Mobility. Which lines and speed-dial buttons
in this profile are configured on a phone depends on phone type. For example, for a Cisco Unified
IP Phone 7970, all buttons are configured according to logout profile1. However, if the phone is a
Cisco Unified IP Phone 7960, all six lines are mapped to phone buttons and the speed dial is ignored
because there is no button available for speed dial.
voice logout-profile 1
pin 9999
user 23C2-8 password 43214
number 3001 type silent-ring
number 3002 type beep-ring
number 3003 type feature-ring
number 3004 type monitor-ring
number 3005,3006 type overlay
number 3007,3008 type cw-overly
speed-dial 1 2000
speed-dial 2 2001 blf
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 889
Configuring Extension Mobility
Where to Go Next
Enabling an IP Phone for Extension Mobility: Example
The following example shows the ephone configurations for three IP phones. All three phones are
enabled for Extension Mobility and share the same logout profile number 1, to be downloaded when
these phones boot and when no phone user is logged into the phone:
ephone 1
mac-address 000D.EDAB.3566
type 7960
logout-profile 1
ephone 2
mac-address 0012.DA8A.C43D
type 7970
logout-profile 1
ephone 3
mac-address 1200.80FC.9B01
type 7911
logout-profile 1
User Profile: Example
The following example shows the configuration for a user profile to be downloaded when a phone user
logs into a Cisco Unified IP phone that is enabled for Extension Mobility. Which lines and speed-dial
buttons in this profile are configured on a phone after the user logs in depends on phone type. For
example, if the user logs into a Cisco Unified IP Phone 7970, all buttons are configured according to
voice-user profile1. However, if the phone user logs into a Cisco Unified IP Phone 7960, all six lines are
mapped to phone buttons and the speed dial is ignored because there is no button available for speed dial.
voice user-profile 1
pin 12345
user me password pass123
number 2001 type silent-ring
number 2002 type beep-ring
number 2003 type feature-ring
number 2004 type monitor-ring
number 2005,2006 type overlay
number 2007,2008 type cw-overly
speed-dial 1 3001
speed-dial 2 3002 blf
Where to Go Next
• If you created a new or modified an existing logout or user profile, you must restart the phones to
propagate the changes. See “Resetting and Restarting Phones” on page 271.
• If you enabled one or more Cisco Unified IP phones for Extension Mobility, generate a new
configuration file and restart the phones. See “Generating Configuration Files for Phones” on
page 261.
Cisco Unified Communications Manager Express System Administrator Guide
890 OL-10663-02
Configuring Extension Mobility
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 891
Configuring Extension Mobility
Feature Information for Extension Mobility
Feature Information for Extension Mobility
Table 24 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified Communications Manager Express and Cisco IOS Software Version Compatibility Matrix
at http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 24 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 24 Feature Information for Extension Mobility
Cisco Unified CME
Feature Name Version Modification
Extension Mobility Enhancement 7.0/4.3 Adds support for the following:
• Automatic Logout, including:
– Configurable time-of-day timers for automatically
logging out all Extension Mobility users.
– Configurable idle-duration timer for logging out an
individual user from an idle Extension Mobility
phone.
• Automatic Clear Call History when a user logs out from
Extension Mobility.
Phone User-Interface for Speed Dial 7.0/4.3 Adds a phone user interface allowing Extension Mobility
users to configure their own speed-dial settings directly on
the phone.
Extension Mobility 4.2 Provides the benefit of phone mobility for end users by
enabling the user to log into any local Cisco Unified
IP Phone that is enabled for Extension Mobility.
Cisco Unified Communications Manager Express System Administrator Guide
892 OL-10663-02
Configuring Feature Access Codes
Last Updated: April 14, 2008
This chapter describes the feature access codes support in Cisco Unified Communications Manager
Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Feature Access
Codes” section on page 899.
Contents
• Information About Feature Access Codes, page 893
• How to Configure Feature Access Codes, page 895
• Configuration Examples for Feature Access Codes, page 897
• Additional References, page 898
• Feature Information for Feature Access Codes, page 899
Information About Feature Access Codes
To enable Feature Access Codes, you should understand the following concept:
• Feature Access Codes, page 894
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 893
Configuring Feature Access Codes
Information About Feature Access Codes
Feature Access Codes
Feature Access Codes (FACs) are special patterns of characters that are dialed from a telephone keypad
to invoke particular features. For example, a phone user might press **1, then press 2345 to forward all
incoming calls to extension 2345.
Typically, FACs are invoked using a short sequences of digits that are dialed using the keypad on an
analog phone, while IP phones users select soft keys to invoke the same features. In Cisco Unified CME
4.0 and later, the same FACs that are available for analog phones can be enabled on IP phones. This
allows phone users to select a particular feature or activate/deactivate a function in the same manner
regardless of phone type.
FACs are disabled on IP phones until they are explicitly enabled. You can enable all standard FACs for
all SCCP phones registered in Cisco Unified CME or you can define a custom FAC or alias to enable one
or more individual FACs.
All FACs except the call-park FAC are valid only immediately after a phone is taken off hook. The
call-park FAC is considered a transfer to a call-park slot and therefore is only valid after the Trnsfer soft
key (IP phones) or hookflash (analog phones) is used to initiate a transfer.
Table 25 contains a list of the standard predefined FACs.
Table 25 Standard FACs
Standard FAC Description
**1 plus optional extension number Call forward all.
**2 Call forward all cancel.
**3 Pick up local group.
**4 plus group number Pick up a ringing call in the specified pickup group. Specified
pickup group must already configured in Cisco Unified
CME.
**5 plus extension number Pick up direct extension.
**6 plus optional park-slot number Call park, if the phone user has an active call and if the phone
user presses the Transfer soft key (IP phone) or hookflash
(analog phone) before dialing this FAC. Target park slot must
be already configured in Cisco Unified CME.
**7 Do not disturb.
**8 Redial.
**9 Dial voice-mail number.
*3 plus hunt group pilot number Join ephone-hunt group. If multiple hunt groups have been
created that allow dynamic membership, the hunt group to be
joined is identified by its pilot number.
*4 Activate or deactivate hunt group logout functionality to
toggle between ready/not-ready status of an extension when
an hunt group agent is off-hook.
*5 Activate or deactivate phone-level hunt group logout to
toggle between ready/not-ready status of all extensions on a
individual phone that is a member of an ephone hunt group
when the phone is idle.
Cisco Unified Communications Manager Express System Administrator Guide
894 OL-10663-02
Configuring Feature Access Codes
How to Configure Feature Access Codes
Table 25 Standard FACs (continued)
Standard FAC Description
*6 Dials the voice-mail number.
#3 Leave ephone-hunt group. Telephone or extension number
must already be configured as a dynamic member of a hunt
group.
How to Configure Feature Access Codes
This section contains the following tasks:
• SCCP: Enabling Feature Access Codes, page 895
• Verifying Feature Access Codes, page 896
SCCP: Enabling Feature Access Codes
To enable standard FACs or create custom FACs, perform the following steps:
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. fac {standard | custom {alias alias-tag custom-fac to existing-fac [extra-digits]} | feature
custom-fac}}
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 895
Configuring Feature Access Codes
How to Configure Feature Access Codes
Command or Action Purpose
Step 4 fac {standard | custom {alias alias-tag Enables standard FACs or creates a custom FAC or alias.
custom-fac to existing-fac [extra-digits]} |
feature custom-fac}} • standard—Enables standard FACs for all phones.
• custom—Creates a custom FAC for a FAC type.
Example: • alias—Creates a custom FAC for an existing FAC or a
Router(config-telephony)# fac custom callfwd existing FAC plus extra digits.
*#5
• alias-tag—Unique identifying number for this alias.
Range: 0 to 9.
• custom-fac—User-defined code to be dialed using the
keypad on an IP or analog phone. Custom FAC can be
up to 256 characters long and contain numbers 0 to 9
and * and #.
• to—Maps custom FAC to specified target.
• existing-fac—Already configured custom FAC that is
automatically dialed when the phone user dials the
custom FAC being configured.
• extra-digits—(Optional) Additional digits that are
automatically dialed when the phone user dials the
custom FAC being configured.
• feature—Predefined alphabetic string that identifies a
particular feature or function. Type ? for a list.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Verifying Feature Access Codes
To verify the FAC configuration, perform the following step.
Step 1 show telephony-service fac
This command displays a list of FACs that are configured on the Cisco Unified CME router. The
following example shows the output when standard FACs are enabled:
Router# show telephony-service fac
telephony-service fac standard
callfwd all **1
callfwd cancel **2
pickup local **3
pickup group **4
pickup direct **5
park **6
dnd **7
redial **8
voicemail **9
ephone-hunt join *3
ephone-hunt cancel #3
ephone-hunt hlog *4
Cisco Unified Communications Manager Express System Administrator Guide
896 OL-10663-02
Configuring Feature Access Codes
Configuration Examples for Feature Access Codes
ephone-hunt hlog-phone *5
trnsfvm *6
The following example shows the output when custom FACs are configured:
Router# show telephony-service fac
telephony-service fac custom
callfwd all #45
alias 0 #1 to **4121
alias 1 #2 to **4122
alias 4 #4 to **4124
Configuration Examples for Feature Access Codes
This section contains the following configuration example:
• FAC: Example, page 897
FAC: Example
The following example shows how to enable standard FACs for all phones:
Router# telephony-service
Router(config-telephony)# fac standard
fac standard is set!
Router(config-telephony)#
The following example shows how the standard FAC for the Call Forward All feature is changed to a
custom FAC (#45). Then an alias is created to map a second custom fac to #45 plus an extension (1111).
The custom FAC (#44) allows the phone user to press #44 to forward all calls all calls to extension 1111,
without requiring the phone user to dial the extra digits that are the extension number.
Router# telephony-service
Router(config-telephony)# fac custom callfwd all #45
fac callfwd all code has been configured to #45
Router(config-telephony)# fac custom alias 0 #44 to #451111
fac alias0 code has been configurated to #44!
alias0 map code has been configurated to #451111!
The following example shows how to define an alias for the group pickup of group 123. The alias
substitutes the digits #4 for the standard FAC for group pickup (**4) and adds the group number (123)
to the dial pattern. Using this custom FAC, a phone user can dial #4 to pick up a ringing call in group
123, instead of dialing the standard FAC **4 plus the group number 123.
Router# telephony-service
Router(config-telephony)# fac custom alias 5 #4 to **4123
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 897
Configuring Feature Access Codes
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
898 OL-10663-02
Configuring Feature Access Codes
Feature Information for Feature Access Codes
Feature Information for Feature Access Codes
Table 26 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 26 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 26 Feature Information for Feature Access Codes
Cisco Unified CME
Feature Name Version Feature Information
Transfer to Voice Mail. 7.0/4.3 FAC for Transfer to Voice Mail was added.
Feature Access Codes (FACs) 4.0 FACs were introduced.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 899
Configuring Feature Access Codes
Feature Information for Feature Access Codes
Cisco Unified Communications Manager Express System Administrator Guide
900 OL-10663-02
Configuring Fax Relay
Last Updated: March 23, 2009
This module describes how to enable Skinny Client Control Protocol (SCCP) Fax Relay for analog
foreign exchange service (FXS) ports under the control of Cisco Unified CME.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Fax Relay” section
on page 908.
Contents
• Prerequisites for Fax Relay, page 901
• Restrictions for Fax Relay, page 902
• Information About Fax Relay, page 902
• How to Configure Fax Relay, page 904
• Configuration Examples for Fax Relay, page 906
• Additional References, page 906
• Feature Information for Fax Relay, page 908
Prerequisites for Fax Relay
• Cisco Unified CME 4.0(3) or a later version.
• If your voice gateway is a separate router than the Cisco Unified CME router, an IP voice image of
Cisco IOS Release 12.4(11)T or later is required.
• SCCP Telephony Control (STC) application is enabled.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 901
Configuring Fax Relay
Restrictions for Fax Relay
Note • In Cisco Unified CME 4.0(3) and later versions, the Cisco-proprietary fax protocol is the only
supported fax option for SCCP-controlled FXS ports. G.711 fax pass-through is not supported for
SCCP-controlled FXS ports.
• For Cisco Unified CME versions before Cisco Unified CME 4.0(3), there are two
manually-controlled options for setting up facsimiles:
– Fax Gateway Protocol
Configure the Cisco VG224, FXS port, or analog telephone adaptor (ATA) to use H.323 or
Session Initiation Protocol (SIP) with a specific fax relay protocol. See the Cisco IOS Fax,
Modem, and Text Support over IP Application Guide.
– G.711 Fax Pass-Through with SCCP
This is the default setup for facsimile on the Cisco VG224 and FXS ports before
Cisco Unified CME 4.0(3). See the Cisco IOS Fax, Modem, and Text Support over IP
Application Guide.
Restrictions for Fax Relay
• RFC2833 dual tone multifrequency (DTMF) digit relay under Cisco Unified CME for SCCP FXS
ports is not supported.
• SCCP FXS ports under Cisco Unified CME control do not natively support RFC2833 DTMF-relay.
However, Cisco Unified CME can support conversion of DTMF digits to and from RFC2833
DTMF-relay on its H323 and SIP interfaces when used with SCCP-controlled FXS ports.
• Cisco Fax Relay is only supported on those Cisco IOS gateways and network modules listed in
Table 27, Supported Gateways, Modules, and VICs for Fax Relay.
Information About Fax Relay
To configure the fax relay feature, you should understand the following concepts:
• Fax Relay and Equipment, page 902
• Feature Design of Cisco Fax Relay, page 903
Fax Relay and Equipment
• The fax relay feature supports the use of existing customer premises equipment (CPE) in voice
networks by allowing legacy analog phones attached to a Cisco IOS gateway to be controlled by
Cisco Unified CME, and by providing feature interoperability between analog and IP endpoints.
• The voice gateway can be the same router that is being used for Cisco Unified CME or it may be a
separate router (for example, the Cisco VG224).
• The fax relay feature facilitates replacement of the PSTN time-division multiplexing (TDM)
infrastructure with VoIP.
Cisco Unified Communications Manager Express System Administrator Guide
902 OL-10663-02
Configuring Fax Relay
Information About Fax Relay
Feature Design of Cisco Fax Relay
Cisco Fax Relay is a proprietary fax relay implementation that uses Real-time Transport Protocol (RTP)
to transport fax data. It is the default fax relay type on Cisco voice gateways and the only supported fax
option for Cisco Unified CME 4.0(3) and later versions. The fax relay feature provides enhanced
supplementary feature capability on analog ports connected to a Cisco integrated services router (ISR)
or Cisco VG224 analog gateway. Calls through the analog FXS ports are controlled by the
Cisco Unified CME system.
Before the introduction of SCCP-enhanced features, SCCP gateways supported fax pass-through only.
SCCP-enhanced features add support for Cisco Fax Relay and Super Group 3 (SG3) to G3 fax relay. This
feature allows the fax stream between two SG3 fax machines to negotiate down to G3 speeds (less than
14.4 kbps) allowing SG3 fax machines to interoperate over fax relay with G3 fax machines.
The SCCP telephony control (STC) application on the Cisco voice gateway presents the locally attached
analog telephones as individual endpoints to the call-control system, which allows the analog phones to
be controlled in the same way as IP phones. With this capability, gateway-attached endpoints share the
same telephony features that are available on IP phones directly connected to Cisco Unified CME.
SCCP-enhanced features provide analog endpoint to analog endpoint interoperability within the IP
telephony network.
Figure 30 shows a multisite deployment of the fax relay feature in a Cisco Unified CME topology.
Figure 30 Cisco Unified CME Fax Relay Deployment
VoIP WAN
Cisco gateway FXS Cisco Unified CME Cisco Unified CME FXS Cisco gateway
FXS
FXS V V
PSTN
LAN 1 LAN 2
IP IP
230565
SCCP
For information on configuring gateway-controlled fax relay features, see the “How to Configure Fax
Relay” section on page 904.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 903
Configuring Fax Relay
How to Configure Fax Relay
Supported Gateways, Modules, and Voice Interface Cards for Fax Relay
Table 27 lists supported gateways, modules, and voice interface cards (VICs).
Table 27 Supported Gateways, Modules, and VICs for Fax Relay
Network Modules and
Gateways Extension Modules Expansion Modules VICs
• Cisco 2801 — • NM-HD-1V • VIC2-2FXS
• Cisco 2811 • NM-HD-2V • VIC-4FXS/DID
• Cisco 2821 • NM-HD-2VE • VIC2-2BRI-NT/TE
• Cisco 2851
• Cisco 3825
• Cisco 3845
• Cisco 2801 • EVM-HD • EVM-HD-8FXS/DID —
• Cisco 2821 • EM-3FXS/4FXO
• Cisco 2851 • EM-HDA-8FXS
• Cisco 3825 • EM-4BRI-NT/TE
• Cisco 3845
• Cisco 2801 — • NM-HDV2 • VIC2-2FXS
• Cisco 2811 • NM-HDV2-1T1/E1 • VIC-4FXS/DID
• Cisco 2821 • NM-HDV2-2T1/E1 • VIC2-2BRI-NT/TE
• Cisco 2851
• Cisco 3825
• Cisco 3845
• Cisco VG 224 — — —
How to Configure Fax Relay
This section contains the following tasks:
• SCCP: Configuring Fax Relay, page 904 (required)
• Verifying and Troubleshooting Fax Relay Configuration, page 905 (optional)
SCCP: Configuring Fax Relay
To configure the fax relay features on Cisco Unified CME, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
904 OL-10663-02
Configuring Fax Relay
How to Configure Fax Relay
3. voice service voip
4. fax protocol cisco
5. fax-relay sg3-to-g3
6. exit
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice service voip Enters voice service configuration mode and specifies VoIP
encapsulation.
Example:
Router(config)# voice service voip
Step 4 fax protocol cisco Specifies the Cisco-proprietary fax protocol as the fax
protocol for SCCP analog endpoints.
Example: • This command is enabled by default.
Router(config-voi-serv)# fax protocol cisco
• This is the only supported option for Cisco Unified
CME 4.0(3) and later versions.
Step 5 fax-relay sg3-to-g3 (Optional) Enables the fax stream between two SG3 fax
machines to negotiate down to G3 speeds.
Example:
Router(config-voi-serv)# fax relay sg3-to-g3
Step 6 exit Exits the current configuration mode.
Example:
Router(config-voi-serv)# exit
Verifying and Troubleshooting Fax Relay Configuration
To verify the configuration of Cisco Fax Relay, use the show-running config command. Sample output
is located in the “Configuration Examples for Fax Relay” section on page 906.
Use the following commands to verify and troubleshoot SCCP gateway-controlled Fax Relay:
• show voice call summary—Displays fax relay voice port settings.
• show voice dsp—Displays fax relay digital signal processor (DSP) channel status.
• debug voip application stcapp all— Displays SCCP telephony control (STC) application fax relay
information.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 905
Configuring Fax Relay
Configuration Examples for Fax Relay
• debug voip dsm all—Displays fax relay DSP stream manager (DSM) messages.
• debug voip dsmp all—Displays fax relay distributed stream media processor (DSMP) messages.
• debug voip hpi all—Displays gateway DSP fax relay information on RTP packet events.
• debug voip vtsp all—Displays gateway voice telephony service provider (VTSP) debugging
information for fax calls.
Note For more information on these and other commands, see the Cisco IOS Voice Command Reference,
Cisco IOS Debug Command Reference, Cisco Unified Communications Manager Express Command
Reference, and Cisco IOS Configuration Fundamentals Command Reference.
Configuration Examples for Fax Relay
This section contains the following example:
• Fax Relay: Example, page 906
Fax Relay: Example
voice service voip
fax-relay sg3-to-g3
ephone-dn 44
number 1234
name fax machine
ephone 33
mac-address 1111.2222.3333
button 1:44
type anl
Additional References
The following sections provide references related to Cisco Fax Relay.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Cisco Unified Communications Manager Express System Administrator Guide
906 OL-10663-02
Configuring Fax Relay
Additional References
Related Topic Document Title
Cisco VG224 Analog Phone Gateway • Supplementary Services Features for FXS Ports on Cisco IOS
Voice Gateways Configuration Guide
• Cisco VG224 Voice Gateway Software Configuration Guide
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 907
Configuring Fax Relay
Feature Information for Fax Relay
Feature Information for Fax Relay
Table 28 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 28 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 28 Feature Information for Cisco Fax Relay
Feature Name Cisco Unified CME Feature Information
Version
Fax Relay 4.0(3) Enables Fax Relay on analog FXS ports on Cisco IOS
voice gateways under the control of Cisco Unified CME.
Cisco Unified Communications Manager Express System Administrator Guide
908 OL-10663-02
Configuring Headset Auto-Answer
Last Updated: January 3, 2008
This chapter describes the headset auto-answer feature in Cisco Unified Communications Manager
Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Headset
Auto-Answer” section on page 913.
Contents
• Information About Headset Auto-Answer, page 907
• How to Configure Headset Auto-Answer, page 910
• Configuration Examples for Headset Auto-answer, page 911
• Additional References, page 912
• Feature Information for Headset Auto-Answer, page 913
Information About Headset Auto-Answer
To enable the Headset Auto-Answer feature, you should understand the following concepts:
• Auto-Answering Calls Using a Headset, page 908
• Difference Between a Line and a Button, page 908
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 907
Configuring Headset Auto-Answer
Information About Headset Auto-Answer
Auto-Answering Calls Using a Headset
In Cisco Unified CME 4.0 and later versions you can configure lines on specific phones to automatically
connect to incoming calls when the headset key is activated. The phone cannot be busy with an active
call and the headset key must be engaged to automatically answer calls. Incoming calls are automatically
answered one by one on the phone as long as the headset light remains lit. For each ephone, you can
specify one or more lines for headset auto-answer.
After a phone is configured for headset auto-answer, the phone user must press the headset key to start
auto-answer. The headset light is lit to indicate that auto-answer is active for the lines that are designated
in the configuration. When the phone auto-answers a call, a zip tone is played to alert the phone user that
a call is present. To stop auto-answer, the phone user presses the headset key again and the headset light
goes out. At this time, the phone user can answer calls in a normal manner using the handset.
Difference Between a Line and a Button
Note that a line is similar to, but not exactly the same as, a button on the phone. A line represents a
phone’s capability to make a call connection, so each button that can make a call connection becomes a
line. (For example, unoccupied buttons or speed-dial buttons are not lines.) Note also that a line is not
the same as an ephone-dn. A button with overlaid ephone-dns is only one line, regardless of whether it
has several ephone-dns (extension numbers) associated with it. In most cases an ephone’s line numbers
do match its button numbers, but in a few cases they do not.
Figure 31 illustrates a comparison of line numbers and button numbers for different types of ephone
configurations.
Cisco Unified Communications Manager Express System Administrator Guide
908 OL-10663-02
Configuring Headset Auto-Answer
Information About Headset Auto-Answer
Figure 31 When is a Line the Same as a Button?
Most of the time, a line number is the same as the button number on which
it appears.
In this example, line 1 is button 1, line 2 is button 2, and line 3 is button 3.
ephone-dn 21
number 2001
ephone-dn 22
number 2002
ephone-dn 23
number 2003
2001 Li ne 1
ephone 2
2002 Li ne 2
button 1:21 2:22 3:23
2003 Li ne 3 headset auto-answer line 1
headset auto-answer line 2
But not always. In the following case, line 2 is button 3, because
button3 is the second button that has an ephone-dn to be connected
to a phone call. Button 2 is unoccupied and cannot take calls.
ephone-dn 33
number 2889
ephone-dn 34
number 2887
ephone 2
2889 Li ne 1 button 1:33 3:34
headset auto-answer line 1
2887 Li ne 2 headset auto-answer line 2
ephone-dn 21
In the following example, button 2 has three overlay ephone- number 2001
dns (22, 23, and 24). Button 2 is defined as one line because
only one of those ephone-dns can be connected to a call ephone-dn 22
using this button at any one time. number 2002
ephone-dn 23
number 2003
ephone-dn 24
number 2004
ephone-dn 25
number 2005
2001 Li ne 1
2002, 2003, 2004 Li ne 2 ephone 2
2005 Li ne 3 button 1:21 2o22,23,24 3:25
headset auto-answer line 2
headset auto-answer line 3
An expansion, or rollover, line for overlaid ephone-dns also ephone-dn 21
counts as one line. Button 2 in this example is also line 2. number 2001
ephone-dn 22
number 2002
ephone-dn 23
number 2003
ephone-dn 24
number 2004
2001, 2002, 2003 Li ne 1
(rollover) ephone 2
Li ne 2
button 1o21,2 2,23 2x1 3:24
135076
2004 Li ne 3
headset auto-a nswer line 1
headset auto-a nswer line 2
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 909
Configuring Headset Auto-Answer
How to Configure Headset Auto-Answer
How to Configure Headset Auto-Answer
This section contains the following tasks:
• SCCP: Enabling Headset Auto-Answer, page 910 (required)
• Verifying Headset Auto-Answer, page 911 (optional)
SCCP: Enabling Headset Auto-Answer
To enable headset auto-answer, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. headset auto-answer line line-number
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies this
Example: ephone during configuration tasks. The maximum number of
Router(config)# ephone 25 ephones for a particular Cisco Unified CME system is
version- and platform-specific. For the range of values, see
the CLI help.
Step 4 headset auto-answer line line-number Specifies a line on an ephone that will be answered automatically
when the headset button is depressed.
Example: • line-number—Number of the phone line that should be
Router(config-ephone)# headset automatically answered.
auto-answer line 1
Note Repeat this command to add additional lines.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Cisco Unified Communications Manager Express System Administrator Guide
910 OL-10663-02
Configuring Headset Auto-Answer
Configuration Examples for Headset Auto-answer
Verifying Headset Auto-Answer
Step 1 Use the show running-config command to verify your configuration. Headset auto-answer is listed in
the ephone portion of the output.
Router# show running-config
ephone 1
headset auto-answer line 1
headset auto-answer line 2
headset auto-answer line 3
headset auto-answer line 4
username "Front Desk"
mac-address 011F.92B0.BE03
speed-dial 1 330 label “Billing”
type 7960 addon 1 7914
no dnd feature-ring
keep-conference
button 1f40 2f41 3f42 4:30
button 5:405 7m20 8m21 9m22
button 10m23 11m24 12m25 13m26
button 14m499 15:1 16m31 17f498
button 18s500
night-service bell
Step 2 Use the show telephony-service ephone command to display only the ephone configuration portion of
the running configuration.
Configuration Examples for Headset Auto-answer
The following example enables headset auto-answer on ephone 3 for line 1 (button 1) and
line 4 (button 4).
ephone 3
button 1:2 2:4 3:6 4o21,22,23,24,25
headset auto-answer line 1
headset auto-answer line 4
The following example enables headset auto-answer on ephone 17 for line 2 (button 2), which has
overlaid ephone-dns, and line 3 (button 3), which is an overlay rollover line.
ephone 17
button 1:2 2o21,22,23,24,25 3x2
headset auto-answer line 2
headset auto-answer line 3
The following example enables headset auto-answer on ephone 25 for line 2 (button 3) and
line 3 (button 5). In this case, the button numbers do not match the line numbers because buttons 2 and 4
are not used.
ephone 25
button 1:2 3:4 5:6
headset auto-answer line 2
headset auto-answer line 3
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 911
Configuring Headset Auto-Answer
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
912 OL-10663-02
Configuring Headset Auto-Answer
Feature Information for Headset Auto-Answer
Feature Information for Headset Auto-Answer
Table 29 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 29 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 29 Feature Information for Headset Auto-Answer
Cisco Unified CME
Feature Name Version Feature Information
Headset Auto-Answer 4.0 Headset auto-answer was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 913
Configuring Headset Auto-Answer
Feature Information for Headset Auto-Answer
Cisco Unified Communications Manager Express System Administrator Guide
914 OL-10663-02
Configuring Intercom Lines
Last Updated: January 15, 2009
This chapter describes the intercom features in Cisco Unified Communications Manager Express
(Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Intercom Lines”
section on page 928.
Contents
• Information About Intercom Lines, page 917
• How to Configure Intercom Lines, page 920
• Configuration Examples for Intercom Lines, page 926
• Where to Go Next, page 926
• Additional References, page 927
• Feature Information for Intercom Lines, page 928
Information About Intercom Lines
To enable intercom lines, you should understand the following concept:
• Intercom Auto-Answer Lines, page 918
• Whisper Intercom, page 919
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 917
Configuring Intercom Lines
Information About Intercom Lines
Intercom Auto-Answer Lines
An intercom line is a dedicated two-way audio path between two phones. Cisco Unified CME supports
intercom functionality for one-way and press-to-answer voice connections using a dedicated pair of
intercom directory numbers on two phones that speed-dial each other.
When an intercom speed-dial button is pressed, a call is speed-dialed to the directory that is the other
half of the dedicated pair. The called phone automatically answers the call in speakerphone mode with
mute activated, which provides a one-way voice path from the initiator to the recipient. A beep is
sounded when the call is auto-answered to alert the recipient to the incoming call. To respond to the
intercom call and open a two-way voice path, the recipient deactivates the mute function by pressing the
Mute button or, on phones such as the Cisco Unified IP Phone 7910, lifting the handset.
In Cisco CME 3.2.1 and later versions, you can deactivate the speaker-mute function on intercom calls.
For example, if phone user 1 makes an intercom call to phone user 2, both users hear each other on
connection when no-mute is configured. The benefit is that people who receive intercom calls can be
heard without them having to disable the mute function. The disadvantage is that nearby background
sounds and conversations can be heard the moment a person receives an intercom call, regardless of
whether they are ready to take a call or not.
Intercom lines cannot be used in shared-line configurations. If a directory number is configured for
intercom operation, it must be associated with one IP phone only. The intercom attribute causes an IP
phone line to operate as an autodial line for outbound calls and as an autoanswer-with-mute line for
inbound calls. Figure 32 shows an intercom between a receptionist and a manager.
To prevent an unauthorized phone from dialing an intercom line (and creating a situation in which a
phone automatically answers a nonintercom call), you can assign the intercom a directory number that
includes an alphabetic character. No one can dial the alphabetic character from a normal phone, but the
phone at the other end of the intercom can be configured to dial the number that contains the alphabetic
character through the Cisco Unified CME router. For example, the intercom ephone-dns in Figure 32 are
assigned numbers with alphabetic characters so that only the receptionist can call the manager on his or
her intercom line, and no one except the manager can call the receptionist on his or her intercom line.
Note An intercom requires the configuration of two ephone-dns, one each on a separate phone.
Cisco Unified Communications Manager Express System Administrator Guide
918 OL-10663-02
Configuring Intercom Lines
Information About Intercom Lines
Figure 32 Intercom Lines
ephone-dn 2
1 The receptionist at phone 6 2 Phone 7 beeps once and automatically number 2345
makes an intercom call to answers in speakerphone mode with
phone 7 by pressing button 2. mute activated. The manager hears the ephone-dn 3
receptionist’s voice and deactivates the number 4578
mute function to open a two-way voice
path for a reply. ephone-dn 18
number A5001
name "Intercom"
intercom A5002
IP IP
V ephone-dn 19
number A5002
Phone 6 - Receptionist Phone 7 - Manager name "Intercom"
Button 1 is extension 2345, a Button 1 is extension 4578, a intercom A5001
normal line. normal line.
Button 2 is extension A5001, a Button 2 is extension A5002, a ephone 6
dedicated intercom connection dedicated intercom connection to button 1:2 2:18
to intercom extension intercom extension
88952
A5002 on phone 7. A5001 on phone 6. ephone 7
button 1:3 2:19
Whisper Intercom
When a phone user dials a whisper intercom line, the called phone automatically answers using
speakerphone mode, providing a one-way voice path from the caller to the called party, regardless of
whether the called party is busy or idle.
Unlike the standard intercom feature, this feature allows an intercom call to a busy extension. The calling
party can only be heard by the recipient. The original caller on the receiving phone does not hear the
whisper page. The phone receiving a whisper page displays the extension and name of the party initiating
the whisper page and Cisco Unified CME plays a zipzip tone before the called party hears the caller's
voice. If the called party wants to speak to the caller, the called party selects the intercom line button on
their phone. The lamp for intercom buttons are colored amber to indicate one-way audio for whisper
intercom and green to indicate two-way audio for standard intercom.
You must configure a whisper intercom directory number for each phone that requires the Whisper
Intercom feature. A whisper intercom directory number can place calls only to another whisper intercom
directory number. Calls between a whisper intercom directory number and a standard directory number
or intercom directory number are rejected with a busy tone.
This feature is supported in Cisco Unified CME 7.1 and later versions. For configuration information,
see the “SCCP: Configuring Whisper Intercom” section on page 922.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 919
Configuring Intercom Lines
How to Configure Intercom Lines
How to Configure Intercom Lines
This section contains the following tasks:
• SCCP: Configuring an Intercom Auto-Answer Line, page 920 (required)
• SCCP: Configuring Whisper Intercom, page 922 (optional)
• SIP: Configuring an Intercom Auto-Answer Line, page 924 (required)
SCCP: Configuring an Intercom Auto-Answer Line
To enable a two-way audio path between two phones, perform the following steps for each SCCP phone
at both ends of the two-way voice path.
Restrictions
• Intercom lines cannot be dual-line.
• If a directory number is configured for intercom operation, it can be associated with only one
Cisco Unified IP phone.
• A separate configuration is required for each phone at both ends of the two-way voice path.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
4. number number
5. name name
6. intercom extension-number [[barge-in [no-mute] | no-auto-answer | no-mute] [label label]] |
label label]
7. exit
8. ephone phone-tag
9. button button-number:dn-tag [[button-number:dn-tag] ...]
10. end
Cisco Unified Communications Manager Express System Administrator Guide
920 OL-10663-02
Configuring Intercom Lines
How to Configure Intercom Lines
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode.
• Do not use the dual-line keyword with this
Example: command. Intercom ephone-dns cannot be
Router(config)# ephone-dn 11 dual-line.
Step 4 number number Assigns a valid intercom number.
• Using one or more alphabetic characters in an
Example: intercom number ensures that the number can
Router(config-ephone-dn)# number A2345 only be dialed from the one other intercom
number that is programmed to dial this number.
The number cannot be dialed from a normal
phone if it contains an alphabetic character.
Step 5 name name Sets a name to be associated with the ephone-dn.
• This name is used for caller-ID displays and also
Example: shows up in the local directory associated with
Router(config-ephone-dn)# name intercom the ephone-dn.
Step 6 intercom extension-number [[barge-in [no-mute] | Defines the directory number that is speed-dialed for
no-auto-answer | no-mute] [label label]] | label the intercom feature when this line is used.
label]
Example:
Router(config-ephone-dn)# intercom A2346 label
Security
Step 7 exit Exits ephone-dn configuration mode.
Example:
Router(config-ephone-dn)# exit
Step 8 ephone phone-tag Enters ephone configuration mode.
Example:
Router(config)# ephone 24
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 921
Configuring Intercom Lines
How to Configure Intercom Lines
Command or Action Purpose
Step 9 button button-number:dn-tag [[button-number:dn-tag] Assigns a button number to the intercom ephone-dn
...] being configured.
• Use the colon separator (:) between the button
Example: number and the intercom ephone-dn tag to
Router(config-ephone)# button 1:1 2:4 3:14 indicate a normal ring for the intercom line.
Step 10 end Exits configuration mode and enters privileged
EXEC mode.
Example:
Router(config)# exit
SCCP: Configuring Whisper Intercom
To enable the Whisper Intercom feature on a directory number, perform the following steps.
Prerequisites
• Cisco Unified CME 7.1 or a later version.
• IP phones require SCCP 12.0 or a later version.
Restrictions
• Not supported on single-line phone models such as the Cisco Unified IP Phone 7906 or 7911.
• Whisper intercom directory numbers can place calls only to other whisper intercom numbers.
• A directory number can be configured as either a regular intercom or a whisper intercom, not both.
• Dual-line and octo-line directory numbers are not supported as intercom lines.
• Only one intercom call, either incoming or outgoing, is allowed on the phone at one time.
• Call features are not supported on intercom calls.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
4. whisper-intercom [label string | speed-dial number [label string]]
5. end
6. show ephone-dn whisper
Cisco Unified Communications Manager Express System Administrator Guide
922 OL-10663-02
Configuring Intercom Lines
How to Configure Intercom Lines
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag Enters ephone configuration mode to create a directory
number for a SCCP phone.
Example:
Router(config)# ephone-dn 1
Step 4 whisper-intercom [label string | speed-dial Enables whisper intercom on a directory number.
number [label string]]
• label string—(Optional) Alphanumeric label that
identifies the whisper intercom button. String can
Example: contain a maximum of 30 characters.
Router(config-ephone-dn)# whisper intercom
• speed-dial number—(Optional) Telephone number to
speed dial.
Step 5 end Exits to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
Step 6 show ephone-dn whisper Display information about whisper intercom ephone-dns
that have been created.
Example:
Router# show ephone-dn whisper
Examples
The following example shows Whisper Intercom configured on extension 2004:
ephone-dn 24
number 2004
whisper-intercom label "sales"!
!
!
ephone 24
mac-address 02EA.EAEA.0001
button 1:24
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 923
Configuring Intercom Lines
How to Configure Intercom Lines
SIP: Configuring an Intercom Auto-Answer Line
To enable the Intercom Auto-Answer feature for SIP phones, perform the following steps for each SIP
phone at both ends of the two-way voice path.
Prerequisites
Cisco CME 3.4 or a later version.
Restrictions
• If a directory number is configured for intercom operation, it can be associated with only one
Cisco Unified IP phone.
• A separate configuration is required for each phone at each end of the two-way voice path.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register dn dn-tag
4. number number
5. auto-answer
6. exit
7. voice register pool pool-tag
8. id mac address
9. type phone-type
10. number tag dn dn-tag
11. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register dn dn-tag Enters voice register dn configuration mode to define a
directory number for a SIP phone, intercom line, voice port,
or an MWI.
Example:
Router(config-register-global)# voice register
dn 1
Cisco Unified Communications Manager Express System Administrator Guide
924 OL-10663-02
Configuring Intercom Lines
How to Configure Intercom Lines
Command or Action Purpose
Step 4 number number Defines a valid number for the directory number being
configured.
Example: • To prevent non intercom originators from manually
Router(config-register-dn)# number A5001 dialing an intercom destination, the number string can
contain alphabetic characters enabling the number to be
dialed only by the Cisco Unified CME router and not
from telephone keypads.
Step 5 auto-answer Enables the Intercom Auto Answer feature on the directory
number being configured.
Example:
Router(config-register-dn)# auto-answer
Step 6 exit Exits configuration mode to the next highest mode in the
configuration mode hierarchy.
Example:
Router(config-register-dn)# exit
Step 7 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for a SIP phone in
Cisco Unified CME.
Example:
Router(config)# voice register pool 3
Step 8 id {network address mask mask | ip address mask Explicitly identifies a locally available individual SIP phone to
mask | mac address} support a degree of authentication.
Example:
Router(config-register-pool)# id mac
0009.A3D4.1234
Step 9 type phone-type Defines a phone type for the SIP phone being configured.
Example:
Router(config-register-pool)# type 7960-7940
Step 10 number tag dn dn-tag Associates a directory number with the SIP phone being
configured.
Example:
Router(config-register-pool)# number 1 dn 17
Step 11 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-pool)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 925
Configuring Intercom Lines
Configuration Examples for Intercom Lines
Configuration Examples for Intercom Lines
This section contains the following example:
• Intercom Lines: Example, page 926
Intercom Lines: Example
The following example shows an intercom between two Cisco Unified IP phones. In this example,
ephone-dn 2 and ephone-dn 4 are normal extensions, while ephone-dn 18 and ephone-dn 19 are set as
an intercom pair. Ephone-dn 18 is associated with line button 2 on Cisco Unified IP phone 4.
Ephone-dn 19 is associated with line button 2 on Cisco Unified IP phone 5. The two ephone-dns provide
a two-way intercom between the two Cisco Unified IP phones.
ephone-dn 2
number 5333
ephone-dn 4
number 5222
ephone-dn 18
number 5001
name “intercom”
intercom 5002 barge-in
ephone-dn 19
name “intercom”
number 5002
intercom 5001 barge-in
ephone 4
button 1:2 2:18
ephone 5
button 1:4 2:19
Where to Go Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See “Generating Configuration Files for Phones” on page 261.
Paging
The paging feature sets up a one-way audio path to deliver information to a group of phones at one time.
For more information, see “Configuring Paging” on page 991.
Cisco Unified Communications Manager Express System Administrator Guide
926 OL-10663-02
Configuring Intercom Lines
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 927
Configuring Intercom Lines
Feature Information for Intercom Lines
Feature Information for Intercom Lines
Table 30 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 30 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 30 Feature Information for Intercom Lines
Cisco Unified CME
Feature Name Version Feature Information
Intercom Lines 3.4 Adds intercom feature, with no-mute function, for
supported Cisco Unified IP phones that are connected to a
Cisco Unified CME router and running SIP.
3.2.1 The no-mute function was introduced.
2.0 Intercom feature was introduced.
Whisper Intercom 7.1 Whisper intercom feature was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
928 OL-10663-02
Configuring Loopback Call Routing
Last Updated: January 3, 2008
This chapter describes the loopback call-routing feature in Cisco Unified Communications Manager
Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Loopback Call
Routing” section on page 936.
Contents
• Information About Loopback Call Routing, page 929
• How to Configure Loopback Call Routing, page 930
• Configuration Examples for Loopback Call Routing, page 934
• Additional References, page 935
• Feature Information for Loopback Call Routing, page 936
Information About Loopback Call Routing
To enable loopback call routing, you should understand the following concept:
• Loopback Call Routing, page 929
Loopback Call Routing
Loopback call routing in a Cisco Unified CME system is provided through a mechanism called
loopback-dn, which provides a software-based limited emulation of back-to-back physical voice ports
connected together to provide a loopback call-routing path for voice calls.
Loopback call routing and loopback-dn restricts the passage of call-transfer and call-forwarding
supplementary service requests through the loopback. Instead of passing these requests through, the
loopback-dn mechanism attempts to service the requests locally. This allows loopback-dn
configurations to be used in call paths where one of the external devices does not support call transfer
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 929
Configuring Loopback Call Routing
How to Configure Loopback Call Routing
or call forwarding (Cisco-proprietary or H.450-based). Control messages that request call transfer or call
forwarding are intercepted at the loopback virtual port and serviced on the local voice gateway. If
needed, this mechanism creates VoIP-to-VoIP call-routing paths.
Loopback call routing may be used for routing H.323 calls to Cisco Unity Express. For information on
configuring Cisco Unity Express, see the Cisco Unity Express documentation.
Note A preferred alternative to loopback call routing was introduced in Cisco CME 3.1. This alternative
blocks H.450-based supplementary service requests by using the following Cisco IOS commands:
no supplementary-service h450.2, no supplementary-service h450.3, and supplementary-service
h450.12. For more information, see “Configuring Call Transfer and Forwarding” on page 595.
Use of loopback-dn configurations within a VoIP network should be restricted to resolving critical
network interoperability service problems that cannot otherwise be solved. Loopback-dn configurations
are intended for use in VoIP network interworking where the alternative would be to make use of
back-to-back-connected physical voice ports. Loopback-dn configurations emulate the effect of a
back-to-back physical voice-port arrangement without the expense of the physical voice-port hardware.
Because digital signal processors (DSPs) are not involved in loopback-dn arrangements, the
configuration does not support interworking or transcoding between calls that use different voice codecs.
In many cases, use of back-to-back physical voice ports that do involve DSPs to resolve VoIP network
interworking issues is preferred, because it introduces fewer restrictions in terms of supported codecs
and call flows.
Loopback call routing requires two extensions (ephone-dns) to be separately configured, each as half of
a loopback-dn pair. Ephone-dns that are defined as a loopback-dn pair can only be used for loopback
call routing. In addition to defining the loopback-dn pair, you must specify preference, huntstop, class
of restriction (COR), and translation rules.
How to Configure Loopback Call Routing
This section contains the following tasks:
• SCCP: Enabling Loopback Call Routing, page 930
• Verifying Loopback Call Routing, page 934
SCCP: Enabling Loopback Call Routing
To enable loopback call-routing, perform the following steps for each ephone-dn that is part of the
loopback-dn pair.
Restrictions
Loopback-dns do not support T.38 fax relay.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
Cisco Unified Communications Manager Express System Administrator Guide
930 OL-10663-02
Configuring Loopback Call Routing
How to Configure Loopback Call Routing
4. number number [secondary number] [no-reg [both | primary]]
5. caller-id {local | passthrough}
6. no huntstop
7. preference preference-order [secondary secondary-order]
8. cor {incoming | outgoing} cor-list-name
9. translate {called | calling} translation-rule-tag
10. loopback-dn dn-tag [forward number-of-digits | strip number-of-digits] [prefix
prefix-digit-string] [suffix suffix-digit-string] [retry seconds] [auto-con] [codec {g711alaw |
g711ulaw}]
11. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode, creates an ephone-dn,
and optionally assigns it dual-line status.
Example: • dn-tag—Unique sequence number that identifies this
Router(config)# ephone-dn 15 ephone-dn during configuration tasks. Range is
platform- and version-dependent.
Note Ephone-dns used for loopback cannot be dual-line
ephone-dns.
Step 4 number number [secondary number] [no-reg Associates a number with this extension (ephone-dn).
[both | primary]]
• number—String of up to 16 digits that represents a
telephone or extension number to be associated with this
Example: ephone-dn.
Router(config-ephone-dn)# number 2001
• secondary—(Optional) Allows you to associate a second
telephone number with an ephone-dn.
• no-reg—(Optional) Specifies that this number should not
register with the H.323 gatekeeper. The no-reg keyword by
itself indicates that only the secondary number should not
register. The no-reg both keywords indicate that both
numbers should not register, and the no-reg primary
keywords indicate that only the primary number should not
register.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 931
Configuring Loopback Call Routing
How to Configure Loopback Call Routing
Command or Action Purpose
Step 5 caller-id {local | passthrough} Specifies caller-ID treatment for outbound calls originated
from the ephone-dn. The default if this command is not used is
as follows. For transferred calls, caller ID is provided by the
Example:
Router(config-ephone-dn)# caller-id local
number and name fields from the outbound side of the
loopback-dn. For forwarded calls, caller ID is provided by the
original caller ID of the incoming call. Settings for the caller-id
block command and translation rules on the outbound side are
executed.
• local—Passes the local caller ID on redirected calls. This
is the preferred usage.
• passthrough—Passes the original caller ID on redirected
calls.
Step 6 no huntstop Disables huntstop and allows call hunting behavior for an
extension (ephone-dn).
Example:
Router(config-ephone-dn)# no huntstop
Step 7 preference preference-order [secondary Sets dial-peer preference for an extension (ephone-dn).
secondary-order]
• preference-order—Preference order for the primary
number associated with an extension (ephone-dn). Range is
Example: 0 to 10, where 0 is the highest preference and 10 is the
Router(config-ephone-dn)# preference 1 lowest preference. Default is 0.
• secondary secondary-order—(Optional) Preference order
for the secondary number associated with the ephone-dn.
Range is 0 to 10, where 0 is the highest preference and 10
is the lowest preference. Default is 9.
Step 8 cor {incoming | outgoing} cor-list-name Applies a class of restriction (COR) to the dial peers associated
with an extension. COR specifies which incoming dial peer can
use which outgoing dial peer to make a call. Each dial peer can
Example:
Router(config-ephone-dn)# cor incoming
be provisioned with an incoming and an outgoing COR list.
corlist1 For information about COR, see “Dial Peer Configuration on
Voice Gateway Routers”.
Step 9 translate {called | calling} Selects an existing translation rule and applies it to a calling
translation-rule-tag number or a number that has been called. This command
enables the manipulation of numbers as part of a dial plan to
Example: manage overlapping or nonconsecutive numbering schemes.
Router(config-ephone-dn)# translate called • called—Translates the called number.
1
• calling—Translates the calling number.
• translation-rule-tag—Unique sequence number of the
previously defined translation rule. Range is
1 to 2147483647.
Note This command requires that you have previously
defined appropriate translation rules using the voice
translation-rule and rule commands.
Cisco Unified Communications Manager Express System Administrator Guide
932 OL-10663-02
Configuring Loopback Call Routing
How to Configure Loopback Call Routing
Command or Action Purpose
Step 10 loopback-dn dn-tag [forward Enables H.323 call transfer and call forwarding by using
number-of-digits | strip number-of-digits] hairpin call routing for VoIP endpoints that do not support
[prefix prefix-digit-string] [suffix
suffix-digit-string] [retry seconds]
Cisco-proprietary or H.450-based call-transfer and
[auto-con] [codec {g711alaw | g711ulaw}] call-forwarding.
• dn-tag—Unique sequence number that identifies the
Example: ephone-dn that is being paired for loopback with the
Router(config-ephone-dn)# loopback-dn 24 ephone-dn that is being configured. The paired ephone-dn
forward 15 prefix 415353.... must be one that is already defined in the system.
• forward number-of-digits—(Optional) Number of digits
in the original called number to forward to the other
ephone-dn in the loopback-dn pair. Range is 1 to 32.
Default is to forward all digits.
• strip number-of-digits—(Optional) Number of leading
digits to be stripped from the original called number before
forwarding to the other ephone-dn in the loopback-dn pair.
Range is 1 to 32. Default is to not strip any digits.
• prefix prefix-digit-string—(Optional) Defines a string of
digits to add in front of the forwarded called number.
Maximum number of digits in the string is 32. Default is
that no prefix is defined.
• suffix suffix-digit-string—(Optional) Defines a string of
digits to add to the end of the forwarded called number.
Maximum number of digits in the string is 32. Default is
that no suffix is defined. If you add a suffix that starts with
the pound character (#), the string must be enclosed in
quotation marks.
• retry seconds—(Optional) Number of seconds to wait
before retrying the loopback target when it is busy or
unavailable. Range is 0 to 32767. Default is that retry is
disabled and appropriate call-progress tones are passed to
the call originator.
• auto-con—(Optional) Immediately connects the call and
provides in-band alerting while waiting for the far-end
destination to answer. Default is that automatic connection
is disabled.
• codec—(Optional) Explicitly forces the G.711 A-law or
G.711 mu-law voice coding type to be used for calls that
pass through the loopback-dn. This overrides the G.711
coding type that is negotiated for the call and provides
conversion from mu-law to A-law if needed. Default is that
Real-Time Transport Protocol (RTP) voice packets are
passed through the loopback-dn without considering the
G.711 coding type negotiated for the calls.
• g711alaw—G.711 A-law, 64000 bits per second, for T1.
• g711ulaw—G.711 mu-law, 64000 bits per second, for E1.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 933
Configuring Loopback Call Routing
Configuration Examples for Loopback Call Routing
Command or Action Purpose
Step 11 end Exits to privileged exec mode.
Example:
Router(config-ephone-dn)# end
Verifying Loopback Call Routing
Step 1 Use the show running-config or show telephony-service ephone-dn command to display ephone-dn
configurations.
Configuration Examples for Loopback Call Routing
This section contains the following example:
• Enabling Loopback Call Routing: Example, page 934
Enabling Loopback Call Routing: Example
The following example uses ephone-dns 15 and 16 as a loopback-dn pair. Calls are routed through this
loopback ephone-dn pair in the following way:
• An incoming call to 4085552xxx enters the loopback pair through ephone-dn 16 and exits the
loopback via ephone-dn 15 as an outgoing call to 2xxx (based on the forward 4 digits setting).
• An incoming call to 6xxx enters the loopback pair through ephone-dn 15 and exits the loopback via
ephone-dn 16 as an outgoing call to 4157676xxx (based on the prefix 415767 setting).
ephone-dn 15
number 6...
loopback-dn 16 forward 4 prefix 415767
caller-id local
no huntstop
!
ephone-dn 16
number 4085552...
loopback-dn 15 forward 4
caller-id local
no huntstop
Cisco Unified Communications Manager Express System Administrator Guide
934 OL-10663-02
Configuring Loopback Call Routing
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 935
Configuring Loopback Call Routing
Feature Information for Loopback Call Routing
Feature Information for Loopback Call Routing
Table 31 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 31 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 31 Feature Information for Loopback Call Routing
Cisco Unified CME
Feature Name Version Feature Information
Loopback Call Routing 2.0 Loopback call routing was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
936 OL-10663-02
Configuring MLPP
First Published: January 20, 2009
Last Updated: October 7, 2009
This document describes the Multilevel Precedence and Preemption (MLPP) service introduced in
Cisco Unified Communications Manager Express 7.1 (Cisco Unified CME).
Finding Feature Information
Your software release may not support all the features documented in this module. For the latest feature
information and caveats, see the release notes for your platform and software release. To find information
about the features documented in this module, and to see a list of the releases in which each feature is
supported, see the “Feature Information for MLPP” section on page 962.
Use Cisco Feature Navigator to find information about platform support and Cisco IOS, Catalyst OS,
and Cisco IOS XE software image support. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Contents
• Prerequisites for MLPP, page 937
• Information About MLPP, page 938
• How to Configure MLPP, page 947
• Additional References, page 960
• Feature Information for MLPP, page 962
Prerequisites for MLPP
• Cisco Unified CME 7.1
• Cisco IOS Release 12.4(24)T
• To use Cisco Unified CME basic automatic call distribution (B-ACD) and auto-attendant (AA)
service as the MLPP attendant-console application, you must download and install the B-ACD
scripts. These scripts are available from the Cisco Unified CME Software Download site at
http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 937
Configuring MLPP
Information About MLPP
• You can use your own audio files for the blocked precedence announcement and busy station not
equipped for preemption announcement or you can use the audio files available from the
Cisco Unified CME Software Download site at
http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp.
Information About MLPP
Multilevel Precedence and Preemption (MLPP) service allows validated users to place priority calls, and
if necessary, to preempt lower-priority calls. Precedence indicates the priority level of a call. Preemption
is the process of terminating a lower-precedence call so a call of higher precedence can proceed. This
capability assures high-ranking personnel can communicate with critical organizations and personnel
during network stress situations, such as a national emergency or degraded network situation.
To configure MLPP service in Cisco Unified CME, you should understand the following concepts:
• Precedence, page 938
• Basic Precedence Call Setup, page 939
• Preemption, page 939
• Basic Preemption Call, page 940
• DSN Dialing Format, page 941
• MLPP Service Domains, page 943
• MLPP Indication, page 944
• MLPP Announcements, page 945
• Automatic Call Diversion (Attendant Console), page 946
Precedence
Precedence indicates the priority level associated with an MLPP call. Phone users can apply a
precedence level when making a call.
You define an MLPP access digit in Cisco Unified CME and assign a maximum precedence level to
individual phones. Phone users request a precedence call by dialing the access code NP, where N
specifies the preconfigured access digit and P specifies the requested precedence level, followed by the
phone number.
Table 32 lists the precedence levels that can be associated with an MLPP call in the Defense Switched
Network (DSN) domain.
Table 32 DSN Precedence Levels
Level Precedence
0 (high) Flash Override
1 Flash
2 Immediate
3 Priority
4 (low) Routine
Cisco Unified Communications Manager Express System Administrator Guide
938 OL-10663-02
Configuring MLPP
Information About MLPP
Table 33 lists the precedence levels that can be associated with an MLPP call in the Defense Red
Switched Network (DRSN) domain.
Table 33 DRSN Precedence Levels
Level Precedence
0 (high) Flash Override Override
1 Flash Override
2 Flash
3 Immediate
4 Priority
5 (low) Routine
A precedence call is any call with a precedence level higher than Routine. If precedence is not
specifically invoked, the system processes a call using normal call processing and call forwarding.
Emergency 911 calls are automatically assigned precedence level 0.
Cisco Unified CME provides precedence indications to the source and destination of a precedence call,
respectively, if either has MLPP indication enabled. For the source, this indication includes a precedence
ringback tone and display of the precedence level of the call, if the device supports display. For the
destination, the indication includes a precedence ringer tone and display of the precedence level of the
call, if the device supports display.
Basic Precedence Call Setup
The following sequence of events occurs during the setup of a precedence call:
1. Phone user goes off hook and dials a precedence call. The call pattern is NP-xxxx, where N is the
precedence access digit, P is the precedence level for the call, and xxx is the extension or phone
number of the called party.
2. The calling party receives the precedence ringback tone and the precedence display while the call is
processing.
3. The called party receives the precedence ringer tone and the precedence display that indicates the
precedence call.
Example
Party 1000 makes a precedence call to party 1001. To do so, party 1000 dials the precedence call pattern,
such as 80-1001.
While the call processes, the calling party (1000) receives the precedence ringback tone and precedence
display on their Cisco Unified IP Phone. After acknowledging the precedence call, the called party
(1001) receives a precedence ringer tone and a precedence display on their Cisco Unified IP Phone.
Preemption
Preemption is the process of terminating an active call of lower precedence so a call of higher precedence
can proceed. Preemption includes the notification and acknowledgement of preempted users and the
reservation of shared resources immediately after preemption and before call termination. Preemption
can take one of the following two forms:
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 939
Configuring MLPP
Information About MLPP
• User Access Preemption—This type of preemption applies to phones and other end-user devices. If
a called party is busy with a lower precedence call, both the called party and the party to which it is
connected, receive preemption notification and the existing call is cleared immediately.
For calls to Cisco Unified IP phones, the called party can hang up immediately to connect to the new
higher precedence call, or if the called party does not hang up, Cisco Unified CME forces the phone
on-hook after the configured preemption tone timer expires and connects the call.
For FXS ports, the called party must acknowledge the preemption by going on-hook, before being
connected to the new higher precedence call.
• Common Network Facility Preemption—This type of preemption applies to trunks. If all channels
of a PRI trunk are busy with calls of lower precedence, a call of lower precedence is preempted to
complete the higher precedence call.
Cisco Unified CME selects a trunk by first searching for an idle channel on all corresponding trunks
(based on matching the called number in the dial peer).
If an idle channel is not found, Cisco Unified CME performs a preemptive-search by searching one
trunk at a time for an idle channel. If no idle-channel is available on a trunk, preemption is
performed on the lowest of lower-precedence calls corresponding to the trunk. If none of the calls
corresponding to the trunk is of lower precedence, the next trunk is searched and so on.
SCCP phones support up to eight calls per directory number. When all lines are busy and a higher
precedence MLPP call comes in, Cisco Unified CME preempts a lower precedence call on one of the
channels of the directory number.
The maximum precedence level that a user can assign to an MLPP call originating from a specific phone
is set using ephone templates and applied to individual phones. Calls from directory numbers that are
shared by SCCP phones can have different maximum precedence levels, based on the precedence level
of the phone.
Basic Preemption Call
Figure 33 shows an example of user access preemption.
Figure 33 User Access Preemption Example
IP
1002 (2) Flash override call
(3) Precedence display 80-1001
(5) Precedence ringback
(1) Flash call active
81-1001
IP IP
1000 1001
(3) Preemption tone (3) Preemption tone
(no need to be preemption enabled) (4) On hook
(5) Precedence ringer (display)
203906
(must be preemption enabled)
Cisco Unified Communications Manager Express System Administrator Guide
940 OL-10663-02
Configuring MLPP
Information About MLPP
In this example, the following sequence of events occurs:
1. User 1000 places a call with precedence level 1 (flash) to user 1001, and preemption is enabled for
user 1001. In this example, user 1000 dials 81-1001 to place the precedence call.
2. User 1002 places a precedence call to user 1001 by dialing 80-1001. This call, which is of
precedence level 0 (flash override), is a higher precedence call than the active precedence call.
3. Phone 1002 receives precedence display (flash override display), and the phones that are involved
in the existing lower precedence call both play preemption tones (users 1000 and 1001).
4. To complete preemption, the parties who are involved in the lower precedence call hang up
(users 1000 and 1001).
5. The higher level precedence call is offered to user 1001, who receives a precedence ringer tone (if
MLPP indication is enabled). The calling party, user 1002, receives precedence ringback.
DSN Dialing Format
Cisco Unified CME 8.0 and later releases provide complete support of the DSN dialing format, as
outlined in Table 34.
Table 34 DSN Dialing Format
[Access-digit {Precedence-level | Service-digit}] [Route-code] [Area-code] Switch-code Line-number
[N {P | S}] [1X] [KXX] KXX XXXX
N is 2 - 9 P is 0 - 4 S is 5 - 9 X is 0 - 9 K is 2 - 8
Service Digit
The service digit provides information to the switch for connecting calls to government or public
telephone services or networks. The services are reached through the trunk or route that is selected based
on the dialed digits. Phone users request a service by dialing the access code NS, where N specifies the
preconfigured access digit and S specifies the requested service, followed by the phone number.
Table 35 lists the service digits supported in Cisco Unified CME 8.0 and later versions.
Table 35 Service Digit
Service Digit Precedence
5 Off-net 700 services
6 Not assigned
7 DSN CONUS FTS
8 Not assigned
9 Local PSTN
In Cisco Unified CME, the route pattern is configured to supply secondary dial-tone and the remainder
of the digits are collected and passed to the PSTN trunk as the called number. The digits that follow the
access digit and service digit must be NANP compliant (E.164 number).
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 941
Configuring MLPP
Information About MLPP
Cisco Unified CME provides secondary dial tone after the two digits and then routes the call based on
the remaining collected digits (using the dial plan configuration). These services are assumed to be
reached through the trunk (or route) selected based on the dialed digits (dialed after the route digits).
Route Code
The route code allows a phone user to inform the switch of special routing or termination requirements.
The route code determines whether a call uses circuit-switched data or voice-grade trunking and can be
used to disable echo suppressors and cancellers, and override satellite link control.
The first digit of the route code is 1. It is a required part of the dialing plan to inform the switch that the
next digit, the route digit, provides network instructions for specialized routing. Phone users dial route
codes in the form 1X, where X is the route digit. The supported route digits that a user can dial are
0 and 1.
Table 36 lists the route codes supported in Cisco Unified CME 8.0 and later versions:
Table 36 Route Codes
Route Code Use Description
10 Voice call (default) Any codec that carries voice or voice band
data, such as G.711, G.729, or fax or modem
pass-through.
11 Circuit-switched data Any codec that carries unaltered DS0 traffic
over IP (circuit emulation). For
Cisco Unified CME, this is the
audio/clearmode codec (RFC-4040).
Dialing Example
If the first digit that the user dials is the configured access digit, this indicates an access code where the
next digit is either a precedence digit or a service digit. If the next digit dialed is:
• 0-4—This is a precedence call. Cisco Unified CME sets the precedence indication, stores the
precedence value, and discards the digits.
• 5-9—This is a call to a particular service. Cisco Unified CME passes the call to the designated trunk,
discards the digits, and plays secondary dial tone.
If the first digit that the user dials or the next digit dialed after the access code is:
• 1—This is a route code and the next digit is a route digit. The supported route digits that a user can
dial are 0 and 1. Cisco Unified CME stores the route code for use later in route selection, sets a
trunk-type indication, and discards the route code digits.
If the first digit that the user dials or the next digit dialed after the access code or route code is:
• 2-8—This is the first digit of the area code or switch code. Area codes and switch codes in the DSN
are allocated so there is no overlap. The area code and/or switch code are used for route selection.
Cisco Unified Communications Manager Express System Administrator Guide
942 OL-10663-02
Configuring MLPP
Information About MLPP
MLPP Service Domains
Cisco Unified CME 8.0 and later versions support MLPP service domains. A service domain consists of
a group of MLPP subscribers and network resources. Calls and resources can only be preempted by
higher-priority calls from MLPP subscribers within the same domain.
You can configure each device with a domain type, such as DSN or DRSN, and a domain identifier. You
can assign a global MLPP domain type and identifier to the Cisco Unified CME router and assign
different service domains to the individual phones registered to Cisco Unified CME through an ephone
template. Calls from any phone that is not configured with a specific service domain use the global
domain type and identifier.
The MLPP precedence and preemption applies only within the same domain. Only calls within the same
domain can be preempted. If a call is placed between two subscribers with different MLPP service
domains, Cisco Unified CME assigns the service domain of the originator to the call.
Figure 34 shows an example of preemption attempted across domains with different identifier numbers.
Figure 34 Service Domains with Different Identifiers
IP
1002 (2) Flash override call
Domain type DSN
Domain identifier 0200
X (3) Preemption fails
because active call is
(1) Flash call active from domain with
different identifier
IP IP
1000 1001
276490
Domain type DSN Domain type DSN
Domain identifier 0100 Domain identifier 0200
In the example shown in Figure 34, the following sequence of events occurs:
1. User 1000, from service domain 0100, places a call with precedence level 1 (flash) to user 1001 in
service domain 0200. The call is assigned domain number 0100 because that is the service domain
of the call originator.
2. User 1002, from domain number 0200, places a precedence call to user 1001. This call, which is of
precedence level 0 (flash override), is a higher precedence call than the active precedence call.
3. The active call is not preempted because the incoming call is from a different service domain than
the active call; a call from domain 0200 cannot preempt a call from domain 0100.
In the example shown in Figure 35, the active call is not preempted because the incoming call is from a
different domain type than the active call; a call from the DSN cannot preempt a call from the DRSN.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 943
Configuring MLPP
Information About MLPP
Figure 35 Service Domains with Different Domain Types
IP
1002 (2) Flash override call
Domain type DSN
Domain identifier 0200
X (3) Preemption fails
because active call
(1) Flash call active is from different
domain type.
IP IP
1000 1001
206688
Domain type DRSN Domain type DSN
Domain identifier 0100 Domain identifier 0200
In the example shown in Figure 36, the active call is successfully preempted because the incoming call
has the same domain type and identifier as the active call.
Figure 36 Service Domains with Same Type and Identifier
IP
1002 (2) Flash override call
Domain type DSN
Domain identifier 0100
(3) Preemption succeeds
because active call
(1) Flash call active has same domain type
and identifier
IP IP
1000 1001
206689
Domain type DSN Domain type DSN
Domain identifier 0100 Domain identifier 0200
MLPP Indication
For basic MLPP calls with MLPP indication enabled, Cisco Unified CME instructs SCCP phones to play
the precedence ringer tone and display the precedence level.
For basic MLPP calls with preemption involved and MLPP indication enabled, Cisco Unified CME
instructs both parties to play the preemption tone and display the precedence level of the MLPP call on
the phone.
For an MLPP call with call waiting, if MLPP indication is enabled, Cisco Unified CME instructs SCCP
phones to play priority the call waiting tone instead of the regular call waiting tone.
Users receive an error tone if they attempt to make a call with a higher level of precedence than the
highest precedence level that is authorized for their phone.
Cisco Unified Communications Manager Express System Administrator Guide
944 OL-10663-02
Configuring MLPP
Information About MLPP
For example, user 1002 dials 80 to start a precedence call. Eight (8) represents the precedence access
digit, and zero (0) specifies the precedence level that the user attempts to use. If this user is not
authorized to make level 0 (flash override) precedence calls, the user receives an error tone.
MLPP Announcements
Users who are unable to place MLPP calls receive announcements that detail the reasons why a call was
unsuccessful. Table 37 lists the supported MLPP announcements.
Table 37 MLPP Announcements
Announcement Condition
Blocked Precedence Announcement (BPA)
(Switch name and Location). Equal or higher precedence An equal or higher precedence call is in progress.
calls have prevented completion of your call. Please hang Users receive the BPA if the destination party for the
up and try again. This is a recording. (Switch name and precedence call is off hook or if the destination party is busy
Location). with a precedence call of an equal or higher precedence.
BPA is not played if the destination party is configured for
Call Waiting or Call Forwarding, or uses automatic call
diversion to an attendant-console service.
Supported in Cisco Unified CME 7.1 and later versions.
Busy Not Equipped Announcement (BNEA)
(Switch name and Location). The number you have dialed Busy station not equipped for preemption.
is busy and not equipped for call waiting or preemption. Users receive the BNEA if the dialed number is busy and
Please hang up and try again. This is a recording. (Switch nonpreemptable.
name and Location).
BNEA is not played if the dialed number is configured for
Call Waiting or Call Forwarding, or has alternate party
designations.
Supported in Cisco Unified CME 7.1 and later versions.
Isolated Code Announcement (ICA)
(Switch name and Location). A service disruption has Operating or equipment problems encountered.
prevented the completion of your call. Please wait 30 The complete trunk group including all routes is busied
minutes and try again. In case of emergency call your manually at either end of the circuit or the complete trunk group
operator. This is a recording. (Switch name and Location). including all routes is in a carrier group alarm state (for
example, Loss of Signal, Remote Alarm Indication, or Alarm
Indication Signal).
Supported in Cisco Unified CME 8.0 and later versions.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 945
Configuring MLPP
Information About MLPP
Table 37 MLPP Announcements
Announcement Condition
Loss of C2 Features Announcement (LOC2)
— Call leaves DSN.
Users receive the LOC2 announcement when the call leaves the
Cisco Unified CME router on the trunk or when the user places
a call to a different domain.
For example, DSN callers who place calls to locations that
permit off-net terminations may receive an announcement
informing them that they have left the DSN.
Supported in Cisco Unified CME 8.0 and later versions.
Unauthorized Precedence Level Announcement (UPA)
(Switch name and Location). The precedence used is not Unauthorized precedence level is attempted.
authorized for your line. Please use an authorized Users receive the UPA when they attempt to make a precedence
precedence or ask your attendant for assistance. This is a call by using a higher level of precedence than the highest
recording. (Switch name and Location). precedence level that is authorized for their line.
Supported in Cisco Unified CME 8.0 and later versions.
Vacant Code Announcement (VCA)
(Switch name and Location). Your call cannot be No such service or invalid code.
completed as dialed. Please consult your directory and call Users receive the VCA when they dial an invalid or unassigned
again or ask your operator for assistance. This is a number.
recording. (Switch name and Location).
Supported in Cisco Unified CME 8.0 and later versions.
Automatic Call Diversion (Attendant Console)
Cisco Unified CME supports automatic diversion of all unanswered precedence calls above Routine to
a designated directory number or attendant console after a selected period of time.
If automatic call diversion of MLPP calls is configured in Cisco Unified CME, it overrides the
Call Forward settings on the phone for all incoming precedence calls above Routine and forwards these
calls to the attendant-console application specified in the MLPP configuration. Cisco Unified CME
treats MLPP calls with a precedence level of Routine as normal calls and honors the Call Forward setting
configured on the phone.
How Cisco Unified CME handles forwarded MLPP calls depends on the following Call Forward options:
• Call Forward All (CFA)—Precedence calls are routed to the target number of the attendant console
immediately. The CFA target is not used for MLPP calls.
• Call Forward Busy (CFB)—Precedence calls are forwarded to the configured CFB destination. If
the CFB destination is Voice Mail or an off-net endpoint, the call is forwarded to the target number
of the attendant-console service.
• Call Forward No Answer (CFNA)—Precedence calls are forwarded to the configured CFNA
destination. If the CFNA destination does not answer before the CFNA timer expires, or it is
voice mail or an off-net endpoint, the call is forwarded to the target number of the attendant-console
service.
Cisco Unified Communications Manager Express System Administrator Guide
946 OL-10663-02
Configuring MLPP
How to Configure MLPP
Calls diverted to the attendant console are indicated by a visual signal and placed in the queue for
attendant service by precedence and time interval. The call with the highest precedence and longest
holding time is answered first. Attendant Queue Announcement is played to calls waiting in the queue
for attendant service. Call distribution is performed to reduce excessive waiting time and each attendant
position operates from a common queue. Cisco Unified CME supports attendant console service for
MLPP using Basic Automatic Call Distribution (B-ACD) and auto-attendant (AA) service.
How to Configure MLPP
This section contains the following tasks.
• Enabling MLPP Service Globally in Cisco Unified CME, page 947
• Enabling MLPP Service on SCCP Phones, page 949
• Enabling MLPP Service on Analog FXS Ports, page 953
• Configuring an MLPP Service Domain for Outbound Dial Peers, page 955
• Configuring MLPP Options, page 956
• Troubleshooting MLPP Service, page 960
Enabling MLPP Service Globally in Cisco Unified CME
To enable MLPP globally in Cisco Unified CME, perform the following steps. This task covers the basic
steps necessary to enable MLPP on the router.
Prerequisites
Trunks must belong to a trunk group and have preemption enabled. For configuration information, see
“Enabling Preemption on the Trunk Group” in Integrating Data and Voice Services for ISDN PRI
Interfaces on Multiservice Access Routers.
Restrictions
• SIP phones are not supported.
• Cisco Unified IP Phone 6900 Series phones are not supported.
• Cisco Unified CME in SRST Fallback mode is not supported.
• Supports only ISDN PRI E1 and T1interfaces.
• Supports MLPP service within the local Cisco Unified CME router only.
• Cisco Unified CME 7.1 supports only Basic Calls, Call Forward, Call Hold and Resume,
Consultative Call-Transfer, and Call Waiting. Blind Transfer is not supported.
• Cisco Unified CME 8.0 and later versions support Three-Party Ad Hoc Conferencing and
Call Pickup.
• Call Park Retrieval based on precedence level is not supported; Cisco Unified CME must be
configured to accept only one call per park slot.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 947
Configuring MLPP
How to Configure MLPP
SUMMARY STEPS
1. enable
2. configure terminal
3. voice mlpp
4. access-digit digit
5. bnea audio-url
6. bpa audio-url
7. upa audio-url
8. service-domain {drsn | dsn} identifier domain-number
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice mlpp Enters voice MLPP configuration mode.
Example:
Router(config)# voice mlpp
Step 4 access-digit digit Defines the access digit that phone users dial to make an
MLPP call.
Example: • digit—Single-digit number that users dial.
Router(config-voice-mlpp)# access-digit 8 Range: 0 to 9. Default: 0.
Note Your domain type must support the access digit that
you select. For example, the valid range for the
DSN is 2 to 9.
Step 5 bnea audio-url Specifies the audio file to play for the busy station not
equipped for preemption announcement.
Example: • audio-url—Location of the announcement audio file in
Router(config-voice-mlpp)# bnea flash:bnea.au URL format. Valid storage locations are TFTP, FTP,
HTTP, and flash memory.
Step 6 bpa audio-url Specifies the audio file to play for the blocked precedence
announcement.
Example:
Router(config-voice-mlpp)# bpa flash:bpa.au
Cisco Unified Communications Manager Express System Administrator Guide
948 OL-10663-02
Configuring MLPP
How to Configure MLPP
Command or Action Purpose
Step 7 upa audio-url Specifies the audio file to play for the unauthorized
precedence announcement.
Example: • This command is supported in Cisco Unified CME 8.0
Router(config-voice-mlpp)# upa flash:upa.au and later versions.
Step 8 service-domain {drsn | dsn} identifier (Optional) Sets the global MLPP domain type and number.
domain-number
• drsn—Defense Red Switched Network (DRSN).
• dsn—Defense Switched Network (DSN). This is the
Example:
Router(config-voice-mlpp)# service-domain dsn
default value.
0010 • domain-number—Number to identify the global
domain, in three-octet format. Range: 0x000000 to
0xFFFFFF. Default: 0.
• A phone uses this global domain for MLPP calls if it is
not configured with the mlpp service-domain
command.
• This command is supported in Cisco Unified CME 8.0
and later versions.
Step 9 end Exits to privileged EXEC mode.
Example:
Router(config-voice-mlpp)# end
Examples
The following example shows MLPP enabled on the Cisco Unified CME router.
voice mlpp
access-digit 8
bpa flash:bpa.au
bnea flash:bnea.au
upa flash:upa.au
service-domain dsn identifier 000010
Enabling MLPP Service on SCCP Phones
To enable MLPP capabilities on an SCCP phone, perform the following steps.
Prerequisites
MLPP must be enabled globally on the Cisco Unified CME router. See the “Enabling MLPP Service
Globally in Cisco Unified CME” section on page 947.
Restrictions
The mlpp max-precedence command is not supported in Cisco Unified CME 8.0 and later versions; it
is replaced by the mlpp service-domain command.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 949
Configuring MLPP
How to Configure MLPP
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-template template-tag
4. mlpp service-domain {drsn | dsn} identifier domain-number max-precedence level
5. mlpp preemption
6. mlpp indication
7. exit
8. ephone phone-tag
9. ephone-template template-tag
10. restart
11. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-template template-tag Enters ephone-template configuration mode to create an
ephone template.
Example: • template-tag—Unique identifier for the ephone
Router(config)# ephone-template 15 template that is being created. Range: 1 to 20.
Cisco Unified Communications Manager Express System Administrator Guide
950 OL-10663-02
Configuring MLPP
How to Configure MLPP
Command or Action Purpose
Step 4 mlpp service-domain {drsn | dsn} identifier Sets the service domain and maximum precedence
domain-number max-precedence level (priority) level for MLPP calls from this phone.
• drsn—Phone belongs to the Defense Red Switched
Example: Network (DRSN).
Router(config-ephone-template)# mlpp
service-domain dsn identifier 0010 • dsn—Phone belongs to the Defense Switched Network
max-precedence 0 (DSN). This is the default value.
• domain-number—Number to identify the global
domain, in three-octet format. Range: 0x000000 to
0xFFFFFF.
• level—Maximum precedence level. Phone user can
specify a precedence level that is less than or equal to
this value.
– DSN—Range: 0 to 4, where 0 is the highest
priority.
– DRSN—Range: 0 to 5, where 0 is the highest
priority.
• This command is supported in Cisco Unified CME 8.0
and later versions.
Step 5 mlpp preemption (Optional) Enables calls on the phone to be preempted.
• Preemption is enabled by default. Skip this step unless
Example: you want to disable preemption with the no mlpp
Router(config-ephone-template)# no mlpp preemption command.
preemption
Step 6 mlpp indication (Optional) Enables the phone to play precedence and
preemption tones, and display the preemption level of calls.
Example: • MLPP indication is enabled by default. Skip this step
Router(config-ephone-template)# no mlpp unless you want to disable MLPP indication with the
indication no mlpp indication command.
Step 7 exit Exits ephone-template configuration mode.
Example:
Router(config-ephone-template)# exit
Step 8 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies
Example: this ephone during configuration tasks.
Router(config)# ephone 36
Step 9 ephone-template template-tag Applies an ephone template to the ephone that is being
configured.
Example:
Router(config-ephone)# ephone-template 15
Step 10 restart Performs a fast reboot of this ephone. Does not contact the
DHCP or TFTP server for updated information.
Example: Note Restart all ephones using the restart all command
Router(config-ephone)# restart in telephony-service configuration mode.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 951
Configuring MLPP
How to Configure MLPP
Command or Action Purpose
Step 11 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Examples
The following example shows a basic configuration for three phones, all using template 1 with MLPP
defined. Figure 37 shows an example of a precedence call using this configuration.
voice mlpp
access-digit 8
bpa flash:BPA.au
bnea flash:BNEA.au
upa flash:UPA.au
ephone-template 1
mlpp service-domain dsn identifier 000000 max-precedence 0
!Configures MLPP domain as DSN, identifier as 000000, and max-precedence set to 0
ephone-dn 1
number 1001
ephone-dn 2
number 1002
ephone-dn 3 dual-line
number 1003
huntstop channel
ephone 1
description Phone-A
mac-address 1111.2222.0001
button 1:1
ephone-template 1
! MLPP configuration inherited from ephone-template 1
ephone 2
description Phone-B
mac-address 1111.2222.0002
button 1:2
ephone-template 1
ephone-3
description Phone-C
mac-address 1111.2222.0003
button 1:3
ephone-template 1
Note The huntstop channel command must be configured on dual-line and octo-line directory numbers to
preempt a call on those types of lines. Otherwise the dual-line or octo-line receives Call Waiting
indication and the call is not preempted.
Cisco Unified Communications Manager Express System Administrator Guide
952 OL-10663-02
Configuring MLPP
How to Configure MLPP
Figure 37 Preemption Call Example
B
IP
1002 (3) Precedence call
(5) Precedence ringback 82-1003
(1) Precedence call active C
A 83-1003
IP IP
1001 1003
(1) Precedence ringback (1) Precedence ringer
206798
(3) Preemption tone (3) Preemption tone
(5) Precedence ringer
In this example, the following sequence of events occurs:
1. Phone A places a precedence call to Phone C by dialing 831003 (access digit 8 + precedence level
3 + destination number 1003).
Phone C hears the precedence ringer tone and Phone A hears the precedence ringback.
2. Phone C answers the call.
3. Phone B places a higher precedence call to Phone C by dialing 821003. Phone A and Phone C both
hear the preemption tone for the duration of the preemption tone timer command (default value is
three seconds).
4. Phone A is preempted after three seconds.
5. Phone C starts ringing (precedence ringer) and Phone B hears the precedence ringback.
6. Phone C answers the call.
Enabling MLPP Service on Analog FXS Ports
To enable MLPP capabilities for an analog FXS phone, perform the following steps.
Prerequisites
MLPP must be enabled globally on the Cisco Unified CME router. See the “Enabling MLPP Service
Globally in Cisco Unified CME” section on page 947.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice-port port
4. mlpp service-domain {drsn | dsn} identifier domain-number max-precedence level
5. mlpp preemption
6. mlpp indication
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 953
Configuring MLPP
How to Configure MLPP
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice-port port Enters voice-port configuration mode.
• Port argument is platform-dependent; type ? to display
Example: syntax.
Router(config)# voice-port 0/1/0
Step 4 mlpp service-domain {drsn | dsn} identifier Sets the service domain and maximum precedence
domain-number max-precedence level (priority) level for MLPP calls from this port.
• drsn—Port belongs to the Defense Red Switched
Example: Network (DRSN).
Router(config-voiceport)# mlpp service-domain
dsn identifier 0020 max-precedence 0 • dsn—Port belongs to the Defense Switched Network
(DSN).
• domain-number—Number to identify the global
domain, in three-octet format. Range: 0x000000 to
0xFFFFFF.
• level—Maximum precedence level. Phone user can
specify a precedence level that is less than or equal to
this value.
– DSN—Range: 0 to 4, where 0 is the highest
priority.
– DRSN—Range: 0 to 5, where 0 is the highest
priority.
• This command is supported in Cisco Unified CME 8.0
and later versions.
Step 5 mlpp preemption (Optional) Enables calls on the port to be preempted.
• Preemption is enabled by default. Skip this step unless
Example: you want to disable preemption with the no mlpp
Router(config-voiceport)# no mlpp preemption preemption command.
Step 6 mlpp indication (Optional) Enables the phone to play precedence and
preemption tones, and display the preemption level of calls.
Example: • MLPP indication is enabled by default. Skip this step
Router(config-voiceport)# no mlpp indication unless you want to disable MLPP indication with the
no mlpp indication command.
Cisco Unified Communications Manager Express System Administrator Guide
954 OL-10663-02
Configuring MLPP
How to Configure MLPP
Command or Action Purpose
Step 7 end Returns to privileged EXEC mode.
Example:
Router(config-voiceport)# end
Examples
The following example shows that the analog FXS phone connected to voice port 0/1/0 can make MLPP
calls with the highest precedence and its calls cannot be preempted.
voice-port 0/1/0
mlpp service-domain dsn identifier 000020 max-precedence 0
no mlpp preemption
station-id name uut1-fxs1
caller-id enable
Configuring an MLPP Service Domain for Outbound Dial Peers
To assign a service domain to MLPP calls that must leave the Cisco Unified CME router through the
trunk, perform the following steps for the corresponding dial peer.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice class mlpp tag
4. service-domain {drsn | dsn}
5. exit
6. dial-peer voice tag {pots | voip}
7. voice-class mlpp tag
8. exit
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 955
Configuring MLPP
How to Configure MLPP
Command or Action Purpose
Step 3 voice class mlpp tag Creates a voice class for the MLPP service.
• tag—Unique number to identify the voice class.
Example: Range: 1 to 10000.
Router(config)# voice class mlpp 1
Step 4 service-domain {drsn | dsn} Sets the network domain in the MLPP voice class.
• drsn—Defense Red Switched Network (DRSN).
Example: • dsn—Defense Switched Network (DSN).
Router(config-voice-class)# service-domain dsn
Step 5 exit Exits voice-class configuration mode.
Example:
Router(config-voice-class)# exit
Step 6 dial-peer voice tag {pots | voip} Enters dial peer voice configuration mode.
Example:
Router(config)# dial-peer voice 101 voip
Step 7 voice-class mlpp tag Assigns a previously configured MLPP voice class to a
POTS or VoIP dial peer.
Example: • tag—Unique number of the voice class that you created
Router(config-dial-peer)# voice-class mlpp 1 in Step 3.
Step 8 end Exits dial-peer voice configuration mode.
Example:
Router(config-dial-peer)# end
Examples
The following example shows an MLPP voice class defined for the DSN service domain. This voice
class is assigned to a POTS dial peer so that calls leaving port 0/1/0 use the DSN protocol.
voice class mlpp 1
service-domain dsn
!
!
dial-peer voice 1011 pots
destination-pattern 19101
voice-class mlpp 1
port 0/1/0
Configuring MLPP Options
To configure optional MLPP features or modify default settings, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
956 OL-10663-02
Configuring MLPP
How to Configure MLPP
3. voice mlpp
4. preemption trunkgroup
5. preemption user
6. preemption tone timer seconds
7. preemption reserve timer seconds
8. service-domain midcall-mismatch {method1 | method2 | method3 | method4}
9. service-digit
10. route-code
11. attendant-console number redirect-timer seconds
12. ica audio-url
13. loc2 audio-url
14. vca audio-url voice-class cause-code tag
15. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice mlpp Enters voice MLPP configuration mode.
Example:
Router(config)# voice mlpp
Step 4 preemption trunkgroup Enables preemption capabilities on a trunk group.
Example:
Router(config-voice-mlpp)# preemption
trunkgroup
Step 5 preemption user Enables all supported phones to preempt calls.
Example:
Router(config-voice-mlpp)# preemption user
Step 6 preemption tone timer seconds Sets the amount of time that the preemption tone plays on
the called phone when a lower precedence call is being
preempted.
Example:
Router(config-voice-mlpp)# preemption tone • seconds—Expiry time, in seconds. Range: 3 to 30.
timer 15 Default: 0 (disabled).
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 957
Configuring MLPP
How to Configure MLPP
Command or Action Purpose
Step 7 preemption reserve timer seconds Sets the amount of time to reserve a channel for a
preemption call.
Example: • seconds—Range: 3 to 30. Default: 0 (disabled).
Router(config-voice-mlpp)# preemption reserve
timer 10
Step 8 service-domain midcall-mismatch {method1 | Defines the behavior when there is a domain mismatch
method2 | method3 | method4} between the two legs of a call.
• method1—Domain remains unchanged for each of the
Example:
Router(config-voice-mlpp)# service-domain connections and the precedence level of the lower
midcall-mismatch method2 priority call changes to that of the higher priority call.
This is the default value.
• method2—Domain and precedence level of the lower
priority call changes to that of the higher priority call.
• method3—Domain remains unchanged for each of the
connections and the precedence levels change to
Routine for both calls.
• method4—Domains change to that of the connection
for which supplementary service was invoked (for
example, transferee in case of transfer). Precedence
levels change to Routine for both calls.
• This command is supported in Cisco Unified CME 8.0
and later versions.
Step 9 service-digit Enables phone users to request off-net services by dialing a
service digit.
Example: • This command is supported in Cisco Unified CME 8.0
Router(config-voice-mlpp)# service-digit and later versions.
Step 10 route-code Enables phone users to specify special routing for a call by
dialing a route code.
Example: • This command is supported in Cisco Unified CME 8.0
Router(config-voice-mlpp)# route-code and later versions.
Step 11 attendant-console number redirect-timer seconds Specifies the telephone number of the MLPP
attendant-console service where calls are redirected if the
phone does not answer.
Example:
Router(config-voice-mlpp)# attendant-console • number—Extension or E.164 telephone number of the
8100 redirect-timer 10 Cisco Unified CME basic automatic call distribution
(B-ACD) and auto-attendant (AA) service.
• seconds—Number of seconds to wait for the phone to
answer before redirecting the call.
Step 12 ica audio-url (Optional) Specifies the audio file to play for the isolated
code announcement.
Example: • This command is supported in Cisco Unified CME 8.0
Router(config-voice-mlpp)# ica flash:ica.au and later versions.
Cisco Unified Communications Manager Express System Administrator Guide
958 OL-10663-02
Configuring MLPP
How to Configure MLPP
Command or Action Purpose
Step 13 loc2 audio-url (Optional) Specifies the audio file to play for the loss of C2
features announcement.
Example: • This command is supported in Cisco Unified CME 8.0
Router(config-voice-mlpp)# loc2 flash:loc2.au and later versions.
Step 14 vca audio-url voice-class cause-code tag (Optional) Specifies the audio file to play for the vacant
code announcement.
Example:
• tag—Number of the voice class that defines the cause
Router(config-voice-mlpp)# vca flash:vca.au
voice-class cause-code 29 codes for which the VCA is played. Range: 1 to 64.
• This command is supported in Cisco Unified CME 8.0
and later versions.
Step 15 end Exits to privileged EXEC mode.
Example:
Router(config-voice-mlpp)# end
Examples
The following example shows an MLPP configuration with optional parameters.
voice mlpp
preemption trunkgroup
preemption user
preemption tone timer 15
preemption reserve timer 10
access-digit 8
attendant-console 8100 redirect-timer 10
service-digit
route-code
bpa flash:bpa.au
bnea flash:bnea.au
upa flash:upa.au
ica flash:ica.au
loc2 flash:loc2.au
vca flash:vca.au voice-class cause-code 29
service-domain midcall-mismatch method2
service-domain dsn identifier 000010
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 959
Configuring MLPP
Additional References
Troubleshooting MLPP Service
To troubleshoot MLPP services, perform the following steps.
SUMMARY STEPS
1. enable
2. debug ephone mlpp
3. debug voice mlpp
4. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 debug ephone mlpp Displays debugging information for MLPP calls to phones
in a Cisco Unified CME system.
Example:
Router# debug ephone mlpp
Step 3 debug voice mlpp Displays debugging information for the MLPP service.
Example:
Router# debug voice mlpp
Additional References
The following sections provide references related to Cisco Unified CME.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified Communications Manager Express System
Administrator Guide
• Cisco Unified Communications Manager Express Command
Reference
Cisco Unified CME network design • Cisco Unified CallManager Express Solution Reference
Network Design Guide
Cisco IOS voice configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Voice Command Reference
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Cisco Unified Communications Manager Express System Administrator Guide
960 OL-10663-02
Configuring MLPP
Additional References
Standards
Standard Title
No new or modified standards are supported by this —
feature, and support for existing standards has not been
modified by this feature.
MIBs
MIB MIBs Link
No new or modified MIBs are supported by this To locate and download MIBs for selected platforms, Cisco IOS
feature, and support for existing MIBs has not been releases, and feature sets, use Cisco MIB Locator found at the
modified by this feature. following URL:
http://www.cisco.com/go/mibs
RFCs
RFC Title
No new or modified RFCs are supported by this —
feature, and support for existing RFCs has not been
modified by this feature.
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 961
Configuring MLPP
Feature Information for MLPP
Feature Information for MLPP
Table 38 lists the release history for this feature.
Not all commands may be available in your Cisco IOS software release. For release information about
a specific command, see the command reference documentation.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 38 lists only the Cisco IOS software release that introduced support for a given feature in a given
Cisco IOS software release train. Unless noted otherwise, subsequent releases of that Cisco IOS
software release train also support that feature.
Table 38 Feature Information for MLPP
Cisco Unified CME
Feature Name Version Feature Information
MLPP Enhancements 8.0 Adds support for the following:
• Additional MLPP announcements
• Multiple service domains
• Route codes and service digits
• Interaction with supplementary services, such as
Three-Way Conference, Call Pickup, and Cancel Call
Waiting on Analog FXS ports
MLPP for Cisco Unified CME 7.1 Allows validated users to place priority calls, and if
necessary, to preempt lower-priority calls.
Cisco Unified Communications Manager Express System Administrator Guide
962 OL-10663-02
Configuring Music on Hold
Last Updated: September 27, 2010
This chapter describes the music on hold features in Cisco Unified Communications Manager Express
(Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Music on Hold”
section on page 990.
Contents
• Information About Music on Hold, page 964
• Prerequisites for Music on Hold, page 963
• Restrictions for Music on Hold, page 963
• How to Configure Music on Hold, page 968
• Additional References, page 989
• Feature Information for Music on Hold, page 990
Prerequisites for Music on Hold
• Phones receiving MOH in a system using G.729 require transcoding between G.711 and G.729. For
information about transcoding, see “Configuring Transcoding Resources” on page 329.
Restrictions for Music on Hold
• IP phones do not support multicast at 224.x.x.x addresses.
• Cisco Unified CME 3.3 and earlier versions do not support MOH for local Cisco Unified CME
phones that are on hold with other Cisco Unified CME phones; these parties hear a periodic
repeating tone instead.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 963
Configuring Music on Hold
Information About Music on Hold
• Cisco Unified CME 4.0 and later versions support MOH for internal calls only if the multicast moh
command is used to enable the flow of packets to the subnet on which the phones are located.
• Internal extensions that are connected through a Cisco VG224 Analog Voice Gateway or through a
WAN (remote extensions) do not hear MOH on internal calls.
• Multicast MOH is not supported on a phone if the phone is configured with the mtp command or
the paging-dn command with the unicast keyword.
Information About Music on Hold
To enable Music on Hold (MOH), you should understand the following concept:
• Music on Hold Summary, page 964
• Music on Hold from a Live Feed, page 965
• Multicast MOH, page 966
• Music on Hold for SIP Phones, page 966
• Music On Hold Enhancement, page 967
• Caching MOH Files for Enhanced System Performance, page 967
Music on Hold Summary
MOH is an audio stream that is played to PSTN and VoIP G.711 or G.729 callers who are placed on hold
by phones in a Cisco Unified CME system. This audio stream is intended to reassure callers that they
are still connected to their calls.
Table 2 provides a summary of options for MOH for PSTN and multicast MOH for local IP phones.
Table 39 Music on Hold (MOH)
Audio Source Description How to Configure
Flash memory No external audio input is required. Configuring Music on Hold
from an Audio File
Live feed The multicast audio stream has minimal Configuring Music on Hold
delay for local IP phones. The MOH from a Live Feed
stream for PSTN callers is delayed by a
few seconds. If the live feed audio input
fails, callers on hold hear silence.
Live feed and flash The live feed stream has a few seconds Configuring Music on Hold
memory of delay for both PSTN and local IP from an Audio File
phone callers. The flash MOH acts as
and
backup for the live-feed MoH.
Configuring Music on Hold
We recommend this option if you want from a Live Feed
live-feed because it provides guaranteed
MOH if the live-feed input is not found For configuration example, see
or fails. the “Examples” section on
page 982.
Cisco Unified Communications Manager Express System Administrator Guide
964 OL-10663-02
Configuring Music on Hold
Information About Music on Hold
Music on Hold
MOH is an audio stream that is played to PSTN and VoIP G.711 or G.729 callers who are placed on hold
by phones in a Cisco Unified CME system. This audio stream is intended to reassure callers that they
are still connected to their calls.
When the phone receiving MOH is part of a system that uses a G.729 codec, transcoding is required
between G.711 and G.729. The G.711 MOH must be translated to G.729. Note that because of
compression, MOH using G.729 is of significantly lower fidelity than MOH using G.711. For
information about transcoding, see “Configuring Transcoding Resources” on page 329.
The audio stream that is used for MOH can derive from one of two sources:
• Audio file—A MOH audio stream from an audio file is supplied from an .au or .wav file held in
router flash memory. For configuration information, see the “Configuring Music on Hold from an
Audio File” section on page 968.
• Live feed—A MOH audio stream from a live feed is supplied from a standard line-level audio
connection that is directly connected to the router through an FXO or “ear and mouth” (E&M)
analog voice port. For configuration information, see the “Configuring Music on Hold from a Live
Feed” section on page 971
If you configure both a live feed and an audio file as the source for MOH, the router seeks the live feed
first. If the live feed is found, it displaces the audio file source. If the live feed is not found or fails at
any time, the router falls back to the audio file source specified in the MOH audio file configuration.
This is the recommended configuration. For configuration example, see the “Examples” section on
page 976.
Music on Hold from a Live Feed
The live-feed feature is typically used to connect to a CD jukebox player. To configure MOH from a live
feed, you establish a voice port and dial peer for the call and also create a “dummy” ephone-dn. The
ephone-dn must have a phone or extension number assigned to it so that it can make and receive calls,
but the number is never assigned to a physical phone. Only one live MOH feed is supported per system.
Using an analog E&M port as the live-feed MOH interface requires the minimum number of external
components. You connect a line-level audio feed (standard audio jack) directly to pins 3 and 6 of an
E&M RJ-45 connector. The E&M voice interface card (VIC) has a built-in audio transformer that
provides appropriate electrical isolation for the external audio source. An audio connection on an E&M
port does not require loop-current. The signal immediate and auto-cut-through commands disable
E&M signaling on this voice port. A G.711 audio packet stream is generated by a digital signal processor
(DSP) on the E&M port.
If you use an FXO port as the live-feed MOH interface, connect the MOH source to the FXO port using
a MOD-SC cable if the MOH source has a different connector than the FXO RJ-11 connector. MOH
from a live feed is supported on the VIC2-2FXO, VIC2-4FXO, EM-HDA-3FXS/4FXO,
EM-HDA-6FXO, and EM2-HDA-4FXO.
You can directly connect a live-feed source to an FXO port if the signal loop-start live-feed command
is configured on the voice port; otherwise, the port must connect through an external third-party adapter
to provide a battery feed. An external adapter must supply normal telephone company (telco) battery
voltage with the correct polarity to the tip and ring leads of the FXO port and it must provide
transformer-based isolation between the external audio source and the tip and ring leads of the FXO port.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 965
Configuring Music on Hold
Information About Music on Hold
Music from a live feed is continuously fed into the MOH playout buffer instead of being read from a
flash file, so there is typically a 2-second delay. An outbound call to a MOH live-feed source is
attempted (or reattempted) every 30 seconds until the connection is made by the directory number that
has been configured for MOH. If the live-feed source is shut down for any reason, the flash memory
source will be automatically activated.
A live-feed MOH connection is established as an automatically connected voice call that is made by the
Cisco Unified CME MOH system or by an external source directly calling in to the live-feed MOH port.
An MOH call can be from or to the PSTN or can proceed via VoIP with voice activity detection (VAD)
disabled. The call is assumed to be an incoming call unless the optional out-call keyword is used with
the moh command during configuration.
The Cisco Unified CME router uses the audio stream from the call as the source for the MOH stream,
displacing any audio stream that is available from a flash file. An example of an MOH stream received
over an incoming call is an external H.323-based server device that calls the ephone-dn to deliver an
audio stream to the Cisco Unified CME router.
For configuration information, see the “Configuring Music on Hold from a Live Feed” section on
page 971.
Multicast MOH
In Cisco CME 3.0 and later versions, you can configure the MOH audio stream as a multicast source. A
Cisco Unified CME router that is configured for multicast MOH also transmits the audio stream on the
physical IP interfaces of the specified router to permit access to the stream by external devices.
Certain IP phones do not support multicast MOH because they do not support IP multicast. In
Cisco Unified CME 4.0 and later versions, you can disable multicast MOH to individual phones that do
not support multicast. Callers hear a repeating tone when they are placed on hold.
Music on Hold for SIP Phones
In Cisco Unified CME 4.1 and later versions, the MOH feature is supported when a call is put on hold
from a SIP phone and when the user of a SIP phone is put on hold by a SIP, SCCP, or POTS endpoint.
The holder (party that pressed the hold key) or holdee (party who is put on hold) can be on the same
Cisco Unified CME or a different Cisco Unified CME connected through a SIP trunk. MOH is also
supported for call transfers and conferencing, with or without a transcoding device.
Configuring MOH for SIP phones is the same as configuring MOH for SCCP phones. For configuration
information, see the “How to Configure Music on Hold” section on page 968.
Cisco Unified Communications Manager Express System Administrator Guide
966 OL-10663-02
Configuring Music on Hold
Information About Music on Hold
Music On Hold Enhancement
Cisco Unified CME 8.0 and later versions enhance the MOH feature by playing different media streams
to PSTN and VoIP callers who are placed on hold. The MOH enhancement allows you to configure up
to five additional media streams supplied from multiple media files stored in a router’s flash memory
and eliminates the need for separate routers for streaming MOH media files.
Cisco Unified CME 8.0 MOH enhancement allows you to create MOH groups and assign ephone
extension numbers to these MOH groups to receive different media streams. Callers to the extension
numbers configured under the MOH groups can listen to different MOH media streams when they are
placed on hold.
You can configure up to five MOH groups with media source files that are five minutes (2.5MB) long on
the Cisco Unified CME router for ephones in different departments in a branch. A MOH group is linked
to an ephone using the extension number of that ephone. For configuration information, see the
“Configuring Music on Hold Groups to Support Different Media Sources” section on page 977.
You can also configure individual directory numbers to select any MOH group as a MOH source on the
Cisco Unified CME router. The extension number of a directory associates an ephone to a specific MOH
group and callers to these extension numbers can listen to different media streams when placed on hold.
For configuration information, see the “Assigning a MOH Group to a Directory Number” section on
page 981.
Similarly, callers from internal directory numbers can listen to different media streams when a MOH
group is assigned for an internal call. For configuration information, see the “Assigning a MOH Group
to all Internal Calls (SCCP Only)” section on page 983
Following precedence rules are applicable when an ephone caller is placed on hold:
– MOH group defined for internal calls takes highest precedence
– MOH group defined in ephone-dn takes the second highest precedence
– MOH group defined in ephone-dn-template takes precedence if MOH group is not defined in
ephone-dn or internal call.
– Extension numbers defined in a MOH-group has the least precedence
– Phones not associated with any MOH groups default to the MOH parameters defined in the moh
command under telephony-service configuration mode.
Note If a selected MOH group does not exist, the caller will hear tone on hold.
Note We recommend that departments in a branch must have mutually exclusive extension numbers and
multicast destinations for configuring MOH groups.
Caching MOH Files for Enhanced System Performance
Caching MOH files helps enhance the system performance by reducing the CPU usage. However,
caching requires memory buffer to store a large MOH file. You can set up a buffer file size for caching
MOH files that you might use in the future. The default MOH file buffer size is 64 KB (8 seconds). The
maximum buffer size (per file) can be configured anywhere between 64 KB (8 minutes) to 10000 KB
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 967
Configuring Music on Hold
How to Configure Music on Hold
(approximately 20 minutes), You can use the moh-file-buffer command to allocate MOH file buffer for
future MOH files, see the, Configuring Buffer Size for MOH Files, page 984. To verify if a file is being
cached and to update a cached moh-file, see the, Verifying MOH File Caching, page 986
Note If the file size is too large, buffer size falls back to 64 KB.
How to Configure Music on Hold
This section contains the following tasks:
• Configuring Music on Hold from an Audio File, page 968
• Configuring Music on Hold from a Live Feed, page 971
• Configuring Music on Hold Groups to Support Different Media Sources, page 977
• Assigning a MOH Group to a Directory Number, page 981
• Configuring Buffer Size for MOH Files, page 984
• Verifying MOH File Caching, page 986
• Verifying Music on Hold Group Configuration, page 987
Configuring Music on Hold from an Audio File
To configure MOH when you are using a file to supply the audio stream, perform the following steps.
Note If you configure MOH from an audio file and from a live feed, the router seeks the live feed first. If a
live feed is found, it displaces an audio file source. If the live feed is not found or fails at any time, the
router falls back to the audio file source.
Prerequisites
• SIP phones require Cisco Unified CME 4.1 or a later version.
• A music file must be in stored in the router’s flash memory. This file should be in G.711 format.
The file can be in .au or .wav file format, but the file format must contain 8-bit 8-kHz data; for
example, ITU-T A-law or mu-law data format.
Restrictions
• To change the audio file to a different file, you must remove the first file using the no moh command
before specifying a second file. If you configure a second file without removing the first file, the
MOH mechanism stops working and may require a router reboot to clear the problem.
• The volume level of a MOH file cannot be adjusted through Cisco IOS software, so it cannot be
changed when the file is loaded into the flash memory of the router. To adjust the volume level of
a MOH file, edit the file in an audio editor before downloading the file to router flash memory.
Cisco Unified Communications Manager Express System Administrator Guide
968 OL-10663-02
Configuring Music on Hold
How to Configure Music on Hold
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. moh filename
5. multicast moh ip-address port port-number [route ip-address-list]
6. exit
7. ephone phone-tag
8. multicast-moh
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 moh filename Enables music on hold using the specified file.
• If you specify a file with this command and later
Example: want to use a different file, you must disable use
Router(config-telephony)# moh minuet.au of the first file with the no moh command before
configuring the second file.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 969
Configuring Music on Hold
How to Configure Music on Hold
Command or Action Purpose
Step 5 multicast moh ip-address port port-number [route Specifies that this audio stream is to be used for
ip-address-list] multicast and also for MOH.
Note This command is required to use MOH for
Example: internal calls and it must be configured after
Router(config-telephony)# multicast moh 239.10.16.4 MOH is enabled with the moh command.
port 16384 route 10.10.29.17 10.10.29.33
• ip-address—Destination IP address for
multicast.
• port port-number—Media port for multicast.
Range is 2000 to 65535. We recommend
port 2000 because it is already used for normal
RTP media transmissions between IP phones and
the router.
Note Valid port numbers for multicast include even
numbers that range from 16384 to 32767.
(The system reserves odd values.)
• route—(Optional) List of explicit router
interfaces for the IP multicast packets.
• ip-address-list—(Optional) List of up to four
explicit routes for multicast MOH. The default is
that the MOH multicast stream is automatically
output on the interfaces that correspond to the
address that was configured with the ip
source-address command.
Note For MOH on internal calls, packet flow must
be enabled to the subnet on which the phones
are located.
Step 6 exit Exits telephony-service configuration mode.
Example:
Router(config-telephony)# exit
Step 7 ephone phone-tag Enters ephone configuration mode.
Example:
Router(config)# ephone 28
Cisco Unified Communications Manager Express System Administrator Guide
970 OL-10663-02
Configuring Music on Hold
How to Configure Music on Hold
Command or Action Purpose
Step 8 multicast-moh (Optional) Enables multicast MOH on a phone. This
is the default.
Example: • This command is supported in
Router(config-ephone)# no multicast-moh Cisco Unified CME 4.0 and later versions.
• The no form of this command disables MOH for
phones that do not support multicast. Callers hear
a repeating tone when they are placed on hold.
• This command can also be configured in
ephone-template configuration mode. The value
set in ephone configuration mode has priority
over the value set in ephone-template mode.
Step 9 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Examples
The following example enables music on hold and specifies the music file to use:
telephony-service
moh minuet.wav
The following example enables MOH and specifies a multicast address for the audio stream:
telephony-service
moh minuet.wav
multicast moh 239.23.4.10 port 2000
Configuring Music on Hold from a Live Feed
To configure music on hold from a live feed, perform the following steps.
Note If you configure MOH from an audio file and from a live feed, the router seeks the live feed first. If a
live feed is found, it displaces an audio file source. If the live feed is not found or fails at any time, the
router falls back to the audio file source.
Prerequisites
• SIP phones require Cisco Unified CME 4.1 or a later version.
• VIC2-2FXO, VIC2-4FXO, EM-HDA-3FXS/4FXO, EM-HDA-6FXO, or EM2-HDA-4FXO
• For a live feed from VoIP, VAD must be disabled.
Restrictions
• A foreign exchange station (FXS) port cannot be used for a live feed.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 971
Configuring Music on Hold
How to Configure Music on Hold
SUMMARY STEPS
1. enable
2. configure terminal
3. voice-port port
4. input gain decibels
5. auto-cut-through (E&M only)
6. operation 4-wire (E&M only)
7. signal immediate (E&M only)
8. signal loop-start live-feed (FXO only)
9. no shutdown
10. exit
11. dial peer voice tag pots
12. destination-pattern string
13. port port
14. exit
15. ephone-dn dn-tag
16. number number
17. moh [out-call outcall-number] [ip ip-address port port-number [route ip-address-list]]
18. exit
19. ephone phone-tag
20. multicast-moh
21. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
972 OL-10663-02
Configuring Music on Hold
How to Configure Music on Hold
Command or Action Purpose
Step 3 voice-port port Enters voice-port configuration mode.
• Port argument is platform-dependent; type ? to display
Example: syntax.
Router(config)# voice-port 1/1/0
Step 4 input gain decibels Specifies, in decibels, the amount of gain to be inserted at
the receiver side of the interface.
Example: • decibels—Acceptable values are integers –6 to 14.
Router(config-voice-port)# input gain 0
Step 5 auto-cut-through (E&M ports only) Enables call completion when a PBX
does not provide an M-lead response.
Example: • MOH requires that you use this command with E&M
Router(config-voice-port)# auto-cut-through ports.
Step 6 operation 4-wire (E&M ports only) Selects the 4-wire cabling scheme.
• MOH requires that you specify 4-wire operation with
Example: this command for E&M ports.
Router(config-voice-port)# operation 4-wire
Step 7 signal immediate (E&M ports only) For E&M tie trunk interfaces, directs the
calling side to seize a line by going off-hook on its E-lead
and to send address information as dual tone
Example:
Router(config-voice-port)# signal immediate
multifrequency (DTMF) digits.
Step 8 signal loop-start live-feed (FXO ports only) Enables an MOH audio stream from a live
feed to be directly connected to the router through an FXO
port.
Example:
Router(config-voice-port)# signal loop-start • This command is supported in Cisco IOS
live-feed Release 12.4(15)T and later releases
Step 9 no shutdown Activates the voice port.
• To shut the voice port down and disable MOH from a
Example: live feed, use the shutdown command.
Router(config-voice-port)# no shutdown
Step 10 exit Exits voice-port configuration mode.
Example:
Router(config-voice-port)# exit
Step 11 dial peer voice tag pots Enters dial-peer configuration mode.
Example:
Router(config)# dial peer voice 7777 pots
Step 12 destination-pattern string Specifies either the prefix or the full E.164 telephone
number to be used for a dial peer.
Example:
Router(config-dial-peer)# destination-pattern
7777
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 973
Configuring Music on Hold
How to Configure Music on Hold
Command or Action Purpose
Step 13 port port Associates the dial peer with the voice port that was
specified in Step 3.
Example:
Router(config-dial-peer)# port 1/1/0
Step 14 exit Exits dial-peer configuration mode.
Example:
Router(config-dial-peer)# exit
Step 15 ephone-dn dn-tag Enters ephone-dn configuration mode.
• dn-tag—Unique sequence number that identifies this
Example: ephone-dn during configuration tasks. Range is
Router(config)# ephone-dn 55 1 to 288.
Step 16 number number Configures a valid extension number for this ephone-dn.
• This number is not assigned to any phone; it is only
Example: used to make and receive calls that contain an audio
Router(config-ephone-dn)# number 5555 stream to be used for MOH.
• number—String of up to 16 digits that represents a
telephone or extension number to be associated with
this ephone-dn.
Cisco Unified Communications Manager Express System Administrator Guide
974 OL-10663-02
Configuring Music on Hold
How to Configure Music on Hold
Command or Action Purpose
Step 17 moh [out-call outcall-number] [ip ip-address Specifies that this ephone-dn is to be used for an incoming
port port-number [route ip-address-list]] or outgoing call that is the source for an MOH stream.
• (Optional) out-call outcall-number—Indicates that the
Example: router is calling out for a live feed for MOH and
Router(config-ephone-dn)# moh out-call 7777 ip specifies the number to be called. Forces a connection
239.10.16.8 port 2311 route 10.10.29.3
to the local voice port that was specified in Step 3. If
10.10.29.45
or this command is used without this keyword, the MOH
stream is received from an incoming call.
Router(config-ephone-dn)# moh out-call 7777
• (Optional) ip ip-address—Destination IP address for
multicast.
If you are configuring MOH from a live feed and from
an audio file for backup, do not configure a multicast IP
address for this command. If the live feed fails or is not
found, MOH will fall back to the ip address that you
configured using the multicast moh command in
telephony-service configuration mode. See the
“Configuring Music on Hold from an Audio File”
section on page 968.
If you specify an address for multicast with this
command and a different address with the multicast
moh command in telephony-service configuration
mode, you can send the MOH audio stream to two
multicast addresses.
• (Optional) port port-number—Media port for
multicast. Range is 2000 to 65535. We recommend
port 2000 because it is already used for RTP media
transmissions between IP phones and the router.
• (Optional) route ip-address-list—Indicates specific
router interfaces on which to transmit the IP multicast
packets. Up to four IP addresses can be listed. Default:
The MOH multicast stream is automatically output on
the interfaces that correspond to the address that was
configured with the ip source-address command.
Step 18 exit Exits ephone-dn configuration mode.
Example:
Router(config-ephone-dn)# exit
Step 19 ephone phone-tag Enters ephone configuration mode.
Example:
Router(config)# ephone 28
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 975
Configuring Music on Hold
How to Configure Music on Hold
Command or Action Purpose
Step 20 multicast-moh (Optional) Enables multicast MOH on a phone. This is the
default.
Example: • This command is supported in Cisco Unified CME 4.0
Router(config-ephone)# no multicast-moh and later versions.
• The no form of this command disables MOH for
phones that do not support multicast. Callers hear a
repeating tone when they are placed on hold.
• This command can also be configured in
ephone-template configuration mode. The value set in
ephone configuration mode has priority over the value
set in ephone-template mode.
Step 21 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Examples
The following example enables MOH from an outgoing call on voice port 1/1/0 and dial peer 7777:
voice-port 1/1/0
auto-cut-through
operation 4-wire
signal immediate
!
dial-peer voice 7777 pots
destination-pattern 7777
port 1/1/0
!
ephone-dn 55
number 5555
moh out-call 7777
The following example enables MOH from a live feed and if the live feed is not found or fails at any
time, the router falls back to the music file (music-on-hold.au) and multicast address for the audio stream
specified in the telephony-service configuration:
voice-port 0/1/0
auto-cut-through
operation 4-wire
signal immediate
timeouts call-disconnect 1
description MOH Live Feed
!
dial-peer voice 7777 pots
destination-pattern 7777
port 0/1/0
!
telephony-service
max-ephones 24
max-dn 192
ip source-address 10.232.222.30 port 2000
moh music-on-hold.au
multicast moh 239.1.1.1 port 2000
!
Cisco Unified Communications Manager Express System Administrator Guide
976 OL-10663-02
Configuring Music on Hold
How to Configure Music on Hold
ephone-dn 52
number 1
moh out-call 7777
Configuring Music on Hold Groups to Support Different Media Sources
To configure a MOH group in Cisco Unified CME to support different MOH media sources, perform the
following steps.
Prerequisites
• Cisco Unified CME 8.0 or a later version.
Restrictions
• Media files from live-feed source are not supported.
• Each MOH group must contain a unique flash media file name, extension numbers, and multicast
destination. If you enter any extension ranges, MOH filenames, and Multicast IP addresses that
already exist in another MOH-group, an error message is issued and the new input in the current
voice MOH-group is discarded.
• Media file CODEC format is limited to G.711 and 8bit m-law
• MOH enhancement for internal calls is supported on SCCP phones only
• MOH enhancement is not supported if supplementary-service media-renegotiate is configured under
voice service VoIP
SUMMARY STEPS
1. enable
2. configure terminal
3. voice moh-group moh-group-tag
4. description string
5. moh filename
6. multicast moh ip-address port port-number route ip-address-list
7. extension-range starting-extension to ending-extension
8. exit
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 977
Configuring Music on Hold
How to Configure Music on Hold
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice moh-group moh-group-tag Enters the voice moh-group configuration mode. You
can create up to five voice moh-groups for ephones
receiving music on hold audio files when placed on
Example:
Router(config-telephony)# voice moh-group 1
hold. Range for the voice moh-groups is 1 to 5.
Step 4 description string (Optional) Allows you to add a brief description
specific to a voice MOH group. You can use up to 80
characters to describe the voice MOH group.
Example:
Router(config-voice-moh-group)# description moh
group for sales
Step 5 moh filename Enables music on hold using the specified MOH
source file. The MOH file must be in .au and .wav
format. MOH filename length should not exceed 128
Example:
Router(config-voice-moh-group)# moh flash:/minuet.au
characters. You must provide the directory and
filename of the MOH file in URL format. For
example: moh flash:/minuet.au
• If you specify a file with this command and later
want to use a different file, you must disable use
of the first file with the no moh command before
configuring the second file.
Cisco Unified Communications Manager Express System Administrator Guide
978 OL-10663-02
Configuring Music on Hold
How to Configure Music on Hold
Command or Action Purpose
Step 6 multicast moh ip-address port port-number route Specifies that this audio stream is to be used for
ip-address-list multicast and also for MOH.
Note This command is required to use MOH for
Example: internal calls and it must be configured after
Router((config-voice-moh-group)# multicast moh MOH is enabled with the moh command.
239.10.16.4 port 16384 route 10.10.29.17 10.10.29.33
• ip-address—Destination IP address for
multicast.
• port port-number—Media port for multicast.
Range is 2000 to 65535. We recommend
port 2000 because it is already used for normal
RTP media transmissions between IP phones and
the router.
Note Valid port numbers for multicast include even
numbers that range from 16384 to 32767.
(The system reserves odd values.)
• route—(Optional) List of explicit router
interfaces for the IP multicast packets.
• ip-address-list—(Optional) List of up to four
explicit routes for multicast MOH. The default is
that the MOH multicast stream is automatically
output on the interfaces that correspond to the
address that was configured with the ip
source-address command.
Note For MOH on internal calls, packet flow must
be enabled to the subnet on which the phones
are located.
Step 7 extension-range starting-extension to (Optional) Identifies MOH callers calling the
ending-extension extension numbers specified in a MOH group.
Extension number must be in hexadecimal digits
Example: (0-9) or (A-F). Both extension numbers (starting
Router(config-voice-moh-group)#extension-range 1000 extension and ending extension) must contain equal
to 1999 number of digits. Repeat this command to add
Router(config-voice-moh-group)#extension-range 2000 additional extension ranges.
to 2999
• starting-extension—(Optional) Lists the starting
extension number for a moh-group.
• ending-extension—(Optional) Lists the ending
extension number for a moh-group.
Note The ending extension number must be greater
than or equal to the starting extension
number. Extension-ranges must not overlap
with any other extension-range configured in
any other MOH group.
Note If extension range is defined and a
moh-group is also defined in an ephone-dn,
the ephone-dn parameters takes precedence.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 979
Configuring Music on Hold
How to Configure Music on Hold
Command or Action Purpose
Step 8 end Returns to privileged EXEC mode.
Example:
Router(config-voice-moh-group)# end
Examples
In the following example total six MOH groups are configured. MOH group 1 through 5 are configured
under voice-moh-group configuration mode and MOH group 0 is the MOH source file configured under
telephony-services.
router# show voice moh-group
telephony-service
moh alaska.wav
Moh multicast 239.1.1.1 port 16384 route 10.1.4.31 10.1.1.2
voice moh-group 1
description this moh group is for sales
moh flash:/hello.au
multicast moh 239.1.1.1 port 16386 route 239.1.1.3 239.1.1.3
extension-range 1000 to 1999
extension-range 2000 to 2999
extension-range 3000 to 3999
extension-range A1000 to A1999
voice moh-group 2
description (not configured)
moh flash1:/minuet.au
multicast moh 239.23.4.10 port 2000
extension-range 7000 to 7999
extension-range 8000 to 8999
voice moh-group 3
description This is for marketing
moh flash2:/happy.au
multicast moh 239.15.10.1 port 3000
extension-range 9000 to 9999
voice moh-group 4
description (not configured)
moh flash:/audio/sun.au
multicast moh 239.16.12.1 port 4000
extension-range 10000 to 19999
voice moh-group 5
description (not configured)
moh flash:/flower.wav
multicast moh 239.12.1.2 port 5000
extension-range 0012 to 0024
extension-range 0934 to 0964
=== Total of 6 voice moh-groups ===
Cisco Unified Communications Manager Express System Administrator Guide
980 OL-10663-02
Configuring Music on Hold
How to Configure Music on Hold
Assigning a MOH Group to a Directory Number
To assign a MOH group to a directory number, perform the following steps.
Prerequisites
• Cisco Unified CME 8.0 or a later version
• MOH groups must be configured under global configuration mode.
Restrictions
• Do not use same extension number for different MOH groups.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn ephone-dn-tag
4. number tag
5. moh-group moh-group-tag
6. ephone-dn-template ephone-dn-template-tag
7. exit
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 981
Configuring Music on Hold
How to Configure Music on Hold
Command or Action Purpose
Step 3 ephone-dn tag Enters ephone-dn configuration mode.
In ephone-dn configuration mode, you assign an extension
Example: number using the number command.
Router(config)# ephone-dn 1
You can also configure a MOH group to an ephone-dn-
template for use across a range of ephone-dns. If two
different MOH groups are configured as a result of this
command, the MOH group configured under the ephone-dn
configuration takes precedence.
Note MOH group configuration for ephone-template-dn
configuration command is temporarily prohibited
when any directory number using that template is on
hold.
Step 4 number Allows you to define an extension number and associate this
Router(config)# ephone-dn 1 number to a telephone,
Router(config-ephone-dn)# number 1001
Step 5 moh-group tag Allows you to assign a MOH group to a directory number.
• MOH group tag— identifies the unique number
Example: assigned to a MOH group for configuration tasks.
Router(config-telephony)#voice moh-group 1
Router(config-voice-moh-group)#
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Examples
In the following example different moh groups are assigned to different directory numbers (ephone-dn)
moh group1 is assigned to ephone-dn 1, moh-group 4 is assigned to ephone-dn 4, and moh-group 5 is
assigned to ephone-dn 5.
ephone-dn 1 octo-line
number 7001
name DN7001
moh-group 1
!
ephone-dn 2 dual-line
number 7002
name DN7002
call-forward noan 6001 timeout 4
!
ephone-dn 3
number 7003
name DN7003
snr 7005 delay 3 timeout 10
allow watch
call-forward noan 8000 timeout 30
!
!
ephone-dn 4 dual-line
number 7004
allow watch
call-forward noan 7001 timeout 10
Cisco Unified Communications Manager Express System Administrator Guide
982 OL-10663-02
Configuring Music on Hold
How to Configure Music on Hold
moh-group 4
!
ephone-dn 5
number 7005
name DN7005
moh-group 5
!
Assigning a MOH Group to all Internal Calls (SCCP Only)
To assign a MOH group to all internal calls, perform the following steps.
Prerequisites
• Cisco Unified CME 8.0 or a later version.
• MOH groups must be configured under global configuration mode.
Restrictions
• Do not use same extension number for different MOH groups.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony service
4. internal-call moh-group tag
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
In ephone-dn configuration mode, you assign an extension
Example: number using the number command.
Router(config-telephony)# ephone-dn 1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 983
Configuring Music on Hold
How to Configure Music on Hold
Command or Action Purpose
Step 4 internal-call moh-group tag Allows to assign a MOH-group for all internal directory
Router(config)# numbers.
Router(config-telephony)# internal call
moh-group 4 • Moh group tag— identifies the unique number assigned
to a MOH group for configuration tasks, Range for the
tag is from 0 to 5, where 0 represents MOH
configuration in telephony service.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Examples
The following examples shows moh-group 4 configured for internal directory calls.
telephony-service
sdspfarm conference mute-on *6 mute-off *8
sdspfarm units 4
sdspfarm transcode sessions 2
sdspfarm tag 1 moto-HW-Conf
moh flash1:/minuet.au
Moh multicast 239.1.1.1 port 16384 route 10.1.4.31 10.1.1.2
internal-call moh-group 4
em logout 0:0 0:0 0:0
max-ephones 110
max-dn 288
ip source-address 15.2.0.5 port 2000
auto assign 1 to 1
caller-id block code *9999
service phone settingsAccess 1
service phone spanTOPCPort 0
service dss
timeouts transfer-recall 12
Configuring Buffer Size for MOH Files
Prerequisites
• Cisco Unified CME 8.0 or a later version.
Restrictions
• MOH file caching is prohibited if live-feed is enabled for MOH-group 0.
• MOH file buffer size must be larger than the MOH file (size) that needs to be cached.
• Sufficient system memory must be available for MOH file caching.
Cisco Unified Communications Manager Express System Administrator Guide
984 OL-10663-02
Configuring Music on Hold
How to Configure Music on Hold
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony service
4. moh-file-buffer file size
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
In ephone-dn configuration mode, you assign an extension
Example: number using the number command.
Router(config-telephony)# ephone-dn 1
Step 4 moh-file-buffer file size (Optional) Allows to set a buffer for the MOH file size. You
can configure a max file buffer size (per file) anywhere
between 64KB (8 seconds) to 10000 KB (approximately 20
Example:
Router(config-telephony)# moh-file-buffer 2000
minutes), Default moh-file-buffer size is 64 KB (8
seconds).
Note A large buffer size is desirable to cache the largest
MOH file and a better system performance.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Examples
The following examples shows 90KB as the configured moh-file-buffer size.
telephony-service
sdspfarm conference mute-on *6 mute-off *8
sdspfarm units 4
sdspfarm transcode sessions 2
sdspfarm tag 1 moto-HW-Conf
moh flash1:/minuet.au
Moh multicast 239.1.1.1 port 16384 route 10.1.4.31 10.1.1.2
moh-file-buffer 2000
em logout 0:0 0:0 0:0
max-ephones 110
max-dn 288
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 985
Configuring Music on Hold
How to Configure Music on Hold
ip source-address 15.2.0.5 port 2000
auto assign 1 to 1
caller-id block code *9999
service phone settingsAccess 1
service phone spanTOPCPort 0
service dss
timeouts transfer-recall 12
Verifying MOH File Caching
Step 1 Use the show ephone moh command to verify if the a MOH file is being cached. The following
examples shows that the minuet.au music file in MOH group 1 is not cached. Follow steps a through d
to verify the MOH file is being cached.
Router #show ephone moh
Skinny Music On Hold Status (moh-group 1)
Active MOH clients 0 (max 830), Media Clients 0
File flash:/minuet.au (not cached) type AU Media_Payload_G711Ulaw64k 160 bytes
Moh multicast 239.10.16.6 port 2000
a. If the file is not cached as in MOH group 1 in the above example, then check file size in the flash.
For example:
Router#dir flash:/minuet.au
Directory of flash:/minuet.au 32 -rw- 1865696 Apr 25 2009 00:47:12 +00:00 moh1.au
b. Under telephony-service, configure “moh-file-buffer <file size>”. Default file size is 64 KB (8
seconds). Make sure you enter a larger file size to cache large MOH files that you may use in future.
For example:
Router(config)# telephony-service
Router(config-telephony)# moh-file-buffer 2000
c. Under voice moh-group <group tag>, configure “no moh”, and immediately configure “moh
<filename>”. This allows the MOH server to read the file immediately from flash again.
For example:
Router(config-telephony)#voice moh-group 1
Router(config-voice-moh-group)#no moh
Router(config-voice-moh-group)#moh flash:/minuet.au
d. Depending on the size of the file, you should see the MOH file caching after a few minutes
(approximately, 2 minutes).
For example:
Router #show ephone moh
Skinny Music On Hold Status - group 1
Active MOH clients 0 (max 830), Media Clients 0
File flash:/moh1.au (cached) type AU Media_Payload_G711Ulaw64k 160 bytes
Moh multicast 239.10.16.6 port 2000
Note MOH file caching is prohibited under the following conditions: if live feed is configured in
moh-group 0, If file buffer size smaller than file size, or insufficient system memory.
Cisco Unified Communications Manager Express System Administrator Guide
986 OL-10663-02
Configuring Music on Hold
How to Configure Music on Hold
Verifying Music on Hold Group Configuration
Step 1 Use the show voice moh-group command to display one or the entire moh-group configuration. The
following example shows all six MOH groups with extension ranges, MOH files, and multicast
destination addresses.
router# show voice moh-group
telephony-service
moh alaska.wav
Moh multicast 239.1.1.1 port 16384 route 10.1.4.31 10.1.1.2
voice moh-group 1
description this moh group is for sales
moh flash:/audio?minuet.au
multicast moh 239.1.1.1 port 16386 route 239.1.1.3 239.1.1.3
extension-range 1000 to 1999
extension-range 2000 to 2999
extension-range 3000 to 3999
extension-range 20000 to 22000
extension-range A1000 to A1999
voice moh-group 2
description (not configured)
moh flash:/audio/hello.au
multicast moh 239.23.4.10 port 2000
extension-range 7000 to 7999
extension-range 8000 to 8999
voice moh-group 3
description This is for marketing
moh flash:/happy.au
multicast moh 239.15.10.1 port 3000
extension-range 9000 to 9999
voice moh-group 4
description (not configured)
moh flash:/audio/sun.au
multicast moh 239.16.12.1 port 4000
extension-range 10000 to 19999
voice moh-group 5
description (not configured)
moh flash:/flower.wav
multicast moh 239.12.1.2 port 5000
extension-range 0012 to 0024
extension-range 0934 to 0964
=== Total of 6 voice moh-groups ===
Step 2 Use the show ephone moh to display information about the different MOH group configured. The
following example displays information about five different MOH groups.
Router #show ephone moh
Skinny Music On Hold Status (moh-group 1)
Active MOH clients 0 (max 830), Media Clients 0
File flash:/minuet.au (not cached) type AU Media_Payload_G711Ulaw64k 160 bytes
Moh multicast 239.10.16.6 port 2000
Skinny Music On Hold Status (moh-group 2)
Active MOH clients 0 (max 830), Media Clients 0
File flash:/audio/hello.au type AU Media_Payload_G711Ulaw64k 160 bytes
Moh multicast on 239.10.16.6 port 2000 via 0.0.0.0
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 987
Configuring Music on Hold
How to Configure Music on Hold
Skinny Music On Hold Status (moh-group 3)
Active MOH clients 0 (max 830), Media Clients 0
File flash:/bells.au type AU Media_Payload_G711Ulaw64k 160 bytes
Moh multicast on 239.10.16.5 port 2000 via 0.0.0.0
Skinny Music On Hold Status (moh-group 4)
Active MOH clients 0 (max 830), Media Clients 0
File flash:/3003.au type AU Media_Payload_G711Ulaw64k 160 bytes
Moh multicast on 239.10.16.7 port 2000 via 0.0.0.0
Skinny Music On Hold Status (moh-group 5)
Active MOH clients 0 (max 830), Media Clients 0
File flash:/4004.au type AU Media_Payload_G711Ulaw64k 160 bytes
Moh multicast on 239.10.16.8 port 2000 via 0.0.0.0
Step 3 Use the show voice moh-group statistics command to display the MOH subsystem statistics
information. In the following example, the MOH Group Streaming Interval Timing Statistics shows the
media packet counts during streaming intervals. Each packet counter is of 32 bit size and holds a count
limit of 4294967296. This means that with 20 milliseconds packet interval (for G.711), the counters will
restart from 0 any time after 2.72 years (2 years 8 months). Use the clear voice moh-group statistics
once in every two years to reset the packet counters.
MOH Group Packet Transmission Timing Statistics shows the maximum and minimum amount of time
(in microseconds) taken by the MOH groups to send out media packets.
The MOH Group Loopback Interval Timing Statistics is available when loopback interface is configured
as part of the multicast MOH routes as in the case of SRST. These counts are loopback packet counts
within certain streaming timing intervals.
router#show voice moh-group statistics
MOH Group Streaming Interval Timing Statistics:
Grp# ~19 msec 20~39 40~59 60~99 100~199 200+ msec
==== ========== ========== ========== ========== ========== ==========
0: 25835 17559966 45148 0 0 1
1: 19766 17572103 39079 0 0 1
2: 32374 17546886 51687 0 0 1
3: 27976 17555681 47289 0 0 1
4: 34346 17542940 53659 0 0 1
5: 14971 17581689 34284 0 0 1
MOH Group Packet Transmission Timing Statistics:
Grp# max(usec) min(usec)
==== ========== ==========
0: 97 7.
1: 95 7.
2: 97 7.
3: 96 7.
4: 94 7.
5: 67 7.
MOH Group Loopback Interval Timing Statistics:
loopback event array: svc_index=1542, free_index=1549, max_q_depth=31
Grp# ~19 msec 20~39 40~59 60~99 100~199 200+ msec
==== ========== ========== ========== ========== ========== ==========
0: 8918821 8721527 10023 0 1 1
1: 9007373 8635813 7184 0 1 1
2: 8864760 8772851 12758 0 1 1
3: 8924447 8715457 10464 0 1 1
4: 8858393 8778957 13017 0 1 1
5: 9005511 8639936 4919 0 1 1
Cisco Unified Communications Manager Express System Administrator Guide
988 OL-10663-02
Configuring Music on Hold
Additional References
Statistics collect time: 4 days 2 hours 5 minutes 39 seconds.
Step 4 Use the clear voice moh-group statistics command to clear the display of MOH subsystem statistics
information.
For Example:
router#clear voice moh-group statistics
All moh group stats are cleared
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 989
Configuring Music on Hold
Feature Information for Music on Hold
Feature Information for Music on Hold
Table 40 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 40 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 40 Feature Information for Music on Hold
Cisco Unified CME
Feature Name Version Feature Information
Music on Hold 8.0 Music on hold from different media sources was added.
4.1 Music on hold for SIP phones was supported.
4.0 • Music on hold was introduced for internal calls.
• The ability to disable multicast MOH per phone was
introduced.
3.0 The ability to use a live audio feed as a multicast source
was introduced.
2.1 Music on hold from a live audio feed was introduced for
external calls.
2.0 Music on hold from an audio file was introduced for
external calls.
Cisco Unified Communications Manager Express System Administrator Guide
990 OL-10663-02
Configuring Paging
Last Updated: January 3, 2008
This chapter describes the paging feature in Cisco Unified Communications Manager Express
(Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Paging” section on
page 1001.
Contents
• Information About Paging, page 991
• How to Configure Paging, page 993
• Configuration Examples for Paging, page 997
• Where to Go Next, page 1000
• Additional References, page 1000
• Feature Information for Paging, page 1001
Information About Paging
To enable paging, you should understand the following concept:
• Audio Paging, page 991
Audio Paging
A paging number can be defined to relay audio pages to a group of designated phones. When a caller
dials the paging number (ephone-dn), each idle IP phone that has been configured with the paging
number automatically answers using its speakerphone mode. Displays on the phones that answer the
page show the caller ID that has been set using the name command under the paging ephone-dn. When
the caller finishes speaking the message and hangs up, the phones are returned to their idle states.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 991
Configuring Paging
Information About Paging
Audio paging provides a one-way voice path to the phones that have been designated to receive paging.
It does not have a press-to-answer option like the intercom feature. A paging group is created using a
dummy ephone-dn, known as the paging ephone-dn, that can be associated with any number of local IP
phones. The paging ephone-dn can be dialed from anywhere, including on-net.
After you have created two or more simple paging groups, you can unite them into combined paging
groups. By creating combined paging groups, you provide phone users with the flexibility to page a
small local paging group (for example, paging four phones in a store’s jewelry department) or to page a
combined set of several paging groups (for example, by paging a group that consists of both the jewelry
department and the accessories department).
The paging mechanism supports audio distribution using IP multicast, replicated unicast, and a mixture
of both (so that multicast is used where possible, and unicast is used for specific phones that cannot be
reached using multicast).
Figure 38 shows a paging group with two phones.
Figure 38 Paging Group
1 To page all the phones in the shipping IP Any phone dials 4444.
department, a person at any phone dials
the number associated with the paging
ephone-dn for the shipping department.
The paging ephone-dn has a number that
does not appear on any phone (in this
example, extension 4444). Ephone-dn 4
Extension 4444
This is a paging ephone-dn; no physical phone
instrument is associated with this number.
2 A one-way voice connection is automatically 4444
made with all idle ephones that are
configured with paging ephone-dn 4. In this
example, that is phone 1 and phone 2. Both
phones answer the call in speakerphone V
mode. The voice of the calling party is heard
through the speaker, and the phone displays
the caller ID (name) of paging ephone-dn 4 Phone 1
("Paging Shipping"). Button 1 is extension 2121, a
IP
normal line.
This phone has a paging-dn to
receive pages.
ephone-dn 4
number 4444 Phone 2
name Paging Shipping Button 1 is extension 2222, a normal line.
IP This phone has a paging-dn to receive
paging ip 239.0.1.20 port 2000
pages.
ephone-dn 21
number 2121
ephone-dn 22 Note that paging-dns are not
number 2222 assigned to phone buttons.
ephone 1
mac-address 3662.0234.6ae2
button 1:21
paging-dn 4
ephone 2
88953
mac-address 9387.6738.2873
button 1:22
paging-dn 4
Cisco Unified Communications Manager Express System Administrator Guide
992 OL-10663-02
Configuring Paging
How to Configure Paging
How to Configure Paging
This section contains the following tasks:
• SCCP: Configuring a Simple Paging Group, page 993 (required)
• SCCP: Configuring a Combined Paging Group, page 994 (optional)
• Verifying Paging, page 997 (optional)
SCCP: Configuring a Simple Paging Group
To set up a paging number that relays incoming pages to a group of phones, perform the following steps.
Restrictions
IP phones do not support multicast at 224.x.x.x addresses.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn paging-dn-tag
4. number number
5. name name
6. paging [ip multicast-address port udp-port-number]
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn paging-dn-tag Enters ephone-dn configuration mode.
• paging-dn-tag—A unique sequence number that identifies this
Example: paging ephone-dn during all configuration tasks. This is the
Router(config)# ephone-dn 42 ephone-dn that is dialed to initiate a page. This ephone-dn is not
associated with a physical phone. Range is 1 to 288.
Note Do not use the dual-line keyword with this command.
Paging ephone-dns cannot be dual-line.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 993
Configuring Paging
How to Configure Paging
Command or Action Purpose
Step 4 number number Defines an extension number associated with the paging ephone-dn.
This is the number that people call to initiate a page.
Example:
Router(config-ephone-dn)# number 3556
Step 5 name name Assigns to the paging number a name to appear in caller-ID displays
and directories.
Example:
Router(config-ephone-dn)# name paging4
Step 6 paging [ip multicast-address port Specifies that this ephone-dn is to be used to broadcast paging
udp-port-number] messages to the idle IP phones that are associated with the paging
dn-tag. If the optional keywords and arguments are not used, IP
Example: phones are paged individually using IP unicast transmission (to a
Router(config-ephone-dn)# paging ip maximum of ten IP phones). The optional keywords and arguments
239.1.1.10 port 2000 are as follows:
• ip multicast-address port udp-port-number—Specifies
multicast broadcast using the specified IP address and UDP
port. When multiple paging numbers are configured, each
paging number must use a unique IP multicast address. We
recommend port 2000 because it is already used for normal
non-multicast RTP media streams between phones and the
Cisco Unified CME router.
Note IP phones do not support multicast at 224.x.x.x addresses.
Step 7 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
SCCP: Configuring a Combined Paging Group
To set up a combined paging group consisting of two or more simple paging groups, perform the
following steps.
Prerequisites
Simple paging groups must be configured. See the “SCCP: Configuring a Simple Paging Group” section
on page 993.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn paging-dn-tag
4. number number
5. name name
6. paging group paging-dn-tag,paging-dn-tag[[,paging-dn-tag]...]
Cisco Unified Communications Manager Express System Administrator Guide
994 OL-10663-02
Configuring Paging
How to Configure Paging
7. exit
8. ephone phone-tag
9. paging-dn paging-dn-tag {multicast | unicast}
10. exit
11. Repeat Step 8 to Step 10 to add additional IP phones to the paging group.
12. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn paging-dn-tag Enters ephone-dn configuration mode to create a paging number for
a combined paging group.
Example: • paging-dn-tag—A unique sequence number that identifies this
Router(config)# ephone-dn 42 paging ephone-dn during all configuration tasks. This is the
ephone-dn that is dialed to initiate a page. This ephone-dn is not
associated with a physical phone. Range is 1 to 288.
Note Do not use the dual-line keyword with this command.
Paging ephone-dns cannot be dual-line.
Step 4 number number Defines an extension number associated with the combined group
paging ephone-dn. This is the number that people call to initiate a
page to the combined group.
Example:
Router(config-ephone-dn)# number 3556
Step 5 name name (Optional) Assigns to the combined group paging number a name to
appear in caller-ID displays and directories.
Example:
Router(config-ephone-dn)# name paging4
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 995
Configuring Paging
How to Configure Paging
Command or Action Purpose
Step 6 paging group paging-dn-tag,paging-dn-tag Sets the paging directory number for a combined group. This
[[,paging-dn-tag]...] command combines the individual paging group ephone-dns that
you specify into a combined group so that a page can be sent to more
Example: than one paging group at a time.
Router(config-ephone-dn)# paging group • paging-dn-tag—Unique sequence number associated with the
20,21
paging number for an individual paging group. List the
paging-dn-tags of all the individual groups that you want to
include in this combined group, separated by commas. You can
include up to ten paging ephone-dn tags in this command.
Note Configure the paging command for all ephone-dns in a
paging group before configuring the paging group
command for that group.
Step 7 exit Exits ephone-dn configuration mode.
Example:
Router(config-ephone-dn)# exit
Step 8 ephone phone-tag Enters ephone configuration mode to add IP phones to the paging
group.
Example: • phone-tag—Unique sequence number of a phone to receive
Router(config)# ephone 2 audio pages when the paging ephone-dn is called.
Step 9 paging-dn paging-dn-tag {multicast | Associates this ephone with an ephone-dn tag that is used for a
unicast} paging ephone-dn (the number that people call to deliver a page).
Note that the paging ephone-dn tag is not associated with a line
Example: button on this ephone.
Router(config-ephone)# paging-dn 42 The paging mechanism supports audio distribution using IP
multicast
multicast, replicated unicast, and a mixture of both (so that
multicast is used where possible and unicast is allowed to specific
phones that cannot be reached through multicast).
• paging-dn-tag—Unique sequence number for a paging
ephone-dn.
• multicast—(Optional) Multicast paging for groups. By default,
paging is transmitted to the Cisco Unified IP phone using
multicast.
• unicast—(Optional) Unicast paging for a single
Cisco Unified IP phone. This keyword indicates that the
Cisco Unified IP phone is not capable of receiving paging
through multicast and requests that the phone receive paging
through a unicast transmission directed to the individual phone.
Note The number of phones supported through unicast is limited
to a maximum of ten phones.
Step 10 exit Exits ephone configuration mode.
Example:
Router(config-ephone)# exit
Cisco Unified Communications Manager Express System Administrator Guide
996 OL-10663-02
Configuring Paging
Configuration Examples for Paging
Command or Action Purpose
Step 11 Repeat Step 8 to Step 10 to add additional IP —
phones to a paging group.
Step 12 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Verifying Paging
Step 1 Use the show running-config command to display the running configuration. Paging ephone-dns are
listed in the ephone-dn portion of the output. Phones that belong to paging groups are listed in the ephone
part of the output.
Router# show running-config
ephone-dn 48
number 136
name PagingCashiers
paging ip 239.1.1.10 port 2000
ephone 2
headset auto-answer line 1
headset auto-answer line 4
ephone-template 1
username "FrontCashier"
mac-address 011F.2A0.A490
paging-dn 48
type 7960
no dnd feature-ring
no auto-line
button 1f43 2f44 3f45 4:31
Step 2 Use the show telephony-service ephone-dn and show telephony-service ephone commands to display
only the configuration information for ephone-dns and ephones.
Configuration Examples for Paging
This section contains the following examples:
• Simple Paging Group: Example, page 998
• Combined Paging Groups: Example, page 998
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 997
Configuring Paging
Configuration Examples for Paging
Simple Paging Group: Example
The following example sets up an ephone-dn for multicast paging. This example creates a paging number
for 5001 on ephone-dn 22 and adds ephone 4 as a member of the paging set. Multicast is set for the
paging-dn.
ephone-dn 22
name Paging Shipping
number 5001
paging ip 239.1.1.10 port 2000
ephone 4
mac-address 0030.94c3.8724
button 1:1 2:2
paging-dn 22 multicast
In this example, paging calls to 2000 are multicast to Cisco Unified IP phones 1 and 2, and paging calls
to 2001 go to Cisco Unified IP phones 3 and 4. Note that the paging ephone-dns (20 and 21) are not
assigned to any phone buttons.
ephone-dn 20
number 2000
paging ip 239.0.1.20 port 2000
ephone-dn 21
number 2001
paging ip 239.0.1.21 port 2000
ephone 1
mac-address 3662.024.6ae2
button 1:1
paging-dn 20
ephone 2
mac-address 9387.678.2873
button 1:2
paging-dn 20
ephone 3
mac-address 0478.2a78.8640
button 1:3
paging-dn 21
ephone 4
mac-address 4398.b694.456
button 1:4
paging-dn 21
Combined Paging Groups: Example
This example sets the following paging behavior:
• When extension 2000 is dialed, a page is sent to ephones 1 and 2 (single paging group).
• When extension 2001 is dialed, a page is sent to ephones 3 and 4 (single paging group).
• When extension 2002 is dialed, a page is sent to ephones 1, 2, 3, 4, and 5 (combined paging group).
Ephones 1 and 2 are included in paging ephone-dn 22 through the membership of ephone-dn 20 in the
combined paging group. Ephones 3 and 4 are included in paging ephone-dn 22 through membership of
ephone-dn 21 in the combined paging group. Ephone 5 is directly subscribed to paging-dn 22.
Cisco Unified Communications Manager Express System Administrator Guide
998 OL-10663-02
Configuring Paging
Configuration Examples for Paging
ephone-dn 20
number 2000
paging ip 239.0.1.20 port 2000
ephone-dn 21
number 2001
paging ip 239.0.1.21 port 2000
ephone-dn 22
number 2002
paging ip 239.0.2.22 port 2000
paging group 20,21
ephone-dn 6
number 1103
name user3
ephone-dn 7
number 1104
name user4
ephone-dn 8
number 1105
name user5
ephone-dn 9
number 1199
ephone-dn 10
number 1198
ephone 1
mac-address 1234.8903.2941
button 1:6
paging-dn 20
ephone 2
mac-address CFBA.321B.96FA
button 1:7
paging-dn 20
ephone 3
mac-address CFBB.3232.9611
button 1:8
paging-dn 21
ephone 4
mac-address 3928.3012.EE89
button 1:9
paging-dn 21
ephone 5
mac-address BB93.9345.0031
button 1:10
paging-dn 22
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 999
Configuring Paging
Where to Go Next
Where to Go Next
Intercom
The intercom feature is similar to paging because it allows a phone user to deliver an audio message to
a phone without the called party having to answer. The intercom feature is different than paging because
the audio path between the caller and the called party is a dedicated audio path and because the called
party can respond to the caller. See “Configuring Intercom Lines” on page 917.
Speed Dial
Phone users who make frequent pages may want to include the paging ephone-dn numbers in their list
of speed-dial numbers. See “Configuring Speed Dial” on page 1065.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
1000 OL-10663-02
Configuring Paging
Feature Information for Paging
Feature Information for Paging
Table 41 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 41 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 41 Feature Information for Paging
Cisco Unified CME
Feature Name Version Feature Information
Paging 2.0 Paging was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1001
Configuring Paging
Feature Information for Paging
Cisco Unified Communications Manager Express System Administrator Guide
1002 OL-10663-02
Configuring Presence Service
Last Updated: July 14, 2009
This module describes presence support in a Cisco Unified Communications Manager Express
(Cisco Unified CME) system.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Presence Service”
section on page 1027.
Contents
• Prerequisites for Presence Service, page 1003
• Restrictions for Presence Service, page 1003
• Information About Presence Service, page 1004
• How to Configure Presence Service, page 1008
• Configuration Examples for Presence, page 1022
• Additional References, page 1025
• Feature Information for Presence Service, page 1027
Prerequisites for Presence Service
• Cisco Unified CME 4.1 or a later version.
Restrictions for Presence Service
• Presence features such as Busy Lamp Field (BLF) notification are supported for SIP trunks only;
these features are not supported on H.323 trunks.
• Presence requires that SIP phones are configured with a directory number (using dn keyword in
number command); direct line numbers are not supported.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1003
Configuring Presence Service
Information About Presence Service
Information About Presence Service
To configure presence service in a Cisco Unified CME system, you should understand the following
concept:
• Presence Service, page 1004
• BLF Monitoring of Ephone-DNs with DnD, Call Park, Paging, and Conferencing, page 1006
• Device-Based BLF Monitoring, page 1007
Presence Service
A presence service, as defined in RFC 2778 and RFC 2779, is a system for finding, retrieving, and
distributing presence information from a source, called a presence entity (presentity), to an interested
party called a watcher. When you configure presence in a Cisco Unified CME system with a SIP WAN
connection, a phone user, or watcher, can monitor the real-time status of another user at a directory
number, the presentity. Presence enables the calling party to know before dialing whether the called
party is available. For example, a directory application may show that a user is busy, saving the caller
the time and inconvenience of not being able to reach someone.
Presence uses SIP SUBSCRIBE and NOTIFY methods to allow users and applications to subscribe to
changes in the line status of phones in a Cisco Unified CME system. Phones act as watchers and a
presentity is identified by a directory number on a phone. Watchers initiate presence requests
(SUBSCRIBE messages) to obtain the line status of a presentity. Cisco Unified CME responds with the
presentity’s status. Each time a status changes for a presentity, all watchers of this presentity are sent a
notification message. SIP phones and trunks use SIP messages; SCCP phones use presence primitives in
SCCP messages.
Presence supports Busy Lamp Field (BLF) notification features for speed-dial buttons and directory call
lists for missed calls, placed calls, and received calls. SIP and SCCP phones that support the BLF
speed-dial and BLF call-list features can subscribe to status change notification for internal and external
directory numbers.
Figure 39 shows a Cisco Unified CME system supporting BLF notification for internal and external
directory numbers. If the watcher and the presentity are not both internal to the Cisco Unified CME
router, the subscribe message is handled by a presence proxy server.
Cisco Unified Communications Manager Express System Administrator Guide
1004 OL-10663-02
Configuring Presence Service
Information About Presence Service
Figure 39 BLF Notification Using Presence
SIP
Subscribe
Notify
V
Cisco Unified CME
PSTN
Subscribe
Notify
155790
IP IP IP IP
IP IP IP IP
The following line states display through BLF indicators on the phone:
• Line is idle—Displays when this line is not being used.
• Line is in-use—Displays when the line is in the ringing state and when a user is on the line, whether
or not this line can accept a new call.
• BLF indicator unknown—Phone is unregistered or this line is not allowed to be watched.
Cisco Unified CME acts as a presence agent for internal lines (both SIP and SCCP) and as a presence
server for external watchers connected through a SIP trunk, providing the following functionality:
• Processes SUBSCRIBE requests from internal lines to internal lines. Notifies internal subscribers
of any status change.
• Processes incoming SUBSCRIBE requests from a SIP trunk for internal SCCP and SIP lines.
Notifies external subscribers of any status change.
• Sends SUBSCRIBE requests to external presentities on behalf of internal lines. Relays status
responses to internal lines.
Presence subscription requests from SIP trunks can be authenticated and authorized. Local subscription
requests cannot be authenticated.
For configuration information, see the “How to Configure Presence Service” section on page 1008.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1005
Configuring Presence Service
Information About Presence Service
BLF Monitoring of Ephone-DNs with DnD, Call Park, Paging, and Conferencing
In versions earlier than Cisco Unified CME 7.1, BLF monitoring does not provide notification of status
changes when a monitored directory number becomes DND-enabled, and the Busy Lamp Field (BLF)
indicators for directory numbers configured as call-park slots, paging numbers, or ad hoc or meet-me
conference numbers display only the unknown line-status.
Cisco Unified CME 7.1 and later versions support idle, in-use, and unknown BLF status indicators for
monitored ephone-dns configured as call-park slots, paging numbers, and ad hoc or meet-me conference
numbers. This allows an administrator (watcher) to monitor a call-park slot to see if calls are parked and
not yet retrieved, which paging number is available for paging, or which conference number is available
for a conference.
An ephone-dn configured as a park-slot is not registered with any phone. In Cisco Unified CME 7.1 and
later versions, if a monitored park-slot is idle, the BLF status shows idle on the watcher. If there is a call
parked on the monitored park-slot, the BLF status indicates in-use. If the monitored park-slot is not
enabled for BLF monitoring with the allow watch command, the BLF indicator for unknown status
displays on the watcher.
An ephone-dn configured for paging or conferencing is also not registered with any phone. The
indicators for the idle, in-use, and unknown BLF status are displayed for the monitored paging number
and ad hoc or meet-me conference numbers, as with the call-park slots.
Cisco Unified CME 7.1 and later versions support the Do Not Disturb (DnD) BLF status indicator for
ephone-dns in the DnD state. When a user presses the DnD soft key on an SCCP phone, all directory
numbers assigned to the phone become DnD-enabled and a silent-ring is played for all calls to any
directory number on the phone. If a monitored ephone-dn becomes DnD-enabled, the corresponding
BLF speed-dial lamp (if available) on the watcher displays solid red with the DnD icon for both the idle
and in-use BLF status.
The BLF status notification occurs if the monitored ephone-dn is:
• The primary directory number on only one SCCP phone
• A directory number that is not shared
• A shared directory number and all associated phones are DnD-enabled
No new configuration is required to support these enhancements. For information on configuring BLF
monitoring of directory numbers, see the “SCCP: Enabling BLF Monitoring for Speed-Dials and Call
Lists” section on page 1012.
Table 42 compares the different BLF monitoring features that can be configured in Cisco Unified CME.
Cisco Unified Communications Manager Express System Administrator Guide
1006 OL-10663-02
Configuring Presence Service
Information About Presence Service
Table 42 Feature Comparison of Directory Number BLF Monitoring
Monitor Mode (Button “m”) Watch Mode (Button “w”) BLF Monitoring
Basic Operation
SCCP phones only. SCCP phones only. SCCP and SIP phones.
Watches a single ephone-dn Watches all activity on the phone Watches all ephone-dn instances
instance. for which the designated with the same (primary)
ephone-dn is the primary extension number. The BLF
If there are multiple ephone-dns
extension. lamp is on if any instance of the
with the same extension (such as
monitored extension is in use.
in an overlay), this mode (The ephone-dn is “primary” for a
watches only a single ephone-dn phone if the extension appears on Indicates DND state of the
(specified with the button button 1 or on the button indicated phone.
command using m keyword). by the auto-line command.)
Does not indicate DND state of Ephone-dn can be shared but
the phone. cannot be the primary extension
on any other phone.
Indicates DND state of the phone.
Shared Lines
Can not distinguish which phone Designed for cases where Cannot distinguish which phone
is using the ephone-dn if the DN ephone-dns are shared across is using the ephone-dn if the DN
is shared across multiple phones. multiple phones. is shared across multiple phones.
Each phone must have a unique
primary ephone-dn.
Used to indicate that a specific
phone is in use as opposed (button
m) to indicating that a specific
ephone-dn is in use.
Local vs. Remote
Monitors only DNs on the local Can only monitor DNs that are on Can monitor extension numbers
Cisco Unified CME system. the local Cisco Unified CME on a remote Cisco Unified CME
system using SIP Subscribe and Notify.
Cannot monitor local and remote
at the same time.
Device-Based BLF Monitoring
Device-based BLF monitoring provides a phone user or administrator (watcher) information about the
status of a monitored phone (presentity). Cisco Unified CME 4.1 and later versions support BLF
monitoring of directory numbers associated with speed-dial buttons, call logs, and directory listings.
Cisco Unified CME 7.1 and later versions support device-based BLF monitoring, allowing a watcher to
monitor the status of a phone, not only a line on the phone.
To identify the phone being monitored for BLF status, Cisco Unified CME selects the phone with the
monitored directory number assigned to the first button, or the directory number whose button is selected
by the auto-line command (SCCP only). If more than one phone uses the same number as its primary
directory number, the phone with the lowest phone tag is monitored for BLF status.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1007
Configuring Presence Service
How to Configure Presence Service
For Extension Mobility phones, the first number configured in the user profile indicates the primary
directory number of the Extension Mobility phone. If the Extension Mobility phone is being monitored,
the BLF status of the corresponding phone is sent to the watcher when an extension-mobility user logs
in or out, is idle, or busy.
If a shared directory number is busy on a monitored SCCP phone, and the monitored device is on-hook,
the monitored phone is considered idle.
When a monitored phone receives a page, if the paging directory number is also monitored, the BLF
status of the paging directory number shows busy on the watcher.
If device-based monitoring is enabled on a directory number configured as a call-park slot, and there is
a call parked on this park-slot, the device-based BLF status indicates busy.
All directory numbers associated with a phone are in the DnD state when the DnD soft key is pressed.
If a monitored phone becomes DnD-enabled, watchers are notified of the DnD status change.
For configuration information, see the “SCCP: Enabling BLF Monitoring for Speed-Dials and Call
Lists” section on page 1012 or “SIP: Enabling BLF Monitoring for Speed-Dials and Call Lists” section
on page 1015.
How to Configure Presence Service
This section contains the following tasks:
• Enabling Presence for Internal Lines, page 1008
• Enabling a Directory Number to be Watched, page 1010
• SCCP: Enabling BLF Monitoring for Speed-Dials and Call Lists, page 1012
• SIP: Enabling BLF Monitoring for Speed-Dials and Call Lists, page 1015
• Configuring Presence to Watch External Lines, page 1017
• Verifying Presence Configuration, page 1019
• Troubleshooting Presence, page 1020
Enabling Presence for Internal Lines
Perform the following steps to enable the router to accept incoming presence requests from internal
watchers and SIP trunks.
Restrictions
• A presentity can be identified by a directory number only.
• BLF monitoring indicates the line status only.
• Instant Messaging is not supported.
SUMMARY STEPS
1. enable
2. configure terminal
3. sip-ua
Cisco Unified Communications Manager Express System Administrator Guide
1008 OL-10663-02
Configuring Presence Service
How to Configure Presence Service
4. presence enable
5. exit
6. presence
7. max-subscription number
8. presence call-list
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 sip-ua Enters SIP user-agent configuration mode to configure the
user agent.
Example:
Router(config)# sip-ua
Step 4 presence enable Allows the router to accept incoming presence requests.
Example:
Router(config-sip-ua)# presence enable
Step 5 exit Exits SIP user-agent configuration mode.
Example:
Router(config-sip-ua)# exit
Step 6 presence Enables presence service and enters presence configuration
mode.
Example:
Router(config)# presence
Step 7 presence call-list Globally enables BLF monitoring for directory numbers in
call lists and directories on all locally registered phones.
Example: • Only directory numbers that you enable for watching
Router(config-presence)# presence call-list with the allow watch command display BLF status
indicators.
• This command enables the BLF call-list feature
globally. To enable the feature for a specific phone, see
the “SCCP: Enabling BLF Monitoring for Speed-Dials
and Call Lists” section on page 1012.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1009
Configuring Presence Service
How to Configure Presence Service
Command or Action Purpose
Step 8 max-subscription number (Optional) Sets the maximum number of concurrent watch
sessions that are allowed.
Example: • number—Maximum watch sessions. Range: 100 to the
Router(config-presence)# max-subscription 128 maximum number of directory numbers supported on
the router platform. Type ? to display range.
Default: 100.
Step 9 end Exits to privileged EXEC mode.
Example:
Router(config-presence)# end
Enabling a Directory Number to be Watched
To enable a line associated with a directory number to be monitored by a phone registered to a
Cisco Unified CME router, perform the following steps. The line is enabled as a presentity and phones
can subscribe to its line status through the BLF call-list and BLF speed-dial features. There is no
restriction on the type of phone that can have its lines monitored; any line on any IP phone or on an
analog phone on supported voice gateways can be a presentity.
Restrictions
• A presentity is identified by a directory number only.
• BLF monitoring indicates the line status only.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
or
voice register dn dn-tag
4. number number
5. allow watch
6. end
Cisco Unified Communications Manager Express System Administrator Guide
1010 OL-10663-02
Configuring Presence Service
How to Configure Presence Service
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag [dual-line] Enters the configuration mode to define a directory number
or for an IP phone, intercom line, voice port, or a
voice register dn dn-tag message-waiting indicator (MWI).
• dn-tag—Identifies a particular directory number during
Example: configuration tasks. Range is 1 to the maximum number
Router(config)# ephone-dn 1 of directory numbers allowed on the router platform, or
or the maximum defined by the max-dn command. Type
? to display range.
Router(config)# voice register dn 1
Step 4 number number Associates a phone number with a directory number to be
assigned to an IP phone in Cisco Unified CME.
Example: • number—String of up to 16 characters that represents
Router(config-ephone-dn)# number 3001 an E.164 telephone number.
or
Router(config-register-dn)# number 3001
Step 5 allow watch Allows the phone line associated with this directory number
to be monitored by a watcher in a presence service.
Example: • This command can also be configured in ephone-dn
Router(config-ephone-dn)# allow watch template configuration mode and applied to one or
or more phones. The ephone-dn configuration has priority
Router(config-register-dn)# allow watch over the ephone-dn template configuration.
Step 6 end Exits to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
or
Router(config-register-dn)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1011
Configuring Presence Service
How to Configure Presence Service
SCCP: Enabling BLF Monitoring for Speed-Dials and Call Lists
A watcher can monitor the status of lines associated with internal and external directory numbers
(presentities) through the BLF speed-dial and BLF call-list presence features. To enable the BLF
notification features on an IP phone using SCCP, perform the following steps.
Prerequisites
• Presence must be enabled on the Cisco Unified CME router. See the “Enabling Presence for Internal
Lines” section on page 1008.
• A directory number must be enabled as a presentity with the allow watch command to provide BLF
status notification. See the “Enabling a Directory Number to be Watched” section on page 1010.
• Device-based monitoring requires Cisco Unified CME 7.1 or a later version. All directory numbers
associated with the monitored phone must be configured with the allow watch command.
Otherwise, if any of the directory numbers is missing this configuration, an incorrect status could
be reported to the watcher.
Restrictions
• Device-based BLF monitoring for call lists is not supported.
• Device-based BLF-speed-dial monitoring is not supported for a remote watcher or presentity.
BLF Call-List
• Not supported on Cisco Unified IP Phone 7905, 7906, 7911, 7912, 7931, 7940, 7960, or 7985,
Cisco Unified IP Phone Expansion Modules, or Cisco Unified IP Conference Stations.
BLF Speed-Dial
• Not supported on Cisco Unified IP Phone 7905, 7906, 7911, 7912, or 7985, or Cisco Unified IP
Conference Stations.
Cisco Unified IP Phone 7931
• BLF status is displayed through monitor lamp only; BLF status icons are not displayed.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. button button-number{separator}dn-tag [,dn-tag...] [button-number{x}overlay-button-number]
[button-number...]
5. blf-speed-dial tag number label string [device]
6. presence call-list
7. end
Cisco Unified Communications Manager Express System Administrator Guide
1012 OL-10663-02
Configuring Presence Service
How to Configure Presence Service
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode to set phone-specific
parameters for a SIP phone.
Example: • phone-tag—Unique sequence number of the phone to
Router(config)# ephone 1 be configured. Range is version and
platform-dependent; type ? to display range. You can
modify the upper limit for this argument with the
max-ephones command.
Step 4 button button-number{separator}dn-tag Associates a button number and line characteristics with a
[,dn-tag...] directory number on the phone.
[button-number{x}overlay-button-number]
[button-number...] • button-number—Number of a line button on an IP
phone.
Example: • separator—Single character that denotes the type of
Router(config-ephone)# button 1:10 2:11 3b12 characteristics to be associated with the button.
4o13,14,15
• dn-tag—Unique sequence number of the ephone-dn
that you want to appear on this button. For overlay lines
(separator is o or c), this argument can contain up to
25 ephone-dn tags, separated by commas.
• x—Separator that creates an overlay rollover button.
• overlay-button-number—Number of the overlay button
that should overflow to this button.
Step 5 blf-speed-dial tag number label string [device] Enables BLF monitoring of a directory number associated
with a speed-dial number on the phone.
Example: • tag—Number that identifies the speed-dial index.
Router(config-ephone)# blf-speed-dial 3 3001 Range: 1 to 33.
label sales device
• number—Telephone number to speed dial.
• string—Alphanumeric label that identifies the
speed-dial button. String can contain a maximum of
30 characters.
• device—(Optional) Enables phone-based monitoring.
This keyword is supported in Cisco Unified CME 7.1
and later versions.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1013
Configuring Presence Service
How to Configure Presence Service
Command or Action Purpose
Step 6 presence call-list Enables BLF monitoring of directory numbers that appear
in call lists and directories on this phone.
Example: • For a directory number to be monitored, it must have
Router(config-ephone)# presence call-list the allow watch command enabled.
• To enable BLF monitoring for call lists on all phones in
this Cisco Unified CME system, use this command in
presence mode. See the “Enabling Presence for Internal
Lines” section on page 1008.
Step 7 end Exits to privileged EXEC mode.
Example:
Router(config-ephone)# end
Examples
The following example shows that the directory numbers for extensions 2001 and 2003 are allowed to
be watched and the BLF status of these numbers display on phone 1.
ephone-dn 201
number 2001
allow watch
!
!
ephone-dn 203
number 2003
allow watch
!
!
ephone 1
mac-address 0012.7F54.EDC6
blf-speed-dial 2 201 label "sales" device
blf-speed-dial 3 203 label "service" device
button 1:100 2:101 3b102
What to Do Next
If you are done modifying parameters for SCCP phones in Cisco Unified CME, generate a new
configuration profile by using the create cnf-files command and then restart the phones with the restart
command. See “SCCP: Generating Configuration Files for SCCP Phones” section on page 263 and
“SCCP: Using the restart Command” on page 274.
Cisco Unified Communications Manager Express System Administrator Guide
1014 OL-10663-02
Configuring Presence Service
How to Configure Presence Service
SIP: Enabling BLF Monitoring for Speed-Dials and Call Lists
A watcher can monitor the status of lines associated with internal and external directory numbers
(presentities) through the BLF speed-dial and BLF call-list presence features. To enable the BLF
notification features on a SIP phone, perform the following steps.
Prerequisites
• Presence must be enabled on the Cisco Unified CME router. See the “Enabling Presence for Internal
Lines” section on page 1008.
• A directory number must be enabled as a presentity with the allow watch command to provide BLF
status notification. See the “Enabling a Directory Number to be Watched” section on page 1010.
• SIP phones must be configured with a directory number under voice register pool configuration
mode (use dn keyword in number command); direct line numbers are not supported.
• Device-based monitoring requires Cisco Unified CME 7.1 or a later version. All directory numbers
associated with the monitored phone must be configured with the allow watch command.
Otherwise, if any of the directory numbers is missing this configuration, an incorrect status could
be reported to the watcher.
Restrictions
• Device-based BLF-speed-dial monitoring is not supported for a remote watcher or presentity.
BLF Call-List
• Not supported on Cisco Unified IP Phone 7905, 7906, 7911, 7912, 7931, 7940, 7960, or 7985,
Cisco Unified IP Phone Expansion Modules, or Cisco Unified IP Conference Stations.
BLF Speed-Dial
• Not supported on Cisco Unified IP Phone 7905, 7906, 7911, 7912, or 7985, or Cisco Unified IP
Conference Stations.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register pool pool-tag
4. number tag dn dn-tag
5. blf-speed-dial tag number label string [device]
6. presence call-list
7. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1015
Configuring Presence Service
How to Configure Presence Service
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for a SIP phone.
Example: • pool-tag—Unique sequence number of the SIP phone
Router(config)# voice register pool 1 to be configured. Range is version and
platform-dependent; type ? to display range. You can
modify the upper limit for this argument with the
max-pool command.
Step 4 number tag dn dn-tag Assigns a directory number to the SIP phone.
• tag—Identifier when there are multiple number
Example: commands. Range: 1 to 10.
Router(config-register-pool)# number 1 dn 2
• dn-tag—Directory number tag that was defined using
the voice register dn command.
Step 5 blf-speed-dial tag number label string [device] Enables BLF monitoring of a directory number associated
with a speed-dial number on the phone.
Example: • tag—Number that identifies the speed-dial index.
Router(config-register-pool)# blf-speed-dial 3 Range: 1 to 7.
3001 label sales device
• number—Telephone number to speed dial.
• string—Alphanumeric label that identifies the
speed-dial button. The string can contain a maximum of
30 characters.
• device—(Optional) Enables phone-based monitoring.
This keyword is supported in Cisco Unified CME 7.1
and later versions.
Step 6 presence call-list Enables BLF monitoring of directory numbers that appear
in call lists and directories on this phone.
Example: • For a directory number to be monitored, it must have
Router(config-register-pool)# presence the allow watch command enabled.
call-list
• To enable BLF monitoring for call lists on all phones in
this Cisco Unified CME system, use this command in
presence mode. See the “Enabling Presence for Internal
Lines” section on page 1008.
Step 7 end Exits to privileged EXEC mode.
Example:
Router(config-register-pool)# end
Cisco Unified Communications Manager Express System Administrator Guide
1016 OL-10663-02
Configuring Presence Service
How to Configure Presence Service
What to Do Next
If you are done modifying parameters for SIP phones in Cisco Unified CME, generate a new
configuration profile by using the create profile command and then restart the phones with the restart
command. See “SIP: Generating Configuration Profiles for SIP Phones” section on page 265 and “SIP:
Using the restart Command” on page 278.
Configuring Presence to Watch External Lines
To enable internal watchers to monitor external directory numbers on a remote Cisco Unified CME
router, perform the following steps.
Prerequisites
Presence service must be enabled for internal lines. See the “Enabling Presence for Internal Lines”
section on page 1008.
SUMMARY STEPS
1. enable
2. configure terminal
3. presence
4. server ip-address
5. allow subscribe
6. watcher all
7. sccp blf-speed-dial retry-interval seconds limit number
8. exit
9. voice register global
10. authenticate presence
11. authenticate credential tag location
12. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1017
Configuring Presence Service
How to Configure Presence Service
Command or Action Purpose
Step 3 presence Enables presence service and enters presence configuration
mode.
Example:
Router(config)# presence
Step 4 server ip-address Specifies the IP address of a presence server for sending
presence requests from internal watchers to external
presentities.
Example:
Router(config-presence)# server 10.10.10.1
Step 5 allow subscribe Allows internal watchers to monitor external directory
numbers.
Example:
Router(config-presence)# allow subscribe
Step 6 watcher all Allows external watchers to monitor internal directory
numbers.
Example:
Router(config-presence)# watcher all
Step 7 sccp blf-speed-dial retry-interval seconds (Optional) Sets the retry timeout for BLF monitoring of
limit number speed-dial numbers on phones running SCCP.
• seconds—Retry timeout in seconds. Range: 60 to 3600.
Example: Default: 60.
Router(config-presence)# sccp blf-speed-dial
retry-interval 90 limit number 15 • number—Maximum number of retries.
Range: 10 to 100. Default: 10.
Step 8 exit Exits presence configuration mode.
Example:
Router(config-presence)# exit
Step 9 voice register global Enters voice register global configuration mode to set
global parameters for all supported SIP phones in a
Cisco Unified CME environment.
Example:
Router(config)# voice register global
Step 10 authenticate presence (Optional) Enables authentication of incoming presence
requests from a remote presence server.
Example:
Router(config-register-global)# authenticate
presence
Cisco Unified Communications Manager Express System Administrator Guide
1018 OL-10663-02
Configuring Presence Service
How to Configure Presence Service
Command or Action Purpose
Step 11 authenticate credential tag location (Optional) Specifies the credential file to use for
authenticating presence subscription requests.
Example: • tag—Number that identifies the credential file to use
Router(config-register-global)# authenticate for presence authentication. Range: 1 to 5.
credential 1 flash:cred1.csv
• location—Name and location of the credential file in
URL format. Valid storage locations are TFTP, HTTP,
and flash memory.
Step 12 end Exits to privileged EXEC mode.
Example:
Router(config-register-global)# end
Verifying Presence Configuration
Step 1 show running-config
Use this command to verify your configuration.
Router# show running-config
!
voice register global
mode cme
source-address 10.1.1.2 port 5060
load 7971 SIP70.8-0-1-11S
load 7970 SIP70.8-0-1-11S
load 7961GE SIP41.8-0-1-0DEV
load 7961 SIP41.8-0-1-0DEV
authenticate presence
authenticate credential 1 tftp://172.18.207.15/labtest/cred1.csv
create profile sync 0004550081249644
.
.
.
presence
server 10.1.1.4
sccp blf-speed-dial retry-interval 70 limit 20
presence call-list
max-subscription 128
watcher all
allow subscribe
!
sip-ua
presence enable
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1019
Configuring Presence Service
How to Configure Presence Service
Step 2 show presence global
Use this command to display presence configuration settings.
Router# show presence global
Presence Global Configuration Information:
=============================================
Presence feature enable : TRUE
Presence allow external watchers : FALSE
Presence max subscription allowed : 100
Presence number of subscriptions : 0
Presence allow external subscribe : FALSE
Presence call list enable : TRUE
Presence server IP address : 0.0.0.0
Presence sccp blfsd retry interval : 60
Presence sccp blfsd retry limit : 10
Presence router mode : CME mode
Step 3 show presence subscription [details | presentity telephone-number | subid subscription-id summary]
Use this command to display information about active presence subscriptions.
Router# show presence subscription summary
Presence Active Subscription Records Summary: 15 subscription
Watcher Presentity SubID Expires SibID Status
======================== ======================== ====== ======= ====== ======
6002@10.4.171.60 6005@10.4.171.34 1 3600 0 idle
6005@10.4.171.81 6002@10.4.171.34 6 3600 0 idle
6005@10.4.171.81 6003@10.4.171.34 8 3600 0 idle
6005@10.4.171.81 6002@10.4.171.34 9 3600 0 idle
6005@10.4.171.81 6003@10.4.171.34 10 3600 0 idle
6005@10.4.171.81 6001@10.4.171.34 12 3600 0 idle
6001@10.4.171.61 6003@10.4.171.34 15 3600 0 idle
6001@10.4.171.61 6002@10.4.171.34 17 3600 0 idle
6003@10.4.171.59 6003@10.4.171.34 19 3600 0 idle
6003@10.4.171.59 6002@10.4.171.34 21 3600 0 idle
6003@10.4.171.59 5001@10.4.171.34 23 3600 24 idle
6002@10.4.171.60 6003@10.4.171.34 121 3600 0 idle
6002@10.4.171.60 5002@10.4.171.34 128 3600 129 idle
6005@10.4.171.81 1001@10.4.171.34 130 3600 131 busy
6005@10.4.171.81 7005@10.4.171.34 132 3600 133 idle
Troubleshooting Presence
Step 1 debug presence {all | asnl | errors | event | info | timer | trace | xml}
This command displays debugging information about the presence service.
Router# debug presence errors
*Sep 4 07:16:02.715: //PRESENCE:[0]:/presence_sip_line_update: SIP nothing to update
*Sep 4 07:16:02.723: //PRESENCE:[17]:/presence_handle_notify_done: sip stack response
code [29]
*Sep 4 07:16:02.723: //PRESENCE:[24]:/presence_handle_notify_done: sip stack response
code [29]
*Sep 4 07:16:02.791: //PRESENCE:[240]:/presence_handle_notify_done: sip stack response
code [17]
Cisco Unified Communications Manager Express System Administrator Guide
1020 OL-10663-02
Configuring Presence Service
How to Configure Presence Service
*Sep 4 07:16:02.791: //PRESENCE:[766]:/presence_handle_notify_done: sip stack response
code [17]
*Sep 4 07:16:04.935: //PRESENCE:[0]:/presence_sip_line_update: SIP nothing to update
*Sep 4 07:16:04.943: //PRESENCE:[17]:/presence_handle_notify_done: sip stack response
code [29]
*Sep 4 07:16:04.943: //PRESENCE:[24]:/presence_handle_notify_done: sip stack response
code [29]
*Sep 4 07:16:04.995: //PRESENCE:[240]:/presence_handle_notify_done: sip stack response
code [17]
*Sep 4 07:16:04.999: //PRESENCE:[766]:/presence_handle_notify_done: sip stack response
code [17]
Step 2 debug ephone blf [mac-address mac-address]
This command displays debugging information for BLF presence features.
Router# debug ephone blf
*Sep 4 07:18:26.307: skinny_asnl_callback: subID 16 type 4
*Sep 4 07:18:26.307: ASNL_RESP_NOTIFY_INDICATION
*Sep 4 07:18:26.307: ephone-1[1]:ASNL notify indication message, feature index 4, subID
[16]
*Sep 4 07:18:26.307: ephone-1[1]:line status 6, subID [16]
*Sep 4 07:18:26.307: ephone-1[1]:StationFeatureStatV2Message sent, status 2
*Sep 4 07:18:26.307: skinny_asnl_callback: subID 23 type 4
*Sep 4 07:18:26.307: ASNL_RESP_NOTIFY_INDICATION
*Sep 4 07:18:26.307: ephone-2[2]:ASNL notify indication message, feature index 2, subID
[23]
*Sep 4 07:18:26.311: ephone-2[2]:line status 6, subID [23]
*Sep 4 07:18:26.311: ephone-2[2]:StationFeatureStatV2Message sent, status 2
*Sep 4 07:18:28.951: skinny_asnl_callback: subID 16 type 4
*Sep 4 07:18:28.951: ASNL_RESP_NOTIFY_INDICATION
*Sep 4 07:18:28.951: ephone-1[1]:ASNL notify indication message, feature index 4, subID
[16]
*Sep 4 07:18:28.951: ephone-1[1]:line status 1, subID [16]
*Sep 4 07:18:28.951: ephone-1[1]:StationFeatureStatV2Message sent, status 1
*Sep 4 07:18:28.951: skinny_asnl_callback: subID 23 type 4
*Sep 4 07:18:28.951: ASNL_RESP_NOTIFY_INDICATION
*Sep 4 07:18:28.951: ephone-2[2]:ASNL notify indication message, feature index 2, subID
[23]
*Sep 4 07:18:28.951: ephone-2[2]:line status 1, subID [23]
*Sep 4 07:18:28.951: ephone-2[2]:StationFeatureStatV2Message sent, status 1
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1021
Configuring Presence Service
Configuration Examples for Presence
Configuration Examples for Presence
This section contains the following example:
• Presence in Cisco Unified CME: Example, page 1022
Presence in Cisco Unified CME: Example
Router# show running-config
Building configuration...
Current configuration : 5465 bytes
!
version 12.4
service timestamps debug datetime msec
service timestamps log datetime msec
no service password-encryption
!
hostname CME-3825
!
boot-start-marker
boot-end-marker
!
logging buffered 2000000 debugging
enable password lab
!
no aaa new-model
!
resource policy
!
no network-clock-participate slot 1
no network-clock-participate slot 2
ip cef
!
!
no ip domain lookup
!
voice-card 1
no dspfarm
!
voice-card 2
no dspfarm
!
!
voice service voip
allow-connections sip to sip
h323
sip
registrar server expires max 240 min 60
!
voice register global
mode cme
source-address 11.1.1.2 port 5060
load 7971 SIP70.8-0-1-11S
load 7970 SIP70.8-0-1-11S
load 7961GE SIP41.8-0-1-0DEV
load 7961 SIP41.8-0-1-0DEV
authenticate presence
authenticate credential 1 tftp://172.18.207.15/labtest/cred1.csv
create profile sync 0004550081249644
Cisco Unified Communications Manager Express System Administrator Guide
1022 OL-10663-02
Configuring Presence Service
Configuration Examples for Presence
!
voice register dn 1
number 2101
allow watch
!
voice register dn 2
number 2102
allow watch
!
voice register pool 1
id mac 0015.6247.EF90
type 7971
number 1 dn 1
blf-speed-dial 1 1001 label "1001"
!
voice register pool 2
id mac 0012.0007.8D82
type 7912
number 1 dn 2
!
interface GigabitEthernet0/0
description $ETH-LAN$$ETH-SW-LAUNCH$$INTF-INFO-GE 0/0$
ip address 11.1.1.2 255.255.255.0
duplex full
speed 100
media-type rj45
no negotiation auto
!
interface GigabitEthernet0/1
no ip address
shutdown
duplex auto
speed auto
media-type rj45
negotiation auto
!
ip route 0.0.0.0 0.0.0.0 11.1.1.1
!
ip http server
!
!
!
tftp-server flash:Jar41sccp.8-0-0-103dev.sbn
tftp-server flash:cvm41sccp.8-0-0-102dev.sbn
tftp-server flash:SCCP41.8-0-1-0DEV.loads
tftp-server flash:P00303010102.bin
tftp-server flash:P00308000100.bin
tftp-server flash:P00308000100.loads
tftp-server flash:P00308000100.sb2
tftp-server flash:P00308000100.sbn
tftp-server flash:SIP41.8-0-1-0DEV.loads
tftp-server flash:apps41.1-1-0-82dev.sbn
tftp-server flash:cnu41.3-0-1-82dev.sbn
tftp-server flash:cvm41sip.8-0-0-103dev.sbn
tftp-server flash:dsp41.1-1-0-82dev.sbn
tftp-server flash:jar41sip.8-0-0-103dev.sbn
tftp-server flash:P003-08-1-00.bin
tftp-server flash:P003-08-1-00.sbn
tftp-server flash:P0S3-08-1-00.loads
tftp-server flash:P0S3-08-1-00.sb2
tftp-server flash:CP7912080000SIP060111A.sbin
tftp-server flash:CP7912080001SCCP051117A.sbin
tftp-server flash:SCCP70.8-0-1-11S.loads
tftp-server flash:cvm70sccp.8-0-1-13.sbn
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1023
Configuring Presence Service
Configuration Examples for Presence
tftp-server flash:jar70sccp.8-0-1-13.sbn
tftp-server flash:SIP70.8-0-1-11S.loads
tftp-server flash:apps70.1-1-1-11.sbn
tftp-server flash:cnu70.3-1-1-11.sbn
tftp-server flash:cvm70sip.8-0-1-13.sbn
tftp-server flash:dsp70.1-1-1-11.sbn
tftp-server flash:jar70sip.8-0-1-13.sbn
!
control-plane
!
dial-peer voice 2001 voip
preference 2
destination-pattern 1...
session protocol sipv2
session target ipv4:11.1.1.4
dtmf-relay sip-notify
!
presence
server 11.1.1.4
sccp blf-speed-dial retry-interval 70 limit 20
presence call-list
max-subscription 128
watcher all
allow subscribe
!
sip-ua
authentication username jack password 021201481F
presence enable
!
!
telephony-service
load 7960-7940 P00308000100
load 7941GE SCCP41.8-0-1-0DEV
load 7941 SCCP41.8-0-1-0DEV
load 7961GE SCCP41.8-0-1-0DEV
load 7961 SCCP41.8-0-1-0DEV
load 7971 SCCP70.8-0-1-11S
load 7970 SCCP70.8-0-1-11S
load 7912 CP7912080000SIP060111A.sbin
max-ephones 100
max-dn 300
ip source-address 11.1.1.2 port 2000
url directories http://11.1.1.2/localdirectory
max-conferences 6 gain -6
call-forward pattern .T
transfer-system full-consult
transfer-pattern .T
create cnf-files version-stamp Jan 01 2002 00:00:00
!
!
ephone-dn 1 dual-line
number 2001
allow watch
!
!
ephone-dn 2 dual-line
number 2009
allow watch
application default
!
!
ephone-dn 3
number 2005
allow watch
Cisco Unified Communications Manager Express System Administrator Guide
1024 OL-10663-02
Configuring Presence Service
Additional References
!
!
ephone-dn 4 dual-line
number 2002
!
!
ephone 1
mac-address 0012.7F57.62A5
fastdial 1 1002
blf-speed-dial 1 2101 label "2101"
blf-speed-dial 2 1003 label "1003"
blf-speed-dial 3 2002 label "2002"
type 7960
button 1:1 2:2
!
!
!
ephone 3
mac-address 0015.6247.EF91
blf-speed-dial 2 1003 label "1003"
type 7971
button 1:3 2:4
!
!
!
line con 0
exec-timeout 0 0
password lab
stopbits 1
line aux 0
stopbits 1
line vty 0 4
password lab
login
!
scheduler allocate 20000 1000
!
end
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1025
Configuring Presence Service
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
1026 OL-10663-02
Configuring Presence Service
Feature Information for Presence Service
Feature Information for Presence Service
Table 43 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 43 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 43 Feature Information for Presence Service
Cisco Unified CME
Feature Name Version Modification
BLF Monitoring 7.1 • Added support for device-based BLF monitoring.
• Added support for BLF Monitoring of ephone-DNs
with DnD, Call Park, Paging, and Conferencing
Presence Service 4.1 Presence with BLF was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1027
Configuring Presence Service
Feature Information for Presence Service
Cisco Unified Communications Manager Express System Administrator Guide
1028 OL-10663-02
Configuring Ring Tones
Last Updated: March 26, 2007
This chapter describes ring tones features in Cisco Unified Communications Manager Express
(Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Ring Tones” section
on page 1038.
Contents
• Information About Ring Tones, page 1029
• How to Configure Ring Tones, page 1031
• Configuration Examples for Ring Tones, page 1036
• Additional References, page 1037
• Feature Information for Ring Tones, page 1038
Information About Ring Tones
To enable distinctive ringing or customized ring tones, you should understand the following concepts:
• Distinctive Ringing, page 1030
• Customized Ring Tones, page 1030
• On-Hold Indicator, page 1030
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1029
Configuring Ring Tones
Information About Ring Tones
Distinctive Ringing
Distinctive ring is used to identify internal and external incoming calls. An internal calls is defined as a
call originating from any Cisco Unified IP phone that is registered in Cisco Unified CME or is routed
through the local FXS port.
In Cisco CME 3.4 and earlier versions, the standard ring pattern is generated for all calls to local SCCP
endpoints. In Cisco Unified CME 4.0, the following distinctive ring features are supported for SCCP
endpoints:
• Specify one of three ring patterns to be used for all types of incoming calls to a particular directory
number, on all phones on which the directory number appears. If a phone is already in use, an
incoming call is presented as a call-waiting call and uses a distinctive call-waiting beep.
• Specify whether the distinctive ring is used only if the incoming called number matches the primary
or secondary number defined for the ephone-dn. If no secondary number is defined for the
ephone-dn, the secondary ring option has no effect.
• Associate a feature ring pattern with a specific button on a phone so that different phones that share
the same directory number can use a different ring style.
For local SIP endpoints, the type of ring sound requested is signaled to the phone using an alert-info
signal. If distinctive ringing is enabled, Cisco Unified CME generates the alert-info for incoming calls
from any phone that is not registered in Cisco Unified CME, to the local endpoint. Alert-info from an
incoming leg can be relayed to an outgoing leg with the internally generated alert-info taking
precedence.
Cisco Unified IP phones use the standard Telcordia Technologies distinctive ring types.
Customized Ring Tones
Cisco Unified IP Phones have two default ring types: Chirp1 and Chirp2. Cisco Unified CME also
supports customized ring tones using pulse code modulation (PCM) files.
An XML file called RingList.xml specifies the ring tone options available for the default ring on an IP
phone registered to Cisco Unified CME. An XML file called DistinctiveRingList.xml specifies the ring
tones available on each individual line appearance on an IP phone registered to Cisco Unified CME.
On-Hold Indicator
On-hold indicator is an optional feature that generates a ring burst on idle IP phones that have placed a
call on hold. An option is available to generate call-waiting beeps for occupied phones that have placed
calls on hold. This feature is disabled by default. For configuration information, see the “SCCP:
Enabling On-Hold Indicator” section on page 1034.
LED color display for hold state, also known as I-Hold, is supported in Cisco Unified CME 4.0(2) and
later versions. The I-Hold feature provides a visual indicator for distinguishing a local hold from a
remote hold on shared lines on supported phones, such as the Cisco Unified IP Phone 7931G. This
feature requires no additional configuration.
Cisco Unified Communications Manager Express System Administrator Guide
1030 OL-10663-02
Configuring Ring Tones
How to Configure Ring Tones
How to Configure Ring Tones
This section contains the following tasks:
• SCCP: Enabling Distinctive Ringing, page 1031
• SCCP: Enabling Customized Ring Tones, page 1032
• SCCP: Enabling On-Hold Indicator, page 1034
• SIP: Enabling Distinctive Ringing, page 1035
SCCP: Enabling Distinctive Ringing
To set the ring pattern for all incoming calls to a directory number, perform the following steps.
Prerequisites
Cisco Unified CME 4.0 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag [dual-line]
4. number number [secondary number] [no-reg [both | primary]]
5. ring {external | internal | feature} [primary | secondary]
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag [dual-line] Enters ephone-dn configuration mode, creates an
ephone-dn, and optionally assigns it dual-line status.
Example:
Router(config)# ephone-dn 29
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1031
Configuring Ring Tones
How to Configure Ring Tones
Command or Action Purpose
Step 4 number number [secondary number] [no-reg [both Configures a valid extension number for this ephone-dn.
| primary]]
Example:
Router(config-ephone-dn)# number 2333
Step 5 ring {external | internal | feature} [primary | Designates which ring pattern to be used for all types of
secondary] incoming calls to this directory number, on all phones on
which the directory number appears.
Example:
Router(config-ephone-dn)# ring internal
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
SCCP: Enabling Customized Ring Tones
To create a customized ring tone, perform the following steps.
Prerequisites
Cisco Unified CME 4.0 or a later version.
SUMMARY STEPS
1. Create PCM file.
2. Edit RingList.xml and DistinctiveRingList.xml.
3. Copy PCM and XML files to system Flash.
4. tftp-server
5. Reboot phones.
DETAILED STEPS
Step 1 Create a PCM file for each customized ring tone (one ring per file). The PCM files must comply with
the following format guidelines.
• Raw PCM (no header)
• 8000 samples per second
• 8 bits per sample
• Law compression
• Maximum ring size—16080 samples
• Minimum ring size—240 samples
Cisco Unified Communications Manager Express System Administrator Guide
1032 OL-10663-02
Configuring Ring Tones
How to Configure Ring Tones
• Number of samples in the ring must be evenly divisible by 240
• Ring should start and end at the zero crossing
Use an audio editing package that supports these file format requirements to create PCM files for
customized phone rings.
Sample ring files are in the ringtone.tar file at http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp
Step 2 Edit the RingList.xml and DistinctiveRingList.xml files using a text editor.
The RingList.xml and DistinctiveRingList.xml files contain a list of phone ring types. Each file shows
the PCM file used for each ring type and the text that is displayed on the Ring Type menu on a
Cisco Unified IP Phone for each ring.
Sample XML files are in the ringtone.tar file at http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp
The RingList.xml and DistinctiveRingList.xml files use the following format to specify customized
rings:
<CiscoIPPhoneRingList>
<Ring>
<DisplayName/>
<FileName/>
</Ring>
</CiscoIPPhoneRingList>
The XML ring files use the following tag definitions:
• Ring files contain two fields, DisplayName and FileName, which are required for each phone ring
type. Up to 50 rings can be listed.
• DisplayName defines the name of the customized ring for the associated PCM file that will be
displayed on the Ring Type menu of the Cisco Unified IP Phone.
• FileName specifies the name of the PCM file for the customized ring to associate with
DisplayName.
• The DisplayName and FileName fields can not exceed 25 characters.
The following sample RingList.xml file defines two phone ring types:
<CiscoIPPhoneRingList>
<Ring>
<DisplayName>Piano1</DisplayName>
<FileName>Piano1.raw</FileName>
</Ring>
<Ring>
<DisplayName>Chime</DisplayName>
<FileName>Chime.raw</FileName>
</Ring>
</CiscoIPPhoneRingList>
Step 3 Copy the PCM and XML files to system Flash on the Cisco Unified CME router. For example:
copy tftp://192.168.1.1/RingList.xml flash:
copy tftp://192.168.1.1/DistinctiveRingList.xml flash:
copy tftp://192.168.1.1/Piano1.raw flash:
copy tftp://192.168.1.1/Chime.raw flash:
Step 4 Use the tftp-server command to enable access to the files. For example:
tftp-server flash:RingList.xml
tftp-server flash:DistinctiveRingList.xml
tftp-server flash:Piano1.raw
tftp-server flash:Chime.raw
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1033
Configuring Ring Tones
How to Configure Ring Tones
Step 5 Reboot the IP phones. After reboot, the IP phones download the XML and ring tone files. Select the
customized ring by pressing the Settings button followed by the Ring Type menu option on a phone.
SCCP: Enabling On-Hold Indicator
The Call Hold feature is available by default. To define an audible indicator as a reminder that a call is
waiting on hold, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag [dual-line]
4. hold-alert timeout {idle | originator | shared}
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag [dual-line] Enters ephone-dn configuration mode, creates an ephone-dn, and
optionally assigns it dual-line status.
Example:
Router(config)# ephone-dn 20
Step 4 hold-alert timeout {idle | originator | Sets audible alert notification on the Cisco Unified IP phone for
shared} alerting the user about on-hold calls.
Note From the perspective of the originator of the call on hold,
Example: the originator and shared keywords provide the same
Router(config-ephone-dn)# hold-alert 15 functionality.
idle
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
Cisco Unified Communications Manager Express System Administrator Guide
1034 OL-10663-02
Configuring Ring Tones
How to Configure Ring Tones
SIP: Enabling Distinctive Ringing
To set the ring pattern for distinguishing between external and internal incoming calls, perform the
following steps.
Prerequisites
Cisco Unified CME 3.4 or a later version.
Restrictions
bellcore-dr1 to bellcore-dr5 are the only Telcordia options that are supported for SIP phones.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. external-ring {bellcore-dr1 | bellcore-dr2 | bellcore-dr3 | bellcore-dr4 | bellcore-dr5}
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode to set
parameters for all supported SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register global
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1035
Configuring Ring Tones
Configuration Examples for Ring Tones
Command or Action Purpose
Step 4 external-ring {bellcore-dr1 | bellcore-dr2 | Specifies the type of audible ring sound to be used for
bellcore-dr3 | bellcore-dr4 | bellcore-dr5} external calls
• Default—Internal ring sound is used for all incoming
Example: calls.
Router(config-register-global)# external-ring
bellcore-dr3
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-global)# end
Configuration Examples for Ring Tones
This section contains the following examples:
• Distinctive Ringing for Internal Calls: Example, page 1036
• On-Hold Indicator: Example, page 1036
Distinctive Ringing for Internal Calls: Example
The following example sets distinctive ringing for internal calls on extension 2333.
ephone-dn 34
number 2333
ring internal
On-Hold Indicator: Example
In the following example, extension 2555 is configured to not forward local calls that are internal to the
Cisco Unified CME system. Extension 2222 dials extension 2555. If 2555 is busy, the caller hears a busy
tone. If 2555 does not answer, the caller hears ringback. The internal call is not forwarded.
ephone-dn 25
number 2555
no forward local-calls
call-forward busy 2244
call-forward noan 2244 timeout 45
Cisco Unified Communications Manager Express System Administrator Guide
1036 OL-10663-02
Configuring Ring Tones
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1037
Configuring Ring Tones
Feature Information for Ring Tones
Feature Information for Ring Tones
Table 44 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 44 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 44 Feature Information for Ring Tones
Cisco Unified CME
Feature Name Version Feature Information
Distinctive Ringing 4.0 Supports ring tones choices for all incoming calls to an
individual directory number, for all SCCP phones on which
the directory number appears.
3.4 Generate the alert-info for incoming calls from any phone
that is not registered in Cisco Unified CME, to local SIP
endpoints.
Customized Ring Tones 4.0 Customized Ring Tones feature was introduced.
On-Hold Indictor 4.0(2) Controls LED color display for hold state to provide visual
indicator for distinguishing a local hold from a remote hold
on shared lines on supported phones, such as the
Cisco Unified IP Phone 7931G.
2.0 Audible on-hold indicator was introduced.
1.0 Call Hold was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
1038 OL-10663-02
Configuring Single Number Reach (SNR)
First Published: February 27, 2009
Last Updated: October 5, 2009
This chapter describes the Single Number Reach (SNR) feature in Cisco Unified Communications
Manager Express (Cisco Unified CME) 7.1 and later versions.
Contents
• Information About Single Number Reach, page 1039
• How to Configure Single Number Reach, page 1040
• Additional References, page 1044
• Feature Information for Single Number Reach, page 1046
Information About Single Number Reach
To configure SNR, you should understand the following concept:
• Single Number Reach, page 1039
Single Number Reach
The Single Number Reach (SNR) feature allows users to answer incoming calls to their extension on
either their desktop IP phone or at a remote destination, such as a mobile phone. Users can pick up active
calls on the desktop phone or the remote phone without losing the connection. This enables callers to
dial a single number to reach the phone user. Calls that are not answered can be forwarded to voice mail.
Remote destinations may include the following devices:
• Mobile (cellular) phones.
• Smart phones.
• IP phones not belonging to the same Cisco Unified CME router as the desktop phone.
• Home phone numbers in the PSTN. Supported PSTN interfaces include PRI, BRI, SIP, and FXO.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1039
Configuring Single Number Reach (SNR)
How to Configure Single Number Reach
For incoming calls to the SNR extension, Cisco Unified CME rings the desktop IP phone first. If the
IP phone does not answer within the configured amount of time, it rings the configured remote number
while continuing to ring the IP phone. Unanswered calls are sent to a configured voice-mail number.
The IP phone user has these options for handling calls to the SNR extension:
• Pull back the call from the remote phone—Phone user can manually pull back the call to the SNR
extension by pressing the Resume soft key, which disconnects the call from the remote phone.
• Send the call to remote phone—Phone user can send the call to the remote phone by using the
Mobility soft key. While connected to the call, the phone user can press the Mobility soft key and
select “Send call to mobile.” The call is forwarded to the remote phone.
• Enable or disable Single Number Reach—While the IP phone is in the idle state, the user can toggle
the SNR feature on and off by using the Mobility soft key. If the user disables SNR,
Cisco Unified CME does not ring the remote number.
IP phone users can modify their own SNR settings directly from the phone by using the menu available
with the Services feature button. You must enable the feature on the phone to allow a phone user to
access the user interface.
This feature is supported in Cisco Unified CME 7.1 and later versions on SCCP IP phones that support
soft keys.
How to Configure Single Number Reach
This section contains the following task:
SCCP: Configuring Single Number Reach, page 1040
SCCP: Configuring Single Number Reach
To enable the Single Number Reach (SNR) feature on SCCP IP phones, perform the following steps.
Prerequisites
• Cisco Unified CME 7.1 or a later version
• Cisco IP Communicator requires version 2.1.4 or later
Restrictions
• Each IP phone supports only one SNR directory number.
• SNR feature is not supported for the following:
– SIP phones or SCCP-controlled analog FXS phones.
– MLPP calls.
– Secure calls.
– Video calls.
– Hunt group directory numbers (voice or ephone).
– MWI directory numbers.
Cisco Unified Communications Manager Express System Administrator Guide
1040 OL-10663-02
Configuring Single Number Reach (SNR)
How to Configure Single Number Reach
– Trunk directory numbers.
• An overlay set can support only one SNR directory number and that directory number must be the
primary directory number.
• Call forward no answer (CFNA), configured with the call-forward noan command, is disabled if
SNR is configured on the directory number. To forward unanswered calls to voice mail, use the
cfwd-noan keyword in the snr command.
• Call forwarding of unanswered calls, configured with the cfwd-noan keyword in the snr command,
is not supported for PSTN calls from FXO trunks because the calls connect immediately.
• If the SNR directory number is the transferred number (Xee) in a blind or consultive transfer, the
user cannot send the call to the remote phone.
• When an SNR call is answered on the remote phone and the call is then transferred, parked, or joined
in a hardware conference in Cisco Unified CME, the user cannot resume the call on the desktop
IP phone.
• Ad hoc and meet-me hardware conferencing support is limited:
– If the SNR directory number is participating in a hardware conference, the user cannot send the
call to the remote phone.
– If the call is answered on the remote phone and then is joined in a hardware conference in
Cisco Unified CME, the user cannot resume the call on the desktop phone.
These conference restrictions do not apply to software conferencing.
• Calls always remain private. If a call is answered on a remote phone, the desktop IP phone can not
listen to the call unless it resumes the call.
• U.S. English is the only locale supported for SNR calls.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
4. number number
5. mobility
6. snr e164-number delay seconds timeout seconds [cfwd-noan extension-number]
7. snr calling-number local
8. exit
9. ephone-template template-tag
10. softkeys connected {[Acct] [ConfList] [Confrn] [Endcall] [Flash] [HLog] [Hold] [Join]
[LiveRcd] [Mobility] [Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]}
11. softkeys idle {[Cfwdall] [ConfList] [Dnd] [Gpickup] [HLog] [Join] [Login] [Mobility]
[Newcall] [Pickup] [Redial] [RmLstC]}
12. exit
13. ephone phone-tag
14. ephone-template template-tag
15. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1041
Configuring Single Number Reach (SNR)
How to Configure Single Number Reach
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag [dual-line | octo-line] Enters directory number configuration mode.
Example:
Router(config)# ephone-dn 10
Step 4 number number Associates an extension number with this directory number.
• number—String of up to 16 digits that represents an
Example: extension or E.164 telephone number.
Router(config-ephone-dn)# number 1001
Step 5 mobility Enables the Mobility feature on the directory number.
Example:
Router(config-ephone-dn)# mobility
Step 6 snr e164-number delay seconds timeout Enables Single Number Reach on the extension.
seconds [cfwd-noan extension-number]
• e164-number—E.164 telephone number to ring if IP phone
extension does not answer.
Example:
Router(config-ephone-dn)# snr 4085550133
• delay seconds—Sets the number of seconds that the call rings
delay 5 timeout 15 cfwd-noan 2001 the IP phone before ringing the remote phone. Range: 0 to 10.
Default: disabled.
• timeout seconds—Sets the number of seconds that the call
rings after the configured delay. Call continues to ring for this
length of time on the IP phone even if the remote phone
answers the call. Range: 5 to 60. Default: disabled.
• cfwd-noan extension-number—(Optional) Forwards the call
to this target number if the phone does not answer after both
the delay and timeout seconds have expired. This is typically
the voice-mail number.
Note The cfwd-noan option is not supported for calls from
FXO trunks because the calls connect immediately.
Step 7 snr calling-number local (Optional) Replaces the original calling party number with the
SNR extension number in the caller ID display of the remote
phone.
Example:
Router(config-ephone-dn)# snr • This command is supported in Cisco Unified CME 8.0 and
calling-number local later versions.
Cisco Unified Communications Manager Express System Administrator Guide
1042 OL-10663-02
Configuring Single Number Reach (SNR)
How to Configure Single Number Reach
Command or Action Purpose
Step 8 exit Exits ephone-dn configuration mode.
Example:
Router(config-ephone-dn)# exit
Step 9 ephone-template template-tag Enters ephone-template configuration mode to create an ephone
template.
Example: • template-tag—Unique identifier for the ephone template that
Router(config)# ephone-template 1 is being created. Range: 1 to 20.
Step 10 softkeys connected {[Acct] [ConfList] Modifies the order and type of soft keys that display on an IP
[Confrn] [Endcall] [Flash] [HLog] [Hold] phone during the connected call state.
[Join] [LiveRcd] [Mobility] [Park]
[RmLstC] [Select] [TrnsfVM] [Trnsfer]} • Pressing the Mobility soft key during the connected call state
forwards the call to the PSTN number defined in Step 6.
Example:
Router(config-ephone-template)# softkeys
connected endcall hold livercd mobility
Step 11 softkeys idle {[Cfwdall] [ConfList] [Dnd] Modifies the order and type of soft keys that display on an IP
[Gpickup] [HLog] [Join] [Login] phone during the idle call state.
[Mobility] [Newcall] [Pickup] [Redial]
[RmLstC]} • Pressing the Mobility soft key during the idle call state
enables the SNR feature. This key is a toggle; pressing it a
second time disables SNR.
Example:
Router(config-ephone-template)# softkeys
idle dnd gpickup pickup mobility
Step 12 exit Exits ephone-template configuration mode.
Example:
Router(config-ephone-template)# exit
Step 13 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique number that identifies this ephone
Example: during configuration tasks.
Router(config)# ephone 21
Step 14 ephone-template template-tag Applies the ephone template to the phone.
• template-tag—Unique identifier of the ephone template that
Example: you created in Step 12.
Router(config-ephone)# ephone-template 1
Step 15 end Exits configuration mode.
Example:
Router(config-ephone-template)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1043
Configuring Single Number Reach (SNR)
Additional References
Examples
The following example shows extension 1001 is enabled for SNR on IP phone 21. After a call rings at
this number for 5 seconds, the call also rings at the remote number 4085550133. The call continues
ringing on both phones for 15 seconds. If the call is not answered after a total of 20 seconds, the call no
longer rings and it is forwarded to the voice-mail number 2001.
ephone-template 1
softkeys idle Dnd Gpickup Pickup Mobility
softkeys connected Endcall Hold LiveRcd Mobility
!
ephone-dn 10
number 1001
mobility
snr 4085550133 delay 5 timeout 15 cfwd-noan 2001
snr calling-number local
!
!
ephone 21
mac-address 02EA.EAEA.0001
ephone-template 1
button 1:10
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Cisco Unified Communications Manager Express System Administrator Guide
1044 OL-10663-02
Configuring Single Number Reach (SNR)
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1045
Configuring Single Number Reach (SNR)
Feature Information for Single Number Reach
Feature Information for Single Number Reach
Table 45 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 45 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 45 Feature Information for Single Number Reach
Cisco Unified CME
Feature Name Version Modification
Calling Number Local 8.0 Added the snr calling-number local command to replace
the calling party number with the SNR extension in the
caller ID display.
Single Number Reach 7.1 Introduced the SNR feature.
Cisco Unified Communications Manager Express System Administrator Guide
1046 OL-10663-02
Customizing Soft Keys
Last Updated: January 20, 2009
This chapter describes the soft-key features in Cisco Unified Communications Manager Express
(Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Soft Keys” section
on page 1064.
Contents
• Information About Soft Keys, page 1047
• How to Customize Soft Keys, page 1050
• Configuration Examples for Soft-Keys, page 1061
• Where to Go Next, page 1063
• Additional References, page 1063
• Feature Information for Soft Keys, page 1064
Information About Soft Keys
To customize soft keys on IP phones, you should understand the following concepts:
• Soft Keys on IP Phones, page 1048
• Account Code Entry, page 1049
• Hookflash Soft Key, page 1050
• Feature Blocking, page 1050
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1047
Customizing Soft Keys
Information About Soft Keys
Soft Keys on IP Phones
You can customize the display and order of soft keys that appear during various call states on individual
IP phones. Soft keys that are appropriate in each call state are displayed by default. Using phone
templates, you can delete soft keys that would normally appear or change the order in which the soft
keys appear. For example, you might want to display the CFwdAll and Confrn soft keys on a manager's
phone and remove these soft keys from a receptionist's phone.
You can modify soft keys for the following call states:
• Alerting—When the remote point is being notified of an incoming call, and the status of the remote
point is being relayed to the caller as either ringback or busy.
• Connected—When the connection to a remote point is established.
• Hold—When a connected party is still connected but there is temporarily no voice connection.
• Idle—Before a call is made and after a call is complete.
• Seized—When a caller is attempting a call but has not yet been connected.
• Remote-in-Use—When another phone is connected to a call on an octo-line directory number shared
by this phone (Cisco Unified CME 4.3 or a later version).
• Ringing—After a call is received and before the call is connected (Cisco Unified CME 4.2 or a later
version).
Not all soft keys are available in all call states. Use the CLI help to see the available soft keys for each
call state. The soft keys are as follows:
• Acct—Short for “account code.” Provides access to configured accounts.
• Answer—Picks up incoming call.
• Barge—Allows a user to join (barge) a call on a SIP shared line (Cisco Unified CME 7.1 or a later
version).
• Callback—Requests callback notification when a busy called line becomes free.
• CBarge—Barges (joins) a call on a shared octo-line directory number (Cisco Unified CME 4.3 or a
later version).
• CFwdALL—Short for “call forward all.” Forwards all calls.
• ConfList—Lists all parties in a conference (Cisco Unified CME 4.1 or a later version)
• Confrn—Short for “conference.” Connects callers to a conference call.
• DND—Short for “do not disturb.” Enables the do-not-disturb features.
• EndCall—Ends the current call.
• GPickUp—Short for “group call pickup.” Selectively picks up calls coming into a phone number
that is a member of a pickup group.
• Flash—Short for “hookflash.” Provides hookflash functionality for public switched telephone
network (PSTN) services on calls connected to the PSTN via a foreign exchange office (FXO) port.
• HLog—Places the phone of an ephone-hunt group agent into the not-ready status or, if the phone is
in the not-ready status, it places the phone into the ready status.
• Hold—Places an active call on hold and resumes the call.
• Join—Joins an established call to a conference (Cisco Unified CME 4.1 or a later version).
• LiveRcd—Starts the recording of a call (Cisco Unified CME 4.3 or a later version).
• Login—Provides personal identification number (PIN) access to restricted phone features.
Cisco Unified Communications Manager Express System Administrator Guide
1048 OL-10663-02
Customizing Soft Keys
Information About Soft Keys
• MeetMe—Initiates a meet-me conference (Cisco Unified CME 4.1 or a later version).
• Mobility—Soft key that forwards a call to the PSTN number defined by the Single Number Reach
(SNR) feature (Cisco Unified CME 7.1 or a later version).
• NewCall—Opens a line on a speakerphone to place a new call.
• Park—Places an active call on hold so it can be retrieved from another phone in the system.
• PickUp—Selectively picks up calls coming into another extension.
• Redial—Redials the last number dialed.
• Resume—Connects to the call on hold.
• RmLstC—Removes the last party added to a conference. This soft key only works for the conference
creator (Cisco Unified CME 4.1 or a later version).
• Select—Selects a call or a conference on which to take action (Cisco Unified CME 4.1 or a later
version).
• Trnsfer—Short for “call transfer.” Transfers an active call to another extension.
• TrnsfVM—Transfers a call to a voice-mail extension number (Cisco Unified CME 4.3 or a later
version).
You change the soft-key order by defining a phone template and applying the template to one or more
phones. You can create up to 20 phone templates for SCCP phones and ten templates for SIP phones.
Only one template can be applied to a phone. If you apply a second phone template to a phone that
already has a template applied to it, the second template overwrites the first phone template information.
The new information takes effect only after you generate a new configuration file and restart the phone,
otherwise the previously configured template remains in effect.
In Cisco Unified CME 4.1, customizing the soft key display for IP phones running SIP is supported only
for the Cisco Unified IP Phone 7911G, 7941G, 7941GE, 7961G, 7961GE, 7970G, and 7971GE.
For configuration information, see the “How to Customize Soft Keys” section on page 1050.
Account Code Entry
The Cisco Unified IP Phones 7940 and 7940G and the Cisco Unified IP Phones 7960 and 7960G allow
phone users to enter account codes during call setup or when connected to an active call using the Acct
soft key. Account codes are inserted into call detail records (CDRs) on the Cisco Unified CME router
for later interpretation by billing software.
An account code is visible in the output of the show call active command and the show call history
command for telephony call legs and is supported by the CISCO-VOICE-DIAL-CONTROL-MIB. The
account code also appears in the “account-code” RADIUS vendor-specific attribute (VSA) for voice
authentication, authorization, and accounting (AAA).
To enter an account code during call setup or when in a connected state, press the Acct soft key, enter
the account code using the phone keypad, then press the # key to notify Cisco Unified CME that the last
digit of the code has been entered. The account code digits are processed upon receipt of the # and appear
in the show output after processing.
No configuration is required for this feature.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1049
Customizing Soft Keys
How to Customize Soft Keys
Note If Cisco Unified CME does not receive a #, each account code digit is processed only after a timer
expires. The timer is 30 seconds for the first digit entered, then x seconds for each subsequent digit,
where x equals the number of seconds configured with the timeouts interdigit (telephony-service)
command. The default value for the interdigit timeout is 10 seconds. The account code digits do not
appear in show output until after being processed.
Hookflash Soft Key
The Flash soft key provides hookflash functionality for calls made on FXO trunks. Certain public
switched telephone network (PSTN) services, such as three-way calling and call waiting, require
hookflash intervention from a phone user. A soft key, labeled Flash, provides this hookflash
functionality for IP phones that use foreign exchange office (FXO) lines attached to the
Cisco Unified CME system.
When a Flash soft key is enabled on an IP phone, it can provide hookflash functionality during all calls
except for local IP-phone-to-IP-phone calls. Hookflash-controlled services can be activated only if they
are supported by the PSTN connection that is involved in the call. The availability of the Flash soft key
does not guarantee that hookflash-based services are accessible to the phone user.
For configuration information, see the “Enabling Flash Soft Key” section on page 1057.
Feature Blocking
In Cisco Unified CME 4.0 and later versions, individual soft-key features can be blocked on one or more
phones. You specify the features that you want blocked by adding the features blocked command to an
ephone template. The template is then applied under ephone configuration mode to one or more ephones.
If a feature is blocked using the features blocked command, the soft key is not removed, but it does not
function. For configuration information, see the “Configuring Feature Blocking” section on page 1059.
To remove a soft-key display, use the appropriate no softkeys command. See the “SCCP: Modifying
Soft-Key Display” section on page 1051.
How to Customize Soft Keys
This section contains the following tasks:
• SCCP: Modifying Soft-Key Display, page 1051
• SIP: Modifying Soft-Key Display, page 1054
• Verifying Soft-Key Configuration, page 1056
• Enabling Flash Soft Key, page 1057
• Verifying Flash Soft-Key Configuration, page 1058
• Configuring Feature Blocking, page 1059
• Verifying Feature Blocking, page 1061
Cisco Unified Communications Manager Express System Administrator Guide
1050 OL-10663-02
Customizing Soft Keys
How to Customize Soft Keys
SCCP: Modifying Soft-Key Display
To modify the display of soft-keys, perform the following steps.
Prerequisites
• Cisco CME 3.2 or a later version.
• Cisco Unified CME 4.2 or a later version to enable soft keys during the ringing call state.
• Cisco Unified CME 4.3 or a later version to enable soft keys during the remote-in-use state.
• The HLog soft key must be enabled with the hunt-group logout HLog command before it will be
displayed. For more information, see the “SCCP: Configuring Ephone Hunt Groups” section on
page 702.
• The Flash soft key must be enabled with the fxo hook-flash command before it will be displayed.
For configuration information, see the “Enabling Flash Soft Key” section on page 1057.
Restrictions
• Enable the ConfList and MeetMe soft keys only if you have hardware conferencing configured. For
information, see the “Meet-Me Conferencing in Cisco Unified CME 4.1 and Later versions” section
on page 756.
• The third soft-key button on the Cisco Unified IP Phone 7905G and Cisco Unified IP Phone 7912G
is reserved for the Message soft key. For these phones’ templates, the third soft-key defaults to the
Message soft key. For example, the softkeys idle Redial Dnd Pickup Login Gpickup command
configuration displays, in order, the Redial, DND, Message, PickUp, Login, and GPickUp soft keys.
• The NewCall soft key cannot be disabled on the Cisco Unified IP Phone 7905G or Cisco Unified IP
Phone 7912G.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-template template-tag
4. softkeys alerting {[Acct] [Callback] [Endcall]}
5. softkeys connected {[Acct] [ConfList] [Confrn] [Endcall] [Flash] [Hlog] [Hold] [Join]
[LiveRcd] [Park] [RmLstC] [Select] [TrnsfVM] [Trnsfer]}
6. softkeys hold {[Join] [Newcall] [Resume] [Select]}
7. softkeys idle {[Cfwdall] [ConfList] [Dnd] [Gpickup] [Hlog] [Join] [Login] [Newcall] [Pickup]
[Redial] [RmLstC]}
8. softkeys remote-in-use {[CBarge] [Newcall]}
9. softkeys ringing {[Answer] [Dnd] [HLog]}
10. softkeys seized {[CallBack] [Cfwdall] [Endcall] [Gpickup] [Hlog] [MeetMe] [Pickup]
[Redial]}
11. exit
12. ephone phone-tag
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1051
Customizing Soft Keys
How to Customize Soft Keys
13. ephone-template template-tag
14. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-template template-tag Enters ephone-template configuration mode to create an ephone
template.
Example: • template-tag—Unique identifier for the ephone template that
Router(config)# ephone-template 15 is being created. Range is 1 to 20.
Step 4 softkeys alerting {[Acct] [Callback] (Optional) Configures an ephone template for soft-key display
[Endcall]} during the alerting call state.
• You can enter any of the keywords in any order.
Example:
Router(config-ephone-template)# softkeys
• Default is all soft keys are displayed in alphabetical order.
alerting Callback Endcall • Any soft key that is not explicitly defined is disabled.
Step 5 softkeys connected {[Acct] [ConfList] (Optional) Configures an ephone template for soft-key display
[Confrn] [Endcall] [Flash] [Hlog] [Hold] during the call-connected state.
[Join] [LiveRcd] [Park] [RmLstC] [Select]
[TrnsfVM] [Trnsfer]} • You can enter any of the keywords in any order.
• Default is all soft keys are displayed in alphabetical order.
Example: • Any soft key that is not explicitly defined is disabled.
Router(config-ephone-template)# softkeys
connected Endcall Hold Transfer Hlog
Step 6 softkeys hold {[Join] [Newcall] [Resume] (Optional) Configures an ephone template for soft-key display
[Select]} during the call-hold state.
• You can enter any of the keywords in any order.
Example:
Router(config-ephone-template)# softkeys
• Default is all soft keys are displayed in alphabetical order.
hold Resume • Any soft key that is not explicitly defined is disabled.
Step 7 softkeys idle {[Cfwdall] [ConfList] [Dnd] (Optional) Configures an ephone template for soft-key display
[Gpickup] [Hlog] [Join] [Login] [Newcall] during the idle state.
[Pickup] [Redial] [RmLstC]}
• You can enter any of the keywords in any order.
Example: • Default is all soft keys are displayed in alphabetical order.
Router(config-ephone-template)# softkeys • Any soft key that is not explicitly defined is disabled.
idle Newcall Redial Pickup Cfwdall Hlog
Cisco Unified Communications Manager Express System Administrator Guide
1052 OL-10663-02
Customizing Soft Keys
How to Customize Soft Keys
Command or Action Purpose
Step 8 softkeys remote-in-use {[CBarge] Modifies the order and type of soft keys that display on an IP
[Newcall]} phone during the remote-in-use call state.
Example:
Router(config-ephone-template)# softkeys
remote-in-use CBarge Newcall
Step 9 softkeys ringing {[Answer] [Dnd] [HLog]} (Optional) Configures an ephone template for soft-key display
during the ringing state.
Example: • You can enter any of the keywords in any order.
Router(config-ephone-template)# softkeys
ringing Answer Dnd Hlog
• Default is all soft keys are displayed in alphabetical order.
• Any soft key that is not explicitly defined is disabled.
Step 10 softkeys seized {[CallBack] [Cfwdall] (Optional) Configures an ephone template for soft-key display
[Endcall] [Gpickup] [Hlog] [MeetMe] during the seized state.
[Pickup] [Redial]}
• You can enter any of the keywords in any order.
Example: • Default is all soft keys are displayed in alphabetical order.
Router(config-ephone-template)# softkeys • Any soft key that is not explicitly defined is disabled.
seized Endcall Redial Pickup Cfwdall Hlog
Step 11 exit Exits ephone-template configuration mode.
Example:
Router(config-ephone-template)# exit
Step 12 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies this
Example: ephone during configuration tasks.
Router(config)# ephone 36
Step 13 ephone-template template-tag Applies an ephone template to the ephone that is being
configured.
Example:
Router(config-ephone)# ephone-template 15
Step 14 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See the “SCCP: Generating Configuration Files for SCCP Phones” section
on page 263.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1053
Customizing Soft Keys
How to Customize Soft Keys
SIP: Modifying Soft-Key Display
To modify the display of soft keys on SIP phones for different call states, perform the following steps.
Prerequisites
Cisco Unified CME 4.1 or a later version.
Restrictions
• This feature is supported only for Cisco Unified IP Phones 7911G, 7941G, 7941GE, 7961G,
7961GE, 7970G, and 7971GE.
• You can download a custom soft key XML file from a TFTP server, however if the soft key XML
file contains an error, the soft keys might not work properly on the phone. We recommend the
following procedure for creating a soft key template in Cisco Unified CME.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register template template-tag
4. softkeys connected {[Confrn] [Endcall] [Hold] [Trnsfer]}
5. softkeys hold {[Newcall] [Resume]}
6. softkeys idle {[Cfwdall] [Newcall] [Redial]}
7. softkeys seized {[Cfwdall] [Endcall] [Redial]}
8. exit
9. voice register pool pool-tag
10. template template-tag
11. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register template template-tag Enters voice register template configuration mode to create
a SIP phone template.
Example: • template-tag—Range: 1 to 10.
Router(config)# voice register template 9
Cisco Unified Communications Manager Express System Administrator Guide
1054 OL-10663-02
Customizing Soft Keys
How to Customize Soft Keys
Command or Action Purpose
Step 4 softkeys connected {[Confrn] [Endcall] [Hold] (Optional) Configures an SIP phone template for soft-key
[Trnsfer]} display during the call-connected state.
• You can enter the keywords in any order.
Example:
Router(config-register-template)# softkeys
• Default is all soft keys are displayed in alphabetical
connected Endcall Hold Transfer order.
• Any soft key that is not explicitly defined is disabled.
Step 5 softkeys hold {[Newcall] {Resume]} (Optional) Configures a phone template for soft-key display
during the call-hold state.
Example: • Default is that the NewCall and Resume soft keys are
Router(config-register-template)# softkeys hold displayed in alphabetical order.
Resume
• Any soft key that is not explicitly defined is disabled.
Step 6 softkeys idle {[Cfwdall] [Newcall] [Redial]} (Optional) Configures a phone template for soft-key display
during the idle state.
Example: • You can enter the keywords in any order.
Router(config-register-template)# softkeys idle
Newcall Redial Cfwdall
• Default is all soft keys are displayed in alphabetical
order.
• Any soft key that is not explicitly defined is disabled.
Step 7 softkeys seized {[Cfwdall] [Endcall] [Redial]} (Optional) Configures a phone template for soft-key display
during the seized state.
Example: • You can enter the keywords in any order.
Router(config-register-template)# softkeys
seized Endcall Redial Cfwdall
• Default is all soft keys are displayed in alphabetical
order.
• Any soft key that is not explicitly defined is disabled.
Step 8 exit Exits voice register template configuration mode.
Example:
Router(config-register-template)# exit
Step 9 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for a SIP phone.
Example:
Router(config)# voice register pool 36
Step 10 template template-tag Applies a SIP phone template to the phone you are
configuring.
Example: • template-tag— Template tag that was created with the
Router(config-register-pool)# template 9 voice register template command in Step 3
Step 11 end Exits to privileged EXEC mode.
Example:
Router(config-register-pool)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1055
Customizing Soft Keys
How to Customize Soft Keys
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See the “SIP: Generating Configuration Profiles for SIP Phones” section on
page 265.
Verifying Soft-Key Configuration
Step 1 show running-config
Use this command to verify your configuration. In the following example, the soft-key display is
modified in phone template 7 and the template is applied to SIP phone 2. All other phones use the default
arrangement of soft keys.
Router# show running-config
!
ephone-dn 1 dual-line
ring feature secondary
number 126 secondary 1261
description Sales
name Smith
call-forward busy 500 secondary
call-forward noan 500 timeout 10
huntstop channel
no huntstop
no forward local-calls
!
!
voice register template 7
session-transport tcp
softkeys hold Resume Newcall
softkeys idle Newcall Redial Cfwdall
softkeys connected Endcall Trnsfer Confrn Hold
voicemail 52001 timeout 30
.
.
.
voice register pool 2
id mac 0030.94C2.A22A
number 1 dn 4
template 7
dialplan 3
!
Step 2 show telephony-service ephone-template
or
show voice register template template-tag
Cisco Unified Communications Manager Express System Administrator Guide
1056 OL-10663-02
Customizing Soft Keys
How to Customize Soft Keys
This command displays the contents of individual templates.
Router# show telephony-service ephone-template
ephone-template 1
softkey ringing Answer Dnd
conference drop-mode never
conference add-mode all
conference admin: No
Always send media packets to this router: No
Preferred codec: g711ulaw
User Locale: US
Network Locale: US
or
Router# show voice register template 7
Temp Tag 7
Config:
Attended Transfer is enabled
Blind Transfer is enabled
Semi-attended Transfer is enabled
Conference is enabled
Caller-ID block is disabled
DnD control is enabled
Anonymous call block is disabled
Voicemail is 52001, timeout 30
KPML is disabled
Transport type is tcp
softkey connected Endcall Trnsfer Confrn Hold
softkey hold Resume Newcall
softkey idle Newcall Redial Cfwdall
Enabling Flash Soft Key
To enable the flash soft key, perform the following steps.
Restrictions
The IP phone must support soft-key display.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. fxo hook-flash
5. restart all
6. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1057
Customizing Soft Keys
How to Customize Soft Keys
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 fxo hook-flash Enables the Flash soft key on phones that support soft-key
display, on PSTN calls using an FXO port.
Example: Note The Flash soft key display is automatically disabled
Router(config-telephony)# fxo hook-flash for local IP-phone-to-IP-phone calls.
Step 5 restart all Performs a fast reboot of all phones associated with this
Cisco Unified CME router. Does not contact the DHCP or
TFTP server for updated information.
Example:
Router(config-telephony)# restart all
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Verifying Flash Soft-Key Configuration
Step 1 Use the show running-config command to display an entire configuration, including Flash soft key,
which is listed in the telephony-service portion of the output.
Router# show running-config
telephony-service
fxo hook-flash
load 7960-7940 P00305000600
load 7914 S00103020002
max-ephones 100
max-dn 500
.
.
.
Step 2 Use the show telephony-service command to show only the telephony-service portion of the
configuration.
Cisco Unified Communications Manager Express System Administrator Guide
1058 OL-10663-02
Customizing Soft Keys
How to Customize Soft Keys
Configuring Feature Blocking
To configure feature blocking for SCCP phones, perform the following steps.
Prerequisites
Cisco Unified CME 4.0 or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-template template-tag
4. features blocked [CFwdAll] [Confrn] [GpickUp] [Park] [PickUp] [Trnsfer]
5. exit
6. ephone phone-tag
7. ephone-template template-tag
8. restart
9. Repeat Step 5 to Step 8 for each phone to which the template should be applied.
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-template template-tag Enters ephone-template configuration mode.
• template-tag—Unique sequence number that identifies
Example: this template during configuration tasks. Range is
Router(config)# ephone-template 1 1 to 20.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1059
Customizing Soft Keys
How to Customize Soft Keys
Command or Action Purpose
Step 4 features blocked [CFwdAll] [Confrn] [GpickUp] Prevents the specified soft key from invoking its feature.
[Park] [PickUp] [Trnsfer]
• CFwdAll—Call forward all calls.
• Confrn—Conference.
Example:
Router(config-ephone-template)# features • GpickUp—Group call pickup.
blocked Park Trnsfer
• Park—Call park.
• PickUp—Directed or local call pickup. This includes
pickup last-parked call and pickup from another
extension or park slot.
• Trnsfer—Call transfer.
Step 5 exit Exits ephone-template configuration mode.
Example:
Router(config-ephone-template)# exit
Step 6 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies
Example: this ephone during configuration tasks. The maximum
Router(config)# ephone 25 number of ephones for a particular Cisco Unified CME
system is version- and platform-specific. For the range
of values, see the CLI help.
Step 7 ephone-template template-tag Applies an ephone template to an ephone.
• template-tag—Template number that you want to apply
Example: to this ephone.
Router(config-ephone)# ephone-template 1
Note To view your ephone-template configurations, use
the show telephony-service ephone-template
command.
Step 8 restart Performs a fast reboot of this ephone. Does not contact the
DHCP or TFTP server for updated information.
Example: Note If you are applying the template to more than one
Router(config-ephone)# restart ephone, you can use the restart all command in
telephony-service configuration mode to reboot all
the phones so they have the new template
information.
Step 9 Repeat Step 5 to Step 8 for each phone to which the —
template should be applied.
Step 10 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Cisco Unified Communications Manager Express System Administrator Guide
1060 OL-10663-02
Customizing Soft Keys
Configuration Examples for Soft-Keys
Verifying Feature Blocking
Step 1 Use the show running-config command to display the running configuration, including ephone
templates and ephone configurations.
Step 2 Use the show telephony-service ephone-template command and the show telephony-service ephone
command to display only the contents of ephone templates and the ephone configurations .
Configuration Examples for Soft-Keys
This section contains the following examples:
• Modifying Soft-Key Display: Example, page 1061
• Modifying the HLog Soft Key for Ephone Hunt Groups: Example, page 1062
• Enabling Flash Soft Key for PSTN Calls: Example, page 1062
• Park and Transfer Blocking: Example, page 1062
• Conference Blocking: Example, page 1062
Modifying Soft-Key Display: Example
The following example modifies soft-key display on four phones by creating two ephone templates.
Ephone template 1 is applied to ephone 11, 13, and 15. Template 2 is applied to ephone 34. The soft-key
displays on all other phones use the default arrangement of keys.
ephone-template 1
softkeys idle Redial Newcall
softkeys connected Endcall Hold Trnsfer
ephone-template 2
softkeys idle Redial Newcall
softkeys seized Redial Endcall Pickup
softkeys alerting Redial Endcall
softkeys connected Endcall Hold Trnsfer
ephone 10
ephone-template 2
ephone 13
ephone-template 1
ephone 15
ephone-template 1
ephone 34
ephone-template 2
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1061
Customizing Soft Keys
Configuration Examples for Soft-Keys
Modifying the HLog Soft Key for Ephone Hunt Groups: Example
The following example establishes the appearance and order of soft keys for phones that are configured
with ephone-template 7. The Hlog key is available when a phone is idle, when it has seized a line, or
when it is connected to a call. Phones without soft keys can use the standard HLog codes to toggle ready
and not-ready status.
telephony-service
hunt-group logout HLog
fac standard
.
.
ephone-template 7
softkeys connected Endcall Hold Transfer Hlog
softkeys idle Newcall Redial Pickup Cfwdall Hlog
softkeys seized Endcall Redial Pickup Cfwdall Hlog
Enabling Flash Soft Key for PSTN Calls: Example
The following example enables the Flash soft key for PSTN calls through an FXO voice port.
telephony-service
fxo hook-flash
Park and Transfer Blocking: Example
The following example blocks the use of Park and Transfer soft keys on extension 2333.
ephone-template 1
features blocked Park Trnsfer
ephone-dn 2
number 2333
ephone 3
button 1:2
ephone-template 1
Conference Blocking: Example
The following example blocks the conference feature on extension 2579, which is on an analog phone.
ephone-template 1
features blocked Confrn
ephone-dn 78
number 2579
ephone 3
ephone-template 1
mac-address C910.8E47.1282
type anl
button 1:78
Cisco Unified Communications Manager Express System Administrator Guide
1062 OL-10663-02
Customizing Soft Keys
Where to Go Next
Where to Go Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. For more information, see “Generating Configuration Files for Phones” on
page 261.
Ephone Templates
The softkeys commands are included in ephone templates that are applied to one or more individual
ephones. For more information about templates, see “Creating Templates” on page 1129.
HLog Soft Key
The HLog soft key must be enabled with the hunt-group logout HLog command before it will be
displayed. For more information, see “Configuring Call-Coverage Features” on page 663.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies. Access to most tools
on the Cisco Support website requires a Cisco.com user
ID and password. If you have a valid service contract
but do not have a user ID or password, you can register
on Cisco.com.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1063
Customizing Soft Keys
Feature Information for Soft Keys
Feature Information for Soft Keys
Table 46 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 46 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 46 Feature Information for Soft Keys
Cisco Unified CME
Feature Name Version Feature Information
Account Code Entry 3.0 Account code entry was introduced.
Barge Sofk Key 4.3 The Barge, LiveRcd, and TrnsfVM soft keys were added.
Conferencing Soft Keys 4.1 The ConfList, Join, MeetMe, RmLstC, and Select soft keys
were added.
Feature Blocking 4.0 Feature blocking was introduced.
Flash Soft Key 3.0 Flash soft key was introduced.
Soft-Key Display 4.1 Configurable soft key display for IP phones running SIP is
supported for the Cisco Unified IP Phone 7911G, 7941G,
7941GE, 7961G, 7961GE, 7970G, and 7971GE
4.0 • An optional HLog soft key was added to the
connected, idle, and seized call states.
• The ability to customize soft-key display in the hold
call state was added.
3.2 Configurable soft-key display (the ability to customize
soft-key display in the alerting, connected, idle, and seized
call states) was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
1064 OL-10663-02
Configuring Speed Dial
Last Updated: October 20, 2008
This chapter describes the speed dial support available in Cisco Unified Communications Manager
Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Speed Dial” section
on page 1086.
Contents
• Information About Speed Dial, page 1065
• How to Configure Speed Dial, page 1070
• Configuration Examples for Speed Dial, page 1082
• Where to Go Next, page 1084
• Additional References, page 1084
• Feature Information for Speed Dial, page 1086
Information About Speed Dial
To enable speed dial, you should understand the following concepts:
• Speed Dial Summary, page 1066
• Speed Dial Buttons and Abbreviated Dialing, page 1067
• Bulk-Loading Speed Dial Numbers, page 1067
• Monitor-Line Button for Speed Dial, page 1068
• DSS (Direct Station Select) Service, page 1069
• Phone User-Interface for Speed Dial and Fast Dial, page 1069
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1065
Configuring Speed Dial
Information About Speed Dial
Speed Dial Summary
Speed dial allows a phone user to quickly dial a number from a list. The different types of speed dial are
summarized in Table 47.
Table 47 Speed Dial Types
Speed Dial Type Availability of Numbers Description How Configured
Local Speed Dial System-level list of frequently Users invoke entries from the Enabling a Local Speed Dial
Menu called numbers that can be Directories > Local Speed Dial Menu, page 1070.
programmed on all phones. menu on IP phones.
A maximum of 32 numbers can
be defined.
Numbers are set up by an
administrator using an XML File
speeddial.xml, which is placed in
the Cisco Unified CME router’s
flash memory.
Personal Speed Speed dial entries are local to a Users invoke entries from the • SCCP: Enabling a Personal
Dial Menu specific IP phone. Directories > Local Services > Speed Dial Menu, page 1073
Personal Speed Dials menu on IP
A maximum of 24 numbers per • SIP: Configuring a Personal
phones.
phone can be defined. Speed-Dial Menu,
page 1080.
Speed Dial Up to 99 speed-dial codes per For IP phones, the first entries • SCCP: Defining Speed-Dial
Buttons and phone. that are set up occupy any unused Buttons and Abbreviated
Abbreviated line buttons and are invoked Dialing, page 1074
Dialing when a user presses one of these
• SIP: Defining Speed-Dial
line buttons. Subsequent entries
Buttons, page 1079.
are invoked when a phone user
dials the speed-dial code (tag)
and the Abbr soft key.
Analog phone users invoke speed
dial by entering an asterisk and
the speed-dial code (tag) number
of the desired entry.
Bulk-Loading There can be up to ten text files Phone users dial the following SCCP: Enabling Bulk-Loading
Speed Dial containing lists of many sequence: Speed-Dial, page 1076.
Numbers speed-dial numbers that are
prefix-code list-id index
loaded into flash, slot, or TFTP
[extension-digits]
locations to be accessed by phone
users. The ten files can hold
10,000 numbers.
Cisco Unified Communications Manager Express System Administrator Guide
1066 OL-10663-02
Configuring Speed Dial
Information About Speed Dial
Table 47 Speed Dial Types
Speed Dial Type Availability of Numbers Description How Configured
Monitor-Line IP phone buttons that are
Speed dial entries are local to a No additional configuration
Button for Speed specific IP phone. configured as monitor lines can required.
Dial be used to speed-dial the line that
There can be as many numbers as
is being monitored.
there are monitor lines on a
phone.
Direct Station All phones on which speed-dial Allows phone user to fast transfer SCCP: Enabling DSS Service,
Select (DSS) line or monitor line button is a call by pressing a single page 1072.
Service configured. speed-dial line or monitor line
button.
Speed Dial Buttons and Abbreviated Dialing
In a Cisco Unified CME system, each phone can have up to 33 local speed-dial numbers (codes 1 to 33),
up to 99 system-level speed-dial numbers (codes 1 to 99), or a combination of the two. If you program
both a local and a system-level speed-dial number with the same speed-dial code (tag), the local number
takes precedence. Typically you will want to reserve codes 1 to 33 for local, per-phone speed-dial
numbers and use codes 34 to 99 for system-level speed-dial numbers so that there is no conflict.
On an IP phone, speed-dial entries are assigned to unused line buttons. Then, after all line buttons are
used, subsequent entries are added but do not have an assigned line button. The speed-dial entry is not
related to the physical button layout of the phone. Entries are assigned in order of speed-dial tag.
You can create local speed-dial codes with locked numbers that cannot be changed from the phone. You
can also create empty local speed-dial codes on an IP phone without a telephone number. These empty
speed-dial codes can be changed by the phone user to add a telephone number.
Changes to speed-dial entries are saved into the router’s nonvolatile random-access memory (NVRAM)
configuration after a timer-based delay.
For configuration information, see the “SCCP: Defining Speed-Dial Buttons and Abbreviated Dialing”
section on page 1074.
Bulk-Loading Speed Dial Numbers
In Cisco Unified CME 4.0 and later versions, up to ten text files containing lists of many speed-dial
numbers can be loaded into flash, slot, or TFTP locations to be accessed by phone users. The ten files
can hold a total of up to 10,000 numbers. Each list holds numbers that are in an appropriate format for
dialing from IP phones and SCCP-enabled analog phones.
Up to ten bulk speed-dial lists can be created. These lists might be corporate directory lists, regional lists,
or local lists, for example. The speed-dial numbers in these lists can be system-level (available to all
ephones) or personal (available to one or more specified ephones). Each list receives a unique speed-dial
list ID number (sd-id) between 0 and 9.
Speed-dial list ID numbers that are not used for global speed-dial lists are available to identify personal,
custom lists that are associated with individual phones.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1067
Configuring Speed Dial
Information About Speed Dial
Bulk speed-dial lists contain entries of speed-dial codes and the associated phone numbers to dial. Each
entry in a speed-dial list must appear on a separate line. The fields in each entry are separated by
commas (,). A line that begins with a semicolon (;) is handled as a comment. The format of each entry
is shown in the following line.
index,digits,[name],[hide],[append]
Table 48 explains the fields in a bulk speed-dial list entry.
Table 48 Bulk Speed-Dial List Entry
Field Description
index Zero-filled number that uniquely identifies this index entry.
Maximum length: 4 digits. All index entries must be the same
length.
digits Telephone number to dialed. Represents a fully qualified
E.164 number. Use a comma (,) to represent a one-second
pause.
name (Optional) Alphanumeric string to identify a name, up to 30
characters.
hide (Optional) Enter hide to block the display of the dialed
number.
append (Optional) Enter append to allow additional digits to be
appended to this number when dialed.
The following is a sample bulk speed-dial list:
01,5550140,voicemail,hide,append
90,914085550153,Cisco extension,hide,append
11,9911,emergency,hide,
91,9911,emergency,hide,
08,110,Paging,,append
To place a call to a speed-dial entry in a list, the phone user must first dial a prefix, followed by the list
ID number, then the index for the bulk speed-dial list entry to be called.
For configuration information, see the “SCCP: Enabling Bulk-Loading Speed-Dial” section on
page 1076.
Monitor-Line Button for Speed Dial
For Cisco CME 3.2 and later versions, a monitor-line button can be used to speed-dial the monitor line’s
number. A monitor line is a line that is shared by two people. Only one person can make and receive
calls on the shared line at a time, while the other person, whose line is in monitor mode, is able to see
that the line is in use. Speed dialing is available when monitor lines’ lamps are off, indicating that the
line is not in use. For example, an assistant who wants to talk with a manager can press an unlit
monitor-line button to speed-dial the manager’s number.
A monitor-line lamp is off or unlit only when its line is in the idle call state. The idle state occurs before
a call is made and after a call is completed. For all other call states, the monitor-line lamp is on or lit.
Cisco Unified Communications Manager Express System Administrator Guide
1068 OL-10663-02
Configuring Speed Dial
Information About Speed Dial
The following example shows a monitor-line configuration. Extension 2311 is the manager’s line, and
ephone 1 is the manager’s phone. The manager’s assistant monitors extension 2311 on button 2 of
ephone 2. When the manager is on the line, the lamp is lit on the assistant’s phone. If the lamp is not lit,
the assistant can speed-dial the manager by pressing button 2.
ephone-dn 11
number 2311
ephone-dn 22
number 2322
ephone 1
button 1:11
ephone 2
button 1:22 2m11
No additional configuration is required to enable a phone user to speed dial the number of a monitored
shared line, when the monitored line is in an idle call state.
DSS (Direct Station Select) Service
In Cisco Unified CME 4.0(2) and later versions, the DSS (Direct Station Select) Service feature allows
the phone user to press a single speed-dial line button to transfer an incoming call when the call is in the
connected state. This feature is supported on all phones on which monitor line buttons for speed dial or
speed-dial line buttons are configured.
When the DSS service is enabled, the system automatically generates a simulated transfer key event
when needed, eliminating the requirement for the phone user to press the Transfer button.
Disabling the service changes the behavior of the speed-dial line button on all IP phones so that a user
pressing a speed-dial button in the middle of a connected call will play out the speed-dial digits into the
call without transferring the call. When DSS service is disabled, the phone user must first press Transfer
and then press the monitor or speed-dial line button to transfer the incoming call.
For configuration information, see the “Enabling a Local Speed Dial Menu” section on page 1070.
Phone User-Interface for Speed Dial and Fast Dial
In Cisco Unified CME 4.3 and later versions, IP phone users can configure their own speed-dial and
fast-dial settings directly from the phone. The speed-dial and fast-dial settings can be added or modified
on the phone by using a menu available with the Services feature button. Extension Mobility users can
add or modify speed-dial settings in their user profile after logging in. Fast-dial settings are not
configurable from Extension Mobility phones, nor is the logout profile configurable from the phone.
Previously, the speed-dial and fast-dial configuration for a phone could only be done in
Cisco Unified CME or by using the web-based GUI. This feature gives phone users the convenience of
configuring their speed-dial and fast-dial settings from their phones directly.
The speed-dial and fast-dial user interface is enabled by default on all phones with displays. You can
disable the capability for an individual phone in Cisco Unified CME to prevent a phone user from
accessing the interface. If a phone's speed-dial or fast-dial setting is configured with an ephone-template,
the configuration from the phone applies only to the specific phone and does not change the
ephone-template configuration.
For configuration information, see the “SCCP: Enabling User Interface for Speed-Dial and Fast-Dial”
section on page 1078.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1069
Configuring Speed Dial
How to Configure Speed Dial
For information on how phone users configure speed-dial and fast-dial buttons using the phone
user-interface, see the Cisco Unified IP Phone documentation for Cisco Unified CME.
How to Configure Speed Dial
This section contains the following tasks:
• Enabling a Local Speed Dial Menu, page 1070
• SCCP: Enabling DSS Service, page 1072
• SCCP: Enabling a Personal Speed Dial Menu, page 1073
• SCCP: Defining Speed-Dial Buttons and Abbreviated Dialing, page 1074
• SCCP: Enabling Bulk-Loading Speed-Dial, page 1076
• SCCP: Verifying Bulk Speed-Dial Parameters, page 1077
• SCCP: Enabling User Interface for Speed-Dial and Fast-Dial, page 1078
• SIP: Defining Speed-Dial Buttons, page 1079
• SIP: Configuring a Personal Speed-Dial Menu, page 1080
Enabling a Local Speed Dial Menu
To enable a local speed-dial menu for all phones, SCCP and SIP, in Cisco Unified CME, perform the
following steps:
Prerequisites
An XML file called speeddial.xml must be created and copied to the TFTP server application on the
Cisco Unified CME router. The contents of speeddial.xml must be valid as defined in the
Cisco-specified directory DTD. See the “Enabling a Local Speed Dial Menu: Example” section on
page 1082 and the Cisco Unified IP Phone Services Application Development Notes.
Restrictions
• If a speed dial XML file contains incomplete information, for example the name or telephone
number is missing for an entry, any information in the file that is listed after the incomplete entry is
not displayed when the local speed dial directory option is used on a phone.
• Before Cisco Unified CME 4.1, local speed-dial menu is not supported on SIP phones.
• Before Cisco CME 3.3, analog phones are limited to nine speed-dial numbers.
SUMMARY STEPS
1. enable
2. copy tftp flash
3. configure terminal
4. ip http server
5. ip http path flash:
Cisco Unified Communications Manager Express System Administrator Guide
1070 OL-10663-02
Configuring Speed Dial
How to Configure Speed Dial
6. exit
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 copy tftp flash Copies the file from the TFTP server to the router flash
memory.
Example: • At the first prompt, enter the IP address or the DNS
Router# copy tftp flash name of the remote host.
Address or name of remote host []? 172.24.59.11 • At both filename prompts, enter speeddial.xml.
Source filename []? speeddial.xml
• At the prompt to erase flash, enter no.
Destination filename [speeddial.xml]?
Accessing tftp://172.24.59.11/speeddial.xml...
Erase flash:before copying? [confirm]n
Loading speeddial.xml from 172.24.59.11 (via
FastEthernet0/0):!
[OK - 329 bytes]
Verifying checksum... OK (0xF5DB)
329 bytes copied in 0.044 secs (7477 bytes/sec)
Step 3 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 4 ip http server Enables the Cisco web-browser user interface on the router.
Example:
Router(config)# ip http server
Step 5 ip http path flash: Sets the base HTTP path to flash memory.
Example:
Router(config)# ip http path flash:
Step 6 exit Returns to privileged EXEC mode.
Example:
Router(config)# exit
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1071
Configuring Speed Dial
How to Configure Speed Dial
SCCP: Enabling DSS Service
To enable DSS Service for all on all SCCP phones on which monitor line buttons for speed dial or
speed-dial line buttons are configured, perform the following steps.
Prerequisites
Cisco Unified CME 4.0(2) or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. service dss
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 service dss Configures DSS (Direct Station Select) service globally
for all phone users in Cisco Unified CME.
Example:
Router(config-telephony)# service dss
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-telephony)# end
Cisco Unified Communications Manager Express System Administrator Guide
1072 OL-10663-02
Configuring Speed Dial
How to Configure Speed Dial
SCCP: Enabling a Personal Speed Dial Menu
To enable a personal speed-dial menu, perform the following steps.
Restrictions
• A personal speed-dial menu is available only on certain Cisco Unified IP phones, such as the 7940,
7960, 7960G, 7970G, and 7971G-GE. To determine whether personal speed-dial menu is supported
on your IP phone, see the Cisco Unified CME user guide for your IP phone model.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. fastdial dial-tag number name name-string
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique number of the phone for which you
Example: want to program personal speed-dial numbers.
Router(config)# ephone 1
Step 4 fastdial dial-tag number name name-string Creates an entry for a personal speed-dial number on this
phone.
Example: • dial-tag—Unique identifier to identify this entry during
Router(config-ephone)# fastdial 1 5552 name configuration. Range is 1 to 24.
Sales
• number—Telephone number or extension to be dialed.
• name name-string—Label to appear in the Personal
Speed Dial menu, containing a string of up to
24 alphanumeric characters. Personal speed dial is
handled through an XML request, so characters that
have special meaning to HTTP, such as ampersand (&),
percent sign (%), semicolon (;), angle brackets (< >),
and vertical bars (||), are not allowed.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1073
Configuring Speed Dial
How to Configure Speed Dial
Command or Action Purpose
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
SCCP: Defining Speed-Dial Buttons and Abbreviated Dialing
To define speed-dial buttons and abbreviated dialing codes, perform the following steps for each
speed-dial definition to be configured.
Restrictions
• On-hook abbreviated dialing using the Abbr soft key is supported only on the following phones:
– Cisco Unified IP Phone 7905G
– Cisco Unified IP Phone 7912G
– Cisco Unified IP Phone 7920G
– Cisco Unified IP Phone 7970G
– Cisco Unified IP Phone 7971G-GE
• System-level speed-dial codes cannot be changed by the phone user, at the phone.
• Before Cisco CME 3.3, analog phones were limited to nine speed-dial numbers.
• Before to Cisco CME 3.3, speed-dial entries that were in excess of the number of physical phone
buttons available were ignored by IP phones.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. speed-dial speed-tag digit-string [label label-text]
5. exit
6. telephony-service
7. directory entry {directory-tag number name name | clear}
8. end
Cisco Unified Communications Manager Express System Administrator Guide
1074 OL-10663-02
Configuring Speed Dial
How to Configure Speed Dial
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies
Example: the phone on which you are adding speed-dial
Router(config)# ephone 55 capability.
Step 4 speed-dial speed-tag digit-string [label Defines a unique speed-dial identifier, a digit string to dial,
label-text] and an optional label to display next to the button.
• speed-tag—Identifier for a speed-dial definition.
Example: Range is 1 to 33.
Router(config-ephone)# speed-dial 1 +5001 label
“Head Office”
Step 5 restart Performs a fast reboot of this ephone. Does not contact the
DHCP or TFTP server for updated information.
Example:
Router(config-ephone)# restart
Step 6 exit Exits configuration mode to the next highest mode in the
configuration mode hierarchy.
Example:
Router(config-ephone)# exit
Step 7 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 8 directory entry {{directory-tag number name Adds a system-level directory and speed-dial definition.
name} | clear}
• directory-tag—Digit string that provides a unique
identifier for this entry. Range is 1 to 99.
Example:
Router(config-telephony)# directory entry 45
• If the same tags 1 through 33 are configured at a
8185550143 name Corp Acctg phone-level by using speed-dial command, and at a
system-level by using this command, the local
definition takes precedence. To prevent this conflict,
we recommend that you use only codes 34 to 99 for
system-level speed-dial numbers.
Step 9 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1075
Configuring Speed Dial
How to Configure Speed Dial
SCCP: Enabling Bulk-Loading Speed-Dial
To enable bulk-loading speed-dial numbers, perform the following steps:
Prerequisites
• Cisco Unified CME 4.0 or a letter version.
• The bulk speed-dial text files containing the lists must be available in a location that is available to
the Cisco Unified CME router: flash, slot, or TFTP location.
Restrictions
• Bulk speed dial is not supported on FXO trunk lines.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. bulk-speed-dial list list-id location
5. bulk-speed-dial prefix prefix-code
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
1076 OL-10663-02
Configuring Speed Dial
How to Configure Speed Dial
Command or Action Purpose
Step 4 bulk-speed-dial list list-id location Identifies the location of a bulk speed-dial list.
• list-id—Digit that identifies the list to be used. Range is
Example: 0 to 9.
Router(config-telephony)# bulk-speed-dial list 6
flash:sd_dept_0_1_8.txt
• location—Location of the bulk speed-dial text file in
URL format. Valid storage locations are TFTP, Slot 0/1,
and flash memory.
• This command can also be configured in ephone
configuration mode for specific phones.
Step 5 bulk-speed-dial prefix prefix-code Sets the prefix code that phone users dial to access speed-dial
numbers from a bulk speed-dial list.
Example: • prefix-code—One- or two-character access code for
Router(config-telephony)# bulk-speed-dial prefix speed dial. Valid characters are digits from 0 to 9,
#7 asterisk (*), and pound sign (#). Default is #.
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
SCCP: Verifying Bulk Speed-Dial Parameters
show telephony-service bulk-speed-dial
Use this command to display information on speed-dial lists.
Router# show telephony-service bulk-speed-dial summary
List-id Entries Size Reference url
0 40 3840 Global tftp://192.168.254.254/phonedirs/uut.csv
1 20 1920 Global phoneBook.csv
8 15 1440 Global tftp://192.168.254.254/phonedirs/big.txt
9 20 1920 Global tftp://192.168.254.254/phonedirs/phoneBook.csv
6 24879 2388384 ephone-2 tftp://192.168.254.254/phonedirs/big.txt1
7 20 1920 ephone-2 phoneBook.csv
6 24879 2388384 ephone-3 big.txt1
7 20 1920 ephone-3 phoneBook.csv
4 Global List(s) 4 Local List(s)
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1077
Configuring Speed Dial
How to Configure Speed Dial
SCCP: Enabling User Interface for Speed-Dial and Fast-Dial
To enable a phone user to configure speed-dial and fast-dial numbers from a menu on their phone,
perform the following steps. This feature is enabled by default. You must perform this task only if the
feature was previously disabled on a phone.
Prerequisites
• Cisco Unified CME 4.3 or a later release.
• The Service URL must be configured. See the “SCCP: Provisioning URLs for Feature Buttons”
section on page 1116.
Restrictions
Extension Mobility users cannot configure fast-dial settings (for personal speed-dial) from their phone.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. phone-ui speeddial-fastdial
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique number that identifies this
Example: ephone during configuration tasks.
Router(config)# ephone 12
Cisco Unified Communications Manager Express System Administrator Guide
1078 OL-10663-02
Configuring Speed Dial
How to Configure Speed Dial
Command or Action Purpose
Step 4 phone-ui speeddial-fastdial Enables a phone user to configure speed-dial and
fast-dial numbers on their phone.
Example: • This command is enabled by default.
Router(config-ephone)# phone-ui
speeddial-fastdial
Step 5 end Exits to privileged EXEC mode.
Example:
Router(config-ephone)# end
What to Do Next
For information on how phone users configure speed dial and fast dial buttons using the UI, see the
Cisco Unified IP Phone documentation for Cisco Unified CME.
SIP: Defining Speed-Dial Buttons
To define speed-dial buttons for Cisco SIP IP phones, perform the following steps.
Prerequisites
Cisco CME 3.4 or a later version.
Restrictions
• Certain SIP IP phones, such as the Cisco Unified IP Phone 7960 and 7940, cannot be configured to
enable speed dialing. Phone users with these phones must manually configure speed-dial numbers
by using the user interface at their Cisco Unified IP phone.
• On Cisco Unified IP phones, speed-dial definitions are assigned to available buttons that have not
been assigned to actual extensions. Speed-dial definitions are assigned in the order of their identifier
numbers.
• Phones with Cisco ATA devices are limited to a maximum of nine speed-dial numbers. Speed-dial
numbers cannot be programmed by using the user interface at the phone.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register pool pool-tag
4. speed-dial speed-tag digit-string [label label-text]
5. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1079
Configuring Speed Dial
How to Configure Speed Dial
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register pool pool-tag Enters voice register pool configuration mode to set
parameters for specified SIP phone.
Example:
Router(config)# voice register pool 23
Step 4 speed-dial speed-tag digit-string [label Creates a speed-dial definition in Cisco Unified CME for a
label-text] SIP phone or analog phone that uses an analog adapter
(ATA).
Example: • speed-tag—Unique sequence number that identifies the
router(config-register-pool)# speed-dial 2 speed-dial definition during configuration. Range is 1
+5001 label “Head Office”
to 5.
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-pool)# end
Examples
The following example shows how to set speed-dial button 2 to dial the head office at extension 5001
and locks the setting so that the phone user cannot change the setting at the phone:
Router(config)# voice register pool 23
Router(config-register-pool)# speed-dial 2 +5001 label “Head Office”
SIP: Configuring a Personal Speed-Dial Menu
To define up to 24 personal speed-dial numbers for a SIP phone, perform the following steps.
Prerequisites
• Cisco Unified CME 4.1 or a later version.
Restrictions
• For certain Cisco Unified IP phones, such as the 7941G, 7941GE, 7961G, 7961GE, 7970G, and
7971GE, personal speed-dial numbers can only be created in Cisco Unified CME by using this
procedure.
Cisco Unified Communications Manager Express System Administrator Guide
1080 OL-10663-02
Configuring Speed Dial
How to Configure Speed Dial
• For certain Cisco Unified IP phones, such as the 7905, 7912, 7940, and 7960, speed dial numbers
can only be created by the user directly on the phone and not in Cisco Unified CME. To determine
whether you must program a speed dial on directly your IP phone, see the Cisco Unified CME user
guide for your IP phone model.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register pool pool-tag
4. fastdial dial-tag number [name name-string]
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for a SIP phone.
Example: • pool-tag—Unique sequence number of the SIP phone
Router(config-register-pool)# voice register to be configured. Range is version and
pool 1 platform-dependent; type ? to display range. You can
modify the upper limit for this argument with the
max-pool command.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1081
Configuring Speed Dial
Configuration Examples for Speed Dial
Command or Action Purpose
Step 4 fastdial dial-tag number [name name-string] Creates a personal speed-dial number on this SIP phone.
• dial-tag—Unique number to identify this entry during
Example: configuration. Range: 1 to 24.
Router(config-register-pool)# fastdial 1 5552
name Sales
• number—Telephone number or extension to be dialed.
• name name-string—(Optional) Label to appear in the
Personal Speed Dial menu, containing a string of a
maximum of 24 alphanumeric characters. Personal
speed dial is handled through an XML request, so
characters that have special meaning to HTTP, such as
ampersand (&), percent sign (%), semicolon (;), angle
brackets (< >), and vertical bars (||), are not allowed.
• Repeat this command for each personal speed-dial
number that you want to create on this phone.
Step 5 end Exits to privileged EXEC mode.
Example:
Router(config-register-pool)# end
Configuration Examples for Speed Dial
This section contains the following examples:
• Enabling a Local Speed Dial Menu: Example, page 1082
• Personal Speed Dial Menu: Example, page 1083
• Speed-Dial Buttons and Abbreviated Dialing: Example, page 1083
• Bulk-Loading Speed Dial: Example, page 1083
• Speed-Dial and Fast-Dial User Interface: Example, page 1084
Enabling a Local Speed Dial Menu: Example
The following commands enable the Cisco web browser and set the HTTP path to flash memory so that
the speeddial.xml file in flash memory is accessible to IP phones:
ip http server
ip http path flash:
The following XML file—speeddial.xml, defines three speed-dial numbers that will appear to the user
after they press the Directories button on an IP phone.
<CiscoIPPhoneDirectory>
<Title>Local Speed Dial</Title>
<Prompt>Record 1 to 1 of 1 </Prompt>
<DirectoryEntry>
<Name>Security</Name>
<Telephone>71111</Telephone>
</DirectoryEntry>
Cisco Unified Communications Manager Express System Administrator Guide
1082 OL-10663-02
Configuring Speed Dial
Configuration Examples for Speed Dial
<DirectoryEntry>
<Name>Marketing</Name>
<Telephone>71234</Telephone>
</DirectoryEntry>
<DirectoryEntry>
<Name>Tech Support</Name>
<Telephone>71432</Telephone>
</DirectoryEntry>
</CiscoIPPhoneDirectory>
Personal Speed Dial Menu: Example
The following example creates a directory of three personal speed-dial listings for one IP phone:
ephone 1
fastdial 1 5489 name Marketing
fastdial 2 12125550155 name NY Sales
fastdial 3 12135550112 name LA Sales
Speed-Dial Buttons and Abbreviated Dialing: Example
The following example defines two locked speed-dial numbers with labels to appear next to the
speed-dial buttons on ephone 1. These speed-dial definitions are assigned to the next empty buttons after
all extensions are assigned. For instance, if two extensions are assigned on the
Cisco Unified IP Phones 7960 and 7960G, these speed-dial definitions appear on the third and fourth
buttons.
This example also defines two system-level speed-dial numbers with the directory entry command. One
is a local extension and the other is a ten-digit telephone number.
ephone 1
mac-address 1234.5678.ABCD
button 1:24 2:25
speed-dial 1 +5002 label Receptionist
speed-dial 2 +5001 label Security
telephony-service
directory entry 34 5003 name Accounting
directory entry 45 8185550143 name Corp Acctg
Bulk-Loading Speed Dial: Example
The following example changes the default bulk speed-dial prefix to #7 and enables global bulk
speed-dial list number 6 for all phones. It also enables a personal bulk speed-dial list for ephone 25.
telephony-service
bulk-speed-dial list 6 flash:sd_dept_01_1_87.txt
bulk-speed-dial prefix #7
ephone-dn 3
number 2555
ephone-dn 4
number 2557
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1083
Configuring Speed Dial
Where to Go Next
ephone 25
button 1:3 2:4
bulk-speed-dial list 7 flash:lmi_sd_list_08_24_95.txt
Speed-Dial and Fast-Dial User Interface: Example
The following example shows that the user interface for speed-dial and fast-dial configuration is disabled
on phone 12:
ephone 12
no phone-ui speeddial-fastdial
ephone-template 5
mac-address 000F.9054.31BD
type 7960
button 1:10 2:7
Where to Go Next
If you are finished creating or modifying speed-dial configurations for individual phones, you must
reboot phones to download the modified configuration. See “Resetting and Restarting Phones” on
page 271.
DSS Call Transfer
Monitor-line button speed dial, also known as direct station select (DSS) call transfer, allows you to use
a monitored line button to speed-dial a call to that extension. If you want to allow consultation during
DSS transfers, see “Configuring Call Transfer and Forwarding” on page 595.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Cisco Unified Communications Manager Express System Administrator Guide
1084 OL-10663-02
Configuring Speed Dial
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies. Access to most tools
on the Cisco Support website requires a Cisco.com user
ID and password. If you have a valid service contract
but do not have a user ID or password, you can register
on Cisco.com.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1085
Configuring Speed Dial
Feature Information for Speed Dial
Feature Information for Speed Dial
Table 49 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified Communications Manager Express and Cisco IOS Software Version Compatibility Matrix
at http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 49 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 49 Feature Information for Speed Dial
Cisco Unified CME
Feature Name Version Feature Information
Speed Dial 4.3 Added user interface on SCCP phones for programming
Speed Dial and Fast Dial.
4.1 Added support for local and personal speed-dial menus for
SIP phones in Cisco Unified CME.
4.0(2) Added support for DSS Service which allows phone user to
fast transfer a call by pressing a single speed-dial line or
monitor line button.
4.0 Added support for bulk speed-dial list for SCCP phones in
Cisco Unified CME.
3.4 Added support for speed dial buttons on SIP phones in
Cisco Unified CME.
3.0 • Added support for personal speed-dial from SCCP
phones in Cisco Unified CME.
• Number of speed-dial definitions that can be created
was increased from 4 to 33.
• The ability to program speed-dial numbers at the
phone was introduced.
• The ability to lock speed-dial numbers was introduced.
1.0 Speed dial using the speed-dial command was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
1086 OL-10663-02
Configuring Video Support for SCCP-Based
Endpoints
Last Updated: July 1, 2009
This chapter describes the video support for SCCP-based endpoints in Cisco Unified
Communications Manager Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the Feature Information for Video Support for
SCCP-Based Endpoints, page 1100.
Contents
• Prerequisites for Video Support for SCCP-Based Endpoints, page 1087
• Information About Video Support for SCCP-Based Endpoints, page 1089
• How to Configure Video for SCCP-Based Endpoints, page 1093
• Where to Go Next, page 1098
• Additional References, page 1098
• Feature Information for Video Support for SCCP-Based Endpoints, page 1100
Prerequisites for Video Support for SCCP-Based Endpoints
• H.323 or SIP network for voice calls is operational.
• Cisco Unified CME 4.0 or a later version.
• Cisco Unified IP phones are registered in Cisco Unified CME.
• Connection between the Cisco Unified Video Advantage 1.02 or a later version and the
Cisco Unified IP phone is up. From a PC with Cisco Unified Video Advantage version 1.02 or later
installed, ensure that the line between the Cisco Unified Video Advantage and the Cisco Unified IP
phone is green. For more information, see the Cisco Unified Video Advantage User Guide.
• Correct video firmware is installed on the Cisco Unified IP phone.
– For Cisco Unified IP Phone 7940G and 7960G, 6.0(4) or a later version
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1087
Configuring Video Support for SCCP-Based Endpoints
Restrictions for Video Support for SCCP-Based Endpoints
– Cisco Unified IP Phone 7970G, 7.0(3) or a later version
– Cisco Unified IP Phone 7941G and7961G, 7.0(3) or a later version
Note Other video-enabled endpoints registered with Cisco Unified Communications Manager can
place video calls to Cisco Unified IP phones only if the phones are registered with
Cisco Unified CME if the appropriate video firmware is installed on the Cisco Unified IP phone.
Restrictions for Video Support for SCCP-Based Endpoints
• This feature supports only the following video codecs:
– H.261—Cisco Unified CME 4.0 and later versions
– H.263—Cisco Unified CME 4.0 and later versions
– H.264—Cisco Unified CME 7.1 and later versions
• This feature supports only the following video formats:
– 4CIF—Resolution 704x576
– 16CIF—Resolution 1408x1152
– Common Intermediate Format (CIF)—Resolution 352x288
– One-Quarter Common Intermediate Format (QCIF)—Resolution 176x144
– Sub QIF (SQCIF)—Resolution 128x96
• The call start fast feature is not supported with an H.323 video connection. You must configure
call start slow for H.323 video. For configuration information, see the “SCCP: Enabling Support for
Video Streams Across H.323 Networks” section on page 1093.
• Video capabilities are configured per phone, not per line.
• All call feature controls (for example, mute and hold) apply to both audio and video calls, if
applicable.
• This feature does not support the following:
– Dynamic addition of video capability—The video capability must be present before the call
setup starts to allow the video connection.
– T-120 data connection between two SCCP endpoints
– Video security
– Far-end camera control (FECC) for SCCP endpoints
– Video codec renegotiation—The negotiated video codec must match or the call falls back to
audio-only. The negotiated codec for the existing call can be used for a new call.
– Video codec transcoding
– SIP endpoints— When a video-capable SCCP endpoint connects to a SIP endpoint, the call falls
back to audio-only.
– Video conferencing—The call falls back to audio-only.
– Features, such as conferencing, that mix the audio streams in Cisco Unified CME—In those
cases, the call falls back to audio-only.
Cisco Unified Communications Manager Express System Administrator Guide
1088 OL-10663-02
Configuring Video Support for SCCP-Based Endpoints
Information About Video Support for SCCP-Based Endpoints
– Video supplementary services between Cisco Unified CME and Cisco Unified
Communications Manager.
• If the Cisco Unified Communications Manager is configured for Media Termination Point (MTP)
transcoding, a video call between Cisco Unified CME and Cisco Unified Communications Manager
is not supported.
• Video telephony is not supported with Cisco Unified CME MTP and codec g729/dspfarm-assist
configuration under ephone.
• If an SCCP endpoint calls an SCCP endpoint on the local Cisco Unified CME and one of the
endpoints transferred across an H323 network, a video-consult transfer between the
Cisco Unified CME systems is not supported.
• When a video-capable endpoint connects to an audio-only endpoint, the call falls back to
audio-only. During audio-only calls, video messages are skipped.
• For Cisco Unified CME, the video capabilities in the vendor configuration firmware is a global
configuration. This means that, although video can be enabled per ephone, the video icon shows on
all Cisco Unified IP phones supported by Cisco Unified CME.
• Because of the extra CPU consumption on RTP-stream mixing, the number of video calls supported
on Cisco Unified CME crossing an H.323 network is less than the maximum number of ephones
supported.
• Cisco Unified CME cannot differentiate audio-only streams and audio-in-video streams. You must
configure the DSCP values of audio and video streams in the H.323 dial-peers.
• If RSVP is enabled on the Cisco Unified CME, a video call is not supported.
• A separate VoIP dial peer, configured for fast-connect procedures, is required to complete a video
call from a remote H.323 network to a Cisco Unity Express system.
Information About Video Support for SCCP-Based Endpoints
To configure video support for SCCP endpoints, you should understand the following concepts:
• Video Support Overview, page 1090
• SIP Trunk Video Support for SCCP Endpoints, page 1090
• Matching Endpoint Capabilities, page 1091
• Retrieving Video Codec Information, page 1091
• Call Fallback to Audio-Only, page 1091
• Call Setup for Video Endpoints, page 1091
• Flow of the RTP Video Stream, page 1092
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1089
Configuring Video Support for SCCP-Based Endpoints
Information About Video Support for SCCP-Based Endpoints
Video Support Overview
Video support allows you to pass a video stream, with a voice call, between two video-capable SCCP
endpoints and between SCCP and H.323 endpoints. Through the Cisco Unified CME router, the
video-capable endpoints can communicate with each other locally, to a remote H.323 endpoint through
a gateway, or through an H.323 network.
Video capabilities are disabled by default, and enabling video capabilities on Cisco Unified CME does
not automatically enable video on all ephones. You must first enable video globally for all video-capable
SCCP phones associated with a Cisco Unified CME router and then enable video for each phone
individually. Video parameters, like maximum bit rate, are set at a system-level.
For information about the global configuration for video capabilities, see the “SCCP: Enabling
System-Level Video Capabilities” section on page 1094. For information about configuring an
individual phone for video capabilities, see the “SCCP: Enabling Video Capabilities on a Phone” section
on page 1095.
Note After video is enabled globally, all video-capable ephones display the video icon.
SIP Trunk Video Support for SCCP Endpoints
Cisco Unified CME 7.1 adds the following support for video calls:
• Support for video calls between SCCP endpoints across different Cisco Unified CME routers
connected through a SIP trunk. All previously supported SCCP video endpoints and video codecs
are supported.
• H.264 video support. H.264 provides high quality images at low bit rates, and is widely used in
commercial video conferencing systems. The H.264 codec supports the following video calls:
– SCCP to SCCP
– SCCP to SIP
– SCCP to H.323
– Dynamic payload negotiation for H.264 (both SCCP to SIP and SCCP to H323)
• SCCP to SIP video supplementary services for all supported video codecs including H.264 codec.
The supported services include call forward, blind transfer, and consultative transfer. End to end
negotiation is supported between the endpoints.
Restrictions
• Asymmetric dynamic payload for SCCP to SIP video calls is not supported.
• The no supplementary-service sip moved-temporarily and no supplementary-service sip refer
commands are not supported for video calls through a SIP trunk.
No new configuration is required to support these enhancements. For configuration information, see
“How to Configure Video for SCCP-Based Endpoints” section on page 1093.
Cisco Unified Communications Manager Express System Administrator Guide
1090 OL-10663-02
Configuring Video Support for SCCP-Based Endpoints
Information About Video Support for SCCP-Based Endpoints
Matching Endpoint Capabilities
During phone registration, information about endpoint capabilities is stored in the Cisco Unified CME.
These capabilities are used to match with other endpoints during call setup. Endpoints can update at any
time; however, the router recognizes endpoint-capability changes only during call setup. If a video
feature is added to a phone, the information about it is updated in the router’s internal data structure, but
that information does not become effective until the next call. If a video feature is removed, the router
continues to see the video capability until the call is terminated but no video stream is exchanged
between the two endpoints.
Note The endpoint-capability match is executed each time a new call is set up or an existing call is resumed.
Retrieving Video Codec Information
Voice gateways use dial-peer configurations to retrieve codec information for audio codecs. Video
codec selection is done by the endpoints and is not controlled by the H.323 service-provider interface
(SPI) through dial-peer or other configuration. The video-codec information is retrieved from the SCCP
endpoint using a capabilities request during call setup.
Call Fallback to Audio-Only
When a video-capable endpoint connects to an audio-only endpoint, the call falls back to an audio-only
connection. Also, for certain features, such as conferencing, where video support is not available, the
call falls back to audio-only.
Cisco Unified CME routers use a call-type flag to indicate whether the call is video-capable or
audio-only. The call-type flag is set to video when the video capability is matched or set to audio-only
when connecting to an audio-only TDM or an audio-only SIP endpoint.
Note During an audio-only connection, all video-related media messages are skipped.
Call Setup for Video Endpoints
The process for handling SCCP video endpoints is the same as that for handling SCCP audio endpoints.
The video call must be part of the audio call. If the audio call setup fails, the video call fails.
During the call setup for video, media setup handling determines if a video-media-path is required. If
so, the corresponding video-media-path setup actions are taken.
• For an SCCP endpoint, video-media-path setup includes sending messages to the endpoints to open
a multimedia path and start the multimedia transmission.
• For an H.323 endpoint, video-media-path setup includes an exchange between the endpoints to open
a logical channel for the video stream.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1091
Configuring Video Support for SCCP-Based Endpoints
Information About Video Support for SCCP-Based Endpoints
A call-type flag is set during call setup on the basis of the endpoint-capability match. After call setup,
the call-type flag is used to determine whether an additional video media path is required. Call signaling
is managed by the Cisco Unified CME router, and the media stream is directly connected between the
two video-enabled SCCP endpoints on the same router. Video-related commands and flow-control
messages are forwarded to the other endpoint. Routers do not interpret these messages.
Call Setup Between Two Local SCCP Endpoints
For interoperation between two local SCCP endpoints on the same router, video call setup uses all
existing audio-call-setup handling, except during media setup. During media setup, a message is sent to
establish the video-media-path. If the endpoint responds, the video-media-path is established and a
start-multimedia-transmission function is called.
Call Setup Between SCCP and H.323 Endpoints
Call setup between SCCP and H.323 endpoints is the same as it is between SCCP endpoints except that
if video capability is selected, the event is posted to the H.323 call leg to send out a video open logical
channel (OLC) and the gateway generates an OLC for the video channel. Because the router needs to
both terminate and originate the media stream, video must be enabled on the router before call setup
begins.
Call Setup Between Two SCCP Endpoints Across an H.323 Network
If call setup between SCCP endpoints occurs across an H.323 network, the setup is a combination of the
processes listed in the previous two sections. The router controls the video media setup between the two
endpoints, and the event is posted to the H.323 call leg so that the gateway can generate an OLC.
Because the endpoint capability negotiation and match occur after the H.323 connect message, video
streams over H.323 network require slow-start on call setup procedures for Cisco Unified CME. An
H.323 network can connect to a remote Cisco Unified CME router, Cisco Unified
Communications Manager, remote IP to IP gateway, or a video-capable H.323 endpoint. For
configuration information, see the “SCCP: Enabling System-Level Video Capabilities” section on
page 1094.
Flow of the RTP Video Stream
For video streams between two local SCCP endpoints, the Real-Time Transport Protocol (RTP) stream
is in flow-around mode. For video streams between SCCP and H.323 endpoints or two SCCP endpoints
on different Cisco Unified CME routers, the RTP stream is in flow-through mode.
• Media flow-around mode enables RTP packets to stream directly between the endpoints of a VoIP
call without the involvement of the gateway. By default, the gateway receives the incoming media,
terminates the call, and then reoriginates it on the outbound call leg. In flow-around mode, only
signaling data is passed to the gateway, improving scalability and performance.
• With flow-through mode, the video media path is the same as for an audio call. Media packets flow
through the gateway, thus hiding the networks from each other.
Cisco Unified Communications Manager Express System Administrator Guide
1092 OL-10663-02
Configuring Video Support for SCCP-Based Endpoints
How to Configure Video for SCCP-Based Endpoints
Use the show voip rtp connection command to display information about RTP named-event packets,
such as caller-ID number, IP address, and port for both the local and remote endpoints, as show in the
following sample output.
Router# show voip rtp connections
VoIP RTP active connections :
No. CallId dstCallId LocalRTP RmtRTP LocalIP RemoteIP
1 102 103 18714 18158 10.1.1.1 192.168.1.1
2 105 104 17252 19088 10.1.1.1 192.168.1.1
Found 2 active RTP connections
============================
How to Configure Video for SCCP-Based Endpoints
This section contains the following tasks:
• SCCP: Enabling Support for Video Streams Across H.323 Networks, page 1093 (required)
• SCCP: Enabling System-Level Video Capabilities, page 1094 (required)
• SCCP: Enabling Video Capabilities on a Phone, page 1095 (required)
• Verifying Video Support for SCCP-Based Endpoints, page 1097 (optional)
• Troubleshooting Video Support for SCCP-Based Endpoints, page 1097 (optional)
SCCP: Enabling Support for Video Streams Across H.323 Networks
To enable slow connect procedures in Cisco Unified CME for H.323 networks and H.323 video
endpoints, perform the following steps.
Prerequisites
• For video supplementary services across an H.323 network, H.450 (H.450.2, H.450.3, or H.450.1)
standard protocol is required.
Restrictions
• The only H.323 video endpoints are supported by Cisco Unified CME are: Tandberg version E3.0
and E4.1, and Polycom Release version 7.5.2.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice service voip
4. h323
5. call start slow
6. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1093
Configuring Video Support for SCCP-Based Endpoints
How to Configure Video for SCCP-Based Endpoints
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice service voip Enters voice-service configuration mode.
Example:
Router(config)# voice service voip
Step 4 h323 Enters H.323 voice-service configuration mode.
Example:
Router(config-voi-serv)# h323
Step 5 call start slow Forces an H.323 gateway to use slow-connect procedures
for all VoIP calls.
Example:
Router(config-serv-h323)# call start slow
Step 6 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-serv-h323)# end
SCCP: Enabling System-Level Video Capabilities
To enable video capabilities and set video parameters for all video-capable phones associated with a
Cisco Unified CME router, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. service phone videoCapability {0 | 1}
5. video
6. maximum bit-rate value
7. end
Cisco Unified Communications Manager Express System Administrator Guide
1094 OL-10663-02
Configuring Video Support for SCCP-Based Endpoints
How to Configure Video for SCCP-Based Endpoints
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 service phone videoCapability {0 | 1} Enables or disables video capability parameter for all
applicable IP phones associated with Cisco Unified CME
router.
Example:
Router(config-telephony)# service phone • The parameter name is word and case-sensitive.
videoCapability 1
• 0—Disable (default).
• 1—Enable.
Step 5 video (Optional) Enters video configuration mode.
• Required only if you want to modify the maximum
Example: value of the video bandwidth for all video-capable
Router(config-telephony)# video phones.
Step 6 maximum bit-rate value (Optional) Sets the maximum IP phone video bandwidth, in
kb/s.
Example: • value—Range: 0 to 10000000. Default: 10000000.
Router(conf-tele-video)# maximum bit-rate 256
Step 7 end Exits to privileged EXEC mode.
Example:
Router(conf-tele-video)# end
SCCP: Enabling Video Capabilities on a Phone
To enable video for video-capable phones associated with a Cisco Unified CME router, perform the
following steps for each phone.
Prerequisites
• Video capabilities are enabled at a system level. See the “SCCP: Enabling System-Level Video
Capabilities” section on page 1094.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1095
Configuring Video Support for SCCP-Based Endpoints
How to Configure Video for SCCP-Based Endpoints
• Use the show ephone registered command to identify individual video-capable SCCP phones, by
ephone-tag, that are registered in Cisco Unified CME. The following example shows that ephone 1
has video capabilities and ephone 2 is an audio-only phone.
Router# show ephone registered
ephone-1 Mac:0011.5C40.75E8 TCP socket:[1] activeLine:0 REGISTERED in SCCP ver 6 +
Video and Server in ver 5
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0 caps:7
IP:10.1.1.6 51833 7970 keepalive 35 max_line 8
button 1: dn 1 number 8003 CH1 IDLE CH2 IDLE
ephone-2 Mac:0006.D74B.113D TCP socket:[2] activeLine:0 REGISTERED in SCCP ver 6 and
Server in ver 5
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0 caps:7
IP:10.1.1.4 51123 Telecaster 7960 keepalive 36 max_line 6
button 1: dn 2 number 8004 CH1 IDLE CH2 IDLE
button 2: dn 4 number 8008 CH1 IDLE CH2 IDLE
===========================================
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. video
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies an
Example: ephone during configuration tasks.
Router(config)# ephone 6
Step 4 video Enables video capabilities on the specified ephone.
Example:
Router(config-ephone)# video
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-ephone)# end
Cisco Unified Communications Manager Express System Administrator Guide
1096 OL-10663-02
Configuring Video Support for SCCP-Based Endpoints
How to Configure Video for SCCP-Based Endpoints
Verifying Video Support for SCCP-Based Endpoints
Use the show running-config command to verify the video settings in the configuration.
See the telephony-service portion of the output for commands that configure video support on the
Cisco Unified CME.
See the ephone portion of the output for commands that configure video support for a specific ephone.
The following example shows the telephony-service portion of the output:
telephony-service
video
maximum bit-rate 256
load 7960-7940 P00306000404
max-ephones 24
max-dn 24
ip source-address 10.0.180.130 port 2000
service phone videoCapability 1
timeouts interdigit 4
timeouts ringing 100
create cnf-files version-stamp Jan 01 2002 00:00:00
keepalive 60
max-conferences 4 gain -6
call-park system redirect
call-forward pattern .T
web admin system name cisco password cisco
web customize load xml.jeff
dn-webedit
time-webedit
transfer-system full-consult
transfer-pattern .T
The following example shows the ephone portion of the output:
ephone 6
video
mac-address 000F.F7DE.CAA5
type 7960
button 1:6
Troubleshooting Video Support for SCCP-Based Endpoints
Step 1 For SCCP endpoint troubleshooting, use the following debug commands:
• debug cch323 video—Enables video debugging trace on the H.323 service-provider interface (SPI).
• debug ephone detail—Debugs all Cisco Unified IP phones that are registered to the router, and
displays error and state levels.
• debug h225 asn1—Displays Abstract Syntax Notation One (ASN.1) contents of H.225 messages
that have been sent or received.
• debug h245 asn1—Displays ASN.1 contents of H.245 messages that have been sent or received.
• debug voip ccapi inout—Displays the execution path through the call-control application
programming interface (CCAPI).
Step 2 For ephone troubleshooting, use the following debug commands:
• debug ephone message—Enables message tracing between Cisco Unified IP phones.
• debug ephone register—Sets registration debugging for Cisco Unified IP phones.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1097
Configuring Video Support for SCCP-Based Endpoints
Where to Go Next
• debug ephone video—Sets ephone video traces, which provide information about different video
states for the call, including video capabilities selection, start, and stop.
Step 3 For basic video-to-video call checking, use the following show commands:
• show call active video—Displays call information for SCCP video calls in progress.
• show ephone offhook—Displays information and packet counts for ephones that are off hook.
• show ephone registered—Displays the status of registered ephones.
• show voip rtp connections—Displays information about RTP named-event packets, such as caller
ID number, IP address, and port for both the local and remote endpoints.
Where to Go Next
After enabling video for video-capable phones in Cisco Unified CME, you must generate a new
configuration file. See “Generating Configuration Files for Phones” on page 261.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Cisco Unified Communications Manager Express System Administrator Guide
1098 OL-10663-02
Configuring Video Support for SCCP-Based Endpoints
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1099
Configuring Video Support for SCCP-Based Endpoints
Feature Information for Video Support for SCCP-Based Endpoints
Feature Information for Video Support for SCCP-Based
Endpoints
Table 50 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note The following table lists the Cisco Unified CME version that introduced support for a given feature.
Unless noted otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 50 Feature Information for Video Support for SCCP-Based Endpoints
Cisco Unified CME
Feature Name Version Feature Information
SIP Trunk Video Support for SCCP 7.1 • Support was added for video calls between SCCP
Endpoints endpoints across different Cisco Unified CME routers
connected through a SIP trunk.
• H.264 codec support was added.
Video Support for SCCP-Based Endpoints 4.0 Video support for SCCP-based endpoints was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
1100 OL-10663-02
Modifying Cisco Unified IP Phone Options
Last Updated: August 9, 2010
This chapter describes the screen and button features available for Cisco Unified IP phones connected
to Cisco Unified Communications Manager Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Cisco Unified IP
Phone Options” section on page 1128.
Contents
• Information About Cisco Unified IP Phone Options, page 1101
• How to Configure Cisco Unified IP Phone Options, page 1105
• Configuration Examples for Cisco Unified IP Phone Options, page 1124
• Additional References, page 1127
• Feature Information for Cisco Unified IP Phone Options, page 1128
Information About Cisco Unified IP Phone Options
To enable IP phone options, you should understand the following concepts:
• Customized Background Images for Cisco Unified IP Phone 7970, page 1102
• Fixed Line/Feature Buttons for Cisco Unified IP Phone 7931G, page 1102
• Header Bar Display, page 1102
• Phone Labels, page 1103
• Programmable Vendor Parameters for Phones, page 1103
• System Message Display, page 1104
• URL Provisioning for Feature Buttons, page 1104
• Push-to-Talk, page 1103
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1101
Modifying Cisco Unified IP Phone Options
Information About Cisco Unified IP Phone Options
Customized Background Images for Cisco Unified IP Phone 7970
The Cisco Unified IP Phone 7970 and 7971 support customized background images on the phone screen.
To enable your Cisco Unified IP Phone 7970 or 7971 to display a customized background image, follow
the procedure in the technical note at
http://www.cisco.com/en/US/products/sw/voicesw/ps4625/products_tech_note09186a008062495a.sht
ml
Sample background images are available in the 7970-backgrounds.tar file at
http://www.cisco.com/cgi-bin/tablebuild.pl/ip-iostsp
Fixed Line/Feature Buttons for Cisco Unified IP Phone 7931G
In Cisco Unified CME 4.0(2) and later versions, you can select from two fixed button-layout formats to
assign functionality to certain line buttons on a Cisco Unified IP Phone 7931G to support key system
phone behavior. If you do not select a button set, no fixed set of feature/line buttons are defined.
The line button layout for the Cisco Unified IP Phone 7931G is a bottom-up array. Button 1 is at the
bottom right of the array and button 24 is at the top left of the array.
Button set 1 includes two predefined feature buttons: button 24 is Menu and button 23 is Headset.
Button set 2 includes four predefined feature buttons: button 24 is Menu; button 23 is Headset; button
22 is Directories; and button 21 is Messages.
For configuration, see the “SCCP: Selecting Button Layout for a Cisco Unified IP Phone 7931G” section
on page 1106.
Header Bar Display
You can customize the content of an IP phone header bar, which is the top line of the IP phone display.
The IP phone header bar, or top line, of a Cisco Unified IP Phone normally replicates the text that
appears next to the first line button. The header bar is shown in Figure 40. The header bar can, however,
contain a user-definable message instead of the extension number. For example, the header bar can be
used to display a name or the full E.164 number of the phone. If no description is specified, the header
bar replicates the extension number that appears next to the first button on the phone.
Figure 40 Cisco Unified IP Phone Display
13:09 06/08/01 3270 Header bar
Title line
Content lines
Service window
Prompt and status area
82878
Softkey 1 Softkey 2 Softkey 3 Softkey 4
Cisco Unified Communications Manager Express System Administrator Guide
1102 OL-10663-02
Modifying Cisco Unified IP Phone Options
Information About Cisco Unified IP Phone Options
Phone Labels
Pone labels are configurable text strings that can be displayed instead of extension numbers next to line
buttons on a Cisco Unified IP phone. By default, the number that is associated to a directory number,
and assigned to a phone, is displayed next to the applicable button. The label feature allows you to enter
a meaningful text string for each directory number so that a phone user with multiple lines can select a
line by label instead of by phone number, thus eliminating the need to consult in-house phone
directories. For configuration information, see the “SCCP: Creating Labels for Directory Numbers”
section on page 1111 or the “SIP: Creating Labels for Directory Numbers” section on page 1112.
Programmable Vendor Parameters for Phones
The vendorConfig section of the configuration file contains phone and display parameters that are read
and implemented by a phone's firmware when that phone is booted. Only the parameters supported by
the currently loaded firmware are available. The number and type of parameters may vary from one
firmware version to the next.
The IP phone that downloads the configuration file will implement only those parameters that it can
support and ignore configured parameters that it cannot implement. For example, a Cisco Unified
IP Phone 7970G does not have a backlit display and cannot implement Backlight parameters regardless
of whether they are configured. The following text shows the format of an entry in the configuration file:
<vendorConfig>
<parameter-name>parameter-value</parameter-name>
</vendorConfig>
For configuration information at the system level, see the “SCCP: Modifying Vendor Parameters for All
Phones” section on page 1119. For configuration information for individual phones, see the “SCCP:
Modifying Vendor Parameters For a Specific Phone” section on page 1120.
Push-to-Talk
This feature allows one-way Push-to-Talk (PTT) in Cisco Unified CME 7.0 and later versions without
requiring an external server to support the functionality. PTT is supported in firmware version 1.0.4 and
later versions on Cisco Unified Wireless IP Phone 7921 and 7925 with a thumb button.
In the following figure, button1/DN 1 is configured as the primary line for this phone. Button 6/ DN 10
is configured for PTT and is the line that is triggered by pushing the thumb button on this phone.
• Holding down on the thumb button causes the configured DN on the phone to go off-hook.
• The thumb button utilizes an intercom DN that targets a paging number (1050).
• The targeted paging group (DN 50) can be unicast or multicast or both.
• Users will hear a “zipzip” tone when call path is set up.
• All other keys on the phone are locked during this operation
• Releasing the thumb button ends the call.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1103
Modifying Cisco Unified IP Phone Options
Information About Cisco Unified IP Phone Options
Figure 41 PTT Call Flow
1) Thumb
button
ephone 1
type 7921
button 1:1 6:10
4) All phones configured with
5) ephone 1 hears “zipzip” ‘paging-dn 50’ receive one-way
tone and begins talking voice path from ephone 1
2) Held to offhook on 3) Intercom line
button 6 (dn 10) automatically
dials1050, a ephone-dn 50
ephone-dn 10 paging number number 1050
intercom 1050 paging
For configuration information, see the “SCCP: Configuring One-Way Push-to-Talk on Cisco Unified
Wireless IP Phones” section on page 1122
System Message Display
The System Message Display feature allows you to specify a custom text or display message to appear
in the lower part of the display window on display-capable IP phones. If you do not set a custom text or
display message, the default message “Cisco Unified CME” is displayed.
When you specify a text message, the number of characters that can be displayed is not fixed because IP
phones typically use a proportional (as opposed to fixed-width) font. There is room for approximately 30
alphanumeric characters.
The display message is refreshed with a new message after one of the following events occurs:
• Busy phone goes back on-hook.
• Idle phone receives a keepalive message.
• Phone is restarted.
The file-display feature allows you to specify a file to display on display-capable IP phones when they
are not in use. You can use this feature to provide the phone display with a system message that is
refreshed at configurable intervals, similar to the way that the text message feature provides a message.
The difference between the two is that the system text message feature displays a single line of text at
the bottom of the phone display, whereas the system display message feature can use the entire display
area and contain graphic images.
URL Provisioning for Feature Buttons
URL provisioning for programmable feature buttons allows you to specify alternative XML files to
access using the feature buttons on IP phones.
Cisco Unified Communications Manager Express System Administrator Guide
1104 OL-10663-02
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
Certain phones, such as the Cisco Unified IP Phone 7940, 7940G, 7960, and 7960G, have programmable
feature buttons that invoke noncall-related services. The four buttons—Services, Directories, Messages,
and Information (the i button)—are linked to appropriate feature operations through URLs. The fifth
button—Settings—is managed entirely by the phone.
The feature buttons are provisioned with specific URLs. The URLs link to XML web pages formatted
with XML tags that the Cisco Unified IP phone understands and uses. When you press a feature button,
the Cisco Unified IP phone uses the configured URL to access the appropriate XML web page for
instructions. The web page sends instructions to the Cisco Unified IP phone to display information on
the screen for users to navigate. Phone users can select options and enter information by using soft keys
and the scroll button.
Operation of these feature buttons is determined by the capabilities of the Cisco Unified IP phone and
the content of the specified URL.
In Cisco Unified CME 4.2 and later versions, up to eight URLs can be configured for the Services feature
button by using an ephone template to apply the configuration to one or more supported SCCP phones.
If you use an ephone template to configure services URLs for one or SCCP phones and you also
configure a system-level services URL in telephony-service configuration mode, the value set in
telephony-service configuration mode appears first in the list of services displayed when the phone user
presses the Services feature button. Cisco Unified CME self-hosted services, such as Extension
Mobility, always appears last in the list of options displayed for the Services feature button.
For configuration information, see the “URLs for Feature Buttons” section on page 1106.
How to Configure Cisco Unified IP Phone Options
This section contains the following tasks:
Button Layout for Cisco Unified IP Phone 7931G
• SCCP: Selecting Button Layout for a Cisco Unified IP Phone 7931G, page 1106 (required)
Header Bar Display
• SCCP: Modifying Header Bar Display, page 1107 (required)
• SIP: Modifying Header Bar Display, page 1109 (required)
• Verifying Header Bar Display, page 1110 (optional)
• Troubleshooting Header Bar Display, page 1110 (optional)
Labels for Directory Numbers
• SCCP: Creating Labels for Directory Numbers, page 1111 (required)
• SIP: Creating Labels for Directory Numbers, page 1112 (required)
• Verifying Labels, page 1113 (optional)
System Message Display
• SCCP: Modifying System Message Display, page 1114 (required)
• Verifying System Message Display, page 1115 (optional)
• Troubleshooting System Message Display, page 1115 (optional)
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1105
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
URLs for Feature Buttons
• SCCP: Provisioning URLs for Feature Buttons, page 1116 (required)
• SIP: Provisioning URLs for Feature Buttons, page 1117 (required)
• Troubleshooting URL Provisioning for Feature Buttons, page 1119 (optional)
Programmable VendorConfig Parameters
• SCCP: Modifying Vendor Parameters for All Phones, page 1119 (optional)
• SCCP: Modifying Vendor Parameters For a Specific Phone, page 1120 (optional)
• Troubleshooting Vendor Parameter Configuration, page 1122 (optional)
Push To Talk
• SCCP: Configuring One-Way Push-to-Talk on Cisco Unified Wireless IP Phones, page 1122
SCCP: Selecting Button Layout for a Cisco Unified IP Phone 7931G
To select a fixed-button layout for a Cisco Unified IP Phone 7931G, perform the following steps.
Prerequisites
Cisco Unified CME 4.0(2) or a later version.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone template template-tag
4. button-layout set phone-type [1 | 2]
5. exit
6. ephone phone-tag
7. ephone-template template-tag
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
1106 OL-10663-02
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
Command or Action Purpose
Step 3 ephone-template template-tag Enters ephone-template configuration mode to create an
ephone template.
Example:
Router(config)# ephone-template 15
Step 4 button-layout phone-type {1 | 2} Specifies which fixed set of feature buttons appears on a
Cisco Unified IP Phone 7931G that uses a template in
which this is configured.
Example:
Router(config-ephone-template)# button-layout • 1—Includes two predefined feature buttons: button
7931 2 24 is Menu and button 23 is Headset.
• 2—Includes four predefined feature buttons: button
24 is Menu; button 23 is Headset; button 22 is
Directories; and button 21 is Messages.
Step 5 exit Exits from this command mode to the next highest mode
in the configuration mode hierarchy.
Example:
Router(config-ephone-template)# exit
Step 6 ephone phone-tag Enters ephone configuration mode.
Example:
Router(config)# ephone 1
Step 7 ephone-template template-tag Applies an ephone template to the ephone that is being
configured.
Example:
Router(config-ephone)# ephone-template 15
Step 8 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-ephone)# end
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See “Generating Configuration Files for Phones” on page 261.
SCCP: Modifying Header Bar Display
To modify the phone header bar display, perform the following steps.
Prerequisites
Directory number to be modified is already configured. For configuration information, see “SCCP:
Creating Directory Numbers” on page 158.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1107
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
4. description display-text
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode.
Example:
Router(config)# ephone-dn 55
Step 4 description display-text Defines a description for the header bar of a display-capable IP
phone on which this ephone-dn appears as the first line.
Example: • display-text—Alphanumeric character string, up to
Router(config-ephone-dn)# description 40 characters. String is truncated to 14 characters in the
408-555-0134 display.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See “Generating Configuration Files for Phones” on page 261.
Cisco Unified Communications Manager Express System Administrator Guide
1108 OL-10663-02
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
SIP: Modifying Header Bar Display
To modify the phone header bar display on supported SIP phones, perform the following steps.
Prerequisites
• Cisco CME 3.4 or a a later version.
Restrictions
• This feature is supported only on Cisco Unified IP Phone 7940, 7940G, 7960, and 7960G.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register pool pool-tag
4. description string
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for a SIP phone in
Cisco Unified CME.
Example:
Router(config)# voice register pool 3
Step 4 description string Defines a customized description that appears in the header
bar of supported Cisco Unified IP phones
Example: • Truncated to 14 characters in the display.
Router(config-register-pool)# description
408-555-0100
• If string contains spaces, enclose the string in quotation
marks.
Step 5 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-pool)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1109
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See the “SIP: Generating Configuration Profiles for SIP Phones” on
page 265.
Verifying Header Bar Display
Step 1 Use the show running-config command to verify your configuration. Descriptions for directory
numbers are listed in the ephone-dn and voice-register dn portions of the output.
Router# show running-config
ephone-dn 1 dual-line
number 150 secondary 151
description 555-0150
call-forward busy 160
call-forward noan 160 timeout 10
huntstop channel
no huntstop
!
!
!
voice-register dn 1
number 1101
description 555-0101
Troubleshooting Header Bar Display
Step 1 show telephony-service ephone
Use this command to ensure that the ephone-dn to which you applied the description appears on the first
button on the ephone. In the example below, ephone-dn 22 has the description in the phone display
header bar.
Router# show telephony-service ephone
ephone-dn 22
number 2149
description 408-555-0149
ephone 34
mac-address 0030.94C3.F96A
button 1:22 2:23 3:24
speed-dial 1 5004
speed-dial 2 5001
Cisco Unified Communications Manager Express System Administrator Guide
1110 OL-10663-02
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
SCCP: Creating Labels for Directory Numbers
To create a label to display in place of the number next to a line button, perform the following steps.
Prerequisites
Directory number for which the label is to be created is already configured. For configuration
information, see “SCCP: Creating Directory Numbers” on page 158.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
4. label label-string
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode.
• dn-tag—Unique sequence number that identifies the
Example: ephone-dn to which the label is to be associated.
Router(config)# ephone-dn 1
Step 4 label label-string Creates a custom label that is displayed on the phone next
to the line button that is associated with this ephone-dn. The
custom label replaces the default label, which is the number
Example:
Router(config-ephone-dn)# label user1
that was assigned to this ephone-dn.
• label-string—String of up to 30 alphanumeric
characters that provides the label text.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1111
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See the “Generating Configuration Files for Phones” on page 261.
SIP: Creating Labels for Directory Numbers
To create label to be displayed in place of a directory number for a SIP phone, intercom line, voice port,
or a message-waiting indicator (MWI), perform the following steps for each label to be created.
Prerequisites
• Cisco CME 3.4 or a later version.
• Directory number for which the label is to be created is already configured and must already have a
number assigned by using the number (voice register dn) command. For configuration
information, see “SIP: Creating Directory Numbers” on page 169.
Restrictions
• Only one label is permitted per directory number.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register dn dn-tag
4. label string
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register dn dn-tag Enters voice register dn configuration mode to define a
directory number for a SIP phone, intercom line, voice port,
or a message-waiting indicator (MWI).
Example:
Router(config-register-global)# voice register
dn 17
Cisco Unified Communications Manager Express System Administrator Guide
1112 OL-10663-02
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
Command or Action Purpose
Step 4 number number Defines a valid number for a directory number.
Example:
Router(config-register-dn)# number 7001
Step 5 label string Creates a text identifier, instead of a phone-number display,
for a directory number that appears on a SIP phone console.
Example:
Router(config-register-dn)# label user01
Step 6 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-dn)# end
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See the “SIP: Generating Configuration Profiles for SIP Phones” on
page 265.
Verifying Labels
Step 1 Use the show running-config command to verify your configuration. Descriptions for directory
numbers are listed in the ephone-dn and voice-register dn portions of the output.
Router# show running-config
ephone-dn 1 dual-line
number 150 secondary 151
label MyLine
call-forward busy 160
call-forward noan 160 timeout 10
huntstop channel
no huntstop
!
!
!
voice-register dn 1
number 1101
label MyLine
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1113
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
SCCP: Modifying System Message Display
To modify the system message display on phone screen, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. system message text-message
5. url idle url idle-timeout seconds
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)#
Step 4 system message text-message Defines a text message to display when a phone is idle.
• text-message—Alphanumeric string to display. Display uses
Example: proportional-width font, so the number of characters that are
Router(config-telephony)# system message displayed varies based on the width of the characters that are
ABC Company used. The maximum number of displayed characters is
approximately 30.
Step 5 url idle url idle-timeout seconds Defines the location of a file to display on phones that are not in
use and specifies the interval between refreshes of the display, in
seconds.
Example:
Router(config-telephony)# url idle • url—Any URL that conforms to RFC 2396.
http://www.abcwrecking.com/public/logo
idle-timeout 35 • seconds—Time interval between display refreshes, in
seconds. Range is 0 to 300.
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Cisco Unified Communications Manager Express System Administrator Guide
1114 OL-10663-02
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
What to Do Next
After configuring the url idle command, you must reset phones. See “SCCP: Using the reset Command”
on page 273.
Verifying System Message Display
Step 1 Use the show running-config command to verify your configuration. System message display is listed
in the telephony-service portion of the output.
Router# show running-config
telephony-service
fxo hook-flash
load 7960-7940 P00307020300
load 7914 S00104000100
max-ephones 100
max-dn 500
ip source-address 10.153.13.121 port 2000
max-redirect 20
timeouts ringing 100
system message XYZ Company
voicemail 7189
max-conferences 8 gain -6
call-forward pattern .T
moh flash:music-on-hold.au
multicast moh 239.10.10.1 port 2000
web admin system name server1 password server1
dn-webedit
time-webedit
transfer-system full-consult
transfer-pattern 92......
transfer-pattern 91..........
transfer-pattern 93......
transfer-pattern 94......
transfer-pattern 95......
transfer-pattern 96......
transfer-pattern 97......
transfer-pattern 98......
transfer-pattern 99......
transfer-pattern .T
secondary-dialtone 9
create cnf-files version-stamp Jan 01 2002 00:00:00
Troubleshooting System Message Display
Step 1 Ensure that the HTTP server is enabled.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1115
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
SCCP: Provisioning URLs for Feature Buttons
To customize URLs for feature buttons in the Sep*.conf.xml configuration file for SCCP IP phones,
perform the following steps.
Restrictions
• Operation of these services is determined by the Cisco Unified IP phone capabilities and the content
of the specified URL.
• Provisioning a URL to access help screens using the i or ? buttons on a phone is not supported.
• Provisioning the directory URL to select an external directory resource disables the
Cisco Unified CME local directory service.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. url {directories | information | messages | services} url
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)#
Cisco Unified Communications Manager Express System Administrator Guide
1116 OL-10663-02
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
Command or Action Purpose
Step 4 url {directories | information | messages Provisions URLs for the four programmable feature buttons
| services} url (Directories, Information, Messages, and Services) on a
supported Cisco Unified IP phone.
Example: • To use a Cisco Unified Communications Manager directory
Router(config-telephony)# url directories as an external directory source, you must list the MAC
http://10.4.212.4/localdirectory
addresses of the phones in Cisco Unified Communications
Manager and reset the phones from Cisco Unified
Communications Manager. You do not need to assign
ephone-dns to the phones for the phones to register with
Cisco Unified Communications Manager.
• The url services command is also available in
ephone-template configuration mode. If you use an ephone
template to provision the Services feature button on one or
more SCCP phones and you configure the url services
command in telephony-service configuration mode, the value
set in telephony-service configuration mode appears first in
the list of options displayed when the phone user presses the
Services feature button.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
What to Do Next
If you want to create an ephone template to provision multiple URLs for the Services feature button on
supported individual SCCP phones, see “Creating Templates” on page 1129.
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See “Generating Configuration Files for Phones” on page 261.
SIP: Provisioning URLs for Feature Buttons
To customize URLs for feature buttons in the SEPDEFAULT.cnf configuration profile for SIP IP phones,
perform the following steps.
Prerequisites
• Cisco CME 3.4 or a later version.
Restrictions
• Operation of these services is determined by the Cisco Unified IP phone capabilities and the content
of the specified URL.
• Provisioning a URL is supported only for Services and Directories feature buttons on SIP phones.
• Programmable Directories and Services feature buttons are supported only on the Cisco Unified IP
Phone 7960, 7960G, 7940, and 7940G.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1117
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
• Provisioning the directory URL to select an external directory resource disables the
Cisco Unified CME local directory service.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. url {directory | service} url
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters telephony-service configuration mode.
Example:
Router(config)#
Step 4 url {directory | service} url Associates a URL with the programmable feature buttons on SIP
phones.
Example:
Router(config-register-global)# url
directory http://10.0.0.11/localdirectory
Router(config-register-global)# url
service
http://10.0.0.4/CCMUser/123456/urltest.ht
ml
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-register-global)# end
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See the “SIP: Generating Configuration Profiles for SIP Phones” on
page 265.
Cisco Unified Communications Manager Express System Administrator Guide
1118 OL-10663-02
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
Troubleshooting URL Provisioning for Feature Buttons
Step 1 Ensure the HTTP server is enabled and that there is communication between the Cisco Unified CME
router and the server.
SCCP: Modifying Vendor Parameters for All Phones
To configure programmable phone and display parameters in the vendorConfig section of the
SepDefault.conf.xml configuration file for all phones, perform the following steps.
Restrictions
• Only the parameters supported by the currently loaded firmware are available.
• The number and type of parameters may vary from one firmware version to the next.
• Only those parameters that are supported by a Cisco Unified IP phone and firmware version are
implemented. Parameters that are not supported are ignored.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. service phone parameter-name parameter-value
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1119
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
Command or Action Purpose
Step 4 service phone parameter-name parameter-value Sets display and phone functionality for all IP phones that
support the configured parameters and to which this
template is applied.
Example:
Router(config-telephony)# service phone • The parameter name is word and case-sensitive. See the
daysDisplayNotActive 1,2,3,4,5,6,7 Cisco Unified CME Command Reference for a list of
Router(config-telephony)# service phone
parameters.
displayOnTime 07:30
Router(config-telephony)# service phone • This command can also be configured in ephone-
displayOnDuration 10:00 template configuration mode and applied to one or
Router(config-telephony)# service phone
displayIdleTimeout 00.01
more phones.
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See the “Generating Configuration Files for Phones” on page 261.
SCCP: Modifying Vendor Parameters For a Specific Phone
To configure parameters in the vendorConfig section of the Sep*.conf.xml configuration file for an
individual SCCP phone, perform the following steps.
Restrictions
• Cisco Unified CME 4.0 or a later version.
• System must be configured to for per-phone configuration files. For configuration information, see
“SCCP: Defining Per-Phone Configuration Files and Alternate Location” on page 119.
• Only the parameters supported by the currently loaded firmware are available.
• The number and type of parameters may vary from one firmware version to the next.
• Only those parameters that are supported by a Cisco Unified IP phone and firmware version are
implemented. Parameters that are not supported are ignored.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone template template-tag
4. service phone parameter-name parameter-value
5. exit
6. ephone phone-tag
Cisco Unified Communications Manager Express System Administrator Guide
1120 OL-10663-02
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
7. ephone-template template-tag
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-template template-tag Enters ephone-template configuration mode to create an
ephone template.
Example:
Router (config)# ephone-template 15
Step 4 service phone parameter-name parameter-value Sets parameters for all IP phones that support the
configured functionality and to which this template is
applied.
Example:
Router(config-telephony)# service phone • The parameter name is word and case-sensitive. See
daysDisplayNotActive 1,2,3,4,5,6,7 the Cisco Unified CME Command Reference for a
Router(config-telephony)# service phone
list of parameters.
displayOnTime 07:30
Router(config-telephony)# service phone • This command can also be configured in
displayOnDuration 10:00 telephony-service configuration mode. For
Router(config-telephony)# service phone
displayIdleTimeout 00.01
individual phones, the template configuration for
this command overrides the system-level
configuration for this command.
Step 5 exit Exits from this command mode to the next highest mode
in the configuration mode hierarchy.
Example:
Router(config-ephone-template)# exit
Step 6 ephone phone-tag Enters ephone configuration mode.
Example:
Router(config)# ephone 1
Step 7 ephone-template template-tag Applies an ephone template to the ephone that is being
configured.
Example:
Router(config-ephone)# ephone-template 15
Step 8 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-ephone)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1121
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See the “Generating Configuration Files for Phones” on page 261.
Troubleshooting Vendor Parameter Configuration
Step 1 Ensure that the templates have been properly applied to the phones.
Step 2 Ensure that you use the create cnf-files command to regenerate configuration files and reset the phones
after you apply the templates.
Step 3 Use the show telephony-service tftp-bindings command to display the configuration files that are
associated with individual phones
Router# show telephony-service tftp-binding
tftp-server system:/its/SEPDEFAULT.cnf
tftp-server system:/its/SEPDEFAULT.cnf alias SEPDefault.cnf
tftp-server system:/its/XMLDefault.cnf.xml alias XMLDefault.cnf.xml
tftp-server system:/its/ATADefault.cnf.xml
tftp-server system:/its/XMLDefault7960.cnf.xml alias SEP00036B54BB15.cnf.xml
tftp-server system:/its/germany/7960-font.xml alias German_Germany/7960-font.xml
tftp-server system:/its/germany/7960-dictionary.xml alias
German_Germany/7960-dictionary.xml
tftp-server system:/its/germany/7960-kate.xml alias German_Germany/7960-kate.xml
tftp-server system:/its/germany/SCCP-dictionary.xml alias
German_Germany/SCCP-dictionary.xml
tftp-server system:/its/germany/7960-tones.xml alias Germany/7960-tones.xml
Step 4 Use the debug tftp events command to verify that the phone is accessing the file when you reboot the
phone.
SCCP: Configuring One-Way Push-to-Talk on Cisco Unified Wireless IP Phones
To associate a phone button with the thumb button on a wireless phone for one-way Push-to-Talk (PTT)
functionality in Cisco Unified CME, perform the following steps.
Prerequisites
• Cisco Unified CME 7.0 or a later version.
• Cisco phone firmware version 1.0.4 or a later version.
• System must be configured to for per-phone configuration files. For configuration information, see
“SCCP: Defining Per-Phone Configuration Files and Alternate Location” on page 119.
• Phone button to be associated with the thumb button must be configured with an intercom DN that
targets a paging number. For configuration information, see “Configuring Intercom Lines” on
page 917.
• Paging group to be dialed by the intercom line must be configured. Targeted paging group can be
unicast or multicast or both. For configuration information, see “Configuring Paging” on page 991.
Cisco Unified Communications Manager Express System Administrator Guide
1122 OL-10663-02
Modifying Cisco Unified IP Phone Options
How to Configure Cisco Unified IP Phone Options
Restrictions
• Supported on Cisco Unified Wireless IP Phone 7921 and 7925 only.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone template template-tag
4. service phone thumbButton1 PTTH button_number
5. exit
6. ephone phone-tag
7. ephone-template template-tag
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-template template-tag Enters ephone-template configuration mode to create an
ephone template.
Example:
Router (config)# ephone-template 12
Step 4 service phone thumbButton1 PTTHbutton_number Specifies which button is to go off hook when user
presses the thumb button.
Example: • button_number—Button on phone that is configured
Router(config-ephone-template)# service phone with an intercom dn that targets a paging number.
thumbButton1 PTTH6 Range is 1 to 6.
• There are no spaces in the PTTH and
button_number keyword/argument combination.
• This command can also be configured in
telephony-service configuration mode. For
individual phones, the template configuration for
this command overrides the system-level
configuration for this command.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1123
Modifying Cisco Unified IP Phone Options
Configuration Examples for Cisco Unified IP Phone Options
Command or Action Purpose
Step 5 exit Exits from this command mode to the next highest mode
in the configuration mode hierarchy.
Example:
Router(config-ephone-template)# exit
Step 6 ephone phone-tag Enters ephone configuration mode.
Example:
Router(config)# ephone 1
Step 7 ephone-template template-tag Applies an ephone template to the ephone that is being
configured.
Example:
Router(config-ephone)# ephone-template 12
Step 8 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-ephone)# end
What to Do Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See the “Generating Configuration Files for Phones” on page 261.
Configuration Examples for Cisco Unified IP Phone Options
This section contains the following examples:
• Text Labels for Ephone-dns: Example, page 1125
• Phone Header Bar Display: Example, page 1125
• System Text Message Display: Example, page 1125
• System File Display: Example, page 1125
• URL Provisioning for Directories, Services, and Messages Buttons: Example, page 1125
• Programmable VendorConfig Parameters: Example, page 1126
• Push-to-Talk (PTT) on Cisco Unified Wireless IP Phones in Cisco Unified CME: Example,
page 1126
Cisco Unified Communications Manager Express System Administrator Guide
1124 OL-10663-02
Modifying Cisco Unified IP Phone Options
Configuration Examples for Cisco Unified IP Phone Options
Text Labels for Ephone-dns: Example
The following example creates text labels for two ephone-dns:
ephone-dn 1
number 2001
label Sales
ephone-dn 2
number 2002
label Engineering
Phone Header Bar Display: Example
The following example provides the full E.164 number for a phone line in the phone header bar:
ephone-dn 55
number 2149
description 408-555-0149
ephone-dn 56
number 2150
ephone 12
button 1:55 2:56
System Text Message Display: Example
The following example specifies text that should display on IP phones when they are not in use:
telephony-service
system message ABC Company
System File Display: Example
The following example specifies that a file called logo.htm should be displayed on IP phones when they
are not in use:
telephony-service
url idle http://www.abcwrecking.com/public/logo.htm idle-timeout 35
URL Provisioning for Directories, Services, and Messages Buttons: Example
The following example provisions the Directories, Services, and Messages buttons.
telephony-service
url directories http://10.4.212.4/localdirectory
url services http://10.4.212.4/CCMUser/123456/urltest.html
url messages http://10.4.212.4/Voicemail/MessageSummary.asp
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1125
Modifying Cisco Unified IP Phone Options
Configuration Examples for Cisco Unified IP Phone Options
Programmable VendorConfig Parameters: Example
The following partial output shows a template in which programmable parameters for phone and display
functionality have been configured by using the service phone command.
ephone-template 1
button-layout 7931 1
service phone daysDisplayNotActive 1,2,3,4,5,6,7
service phone backlightOnTime 07:30
service phone backlightOnDuration 10:00
service phone backlightIdleTimeout 00.01
In the following example, the PC port is disabled on phones 26 and 27. All other phones have the PC
port enabled.
ephone-template 8
service phone pcPort 1
!
!
ephone 26
mac-address 1111.1111.1001
ephone-template 8
type 7960
button 1:26
!
!
ephone 27
mac-address 1111.2222.2002
ephone-template 8
type 7960
button 1:27
Push-to-Talk (PTT) on Cisco Unified Wireless IP Phones in Cisco Unified CME:
Example
The following partial output shows a template in which one-way PTT is configured by using the service
phone thumbButton1 command.
ephone-template 12
service phone thumbButton1 PTTH6
!
!
ephone-dn 10
intercom 1050
ephone-dn 50
number 1050
paging
!
!
ephone 1
type 7921
button 1:1 6:10
!
!
ephone 2
button 1:2
paging-dn 50
ephone 3
button 1:3
paging-dn 50
Cisco Unified Communications Manager Express System Administrator Guide
1126 OL-10663-02
Modifying Cisco Unified IP Phone Options
Additional References
ephone 4
button 1:1
paging-dn 50
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1127
Modifying Cisco Unified IP Phone Options
Feature Information for Cisco Unified IP Phone Options
Feature Information for Cisco Unified IP Phone Options
Table 51 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 51 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 51 Feature Information for Cisco Unified IP Phone Options
Cisco Unified CME
Feature Name Version Feature Information
Fixed Line/Feature Buttons 4.0(2) Provides two preconfigured fixed sets of feature buttons
for provisioning a Cisco Unified IP Phone 7931G.
Header Bar Display 3.4 Added support for modifying header bar display on SIP
phones.
2.01 Phone header bar display is introduced.
Labels for Directory Numbers 3.4 Added support for label display on SIP phones.
3.0 Ephone-dn labels were introduced.
Programmable Vendor Parameters 4.0 Added support for configuring programmable phone and
display functionality at a phone level for SCCP phones.
3.4 Added support for configuring programmable phone and
display functionality for SIP phones.
3.2.1 Added support for programmable phone and display
functionality in vendorConfig portion of configuration file.
Implementation of configuration is firmware version
dependent.
System Message Display 3.0 System message display on idle phones using text
messages was introduced.
2.1 System message display on idle phones using HTML files
was introduced.
URL Provisioning for Feature Buttons 4.2 Added support for configuring an ephone template to
provision multiple URLs for the Services feature button
phones.
3.4 Added support for provisioning customized URLs for
programmable feature buttons on supported SIP phones.
2.0 Provisioning customized URLs for programmable feature
buttons was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
1128 OL-10663-02
Creating Templates
Last Updated: March 22, 2010
This chapter describes templates support available in Cisco Unified Communications Manager Express
(Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Creating Templates”
section on page 1139.
Contents
• Information About Templates, page 1129
• How to Configure Templates, page 1130
• Configuration Examples for Creating Templates, page 1136
• Where to Go Next, page 1137
• Additional References, page 1137
• Feature Information for Creating Templates, page 1139
Information About Templates
To enable templates you should understand the following concepts:
• Phone Templates, page 1129
• Ephone-dn Templates, page 1130
Phone Templates
An ephone or voice-register template is a set of features that can be applied to one or more individual
phones using a single command.
Ephone templates were introduced in Cisco CME 3.2 to manipulate soft-key display and order on IP
phones.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1129
Creating Templates
How to Configure Templates
In Cisco Unified CME 4.0, ephone templates were significantly enhanced to include a number of
additional phone features. Templates allow you to uniformly and easily implement the features you
select for a set of phones. A maximum of 20 ephone templates can be created in a Cisco Unified CME
system, although an ephone can have only one template applied to it at a time.
In Cisco Unified CME 4.3 and later versions, an ephone template cannot be applied to a particular phone
unless its configuration file includes its Mac address. If you attempt to apply a template to a phone for
which the MAC address in not configured, a message appears.
If you use an ephone template to apply a command to a phone and you also use the same command in
ephone configuration mode for the same phone, the value set in ephone configuration mode has priority.
Voice-register templates were introduced in Cisco CME 3.4 to enable sets of features to be applied to
individual SIP IP phones that are connected directly in Cisco Unified CME. Typically, features to be
enabled by using a voice-register template are not configurable in other configuration modes. A
maximum 10 voice-register templates can be defined in Cisco Unified CME, although a phone can have
only one template applied to it at a time.
Type ? in ephone-template or voice-register-template configuration mode to display a list of features that
can be implemented by using templates.
For configuration information, see the “SCCP: Enabling Ephone Templates” section on page 1130.
Ephone-dn Templates
Ephone-dn templates allow you to apply a standard set of features to ephone-dns. A maximum of 15
ephone-dn templates can be created in a Cisco Unified CME system, although an ephone-dn can have
only one template applied to it at a time.
If you use an ephone-dn template to apply a command to an ephone-dn and you also use the same
command in ephone-dn configuration mode for the same ephone-dn, the value that you set in ephone-dn
configuration mode has priority.
Type ? in ephone-dn-template configuration mode to display a list of features that can be implemented
by using templates.
For configuration information, see the “SCCP: Enabling Ephone-dn Templates” section on page 1132
How to Configure Templates
This section contains the following tasks:
• SCCP: Enabling Ephone Templates, page 1130
• SCCP: Enabling Ephone-dn Templates, page 1132
• SCCP: Verifying Templates, page 1133
• SIP: Creating and Applying Templates to SIP Phones, page 1134
SCCP: Enabling Ephone Templates
To create an ephone template and apply it to a phone, perform the following steps.
Cisco Unified Communications Manager Express System Administrator Guide
1130 OL-10663-02
Creating Templates
How to Configure Templates
Prerequisites
• In Cisco Unified CME 4.3 and later versions, the configuration file for a particular phone must
contain its MAC address before an ephone template can be applied to that phone. To explicitly
configure a MAC address, use the mac-address command in ephone configuration mode. For
configuration information, see “Configuring Phones to Make Basic Calls” on page 139.
• It is recommended to configure cnf-file per phone before adding ephone-template under ephone.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-template template-tag
4. command
5. exit
6. ephone phone-tag
7. ephone-template template-tag
8. restart
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-template template-tag Enters ephone-template configuration mode to create an
ephone template.
Example: • template-tag—Unique identifier for the ephone
Router(config)# ephone-template 15 template that is being created. Range is 1 to 20.
Step 4 command Applies the specified command to the ephone template that
is being created.
Example: • Type ? for a list of commands that can be used in this
Router(config-ephone-template)# features step.
blocked Park Trnsfer
• Repeat this step for each command that you want to add
to the ephone template.
Step 5 exit Exits ephone-template configuration mode.
Example:
Router(config-ephone-template)# exit
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1131
Creating Templates
How to Configure Templates
Command or Action Purpose
Step 6 ephone phone-tag Enters ephone configuration mode.
• phone-tag—Unique sequence number that identifies
Example: this ephone during configuration tasks.
Router(config)# ephone 36
Step 7 ephone-template template-tag Applies an ephone template to the ephone that is being
configured.
Example:
Router(config-ephone)# ephone-template 15
Step 8 restart Performs a fast reboot of this ephone. Does not contact the
DHCP or TFTP server for updated information.
Example: Note Restart all ephones using the restart all command
Router(config-ephone)# restart in telephony-service configuration mode.
Step 9 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
SCCP: Enabling Ephone-dn Templates
To create an ephone-dn template and apply it to an ephone-dn, perform the following steps:
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn-template template-tag
4. command
5. exit
6. ephone-dn dn-tag
7. ephone-dn-template template-tag
8. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
1132 OL-10663-02
Creating Templates
How to Configure Templates
Command or Action Purpose
Step 3 ephone-dn-template template-tag Enters ephone-dn-template configuration mode to create an
ephone-dn template.
Example: • template-tag—Unique identifier for the ephone-dn
Router(config)# ephone-dn-template 3 template that is being created. Range is 1 to 20.
Step 4 command Applies the specified command to the ephone-dn template
that is being created.
Example: • Type ? for a list of commands that can be used in this
Router(config-ephone-dn-template)# step.
call-forwarding busy 4000
• Repeat this step to add more commands to the template.
Step 5 exit Exits ephone-dn-template configuration mode.
Example:
Router(config-ephone-dn-template)# exit
Step 6 ephone-dn dn-tag Enters ephone-dn configuration mode.
• dn-tag—Unique sequence number that identifies this
Example: ephone-dn during configuration tasks.
Router(config)# ephone-dn 23
Step 7 ephone-dn-template template-tag Applies an ephone-dn template to the ephone-dn that is
being configured.
Example:
Router(config-ephone-dn)# ephone-dn-template 3
Step 8 end Returns to privileged EXEC mode.
Example:
Router(config-ephone-dn)# end
SCCP: Verifying Templates
To view the configuration of a template, and verify to which phone or directory number a template is
applied, perform the following steps.
SUMMARY STEPS
1. show telephony-service ephone
2. show telephony-service ephone-template
3. show telephony-service ephone-dn
4. show telephony-service ephone-dn-template
DETAILED STEPS
Step 1 show telephony-service ephone
Use is command to display information about SCCP phones in Cisco Unified CME, including which
template-tags are enabled in the configuration for a phone.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1133
Creating Templates
How to Configure Templates
Router# show telephony-service ephone 1
ephone-dn-template 1
description Call Center Line 1
call-forward busy 500
call-forward noan 500 timeout 10
pickup-group 33!
!
Step 2 show telephony-service ephone-template
Use is command to display information about an ephone template in Cisco Unified CME, including a
list of features enabled in the configuration.
Step 3 show telephony-service ephone-dn
Use is command to display information about directory numbers, including which template-tags are
enabled in the configuration for a directory number.
Router# show telephony-service ephone-dn 4
!
ephone-dn 4 dual-line
number 136
description Desk4
ephone-dn template 1
ephone-hunt login
Step 4 show telephony-service ephone-dn-template
Use is command to display information about an ephone-dn template in Cisco Unified CME, including
a list of features enabled in the configuration.
SIP: Creating and Applying Templates to SIP Phones
To create templates of common features and softkeys that can be applied to individual Cisco SIP IP
phones, follow the steps in this section.
Prerequisites
• Cisco CME 3.4 or a later version.
• The mode cme command must be enabled in Cisco Unified CME.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register template template-tag
4. command
5. exit
6. voice register pool pool-tag
7. template template-tag
8. end
Cisco Unified Communications Manager Express System Administrator Guide
1134 OL-10663-02
Creating Templates
How to Configure Templates
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register template template-tag Enters voice register template configuration mode to define
a template of common parameters for SIP phones in
Cisco Unified CME.
Example:
Router(config)# voice register template 1 • Range is 1 to 5.
Step 4 command Applies the specified command to this template and enables
the corresponding feature on any supported SIP phone that
uses a template in which this command is configure.
Example:
Router(config-register-template)# anonymous • Type ? to display list of commands that can be used in
block a voice register template.
• Repeat this step for each feature to be added to this
voice register template.
Step 5 exit Exits configuration mode to the next highest mode in the
configuration mode hierarchy.
Example:
Router(config-register-template)# exit
Step 6 voice register pool pool-tag Enters voice register pool configuration mode to set
phone-specific parameters for SIP phones.
Example: • pool-tag—Unique sequence number of the Cisco SIP
Router(config)# voice register pool 3 phone to be configured. Range is 1 to 100 or the upper
limit as defined by max-pool command.
Step 7 template template-tag Applies a template created with the voice register template
command.
Example: • template-tag—Unique sequence number of the
Router(config-register-pool)# voice register template to be applied to the SIP phone specified by the
pool 1 voice register pool command. Range is 1 to 5.
Step 8 end Returns to privileged EXEC mode.
Example:
Router(config-register-pool)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1135
Creating Templates
Configuration Examples for Creating Templates
Examples
The following example shows templates 1 and 2 and how to do the following:
• Apply template 1 to SIP phones 1 to 3
• Apply template 2 to SIP phone 4
• Remove a previously created template 5 from SIP phone 5.
Router(config)# voice register template 1
Router(config-register-temp)# anonymous block
Router(config-register-temp)# caller-id block
Router(config-register-temp)# voicemail 5001 timeout 15
Router(config)# voice register template 2
Router(config-register-temp)# anonymous block
Router(config-register-temp)# caller-id block
Router(config-register-temp)# no conference
Router(config-register-temp)# no transfer-attended
Router(config-register-temp)# voicemail 5005 timeout 15
Router(config)# voice register pool 1
Router(config-register-pool)# template 1
Router(config)# voice register pool 2
Router(config-register-pool)# template 1
Router(config)# voice register pool 3
Router(config-register-pool)# template 1
Router(config)# voice register pool 4
Router(config-register-pool)# template 2
Router(config)# voice register pool 5
Router(config-register-pool)# no template 5
Configuration Examples for Creating Templates
This section contains the following examples:
• Using Ephone Template to Block The Use of Park and Transfer Soft Keys, page 1136
• Using Ephone-dn Template to Set Call Forwarding, page 1137
Using Ephone Template to Block The Use of Park and Transfer Soft Keys
The following example creates an ephone template to block the use of Park and Transfer soft keys. It is
applied to ephone 36 and extension 2333.
ephone-template 15
features blocked Park Trnsfer
ephone-dn 2
number 2333
ephone 36
button 1:2
ephone-template 15
Cisco Unified Communications Manager Express System Administrator Guide
1136 OL-10663-02
Creating Templates
Where to Go Next
Using Ephone-dn Template to Set Call Forwarding
The following example creates ephone-dn template 3, which sets call forwarding on busy and no answer
to forward calls to extension 4000 and sets the pickup group to 4. Ephone-dn template 3 is then applied
to ephone-dn 23 and ephone-dn 33, which appear on ephones 13 and 14, respectively.
ephone-dn-template 3
call-forwarding busy 4000
call-forwarding noan 4000 timeout 30
pickup group 4
ephone-dn 23
number 2323
ephone-dn-template 3
ephone-dn 33
number 3333
ephone-dn-template 3
ephone 13
button 1:23
ephone 14
button 1:33
Where to Go Next
Soft-Key Display
The display of soft keys during different call states is managed using ephone templates. For more
information, see “Customizing Soft Keys” on page 1047.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1137
Creating Templates
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
1138 OL-10663-02
Creating Templates
Feature Information for Creating Templates
Feature Information for Creating Templates
Table 52 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 52 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 52 Feature Information for Templates
Cisco Unified CME
Feature Name Version Feature Information
Ephone Templates 4.0 • The number of ephone templates that can be created
was increased from 5 to 20.
• More commands can be included in ephone templates.
3.2 Ephone templates were introduced to manage soft keys.
The only commands that can be used in ephone templates
are the softkeys commands.
Ephone-dn Templates 4.0 Ephone-dn templates were introduced.
Phone Templates for SIP Phones 4.1 The maximum number of templates that can be configured
was increased from 5 to 10.
3.4 Voice-register templates were introduced for SIP IP
phones directly connected to a Cisco Unified CME router.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1139
Creating Templates
Feature Information for Creating Templates
Cisco Unified Communications Manager Express System Administrator Guide
1140 OL-10663-02
Configuring Interoperability with
Cisco Unified CCX
Last Updated: March 8, 2010
This chapter describes features in Cisco Unified Communications Manager Express
(Cisco Unified CME) that provide support for interoperability between Cisco Unified CME and external
feature services, such as Cisco Customer Response Solutions (CRS) with Cisco Unified Contact Center
Express (Cisco Unified CCX).
Note To configure support for computer-based CSTA client applications, such as a Microsoft Office
Communicator (MOC) client or an application developed by using the Cisco Unified CME CTI SDK,
see “Configuring CTI CSTA Protocol Suite” on page 1165.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for Interoperability
Feature” section on page 1164.
Contents
• Information About Interoperability with Cisco Unified CCX, page 1142
• How to Configure Interoperability with Cisco Unified CCX, page 1144
• Configuration Examples for Interoperability with Cisco Unified CCX, page 1153
• Where to Go Next, page 1162
• Additional References, page 1163
• Feature Information for Interoperability with Cisco Unified CCX, page 1164
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1141
Configuring Interoperability with Cisco Unified CCX
Information About Interoperability with Cisco Unified CCX
Information About Interoperability with Cisco Unified CCX
Cisco Unified CME 4.2 and later versions support interoperability between Cisco Unified CME and
Cisco Customer Response Solutions (CRS) with Cisco Unified Call Center Express
(Cisco Unified CCX), including enhanced call processing, device and call monitoring, unattended call
transfers to multiple call center agents and basic extension mobility, and IP IVR applications.
The Cisco Unified CCX application uses the CRS platform to provide a multimedia (voice, data, and
web). Cisco IP IVR functionality is available with Cisco Unified CCX and includes prompt-and-collect
and call treatment.
The following functions are provided in Cisco Unified CME 4.2 and later versions:
• Support of Cisco Unified CCX Cisco Agent Desktop for use with Cisco Unified CME
• Configuration query and update between Cisco Unified CCX and Cisco Unified CME.
• SIP-based simple and supplementary call control services including:
– Call routing between Cisco Unified CME and Cisco Unified CCX using SIP-based route point
– First-party call control for SIP-based simple and supplementary calls
– Call monitoring and device monitoring based on SIP presence and dialog event package
• Cisco Unified CCX session management of Cisco Unified CME
• Cisco Unified CCX device and call monitoring of agent lines and call activities in
Cisco Unified CME
Provisioning and configuration information in Cisco Unified CCX is automatically provided to
Cisco United CME. If the configuration from Cisco Unified CCX is deleted or must be modified, you
can configure the same information in Cisco Unified CME by using Cisco IOS commands.
For first party call control, a route point for Cisco CRS is a peer device to Cisco Unified CME through
a SIP trunk. An incoming call to Cisco Unified CME that is targeted to a call center phone is routed to
Cisco Unified CCX through the route point. The call is placed in a queue and redirected to the most
suitable agent by Cisco Unified CCX.
Supplementary services such as call hold, blind transfer, and semi-attended transfer are initiated by
Cisco Unified CCX. Existing SIP-based simple and supplementary service call flow applies except for
blind transfers. For blind transfers with Cisco Unified CCX as the transferrer, Cisco Unified CCX will
stay in the active state until the transfer target answers. It drops out only after the transferred call is
successfully answered. If the transfer target does not answer when ringing times out, the call is pulled
back by Cisco Unified CCX and rerouted to another agent. This mechanism also applies when the
transfer target is configured with call-forward all or forward no-answer. The forward configuration is
ignored during blind transfer.
When a call moves between Cisco Unified CCX and Cisco Unified CME because of redirect, transfer,
and conference, the SIP Call-ID continues to change. For call control purposes, Cisco Unified CME
issues a unique Global Call ID (Gcid) for every outbound call leg. A Gcid remains the same for all legs
of the same call in the system, and is valid for redirect, transfer, and conference events, including 3-party
conferencing when a call center phone acts as a conference host.
Before Cisco IOS Release 12.4(11)XW6, if the call monitoring module in Cisco Unified CME 4.2
detected a call associated with a non default session application, such as B-ACD or a TCL script, the
module was globally disabled. After the module was disabled, Cisco Unified CCX administration had to
manually re-enable the call monitoring module after the session completes.
Cisco Unified Communications Manager Express System Administrator Guide
1142 OL-10663-02
Configuring Interoperability with Cisco Unified CCX
Information About Interoperability with Cisco Unified CCX
In Cisco IOS Release 12.4(11)XW6 and later releases, the call monitoring module in Cisco Unified CME
does not monitor a call associated with a non default session application, such as B-ACD or a TCL script,
including all calls merged into this call by way of consult transfer and conference. The module is not
disabled and continues to monitor other calls.
Table 53 contains a list of tasks required to enable operability between Cisco Unified CME and
Cisco Unified CCX, presented in the order in which the tasks are to be completed. This section contains
information about performing tasks in the first 2 steps in this table and procedures for completing step 3.
For configuration information, see the “How to Configure Interoperability with Cisco Unified CCX”
section on page 1144.
Table 53 Tasks to Configure Interoperability between Cisco CRS and Cisco Unified CME
Step Task Name of Document
1 Verify that the appropriate Cisco Unified —
Communications Manager Express
(Cisco Unified CME) version is installed on the router.
For compatibility information, see the Cisco Unified
Contact Center Express (Cisco Unified CCX) Software
and Hardware Compatibility Guide.
2 Configure the Cisco Unified CME router. Prerequisites, page 1144
Tip Note the XML user ID and password in
Cisco Unified CME and router’s IP address.
3 Configure Cisco Unified CME to enable interoperability How to Configure Interoperability
with Cisco Unified CCX. with Cisco Unified CCX,
page 1144
4 Install Cisco Unified Contact Center Express Cisco CRS Installation Guide at
(Cisco Unified CCX) for Cisco Unified CME. http://www.cisco.com/en/US/prod
5 Perform the initial setup of Cisco CRS for ucts/sw/custcosw/ps1846/prod_in
Cisco Unified CME. stallation_guides_list.html.
Tip When setup launches, you are asked for the XML
user ID and password, known as AXL user in
Cisco CRS, that you created in
Cisco Unified CME. You also must enter the
router IP address.
6 Configure Cisco Unified CME telephony subsystem to “Provisioning Unified CCX for
enable interoperability with Cisco Unified CCX. Unified CME” chapter in the
7 Create users and assign the agent capability in Cisco appropriate Cisco CRS
CRS. Administration Guide or Cisco
Unified Contact Center Express
Administration Guide at
http://www.cisco.com/en/US/prod
ucts/sw/custcosw/ps1846/product
s_installation_and_configuration_
guides_list.html.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1143
Configuring Interoperability with Cisco Unified CCX
How to Configure Interoperability with Cisco Unified CCX
How to Configure Interoperability with Cisco Unified CCX
This section contains the following procedures:
• Enabling Interoperability with Cisco Unified CCX, page 1144 (required)
• SCCP: Identifying Agent Directory Numbers in Cisco Unified CME for Session Manager,
page 1147 (required)
• Verifying Registrations and Subscriptions in Cisco Unified CME, page 1149 (optional)
• Re-creating a Session Manager in Cisco Unified CME, page 1149 (optional)
• Reconfiguring a Cisco CRS Route Point as a SIP Endpoint, page 1150 (optional)
Enabling Interoperability with Cisco Unified CCX
To configure Cisco Unified CME to enable interoperability between Cisco Unified CME and
Cisco Unified CCX, perform the following steps.
Note A single Cisco Unified CME can support multiple session managers.
Prerequisites
• Cisco Unified CME version and Cisco IOS release that is compatible with your Cisco Unified CCX
version. For compatibility information, see the Cisco Unified Contact Center Express (Cisco Unified
CCX) Software and Hardware Compatibility Guide.
• XML API must be configured to create an AXL username for Cisco Unified CCX access. For
configuration information, see “Configuring the XML API” on page 1219.
Note During the initial setup of Cisco CRS for Cisco Unified CME, you need the AXL username and
password that was configured using the xml user command in telephony-service configuration mode.
You also need the router IP address that was configured using the ip source-address command in
telephony-service configuration mode.
• Agent phones to be connected in Cisco Unified CME must be configured in Cisco Unified CME.
When configuring a Cisco Unified CCX agent phone, use the keep-conference endcall command
to enable conference initiators to exit from conference calls and end the conference for the
remaining parties. For configuration information, see “Configuring Conferencing” on page 753.
• The Cisco Unified CME router must be configured to accept incoming presence requests. For
configuration information, see “Configuring Presence Service” on page 1003.
• To support Desktop Monitoring and Recording, the service phone SpanToPCPort 1 command must
be configured in telephony-service configuration mode. For configuration information, see “SCCP:
Modifying Vendor Parameters for All Phones” on page 1119.
Restrictions
• Maximum number of active Cisco Unified CCX agents supported: 50.
• Multi-Party Ad Hoc and Meet-Me Conferencing are not supported.
Cisco Unified Communications Manager Express System Administrator Guide
1144 OL-10663-02
Configuring Interoperability with Cisco Unified CCX
How to Configure Interoperability with Cisco Unified CCX
• The following incoming calls are supported for deployment of the interoperability feature: SIP trunk
calls from another Cisco Unified CME and all calls from a PSTN trunk. Other trunks, such H.323,
are supported as usual in Cisco Unified CME, however, not for customer calls to
Cisco Unified CCX.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice call send-alert
4. voice service voip
5. callmonitor
6. gcid
7. allow-connections sip to sip
8. no supplementary-service sip moved-temporary
9. no supplementary-service sip refer
10. sip
11. registrar server [expires [max sec] [min sec]
12. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice call send-alert Enables the terminating gateway to send an alert message
instead of a progress message after it receives a call setup
message.
Example:
Router(config)# voice call send-alert
Step 4 voice service voip Enters voice-service configuration mode and specifies
voice-over-IP encapsulation.
Example:
Router(config)# voice service voip
Step 5 callmonitor Enables call monitoring messaging functionality.
• Used by Cisco Unified CCX for processing and
Example: reporting.
Router(config-voi-serv)# callmonitor
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1145
Configuring Interoperability with Cisco Unified CCX
How to Configure Interoperability with Cisco Unified CCX
Command or Action Purpose
Step 6 gcid Enables Global Call-ID (Gcid) for call control purposes.
• Used by Cisco Unified CCX for tracking call.
Example:
Router(config-voi-serv)# gcid
Step 7 allow-connections sip to sip Allows connections between specific types of endpoints in
a VoIP network.
Example:
Router(config-voi-serv)# allow-connections sip
to sip
Step 8 no supplementary-service sip moved-temporary Prevents the router from sending a redirect response to the
destination for call forwarding.
Example:
Router(config-voi-serv)# no
supplementary-service sip moved-temporary
Step 9 no supplementary-service sip refer Prevents the router from forwarding a REFER message to
the destination for call transfers.
Example:
Router(config-voi-serv)# no
supplementary-service sip refer
Step 10 sip Enters SIP configuration mode.
Example:
Router(config-voi-serv)# sip
Step 11 registrar server [expires [max sec][min sec]] Enables SIP registrar functionality in Cisco Unified CME.
• expires—(Optional) Sets the active time for an
Example: incoming registration.
Router(config-voi-sip)# registrar server
expires max 600 min 60
• max sec—(Optional) Maximum time for a registration
to expire, in seconds. Range: 600 to 86400.
Default: 3600. Recommended value: 600.
Note Ensure that the registration expiration timeout is set
to a value smaller than the TCP connection aging
timeout to avoid disconnection from the TCP.
• min sec—(Optional) Minimum time for a registration
to expire, in seconds. Range: 60 to 3600. Default: 60.
Step 12 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-voi-serv)# end
Cisco Unified Communications Manager Express System Administrator Guide
1146 OL-10663-02
Configuring Interoperability with Cisco Unified CCX
How to Configure Interoperability with Cisco Unified CCX
SCCP: Identifying Agent Directory Numbers in Cisco Unified CME for Session
Manager
To specify which directory numbers, associated with phone lines on Cisco Unified CCX agent phones,
can be managed by a session manager, perform the following steps.
Prerequisites
• Up to eight session managers must be configured in Cisco Unified CME.
• Directory numbers associated with Cisco Unified CCX agent phones must be configured in Cisco
Unified CME.
– Cisco Unified CME 4.2: Directory numbers for agent phones must be configured as dual lines
to allow an agent to make two call connections at the same time using one phone line button.
Note that if the second line of the dual-line directory number is busy, a transfer event between
phones in the solution will fail to complete.
– Cisco Unified CME 4.3/7.0 and later versions: We recommend that directory numbers for agent
phones be configured as octal lines to help to ensure that a free line with the same directory
number is available for a transfer event.
– For configuration information, see “Configuring Phones to Make Basic Calls” on page 139.
Restrictions
• Only SCCP phones can be configured as agent phones in Cisco Unified CME. The Cisco VG224
Analog Phone Gateway and analog and SIP phones are supported as usual in Cisco Unified CME,
however, not as Cisco Unified CCX agent phones.
• Cisco Unified IP Phone 7931 cannot be configured as an agent phone in Cisco Unified CME.
Cisco Unified IP Phone 7931s are supported as usual in Cisco Unified CME, however, not as
Cisco Unified CCX agent phones.
• Shared-line appearance is not supported on agent phones. A directory number cannot be associated
with more than one physical agent phone at one time.
• Overlaid lines are not supported on agent phones. More than one directory number cannot be
associated with a single line button on an agent phone.
• Monitored mode for a line button is not supported on agent phones. An agent phone cannot be
monitored by another phone.
• Cisco Unified CCX does not support a call event that includes a different directory number; all call
events must include the primary directory number. Call transfers between phones with single-line
directory numbers will cause call monitoring to fail.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone-dn dn-tag
4. allow watch
5. session-server {session-tag[,...session-tag]}
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1147
Configuring Interoperability with Cisco Unified CCX
How to Configure Interoperability with Cisco Unified CCX
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn dn-tag Enters ephone-dn configuration mode.
• dn-tag—Unique ID of an already configured directory
Example: number. The tag number corresponds to a tag number
Router(config)# ephone-dn 24 created when this directory number was initially
configured.
Step 4 session-server Specifies which session managers are to monitor the
session-server-tag[,...session-server-tag] directory number being configured.
• session-server-tag—Unique ID session manager,
Example: configured in Cisco Unified CCX and automatically
Router(config-ephone-dn)# session-server provided to Cisco Unified CME. Range: 1 to 8.
1,2,3,4,6
Tip If you do not know the value for session-server-tag,
we recommend using 1.
• Can configure up to eight session-server-tags;
individual tags must be separated by commas (,).
• Each directory number can be managed by up to eight
session managers. Each session manager can monitor
more than one directory number.
Step 5 allow watch Allows the phone line associated with this directory number
to be monitored by a watcher in a presence service.
Example: • This command can also be configured in ephone-dn
Router(config-ephone-dn)# allow watch template configuration mode and applied to one or
more phones. The ephone-dn configuration has priority
over the ephone-dn template configuration.
Step 6 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-ephone-dn)# end
Cisco Unified Communications Manager Express System Administrator Guide
1148 OL-10663-02
Configuring Interoperability with Cisco Unified CCX
How to Configure Interoperability with Cisco Unified CCX
Verifying Registrations and Subscriptions in Cisco Unified CME
Before using the system, verify registrations and subscriptions for Cisco Unified CCX endpoints.
Step 1 Use the show sip status registrar command to verify whether session manager and Cisco CRS route
points are registered.
Step 2 Use the show presence subscription summary command to verify whether Cisco CRS route points and
Cisco Unified CCX agent directory numbers are subscribed.
The following is sample output from the show presence subscription summary command. The first two
rows show the status for two route points. The next two are for logged in agent phones.
Router# show presence subscription summary
Presence Active Subscription Records Summary: 15 subscription
Watcher Presentity SubID Expires SibID Status
======================== ======================== ====== ======= ====== ======
CRScontrol@10.4.171.81 8101@10.4.171.34 4 3600 0 idle
CRScontrol@10.4.171.81 8201@10.4.171.34 8 3600 0 idle
CRScontrol@10.4.171.81 4016@10.4.171.34 10 3600 0 idle
CRScontrol@10.4.171.81 4020@10.4.171.34 12 3599 0 idle
Re-creating a Session Manager in Cisco Unified CME
Note Provisioning and configuration information in Cisco Unified CCX is automatically provided to
Cisco United CME. The following task is required only if the configuration from Cisco Unified CCX is
deleted or must be modified.
To re-create a session manager in Cisco Unified CME for Cisco Unified CCX, perform the following
steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register session-server session-server-tag
4. register-id name
5. keepalive seconds
6. end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1149
Configuring Interoperability with Cisco Unified CCX
How to Configure Interoperability with Cisco Unified CCX
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register session-server Enters voice register session-server configuration mode to
session-server-tag enable and configure a session manager for an external
feature server, such as the Cisco Unified CCX application
Example: on a Cisco CRS system.
Router(config)# voice register session-server 1 • Range: 1 to 8.
• A single Cisco Unified CME can support multiple
session managers.
Step 4 register id name (Optional) Required only if the configuration from
Cisco Unified CCX is deleted or must be modified.
Example: • name—String for identifying Cisco Unified CCX. Can
Router(config-register-fs)# CRS1 contain 1 to 30 alphanumeric characters.
Step 5 keepalive seconds (Optional) Required only if the configuration from
Cisco Unified CCX is deleted or must be modified.
Example: • Keepalive duration for registration, in seconds, after
Router(config-register-fs)# keepalive 300 which the registration expires unless
Cisco Unified CCX reregisters before the registration
expiry.
• Range: 60 to 3600. Default: 300.
Note Default in Cisco Unified CCX is 120.
Step 6 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-fs)# end
Reconfiguring a Cisco CRS Route Point as a SIP Endpoint
Note Provisioning and configuration information in Cisco Unified CCX is automatically provided to
Cisco United CME. The following task is required only if the configuration from Cisco Unified CCX is
deleted or must be modified.
To reconfigure a Cisco CRS route point as a SIP endpoint in Cisco Unified CME, perform the following
steps.
Cisco Unified Communications Manager Express System Administrator Guide
1150 OL-10663-02
Configuring Interoperability with Cisco Unified CCX
How to Configure Interoperability with Cisco Unified CCX
Prerequisites
• Directory numbers associated with Cisco CRS route points must be configured in
Cisco Unified CME. For configuration information for directory numbers associated with SIP
endpoints, see “Configuring Phones to Make Basic Calls” on page 139.
• Directory numbers associated with Cisco CRS route points must be enabled to be watched. For
configuration information, see “Configuring Presence Service” on page 1003.
• The mode cme command must be enabled in Cisco Unified CME.
Restrictions
• Each Cisco CRS route point can be managed by only one session manager.
• Each session manager can manage more than one Cisco CRS route point.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register dn dn-tag
4. number number
5. session-server {session-tag[,...session-tag]}
6. allow watch
7. refer target dial-peer
8. exit
9. voice register pool pool-tag
10. number tag dn dn-tag
11. session-server session-tag
12. codec codec-type [bytes]
13. dtmf-relay sip-notify
14. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1151
Configuring Interoperability with Cisco Unified CCX
How to Configure Interoperability with Cisco Unified CCX
Command or Action Purpose
Step 3 voice register dn dn-tag Enters voice register dn configuration mode to define a
directory number for a SIP phone, intercom line, voice port,
or a message-waiting indicator (MWI).
Example:
Router(config-register-global)# voice register
dn 1
Step 4 number number Defines a valid number for a directory number.
Example:
Router(config-register-dn)# number 2777
Step 5 session-server Specifies which session managers are to monitor the
session-server-tag[,...session-server-tag] directory number being configured.
• session-server-tag—Unique ID session manager,
Example: configured in Cisco Unified CCX and automatically
Router(config-register-dn)# session-server 1 provided to Cisco Unified CME. Range: 1 to 8.
Tip If you do not know the value for session-server-tag,
we recommend using 1.
• Can configure up to eight session-server-tags;
individual tags must be separated by commas (,).
• Each directory number can be managed by up to eight
session managers. Each session manager can monitor
more than one directory number.
Step 6 allow watch Allows the phone line associated with this directory number
to be monitored by a watcher in a presence service.
Example:
Router(config-register-dn)# allow watch
Step 7 refer target dial-peer Enables watcher to handle SIP REFER message from this
directory number.
Example: • target dial-peer—Refer To portion of message is
Router(config-register-dn)# refer target based on address from dial peer for this directory
dial-peer number.
Step 8 exit Exits configuration mode to the next highest mode in the
configuration mode hierarchy.
Example:
Router(config-register-dn)# exit
Step 9 voice register pool pool-tag Enters voice register pool configuration mode to set
device-specific parameters for a Cisco CRS route point.
Example: • A voice register pool in Cisco Unified CCX can contain
Router(config)# voice register pool 3 up to 10 individual SIP endpoints. Subsequent pools are
created for additional SIP endpoints.
Step 10 number tag dn dn-tag Associates a directory number with the route point being
configured.
Example:
Router(config-register-pool)# number 1 dn 1
Cisco Unified Communications Manager Express System Administrator Guide
1152 OL-10663-02
Configuring Interoperability with Cisco Unified CCX
Configuration Examples for Interoperability with Cisco Unified CCX
Command or Action Purpose
Step 11 session-server session-server-tag Identifies session manager to be used to control the route
point being configured.
Example: • session-server-tag—Unique number assigned to a
Router(config-register-pool)# session-server 1 session manager. Range: 1 to 8. The tag number
corresponds to a tag number created by using the voice
register session-server command.
Step 12 codec g711ulaw Specifies the codec for the dial peer dynamically created for
the route point being configured.
Example: • codec-type—g711ulaw is required for
Router(config-register-pool)# codec g711ulaw Cisco Unified CCX.
Step 13 dtmf-relay sip-notify Specifies DTMF Relay method to be used by the route point
being configured.
Example:
Router(config-register-pool)# dtmf-relay
sip-notify
Step 14 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-pool)# end
Configuration Examples for Interoperability with
Cisco Unified CCX
The following output from the show running-configuration command shows the configuration on a
Cisco Unified CME router that will interoperate with Cisco Unified CCX.
!
version 12.4
service timestamps debug datetime msec
service timestamps log datetime msec
no service password-encryption
!
hostname sb-sj3-3845-uut1
!
boot-start-marker
boot-end-marker
!
card type t1 0 2
card type t1 0 3
logging buffered 1000000
no logging console
enable password password
!
no aaa new-model
network-clock-participate wic 2
network-clock-participate wic 3
ip cef
!
!
no ip dhcp use vrf connected
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1153
Configuring Interoperability with Cisco Unified CCX
Configuration Examples for Interoperability with Cisco Unified CCX
!
ip dhcp excluded-address 192.0.2.250 192.0.2.254
!
ip dhcp pool ephones
network 192.0.2.0 255.255.255.0
option 150 ip 192.0.2.254
default-router 192.0.2.254
!
!
no ip domain lookup
!
isdn switch-type primary-5ess
voice-card 0
no dspfarm
!
!
!
!
voice service voip
gcid
callmonitor
allow-connections h323 to h323
allow-connections h323 to sip
allow-connections sip to h323
allow-connections sip to sip
no supplementary-service sip moved-temporarily
no supplementary-service sip refer
sip
registrar server expires max 120 min 60
!
!
voice class codec 1
codec preference 1 g711ulaw
codec preference 2 g729r8
!
!
!
!
!
!
!
!
!
!
voice register global
mode cme
source-address 192.0.2.254 port 5060
max-dn 720
max-pool 240
authenticate presence
authenticate register
dialplan-pattern 1 511.... extension-length 4
voicemail 9001
create profile sync 0000347600391314
!
voice register session-server 1
keepalive 300
register-id SB-SJ3-UCCX1_1164774025000
!
voice register dn 1
session-server 1
number 8999
allow watch
refer target dial-peer
Cisco Unified Communications Manager Express System Administrator Guide
1154 OL-10663-02
Configuring Interoperability with Cisco Unified CCX
Configuration Examples for Interoperability with Cisco Unified CCX
!
voice register dn 2
session-server 1
number 8001
allow watch
refer target dial-peer
!
voice register dn 3
session-server 1
number 8101
allow watch
refer target dial-peer
!
voice register dn 11
number 2011
name ep-sip-1-11
mwi
!
voice register dn 12
number 2012
name ep-sip-1-12
mwi
!
voice register dn 16
number 5016
name rp-sip-1-16
label SIP 511-5016
mwi
!
voice register dn 17
number 5017
name rp-sip-1-17
label SIP 511-5017
mwi
!
voice register dn 18
number 5018
name rp-sip-1-18
label SIP 511-5018
mwi
!
voice register pool 1
session-server 1
number 1 dn 1
number 2 dn 2
number 3 dn 3
dtmf-relay sip-notify
codec g711ulaw
!
voice register pool 11
id mac 1111.0711.2011
type 7970
number 1 dn 11
dtmf-relay rtp-nte
voice-class codec 1
username 5112011 password 5112011
!
voice register pool 12
id mac 1111.0711.2012
type 7960
number 1 dn 12
dtmf-relay rtp-nte
voice-class codec 1
username 5112012 password 5112012
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1155
Configuring Interoperability with Cisco Unified CCX
Configuration Examples for Interoperability with Cisco Unified CCX
!
voice register pool 16
id mac 0017.0EBC.1500
type 7961GE
number 1 dn 16
dtmf-relay rtp-nte
voice-class codec 1
username rp-sip-1-16 password pool16
!
voice register pool 17
id mac 0016.C7C5.0660
type 7971
number 1 dn 17
dtmf-relay rtp-nte
voice-class codec 1
username rp-sip-1-17 password pool17
!
voice register pool 18
id mac 0015.629E.825D
type 7971
number 1 dn 18
dtmf-relay rtp-nte
voice-class codec 1
username rp-sip-1-18 password pool18
!
!
!
!
!
!
!
controller T1 0/2/0
framing esf
clock source internal
linecode b8zs
pri-group timeslots 1-4,24
!
controller T1 0/2/1
framing esf
clock source internal
linecode b8zs
pri-group timeslots 1-4,24
!
controller T1 0/3/0
framing esf
clock source internal
linecode b8zs
ds0-group 0 timeslots 1-4 type e&m-immediate-start
!
controller T1 0/3/1
framing esf
clock source internal
linecode b8zs
ds0-group 0 timeslots 1-4 type e&m-immediate-start
vlan internal allocation policy ascending
!
!
!
!
interface GigabitEthernet0/0
ip address 209.165.201.1 255.255.255.224
duplex auto
speed auto
media-type rj45
Cisco Unified Communications Manager Express System Administrator Guide
1156 OL-10663-02
Configuring Interoperability with Cisco Unified CCX
Configuration Examples for Interoperability with Cisco Unified CCX
!
interface GigabitEthernet0/1
ip address 192.0.2.254 255.255.255.0
duplex auto
speed auto
media-type rj45
!
interface Serial0/2/0:23
no ip address
encapsulation hdlc
isdn switch-type primary-5ess
isdn protocol-emulate network
isdn incoming-voice voice
no cdp enable
!
interface Serial0/2/1:23
no ip address
encapsulation hdlc
isdn switch-type primary-5ess
isdn protocol-emulate network
isdn incoming-voice voice
no cdp enable
!
interface Service-Engine1/0
ip unnumbered GigabitEthernet0/0
service-module ip address 209.165.202.129 255.255.255.224
service-module ip default-gateway 209.165.201.1
!
ip route 192.0.0.30 255.0.0.0 192.0.0.55
ip route 209.165.202.129 255.255.255.224 Service-Engine1/0
ip route 192.0.2.56 255.255.255.0 209.165.202.2
ip route 192.0.3.74 255.255.255.0 209.165.202.3
ip route 209.165.202.158 255.255.255.224 192.0.0.55
!
!
ip http server
ip http authentication local
ip http path flash:
!
!
ixi transport http
response size 64
no shutdown
request outstanding 1
!
ixi application cme
no shutdown
!
!
!
control-plane
!
!
!
voice-port 0/0/0
!
voice-port 0/0/1
!
voice-port 0/2/0:23
!
voice-port 0/3/0:0
!
voice-port 0/1/0
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1157
Configuring Interoperability with Cisco Unified CCX
Configuration Examples for Interoperability with Cisco Unified CCX
voice-port 0/1/1
!
voice-port 0/2/1:23
!
voice-port 0/3/1:0
!
!
!
!
!
dial-peer voice 9000 voip
description ==> This is for internal calls to CUE
destination-pattern 9...
voice-class codec 1
session protocol sipv2
session target ipv4:209.165.202.129
dtmf-relay rtp-nte sip-notify
!
dial-peer voice 9001 voip
description ==> This is for external calls to CUE
destination-pattern 5119...
voice-class codec 1
session protocol sipv2
session target ipv4:209.165.202.129
dtmf-relay rtp-nte sip-notify
!
dial-peer voice 521 voip
destination-pattern 521....
voice-class codec 1
max-redirects 5
session protocol sipv2
session target ipv4:209.165.201.2
dtmf-relay rtp-nte sip-notify
!
dial-peer voice 531 voip
destination-pattern 531....
voice-class codec 1
max-redirects 5
session protocol sipv2
session target ipv4:209.165.201.3
dtmf-relay rtp-nte sip-notify
!
!
presence
presence call-list
watcher all
allow subscribe
!
sip-ua
mwi-server ipv4:209.165.202.128 expires 3600 port 5060 transport udp
presence enable
!
!
telephony-service
no auto-reg-ephone
xml user axluser password axlpass 15 <====AXL username and password for Cisco CRS
max-ephones 240
max-dn 720
ip source-address 192.0.2.254 port 2000 <====IP address of router
system message sb-sj3-3845-uut1
url services http://192.0.2.252:6293/ipphone/jsp/sciphonexml/IPAgentInitial.jsp
url authentication http:192.0.2.252:6293/ipphone/jsp/sciphonexml/IPAgentAuthenticate.jsp
cnf-file perphone
dialplan-pattern 1 511.... extension-length 4
Cisco Unified Communications Manager Express System Administrator Guide
1158 OL-10663-02
Configuring Interoperability with Cisco Unified CCX
Configuration Examples for Interoperability with Cisco Unified CCX
voicemail 9001
max-conferences 8 gain -6
call-forward pattern .T
moh flash:music-on-hold.wav
multicast moh 239.10.10.1 port 2000
transfer-system full-consult
transfer-pattern .T
create cnf-files version-stamp 7960 Jun 18 2007 07:44:25
!
!
ephone-dn 1 dual-line
session-server 1
number 1001
name ag-1-1
allow watch
mwi sip
!
!
ephone-dn 2 dual-line
session-server 1
number 1002
name ag-1-2
allow watch
mwi sip
!
!
ephone-dn 3 dual-line
session-server 1
number 1003
name ag-1-3
allow watch
mwi sip
!
!
ephone-dn 4 dual-line
session-server 1
number 1004
name ag-1-4
allow watch
mwi sip
!
!
ephone-dn 5
session-server 1
number 1005
name ag-1-5
allow watch
mwi sip
!
!
ephone-dn 11 dual-line
number 3011
name ep-sccp-1-11
mwi sip
!
!
ephone-dn 12
number 3012
name ep-sccp-1-12
mwi sip
!
!
ephone-dn 16 dual-line
number 4016
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1159
Configuring Interoperability with Cisco Unified CCX
Configuration Examples for Interoperability with Cisco Unified CCX
label SCCP 511-4016
name rp-sccp-1-16
mwi sip
!
!
ephone-dn 17 dual-line
number 4017
label SCCP 511-4017
name rp-sccp-1-17
mwi sip
!
!
ephone-dn 18 dual-line
number 4018
label SCCP 511-4018
name rp-sccp-1-18
mwi sip
!
!
ephone-dn 19 dual-line
number 4019
label SCCP 511-4019
name rp-sccp-1-19
mwi sip
!
!
ephone-dn 20 dual-line
number 4020
label SCCP 511-4020
name rp-sccp-1-20
mwi sip
!
!
ephone-dn 21 dual-line
number 4021
label SCCP 511-4021
name rp-sccp-1-21
mwi sip
!
!
ephone-dn 22 dual-line
number 4022
label SCCP 511-4022
name rp-sccp-1-22
mwi sip
!
!
ephone 1
mac-address 1111.0711.1001
type 7970
keep-conference endcall
button 1:1
!
!
!
ephone 2
mac-address 1111.0711.1002
type 7970
keep-conference endcall
button 1:2
!
!
!
ephone 3
Cisco Unified Communications Manager Express System Administrator Guide
1160 OL-10663-02
Configuring Interoperability with Cisco Unified CCX
Configuration Examples for Interoperability with Cisco Unified CCX
mac-address 1111.0711.1003
type 7970
keep-conference endcall
button 1:3
!
!
!
ephone 4
mac-address 1111.0711.1004
type 7970
keep-conference endcall
button 1:4
!
!
!
ephone 5
mac-address 1111.0711.1005
type 7970
keep-conference endcall
button 1:5
!
!
!
ephone 11
mac-address 1111.0711.3011
type 7970
keep-conference endcall
button 1:11
!
!
!
ephone 12
mac-address 1111.0711.3012
type 7960
keep-conference endcall
button 1:12
!
!
!
ephone 16
mac-address 0012.D916.5AD6
type 7960
keep-conference endcall
button 1:16
!
!
!
ephone 17
mac-address 0013.1AA6.7A9E
type 7960
keep-conference endcall
button 1:17
!
!
!
ephone 18
mac-address 0012.80F3.B013
type 7960
keep-conference endcall
button 1:18
!
!
!
ephone 19
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1161
Configuring Interoperability with Cisco Unified CCX
Where to Go Next
mac-address 0013.1A1F.6282
type 7970
keep-conference endcall
button 1:19
!
!
!
ephone 20
mac-address 0013.195A.00D0
type 7970
keep-conference endcall
button 1:20
!
!
!
ephone 21
mac-address 0017.0EBC.147C
type 7961GE
keep-conference endcall
button 1:21
!
!
!
ephone 22
mac-address 0016.C7C5.0578
type 7971
keep-conference endcall
button 1:22
!
!
!
line con 0
exec-timeout 0 0
stopbits 1
line aux 0
stopbits 1
line 66
no activation-character
no exec
transport preferred none
transport input all
transport output pad telnet rlogin lapb-ta mop udptn v120
line vty 0 4
password lab
login
!
scheduler allocate 20000 1000
!
end
Where to Go Next
If you are done modifying parameters for phones in Cisco Unified CME, generate a new configuration
file and restart the phones. See “Generating Configuration Files for Phones” on page 261.
Cisco Unified Communications Manager Express System Administrator Guide
1162 OL-10663-02
Configuring Interoperability with Cisco Unified CCX
Additional References
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T documentation
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1163
Configuring Interoperability with Cisco Unified CCX
Feature Information for Interoperability with Cisco Unified CCX
Feature Information for Interoperability with
Cisco Unified CCX
Table 54 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified Communications Manager Express and Cisco IOS Software Version Compatibility Matrix
at http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 54 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 54 Feature Information for Interoperability Feature
Cisco Unified CME
Feature Name Version Modification
Interoperability with Cisco Unified CCX 4.2 Enables interoperability between Cisco Unified CME and
Cisco Customer Response Solutions (CRS) 5.0 and later
versions with Cisco Unified Contact Center Express
(Cisco Unified CCX), including Cisco Unified IP IVR,
enhanced call processing, device and call monitoring,
unattended call transfers to multiple call center agents, and
basic extension mobility.
Cisco Unified Communications Manager Express System Administrator Guide
1164 OL-10663-02
Configuring CTI CSTA Protocol Suite
First Published: October 7, 2009
This module describes how to configure the CTI CSTA protocol suite in Cisco Unified
Communications Manager Express (Cisco Unified CME) 8.0 and later versions to allow computer-based
CSTA client applications, such as a Microsoft Office Communicator (MOC) client or an application
developed by using the Cisco Unified Communications Express (UC Express) Services InterfaceSDK,
to monitor and control the Cisco Unified CME system to enable programmatic control of SCCP
telephony devices registered in Cisco Unified CME.
Note To configure support for interoperability between Cisco Unified CME and Cisco Customer Response
Solutions (CRS) with Cisco Unified Contact Center Express (Cisco Unified CCX), see“Configuring
Interoperability with Cisco Unified CCX” on page 1141.
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for CTI CSTA Protocol
Suite” section on page 1186.
Contents
• Information About CTI CSTA Protocol Suite, page 1166
• How to Configure CTI CSTA Protocol Suite, page 1167
• Configuration Examples for CTII CSTA Protocol Suite, page 1177
• Additional References, page 1184
• Feature Information for CTI CSTA Protocol Suite, page 1186
Americas Headquarters:
Cisco Systems, Inc., 170 West Tasman Drive, San Jose, CA 95134-1706 USA
Configuring CTI CSTA Protocol Suite
Information About CTI CSTA Protocol Suite
Information About CTI CSTA Protocol Suite
To enable these new features, you should understand the following concepts:
• CTI CSTA in Cisco Unified CME, page 1166
• CTI Session, page 1166
• Supported Services and Events, page 1167
CTI CSTA in Cisco Unified CME
The CTI CSTA Protocol Suite in Cisco Unified CME 8.0 and later versions provides third-party
call-control capabilities for computer-based CSTA client applications, such as a Microsoft Office
Communicator (MOC) client through Microsoft Office Communications Server (OCS) and applications
created using the Cisco Unified CME CTI SDK, and enables click-to-dial from the application.
CSTA Client Application Deployment
Typically, a computer-based application uses CSTA to control its associated PBX phone via a SIP CSTA
gateway. The gateway terminates SIP messages and converts ECMA-323 messages to and from the
PBX-specific protocol.
In Cisco Unified CME 8.0 and later versions, a computer-based CSTA client application interacts
directly with Cisco Unified CME via the CTI interface in Cisco Unified CME to control and monitor IP
phones registered in Cisco Unified CME. Cisco Unified CME replaces the CSTA gateway and the PBX
in the typical application-to-PBX deployment to terminate SIP messages from the client application and
convert CSTA XML into the line-side protocol that controls the phone.
CTI Session
If required, a CSTA client application creates a session by establishing a SIP dialog with the CTI
interface in Cisco Unified CME 8.0 and later versions. The logical name of the phone user is described
in the SIP “From” header while the PBX phone line is described in the SIP “To” header. The user and
line configurations are created in the application.
The SIP INVITE body includes a System Status service request. A SIP “OK” response that includes a
System Status response is sent from Cisco Unified CME. The application continues only if it receives
the expected response.
After receiving the expected response, the client application begins the capabilities exchange by sending
a SIP message requesting a list of supported CSTA services and events from Cisco Unified CME.
Cisco Unified CME sends a response with an encapsulated CSTA features response that is a list of
supported services and events. For information, see the “Supported Services and Events” section on
page 1167.
The CSTA client application must start a CSTA monitor before it can observe changes to calls and
features by CSTA events. To start the Call Monitor Module (CMM) in Cisco Unified CME, the
application sends a SIP INFO message with an encapsulated service request. The CTI interface
authorizes this request and sends back a SIP 200 OK response with an encapsulated ECMA-323 Monitor
Start response. After this, Cisco Unified CME starts generating subsequent events in SIP INFO
messages to the application.
Cisco Unified Communications Manager Express System Administrator Guide
1166 OL-10663-02
Configuring CTI CSTA Protocol Suite
How to Configure CTI CSTA Protocol Suite
During a CTI session, the CSTA client application sets a timer (default 30 minutes) in the INVITE
message and refreshes it via RE-INVITE message. Cisco Unified CME will delete a SIP dialog after the
session expires.
Supported Services and Events
Table 55 contains a list of typical CSTA services and events that are supported by the CTI CSTA protocol
Suite in Cisco Unified CME 8.0 and later versions. Not all CSTA client applications can support all
features. For more information, see the user documentation for your CSTA client application.
Table 55 Supported CSTA Services and Events
Function Supported Services and Events
Call Control • Make Call
• Answer Call
• Clear Connection
• Reconnect
• Hold Call
• Retrieve Call (Resume)
• Deflect Call (only at alerting state)
• Single Step Transfer Call
• Consultation Call
• Transfer Call
• Alternate Call Generate Digits (DTMF)
Logical Phone Features • Get Do Not Disturb
• Set Do Not Disturb
• Get CFwdALL
• Set CFwdAll
How to Configure CTI CSTA Protocol Suite
Table 56 contains a list of tasks required to enable a computer-based CSTA client application to control
IP phones in Cisco Unified CME, presented in the order in which the tasks are to be completed. This
document contains information about performing tasks in the first 2 steps in this table and procedures
for completing step 3.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1167
Configuring CTI CSTA Protocol Suite
How to Configure CTI CSTA Protocol Suite
Table 56 Tasks to Configure Interoperability between a CSTA Client Application and
Cisco Unified CME
Step Task Name of Document
1 Verify that the appropriate version of Cisco Unified —
Communications Manager Express
(Cisco Unified CME) is installed on the router.
2 Configure Cisco Unified CME including AXL user See Prerequisites, page 1168.
name and password for the computer-based CSTA
client application, if required.
Tip Note the AXL user ID and password of
application and IP address of the
Cisco Unified CME router.
Note AXL credential is not required for a MOC
clients.
3 Configure Cisco Unified CME to enable See list below.
interoperability with CSTA client application.
4 Install CSTA client application. See documentation for your
5 Configure CSTA client application for application.
Cisco Unified CME including SIP URI of CTI
gateway front-end or client application.
This section contains the following tasks:
• Enabling CTI CSTA in Cisco Unified CME, page 1168 (required)
• Creating a Session Manager, page 1171 (optional)
• Configuring a Number or Device for CTI CSTA Operations, page 1173(required)
• Clearing a Session Between a CTSA Client Application and Cisco Unified CME, page 1177
(optional)
Enabling CTI CSTA in Cisco Unified CME
To configure Cisco Unified CME to enable interoperability between Cisco Unified CME and a
computer-based CSTA client application, perform the following steps.
Prerequisites
• Cisco Unified CME 8.0 or a later version must be installed and configured on the Cisco router.
• (Not required for MOC client) XML API must be configured to create an AXL username for some
CSTA client application access. To determine if an AXL username is required for your application,
see your application documentation. For configuration information, see “Configuring the XML
API” in the Cisco Unified CME Administrator Guide.
Cisco Unified Communications Manager Express System Administrator Guide
1168 OL-10663-02
Configuring CTI CSTA Protocol Suite
How to Configure CTI CSTA Protocol Suite
Note During the initial setup of the CSTA client application, you need the router IP address that was
configured using the ip source-address command in telephony-service configuration mode. For some
client applications, you may also need the AXL username and password that is configured using the xml
user command in telephony-service configuration mode.
SUMMARY STEPS
1. enable
2. configure terminal
3. voice service voip
4. allow-connections sip-to-sip
5. no supplementary-service sip moved-temporary
6. no supplementary-service sip-refer
7. no cti shutdown
8. callmonitor
9. gcid
10. cti csta mode basic
11. cti message device-id suppress-conversion
12. sip
13. registrar server [expires [max sec][min sec]
14. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice service voip Enters voice-service configuration mode and specifies
voice-over-IP encapsulation.
Example:
Router(config)# voice service voip
Step 4 allow-connections sip-to-sip Allows connections between specific types of endpoints in
a VoIP network.
Example:
Router(config-voi-serv)# allow-connections
sip-to-sip
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1169
Configuring CTI CSTA Protocol Suite
How to Configure CTI CSTA Protocol Suite
Command or Action Purpose
Step 5 no supplementary-service sip moved-temporary Disables supplementary service for call forwarding.
Example:
Router(config-voi-serv)# no
supplementary-service sip moved-temporary
Step 6 no supplementary-service sip refer Prevents the router from forwarding a REFER message to
the destination for call transfers.
Example:
Router(config-voi-serv)# no
supplementary-service sip refer
Step 7 no cti shutdown Enables CTI integration.
Example:
Router(config-voi-serv)# no cti shutdown
Step 8 callmonitor (Optional) Enables call monitoring messaging functionality
for processing and reporting.
Example: • This command is not required for MOC client.
Router(config-voi-serv)# callmonitor
Step 9 gcid (Optional) Enables Global Call-ID (Gcid) for call control
purposes.
Example: • This command is not required for MOC client.
Router(config-voi-serv)# gcid
Step 10 allow-connections sip to sip Allows connections between specific types of endpoints in
a VoIP network.
Example:
Router(config-voi-serv)# allow-connections sip
to sip
Step 11 cti csta mode basic (Optional) Suppresses enhanced feature/extension in CTI
messages.
Example: • Required for MOC client.
Router(config-voi-serv)# cti csta mode basic
Step 12 cti message device-id suppress-conversion (Optional) Suppresses conversion or promotion of
extension numbers of associated endpoints in CTI
messages.
Example:
Router(config-voi-serv)# cti message device-id • This command is not required for MOC client.
suppress-conversion
Step 13 sip Enters SIP configuration mode.
• Required only if you perform the following step for
Example: enabling the SIP registrar function in
Router(config-voi-serv)# sip Cisco Unified CME.
Cisco Unified Communications Manager Express System Administrator Guide
1170 OL-10663-02
Configuring CTI CSTA Protocol Suite
How to Configure CTI CSTA Protocol Suite
Command or Action Purpose
Step 14 registrar server [expires [max sec][min sec]] (Optional) Enables SIP registrar functionality in
Cisco Unified CME.
Example: • max sec—(Optional) Maximum time for a registration
Router(config-voi-sip)# registrar server to expire, in seconds. Range: 600 to 86400.
expires max 600 min 60 Default: 3600. Recommended value: 600.
Note Ensure that the registration expiration timeout is set
to a value smaller than the TCP connection aging
timeout to avoid disconnection from the TCP.
• This command is not required for MOC client.
Step 15 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-voi-sip)# end
Examples
The following example shows the required configuration for supporting interaction with a MOC client:
voice service voip
allow-connections sip to sip
no supplementary-service sip moved-temporarily
no supplementary-service sip refer
no cti shutdown
cti csta mode basic
!
!
!
What to Do Next
• If you are configuring Cisco Unified CME to interact with a MOC client, go to the “Configuring a
Number or Device for CTI CSTA Operations” section on page 1173.
• If you are configuring a CSTA client application that requires a session server in
Cisco Unified CME, go to the “Creating a Session Manager” section on page 1171.
Creating a Session Manager
To configure a session manager in Cisco Unified CME for a CSTA client application, perform the
following steps.
Note • This task is not required for a MOC client.
• A single Cisco Unified CME can support multiple session managers.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1171
Configuring CTI CSTA Protocol Suite
How to Configure CTI CSTA Protocol Suite
SUMMARY STEPS
1. enable
2. configure terminal
3. voice register global
4. mode cme
5. exit
6. voice register session-server session-server-tag
7. cti-aware
8. register-id name
9. keepalive seconds
10. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 voice register global Enters voice register global configuration mode.
Example:
Router(config)# voice register global
Step 4 mode cme Enables mode for provisioning SIP devices in
Cisco Unified CME.
Example:
Router(voice-register-global)# mode cme
Step 5 exit Exits to global configuration mode.
Example:
Router(voice-register-global)# configure
terminal
Step 6 voice register session-server Enters voice register session-server configuration mode to
session-server-tag enable and configure a session manager.
• Range: 1 to 8.
Example:
Router(config)# voice register session-server 1
• A single Cisco Unified CME can support multiple
session managers.
Cisco Unified Communications Manager Express System Administrator Guide
1172 OL-10663-02
Configuring CTI CSTA Protocol Suite
How to Configure CTI CSTA Protocol Suite
Command or Action Purpose
Step 7 cti-aware Binds this session manager to the CTI subsystem and
enables CTI-specific Register heartbeat.
Example:
Router(config-register-fs)# cti-aware
Step 8 register-id name Creates an ID for explicitly identifying the CSTA client
application during Register requests.
Example: • name—String for identifying application. Can contain
Router(config-register-fs)# register app1 1 to 30 alphanumeric characters.
Step 9 keepalive seconds Keepalive duration for registration, in seconds, after which
the registration expires unless the application reregisters
before the registration expiry.
Example:
Router(config-register-fs)# keepalive 60 • Range: 60 to 3600. Default: 300.
Step 10 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-register-fs)# end
Examples
!
voice register global
mode cme
source-address 10.0.0.1 port 5060
!
!
voice register session-server 1
keepalive 60
register-id app1
cti-aware
!
Configuring a Number or Device for CTI CSTA Operations
To configure a directory number or an IP phone for CTI CSTA operations, perform the following steps
for each number or phone to be monitored and controlled by the CSTA client application.
Prerequisite
• Directory number or IP phone to be controlled and monitored by the application is configured in
Cisco Unified CME. For configuration information, see “Configuring Phones to Make Basic Calls”
on page 139.
• Extension Mobility (EM) phone to be controlled and monitored by the application must be
configured in Cisco Unified CME, including the required user profiles. For information, see the
“Configuring Extension Mobility” on page 875.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1173
Configuring CTI CSTA Protocol Suite
How to Configure CTI CSTA Protocol Suite
Restrictions
• Only SCCP IP phones can be controlled by a CSTA client application. The Cisco VG224 Analog
Phone Gateway and analog and SIP phones are supported as usual in Cisco Unified CME, however,
not as IP phones for a CSTA client application.
• Overlay DNs are not supported on IP phones for a CSTA client application. The Call Monitor
Module in Cisco Unified CME is unable to determine if two inbound calls to the same directory
number are on the same phone or on different phones, as in an overlay configuration. Overlays DNs
are supported as usual in Cisco Unified CME, however, not on IP phones to be controlled or
monitored by a CSTA client application.
• Not all SCCP IP phones support the Prompted Make Call feature in the CTI CSTA protocol suite.
The Cisco VG224 Analog Phone Gateway, Cisco ATAs, and SCCP-controlled FXS ports on Cisco
routers do not support a prompted make-call request from a CSTA client application. Certain
Cisco Unified phone models, including the Cisco Unified 792X and Cisco Unified 793X, may be
unable to complete a prompted make-call request from a CSTA client application.
• Prompted Make Call is not supported on IP phones associated with a MOC Client. Prompted Make
Call is supported as usual in Cisco Unified CME, however, not on IP phones to be controlled by a
MOC client.
• Shared lines are not supported on an IP phone associated with a MOC client. Shared lines are
supported as usual in Cisco Unified CME, however, not on IP phones to be controlled by a MOC
client.
• If the phone to be controlled and monitored by a MOC client is an Extension Mobility (EM) phone,
the MOC client must log into the phone using the credential in an EM user profile when no users
are logged into the EM phone or after an EM user logs in.
SUMMARY STEPS
1. enable
2. configure terminal
3. emadmin login name
4. emadminlogout name
5. ephone-dn tag
6. cti watch
7. cti notify
8. exit
9. telephony-service
10. em external
11. url services url root
12. end
Cisco Unified Communications Manager Express System Administrator Guide
1174 OL-10663-02
Configuring CTI CSTA Protocol Suite
How to Configure CTI CSTA Protocol Suite
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 1 emadmin login name ephone-tag (Optional) Enables application to log in to an IP phone that
is enabled for Extension Mobility.
Example: • name—Credential in Extension Mobility user profile
Router# emadmin login user204 2 configured with the user (voice user-profile) command.
• ephone-tag—Identifier for IP phone that is enabled for
Extension Mobility.
• Required for MOC client if the MOC client will control
the number or device to be configured.
Step 1 emadmin logout name (Optional) Logs the application out of the Extension
Mobility phone.
Example: • name—Credential in Extension Mobility that the
Router# emadmin logout user204 application used to log into an Extension Mobility
phone.
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone-dn tag Enters ephone-dn configuration mode.
Example:
Router(config)# ephone-dn 1
Step 4 cti watch Allows this directory number to be monitored and
controlled by a CSTA client application.
Example: • This command can also be configured in
Router(config-ephone-dn)# cti watch ephone-dn-template configuration mode. The value set
in ephone-dn configuration mode has priority over the
value set in ephone-dn-template mode.
Step 5 cti notify (Optional) Forces ephone-dn into constant “up” state to
allow CTI operations on this directory number.
Example: • Required if ephone-dn to be monitored/controlled is not
Router(config-ephone-dn)# cti notify associated with a physical device.
• This command can also be configured in
ephone-dn-template configuration mode. The value set
in ephone-dn configuration mode has priority over the
value set in ephone-dn-template mode.
Step 6 exit Exits ephone-dn configuration mode.
Example:
Router(config-ephone-dn)# exit
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1175
Configuring CTI CSTA Protocol Suite
How to Configure CTI CSTA Protocol Suite
Command or Action Purpose
Step 7 telephony-service Enters telephony-service configuration mode.
• Required only if you perform the following steps for
Example: configuring the Services menu on an IP phone.
Router(config)# telephony-service
Step 8 em external (Optional) Removes login page for Extension Mobility
from the Services menu on IP phones.
Example:
Router(config-telephony)# em external
Step 9 url services url root (Optional) Provides menu of root phone services under the
Services button on IP phones.
Example: • url—URL for external menu of root phone services
Router(config-telephony)# url services provided by an application
http://my_application/menu.html root
Step 10 end Exits configuration mode and enters privileged EXEC
mode.
Example:
Router(config-telephony)# end
Examples
!
voice logout-profile 1
number 203 type normal
!
voice user-profile 1
user user204 password psswrd
number 204 type normal
!
.
.
.
ephone-dn 1
number 201
cti watch
!
!
ephone-dn 2
number 202
cti watch
!
!
ephone-dn 3
number 203
cti watch
!
!
ephone-dn 4
number 204
cti notify
cti watch
!
!
ephone 1
mac-address 001E.4A34.A35F
Cisco Unified Communications Manager Express System Administrator Guide
1176 OL-10663-02
Configuring CTI CSTA Protocol Suite
Configuration Examples for CTII CSTA Protocol Suite
type 7961
button 1:1
!
!
!
ephone 2
mac-address 000F.8FC7.B681
type 7960
button 1:2
!
!
!
ephone 3
mac-address 0019.E7FF.1E30
type 7961
logout-profile 1
Clearing a Session Between a CTSA Client Application and Cisco Unified CME
To gracefully tear down a CTI session between a CSTA client application and Cisco Unified CME,
perform the following steps.
Prerequisites
• Cisco Unified CME 8.0 or a later version
• To determine the session ID, use the show cti session command.
SUMMARY STEPS
1. enable
2. clear cti session id session-tag
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 clear cti session id session-tag Clears the session between a CSTA client application and
Cisco Unified CME.
Example:
Router# clear cti session id 3
Configuration Examples for CTII CSTA Protocol Suite
This section contains the following configuration examples:
• MOC Client: Example, page 1178
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1177
Configuring CTI CSTA Protocol Suite
Configuration Examples for CTII CSTA Protocol Suite
• CSTA Client Application Requiring a Session Manager: Example, page 1180
MOC Client: Example
!
version 12.4
service timestamps debug datetime msec
service timestamps log datetime msec
no service password-encryption
!
hostname sdatar-2811s
!
boot-start-marker
boot system flash c2800nm-ipvoice-mz.oct_20090510
boot-end-marker
!
logging message-counter syslog
!
no aaa new-model
!
ip source-route
!
!
ip cef
!
ip dhcp pool test
network 10.0.0.0 255.255.255.0
option 150 ip 10.0.0.1
default-router 10.0.0.1
!
!
no ipv6 cef
multilink bundle-name authenticated
!
!
voice service voip
allow-connections sip to sip
no supplementary-service sip moved-temporarily
no supplementary-service sip refer
no cti shutdown
cti csta mode basic
!
!
!
!
voice logout-profile 1
number 203 type normal
!
voice user-profile 1
user user204 password psswrd
number 204 type normal
!
voice-card 0
!
!
!
archive
log config
hidekeys
!
!
Cisco Unified Communications Manager Express System Administrator Guide
1178 OL-10663-02
Configuring CTI CSTA Protocol Suite
Configuration Examples for CTII CSTA Protocol Suite
!
interface FastEthernet0/0
ip address 10.0.0.1 255.255.255.0
duplex auto
speed auto
!
interface Service-Engine0/0
no ip address
shutdown
!
interface FastEthernet0/1
ip address 1.5.41.5 255.255.0.0
duplex auto
speed auto
!
ip forward-protocol nd
ip route 0.0.0.0 0.0.0.0 10.1.43.254
ip route 223.255.254.254 255.255.255.255 1.5.0.1
!
!
ip http server
!
!
ixi transport http
response size 64
no shutdown
request outstanding 1
request timeout 60
!
ixi application cme
no shutdown
!
!
!
control-plane
!
!
!
voice-port 0/0/0
!
voice-port 0/0/1
!
voice-port 0/0/2
!
voice-port 0/0/3
!
!
mgcp fax t38 ecm
!
!
!
sip-ua
!
!
telephony-service
em logout 1:0
max-ephones 10
max-dn 100
ip source-address 10.0.0.1 port 2000
url authentication http://10.0.0.1/CCMCIP/authenticate.asp
cnf-file location flash:
cnf-file perphone
max-conferences 8 gain -6
transfer-system full-consult
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1179
Configuring CTI CSTA Protocol Suite
Configuration Examples for CTII CSTA Protocol Suite
create cnf-files version-stamp Jan 01 2002 00:00:00
!
ephone-dn 1
number 201
cti watch
!
!
ephone-dn 2
number 202
cti watch
!
!
ephone-dn 3
number 203
cti watch
!
!
ephone-dn 4
number 204
cti notify
cti watch
!
!
ephone 1
mac-address 001E.4A34.A35F
type 7961
button 1:1
!
!
!
ephone 2
mac-address 000F.8FC7.B681
type 7960
button 1:2
!
!
!
ephone 3
mac-address 0019.E7FF.1E30
type 7961
logout-profile 1
CSTA Client Application Requiring a Session Manager: Example
!
version 12.4
service timestamps debug datetime msec
service timestamps log datetime msec
no service password-encryption
!
hostname sdatar-2811s
!
boot-start-marker
boot system flash c2800nm-ipvoice-mz.oct_20090510
boot-end-marker
!
logging message-counter syslog
!
no aaa new-model
!
ip source-route
Cisco Unified Communications Manager Express System Administrator Guide
1180 OL-10663-02
Configuring CTI CSTA Protocol Suite
Configuration Examples for CTII CSTA Protocol Suite
!
!
ip cef
!
ip dhcp pool test
network 10.0.0.0 255.255.255.0
option 150 ip 10.0.0.1
default-router 10.0.0.1
!
!
no ipv6 cef
multilink bundle-name authenticated
!
!
voice service voip
no cti shutdown
csta cti mode basic
sip
registrar server expires max 120 min 60
!
voice register global
mode cme
source-address 10.0.0.1 port 5060
!
voice register session-server 1
keepalive 60
register-id apps
cti-aware
!
!
voice logout-profile 1
number 203 type normal
!
voice user-profile 1
user user204 password cisco
number 204 type normal
!
!
!
voice-card 0
!
!
!
archive
log config
hidekeys
!
!
!
interface FastEthernet0/0
ip address 10.0.0.1 255.255.255.0
duplex auto
speed auto
!
interface Service-Engine0/0
no ip address
shutdown
!
interface FastEthernet0/1
ip address 1.5.41.5 255.255.0.0
duplex auto
speed auto
!
ip forward-protocol nd
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1181
Configuring CTI CSTA Protocol Suite
Configuration Examples for CTII CSTA Protocol Suite
ip route 0.0.0.0 0.0.0.0 10.1.43.254
ip route 223.255.254.254 255.255.255.255 1.5.0.1
!
!
ip http server
!
!
ixi transport http
response size 64
no shutdown
request outstanding 1
request timeout 60
!
ixi application cme
no shutdown
!
!
!
control-plane
!
!
!
voice-port 0/0/0
!
voice-port 0/0/1
!
voice-port 0/0/2
!
voice-port 0/0/3
!
!
mgcp fax t38 ecm
!
!
!
!
sip-ua
!
!
telephony-service
em logout 1:0
max-ephones 10
max-dn 100
ip source-address 10.0.0.1 port 2000
url authentication http://10.0.0.1/CCMCIP/authenticate.asp
cnf-file location flash:
cnf-file perphone
max-conferences 8 gain -6
transfer-system full-consult
create cnf-files version-stamp Jan 01 2002 00:00:00
!
!
ephone-dn 1
number 201
cti watch
!
!
ephone-dn 2
number 202
cti watch
!
!
ephone-dn 3
number 203
Cisco Unified Communications Manager Express System Administrator Guide
1182 OL-10663-02
Configuring CTI CSTA Protocol Suite
Configuration Examples for CTII CSTA Protocol Suite
cti watch
!
!
ephone-dn 4
number 204
cti notify
cti watch
!
!
ephone 1
mac-address 001E.4A34.A35F
type 7961
button 1:1
!
!
!
ephone 2
mac-address 000F.8FC7.B681
type 7960
button 1:2
!
!
!
ephone 3
mac-address 0019.E7FF.1E30
type 7961
logout-profile 1
!
!
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1183
Configuring CTI CSTA Protocol Suite
Additional References
Additional References
The following sections provide references related to Cisco Unified CME 8.0.
Related Documents
Related Topic Document Title
Cisco Unified Communications Manager Express • Cisco Unified CME Command Reference
configuration
• Cisco Unified CME documentation roadmap
Cisco IOS voice configuration • Cisco IOS Release 12.4T configuration documentation roadmap
• Cisco IOS Voice Command Reference
SIP gateway configuration • Cisco IOS SIP Configuration Guide
Standards
Standard Title
ECMA-269 Services for Computer Supported Telecommunications Applications
(CSTA) Phase III
ECMA-323 XML Protocol for Computer Supported Telecommunications
Applications (CSTA) Phase III
ECMA-348 Web Services Description Language (WSDL) for CSTA Phase III
MIBs
MIB MIBs Link
No new or modified MIBs are supported by this To locate and download MIBs for selected platforms, Cisco IOS
feature, and support for existing MIBs has not been releases, and feature sets, use Cisco MIB Locator found at the
modified by this feature. following URL:
http://www.cisco.com/go/mibs
RFCs
RFC Title
RFC 2396 URI Generic Syntax
Cisco Unified Communications Manager Express System Administrator Guide
1184 OL-10663-02
Configuring CTI CSTA Protocol Suite
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1185
Configuring CTI CSTA Protocol Suite
Feature Information for CTI CSTA Protocol Suite
Feature Information for CTI CSTA Protocol Suite
Table 57 lists the release history for this feature.
Not all commands may be available in your Cisco IOS software release. For release information about a
specific command, see the command reference documentation.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS and Catalyst OS software images
support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note This table lists only the Cisco IOS software release that introduced support for a given feature in a given
Cisco IOS software release train. Unless noted otherwise, subsequent releases of that Cisco IOS
software release train also support that feature.
Table 57 Feature Information for CTI CSTA Protocol Suite
Cisco Unified CME
Feature Name Version Feature Information
CTI CSTA Protocol Suite in 8.0 Introduces industry-standard Computer Telephony
Cisco Unified CME Integration (CTI) interface that enables computer-based
CSTA client applications to interact directly with
Cisco Unified CME to monitor/control IP phones.
The following commands are new or modified for this
feature: clear csta session, cti-aware, cti csta mode, cti
message device-id suppress-conversion, cti notify, cti
shutdown, cti watch, debug cti, debug cti callmon,
emadmin login, emadmin logout, em external, show cti,
url (telephony-service)
Cisco Unified Communications Manager Express System Administrator Guide
1186 OL-10663-02
Configuring SRST Fallback Mode
Last Updated: October 7, 2009
This chapter describes SRST fallback mode using Cisco Unified Communications Manager Express
(Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for SRST Fallback
Mode” section on page 1203.
Contents
• Prerequisites for SRST Fallback Mode, page 1187
• Restrictions for SRST Fallback Mode, page 1188
• Information About SRST Fallback Mode, page 1188
• How to Configure SRST Fallback Mode, page 1192
• Configuration Examples for SRST Fallback Mode, page 1198
• Additional References, page 1202
• Feature Information for SRST Fallback Mode, page 1203
Prerequisites for SRST Fallback Mode
• The IP address of the Cisco Unified CME router must be registered as the SRST reference on the
Cisco Unified Communications Manager device pool.
• Cisco Unified CME 4.0 or a later version must be installed on the Cisco Unified CME router that is
configured in SRST mode.
• Following tasks must be completed:
– “Generating Configuration Files for Phones” on page 261.
– “Configuring System-Level Parameters” on page 101. Note that the max-dn command must be
explicity configured with the preference keyword to support calls between PSTN and IP phones
during SRST fallback mode.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1187
Configuring SRST Fallback Mode
Restrictions for SRST Fallback Mode
– “Generating Configuration Files for Phones” on page 261.
– “Configuring Call Transfer and Forwarding” on page 595.
Restrictions for SRST Fallback Mode
• The call-manager-fallback command, which is used to configure Cisco Unified SRST, cannot be
used on a router that is configured for Cisco Unified CME.
• The telephony-service setup command and auto assign command must not be enabled on a
Cisco Unified CME router configured for SRST fallback mode. If you used the telephony-service
setup command before configuring the router for SRST fallback support, you must remove any
unwanted ephone directory numbers created by the setup process.
• The number of phones that fall back to a Cisco Unified CME router in SRST mode cannot exceed
the maximum number of phones that is supported by the router. To find the maximum number of
phones for a particular router and Cisco Unified CME version, see the appropriate Cisco CME
Supported Firmware, Platforms, Memory, and Voice Products document at
http://www.cisco.com/en/US/products/sw/voicesw/ps4625/products_device_support_tables_list.ht
ml.
• The ephone-dns and ephones that are created from fallback may have less information associated
with them than appears in their original configuration on a Cisco Unified Communications Manager
or on an active Cisco Unified CME system. This situation occurs because the Cisco Unified CME
router in SRST mode is designed to learn only a limited amount of information from the fallback IP
phones. For example, if an ephone-dn has in its configuration the command number 4888 no-reg
(to keep that extension from registering under its E.164 address), after fallback the no-reg part of
this command will be lost because this information cannot be learned from the IP phones.
• The order of the SRST fallback ephone-dns and ephones will be different from the order of the active
Cisco Unified Communications Manager or Cisco Unified CME ephone-dns and ephones. For
example, ephone 1 on an active Cisco Unified Communications Manager might be numbered
ephone 5 on the Cisco Unified CME router in SRST mode, because the order of learned ephone-dns
and ephones is determined by the sequence of the ephone fallback occurrence, which is random.
Information About SRST Fallback Mode
To configure SRST fallback mode, you should understand the following concepts:
• SRST Fallback Mode Using Cisco Unified CME, page 1188
• Prebuilding Cisco Unified CME Phone Configurations, page 1192
• Autoprovisioning Directory Numbers in SRST Fallback Mode, page 1192
SRST Fallback Mode Using Cisco Unified CME
This feature enables routers to provide call-handling support for Cisco Unified IP phones if they lose
connection to remote primary, secondary, or tertiary Cisco Unified Communications Manager
installations or if the WAN connection is down. When Cisco Unified SRST functionality is provided by
Cisco Unified CME, provisioning of phones is automatic and most Cisco Unified CME features are
available to the phones during periods of fallback, including hunt-groups, call park and access to
Cisco Unified Communications Manager Express System Administrator Guide
1188 OL-10663-02
Configuring SRST Fallback Mode
Information About SRST Fallback Mode
Cisco Unity voice messaging services using SCCP protocol. The benefit is that
Cisco Unified Communications Manager users will gain access to more features during fallback without
any additional licensing costs.
This feature offers a limited telephony feature set during fallback mode. Customers who require the
following features should continue to use Cisco Unified SRST, because these features are not supported
with SRST fallback support using Cisco Unified CME.
• More than 240 phones during fallback service
• Cisco VG 248 Analog Phone Gateway support
• Secure voice fallback during SRST fallback service
• Simple, one-time configuration for SRST fallback service
Cisco Unified Communications Manager supports Cisco Unified IP phones at remote sites attached to
Cisco Integrated Services Routers across the WAN. This new feature combines the many features
available in Cisco Unified CME with the ability to automatically detect IP phone configurations that is
available in Cisco Unified SRST to provide seamless call handling when communication with the
Cisco Unified Communications Manager is interrupted.
When the system automatically detects a failure, Cisco Unified SRST uses Simple Network Auto
Provisioning (SNAP) technology to auto-configure a branch office router to provide call processing for
the Cisco Unified IP phones that are registered with the router. When the WAN link or connection to the
primary Cisco Unified Communications Manager is restored, call handling returns to the primary
Cisco Unified Communications Manager.
A limited number of phone features are automatically detected at the time that call processing falls back
to Cisco Unified CME in SRST Fallback Mode, and an advantage of SRST fallback support using
Cisco Unified CME is that you can choose to prebuild a Cisco Unified CME configuration that contains
a number of extensions (ephone-dns) with additional features that you want them to have for some or all
of your extensions. The configurations will contain ephone-dn configurations but will not identify which
phones (which MAC addresses) will be associated with which ephone-dns (extension numbers).
By copying and pasting a prebuilt configuration onto Cisco Unified CME routers at several locations,
you can use the same overall configuration for sites that are identically laid out. For example, if you have
a number of retail stores, each with five to ten checkout registers, you can use the same overall
configuration in each store. You might use a range of extensions from 1101 to 1110. Stores with fewer
than ten registers will simply not use some of the ephone-dn entries you provide in the configuration.
Stores with more extensions than you have prebuilt will use the auto-provisioning feature to populate
their extra phones. The only configuration variations from store to store will be the specific MAC
addresses of the individual phones, which are added to the configurations at the time of fallback.
When a phone registers for SRST service with a Cisco Unified CME router and the router discovers that
the phone was configured with a specific extension number, the router searches for an existing prebuilt
ephone-dn with that extension number and then assigns that ephone-dn number to the phone. If there is
no prebuilt ephone-dn with that extension number, the Cisco Unified CME system automatically creates
one. In this way, extensions without prebuilt configurations are automatically populated with extension
numbers and features as the numbers and features are “learned” by the Cisco Unified CME router in
SRST mode when the phone registers to the router after a WAN link fails.
The SRST fallback support using Cisco Unified CME feature is able to interrogate phones to learn their
MAC addresses and the extension-to-ephone relationships associated with each phone. This information
is used to dynamically create and execute the Cisco Unified CME button command for each phone and
automatically provision each phone with the extensions and features you want it to have.
The following sequence describes how Cisco Unified CME provides SRST services for
Cisco Unified Communications Manager phones when they lose connectivity with the
Cisco Unified Communications Manager and fall back to the Cisco Unified CME router in SRST mode:
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1189
Configuring SRST Fallback Mode
Information About SRST Fallback Mode
Before Fallback
1. Phones are configured as usual in Cisco Unified Communications Manager.
2. The IP address of the Cisco Unified CME router is registered as the SRST reference on the
Cisco Unified Communications Manager device pool.
3. SRST mode is enabled on the Cisco Unified CME router.
4. (Optional) Ephone-dns and features are prebuilt on the Cisco Unified CME router.
During Fallback
5. Phones that are enabled for fallback register to the default Cisco Unified CME router that has SRST
mode enabled. Each display-enabled IP phone displays the message that has been defined using the
system message command under telephony-service configuration mode. By default, this message is
“Cisco Unified CME.”
6. While the fallback phones are registering, the router in SRST mode initiates an interrogation of the
phones in order to learn their phone and extension configurations. The following information is
acquired or “learned” by the router:
– MAC address
– Number of lines or buttons
– Ephone-dn-to-button relationship
– Speed-dial numbers
7. The option defined with the srst mode auto-provision command determines whether
Cisco Unified CME adds the learned phone and extension information to its running configuration.
If the information is added, it appears in the output when you use the show running-config
command and is saved to NVRAM when you use the write command.
– Use the srst mode auto-provision none command to enable the Cisco Unified CME router to
provide SRST fallback services for Cisco Unified Communications Manager.
– If you use the srst mode auto-provision dn or srst mode auto-provision all commands, the
Cisco Unified CME router includes the phone configuration it learns from
Cisco Unified Communications Manager in its running configuration. If you then save the
configuration, the fallback phones are treated as locally configured phones on the
Cisco Unified CME-SRST router which could adversely impact the fallback behavior of those
phones.
8. While in fallback mode, Cisco Unified IP phones periodically attempt to reestablish a connection
with Cisco Unified Communications Manager every 120 seconds (default). To manually reestablish
a connection to Cisco Unified Communications Manager you can reboot the Cisco Unified IP
phone.
9. When a connection is reestablished with Cisco Unified Communications Manager,
Cisco Unified IP phones automatically cancel their registration with the Cisco Unified CME router
in SRST mode. However, if a WAN link is unstable, Cisco Unified IP phones can bounce between
Cisco Unified Communications Manager and the Cisco Unified CME router in SRST mode.
An IP phone connected to the Cisco Unified CME-SRST router over a WAN reconnects itself to
Cisco Unified Communications Manager as soon as it can establish a connection to
Cisco Unified Communications Manager over the WAN link. However, if the WAN link is
unstable, the IP phone switches back and forth between Cisco Unified CME-SRST and
Cisco Unified Communications Manager, causing temporary loss of phone service (no dial tone).
These reconnect attempts, known as WAN link flapping issues, continue until the IP phone
successfully reconnects itself back to Cisco Unified Communications Manager.
Cisco Unified Communications Manager Express System Administrator Guide
1190 OL-10663-02
Configuring SRST Fallback Mode
Information About SRST Fallback Mode
WAN link disruptions can be classified into two types: infrequent random outages that occur on an
otherwise stable WAN, and sporadic, frequent disruptions that last a few minutes.
To resolve WAN-link flapping issues between Cisco Unified Communications Manager and SRST,
Cisco Unified Communications Manager provides an enterprise parameter and a setting in the
Device Pool Configuration window called Connection Monitor Duration. (Depending on system
requirements, the administrator decides which parameter to use.) The value of the parameter is
delivered to the IP phone in the XML configuration file.
• Use the enterprise parameter to change the connection duration monitor value for all IP phones
in the Cisco Unified Communications Manager cluster. The default for the enterprise parameter
is 120 seconds.
• Use the Device Pool Configuration window to change the connection duration monitor value for
all IP phones in a specific device pool.
A Cisco Unified IP phone will not reestablish a connection with the primary
Cisco Unified Communications Manager at the central office if it is engaged in an active call.
After the First Fallback
Additional features can be set up, such as ephone hunt groups, which can contain learned extensions and
prebuilt extensions. The complete core set of Cisco Unified CME phone features is available to the IP
phones and extensions, whether they are learned or configured.
Figure 42 shows a branch office with several Cisco Unified IP phones connected to a
Cisco Unified CME router in SRST fallback mode. The router provides connections to both a WAN link
and the PSTN. The Cisco Unified IP phones connect to their primary Cisco Unified Communications
Manager at the central office via this WAN link. Cisco Unified CME provides SRST services for the
phones when connectivity over the WAN link is interrupted.
Figure 42 SRST Fallback Support using Cisco Unified CME
Telephone Telephone
Fax
Cisco Unified CallManager
PSTN
V
Cisco Unified CME IP
router in SRST mode network
WAN
IP IP IP Cisco Unified IP phones disconnected
146571
PCs
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1191
Configuring SRST Fallback Mode
How to Configure SRST Fallback Mode
Prebuilding Cisco Unified CME Phone Configurations
Prebuilding Cisco Unified CME ephone-dns allows you to create a set of directory numbers with
extension numbers and some features, which will provide service during fallback that is similar to the
service that is provided during normal operation. You can prebuild all of your normal extensions, a
limited set of your extensions, or none of your extensions. Directory numbers that are not prebuilt will
be populated with extension numbers and features as they are “learned” by the Cisco Unified CME
router in SRST mode at the time of fallback.
An ephone-dn is the IP equivalent of a normal phone line in most cases. It represents a potential call
connection and is associated with a virtual voice port and virtual dial peer. An ephone-dn has one or more
extension or telephone numbers associated with it, which allow call connections to be made. An
ephone-dn can be single-line, which allows one call connection to be made at a time, or dual-line, which
allows two simultaneous call connections. Dual-line ephone-dns are useful for features such as call
transfer or call waiting, in which one call is put on hold to connect to another. Single-line ephone-dns
are required for certain features such as intercom, paging, and message-waiting indication (MWI). For
more information, see “Cisco Unified CME Overview” on page 17.
If an ephone-dn is manually configured in Cisco Unified CME, incoming calls will always route to the
manually configured ephone-dn in Cisco Unified CME rather than to Cisco Unified
Communications Manager using the voip dial peer. To avoid incorrect routing, configure a higher
preference for the voip dial peer than the preference for the prebuilt directory number. For configuration
example, see “Prebuilding DNs: Example” section on page 1202.
Autoprovisioning Directory Numbers in SRST Fallback Mode
Cisco Unified CME 4.3 and later versions support octo-line directory numbers in SRST fallback mode.
You can specify whether Cisco Unified CME in SRST fallback mode creates octo-line or dual-line
directory numbers based on the phone type. For the Cisco Unified IP Phone 7902 or 7920, or an analog
phone connected to the Cisco VG224 or Cisco ATA, the system creates a dual-line directory number; it
creates an octo-line directory number for all other phone types. This applies only to the ephone-dns that
are “learned” automatically from ephone configuration information, and not to ephone-dns that are
manually configured in Cisco Unified CME.
How to Configure SRST Fallback Mode
This section contains the following tasks:
• Enabling SRST Fallback Mode, page 1193 (required)
• Verifying SRST Fallback Mode, page 1196 (optional)
• Prebuilding Cisco Unified CME Phone Configurations, page 1197 (optional)
• Modifying Call Pickup for Fallback Support, page 1197 (optional)
Cisco Unified Communications Manager Express System Administrator Guide
1192 OL-10663-02
Configuring SRST Fallback Mode
How to Configure SRST Fallback Mode
Enabling SRST Fallback Mode
To enable SRST mode on the Cisco Unified CME router, perform the following steps.
Restrictions
Do not enable the telephony-service setup command or auto assign command on a Cisco Unified CME
router that you are configuring for SRST fallback mode. If you used the telephony-service setup
command previously on the router, you must remove any unwanted ephone directory numbers created
by the setup process.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. srst mode auto-provision {all | dn | none}
5. srst dn line-mode {dual | dual-octo | octo | single}
6. srst dn template template-tag
7. srst ephone template template-tag
8. srst ephone description string
9. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1193
Configuring SRST Fallback Mode
How to Configure SRST Fallback Mode
Command or Action Purpose
Step 4 srst mode auto-provision {all | dn | none} Enables SRST mode for a Cisco Unified CME router.
• all—Includes information for learned ephones and
Example: ephone-dns in the running configuration.
Router(config-telephony)# srst mode
auto-provision none
• dn—Includes information for learned ephone-dns in
the running configuration.
• none—Does not include information for learned
ephones or learned ephone-dns in the running
configuration. Use this keyword when you want
Cisco Unified CME to provide SRST fallback services
for Cisco Unified Communications Manager.
Step 5 srst dn line-mode {dual | dual-octo | octo | (Optional) Specifies the line mode for ephone-dns in SRST
single} mode on a Cisco Unified CME router.
• dual—SRST fallback ephone-dns are dual-line
Example: ephone-dns.
Router(config-telephony)# srst dn line-mode
dual-octo • dual-octo—SRST fallback ephone-dns are dual-line or
octo-line, depending on the phone type. This keyword
is supported in Cisco Unified CME 4.3 and later
versions.
• octo—SRST fallback ephone-dns are octo-line. This
keyword is supported in Cisco Unified CME 4.3 and
later versions.
• single—SRST fallback ephone-dns are single-line
ephone-dns. Default value.
Note This command is used only when ephone-dns are
learned at the time of fallback. It is ignored when
you prebuild ephone-dn configurations.
Step 6 srst dn template template-tag (Optional) Specifies an ephone-dn template to be used in
SRST mode on a Cisco Unified CME router. The template
includes features that were specified when the template was
Example:
Router(config-telephony)# srst dn template 3
created. See “Configuring Templates for Fallback Support:
Example” on page 1201.
• template-tag—Identifying number of an existing
ephone-dn template. Range is 1 to 15.
Step 7 srst ephone template template-tag (Optional) Specifies an ephone template to be used in SRST
mode on a Cisco Unified CME router.
Example: • template-tag—Identifying number of an existing
Router(config-telephony)# srst ephone ephone template. Range is 1 to 20.
template 5
Cisco Unified Communications Manager Express System Administrator Guide
1194 OL-10663-02
Configuring SRST Fallback Mode
How to Configure SRST Fallback Mode
Command or Action Purpose
Step 8 srst ephone description string (Optional) Specifies a description to be associated with an
ephone learned in SRST mode on a Cisco Unified CME
router.
Example:
Router(config-telephony)# srst ephone • string—Description to be associated with an ephone.
description Cisco Unified CME SRST Fallback Maximum string length is 100 characters.
Step 9 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1195
Configuring SRST Fallback Mode
How to Configure SRST Fallback Mode
Verifying SRST Fallback Mode
Step 1 Use the show telephony-service all or the show running-config command to verify that SRST fallback
mode has been set on this router.
telephony-service
srst mode auto-provision all
srst ephone template 5
srst ephone description srst fallback auto-provision phone : Jul 07 2005 17:45:08
srst dn template 8
srst dn line-mode dual
load 7960-7940 P00305000600
max-ephones 30
max-dn 60 preference 0
ip source-address 10.1.68.78 port 2000
max-redirect 20
system message "SRST Mode: Cisco Unified CME’
keepalive 10
max-conferences 8 gain -6
moh welcome.au
create cnf-files version-stamp Jan 01 2002 00:00:00
Step 2 Use the show telephony-service ephone-dn command during fallback to review ephone-dn
configurations. Learned ephone-dns are noted by a line stating that they were learned during SRST
fallback.
Note Learned ephone-dns do not appear in the output for the show running-config command if the
none keyword is used in the srst mode auto-provision command.
ephone-dn 1 dual-line
number 4008
name 4008
description 4008
preference 0 secondary 9
huntstop
no huntstop channel
call-waiting beep
ephone-dn-template 8
This DN is learned from srst fallback ephones
Step 3 Use the show telephony-service ephone command during fallback to review ephone configurations.
Learned ephones are noted by a line stating that they were learned during SRST fallback.
Note Learned ephones do not appear in the output for the show running-config command if the none
keyword is used in the srst mode auto-provision command.
ephone 1
mac-address 0112.80B3.9C16
button 1:1
multicast-moh
ephone-template 5
Always send media packets to this router: No
Preferred codec: g711ulaw
user-locale JP
network-locale US
Description: "YOUR Description" : Oct 11 2005 09:58:27
This is a srst fallback phone
Cisco Unified Communications Manager Express System Administrator Guide
1196 OL-10663-02
Configuring SRST Fallback Mode
How to Configure SRST Fallback Mode
Prebuilding Cisco Unified CME Phone Configurations
You can optionally create a set of ephone-dns that are preconfigured with extension numbers and some
features to provide service during fallback that is similar to the service that is provided during normal
operation. Extensions that are not prebuilt are populated with extension numbers and features as they are
“learned” by the Cisco Unified CME router in SRST mode at the time of fallback.
Note To avoid incorrect routing when you prebuild ephone-dns for Cisco Unified Communications Manager
phones in Cisco Unified CME, use the preference command in ephone-dn and voip-dial-peer
configuration mode to create a higher preference (0 being the highest) for the voip dial peer than the
preference for the prebuilt directory number. For configuration example, see the “Prebuilding DNs:
Example” section on page 1202.
See the following procedures to set up a few of the most common features to associate with phones in
fallback mode:
• “SCCP: Creating Directory Numbers” section on page 158
• “Enabling Call Park or Directed Call Park” section on page 543
• “SCCP: Enabling Ephone Templates” section on page 1130
• “SCCP: Enabling Ephone-dn Templates” section on page 1132
• “SCCP: Configuring Ephone Hunt Groups” section on page 702. Note that the dial-peer hunt
command must be configured for hunt-selection order of explicit preference to support hunt groups
during SRST fallback mode.
Modifying Call Pickup for Fallback Support
An especially useful feature for fallback phones is modifying the behavior of the Pickup soft key in
Cisco Unified CME to match that of the Pickup soft key in Cisco Unified Communications Manager. To
modify the call pickup feature for fallback support, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. no service directed-pickup
5. create cnf-files
6. reset all
7. exit
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1197
Configuring SRST Fallback Mode
Configuration Examples for SRST Fallback Mode
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 no service directed-pickup (Optional) Disables directed call pickup and changes the
behavior of the PickUp soft key so that a user pressing it
invokes local group pickup rather than directed call pickup.
Example:
Router(telephony)# no service directed-pickup
This behavior is consistent with that of the PickUp soft key
in Cisco Unified Communications Manager.
Note For changes to the service-phone settings to be
effective, the Sep*.conf.xml file must be updated
with the create cnf-files command and the phone
units must rebooted with the reset command.
Step 5 create cnf-files Builds XML configuration files for Cisco Unified IP
phones.
Example:
Router(telephony)# create cnf-files
Step 6 reset all Resets all phones.
Example:
Router(telephony)# reset all
Step 7 exit Exits dial-peer configuration mode.
Example:
Router(telephony)# exit
Configuration Examples for SRST Fallback Mode
This section contains the following examples:
• Enabling SRST Mode: Example, page 1199
• Provisioning Directory Numbers for Fallback Support: Example, page 1200
• Configuring Templates for Fallback Support: Example, page 1201
• Enabling Hunt Groups for Fallback Support: Example, page 1201.
Cisco Unified Communications Manager Express System Administrator Guide
1198 OL-10663-02
Configuring SRST Fallback Mode
Configuration Examples for SRST Fallback Mode
• Modifying Call Pickup for Fallback Support: Example, page 1201
• Prebuilding DNs: Example, page 1202
Enabling SRST Mode: Example
The following example enables SRST mode on the Cisco Unified CME router. It specifies that learned
fallback ephone-dns should be created in dual-line mode and use ephone-dn template 3 for their
configuration parameters. Learned ephones will use the parameters in ephone template 5 and a
description will be associated with the phones.
telephony-service
max-ephones 30
max-dn 60 preference 0
srst mode auto-provision all
srst dn line-mode dual
srst dn template 3
srst ephone description srst fallback auto-provision phone
srst ephone template 5
.
.
.
The following excerpt from the show running-config command displays the configuration of ephone 1,
which was learned during fallback; the description is stamped with the date and time that the show
running-config command was used. The configuration of ephone 2, which was prebuilt rather than
learned, is shown for comparison.
ephone 1
description srst fallback auto-provision phone : Jul 07 2005 17:45:08
ephone-template 5
mac-address 100A.7052.2AAE
button 1:1 2:2
ephone 2
mac-address 1002.CD64.A24A
type 7960
button 1:3
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1199
Configuring SRST Fallback Mode
Configuration Examples for SRST Fallback Mode
The following excerpt from the show running-config command displays the configuration of
ephone-dn 1 through ephone-dn 3. All three ephones are learned ephone-dns that are configured in
dual-line mode and use ephone-dn template 5, as specified in the telephony-service configuration mode
commands.
ephone-dn 1 dual-line
number 7001
description 7001
name 7001
ephone-dn-template 5
This DN is learned from srst fallback ephones
!
!
ephone-dn 2 dual-line
number 4005
name 4005
ephone-dn-template 5
This DN is learned from srst fallback ephones
!
!
ephone-dn 3 dual-line
number 4002
label 4002
name 4002
ephone-dn-template 5
This DN is learned from srst fallback ephones
Provisioning Directory Numbers for Fallback Support: Example
The following example sets up five ephone-dns and two call-park slots that are used for fallback phones.
ephone-dn 1
number 1101
name Register 1
ephone-dn 2
number 1102
name Register 2
ephone-dn 3
number 1103
name Register 3
ephone-dn 4
number 1104
name Register 4
ephone-dn 5
number 1105
name Register 5
ephone-dn 21
number 1121
name Park Slot 1
park-slot timeout 60 limit 3 recall alternate 1100
ephone-dn 22
number 1122
name Park Slot 2
park-slot timeout 60 limit 3 recall alternate 1100
Cisco Unified Communications Manager Express System Administrator Guide
1200 OL-10663-02
Configuring SRST Fallback Mode
Configuration Examples for SRST Fallback Mode
Configuring Templates for Fallback Support: Example
The following example creates ephone-dn template 3 and ephone template 5 that will be used with the
SRST fallback support using Cisco Unified CME feature. Ephone-dn template 3 adds the fallback
phones to pickup group 24 and specifies call forwarding for busy and no-answer conditions to extension
1100. Ephone template 5 defines two fastdial numbers that will appear as menu entries displayed from
the Directories > Local Services > Personal Speed Dials option on the fallback phones, and also specifies
the soft-key layouts for the fallback phones.
ephone-dn-template 3
pickup-group 24
call-forward busy 1100
call-forward noan 1100 timeout 45
ephone-template 5
fastdial 1 1101 name Front Register
fastdial 2 918005550111 Headquarters
softkeys idle Newcall Cfwdall Pickup
softkeys seized Endcall Cfwdall Pickup
softkeys alerting Endcall
softkeys connected Endcall Hold Park Trnsfer
Enabling Hunt Groups for Fallback Support: Example
The following example configures the dial peers to hunt in the following order: (1) explicit preference,
2) longest match in phone number, and (3) random selection. The dial-peer hunt command must be
configured for hunt-selection order of explicit preference to support hunt groups during SRST fallback
mode.
dial-peer hunt 2
The following example creates a peer hunt group with the pilot number 1111.
ephone-hunt 3 peer
pilot 1111
list 1101, 1102, 1103
hops 3
timeout 25
final 1100
Modifying Call Pickup for Fallback Support: Example
The following example changes the behavior of the Pickup soft key to be like the one in
Cisco Unified Communications Manager.
telephony-service
no service directed-pickup
create cnf-files
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1201
Configuring SRST Fallback Mode
Additional References
Prebuilding DNs: Example
In the following partial example, the preference command in ephone-dn and
voip-dial-peer configuration mode is configured to create a voip dial peer with a higher
preference (0) than the preference (1) of the manually-configured directory number
(ephone-dn 1).
dial-peer voice 1002
voip destination-pattern 1019
.
.
.
preference 0 <<=====This dial peer has precedence and will match first.
ephone-dn 1
number 1019
preference 1 <<======Configure lower preference for prebuilt DN.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies. Access to most tools
on the Cisco Support website requires a Cisco.com user
ID and password. If you have a valid service contract
but do not have a user ID or password, you can register
on Cisco.com.
Cisco Unified Communications Manager Express System Administrator Guide
1202 OL-10663-02
Configuring SRST Fallback Mode
Feature Information for SRST Fallback Mode
Feature Information for SRST Fallback Mode
Table 58 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 58 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 58 Feature Information for SRST Fallback Mode
Cisco Unified CME
Feature Name Version Feature Information
Octo-Line Directory Numbers 4.3 Support for octo-line directory numbers was added.
SRST Fallback Support Using 4.0 SRST fallback support using Cisco Unified CME was
Cisco Unified CME introduced.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1203
Configuring SRST Fallback Mode
Feature Information for SRST Fallback Mode
Cisco Unified Communications Manager Express System Administrator Guide
1204 OL-10663-02
Configuring VRF Support
First Published: December 2, 2008
Last Updated: April 9, 2009
Virtual Route Forwarding (VRF) divides a physical router into multiple logical routers, each having its
own set of interfaces and routing and forwarding tables. VRF support in voice networks can be used to
split Cisco Unified Communications Manager Express (Cisco Unified CME) into multiple virtual
systems for SIP and SCCP endpoints and TAPI-based client applications and softphones on your PC.
Finding Feature Information
Your software release may not support all the features documented in this module. For the latest feature
information and caveats, see the release notes for your platform and software release. To find information
about the features documented in this module, and to see a list of the releases in which each feature is
supported, see the “Feature Information for VRF Support” section on page 1217.
Use Cisco Feature Navigator to find information about platform support and Cisco IOS and Catalyst OS
software image support. To access Cisco Feature Navigator, go to http://www.cisco.com/go/cfn. An
account on Cisco.com is not required.
Contents
• Prerequisites for Configuring VRF Support, page 1206
• Restrictions for Configuring VRF Support, page 1207
• Information About VRF Support, page 1208
• How to Configure VRF Support, page 1208
• Additional References, page 1215
• Feature Information for VRF Support, page 1217
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1205
Configuring VRF Support
Prerequisites for Configuring VRF Support
Prerequisites for Configuring VRF Support
• Cisco Unified CME 7.0(1) or a later version must be configured on the Cisco router.
• VRF-Aware H.323 and SIP must be configured on the Cisco Unified CME router, including the
following:
– Up to five VRFs must be configured on the Cisco Unified CME router by using the ip vrf
command. For configuration information, see VRF-Aware H.323 and SIP for Voice Gateways.
– One of the groups must be designated as a global voice VRF (SIP Trunk) by using the voice vrf
command. For configuration information, see VRF-Aware H.323 and SIP for Voice Gateways.
Example:
voice vrf voice-vrf
ip vrf data-vrf1
rd 801:1
route-target export 801:1
route-target import 1000:1
!
ip vrf data-vrf2
rd 802:1
route-target export 802:1
route-target import 1000:1
!
ip vrf voice-vrf
rd 1000:1
route-target export 1000:1
route-target import 801:1
route-target import 802:1
!
• Interfaces on the router must be configured for the VRFs by using the ip vrf forwarding command.
Note SIP phones must register through the global voice VRF. Only global voice VRF is supported for
SIP trunk.
Example:
interface GigabitEthernet0/0.301
encapsulation dot1Q 301
ip vrf forwarding data-vrf1
ip address 10.1.10.1 255.255.255.0
!
interface GigabitEthernet0/0.302
encapsulation dot1Q 302
ip vrf forwarding data-vrf1
ip address 10.2.10.1 255.255.255.0
!
interface GigabitEthernet0/0.303
encapsulation dot1Q 303
ip vrf forwarding voice-vrf
ip address 10.3.10.1 255.255.255.0
• VRFs must be mapped to IP addresses using DHCP. For configuration information, see “Defining
DHCP” on page 82.
Example:
!<=== no ip dhcp command required only if “ip vrf forward” is specified under ip dhcp
no ip dhcp use vrf connected pool===>
!<=== Associate subnets with VRFs. Overlapping IP addresses are NOT supported.===>
Cisco Unified Communications Manager Express System Administrator Guide
1206 OL-10663-02
Configuring VRF Support
Restrictions for Configuring VRF Support
ip dhcp pool vcme1
network 10.1.10.0 255.255.255.0
default-router 10.1.10.1
option 150 ip 10.1.10.1
class vcme1
address range 10.1.10.10 10.1.10.250
!
ip dhcp pool vcme2
network 10.2.10.0 255.255.255.0
default-router 10.2.10.1
option 150 ip 10.2.10.1
class vcme2
address range 10.2.10.10 10.2.10.250
For more configuration examples, see the “Mapping IP Address Ranges to VRF Using DHCP:
Example” section on page 1213
• Dial peers for H323 and SIP trucks must be routed through the global voice VRF.
Note Dial peers are global resources belonging to the voice VRF and shared with and accessible from
any VRF. There is no need to configure a dial peer for each individual VRF.
Restrictions for Configuring VRF Support
• For SIP phones in Cisco Unified CME: SIP proxy and registrar must be in the same VRF.
• IP-address overlap between VRFs is not supported.
• Cross-VRF video is not supported.
• The following call types are not supported for a voice VRF:
– IP-to-IP gateway and gatekeeper configured on the same router.
– IP-to-IP gateway with a VRF configured on one call leg and not on another call leg.
– IP-to-IP gateway with one VRF configured for the H.323 call leg and a different VRF
configured for the SIP call leg.
– For H.323 calls, only TCP is supported. H.323 UDP signaling is not supported. SIP calls support
both TCP and UDP signaling.
• The following features are not supported by on a VRF:
– Call-fallback and RSVP features.
– H.323 Annex E calls.
– AAA and DNS components in voice-capable access routers. These routers communicate with
AAA and DNS using the default routing table.
• If a global voice VRF is not configured, signaling and media packets are sent using the default
routing table.
• SIP phones must register through the global voice VRF. Only the global voice VRF is supported for
SIP phones (SIP trunk).
• Cisco Unity Express on the Cisco Unified CME router must belong to the global voice VRF.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1207
Configuring VRF Support
Information About VRF Support
Note Telnet is used to access Cisco Unity Express on the global voice VRF because the Service-Engine
Service-Engine 1/0 session command is for non-VRF aware Cisco Unified CME only. To access the
Cisco Unity Express module for defining voice-mail users on global voice VRF, telnet through the
global voice VRF. For example: telnet 10.10.10.5 2066 /vrf vrf. For more information, see the “Installing
Cisco Unity Express Software” chapter in the appropriate Cisco Unity Express Administrator Guide for
Cisco Unified CME.
Information About VRF Support
To configure transcoding support, you should understand the following concepts:
• VRF-Aware Cisco Unified CME, page 1208
VRF-Aware Cisco Unified CME
VRF implementations enable you to consolidate voice communication into one logically-partitioned
network to separate voice and data communication on a converged multimedia network.
In Cisco Unified CME 7.0(1) and later versions, VRF in voice networks can be used to share a
Cisco Unified CME among multiple closed-users groups with different requirements. The actual call
processing rules can be applied by voice on a per VRF basis. A virtual Cisco Unified CME on each VRF
is a collection of phones in VRF groups that register in Cisco Unified CME through the VRF. All SCCP
and SIP phones connected to Cisco Unified CME register through the global voice VRF. TAPI-based
client applications and softphones on a PC must register through a data VRF and can communicate with
phones on the voice VRF.
VRF Support on Cisco Unified CME provides the following enhancements to the VRF-Aware H.323
and SIP for Voice Gateways feature:
• Line side support for up to 5 VRFs.
• Interworks with the global voice VRF on an H323 or SIP Trunk.
• Line side VRF can be a global voice VRF.
• VRFs are assigned on a per-phone level.
• Support for cross-VRF shared-lines.
For configuration information, see the “How to Configure VRF Support” section on page 1208
How to Configure VRF Support
This section contains the following tasks:
• Creating VRF Groups, page 1209 (required)
• Adding Cisco Unified CME Phones to a VRF Group, page 1210 (required)
Cisco Unified Communications Manager Express System Administrator Guide
1208 OL-10663-02
Configuring VRF Support
How to Configure VRF Support
Creating VRF Groups
To configure up to five VRF groups for users and phones in Cisco Unified CME, perform the following
steps for each group to be configured.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. group group-tag [vrf vrfname]
5. ip source-address ip-address [port port]
6. url {authentication | directories | idle | information | messages | proxy-server | services} url
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 group group-tag [vrf vrfname] Creates a VRF group for Cisco Unified CME users and
phones.
Example: • group-tag—Unique identifier for VRF group being
Router(config-telephony)# group 1 configured. Range: 1 to 5.
• (Optional) vrf vrfname—Name of previously
configured VRF to which this group is associated.
• By default, VRF groups are associated with a global
voice VRF unless otherwise specified by using the vrf
vrfname keyword and argument combination.
Step 5 ip source-address ip-address [port port] Associates VRF group with Cisco Unified CME.
• ip address and port through which Cisco Unified IP
Example: phones communicate with Cisco Unified CME.
Router(conf-tele-group)# ip source-address
10.1.10.1 port 2000
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1209
Configuring VRF Support
How to Configure VRF Support
Command or Action Purpose
Step 6 url {authentication | directories | idle | Provisions uniform resource locators (URLs) for
information | messages | proxy-server | Cisco Unified IP phones connected to Cisco Unified CME.
services} url
Example:
Router(conf-tele-group)# url directories
http://10.1.10.1/localdirectory
Step 7 end Returns to privileged EXEC mode.
Example:
Router(conf-tele-group)# end
Examples
The following partial output from the show running-config commands shows how to define three VRF
groups for Cisco Unified CME. Group 1 is on the global voice VRF and the other two groups are on data
VRFs.
telephony-service
sdspfarm conference mute-on # mute-off #
sdspfarm units 4
sdspfarm transcode sessions 10
sdspfarm tag 1 xcode101
sdspfarm tag 2 conf103
group 1
ip source-address 10.1.10.1 port 2000
url directories http://10.1.10.1/localdirectory
!
group 2 vrf data-vrf1
ip source-address 10.2.10.1 port 2000
!
group 3 vrf data-vrf2
ip source-address 10.3.10.1 port 2000
Adding Cisco Unified CME Phones to a VRF Group
To add an SCCP Cisco Unified IP phone, TAPI-based client, or softphone in Cisco Unified CME to a
VRF group, perform the following steps for each phone to be added.
Prerequisites
• All ephone configurations to be included in a VRF group must be already configured in
Cisco Unified CME. For configuration information, see “Configuring Phones to Make Basic Calls”
on page 139.
Restrictions
• All SCCP phones in Cisco Unified CME must register through the global voice VRF and must be
added to the VRF group on the global voice VRF only.
• Analog phones connected to FXS ports on a IOS gateway must register through the global voice
VRF and must be added to the VRF group on the global voice VRF only.
Cisco Unified Communications Manager Express System Administrator Guide
1210 OL-10663-02
Configuring VRF Support
How to Configure VRF Support
• TAPI-based client applications and softphones on a PC must register through the data VRF and must
be added to a VRF group on a data VRF only.
• VRF groups do not support identical IP addresses or shared lines.
SUMMARY STEPS
1. enable
2. configure terminal
3. ephone phone-tag
4. description string
5. mac-address [mac-address]
6. group phone group-tag [tapi group-tag]
7. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ephone phone-tag Enters ephone configuration mode for a Cisco Unified IP
phone.
Example:
Router(config)# ephone 11
Step 4 description string (Optional) Includes descriptive text about the interface.
Example:
Router(config-ephone)# description cme-2801
srst
Step 5 mac-address [mac-address] Associates the MAC address of a Cisco Unified IP phone
with an ephone configuration.
Example:
Router(config-ephone)# mac-address
0012.8055.d2EE
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1211
Configuring VRF Support
How to Configure VRF Support
Command or Action Purpose
Step 6 group phone group-tag [tapi group-tag] Adds a phone, TAPI-based client, or softphone to a VRF
group.
Example: • group-tag—Unique identifier for VRF group that was
Router(config-ephone)# group phone 1 previously configured by using the group command in
telephony-service configuration mode. Range: 1 to 5.
• This command can also be configured in
ephone-template configuration mode and applied to
one or more phones. The ephone configuration has
priority over the ephone-template configuration.
Step 7 end Returns to privileged EXEC mode.
Example:
Router(config-ephone)# end
Examples
The following example shows how to add phones to VRF groups. Phones 1 and 3 are in VRF group 1 on
the global voice VRF. Phone 1 TAPI client and softphone 3 are in group 1 on the data-vrf2. Phone 3
TAPI client and softphone 4 are in group 3 on data-vrf 2.
telephony-service
sdspfarm conference mute-on # mute-off #
sdspfarm units 4
sdspfarm transcode sessions 10
sdspfarm tag 1 xcode101
sdspfarm tag 2 conf103
group 1 vrf voice-vrf
ip source-address 10.1.10.1 port 2000
url directories http://10.1.10.1/localdirectory
!
group 2 vrf data-vrf1
ip source-address 10.2.10.1 port 2000
!
group 3 vrf data-vrf2
ip source-address 10.3.10.1 port 2000
!
.
.
ephone-template 1
group phone 1 tapi 2
ephone-template 2
group phone 2
...
ephone 1
ephone-template 1
ephone 2
ephone-template 2
ephone 3
group phone 1 tapi 3
ephone 4
group phone 3
ephone 201
group phone 1
type anl
Cisco Unified Communications Manager Express System Administrator Guide
1212 OL-10663-02
Configuring VRF Support
Configuration Examples for Configuring VRF Support
Configuration Examples for Configuring VRF Support
This sections contains the following examples:
• Mapping IP Address Ranges to VRF Using DHCP: Example, page 1213
• VRF-Aware Hardware Conferencing: Example, page 1214
• Cisco Unity Express on Global Voice VRF: Example, page 1215
Mapping IP Address Ranges to VRF Using DHCP: Example
Note Duplicate IP addresses, with or without specifying a VRF, are not supported in Cisco Unified CME
7.0(1).
There are three ways to assign DHCP addresses: global address allocation; VRF pool; or individual host
With a global address allocation scheme, you must use the no ip dhcp use vrf connected command.
no ip dhcp use vrf connected
!
ip dhcp pool vcme1
network 209.165.201.10 255.255.255.224
option 150 ip 209.165.201.9
default-router 209.165.201.9
class vcme1
address range 209.165.201.1 209.165.201.30
!
The following example shows how to assign addresses from VRF pool vcme1.
ip dhcp use vrf connected
!
ip dhcp pool vcme1
vrf data-vrf1
network 209.165.201.10 255.255.255.224
option 150 ip 209.165.201.9
default-router 209.165.201.9
class vcme1
address range 209.165.201.1 209.165.201.30
!
The following example show how to assign an address by an individual host. You must replace the first
two hexadecimal digits of a host MAC address with 01.
ip dhcp pool phone3
host 209.165.201.15 255.255.255.224
client-identifier 0100.0ed7.4ce6.3d
default-router 209.165.201.11
option 150 ip 209.165.201.11
!
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1213
Configuring VRF Support
Configuration Examples for Configuring VRF Support
VRF-Aware Hardware Conferencing: Example
Hardware Conferencing with Internal DSP Farm
• The internal DSPFarm must be registered through a local loopback interface.
• The loopback allows Cisco Unified CME to access the media path in global routing table.
The boldface commands in the following configuration example show that the signaling and media paths
are accessed through the global routing table and the loopback interface is in default routing table.
interface Loopback5
ip address 12.5.10.1 255.255.255.255
!
sccp local Loopback5
sccp ccm 12.5.10.1 identifier 2 version 4.1
sccp
!
sccp ccm group 2
bind interface Loopback5
associate ccm 2 priority 1
associate profile 103 register conf103
associate profile 101 register xcode101
!
telephony-service
sdspfarm conference mute-on # mute-off #
sdspfarm units 4
sdspfarm transcode sessions 10
sdspfarm tag 1 xcode101
sdspfarm tag 2 conf103
group 1 vrf vrf1
ip source-address 10.1.10.1 port 2000
!
group 2 vrf vrf2
ip source-address 10.2.10.1 port 2000
!
group 3 vrf vrf3
ip source-address 10.3.10.1 port 2000
!
group 4 vrf vrf4
ip source-address 10.4.10.1 port 2000
!
group 5
ip source-address 12.5.10.1 port 2000
!
conference hardware
max-ephones 240
max-dn 480
voicemail 7710
max-conferences 8 gain -6
Hardware Conferencing with External DSP Farm
• Configure DSP farm as usual on a Cisco router.
• The external DSP farm must be registered to Cisco Unified CME through the interface or
subinterface assigned to the global voice VRF. Make sure the connection path is coming in through
the voice VRF.
• The router on which the external DSP farm is configured does not have to be VRF-aware.
For information about configuring DSP Farms, see “How to Configure Transcoding Resources” on
page 334.
Cisco Unified Communications Manager Express System Administrator Guide
1214 OL-10663-02
Configuring VRF Support
Additional References
Cisco Unity Express on Global Voice VRF: Example
voice vrf vrf2
ip vrf data-vrf2
rd 100:2
route-target export 100:2
route-target import 100:2
!
Interface loop back 0
ip vrf forwarding data-vrf2
Ip address 21.10.10.2
!<==The following config puts CUE in the voice vrf. Service-engine interface and
service-module must have an IP address.===>
!
interface Service-Engine1/0
ip vrf forwarding voice-vrf3 ip address 21.10.10.5 255.255.255.0
service-module ip address 21.10.10.6 255.255.255.0
service-module ip default-gateway 21.10.10.2!
ip route 21.10.10.6 255.255.255.255 Service-Engine1/0
…
line 66
no activation-character
Additional References
The following sections provide references related to Virtual Route Forwarding.
Related Documents
Related Topic Document Title
Troubleshooting VRF-aware services VRF-Aware System Message Logging
IP Application Services Configuration Cisco IOS IP Application Services Configuration Guide 12.4
IP Application Services Command Reference Cisco IOS IP Application Services Command Reference 12.4
MPLS VPNs MPLS Virtual Private Networks Configuration Guide 12.0(5)T
MPLS Command Reference Cisco IOS Multiprotocol Label Switching Command Reference 12.4
Cisco Unified CME Command Reference Cisco Unified Communications Manager Express Command
Reference
All other Cisco IOS Command Reference guides Various titles located at
http://www.cisco.com/en/US/products/ps6350/prod_command_refe
rence_list.html
VRF-lite Catalyst 4500 Series Switch Cisco IOS Software Configuration
Guide, 12.2(25)SG, Configuring VRF-Lite
Standards
Standard Title
H.323 Annex E Multiplexed call signaling over UDP (within H.323v4 and later).
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1215
Configuring VRF Support
Additional References
MIBs
MIB MIBs Link
No new or modified MIBs are supported, and support To locate and download MIBs for selected platforms, Cisco IOS
for existing MIBs has not been modified. releases, and feature sets, use Cisco MIB Locator found at the
following URL:
http://www.cisco.com/go/mibs
RFCs
RFC Title
No new or modified RFCs are supported, and support —
for existing RFCs has not been modified.
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
1216 OL-10663-02
Configuring VRF Support
Feature Information for VRF Support
Feature Information for VRF Support
Table 59 lists the release history for this feature.
Not all commands may be available in your Cisco IOS software release. For release information about
a specific command, see the command reference documentation.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS and Catalyst OS software images
support a specific software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 59 lists only the Cisco IOS software release that introduced support for a given feature in a given
Cisco IOS software release train. Unless noted otherwise, subsequent releases of that Cisco IOS
software release train also support that feature.
Table 59 Feature Information for Virtual Route Forwarding
Cisco Unified CME
Feature Name Version Feature Information
VRF Support in Cisco Unified CME 7.0(1) VRF supports Cisco Unified CME, conferencing,
transcoding, and RSVP components. VRF also allows soft
phones in data VRF resources to communicate with phones
in a VRF voice gateway.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1217
Configuring VRF Support
Feature Information for VRF Support
Cisco Unified Communications Manager Express System Administrator Guide
1218 OL-10663-02
Configuring the XML API
Last Updated: March 3, 2008
This chapter describes the eXtensible Markup Language (XML) Application Programming Interface
(API) support available in Cisco Unified Communications Manager Express (Cisco Unified CME).
Finding Feature Information in This Module
Your Cisco Unified CME version may not support all of the features documented in this module. For a
list of the versions in which each feature is supported, see the “Feature Information for XML API” section
on page 1228.
Contents
• Information About XML API, page 1219
• How to Configure XML API, page 1220
• Configuration Examples for XML API, page 1225
• Where to Go Next, page 1226
• Additional References, page 1226
• Feature Information for XML API, page 1228
Information About XML API
To enable XML API, you should understand the following concepts:
• XML API Definition, page 1219
• XML API Provision Using IXI, page 1220
XML API Definition
An XML API provides an interface to Cisco Unified CME that allows an external network management
system (NMS) to configure and monitor Cisco Unified CME operations.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1219
Configuring the XML API
How to Configure XML API
XML API Provision Using IXI
In previous versions of Cisco Unified CME, the XML interface provided configuration and monitoring
functions using the HTTP port. The XML interface ran under the HTTP server process, simultaneously
parsing incoming XML requests on demand and processing them.
In Cisco Unified CME 4.0 and later versions, the XML interface is provided through the Cisco IOS
XML Infrastructure (IXI), in which the parser and transport layers are separated from the application.
This modularity provides scalability and enables future XML support to be developed. In
Cisco Unified CME 4.0 and later versions, all Cisco Unified CME features have XML support.
How to Configure XML API
This section contains the following tasks:
• Defining XML Transport Parameters, page 1220
• Defining XML Application Parameters, page 1222
• Defining Authentication for XML Access, page 1223
• Defining XML Event Table Parameters, page 1224
• Troubleshooting the XML Interface, page 1225
Note The following Cisco IOS commands that were previously used with the XML interface are no longer
valid: log password, xmltest, xmlschema, and xmlthread.
Defining XML Transport Parameters
To define the XML transport method and associated parameters, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. ip http server
4. ixi transport http
5. response size fragment- size
6. request outstanding number
7. request timeout seconds
8. no shutdown
9. end
Cisco Unified Communications Manager Express System Administrator Guide
1220 OL-10663-02
Configuring the XML API
How to Configure XML API
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ip http server Enables the Cisco web browser user interface on the local
Cisco Unified CME router.
Example:
Router(config)# ip http server
Step 4 ixi transport http Specifies the XML transport method and enters
XML-transport configuration mode.
Example: • http—HTTP transport.
Router(config)# ixi transport http
Step 5 response size fragment-size Sets the response buffer size.
• fragment-size—Size of fragment in the response buffer,
Example: in kilobytes. Range is constrained by the transport type
Router(conf-xml-trans)# response size 8 and platform. See the CLI help for the valid range of
values.
Step 6 request outstanding number Sets the maximum number of outstanding requests allowed
for the transport type.
Example: • number—Number of requests. Range is constrained by
Router(conf-xml-trans)# request outstanding 2 the transport type and platform. See the CLI help for the
valid range of values.
Step 7 request timeout seconds Sets the number of seconds to wait, while processing a
request, before timing out.
Example: • seconds—Number of seconds. Range is 0 to 60.
Router(conf-xml-trans)# request timeout 30
Step 8 no shutdown Enables HTTP transport.
Example:
Router(conf-xml-trans)# no shutdown
Step 9 end Returns to privileged EXEC mode.
Example:
Router(config-xml-app)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1221
Configuring the XML API
How to Configure XML API
Defining XML Application Parameters
To set a response timeout for communication with the XML application that overrides the setting in
transport configuration mode, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. ixi application cme
4. response timeout {-1 | seconds}
5. no shutdown
6. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 ixi application cme Enters XML-application configuration mode for
configuring Cisco IOS XML infrastructure parameters for
the Cisco Unified CME application.
Example:
Router(config)# ixi application cme Note This command defines URL of Cisco Unified CME
XML server as
http://<routerIPaddress>/ios_xml_app/cme.
Step 4 response timeout {-1 | seconds} Sets a timeout for responding to the XML application and
overwrites the IXI transport level timeout.
Example: • -1—No application-specific timeout is specified. This
Router(config-xml-app) response timeout 30 is the default.
• seconds—Length of timeout, in seconds. Range is
0 to 60.
Step 5 no shutdown Enables XML communication with the application.
Example:
Router(conf-xml-app)# no shutdown
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-xml-app)# end
Cisco Unified Communications Manager Express System Administrator Guide
1222 OL-10663-02
Configuring the XML API
How to Configure XML API
Defining Authentication for XML Access
To authenticate users for XML access, perform the following steps:
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. xml user user-name password password privilege-level
5. end
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)# telephony-service
Step 4 xml user user-name password password Defines an authorized user.
privilege-level
• user-name—Unique alphanumeric string that is
authorized user name. Maximum length of string is 19
Example: characters.
Router(config-telephony)# xml user user23
password 3Rs92uzQ 15 • password—Alphanumeric string to use for access.
Maximum length of string is 19 characters.
• privilege-level—Level of access to Cisco IOS
commands to be granted to this user. Only the
commands with the same or a lower level can be
executed via XML. Range is 0 (lowest) to 15 (highest).
Step 5 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1223
Configuring the XML API
How to Configure XML API
Defining XML Event Table Parameters
The XML event table is an internal buffer that stores captured and time-stamped events, such as phones
registering and unregistering and extension status. One event equals one entry in the table. To set the
maximum number of events or entries that can be stored in the XML event table and the length of time
that events are retained before they are deleted from the table, perform the following steps.
SUMMARY STEPS
1. enable
2. configure terminal
3. telephony-service
4. log table max-size number
5. log table retain-timer minutes
6. end
7. show fb-its-log
8. clear telephony-service xml-event-log
DETAILED STEPS
Command or Action Purpose
Step 1 enable Enables privileged EXEC mode.
• Enter your password if prompted.
Example:
Router> enable
Step 2 configure terminal Enters global configuration mode.
Example:
Router# configure terminal
Step 3 telephony-service Enters telephony-service configuration mode.
Example:
Router(config)#
Step 4 log table max-size number Sets the number of entries in the XML event table.
• number—Number of entries. Range is 0 to 1000.
Example: Default is 150.
Router(config-telephony)# log table max-size
100
Step 5 log table retain-timer minutes Sets the number of minutes to retain entries in the event
table before they are deleted.
Example: • minutes—Number of minutes. Range is 2 to 500.
Router(config-telephony)# log table Default is 15.
retain-timer 30
Cisco Unified Communications Manager Express System Administrator Guide
1224 OL-10663-02
Configuring the XML API
Configuration Examples for XML API
Command or Action Purpose
Step 6 end Returns to privileged EXEC mode.
Example:
Router(config-telephony)# end
Step 7 show fb-its-log Displays the event logs.
Example:
Router# show fb-its-log
Step 8 clear telephony-service xml-event-log Clears XML event logs.
Example:
Router# clear telephony-service xml-event-log
Troubleshooting the XML Interface
Step 1 Use the debug cme-xml command to view debug messages for the Cisco Unified CME XML interface.
Configuration Examples for XML API
This section contains the following examples:
• XML Transport Parameters: Example, page 1225
• XML Application Parameters: Example, page 1225
• XML Authentication: Example, page 1226
• XML Event Table: Example, page 1226
XML Transport Parameters: Example
The following example selects HTTP as the XML transport method:
ip http server
ixi transport http
response size 8
request outstanding 2
request timeout 30
no shutdown
XML Application Parameters: Example
The following example sets the application response timeout to 30 seconds.
ixi application cme
response timeout 30
no shutdown
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1225
Configuring the XML API
Where to Go Next
XML Authentication: Example
The following example selects HTTP as the XML transport method. It allows access for user23 with the
password 3Rs92uzQ, and sets up access list 99 that accepts requests from the IP address 192.168.146.72.
ixi transport http
ip http server
!
telephony-service
xml user user23 password 3Rs92uzQ 15
XML Event Table: Example
The following example sets the maximum number of entries in the XML event table to 100 and the
number of minutes to retain entries at 30:
telephony-service
log table max-size 100
log table retain-timer 30
Where to Go Next
For developer information on the XML API, see the XML Provisioning Guide for Cisco CME/SRST.
Additional References
The following sections provide references related to Cisco Unified CME features.
Related Documents
Related Topic Document Title
Cisco Unified CME configuration • Cisco Unified CME Command Reference
• Cisco Unified CME Documentation Roadmap
Cisco IOS commands • Cisco IOS Voice Command Reference
• Cisco IOS Software Releases 12.4T Command References
Cisco IOS configuration • Cisco IOS Voice Configuration Library
• Cisco IOS Software Releases 12.4T Configuration Guides
Phone documentation for Cisco Unified CME • User Documentation for Cisco Unified IP Phones
Cisco Unified Communications Manager Express System Administrator Guide
1226 OL-10663-02
Configuring the XML API
Additional References
Technical Assistance
Description Link
The Cisco Support website provides extensive online http://www.cisco.com/techsupport
resources, including documentation and tools for
troubleshooting and resolving technical issues with
Cisco products and technologies.
To receive security and technical information about
your products, you can subscribe to various services,
such as the Product Alert Tool (accessed from Field
Notices), the Cisco Technical Services Newsletter, and
Really Simple Syndication (RSS) Feeds.
Access to most tools on the Cisco Support website
requires a Cisco.com user ID and password.
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1227
Configuring the XML API
Feature Information for XML API
Feature Information for XML API
Table 60 lists the features in this module and enhancements to the features by version.
To determine the correct Cisco IOS release to support a specific Cisco Unified CME version, see the
Cisco Unified CME and Cisco IOS Software Version Compatibility Matrix at
http://www.cisco.com/en/US/docs/voice_ip_comm/cucme/requirements/guide/33matrix.htm.
Use Cisco Feature Navigator to find information about platform support and software image support.
Cisco Feature Navigator enables you to determine which Cisco IOS software images support a specific
software release, feature set, or platform. To access Cisco Feature Navigator, go to
http://www.cisco.com/go/cfn. An account on Cisco.com is not required.
Note Table 60 lists the Cisco Unified CME version that introduced support for a given feature. Unless noted
otherwise, subsequent versions of Cisco Unified CME software also support that feature.
Table 60 Feature Information for XML API
Cisco Unified CME
Feature Name Version Feature Information
Call Blocking Based on Date and Time 4.0 The XML API was modified and is now provided through
the Cisco IOS XML infrastructure. It supports all
Cisco Unified CME features. The log password, xmltest,
xmlschema, and xmlthread commands were made
obsolete.
3.0 The XML API was introduced.
Cisco Unified Communications Manager Express System Administrator Guide
1228 OL-10663-02
INDEX
announcements
Numerics
blocked precedence 963
7931 187 busy station 963
911 services 853 isolated code 963
loss of C2 features 964
MLPP 963
A
unauthorized precedence 964
abbreviated dialing 1092 vacant code 964
accept command 583 Answer soft key 1066
access-digit command 966 API, XML 1237
account code entry 1067 application (voice register global) command 131
Acct soft key 1066 application command 238
addon command 163 archives, downloading for Cisco Unified CME 54
address command 867 associate application command 340
ad hoc conferencing 773 associate application sccp command 789
after-hour exempt (voice register pool) command 546 associate ccm command 339, 789
after-hour exempt command 545 associate profile command 339
after-hours block pattern command 540 ATA (Cisco Analog Telephone Adapters) 151
after hours call blocking attendant-console command 976
configuring exception for dial peer 542 audio fallback, for video calls 1109
configuring exception for SIP phone 544, 545 audio file for MOH 56
after-hours date command 541 audio paging 1009
after-hours day command 541 authenticate command 127
after-hours toll bar 537 authenticate credential command 95, 1037
agent availability, ephone hunt groups 694 authenticate ood-refer command 95
agent status control, hunt groups 696 authenticate presence command 1036
alerting (call state) 1066 authentication, See phone authentication
allow connections command 650 authentication credential command 898
allow-connections command 80, 648 authentication for HTTP server 385
allow-connections sip-to-sip command 1164, 1187, 1188 authentication string, entering on phone 486
allow subscribe command 1036 auth-mode command 475, 479
allow watch command 1029, 1166, 1170 auth-string command 475
analog phones 151 auto-answer, headset 927
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1247
Index
auto-answer command 943 bulk registration
auto assign command 243 configuring 112
autoconfiguration of VG2xx 152 disabling SIP proxy registration 181
auto-cut-through command 991 bulk-speed-dial list command 1095
auto-line command 517 bulk-speed-dial-prefix command 1095
auto logout command 697 busy call forwarding 614
automatic agent status not-ready, ephone hunt groups 697 busy station announcement 963
automatic line selection 515 busy-trigger-per-button command 167, 172
automatic registration blocking 119 button command 198
auto-reg-ephone command 119 assigning dns to phones 167
overlaid ephone-dns 741
button-layout command 1125
B
button optimization 149
b2bua command 428
bandwidth, for video 1113
C
barge 521
Barge soft key 1066 CA (certification authority) 449
billing records 22 cadence command 785
bind interface command 787 Callback soft key 1066
bit-rate, setting maximum value 1112 call blast 693
blast hunt group 693 call blocking
BLF for a phone 148, 1025 based on date and time 537
BLF for a phone line 147, 1022 override 538
blf-speed-dial command 1031, 1034 call-coverage features 681
BLF status 1022 call detail records 22
blind transfer 616 caller-id block command 766
blocked precedence announcement 963 caller ID blocking 764
blocking caller-id command 950
automatic registration 119 caller ID name 827
caller ID 537 call-feature-uri gpickup command 713
call park 560 call-feature-uri pickup command 713
calls 537 call-forward all command 640
call transfer 616 call-forward b2bua all command 663
features 1068 call-forward b2bua busy command 421, 664
local directory 823 call-forward b2bua mailbox command 421, 664
bnea command 966 call-forward b2bua noan command 422, 664
bpa command 966 call-forward b2bua unreachable command 664
bulk command 113 call-forward busy command 640
bulk-loading speed-dial numbers 1094 call-forward busy command, overlaid ephone-dns 740
Cisco Unified Communications Manager Express System Administrator Guide
1248 OL-10663-02
Index
call forwarding H.450.2 standard 618
blocking local extension forwards 641 H.450 standards 616
H.450.3 standard 618 recall 149, 617
selective 614 transcoding between G.726 and G.711 330
transcoding between G.726 and G.711 330 call type 1109
call-forward max-length command 640 call waiting
call-forward night-service command 640 beep 686
call-forward noan command 640 cancel 687
call-forward noan command, overlaid ephone-dns 740 overlaid ephone-dns 702
call-forward pattern command 639, 650 ring 687
call-forward system command 289 call-waiting 719
call history 22 call-waiting beep command 715
call hunt 683 call-waiting ring command 687, 715
calling-number local command 650 cancel call waiting 687
callmon command 1163 CAPF (certificate authority proxy function) 450
callmonitor command 1188 capf-auth-str command 478
call park capf-server command 474
alternate target 558 cBarge 521
blocking 560 CBarge soft key 1066
call-park slots 556 CDRs 22
dedicated slots 558 cert-enroll-trustpoint command 474
directed 558 certificate 449
examples 567 certificate authority proxy function, See CAPF
monitoring call-park slots 557 certificate revocation list, See CRL
redirect 560 certificate trust list, See CTL
reminder ring 557 certification authority, See CA
reservation groups 558 cert-oper (CAPF-server) command 476
timeout interval 557 cert-oper (ephone) command 479
call-park system command 562 CFwdALL soft key 1066
call pickup channel huntstop 684
examples 744 CIF (common intermediate format) 1106
group numbers 684 Cisco BTS Softswitch (Cisco BTS) 619, 620, 623, 625
call routing, loopback 947 Cisco IOS softwrae 39
call setup, video 1109 Cisco phone firmware
call start slow command 1111 troubleshooting upgrade 73
call transfer 667 upgrading SIP 61
blocking 616 verifying firmware version on an IP phone 72
consult transfer for direct station select 618 Cisco PSTN Gateway (Cisco PGW) 619, 623, 625
direct station select 618 Cisco QoS 41
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1249
Index
Cisco Unified CME for SIP phones cli write command 247
applying translation rules 297 clock summer-time command 88
configuring bulk registration 112 clock timezone command 88
configuring call forwarding 662 cnf-file command 121
configuring call transfer 667 cnf-file location command 120
configuring dial-plan patterns 288 cnf-file perphone command 467
configuring hunt stop 707 codec (dspfarm-profile) command 340
configuring voice hunt groups 728 codec command 183, 186, 211, 240, 429, 788, 1171
configuring voice mailbox 420 codec g729r8 dspfarm-assist command 155, 333
creating and applying templates 1152 codec preference command 493
creating DNs 169 common intermediate format, see CIF 1106
disabling SIP proxy registration 181 conference add-mode command 795
generating configuration profiles 265 conference ad-hoc command 793
RFC 2833 dual tone DTMF MTP passthrough 405 conference admin command 795
SIP MWI - QSIG translation 406 conference drop-mode command 795
Cisco Unified Communications Manager conference hardware command 791
interworking with Cisco Unified CME 656, 660 conference-join custom-cptone command 788
network scenario 631, 632 conference-leave custom-cptone command 788
no support for H.450 standards 619 conference meetme command 793
Cisco Unified IP Phone 7931G 187 conferencing 771
Cisco Unified Video Advantage 1105 end-of-conference options 773
Cisco Unity examples 805
configuring SIP dial peer for 424 gain control 773
integration 404 initiator dropoff control 773
Cisco Unity Connection integration 403 transcoding between G.729 and G.711 for ad hoc
calls 330
Cisco Unity Express
AXL enhancement 408
configuration files
externally stored 103, 262
configuring SIP dial peer for 427
GUI 390
integration with Cisco Unified CME 403
per phone 103, 262
transcoding between G.726 and G.711 330
per phone type 103, 262
Cisco Unity Express AXL enhancement 408
configuring Cisco QoS 41
Cisco VG 224 151
Configuring Toll Fraud Prevention 367
class of restriction (COR) 539
configuring VLANs 41
clear cti session command 1195
clear telephony-service xml-event-log command 1243
ConfList soft key 1066
clear voice moh-group statistics command 1007
Confrn soft key 1066
clid strip command 765
connected (call state) 1066
clid strip name command 765
connection plar opx command 190
client identifier command 85
consultative transfer 616, 617
Cisco Unified Communications Manager Express System Administrator Guide
1250 OL-10663-02
Index
COR (class of restriction) 539 debug ephone message command 1115
cor command 549 debug ephone mlpp command 978
corlist command 548 debug ephone mtp command 352
CPU consumption, for video calls 1107 debug ephone register command 1115
create cnf-files command 61, 71, 205 debug ephone video command 1116
create profile command 63, 67, 181, 266 debug h225asn1 command 1115
credentials command 481 debug h245 asn1 command 1115
CRL (certificate revocation list) 450 debug sccp command 352
crypto pki authenticate command 359, 360, 464, 488, 496 debug tftp event command 73
crypto pki enroll command 359, 465 debug voice mlpp command 978
crypto pki server command 354, 460, 462, 485 debug voip ccapi inout command 1115
crypto pki trustpoint command 355, 357, 360, 461, 463, 484, dedicated call-park slots 558
488, 496
default-router command 84, 86
CSTA client application 1183
description (ephone-hunt) command 724
csv accounting 22
description(moh-group) command 996
cti-aware command 1191
description command 426, 428, 1126, 1127
cti csta mode basic command 1188
destination-pattern command 240, 426, 428
CTI CSTA protocol suite 1183
device-id command 163
cti message device-id suppress-conversion device-name command 163
command 1188
device-security-mode command 467, 478
cti notify command 1193
device-type command 163
cti shutdown command 1188
DHCP server
cti watch command 1193
changing TFTP address 93
CTL (certificate trust list) 450
option 150 and configuration files 93
ctl-client command 469, 472
DHCP service
ctl-service admin command 482
description 76
customer administrator GUI access setup
setting up 82
using the CLI 392
dialing plans 283
using the GUI 391
dial-peer hunt command 700
customer administrator GUI file 390
dial-peer hunt for ephone-dn dial peers
dial-peer preference 683
D dial peers
ephone-dns 141
database level command 354, 460
for call transfer and forwarding 627
database url command 355, 461
dial-peer voice command 425, 428
date-format command 128
dialplan command 177
debug cch323 video command 1115
dialplan-pattern command 288, 289
debug dspfarm command 352
dial plans for SIP phones 157
debug ephone detail command 1115
dial tone, secondary 286
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1251
Index
DID (Direct Inward Dialing) 285 for H.323 networks 77
digital certificate 449 SIP NOTIFY 427
digital certificates 448 SIP trunks 90
digital signature 449 dtmf-relay (voice register pool) command 172, 1171
digit collect kpml command 179 dtmf-relay h245-alphanumeric command 90, 240
directed call park 558 dtmf-relay rtp-nte command 91, 426
directed call pickup, See call pickup dtmf-relay sip-notify command 91, 429
directories 823 dual-line ephone-dn 142
directory command 826 dual-number ephone-dns 146
directory entry command 828 dualtone conference command 785
directory numbers for SIP phones 169 dynamic membership, hunt groups 696
direct station select 1087
direct station select call transfer 618
E
display-logout command 724
distinctive ringing 1047 E.164 number registration
DND (do not disturb) 847 ephone-hunt group pilot number 723
dnd command 849 SIP 77
dnd feature-ring command 846 E911 services 853
DND soft key 697, 850, 1066 elin command 867
dn-webedit command 388 emadmin login command 1193
do not disturb (DND) 847 emadmin logout command 1193
downloading files for Cisco Unified CME 54 emergency response callback command 872
DSCP (Differentiated Services Code Point) 102 emergency response location command 875, 876, 877
dspfarm connection interval command 349 emergency response zone command 870, 871
dspfarm profile command 340 emergency services 853
dspfarm rtp timeout command 349 em external command 1194
DSP farms, modifying configuration after upgrading Cisco em keep-history command 898
IOS software 346
em logout command 899
DSP farms, usage considerations 333
emptycapability command 492
dspfarm transcoder maximum sessions command 342, 348
encryption 447
DSPs (digital signal processors) 331
EndCall soft key 1066
dsp services dspfarm command 337, 341, 784
endpoint capability match 1109
DSS (direct station select) service 1087
enhanced 911 services 853
dst auto-adjust command 129
enrollment terminal command 488
dst command 129
enrollment url command 357, 462, 464, 484
DTMF integration 404
ephone command 166
DTMF integration patterns for voice mail 422
ephone-dn command 70, 160, 418
dtmf-interworking rtp-nte command 427
ephone-dn dial-peer hunt
DTMF relay
ephone-dns
Cisco Unified Communications Manager Express System Administrator Guide
1252 OL-10663-02
Index
assigning to phone (button command) 167
F
definition 19
dual-line 142 FAC (feature access code) 911
dual-number 146 fac command 416, 563, 710, 717, 914
hunt groups 688 far-end camera control, see FECC 1106
overlaid 147, 700 fastdial command 1091, 1100
secondary number 146 fax relay 919
shared 146 fax support 152
single-line 142 feature access code (FAC) 911
two ephone-dns with one number 145 feature blocking 1068
types 141 feature buttons
ephone-hunt command 721 fixed 1120
ephone hunt groups URL provisioning for 1122
agent availability options 694 features blocked command 1078
agent status control 696 FECC (far-end camera control) 1106
automatic agent status not-ready 697 filename command 176
dynamic membership 696 files, downloading for Cisco Unified CME 54
examples 745 file text command 63, 67, 266
hops 688 final command 722, 731
longest-idle groups 692 firmware files
peer groups 691 phone 54
sequential groups 690 video 1105
ephone-hunt login command 725 fixed line/feature button layout 1120
ephones Flash soft key 1066, 1068
basic configuration 165 flow-around mode, video stream 1110
definition 19 flow control messages 1110
enabling video 1113 flow-through mode, video stream 1110
setting video bandwidth 1113 forwarding, See call forwarding
ephone-type command 163 forwarding calls using local hairpin routing 649
Ephone-type templates 162 forward local-calls command 641
extending overlaid ephone-dn calls 704 frequency command 785
extension assigner feature 229 from-ring command 724
automatic synchronization 235 fwd-final command 723
extension-assigner tag-type command 242 fxo hook-flash command 1076
extension mobility 893 FXO port monitoring 149
extension-range command 997 FXO trunk lines 149
external-ring command 1054 FXS ports 151
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1253
Index
description 618
G
enabling 633
G.711 conference calls 773 handling non-H.450.2 calls 622
G.729r8 codec network requirements 620
remote phones 155, 333 H.450.3 supplementary services 618
transcoding 329 description 618
gain control for conferences 773 enabling 633
gatekeeper, H.323 handling non-H.450.3 calls 622
not registering ephone hunt-group pilot number 723 network requirements 620
number format restrictions 284 H.450 standards
gcid command 1164, 1188 call forwarding 614
generating SIP profiles 265 call transfer 616
GPickUp soft key 1066 H.450 tandem gateways
grant auto command 354, 462, 485 description 625
group call pickup 684 enabling H.323-to-H.323 connections 647
group command 582, 1227 licensing 625
group phone command 1230 h225 h245-address on-connect (h323 voice-service)
group pickup, See call pickup command 659
GUI (graphical user interface) h225 h245-address on-connect (voice-class)
command 660
customer administrator setup 391
h323 command 491
how to access 389
hairpin call routing
phone user setup 393
description 622
prerequisites 383
enabling H.323-to-H.323 connections 647
restrictions 384
network requirements 624
setting up 385
restrictions 647
system administrator setup 387
headset auto-answer 927
headset auto-answer command 930
H HLog soft key 697, 1066
hold (call state) 1066
H.225 debug messages 1115
hold-alert command 719, 1052
H.245 debug messages 1115
Hold soft key 1066
H.261 video codec 1106
hookflash functionality 1068
H.263 video codec 1106
hops command 722, 732
H.264 video codec 1108
host command 85
H.323-to-H.323 connections, enabling 647
HTTP path, setting 385
H.323 video endpoints 1108
HTTP server, enabling 385
H.450.12 supplementary services
hunt, See call hunt
description 622
hunt-group logout command 697, 725
H.450.2 supplementary services 618
Cisco Unified Communications Manager Express System Administrator Guide
1254 OL-10663-02
Index
hunt groups 687 ip source-address (credentials) command 481
huntstop 683, 707 ip source-address command 110, 345
huntstop, channel 684 ip source-address command (redundant router) 116, 124
huntstop channel command 160, 170, 706, 740 isolated code announcement 963
huntstop command 188, 196, 683, 708, 740 issuer-name command 461
huntstop command, overlaid ephone-dns 700 ixi application cme command 1240
ixi transport http command 1239
I
J
ica command 976
id command 172, 943 Join soft key 1066
idle (call state) 1066
incoming alerting command (redundant router) 124
K
index command 589, 596
in key systems 198 keepalive command 122, 1168, 1191
input gain command 991 keepalive retries command 339
installing Cisoc IOS software 39 keep-conference (voice register pool) command 782
installing hardware 37 keep-conference command 780
intercom command 939 keygen-retry command 476
intercom lines keygen-timeout command 476
configuring for SCCP phones 938 keypad-normalize command 168
configuring for SIP phones 942 keyswitch 20, 187
description 935 key system 20, 187
interface command 87 KPML 156
internal-call command 1002 kron occurrence command 248
international languages and tones kron policy-list command 247
alternative locales 307
user-defined locales 306
interoperability with other systems 629
L
intersite calling plan 284 label command 1129, 1131
ip dhcp pool command 83, 85, 94 language support 305
ip helper-address command 87 license requirements 19
ip http authentication command 387 lifetime certificate command 461, 485
ip http path flash command 386, 1089 line buttons
ip http server command 386, 897, 1089 fixed 1120
IP phone phone labels 1121
configuring phone options 1123 line selection, automatic 515
programmable vendor parameters 1121 list command 722, 731
ip qos dscp command 116, 127
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1255
Index
live-feed music on hold 983
M
LiveRcd soft key 1066
live record 408 mac-address command 166, 198, 205, 246
live record command 418 MAC addresses for analog phones 207
load (telephony service) command 61, 71 mailbox-selection (dial-peer) command 412
load-cfg-file command 467 mailbox-selection (ephone-dn) command 413
load command 63, 115, 126 mailbox selection policy 411, 412
loc2 command 977 manufacture-installed certificate, See MIC
local directory 823 max-calls-per-button command 167
locale installer 307 max-conferences command 779
locales max-dn command 116, 127
multiple 307 max-ephones command 102, 116
system-defined 306 max-idle-time command 906
user-defined 306 maximum bit-rate command 1112
locally significant certificate, See LSC maximum conference-party command 788
local speed dial 1088 maximum sessions command 340, 788
location command 868 max-pool command 127
logical partitioning class of restriction 573 max-presentation command 163
login (telephony-service) command 542 max-redirect command 725
Login soft key 1066 max-subscription command 1028
logout-profile command 904 max-timeout command 723
log table max-size command 1242 media encryption 445
log table retain-timer command 1242 media messages 1109
longest-idle ephone hunt groups 692 media path setup 1109
loopback call routing 947 media termination point, See MTP
loopback-dn command 951 meet-me conferencing 774
loss of C2 features announcement 964 Cisco CME 3.2 to Cisco Unified CME 4.0 775
LPCOR 573 MeetMe soft key 1067
lpcor incoming (ephone) command 591 messages
lpcor incoming (trunk group) command 585 debug 1115
lpcor incoming (voice port) command 586 flow control 1110
lpcor incoming (voice service) command 589 media 1109
lpcor outgoing (dial peer) command 589 MIBs 25
lpcor outgoing (ephone) command 592 MIC (manufacture-installed certificate) 451
lpcor outgoing (trunk group) command 585 configuring 487
lpcor outgoing (voice port) command 586 MLPP
lpcor type command 591 access digit 956
lpcor type mobile command 595 announcements 963
LSC (locally significant certificate) 451 explained 955
Cisco Unified Communications Manager Express System Administrator Guide
1256 OL-10663-02
Index
precedence 956 mwi reg-e164 command 432
preemption 957 mwi-server command 434, 438
service domains 961 mwi stutter command 432
mlpp indication command 969, 972 mwi-type command 189, 431
mlpp max-precedence command 967
mlpp preemption command 969, 972
N
mlpp service-domain command 969, 972
mobility command 1060 name command 160, 827, 834, 867
Mobility soft key 1061, 1067 network command 83
MOC client 1183 network-locale (ephone-template) command 319
mode command 63, 126 network-locale command 205, 319
mode ra command 485 network locales
MOH (music on hold) alternative 307
audio file to download 56 system-defined 306
from a live feed 983 user-defined 306
from an audio file 986 network parameters 75
transcoding between G.726 and G.711 330 NewCall soft key 1067
moh (telephony-service) command 987, 996 night service 698
moh command 993 examples 749
moh-file-buffer command 1003 notification 698
moh-group command 1000 night-service bell (ephone) command 736
monitoring call-park slots 557 night-service bell (ephone-dn) command 735
monitor-line button 1086 night-service call forwarding 614
monitor mode for shared lines 147 night-service code command 735
MTP (media termination point) night-service date command 734
remote phones 155 night-service day command 733
transcoding for video 1107 night-service everyday command 734
mtp command 210 night-service weekday command 734
multicast moh command 988, 997 night-service weekend command 735
multicast-moh command 989, 994 no-answer call forwarding 614
multi-party ad hoc conferencing 773 no ephone command 66
MWI no-reg (ephone-hunt) command 723
configuring Subscribe notify 433 no-reg command 182
configuring unsolicited notify 433 no supplementary-service sip moved-temporary
defining MWI outcall 432 command 1164, 1188
prefix specification for SIP 435 no supplementary-service sip refer command 1188
mwi command 430, 433, 435 notification, night-service 698
mwi-line command 199, 430 notification, on-hold 1048
mwi prefix command 436 notify telephone-event command 81, 91
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1257
Index
not-ready, automatic, ephone hunt groups 697 restrictions 738
no upgrade command 64 rollover to another button 704
no vad command 429 override for after-hours toll bar 537
no voice register pool command 69
nte-end-digit-delay command 168
P
NTP (Network Time Protocol) 77, 103
ntp server command 88 packet voice/data modules (PVDM) 331
ntp-server command 130 paging 1009
number (voice logout-profile) command 901 paging command 1012
number (voice register dn) command 170, 708, 943 paging-dn command 1014
number (voice register pool) command 172, 943 paging group command 1014
number (voice user-profile) command 906 parallel hunt groups 693
number command 160, 188, 418 param ea-password command 238
number plan 284 paramspace callsetup after-hours-exempt command 543
num-buttons command 163 paramspace command 239
parking calls 555, 556
park reservation-group command 564
O
park reservation groups 558
octo-lines park-slot command 563
autoprovisioning in SRST fallback mode 1210 Park soft key 1067
barge 521 pattern command 176
conferencing 772 pattern direct command 423
description 143 pattern ext-to-ext busy command 424
privacy 521 pattern ext-to-ext no-answer command 424
one-quarter common intermediate format, see QCIF 1106 pattern trunk-to-ext busy command 424
on-hold notification 1048 pattern trunk-to-ext no-answer command 424
OOD-R (out-of-dialog refer) 78 PBX model 285
open logical channel (OLC) 1110 PBX system 20, 158
operation command 991 peer ephone hunt groups 691
option 150 and configuration files, changing TFTP per-phone configuration files 103, 262
address 93
personal speed dial 1091
option 150 ip command 83, 85, 94
phone authentication 445
overlaid ephone-dns 147, 700
authentication string entering on phone 486
call waiting 702
CA configuration 459
definition 147
CAPF server configuration 473
examples 750
certificates 448
huntstop 700
configuration tasks 459
huntstop channel 740
CTL client and CTL provider configuration 468, 469
preference 700
examples 497
Cisco Unified Communications Manager Express System Administrator Guide
1258 OL-10663-02
Index
MIC importing 487 isolated code announcement 963
PKI 448 unauthorized announcement 964
RA configuration 483 vacant code announcement 964
telephony-service security configuration 466 preemption
telephony-service security parameters 466 explained 957
phone-key-size command 475 preemption reserve timer command 976
phone labels 1121 preemption tone timer command 975
phoneload command 164 preemption trunkgroup command 975
phone number plan 284 preemption user command 975
phone-redirect-limit command 667 preference (ephone-dn) command 683, 706
phones preference (ephone-hunt) command 723
analog 151 preference (voice hunt group) command 731
basic configuration 139 preference, dial-peer 683
configuration files 261 preference command 188, 708
remote teleworker 154 preference command, overlaid ephone-dns 700, 739
phone screen preference command for prebuilt dns 1215
custom background images 1120 presence call-list command 1027, 1032, 1034
header bar display 1120 presence command 1027, 1036
system message display 1122 presence enable command 1027
phone-specific parameters for individual SIP phones 171 presence service 1021
phone user GUI access setup 393 present-call command 724
using CLI 394 privacy 521
using GUI 393 privacy-button command 530, 533, 902, 907
pickup, See call pickup privacy command 529, 530, 532
pickup-call any-group command 711 privacy initial-state command 533
pickup-group command 711 privacy-on-hold command 529, 532
PickUp soft key 1067 private lines to Public Switched Telephone Network
(PSTN) 149
pilot command 721, 730
profile-identifier register command 790
PIN (personal identification number) 538
protocol mode command 108
pin (voice logout-profile) command 902
provision-tag command 246
pin (voice user-profile) command 906
PTT 1121
pin command 545
push-to-talk 1121
PKI (Public Key Infrastructure) 448
policy-list command 248
port (CAPF-server) command 475
Q
precedence
blocked announcement 963 QCIF (one-quarter common intermediate format) 1106
busy station announcement 963 qsig decode command 652
explained 956
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1259
Index
description 271
R
restart (ephone) command 274
RA (registration authority) 449 Resume soft key 1067
RADIUS accounting 22 retry register command 82, 91
ready/not-ready status, hunt groups 696 revocation-check command 356, 358, 464, 484, 488, 496
Real-Time Transport Protocol, See RTP RFC 2833 DTMF MTP passthrough 405
rebooting phones 271 ring command 1050
Redial soft key 1067 ringing, distinctive 1047
redirect-called translation rule 292 ringing call state 1066
redirect-target translation rule 292 ring number command (redundant router) 125
refer-ood enable command 95 RmLstC soft key 1067
refer target dial-peer command 1170 rollover button for overlaid ephone-dns 704
regenerate command 470, 473 route code 960
register id command 1168, 1191 route-code command 976
register support, SIP 77 routing, loopback 947
registrar command 81, 91, 113 RSA key pair 449
registrar server command 81, 1164, 1189 rsakeypair command 356, 358, 464, 484
registration, blocking automatic 119 RTP (Real-Time Transport Protocol) 1110
registration, video-enabled endpoints 1106 RTP packets 1111
registration authority, See RA rule command 292
relay, DTMF 77
reminder, call-park 557
reminder, on-hold 1048
S
remote-in-use (call state) 1066 SAST (system administrator security token)
remote phones 154 sast1 trustpoint command 469, 472
request outstanding command 1239 sast2 trustpoint command 470, 472
request timeout command 1239 SCCP (Skinny Client Control Protocol)
reset (voice register global) command 278, 279 analog phones 151
reset (voice register pool) command 64 firmware 54
reset tapi command 276 security 445
resetting all SIP phones 277 sccp blf-speed-dial retry-interval command 1036
resetting a TAPI session 276 sccp ccm command 342, 786
resetting phones sccp ccm group command 338, 786, 789
description 271 sccp command 787
reset (ephone) command 273, 277 SCCP Controlled Analog (FXS) Ports 206
resolution, for video 1106 sccp ip precedence command 349
response size command 1239 sccp local command 342, 786
response timeout command 1240 SCCP video endpoints 1108
restarting phones sdspfarm conference mute-on command 791
Cisco Unified Communications Manager Express System Administrator Guide
1260 OL-10663-02
Index
sdspfarm tag command 345, 347, 791 session transport protocol 157
sdspfarm transcode sessions command 345 shared ephone-dns 146
sdspfarm units command 791 shared-line command 170
secondary dial tone 286 shared-line overlays 701
secondary-dialtone command 300 shared lines 144, 284
secondary numbers 146 show call active video command 1116
secondary start command 724 show call prompt-mem-usage command 662
secure real-time transport protocol 445 show dspfarm sessions active command 352
secure-signaling trustpoint command 466 show dspfarm sessions command 351
secure transcoding 334, 457 show dspfarm sessions summary command 351
security, See phone authentication show ephone-dn park command 567
security command 163 show ephone-dn whisper-intercom command 941
seized (call state) 1066 show ephone offhook command 1116
selective call forwarding 614 show ephone phone-load command 72
Select soft key 1067 show ephone registered command 1114, 1116
sequential ephone hunt groups 690 show ephone socket command 111
serial-number command 484 show fb-its-log command 1243
server (CTL-client) command 470 show rtp connections command 1116
server cme command 470, 472 show running-config command 1115
server command 1036 show sccp command 350
server-security-mode command 468 show sccp connections command 350
service command 238, 240 show sccp connections details command 352
service dhcp command 87 show sdspfarm command 350
service digit 959 show shared-line command 371, 374
service-digit command 976 show sip-ua register status command 92, 93
service directed-pickup command 710 show sip-ua statistics command 92, 93
service-domain command 967, 974 show sip-ua status command 92
service-domain midcall-mismatch command 976 show sip-ua timers command 92, 93
service domains 961 show telephony-service bulk-speed-dial command 1095
service dss command 1090 show telephony-service security-info command 468
service local-directory command 826 show telephony-service tftp-bindings command 265
service phone g722CodecSupport command 184 show voice emergency callers command 880
service phone command 1138, 1139 show voice moh-group command 1005
service phone thumbButton1 command 1141 show voice moh-group statistics command 1006
service phone videoCapability command 1112 show voice register profile text command 267
Session Initiation Protocol, See SIP show voice register tftp-bind command 267
session protocol command 428 show voip rtp connections command 661, 1111
session-server command 1166, 1170, 1171 signal immediate command 991
session target command 240, 426, 428 signal loop-start live-feed command 991
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1261
Index
signature 449 bulk loading 1094
single in-line memory module (SIMM) sockets 331 buttons on phones 1092
single-line ephone-dn 142 local 1088
SIP (Session Initiation Protocol) monitor-line button 1086
dial plans 157 personal 1091
endpoints 1106 speed-dial (voice logout-profile) command 902
register support 77 speed-dial (voice user-profile) command 906
shared lines 144 speeddial.xml file 1084
sip command 81, 1164, 1188 speed dial buttons 1097
SIP MWI - QSIG translation 406 speed-dial command 1093, 1098
SIP phone firmware, upgrading 61 speed-dial options in GUI 895
SIP-to-SIP call forwarding 662 speed-dial options in phone user interface 895
sip-ua command 95, 113, 434, 437, 1027 speed-dial user interface 1087
slots, call-park 556 spfarm profile command 788
SNR (Single Number Reach) 1057 squeeze command 119, 263
snr calling-number local command 1060 srst dn line-mode command 1212
snr command 1060 srst dn template command 1212
soft key srst ephone description command 1213
display 1065 srst ephone template command 1212
DND 697 SRST fallback
feature blocking 1065 preference command for prebuilt dns 1215
HLog 697 SRST fallback mode 1205
softkeys alerting command 1070 srst mode auto-provision command 1212
softkeys commands 1065 SRTP 445
softkeys connected (voice register template) srtp fallback command 491, 493
command 1073
subnet command 874
softkeys connected command 415, 419, 795, 1061, 1070
supplementary-service h225-notify cid-update (dial-peer)
softkeys hold command 796, 1070, 1073 command 660
softkeys idle (voice register template) command 1073 supplementary-service h225-notify cid-update
(voice-service) command 659
softkeys idle command 796, 848, 1061, 1070
softkeys remote-in-use command 525, 527, 1071
supplementary-service h450.12 (dial-peer) command 647
softkeys ringIn command 848
supplementary-service h450.12 (voice-service)
command 646
softkeys ringing command 1071
supplementary-service h450.2 (dial-peer) command 638
softkeys seized (voice register template) command 1073
supplementary-service h450.2 (voice-service)
softkeys seized command 717, 796, 1071 command 637
software, downloading for Cisco Unified CME 54 supplementary-service h450.3 (dial-peer) command 638
source-addr command 474 supplementary-service h450.3 (voice-service)
source-address command 126 command 637, 650
speed dial supplementary-service h450.7 command 652, 654
Cisco Unified Communications Manager Express System Administrator Guide
1262 OL-10663-02
Index
supplementary-service media-renegotiate command 491 timeouts night-service bell command 735
supplementary-service qsig call-forward command 652, timeout transfer-recall command 636, 642
654
timers register command 82, 92
supplementary-service sip moved-temporarily
time-webedit command 389
command 655
time-zone command 118
supplementary-service sip refer command 656
timezone command 128
switchback interval command 340
TLS (transport layer security) 451
switchback method command 339
toll bar, after-hours 537
switchover method command 339
toll bar override 537
system administrator GUI access setup 387
toll fraud prevention 30
system administrator security token, See SAST
transcoding support 329
system-defined locales 306
transfer, See call transfer
system message command 1132
transfer-digit-collect command 637
transfer max-length command 643
T transfer-mode command 642
transfer-pattern blocked command 643
TACACS authentication for HTTP server 385
transfer-pattern command 636
TAPI (Telephony Application Programming Interface)
software 57 transfer recall 149, 617
telephony-service ccm-compatible (h323 voice-service) transfer-system command 635
command 658 transfer-system full-consult command 791
telephony-service ccm-compatible (voice-class) transfer to voice mail 408
command 659
translate command 292, 295
telephony service command 60, 70
translate-outgoing command 298
telephony-service security parameters 466
translation-profile command 294
teleworker remote phones 154
translation-profile incoming command 296
template command 668, 1153
transport layer security, See TLS
templates, creating and applying 1152
Trnsfer soft key 1067
tftp-path command 126
TrnsfVM soft key 1067
TFTP server
troubleshooting Cisco phone firmware upgrade 73
changing address 93
troubleshooting tips for upgrading, downgrading,
storing configuration files 103, 261 converting phone firmware 73
tftp-server command 60, 70, 115 trunk command 192, 195
tftp-server-credentials trustpoint command 467 trunk lines 149
three-party ad hoc conferencing 773 trunk monitoring 149
three-party conferencing, See conferencing trunk optimization 149
time-format command 118, 128 trustpoint 449
timeout command 722, 732 trustpoint (credentials) command 481
timeouts busy command 122 trustpoint-label command 474
timeouts interdigit (telephony-service) command 122 TSP (TAPI Service Provider) software 57
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1263
Index
type command 167, 172, 175, 198, 205, 943 call setup 1109
type ip-ste command 215 codec selection process 1109
codecs supported 1106
firmware version 1105
U
formats supported 1106
unauthorized precedence announcement 964 icon 1107
upa command 967 prerequisites 1111
upgrade command 63, 67 restrictions 1111
upgrading SIP firmware 61 setting parameters 1112
url authentication command 898 troubleshooting 1115
url command 1135, 1136 video (config-ephone) command 1114
url directories command 830 video (config-telephony) command 1112
url directory command 835 virtual voice port 141
url idle command 1132 VLAN 41
url services root command 1194 vm-integration command 423
user (voice logout-profile) command 901 vmwi dc-voltage command 437
user (voice user-profile) command 905 voice call send-alert coomand 1163
user-defined locales 306 voice-card command 784
user GUI access setup 393 voice class codec command 493
user-locale (ephone-template) command 319 voice-class codec command 494
user-locale command 317, 318 voice class custom-cptone command 785
user locales voice class mlpp command 974
alternative 307 voice-class mlpp command 974
system-defined 306 voice emergency response location command 867, 874
user-defined 306 voice emergency response zone command 868
username command 394 voice-gateway system command 205
utf8 command 164 voice hunt-group command 730
voice hunt groups 728
voice logout-profile command 901
V voice lpcor call-block cause command 582
vacant code announcement 964 voice lpcor custom command 582
vad command 241 voice lpcor enable command 582
vca command 977 voice lpcor ip-phone mobility command 596
vendorConfig parameters 1121 voice lpcor ip-phone subnet command 595
verifying firmware version on an IP phone 72 voice lpcor ip-trunk subnet incoming command 588
verifying SIP profiles 267 voice lpcor policy command 582
VG2xx autoconfiguration 152 voice mail
video Cisco Unity Express AXL enhancement 408
DTMF integration patterns 422
Cisco Unified Communications Manager Express System Administrator Guide
1264 OL-10663-02
Index
integration 401 XML files
mailbox selection policy 411, 412 downloading xml.template 56
MWI prefix specification for SIP 435 GUI configuration file 390
voicemail (voice register global) command 410, 415, 421 speeddial.xml for system speed dial 1084
voicemail command 418 xml user command 1241
voice mlpp command 966, 975
voice moh-group command 996
voice port, virtual 141
voice-port command 205
voice register dialplan command 175
voice register dn command 170, 421, 834, 942
voice register global command 63, 67, 126, 128, 131, 667, 835
voice register pool command 64, 172, 549, 943
voice-register session-server command 1168, 1190
voice register template command 668, 1153
voice services hardware 37
voice service voip command 1163
voice translation-profile command 292
voice translation-rule command 291
voice user-profile command 905
VoIP-to-VoIP connections
configuring 647
H.450 tandem gateways 625
hairpin call routing 622, 629
watcher all command 1036
watch mode for a phone 148
web admin customer command 393
web admin system command 388
web customize load command 391
whisper intercom 937
whisper intercom command 941
XML application programming interface 1237
Cisco Unified Communications Manager Express System Administrator Guide
OL-10663-02 1265
Index
Cisco Unified Communications Manager Express System Administrator Guide
1266 OL-10663-02
You might also like
- Cisco CCNA Command Guide: An Introductory Guide for CCNA & Computer Networking Beginners: Computer Networking, #3From EverandCisco CCNA Command Guide: An Introductory Guide for CCNA & Computer Networking Beginners: Computer Networking, #34.5/5 (2)
- Cisco Unified Communications Manager Express System Administrator Guide100% (1)Cisco Unified Communications Manager Express System Administrator Guide1,818 pages
- Cisco Unified Communications Manager Express System Administrator GuideNo ratings yetCisco Unified Communications Manager Express System Administrator Guide1,664 pages
- Cisco Unified Communications Manager Express ReferenceNo ratings yetCisco Unified Communications Manager Express Reference1,138 pages
- Cisco Cucm B Feature Configuration Guide For Cisco1251SU1No ratings yetCisco Cucm B Feature Configuration Guide For Cisco1251SU1882 pages
- Administration Guide For Cisco Unified Contact Center Enterprise, Release 12.0No ratings yetAdministration Guide For Cisco Unified Contact Center Enterprise, Release 12.0102 pages
- Cucm B Feature Configuration Guide 1251No ratings yetCucm B Feature Configuration Guide 1251676 pages
- Cisco-Ip-Phone-8800 - Series Maintenance & Troubleshooting GuideNo ratings yetCisco-Ip-Phone-8800 - Series Maintenance & Troubleshooting Guide282 pages
- CUCM BK C8A0AF97 00 Cucm-Managed-Service-Guide-100No ratings yetCUCM BK C8A0AF97 00 Cucm-Managed-Service-Guide-1001,084 pages
- Cucm B System Configuration Guide For CiscoNo ratings yetCucm B System Configuration Guide For Cisco436 pages
- Cisco Feature Configuration Guide For Cisco Unified Communications ManagerNo ratings yetCisco Feature Configuration Guide For Cisco Unified Communications Manager722 pages
- Cisco Callmanager Express 3.3 System Administrator Guide: Corporate HeadquartersNo ratings yetCisco Callmanager Express 3.3 System Administrator Guide: Corporate Headquarters370 pages
- Cisco - Unified Communicator - Administrator GuideNo ratings yetCisco - Unified Communicator - Administrator Guide1,034 pages
- New and Changed Information For Cisco Unified CommunicationsManager, Release 10.0No ratings yetNew and Changed Information For Cisco Unified CommunicationsManager, Release 10.0232 pages
- Cisco CUIP BK P82B3B16 00 Phones-services-Application-Development-notesNo ratings yetCisco CUIP BK P82B3B16 00 Phones-services-Application-Development-notes188 pages
- Cisco Unified Communications Operating System Administration GuideNo ratings yetCisco Unified Communications Operating System Administration Guide94 pages
- Cisco IP Communications Express CallManager Express With Cisco Unity ExpressNo ratings yetCisco IP Communications Express CallManager Express With Cisco Unity Express510 pages
- CUCM BK F3AC1C0F 00 Cucm Features Services Guide 100No ratings yetCUCM BK F3AC1C0F 00 Cucm Features Services Guide 1001,158 pages
- CUCM_BK_C5D96C80_00_cucm-os-admin-guide-91No ratings yetCUCM_BK_C5D96C80_00_cucm-os-admin-guide-91138 pages
- CISCO Unified Communications Manager Guide PDFNo ratings yetCISCO Unified Communications Manager Guide PDF1,118 pages
- Cisco Call Manager and Cisco IOS Interoperability GuideNo ratings yetCisco Call Manager and Cisco IOS Interoperability Guide194 pages
- Cisco IP Phone 8841, 8851, and 8861 User GuideNo ratings yetCisco IP Phone 8841, 8851, and 8861 User Guide128 pages
- Ucce B 12 0 Scripting-Media-Routing-GuideNo ratings yetUcce B 12 0 Scripting-Media-Routing-Guide260 pages
- Intelligent Internet Knowledge Networks: Processing of Concepts and WisdomFrom EverandIntelligent Internet Knowledge Networks: Processing of Concepts and WisdomNo ratings yet
- The CompTIA Network+ & Security+ Certification: 2 in 1 Book- Simplified Study Guide Eighth Edition (Exam N10-008) | The Complete Exam Prep with Practice Tests and Insider Tips & Tricks | Achieve a 98% Pass Rate on Your First Attempt!From EverandThe CompTIA Network+ & Security+ Certification: 2 in 1 Book- Simplified Study Guide Eighth Edition (Exam N10-008) | The Complete Exam Prep with Practice Tests and Insider Tips & Tricks | Achieve a 98% Pass Rate on Your First Attempt!5/5 (1)
- FCSS—Enterprise Firewall 7.4 Administrator Exam PreparationFrom EverandFCSS—Enterprise Firewall 7.4 Administrator Exam PreparationNo ratings yet
- Virtual Private Networking: A Construction, Operation and Utilization GuideFrom EverandVirtual Private Networking: A Construction, Operation and Utilization GuideNo ratings yet
- Avaya 1600 Series IP Deskphones: Installation and Maintenance Guide Release 1.2.xNo ratings yetAvaya 1600 Series IP Deskphones: Installation and Maintenance Guide Release 1.2.x90 pages
- Penetration Testing in Wireless Networks: Shree Krishna LamichhaneNo ratings yetPenetration Testing in Wireless Networks: Shree Krishna Lamichhane51 pages
- This Is Step by Step Upgrade Process For My Elastix A2billingNo ratings yetThis Is Step by Step Upgrade Process For My Elastix A2billing5 pages
- 14 Artificial Intelligence Techniques: Sense. Mistic Point of View, Which Could Be Expressed Somehow LikeNo ratings yet14 Artificial Intelligence Techniques: Sense. Mistic Point of View, Which Could Be Expressed Somehow Like22 pages
- Carrier Enhanced Voip Service Agreement Terms and ConditionsNo ratings yetCarrier Enhanced Voip Service Agreement Terms and Conditions9 pages
- Business Economy Service Plans: Site Name Phone Customer / Co. Name Fax Service Address E-Mail City, State - ZIP CellNo ratings yetBusiness Economy Service Plans: Site Name Phone Customer / Co. Name Fax Service Address E-Mail City, State - ZIP Cell1 page
- Cisco CCNA Command Guide: An Introductory Guide for CCNA & Computer Networking Beginners: Computer Networking, #3From EverandCisco CCNA Command Guide: An Introductory Guide for CCNA & Computer Networking Beginners: Computer Networking, #3
- Cisco Unified Communications Manager Express System Administrator GuideCisco Unified Communications Manager Express System Administrator Guide
- Cisco Unified Communications Manager Express System Administrator GuideCisco Unified Communications Manager Express System Administrator Guide
- Cisco Unified Communications Manager Express ReferenceCisco Unified Communications Manager Express Reference
- Cisco Cucm B Feature Configuration Guide For Cisco1251SU1Cisco Cucm B Feature Configuration Guide For Cisco1251SU1
- Administration Guide For Cisco Unified Contact Center Enterprise, Release 12.0Administration Guide For Cisco Unified Contact Center Enterprise, Release 12.0
- Cisco-Ip-Phone-8800 - Series Maintenance & Troubleshooting GuideCisco-Ip-Phone-8800 - Series Maintenance & Troubleshooting Guide
- CUCM BK C8A0AF97 00 Cucm-Managed-Service-Guide-100CUCM BK C8A0AF97 00 Cucm-Managed-Service-Guide-100
- Cisco Feature Configuration Guide For Cisco Unified Communications ManagerCisco Feature Configuration Guide For Cisco Unified Communications Manager
- Cisco Callmanager Express 3.3 System Administrator Guide: Corporate HeadquartersCisco Callmanager Express 3.3 System Administrator Guide: Corporate Headquarters
- Cisco - Unified Communicator - Administrator GuideCisco - Unified Communicator - Administrator Guide
- New and Changed Information For Cisco Unified CommunicationsManager, Release 10.0New and Changed Information For Cisco Unified CommunicationsManager, Release 10.0
- Cisco CUIP BK P82B3B16 00 Phones-services-Application-Development-notesCisco CUIP BK P82B3B16 00 Phones-services-Application-Development-notes
- Cisco Unified Communications Operating System Administration GuideCisco Unified Communications Operating System Administration Guide
- Cisco IP Communications Express CallManager Express With Cisco Unity ExpressCisco IP Communications Express CallManager Express With Cisco Unity Express
- CUCM BK F3AC1C0F 00 Cucm Features Services Guide 100CUCM BK F3AC1C0F 00 Cucm Features Services Guide 100
- Cisco Call Manager and Cisco IOS Interoperability GuideCisco Call Manager and Cisco IOS Interoperability Guide
- Intelligent Internet Knowledge Networks: Processing of Concepts and WisdomFrom EverandIntelligent Internet Knowledge Networks: Processing of Concepts and Wisdom
- The CompTIA Network+ & Security+ Certification: 2 in 1 Book- Simplified Study Guide Eighth Edition (Exam N10-008) | The Complete Exam Prep with Practice Tests and Insider Tips & Tricks | Achieve a 98% Pass Rate on Your First Attempt!From EverandThe CompTIA Network+ & Security+ Certification: 2 in 1 Book- Simplified Study Guide Eighth Edition (Exam N10-008) | The Complete Exam Prep with Practice Tests and Insider Tips & Tricks | Achieve a 98% Pass Rate on Your First Attempt!
- CCNA Exam Focus: Study Guide with Practice TestsFrom EverandCCNA Exam Focus: Study Guide with Practice Tests
- FCSS—Enterprise Firewall 7.4 Administrator Exam PreparationFrom EverandFCSS—Enterprise Firewall 7.4 Administrator Exam Preparation
- Virtual Private Networking: A Construction, Operation and Utilization GuideFrom EverandVirtual Private Networking: A Construction, Operation and Utilization Guide
- CCSP - Certified Cloud Security Professional Exam InsightsFrom EverandCCSP - Certified Cloud Security Professional Exam Insights
- Avaya 1600 Series IP Deskphones: Installation and Maintenance Guide Release 1.2.xAvaya 1600 Series IP Deskphones: Installation and Maintenance Guide Release 1.2.x
- Penetration Testing in Wireless Networks: Shree Krishna LamichhanePenetration Testing in Wireless Networks: Shree Krishna Lamichhane
- This Is Step by Step Upgrade Process For My Elastix A2billingThis Is Step by Step Upgrade Process For My Elastix A2billing
- 14 Artificial Intelligence Techniques: Sense. Mistic Point of View, Which Could Be Expressed Somehow Like14 Artificial Intelligence Techniques: Sense. Mistic Point of View, Which Could Be Expressed Somehow Like
- Carrier Enhanced Voip Service Agreement Terms and ConditionsCarrier Enhanced Voip Service Agreement Terms and Conditions
- Business Economy Service Plans: Site Name Phone Customer / Co. Name Fax Service Address E-Mail City, State - ZIP CellBusiness Economy Service Plans: Site Name Phone Customer / Co. Name Fax Service Address E-Mail City, State - ZIP Cell