Upgrade to PBXact 16

Owned by Kelli Higdon
Last updated: Mar 22, 2024
6 min read

Keeping your PBXact system up to date is an important aspect of maintenance. Fortunately, this is a relatively straightforward process.

You'll need to be on a current Peace of Mind Plan support contract (POMP) to upgrade your PBXact system. See the How to Purchase Support Credits wiki for more information on how to purchase POMPs.

It is strongly recommended that a full backup of the system (13 ,14 or 15) be made prior to the upgrade steps below. If necessary, this backup can be used as a restore point to a new install. Note also that the Backup and Restore module in PBXact 16 allows restores of backups made by previous versions. See Upgrade Your PBXact Version 13/14 to PBXact 16

 

 

 

Upgrade Your PBXact Version 15 to PBXact 16

How to install PBX upgrade tool 

We need to download and install the latest pbx upgrade tool. Please find below steps to install PBX upgrade.

  1. Jump to "updates" section by clicking "Pbxact GUI → Admin → Updates" 

     

  2. Then select "Module updates" tab and click on "Check Online" option 

     

  3. Once "Check online" operation is finished, it will show you available modules to install.

    "PBX upgrade"  module will also be display like shown in below screenshot. 

     

    Select "download all" and proceed further by selecting "process" button.

     

     

  4. This will further ask confirmation to install new PBX upgrader module. Please confirm and proceed further.

     

  5. After confirmation, PBX upgrader module will gets installed and then we can return back to module admin page.

  6. Module admin page, we can see PBX upgrader module is installed successfully.

           

     

How to use PBX upgrade tool

Please find below steps to use PBX upgrader to upgrade your PBXact-15 system to PBXact-16.

  1. Once PBX upgrade module is installed, you can find that module under "PBXact GUI → Module admin" section.

     

  2. After selecting 15 to 16 Upgrade tool, below page will reopen where we can check the features of PBXact-16 by expanding the tab or else move to next step by clicking "Check the requirements" button.

     

  3.  You will see all passed validation as soon as "requirements check" process is over. Move to next step by clicking "Proceed to upgrade process".

     

  4. Upgrade process will start with below wizard.  Click on "next" will start downloading new PHP 7.4 dependent packages along with updated modules as per the PBXact 16 system.

As shown in upgrade wizard top help tip, this will update the PHP version to 7.4 along with dependent packages and then will perform the module updates so please do not refresh/close the browser.

System upgrade process is an irreversible step so please ensure to take your PBX backup before proceeding.

Alert pop up will appear for just to be double sure to start the upgrade process.  We can cancel the upgrade process from here also.

 

  1. Step-2 of upgrade wizard will take some time so "do not refresh the web browser" and let the process to finish. 

     

  2. This process will take some time due to downloading , installing all the PHP 7.4 and dependent packages and the PBXact 16 modules.
    Upgrade  process will perform the "fwconsole restart" as well. 

     

  3.  Wizard will display the status and on successful completion it will display "The upgrade process has finished. Click Refresh below to continue.". Just click on the "Refresh" button and you will be redirected to Module admin page to show PBXact 16 module list page and upgrade to PBXact 16 is done successfully.

     

  4. The upgrade process will take you back to the Web GUI where you have to complete the installation clicking on the "Apply Config" red button at the top of the page.

Post Upgrade checks

  • Verify the php version to ensure the upgrade is done properly.

  • Run  "php -v" command from the CLI and verify the PHP version is properly upgraded, output of the command should show PHP version as "PHP 7.4.XX"

  • Verify asterisk manager is connected.
    - Login to asterisk CLI and run  manager show connected" command verify admin user is connected and you are not seeing any asterisk manager connection related errors.

  • Unban / unblock known good IP's (Applicable if you fail2ban service is enabled).
    - If your endpoints are registered through responsive firewall and not whitelisted in fail2ban then your known good IP's may get banned during the upgrade process and needs to be removed from banned list so that the endpoint an get registered.

  • Check the modules are enabled properly.
    - During the upgrade process the module may get disabled during the upgrade process due to some dependency package or module missing so please ensure all your required modules are installed and enabled properly.

  • Verify fwconsole commands are running fine.
    - Run "fwconsole r" and fwconsole restart" commands and verify both the commands executes

Trouble Shooting the Upgrade process

  • If your upgrade process failed for some reason or there is no response in from the GUI wizard due to some network issues, then please login to CLI and check "/var/log/pbx/freepbx16-upgrade.log" for more detailed info on why the process got failed.

  • Sometimes after completing the upgrade process you might see the error as "In RedisCache.php line 135: Function Redis::delete() is deprecated" . The root cause of this issue is that the framework module failed to upgrade but the PHP updated to 7.4. To fix this issue follow the below steps.

    • Download install the V16 framework module manually.

      • ./usr/sbin/fwconsole ma downloadinstall framework --tag=16.0.10.42

    • Upgrade all the modules.

      • fwconsole ma upgradeall

  • If the upgrade process is failed due to the cloud migration module, then move the cloud migration module directory to different location and then install all the modules.

    • Move the cloud migration module 

      • mv /var/www/html/admin/modules/cloudmigration /tmp/

    • Install all the modules

      • fwconsole ma installall

  • If the upgrade process is failed due to the oracle_connector module, then move the oracle_connector module directory to different location and then install all the modules.

    • Move the oracle_connector module

      • mv /var/www/html/admin/modules/oracle_connector /tmp/

    • Install all the modules

      • fwconsole ma installall

Upgrade Your PBXact Version 13/14 to PBXact 16

 

The recommended path from PBXact 13/PBXact-14 to PBXact-16 is to use the "Backup & Restore" functionality to take a Backup from the working PBXact-13/14 system and then restore to newly installed PBXact-16 system.

The following steps will have you up and running on a PBXact-16 system with the same configuration as your existing PBXact-13/14 system. 

  1. Take Backup of your PBXact-13/14 System.

    1. Take full backup of your PBXact-13/14 system using Backup & Restore module of PBXact-13/14.  Please refer to Using the Backup module for further details of how to configure and take full backup of your 13/14 system.

  2. Ensure PBXact-16 which is running on another server is fully up-to-date with system rpm's and modules. Please refer to Updates#ModuleUpdates for more details.

  3. Restore 

    1. Please note that Backup & Restore has been completely re-designed in PBXact-15+ so so you will see GUI differences in the way it used to work in PBXact-13/14 vs PBXact-15+.

    2. Please refer to  Backup & Restore wiki to know more about PBXact-16 Backup & Restore module. 

    3. We can restore the configurations by uploading the PBXact-13/14 generated configuration backup to "PBXact GUI → Admin → Backup & Restore → Restore tab".

    4. After a successful restore , your PBXact-13/14 is successfully replicated to new PBXact-15.

Unable to render {include} The included page could not be found.