2. Backup the PxM Virtual Appliance

This chapter provides a list of prerequisites required before creating a backup of the PxM Virtual Appliance.

If you don’t have a current backup of your PxM Virtual Appliance then we recommend you create a backup.


This may not be possible if your PxM Virtual Appliance has had a failure and needs to be restored from an existing backup. In this case, see Restoring your PxM Virtual Appliance

2.1. Prerequisites

Before backing up a working system we recommend you adhere to the following prerequisites:

  • Within your virtual environment, take a snapshot of the PxM Virtual Appliance to be upgraded.

  • Within the PxM Web Management Interface, disable all scheduled Regenerate Account Credentials for all devices tasks. To do this:

    • On the left-hand menu, under REPORTING, click Tasks. The Tasks reports screen appears.

    • On the Tasks reports screen, click the Upcoming scheduled tasks tab.

      Upcoming tasks report

    • In the field above the Task column, type regenerate account credentials.

      Upcoming tasks report filtered

      The table is filtered and will only display Regenerate Account Credentials for all devices tasks.

    • Within the Profile column, click a profile name. The Profile detail page appears.

    • Within the PROFILE MEMBERS area, to the right of Tasks, click manage. The Manager: tasks window appears.

      Profile manage tasks

    • Within the Manager: tasks window, unselect the Included checkbox for Regenerate Account Credentials for all devices and Regenerate Account Credentials for devices attached to profile.

    • Click Save changes.

  • Allocate at least 16 GB disk space at the root level. If insufficient disk space is available, free space with one or more of the following methods:


    The current disk space is displayed on the Manage files screen, on the Disk usage (percentage) graph.

    • On the PxM Web Management Interface, download Techout/Backup files you want to archive and then delete them from the system.

    • Using SFTP software, copy the oldest files to another system for archiving and then delete the log files.


      Do not delete files without a sequence number, as they are in use by the PxM Virtual Appliance. For example, external.log is currently in use by PxM and should not be deleted, whereas external.log.1, external.log.2, etc., are archived files which can be safely deleted.

    • Delete the syslog or the PxM logs in var/log.


      When logging in via SFTP, use the osirium_support account.

    • Remove old Osirium kit files. Check the following:

      • osirium_suport home-directory on the PxM Server.

      • Extracted kit files can be found in /data/kits.

        Extracted kits

  • Ensure all users are logged out of PxM.


    Active users are displayed on the Summary screen, on the CONNECTIONS (LAST 24 HRS) graph.

2.2. Backing up your PxM Virtual Appliance

The following steps guide you through the process of creating a backup file for your PxM Virtual Appliance. The backup file contains the PxM database, templates, and task logs.

Backups should be scheduled and stored inline with your company policies and procedures.


Do not backup your PxM Virtual Appliance if a Credentials Refresh task is currently running.

To check if a Credentials Refresh task is running:

  • On the left-hand menu, under SYSTEM, click System queue. The System queue table appears.

  • In the field above the Name column, type credential. The Status column indicates whether or not a task is running.

    Credential refresh task

To create a PxM backup:

  1. Within the Web Management Interface click on the Devices in the left-hand menu.

  2. On the Manage devices page, click on Osirium Server. The named device detail page will open.

    Osirium Server detail page

  3. Select the Tasks tab. Click the Execute now arrow next to the Backup task.

    Backup task execute

  4. In the Execute task Basckup window, select the Osirium Server device and click Execute.

    Execute backup

  5. In the Question click Yes to continue with executing the backup task on the Osirium Server. The Action queue window will open. Wait while the task is executed.


  6. Once the task has completed click Files in the left-hand menu.

  7. On the Manage files page download the created Osirium Server backup file created and save to a preferred location.

To restore your PxM Virtual Appliance using an Osirium Server backup file, see PxM Virtual Appliance Restore Procedure.