Aug 07, 2022 16:12
The Guide explains how to upgrade existing Cloud, Hardware systems to WMS version 4.0 and how to deploy PBX as a Virtual Machine on WMS 4.0.
PBX Licensing and Activation: https://confluence.wildix.com/x/twM8AQ
Updated: November 2020
Permalink: https://confluence.wildix.com/x/jgKIAQ
If you are running WMS4 and you would like to upgrade to WMS5, please follow the document: Deploying WMS 5.0 on Hardware, Virtual, Cloud PBXs
Important!
Before upgrading your PBX, make sure that WMP shows that the PBX is entitled to WMS 4.01, otherwise contact Wildix for the information on how to get a valid license.
Before proceeding, make sure that you have a backup of the existing system as all the configuration data will be lost during the upgrade.
Supported Systems: Per User WMS 3.XX PBXs with monthly, yearly or 5 year subscriptions. Lifetime per user systems bought onwards.
Unsupported Systems: Per Service PBXs and Lifetime Per User PBXs, licenses for these PBXs must be regenerated.
Install or upgrade VM PBX
Important: Upgrade of existing Virtual Machines running WMS 3.XX is not supported. Existing user data and CDR must be copied manually to the new Virtual Machine if they were not saved on a separate virtual disk.
Requirements
Any kind of VM hypervisor capable of importing OVF/OVA templates for deploying, is supported.
Recommended requirement for VM systems:
2vCPU, 4GB -> PBX managing up to 1000 users
4vCPU, 8GB -> PBX managing up to 5000 users
8vCPU, 16GB -> PBX managing up to 10000 users
Requirements may differ depending on the system usage (i.e. additional integrations, burst load, etc).
Deployment
- Download the new VM Image here: https://files.wildix.com/images/wms4/WMS_4.04_x64_20201113.ova (compatible with VMWare 6.X, HyperV, Virtualbox)
- If you prefer OVF format, please use utility called OVFTool by VMWare: http://ftp.tucha13.net/pub/software/VMware-ovftool-4.1.0/
After installation, you need to run the following command changing paths for your system:
ovftool WMS_4.01_x64_20190111.ova WMS_4.01_x64_20201113.ovf
- In case if you're running VMWare version lower than 6.5, please run this command in order to reduce VMWare HW Compatibility Level:
ovftool --maxVirtualHardwareVersion=11 wms_4_01_x64_20201113.ova wms_4_01_x64_20201113_v11.ova
To install the system, follow the official vendor documentation for your virtualization platform to start a Linux 64 bits Virtual Machine.
Once the VM is installed, follow PBX Licensing and Activation Admin Guide and reactivate the existing licenses, upload the backup saved previously.
All the existing data (voicemails / recordings / CDR) stored on the old VM must be copied manually. Contact Wildix Support if help is needed during this procedure.
In case of old versions of VMware, there are two ways:
- Re-convert OVA template to OVF format, it provides access to 2 VM disk files (root and virtual usb-key) and then build virtual machine on any hypervisor with 2 disk files and run it
- Otherwise download OVF archive from here: https://files.wildix.com/images/wms4/WMS_4.04_x64_20201113_vhd.zip
Note: If you install the system using Hyper-V, download VHD archive from here: https://files.wildix.com/images/wms4/WMS_4.04_x64_20201113_vhd.zip.
Upgrade HW PBX
Warning:
- Веfore the upgrade, remove all external USB storages
- Backup is required before upgrading as all data (excluding USB stored date) will be deleted
- Do not turn off the PBX during the upgrade
Requirements
CPU: Atom D2550, Celeron J1800, Celeron J1900
Supported starting from WMS version 3.88.41071 and higher
For example:
Preparing USB flash drive for upgrade/ restore of HW PBX
Requirements:
USB flash drive - 4GB or more; without any partitions that may prevent the booting process (MBR partitions in particular)
For upgrade/restore procedure, you need to prepare special USB flash drive:
- Download image
- Write image to USB flash drive
Warning:
This will irrevocably delete all files on your USB flash drive, so make sure you do not have any important files on the flash drive before doing this. Be absolutely sure that you are directing dd to the correct drive before executing.
Windows
Use Etcher GUI tool.
Mac OS
Use Etcher GUI tool or command line utility dd as below.
Run the following commands, replacing /dev/diskX
with your drive, e.g. /dev/disk2.
A USB device is normally auto-mounted in macOS, and you have to unmount (not eject) it before block-writing to it with dd:
# diskutil unmountDisk /dev/diskX # dd if=PATH_TO_IMAGE of=/dev/rdiskX bs=1m
Linux
Run the following command, replacing /dev/sdX
with your drive, e.g. /dev/sdb
(Do not append a partition number, so do not use something like /dev/sdb1
):
# dd if=PATH_TO_IMAGE of=/dev/sdX bs=512K status=progress oflag=sync
Deployment
To deploy HW PBX, proceed with the following steps:
- Connect to PBX via serial cable (speed 19200)
- Insert a special prepared USB flash drive as described in the previous section
- Turn on or reboot PBX
- Press a key on the keyboard within three seconds to be able to move inside the boot menu (e.g. Up/ Down key)
- Select Upgrade to version 4 in GRUB menu
- Select Upgrade
- Wait for the system to be updated and turned off automatically
Once the system has started, follow PBX Licensing and Activation Admin guide and reactivate the existing licenses, upload the backup saved previously. Connect the existing USB storage and configure it if needed, DO NOT RE-INIT the storage as all data will be lost.
Deployment of HW PBXs with 32bit OS
Some HW PBXs with WMS 4.01 Version are based on 32-bit. Before upgrading or activating licenses on this PBX, you need to update it to the latest WMS Version based on 64-bit:
- Connect to PBX via serial cable (speed 19200)
- Insert a special prepared USB flash drive as described in the previous section
- Turn on or reboot PBX
- Select System restore -> Restore in GRUB menu
Select Restore
Note: After restoring the system, an error indicating the failure of updating from 32-bit to 64-bit may occur. To remove the error, activate PBX licenses.
- Wait for the system to be updated and turned off automatically
After completing the procedure, you can proceed with PBX Licensing and Activation.
How to update WMS Network from 3.88 to 4.x
In some situations, especially in a case of a large distributed network, it is impossible to complete the upgrade of the whole WMS network on the same day.
Please follow our recommendations, to ensure a smooth and problem-free transition from WMS 3.88 to 4.x:
- First upgrade all the Client PBXs and only then proceed with upgrading the Server PBX in the WMS Network.
- In case of big installations or distributed networks, upgrade can be done over time. Here is a list of limitations that you should take into consideration, in case you gradually update the PBXs in your WMS Network:
- users can be added/ modified only on the Server PBX
- file transfer and other advanced features might not work
Tools available in WMS 4
By default the following tools are installed on the system:
- mtr-tiny
- tsql
- iftop
- dig
- iperf
- sngrep
Heavy/additional tools that are available but not installed automatically:
- mysql-client
- htop
- mc