Upgrading the Cisco ATA Signaling Image


This section describes two methods for upgrading the Cisco ATA software for the SCCP protocol:

Upgrading the Signaling Image Via Cisco CallManager—This is the Cisco-recommended method for the SCCP protocol. This method is the most efficient method and requires no configuration-file changes.

Upgrading the Signaling Image Manually—This method can be used if you want to manually upgrade the image of one Cisco ATA. However, this method is not recommended in the Cisco CallManager environment because of configuration changes that are required before and after performing the upgrade.

This section also describes procedures for verifying a successful image upgrade:

Confirming a Successful Signaling Image Upgrade—Procedures for using your Web browser or the voice configuration menu are included.


Note If the Cisco ATA is loaded with a SCCP image version earlier than ata186-v2-15-ms-020911b and has registered to a Cisco CallManager, upgrading the SCCP image to ata186-v2-15-ms-02911b or later may cause the Cisco CallManager to show a "Not Registered" status. This status may appear even if the Cisco ATA has successfully completed the registration process. In this scenario, you must restart the Cisco CallManager to update the to the proper Cisco ATA registration status. (For more information, see the "Restarting the Cisco CallManager" section.)



Caution Do not unplug the Cisco ATA while the function button is blinking. Doing so can cause permanent damage to the device. The function button blinks during an upgrade.


Note The term Cisco ATA is used throughout this manual to refer to both the Cisco ATA 186 and the Cisco ATA 188, unless differences between the Cisco ATA 186 and Cisco ATA 188 are explicitly stated.


Upgrading the Signaling Image Via Cisco CallManager

This feature is supported in Cisco CallManager version 3.2 or later and is the Cisco-recommended method for SCCP. The following requirements must be met:

XML support must be turned on in the Cisco ATA (default is on). XML support is configured with Bit 31 of the ConnectMode parameter (see the "ConnectMode" section).

This procedure can only be performed by the Cisco CallManager administrator.

Obtain the latest signaling image from the Cisco web site. See the "Setting Up the TFTP Server with Cisco ATA Software" section for instructions on where to find the software on the Cisco web site and how to place the files onto the Cisco CallManager TFTP server. The image file has the extension of .zup.

This section contains procedures for two different scenarios:

Procedure for Upgrading all Cisco ATAs at Once

Procedure for Upgrading One Cisco ATA

Procedure for Upgrading all Cisco ATAs at Once


Step 1 Download the latest Cisco ATA release software for SCCP from the Cisco web site, and store the files on the Cisco CallManager TFTP server. For more information, see the "Setting Up the TFTP Server with Cisco ATA Software" section.

Step 2 Go to the main Cisco CallManager Administration screen.

Step 3 From the System pull-down menu, select Device Defaults. The Device Defaults screen appears.

Step 4 In the Device Type list, find the device type Cisco ATA 186. In the Load Information field next to the device type of Cisco ATA 186, enter the name of the signaling image (the signaling image has an extension of .zup, for example, ATA186-v2-15-ms-020812a.zup) to use for upgrading the Cisco ATAs.

Step 5 Press the Update button at the top of the Device Defaults screen.

Step 6 From the Device pull-down menu, select Phone. The Find and List Phones screen appears.

Step 7 In the area next to the Find button, enter the letters "ata", then press Find. The Find and List Phones screen reappears, and now contains all the Cisco ATAs connected to your Cisco CallManager.

Step 8 Check the box to the left of the Device Name column (above all listed devices) to select all the Cisco ATAs shown.

Step 9 Click the Reset Selected button at the bottom of the Find and List Phones screen.

Step 10 The Reset Device pop-up window appears. Click Reset Device. The Reset Device popup window appears. Click Reset to complete the procedure.

Step 11 A confirmation box appears. Click OK.

The function button on each Cisco ATA blinks during its upgrade. Once the button stops blinking, the upgrade is complete and the device re-registers to the Cisco CallManager.


Procedure for Upgrading One Cisco ATA


Step 1 Download the latest Cisco ATA release software for SCCP from the Cisco web site, and store the files on the Cisco CallManager TFTP server. For more information, see the "Setting Up the TFTP Server with Cisco ATA Software" section.

Step 2 Go to the main Cisco CallManager Administration screen.


Note Before continuing this procedure, make sure that the Load Information field for the Cisco ATA 186 Device Type is set to 0 on the Device Defaults screen (System > Device Defaults).


Step 3 From the Device pull-down menu, select Phone. The Find and List Phones screen appears.

Step 4 In the area next to the Find button, enter a portion or all of the Cisco ATA MAC address, then press Find. The Find and List Phones screen reappears, and now contains the Cisco ATAs that match the find criteria you entered in the previous screen.

Step 5 Click the icon of the Cisco ATA whose signaling image you would like to upgrade. The Phone Configuration screen appears.

Step 6 In the Phone Load field, enter the name of the signaling image (the signaling image has an extension of .zup, for example, ATA186-v2-15-ms-020812a.zup).

Step 7 Press Update.

Step 8 You will receive a message that you should reset the device. Click OK.

Step 9 Click the Reset Phone button on the Phone Configuration screen.

Step 10 The Reset Device pop-up window appears. Click Reset.

Step 11 A confirmation box appears. Click OK.

The Function button on the Cisco ATA blinks during the upgrade. Once the button stops blinking, the upgrade is complete and the device re-registers to the Cisco CallManager.


If you use this method, you should be running Cisco CallManager versions 3.0 or 3.1 only.

If you are a registered CCO user. go to the following URL: http://www.cisco.com/cgi-bin/tablebuild.pl/ata186

Download the zip file that contains the software for the applicable release and signaling image you are using. The contents of each file are described next to the file name. Save the zip file onto a floppy disc.

Running the Executable

upgradecode Syntax

upgradecode:3,0x301,0x0400,0x0200,tftp_server_ip,69,image_id,image_file

upgradecode Definitions

The following values need to be modified:

tftp_server_ip is the TFTP server which contains the latest image (image_file).

Upgrading the Signaling Image Manually

This section describes how to manually upgrade the Cisco ATA with the most recent signaling image. The executable file that you need is called ata186us.exe, and is bundled in the Cisco ATA release-software zip file.

You should use this procedure only if the Cisco CallManager IP address or URL has been statically configured with the CA0orCM0 or CA1orCM1 parameters (see the "CA0orCM0 and CA1orCM1" section).

This section contains the following topics:

Preliminary Steps

Running the Executable File

Preliminary Steps

Before you run the executable file, be sure to complete the following procedure:

Procedure


Step 1 If you are a registered CCO user. go to the following URL: http://www.cisco.com/cgi-bin/tablebuild.pl/ata186

Step 2 Locate the zip file that contains the software for the applicable release and signaling image you are using. The contents of each file are described next to the file name. Extract the signaling image file (this file has an extension of .zup—For example, ata186-v2-15-020723a.zup) and store it on the PC that has connectivity with the Cisco ATA.

Step 3 Set the Cisco ATA parameter UseTftp to 0.


Note Remember to set this parameter back to 1 before you use the Cisco CallManager upgrade method at a later time.


Step 4 (For Cisco Call Manager version 3.2 or later) In the Cisco CallManager Phone Configuration screen for the Cisco ATA whose image you are upgrading, set the Phone Load field to NONE.

Step 5 Follow the instructions in the "Running the Executable File" section.


Running the Executable File

This section includes the procedure for running the executable file and using the voice configuration menu to complete the upgrade process. First check to make sure the upgrade requirements are met and determine the syntax to use when running the program.

This section contains the following topics:

"Upgrade Requirements" section

"Syntax" section

"Upgrade Procedure" section

Upgrade Requirements

The following list contains the requirements for using the ata186us.exe file and the voice configuration menu to upgrade the Cisco ATA to the latest signaling image:

A network connection between the PC from which you will invoke the executable file and the Cisco ATA

A PC running Microsoft Windows 9X/ME/NT/2000

Syntax

ata186us [-any] {-h[host_ip]} {-p[port]} {-quiet} [-d1 -d2 -d3] <image file>

Definitions

-any—Allow upgrade regardless of software and build versions (recommended).

-h[host_ip]—Set the upgrade server to a specific IP address in cases where there may be more than one IP address for the host. The default behavior is that the program will use the first IP address it obtains when it runs the gethostbyname command.

-p[port]—Set the server port to a specific port number (the default port number is 8000; use a different port number only if you are setting up an upgrade server other than the default).

-quiet—Quiet mode; send all output to log file named as [port].log (useful when running the upgrade server as a daemon).

-d1,-d2,-d3—Choose a verbosity level for debugging, with -d3 being the most verbose.

image file—This is the name of the signaling image file to which the Cisco ATA will upgrade.

Example

To upgrade the Cisco ATA to the signaling image ata186-v2-15-020723a.zup, you can use the following syntax:

ata186us -any -d1 ata186-v2-15-020723a.zup

Upgrade Procedure

To perform the upgrade, follow these steps:

Procedure


Step 1 Run the executable file (see the "Syntax" section) from the Microsoft Windows DOS or command prompt. You will receive instructions on how to upgrade.

Step 2 On the Cisco ATA, press the function button to invoke the voice configuration menu.

Step 3 Using the telephone keypad, enter the following:

100# ip_address_of_PC * port #

This is the IP address of the PC and the port number at the DOS prompt where you invoked the ata186us.exe file.

For example, if the IP address is 192.168.1.10, and the port number is 8000 (the default), then enter:

100#192*168*1*10*8000#

When the upgrade is complete, the "Upgrade Successful" prompt will sound.



Note When upgrading many Cisco ATAs manually, you can save the software-upgrade dial-pad sequence in your telephone's speed-dial, and use this sequence repeatedly.


Confirming a Successful Signaling Image Upgrade

You can verify that you have successfully upgraded the Cisco ATA signaling image by using one of the following methods:

Using a Web Browser

Using the Voice Configuration Menu

Using a Web Browser

To use your web browser to verify a successful image upgrade, perform the following steps:

Procedure


Step 1 Open your web browser.

Step 2 Enter the IP address of your Cisco ATA Web configuration page:

http://<IP address>/dev

Step 3 Refresh the page to clear the cache.

The image version number and its build date should appear at the bottom-left corner of the Cisco ATA Web configuration page.


Using the Voice Configuration Menu

To use the voice configuration menu to verify a successful image upgrade, perform the following steps:

Procedure


Step 1 Pick up the telephone handset attached to the Phone1 port of the Cisco ATA.

Step 2 Press the function button on the Cisco ATA.

Step 3 Press 123# on the telephone keypad to play out the image version number.

Press 123123# on the telephone keypad to play out the image build date.


Procedure for Upgrading One Cisco ATA


Step 1 Download the latest Cisco ATA release software for SCCP from the Cisco web site, and store the files on the Cisco CallManager TFTP server. For more information, see the "Setting Up the TFTP Server with Cisco ATA Software" section.

Step 2 Go to the main Cisco CallManager Administration screen.


Note Before continuing this procedure, make sure that the Load Information field for the Cisco ATA 186 Device Type is set to 0 on the Device Defaults screen (System > Device Defaults).


Step 3 From the Device pull-down menu, select Phone. The Find and List Phones screen appears.

Step 4 In the area next to the Find button, enter a portion or all of the Cisco ATA MAC address, then press Find. The Find and List Phones screen reappears, and now contains the Cisco ATAs that match the find criteria you entered in the previous screen.

Step 5 Click the icon of the Cisco ATA whose signaling image you would like to upgrade. The Phone Configuration screen appears.

Step 6 In the Phone Load field, enter the name of the signaling image (the signaling image has an extension of .zup, for example, ATA186-v2-15-ms-020812a.zup).

Step 7 Press Update.

Step 8 You will receive a message that you should reset the device. Click OK.

Step 9 Click the Reset Phone button on the Phone Configuration screen.

Step 10 The Reset Device pop-up window appears. Click Reset.

Step 11 A confirmation box appears. Click OK.

The function button on the Cisco ATA blinks during the upgrade. Once the button stops blinking, the upgrade is complete and the device re-registers to the Cisco CallManager.