Skip to content

Restoring the PxM Virtual Appliance from a backup

This section covers:


The restore process allows you to reinstate your existing PxM Virtual Appliance configurations onto a new PxM Virtual Appliance.

This guide describes the process of how the PxM Virtual Appliance can be restored from a backup when a system failure occurs or as part of the upgrade process requirements.

The PxM Virtual Appliance restore procedure requires a backup file so it is important that regular backups of the PxM Virtual Appliance are taken and kept in accordance with your corporate recovery strategy.

Within the PxM Platform backups can be scheduled and transferred to a PxM Virtual Mesh Appliance. The mesh feature allows you to automate the backup of your PxM Virtual Appliance backup file onto a remote standby PxM Virtual Appliance. For further instructions on how to set this up see here.

A PxM Virtual Appliance backup file contains the following data to allow the appliance to be restored:

  • A copy of the database which includes all the configuration including users, devices, profiles etc.
  • Task logs.
  • Copy of all the device templates.


Session recordings are not included in the backup file as these are saved to an external file store.

Upgrade and restore paths

The following table gives you an overview of the upgrade paths depending on the version upgrading from and to, and also which upgrade path requires a backup/restore as a straight upgrade is not possible due to the changes in the system.

Current PxM version Upgrade to PxM version Backup/restore required?
Current 6.x or lower 7.x Yes, click here for details.
6.0.x to 6.5.x Latest 6.x version No
5.4.x 6.0.x Yes
5.2.x to 5.3.x 5.4.x No
5.0.x to 5.1.x 5.2.x No


Before proceeding with restoring your PxM Virtual Appliance review the following prerequisites:

  • A recent backup of the PxM Virtual Appliance you want to restore.

  • The Master Encryption Key of the PxM Virtual Appliance, This is very important and without the correct master encryption key the PxM Virtual Appliance can not be restored from its backup.

Supporting documentation

Further information relating to the PxM Platform can be found here.