New Rock Technologies, Inc. Binary Upgrade Procedure MX Series OM Series WROC Series http://www.newrocktech.com Email: gs@newrocktech.com.
Amendent Records Document Rev. 01 (Oct., 2014 ) Copyright 2014 New Rock Technologies, Inc. All Rights Reserved. All or part of this document may not be excerpted, reproduced and transmitted in any form or by any means without prior written permission from the company. 1
Contents Amendent Records... 1 Contents... 2 Contents of Figure... 3 Contents of Table... 4 1 Introduction... 5 1.1 Overview... 5 1.2 Purpose... 5 1.3 Determining the Firmware and Kernel Versions... 5 1.3.1 In the new release file provided by New Rock... 5 1.3.2 On the MX/OM/WROC device... 6 1.4 Determining Which Upgrade Procedure to Use... 6 2 Procedure... 7 2.1 Pre-requisites... 7 2.1.1 FTP Server... 7 2.1.2 IP address of the MX/OM/WROC device... 7 2.1.3 Enable Telnet on the MX/OM/WROC device... 7 2.1.4 Backup Configuration... 7 2.2 Procedures... 7 2.2.1 Store files on the FTP Server... 8 2.2.2 Telnet to the MX/OM/WROC device... 9 2.2.3 Verify the Files... 12 2.2.4 Run the Upgrade Utility Tool... 13 2.2.5 Verify the Upgrade... 14 www.newrocktech.com 2
Contents of Figure Figure 1-1 MX Gateway Version Info on web GUI... 6 Figure 2-1 Enabling telnet service on MX Gateway info Screen... 7 Figure 2-2 Command prompt window for telnet service on MX8 Gateway... 9 Figure 2-3 Command prompt window for login and telnet password on MX8 Gateway... 9 Figure 2-4 Command prompt window for changing directories on MX8 gateway... 9 Figure 2-5 Command prompt window for connecting to the FTP server... 10 Figure 2-6 Command prompt window for switching to binary mode to transfer files.... 10 Figure 2-7 Command prompt window for enabling hash mode on transferred files... 10 Figure 2-8 Command prompt window for changing FTP directory... 11 Figure 2-9 Command prompt window for obtaining upgrade package for MX8 Gateway... 11 Figure 2-10 Command prompt window for successfully obtaining upgrade package for MX8 Gateway... 11 Figure 2-11 Command prompt window for obtaining upgrade utility tool for MX8 Gateway... 12 Figure 2-12 Command prompt window for logging out of the FTP server... 12 Figure 2-13 Command prompt window for verifying the file size of the upgrade package and utility tool received on MX8 Gateway... 12 Figure 2-14 Command prompt window to set permission to execute the upgrade utility tool on MX8 Gateway... 13 Figure 2-15 Command prompt window to execute or run the upgrade package and utility tool on MX8 Gateway... 14 Figure 2-16 Verifying the MX Gateway Version Info on web GUI... 14 3
Contents of Table Table 1-1 MX/OM/WROC models and its corresponding upgrade package and utility tool filenames... 5 Table 2-1 MX/OM/WROC upgrade package and utility tool filenames with its corresponding file size... 8 www.newrocktech.com 4
1 Introduction 1.1 Overview In most cases, upgrading a MX/OM/WROC device can be done with any of the following 2 ways: Using Auto Configuration Using the web GUI However, in the situation where the kernel software of the MX/OM/WROC device has changed, and not just the firmware, a special procedure needs to be done in order to perform the upgrade. 1.2 Purpose The purpose of this document is to describe the procedure used to upgrade the MX/OM/WROC device when a kernel update has been provided. 1.3 Determining the Firmware and Kernel Versions 1.3.1 In the new release file provided by New Rock The version in the new software can be determined by looking at the file name. The format will be <series_name>.<device_model>.<kernel_version>.<firmware_version>.<firmware_language>.<firmw are_subversion>.<file_format>. An example is MX.J1.1.1.6.333.E0.02.bin. In this example, the series name is MX, the device model is HX4, the kernel version is 1.1.6, the firmware version is 333, the firmware language is English, the subversion number is 2 and it is a binary file. The other file format would be a standard MX/OM/WROC upgrade file and would end in tar.gz. The following table shows the different MX/OM/WROC models and its corresponding upgrade package and utility tool filenames. Table 1-1 MX/OM/WROC models and its corresponding upgrade package and utility tool filenames Models Upgrade package Upgrade utility tool HX4 MX.J1.1.1.6.333.E0.02.bin kupdate.mx4.v1.10 MX8 MX.B2.1.9.6.333.E0.04.bin kupdate.mx8.v1.7 MX60 MX.H1.2.0.6.333.E0.04.bin kupdate.mx60.v1.9 MX120 MX.F1.2.0.4.333.E0.04.bin kupdate.mx120.v1.7 MX100E MX.L1.1.1.4.5_80_4_tg.E0.07.bin kupdate.om400.v1.15 OM4 OM.J1.1.1.6.5_82.E0.02.bin kupdate.mx4.v1.10 www.newrocktech.com 5
OM12 OM.B2.1.9.6.5_82.E0.02.bin kupdate.mx8.v1.7 OM80 OM.H1.2.0.6.5_82.E0.02.bin kupdate.mx60.v1.9 OM200 OM.F1.2.0.6.5_82.E0.02.bin kupdate.mx120.v1.7 WROC2000 OM.K1.3.4.1.3.5_84.E0.06.bin kupdate_wroc_1.9.1 WROC3000 OM.M1.1.2.26.4.5_84.E0.01.bin kupdate.wroc3000.v1.0.6 A.zip file will be made available for download of the latest version on upgrade package and utility tool from the New Rock website (www.newrocktech.com). 1.3.2 On the MX/OM/WROC device The version of MX/OM/WROC device can be found by selecting Version info or Info in the upper right hand corner of the web GUI. Figure 1-1 shows the Version info screen for a MX gateway. In this example the kernel version in 1.9.6 and the firmware version is 333. Figure 1-1 MX Gateway Version Info on web GUI 1.4 Determining Which Upgrade Procedure to Use The binary upgrade procedure described in this document only needs to be followed if the kernel version of the new software is different than the kernel version currently installed on the MX/OM/WROC device. www.newrocktech.com 6
2 Procedure 2.1 Pre-requisites 2.1.1 FTP Server The binary upgrade process requires the use of an FTP server. 2.1.2 IP address of the MX/OM/WROC device If the IP address of the MX/OM/WROC device is not known, please connect an analog phone to one of the FXS or Phone ports on the MX/OM/WROC device; pick up the phone and listen to the announcement after dialing ##. If the device don t have FXS port then it is recommended to use Wireshark. 2.1.3 Enable Telnet on the MX/OM/WROC device Connect to the web GUI of the MX/OM/WROC device. Go to the Advanced->Security page. In the Telnet service section make sure that the radio button for the Telnet parameter is set to On. If it isn t, set it to On and set a password in the Telnet password and Confirm password fields. Figure 2-1 Enabling telnet service on MX Gateway info Screen Reboot the MX/OM/WROC device and telnet will be enabled. 2.1.4 Backup Configuration It is strongly recommended that the current configuration of the MX/OM/WROC device should be saved before proceeding with the binary upgrade. This will ensure that any configuration parameters will not be lost in the case of an upgrade failure. 2.2 Procedures If the FTP server will be used, please skip to section 0Telnet to the MX/OM/WROC device. www.newrocktech.com 7
2.2.1 Store files on the FTP Server When there is a kernel change that requires a binary upgrade, a.zip file will be made available for download from the New Rock website (www.newrocktech.com). This.zip file will contain: The upgrade package (i.e. MX.B2.1.9.6.333.E0.04.bin). The upgrade utility (i.e. Kupdate.mx8.v1.7). This instruction document. It is very important that only the upgrade tool that is provided in the.zip file be used to perform the binary upgrade of the upgrade package contained in the.zip. If another version is used, there is a higher risk of the upgrade to fail. Place the upgrade package and the upgrade utility on the FTP server. Please do not change the name of either file. Please use binary mode when transferring the files. After transferring the files, please check the file sizes. The following table shows the different MX/OM/WROC upgrade package and utility tool filenames with its corresponding file size. Table 2-1 MX/OM/WROC upgrade package and utility tool filenames with its corresponding file size Models Upgrade package (file size) HX4 MX.J1.1.1.6.333.E0.02.bin (8,060,928 bytes) MX8 MX.B2.1.9.6.333.E0.04.bin (8,192,000 bytes) MX60 MX.H1.2.0.6.333.E0.04.bin (8,060,928 bytes) MX120 MX.F1.2.0.4.333.E0.04.bin (8,192,000 bytes) MX100E MX.L1.1.1.4.5_80_4_tg.E0.07.bin (12,320,768 bytes) OM4 OM.J1.1.1.6.5_82.E0.02.bin (8,060,928 bytes) OM12 OM.B2.1.9.6.5_82.E0.02.bin (8,192,000 bytes) OM80 OM.H1.2.0.6.5_82.E0.02.bin (8,060,928 bytes) OM200 OM.F1.2.0.6.5_82.E0.02.bin (8,192,000 bytes) WROC2000 OM.K1.3.4.1.3.5_84.E0.06.bin (14,811,136 bytes) WROC3000 OM.M1.1.2.26.4.5_84.E0.01.bin (17,956,864 bytes) Upgrade utility tool (file size) kupdate.mx4.v1.10 (26,992 bytes) kupdate.mx8.v1.7 (32,832 bytes) kupdate.mx60.v1.9 (27,916 bytes) kupdate.mx120.v1.7 (34,736 bytes) kupdate.om400.v1.15 (31,228 bytes) kupdate.mx4.v1.10 (26,992 bytes) kupdate.mx8.v1.7 (32,832 bytes) kupdate.mx60.v1.9 (27,916 bytes) kupdate.mx120.v1.7 (34,736 bytes) kupdate_wroc_1.9.1 (6,828 bytes) kupdate.wroc3000.v1.0.6 (45,060 bytes) www.newrocktech.com 8
2.2.2 Telnet to the MX/OM/WROC device For information about telnet, including how to install it on Windows, please see the following article on the Microsoft website. http://windows.microsoft.com/en-us/windows/telnet-faq Telnet to the IP address of the MX/OM/WROC device. See section 2.1.2 IP address of the MX/OM/WROC device if it is unknown. (i.e. 192.168.250.110 is the IP address of MX8 gateway). Figure 2-2 Command prompt window for telnet service on MX8 Gateway At the Login: prompt, enter root and at the Password: prompt, enter the telnet password for the MX/OM/WROC device that was configured according to section 2.1.3 Enable Telnet on the MX/OM/WROC device (i.e. MX8-VoIP-AG login: root; Password: voip123) Figure 2-3 Command prompt window for login and telnet password on MX8 Gateway FTP files to the MX/OM/WROC device. Change directories to the /tmp directory by entering cd /tmp at the ~ # prompt. Figure 2-4 Command prompt window for changing directories on MX8 gateway www.newrocktech.com 9
Connect to the FTP server by entering ftp x.x.x.x (where: x.x.x.x. is the ftp server IP Address) at the /tmp # prompt. (i.e. ftp 192.168.2.2) At the Name prompt, enter FTP username. Then, at the Password prompt, please enter the FTP password. (i.e. Name< ftp 192.168.2.2:root>: newrock ; password: 123456) Figure 2-5 Command prompt window for connecting to the FTP server Switch to binary mode by entering bin at the ftp> prompt. Figure 2-6 Command prompt window for switching to binary mode to transfer files. Turn on hash mode by entering hash at the ftp> prompt. This will cause a hash mark (#) to be displayed for every 1024 bytes that are transferred. This is useful to ensure that the download is still in progress. Figure 2-7 Command prompt window for enabling hash mode on transferred files www.newrocktech.com 10
Change to the FTP directory and check the directory listing. Figure 2-8 Command prompt window for changing FTP directory Get the upgrade package. (i.e. get MX.B2.1.9.6.333.E0.04.bin) Figure 2-9 Command prompt window for obtaining upgrade package for MX8 Gateway If it was successful, a message will be on the screen that says something like 226 File send OK and the file size received in bytes. Figure 2-10 Command prompt window for successfully obtaining upgrade package for MX8 Gateway www.newrocktech.com 11
Get the upgrade utility tool. (i.e. get kupdate.mx4.v1.13). Again, make sure that the transfer was successful by checking the message 226 File send OK and the file size received in bytes. Figure 2-11 Command prompt window for obtaining upgrade utility tool for MX8 Gateway Finally, log out of the FTP server. Figure 2-12 Command prompt window for logging out of the FTP server 2.2.3 Verify the Files At the /tmp prompt, enter ls l. Make sure that the file size of the upgrade package and utility received on the MX/OM/WROC device are correct. (i.e.file size of MX.B2.1.9.6.333.E0.04.bin is 8192000 and the file size of kupdate.mx8.v1.7 is 32832). Do not continue if either file size is incorrect. Figure 2-13 Command prompt window for verifying the file size of the upgrade package and utility tool received on MX8 Gateway www.newrocktech.com 12
2.2.4 Run the Upgrade Utility Tool First, make the upgrade utility tool executable on MX/OM/WROC device. (i.e. chmod +x kupdate.mx8.v1.7). Figure 2-14 Command prompt window to set permission to execute the upgrade utility tool on MX8 Gateway Now, execute or run the upgrade package and utility tool on MX/OM/WROC device. ( i.e../kupdate.mx4.v1.13 MX.B2.1.9.6.333.E0.04.bin n). The upgrade should take between two and four minutes. Please do not close the window or remove power until the upgrade is complete. Doing so could cause an upgrade failure that would result in the Smart ATA having to be sent back for repair. When the message OK! Rebooting appears on the screen, the upgrade is complete and the MX/OM/WROC device will automatically reboot. www.newrocktech.com 13
Figure 2-15 Command prompt window to execute or run the upgrade package and utility tool on MX8 Gateway 2.2.5 Verify the Upgrade Log back in to the web GUI and verify that the MX/OM/WROC device has already the correct kernel version and firmware version. Figure 2-16 Verifying the MX Gateway Version Info on web GUI www.newrocktech.com 14