System Installation and Initial Setup

When you order a new Cisco IPC Express system, both the router and the Cisco UE hardware come preinstalled with the software and licensing you purchased. You do not need to do a software installation for a new system unless you have to upgrade the software levels from what was originally ordered. This section provides a high-level overview of the software installation and initial system setup process.

Although you do not need to install software on a new system, you must configure the system to make it functional. Several setup utilities can help you with these first-time tasks and these utilities, as discussed in the following sections.

Software Installation

Cisco CME software is part of the general Cisco IOS router software. You need an IP voice or greater Cisco IOS image to get voice features, including Cisco CME. In addition to the Cisco IOS software, you purchase the following licenses based on the number of users at your site, as covered in Appendix A, "Cisco IPC Express Features, Releases, and Ordering Information":

• Cisco CME seat licenses for the number of IP phones
• Cisco UE voice mail licenses for the number of mailboxes

Note

If you are upgrading an existing router to become a Cisco CME system, you have to follow a full software installation procedure. Also, if you are upgrading an existing Cisco UE module to a new level of licensing or software, a software installation is required. Refer to Cisco.com for more detailed step-by-step instructions on router, Cisco CME, and Cisco UE software installation procedures.

 

Cisco CME Router Software Installation

Installing Cisco CME is exactly the same as installing your router with software. In summary, here are the steps:

Step 1.	Download the correct Cisco IOS software image and release level from the Cisco.com Software Center at http://www.cisco.com/go/software. Note that you have to be a registered Cisco.com user to access the Software Center.
Step 2.	Place these files on a Trivial File Transfer Protocol. (TFTP) or FTP server at your site.
Step 3.	Use the Cisco IOS router CLI to load the software image into router Flash.
Step 4.	Reboot the router.

In addition to loading the Cisco IOS software image, several processes apply to Cisco CME installation:

• Download the phone images into the router Flash.
• Download the GUI files into the router Flash. (You can use the archive command on the router to extract the contents of the entire .tar file with a single step into the router Flash.)
• Optionally, copy any TCL scripts needed by your configuration into router Flash.
• Optionally, copy any MOH files needed by your configuration into router Flash.

Cisco UE Installation

You can download Cisco UE software from the Cisco.com Software Center at http://www.cisco.com/go/software. Follow the links to Voice Software and Cisco UE. Cisco UE also ships with a set of CD-ROMs containing the software.

The Cisco UE application software resides on the storage medium of the Cisco UE hardware and has to be loaded separately from the router's software. The Cisco UE software files from Cisco.com or the CD-ROMs must be loaded onto an FTP server. From there the Cisco UE module itself is loaded via FTP from the server to the hard disk or compact Flash unit.

Note

The installation procedure for Cisco UE changed significantly between releases 1.1 and 2.0. Before release 2.0, Cisco UE did not have an onboard installer and required an additional TFTP step to load the installer before proceeding to the FTP step that installed the system software. As of release 2.0, the TFTP step is no longer required.

Cisco UE is an embedded Linux-based application. Although neither the operating system nor the file system is accessible to the administrator, it is instructive to know this to understand the methods of loading and troubleshooting the system.

The following files constitute the software components for a particular software release of Cisco UEin this example, release 2.0.1. The package and manifest files control the installation, and the .prt1 file is the actual software image. The exact files that constitute a release might differ slightly from one release to another. Before release 2.0 there was also a manifest file component.

• cue-installer.2.0.1
• cue-vm-full.2.0.1.pkg
• cue-vm-full.2.0.1.prt1

In addition to the software files, a license (or package) file must be installed on the Cisco UE system to determine the system parameters and identity controlled by licensing. One of the files listed next, corresponding to the license purchased for the system, must be installed on the application. The installation procedure is very similar to that of a software installation.

• cue-vm-12-license.2.0.1.cme.pkg
• cue-vm-25-license.2.0.1.cme.pkg
• cue-vm-50-license.2.0.1.cme.pkg
• cue-vm-100-license.2.0.1.cme.pkg
• cue-vm-12-license.2.0.1.ccm.pkg
• cue-vm-25-license.2.0.1.ccm.pkg
• cue-vm-50-license.2.0.1.ccm.pkg
• cue-vm-100-license.2.0.1.ccm.pkg

The Cisco UE application ships preinstalled from the Cisco factory, so there is no default license file and software download, and installation is required only for upgrading the system after the initial order. License installation is required only if a change is made to the system's licensingfor example, if a 25-mailbox system is upgraded to a 50-mailbox system. As shown in the file list, separate license files exist for Cisco UE deployed with Cisco CME (filename ending in .cme.pkg) or with Cisco Call Manager (filename ending in .ccm.pkg). These license files control the Cisco UE GUI pages that allow configuration parameters for the appropriate call control engine. Ensure that if you are using Cisco UE with a Cisco CME system you have the correct version of the license installed.

Installing Cisco UE is very similar to a router software installation. Always consult the appropriate release notes first for any software installation. You can find the release notes at the same Cisco.com location where you download the software.

In summary, here are the software installation steps:

Step 1.	Download the correct Cisco UE software image and release level from the Cisco.com Software Center (at http://www.cisco.com/go/software), or use the software files from your CD-ROM.
Step 2.	Download the Cisco UE license files (if they are changing from what is already installed on the system) from the same site.
Step 3.	Place these files on a server at your site set up for both TFTP and FTP.
Step 4.	If you are upgrading an existing Cisco UE system, you must do a backup before you start the software installation. An installation reformats the storage medium (disk or Flash) on your Cisco UE module.
Step 5.	Log into the router and shut down the Cisco UE module using the reload command at the Cisco UE CLI prompt. You also can use the service-module service-engine x/y reload command from the router CLI, where x/y is the slot in your router where the Cisco UE module is inserted.
Step 6.	During the Cisco UE bootup sequence, interrupt the normal automatic startup with three asterisks when prompted. (You see the message "Please enter '***' to change boot configuration: ***" on the screen. You have a few seconds to interrupt the bootup sequence and get to the Cisco UE bootloader prompt ServicesEngine bootloader>.)
Step 7.	Enter the required configuration at the bootloader prompt (such as the IP address of the FTP server where the software is loaded from).
Step 8.	Ping the FTP server to ensure that there is contact between the router and the server.
Step 9.	Enter the software load command, such as software install package url ftp://10.10.10.1/cue-vm-full.2.0.1.pkg user ftpuser, to install Cisco UE software release 2.0.1 from the FTP server at IP address 10.10.10.1 using the ftpuser login. The FTP server prompts you for a password, which you can then enter. This command starts the software installation, which takes several minutes. It requires no manual intervention, so it can be left unattended as long as you are making a log of the output in case any errors occur.

If you are also changing the licensing on Cisco UE, follow all the preceding steps exactly as if you are doing a software installation. However, in Step 9 you specify a license package filename instead of the software package file (cue-vm-full.2.0.1.pkg).

A sample license installation command is software install package url ftp://10.10.10.1/cue-vm-25-license.2.0.1.cme.pkg user ftpuser. This installs a 25-mailbox Cisco CME license on your Cisco UE system.

If you are upgrading an existing system, you must now do a restore from backup to reinstate the configuration and voice mail messages that were present on the Cisco UE system before the software installation.

Initial System Setup

As soon as the system is installed with all its software and licensing information, you must enter the basic configuration to make the system functional enough to drive the GUI so that you can do additional feature configuration. (You also can do this using the CLI if you choose.) Several Cisco CME and Cisco UE utilities help you with these tasks:

• Cisco CME Auto-Registration Utility
• Cisco CME Setup Utility
• Cisco UE Post-Installation Setup
• Cisco UE Initialization Wizard

The following sections describe each of these utilities.

Cisco CME Auto-Registration Utility

Your Cisco CME system can automatically detect and register new IP phones added to the network. With this capability, you no longer have to manually associate the Media Access Control (MAC) address of the IP phone and bind buttons to the ephone-dn definition.

IP phones added to the Cisco CME network register automatically. The Auto-Registration utility assigns an extension number (ephone-dn) on a first-come, first-served basis as long as a pool of extension numbers is preconfigured and available to use. Example 13-9 automatically assigns ephone-dns 1 to 8 for Cisco 7960 IP Phones newly discovered by the Cisco CME router. It also auto configures call forwarding for these ephone-dns, with calls forwarded to extension 59000 on busy or when they are not answered within 10 seconds.

Example 13-9. Configuration Sample for Auto-Registration Using CLI

telephony-service
 auto assign 1 to 8 type 7960 cfw 59000 timeout 10 
 create cnf-files
!
ephone-dn 1
 number 59001
!
ephone-dn 2
 number 59002
...
ephone-dn 8
 number 59008

If the configuration shown in Example 13-9 is not done on the Cisco CME system, newly added IP phones complete the boot and registration process with no button or extension number (ephone-dn) associated. They also cannot make or receive calls until manual configuration has been entered into the system. Be sure that the Example 13-9 configuration is in place if you want newly connected IP phones to be automatically registered and configured.

When automatically registering and configuring newly connected IP phones using the Cisco CME Auto-Registration utility, keep the following points in mind:

• Shared-line appearances on multiple phones can't be automatically set up by using the configuration shown in Example 13-9.
• Auto-registration isn't available on the Cisco 7914 Expansion Modules.
• Automatically assigned ephone-dn tags are normal ephone-dns (extensions). They are not the specialized directory number (DNs) needed for paging, intercom, MOH, and MWI.
• All the ephone-dns in an automatic assignment set must be in either single-line or dual-line mode; they cannot be mixed.
• Manual CLI commands are required to remove the configuration created by automatic assignment.

Cisco CME Setup Utility

The Cisco CME Setup Utility allows you to set up a CME system and its IP phones during a single session by providing a dialog box interface with a series of questions. This utility is extremely useful when you set up or install a Cisco CME system for the first time. Cisco CME automatically builds its configuration based on the selections and answers to the questions. As soon as all the phones have been registered, you must manually save the autogenerated configuration using the router write command.

You must enter telephony-service setup at the router prompt to trigger the Setup Utility. If a previous Cisco CME configuration exists, enter the no telephony-service command to remove the existing configuration, and then use the Setup Utility to create a new configuration.

The following is a list of parameters and fields queried during the Setup Utility. Your selections and answers to these allow Cisco CME to build a configuration automatically:

• DHCP service
• IP source address and Skinny Client Control Protocol (SCCP) port
• Number of phones
• Dual line or single line
• Language
• Call progress tones
• First extension number
• Direct inward dial (DID) service
• Forward calls
• Voice mail number

If you enter the telephony-service setup command on a system with a previous CME configuration, you see the prompts shown in Example 13-10.

Example 13-10. Cisco CME Setup Utility Configuration Sample

router(config)#telephony-service setup
--- Cisco IOS Telephony Services already configured. --- 
- Please do "no telephony-service" to cleanup & run Setup again -
router(config)#no telephony-service

If you enter the telephony-service setup command again, you see the prompts shown in Example 13-11.

Example 13-11. Cisco CME Setup Utility Prompts

router(config)#telephony-service setup
 --- Cisco IOS Telephony Services Setup ---
Do you want to setup DHCP service for your IP Phones? [yes/no]: y
Configuring DHCP Pool for Cisco IOS Telephony Services :
 IP network for telephony-service DHCP Pool: 192.168.1.0
 Subnet mask for DHCP network: 255.255.255.255.0
 TFTP Server IP address (Option 150): 192.168.1.1
 Default Router for DHCP Pool: 192.168.1.1
Do you want to start telephony-service setup? [yes/no]: y
Configuring Cisco IOS Telephony Services:
 Enter the IP source address for Cisco IOS Telephony Services: 192.168.1.1
 Enter the Skinny Port for Cisco IOS Telephony Services: [2000]: 2000
 How many IP phones do you want to configure: [0]: 3
 Do you want dual-line extensions assigned to phones? [yes/no]: y
 What Language do you want on IP phones:
 0 English
 1 French
 2 German
 3 Russian
 4 Spanish
 5 Italian
 6 Dutch
 7 Norwegian
 8 Portuguese
 9 Danish
 10 Swedish
 [0]: 0
 Which Call Progress tone set do you want on IP phones:
 0 United States
 1 France
 2 Germany
 3 Russia
 4 Spain
 5 Italy
 6 Netherlands
 7 Norway
 8 Portugal
 9 UK
 10 Denmark
 11 Switzerland
 12 Sweden
 13 Austria
 14 Canada
[0]: 0
 What is the first extension number you want to configure: [0]: 1001
Do you have Direct-Inward-Dial service for all your phones? [yes/no]: n
Do you want to forward calls to a voice message service? [yes/no]: y
 Enter extension or pilot number of the voice message service: 57777
 Call forward No Answer Timeout: [18]: 10
Do you wish to change any of the above information? [yes/no]: n
 ---- Setup completed config ---
router(config)#
Jan 9 17:50:24.069: %LINK-3-UPDOWN: Interface ephone_dsp DN 1.1, changed statep
Jan 9 17:50:24.069: %LINK-3-UPDOWN: Interface ephone_dsp DN 1.2, changed statep
Jan 9 17:50:24.069: %LINK-3-UPDOWN: Interface ephone_dsp DN 2.1, changed statep
Jan 9 17:50:24.069: %LINK-3-UPDOWN: Interface ephone_dsp DN 2.2, changed statep
router(config)#
Jan 9 17:50:55.467: %IPPHONE-6-REG_ALARM: 16: Name=SEP000DBC50DEC6 Load=3.2(2.d
Jan 9 17:50:55.467: %IPPHONE-6-REGISTER_NEW: ephone-1:SEP000DBC50DEC6 IP:192.1.
router(config)#
reseting 000D.BC50.DEC6
Jan 9 17:50:57.499: %IPPHONE-6-UNREGISTER_NORMAL: ephone-1:SEP000DBC50DEC6 IP:.
router(config)#
Jan 9 17:51:14.220: %IPPHONE-6-REG_ALARM: 21: Name=SEP00036B7FFF59 Load=5.0(3.P
Jan 9 17:51:14.220: %IPPHONE-6-REGISTER_NEW: ephone-2:SEP00036B7FFF59
IP:192.168.1.13
reseting 0003.6B7F.FF59
Jan 9 17:51:16.517: %IPPHONE-6-UNREGISTER_NORMAL: ephone-2:SEP00036B7FFF59 IP:.
router(config)#
Jan 9 17:52:01.296: %IPPHONE-6-REG_ALARM: 22: Name=SEP000DBC50DEC6 Load=3.2(2.t
Jan 9 17:52:01.296: %IPPHONE-6-REGISTER: ephone-2:SEP000DBC50DEC6 IP:192.168.1.12
router(config)#end
router#show ephone register
ephone-1 Mac:000D.BC50.DEC6 TCP socket:[7] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0
IP:192.168.1.13 51378 Telecaster 7960 keepalive 16 max_line 6
button 1: dn 1 number 1001 CH1 IDLE CH2 IDLE
ephone-2 Mac:0003.6B7F.FF59 TCP socket:[9] activeLine:0 REGISTERED
mediaActive:0 offhook:0 ringing:0 reset:0 reset_sent:0 paging 0 debug:0
IP:192.168.1.12 50922 Telecaster 7960 keepalive 15 max_line 6
button 1: dn 2 number 1002 CH1 IDLE CH2 IDLE

The Setup Utility automatically generates the configuration commands shown in Example 13-12.

Example 13-12. Commands Created by the Cisco CME Setup Utility

! when DHCP service is selected
ip dhcp pool ITS
 network 192.168.1.0 255.255.255.0
 option 150 ip 192.168.1.1
 default-router 192.168.1.1
! auto-generated telephony-service commands
telephony-service
 load 7910 P00403020214
 load 7960-7940 P00303020214
 max-ephones 3
 max-dn 3
 ip source-address 192.168.1.1
 port 2000
 auto assign 1 to 3
 create cnf-files version-stamp 7960 Jan 09 2004 17:50:24
 voicemail 57777
 max-conferences 8
! Note that Setup tool uses auto-assign command to assign ephone-dns to the phones
ephone-dn 1 dual-line
 number 1001
 call-forward busy 57777
 call-forward noan 57777 timeout 10
!
ephone-dn 2 dual-line
 number 1002
 call-forward busy 57777
 call-forward noan 57777 timeout 10
!
ephone 1
 mac-address 000D.BC50.DEC6
 type 7960
 button 1:1
!
ephone 2
 mac-address 0003.6B7F.FF59
 type 7960
 button 1:2

 

Cisco UE Post-Installation Setup

After you have completed a software installation on Cisco UE, the software automatically starts up. During the first startup, the software detects that no configuration has been entered yet. It asks you a series of questions to set up a Domain Name System (DNS), a Network Time Protocol (NTP) time server, the system's time zone, and an initial administrator account (user ID and password) that you will use later to log into the GUI. Example 13-13 shows this exchange.

Example 13-13. Cisco UE Post-Installation Setup

********** rc.post_install ****************
IMPORTANT:: Welcome to Cisco Systems Service Engine
IMPORTANT:: post installation configuration tool.
IMPORTANT:: This is a one time process which will guide
IMPORTANT:: you through initial setup of your Service Engine.
IMPORTANT:: Once run, this process will have configured
IMPORTANT:: the system for your location.
IMPORTANT:: If you do not wish to continue, the system will be halted
IMPORTANT:: so it can be safely removed from the router.
Do you wish to start configuration now (y,n)? y
Are you sure (y,n)? y
Enter Hostname: cue-site6
Enter Domain Name (mydomain.com, or enter to use localdomain):
IMPORTANT:: DNS Configuration:
IMPORTANT:: This allows the entry of hostnames, for example foo.cisco.com, instead
IMPORTANT:: of IP addresses like 1.100.10.205 for servers used by CUE. In order
IMPORTANT:: to configure DNS you must know the IP address of at least one of your
IMPORTANT:: DNS Servers.
Would you like to use DNS for CUE (y,n)?n
WARNING: If DNS is not used CUE will require the use
WARNING: of IP addresses.
Are you sure (y,n)? y
Enter IP Address of the Primary NTP Server (IP address, or enter for
 171.19.153.38):
Found server 171.19.153.38
Enter IP Address of the Secondary NTP Server (IP address, or enter to bypass):
Please identify a location so that time zone rules can be set correctly.
Please select a continent or ocean.
1) Africa 4) Arctic Ocean 7) Australia 10) Pacific Ocean
2) Americas 5) Asia 8) Europe
3) Antarctica 6) Atlantic Ocean 9) Indian Ocean
#? 2
Please select a country.
 1) Anguilla 18) Ecuador 35) Paraguay
 2) Antigua & Barbuda 19) El Salvador 36) Peru
 3) Argentina 20) French Guiana 37) Puerto Rico
 4) Aruba 21) Greenland 38) St Kitts & Nevis
 5) Bahamas 22) Grenada 39) St Lucia
 6) Barbados 23) Guadeloupe 40) St Pierre & Miquelon
 7) Belize 24) Guatemala 41) St Vincent
 8) Bolivia 25) Guyana 42) Suriname
 9) Brazil 26) Haiti 43) Trinidad & Tobago
10) Canada 27) Honduras 44) Turks & Caicos Is
11) Cayman Islands 28) Jamaica 45) United States
12) Chile 29) Martinique 46) Uruguay
13) Colombia 30) Mexico 47) Venezuela
14) Costa Rica 31) Montserrat 48) Virgin Islands (UK)
15) Cuba 32) Netherlands Antilles 49) Virgin Islands (US)
16) Dominica 33) Nicaragua
17) Dominican Republic 34) Panama
#? 45
Please select one of the following time zone regions.
 1) Eastern Time
 2) Eastern Time - Michigan - most locations
 3) Eastern Time - Kentucky - Louisville area
 4) Eastern Standard Time - Indiana - most locations
 5) Central Time
 6) Central Time - Michigan - Wisconsin border
 7) Mountain Time
 8) Mountain Time - south Idaho & east Oregon
 9) Mountain Time - Navajo
10) Mountain Standard Time - Arizona
11) Pacific Time
12) Alaska Time
13) Alaska Time - Alaska panhandle
14) Alaska Time - Alaska panhandle neck
15) Alaska Time - west Alaska
16) Aleutian Islands
17) Hawaii
#? 11
The following information has been given:
 United States
 Pacific Time
Therefore TZ='America/Los_Angeles' will be used.
Local time is now: Wed Sep 1 05:40:16 PDT 2004.
Universal Time is now: Wed Sep 1 12:40:16 UTC 2004.
Is the above information OK?
1) Yes
2) No
#? 1
Configuring the system. Please wait...
...
IMPORTANT:: Administrator Account Creation
IMPORTANT:: Create an administrator account. With this account,
IMPORTANT:: you can log in to the Cisco Unity Express GUI and
IMPORTANT:: run the initialization wizard.
Enter administrator user ID: (user ID): admin
Enter password for admin:
Confirm password for admin by reentering it:
SYSTEM ONLINE
cue-site6>
cue-site6> show software version 
Installed Packages:
 - Core 2.0.0.6
 - Auto Attendant 2.0.0.6
 - Global 2.0.0.6
 - Voice Mail 2.0.0.6
Installed Languages:
 - US English 2.0.0
cue-site6> show software license 
Core:
 - application mode: CCME
 - total usable system ports: 4
Voicemail/Auto Attendant:
 - max system mailbox capacity time: 480
 - max general delivery mailboxes: 15
 - max personal mailboxes: 50
Languages:
 - max installed languages: 1
max enabled languages: 1

As shown in Example 13-13, the post-installation setup asks you a series of questions that help you set up the host name, DNS entries, and time zone information for the Cisco UE system. The last two commands shown in Example 13-13, show software version and show software license, are not part of the post-installation setup. However, they are handy commands to use to check that the system has been installed with the software and license you intended.

Cisco UE Initialization Wizard

If you set up your entire system using the CLI, you never need or see the Cisco UE Initialization Wizard. On the other hand, if you are setting up a newly installed Cisco UE system for the first time, the GUI Initialization Wizard is a handy way to set up the basic configuration for the system in a few successive GUI screens.

The Cisco UE Initialization Wizard comes up automatically the first time you log into the GUI of a newly installed Cisco UE system. After you finish working through the Cisco UE Initialization Wizard, you can never run it again. The only way to access it again is to reinstall the software on the Cisco UE system. However, everything you can do from the Cisco UE Initialization Wizard can also be done later using the normal GUI screens. The Cisco UE Initialization Wizard simply lays it out in an easy-to-use sequence for setting up a system that has no prior configuration to make sure you configure all the system's basic aspects.

To get the best results from the Cisco UE Initialization Wizard, configure your Cisco CME IP phones and extensions before you enter the Wizard. The Cisco UE Initialization Wizard walks you through several steps (each on a separate screen) that request basic system configuration information:

• Cisco CME Login This screen asks for the Cisco CME administrator login (configured using the web admin command under telephony-service on the router). This is used to coordinate configuration information between Cisco CME and Cisco UE.
• Import Users In this step, the Cisco UE software imports all the users (IP phones, their extensions, and the usernames) found in the router configuration. This screen allows you to select which ones you want to import. You can also choose which users get a mailbox and which users get administrator privileges assigned to the user ID.
• System Defaults This step allows you to set the password and PIN generation policy for the system and the mailbox size and expiry defaults to be used for mailbox creation.
• Call Handling This step allows you to set the pilot numbers for voice mail, AA, and administrator TUI access, as well as the MWI DNs for the system.

The final screens summarize the configuration you have entered, allow you to go back and make changes, and commit the configuration to the system.

After you have completed the Cisco UE Initialization Wizard, the system logs you out, and you have to log back in using the administrator login. At this point, you see the normal system login screen.

Prerequisites to Using the GUI

Before you set up the GUI features, you should be familiar with the prerequisites for using the GUI, including the following:

• Copy all the GUI files into the Cisco CME router's Flash.
• Configure the Cisco CME router to act as an HTTP server and to service the HTML GUI files.
• Use Microsoft IE version 6.0 or later.
• Limit the size of the XML file to 4000 bytes or smaller if you plan on using an XML configuration file to create a customized administrator login.

Note

You might change the password of the system administrator, customer administrator, and phone user via the GUI.

 

GUI File Installation

The GUI and xml.template files supporting the Cisco CME GUI are bundled into a single archive, such as cme-gui-x.x.x.tar, where x.x.x indicates the Cisco CME software release that this file pertains to. You can download this .tar file from the Cisco.com Software Center by looking for Voice Software and then for Cisco CME under Voice Applications Software.

Each release of Cisco IOS software is shipped with a unique version of the Cisco CME GUI file set. Therefore, you should be sure that the files matching the Cisco IOS release on your router are installed in the Cisco CME router Flash to ensure that the GUI features function properly. When upgrading a Cisco CME router from one version of Cisco IOS software to another, you must erase the old GUI files from Flash, and replace them with the new set matching the software release now installed on the router.

To copy and extract the contents of the cme-gui-x.x.x.tar file to the router's Flash, follow these steps:

Step 1.	Download the appropriate cme-gui-x.x.x.tar file to a TFTP server, substituting the Cisco CME release you're using for x.x.x.
Step 2.	Log on to privileged EXEC mode on the router.
Step 3.	Enter the archive command to extract the contents of the .tar file to the router's Flash memory: router#archive tar /xtract tftp://ip-address/cme-gui-x.x.x.tar flash:   For example, to extract the contents of cme-gui-3.0.3.tar from the TFTP server at IP address 192.168.1.1 to the router's Flash, enter the following command: router#archive tar /xtract tftp://192.168.1.1/cme-gui-3.0.3.tar flash:

The files extracted to Flash include

• CiscoLogo.gif
• dom.js
• normal_user.js
• Delete.gif
• downarrow.gif
• sxiconad.gif
• Plus.gif
• ephone_admin.html
• telephony_service.html
• Tab.gif
• uparrow.gif
• admin_user.html
• logohome.gif
• xml-test.html
• admin_user.js
• normal_user.html
• xml.template

Setting up the Router for HTTP

After the Cisco CME GUI files have been extracted to the router's Flash, you must configure the Cisco CME router to act as an HTTP server, set the base path for the HTML files, and enter a Cisco CME administrator account username and password, as shown in Example 13-14.

Example 13-14. Enabling the Cisco CME Router as an HTTP Server

router#show running-config
ip http server 
ip http path flash: 
...
telephony-service
 web admin system name admin1 password admin1pswd 
 web admin customer name admin2 password admin2pswd
 dn-webedit
 time-webedit

The following commands are needed to allow an IP phone user to log in and use the GUI to manage his or her own phone, and perform some basic configuration tasks:

router#ephone 1
router#username user1 password user1pswd

At this point, you can access the Cisco CME GUI pages by pointing your browser to the following link:

http://ip-address of your router/ccme.html

If you also have Cisco UE installed on your router (and it already has an IP address assigned, as discussed in the following section), you can access the integrated system GUI by pointing your browser to the following link:

http://ip-address of your CUE module/

Note

You must enable IP routing on the Cisco CME router for the Cisco UE GUI to connect correctly.

 

Router Prerequisite Configuration for Cisco UE

The Cisco UE GUI provides access to configure AA and voice mail application features. If you have just installed a brand new system, you must perform some basic router configuration before the CLI or GUI can access the Cisco UE module for application-level configuration. The prerequisite router configuration for access to Cisco UE is discussed in the following sections.

Service-Engine Interface

The Cisco UE hardware shows up on the router as a service-engine interface, as shown in Example 13-15.

Example 13-15. Router Service-Engine Interface for Cisco UE

router#show version
Cisco IOS Software, 2600 Software (C2691-IPVOICE-M), Version 12.3(8)T3, RELEASE
 SOFTWARE (fc1)
...
2 FastEthernet interfaces
1 terminal line
1 cisco service engine(s) 
DRAM configuration is 64 bits wide with parity disabled.

 

IP Connectivity

To be able to communicate with the Cisco UE module, you must assign it an IP address. The most common way to configure the Cisco UE module is by using the unnumbered IP address method. An ip unnumbered configuration, shown in Example 13-16, allows the Cisco UE module to consume an IP address in the subnet of the network associated with a particular router egress port, such as FastEthernet 0/0 or a loopback interface. The router interface that the Cisco UE interface is associated with must be in an up state at all times for Cisco UE to communicate.

Note

The ip unnumbered method of IP addressing for Cisco UE requires the configuration of a static route to the service-engine interface.

 

Example 13-16. IP Unnumbered Configuration

router#show running-config
interface FastEthernet0/0
 ip address 171.68.10.1 255.255.255.0
!
interface Service-Engine4/0 
 ip unnumbered FastEthernet0/0
 service-module ip address 171.68.10.10 255.255.255.0
 service-module ip default-gateway 171.68.10.1
!
ip route 171.68.10.10 255.255.255.255 Service-Engine4/0 

The IP address of the Cisco UE module in Example 13-16 is 171.68.10.10. The default gateway on the service-engine interface must be set to the IP address of the Ethernet interface on the router that the unnumbered statement refers to (171.68.10.1 in the example). The default gateway setting for Cisco UE must be the Cisco CME router. You can also use a subinterface or a loopback interface as the ip unnumbered parameterfor example, by replacing ip unnumbered FastEthernet0/0 with an ip unnumbered Loopback0 statement.

It is also possible to assign Cisco UE its own IP subnet. This configuration does not require a static route. In this configuration the IP address must be routable such that the TFTP or FTP server used for software installation or backup knows how to reach the Cisco UE module. This is shown in Example 13-17.

Example 13-17. Stub Network Configuration

router#show running-config
interface FastEthernet0/0
 ip address 171.68.10.1 255.255.255.0
!
interface Service-Engine4/0 
 ip address 171.68.20.1 255.255.255.0
 service-module ip address 171.68.20.10 255.255.255.0
 service-module ip default-gateway 171.68.20.1

The last variation that you can use for Cisco UE is to configure its IP address as a VLAN (virtual LAN). This method is typically used if a LAN switch module is integrated into the Cisco CME router instead of using an external LAN switch. This configuration, shown in Example 13-18, is very similar to the ip unnumbered configuration given previously and also requires a static route.

Example 13-18. VLAN Configuration

router#show running-config
interface VLAN1
 ip address 171.68.10.1 255.255.255.0
!
interface Service-Engine4/0
 ip unnumbered VLAN1 
 service-module ip address 171.68.10.10 255.255.255.0
 service-module ip default-gateway 171.68.10.1
!
ip route 171.68.10.10 255.255.255.255 Service-Engine4/0 

 

Date and Time

Cisco UE's date and time are controlled by two configurations on the system:

• Time zone and geographic area
• NTP source

Although the Cisco UE module has its own onboard clock, you cannot set the clock using the GUI or CLI. The Cisco UE clock is controlled entirely via NTP (which is in Coordinated Universal Time [UTC]). The system's time zone setting (shown earlier in Example 13-13) controls the offset from UTC to local time. The clock is synchronized with the NTP source during Cisco UE software startup and ongoing synchronization checks while the application is running. Therefore, it is important to insert a valid NTP configuration to ensure that the Cisco UE clock is set correctly.

The following Cisco UE module configuration is required to set the clock's NTP source:

ntp server 171.19.153.31

Note

On a Cisco CME system with Cisco UE, the GUI clock set capability on the Configure > System Parameters > System Time GUI screen displays and controls the Cisco CME router clock, not the Cisco UE module clock. Setting the router's clock has no effect on Cisco UE, unless the router is also defined as the NTP source for Cisco UE.

 

Call Routing to the AA and Voice Mail Pilot Numbers

Cisco UE is logically an application across a LAN segment from the Cisco CME router. It just so happens that the LAN segment physically runs across the backplane of the router chassis. No IP packets can reach Cisco UE unless IP routing is enabled on the router, the Cisco UE module has a valid IP address, and some call routing statements exist on the router to direct calls via VoIP to Cisco UE.

The Cisco CME router, as well as any other PSTN gateways that might exist in your office, must have dial peers configured to route calls to the Cisco UE AA and voice mail pilot numbers.

The Cisco CME router hosting Cisco UE must have a Session Initiation Protocol (SIP) dial peer for AA and voice mail calls with the following parameters:

• Disable VAD (voice activity detection)
• G.711 codec
• SIP-Notify dual-tone multifrequency (DTMF) relay

You can define a single wildcard dial peer for both your AA and voice mail pilot numbers, or you can define separate, more explicit dial peers for each pilot number individually. Example 13-19 shows a combined SIP dial peer applicable to a sample AA pilot number of 6800 and a voice mail pilot of 6801. The IP address of the Cisco UE, in this example, is 171.68.10.10. The dial peer example shown here assumes that your office has no other extensions starting with 680. If you do, you have to use a more explicit destination pattern in the dial peer for Cisco UE calls.

Example 13-19. SIP Dial Peer for Cisco UE

dial-peer voice 3100 voip
 description VM-AA
 destination-pattern 680.
 session protocol sipv2
 session target ipv4: 171.68.10.10 
 dtmf-relay sip-notify 
 codec g711ulaw 
 no vad 

If your PSTN trunks are integrated into your Cisco CME router, you do not need any further configuration to route calls to Cisco UE. The SIP dial peer shown in Example 13-19 is sufficient to route both IP phone and PSTN calls to Cisco UE. On the other hand, if you are using a separate router for your PSTN trunks and there is an IP network segment (LAN or WAN) between the PSTN gateway router and the Cisco CME router, you must configure H.323 dial peers on the PSTN gateway to route calls to Cisco CME (and Cisco UE).

Cisco CME GUI Customization Via XML