Upgrade

Upgrading a XiVO PBX is done by executing commands through a terminal on the server.

Note

Downgrade is not supported

Overview

The upgrade consists of the following steps:

  • switch the version via xivo-dist utility
  • upgrade via the xivo-upgrade utility: it will upgrade the system (Debian packages) and the XiVO PBX packages

Warning

The following applies to XiVO PBX >= 2016.03. For older version, see Version-specific upgrade procedures section.

Important

You must stop all services (xivo-service stop all) on Media Servers linked to your XiVO Main before the upgrade.

Preparing the upgrade

There are two cases:

  1. Upgrade to another LTS XiVO PBX version,
  2. Upgrade to the latest Bugfix release of your current installed LTS version.

Upgrade to another LTS version

To prepare the upgrade you should:

  1. Switch the sources to the new XiVO PBX LTS version with xivo-dist, for example, to switch to Deneb LTS version:

    xivo-dist xivo-deneb
    
  2. Read carefully the Release Notes starting from your current version to the version you target (read even more carefully the New features and Behavior changes between LTS)

  3. Check the specific instructions and manual steps from your current LTS to your targetted LTS and all intermediate LTS: see Manual steps for LTS upgrade

  4. Check also if you are in a specific setup that requires a specific procedure to be followed (e.g. Upgrading a cluster).

  5. And then upgrade, see Upgrading

Upgrade to latest Bugfix release of an LTS version

After the release of an LTS version (e.g. Polaris) we may backport some bugfixes in this version. We will then create a subversion (e.g. Polaris .04) shipping these bugfixes. These bugfix version does not contain any behavior change.

To upgrade to the latest subversion of your current installed version you need to:

  1. Read carefully the Release Notes starting from your installed version (e.g. Polaris.00) to the latest bugfix release (e.g. Polaris.04).

  2. Verify that the debian sources list corresponds to your installed LTS or refix it, for example for Polaris:

    xivo-dist xivo-polaris
    
  3. And then upgrade, see Upgrading

Upgrading

Note

About xivo-upgrade script usage see xivo-upgrade script

After having prepared your upgrade (see above), you can upgrade:

  1. When ready, launch the upgrade process. All XiVO PBX services will be stopped during the process:

    xivo-upgrade
    

Post Upgrade

When finished:

  • Check that all services are running:

    xivo-service status all
    
  • Check that all the docker services are in the correct version. Compare the output of xivo-dcomp version with the table in Release Notes

  • Check that services are correctly working like SIP registration, ISDN link status, internal/incoming/outgoing calls etc.

Manual steps for LTS upgrade

This section was moved here.

Upgrade Notes

See Release Notes for version specific informations.