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.

      Web UI Tasks reports

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

      Web UI Tasks reports 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.

      Web UI Manager: tasks

    • Within the Manager: tasks window, deselect 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.

        Osirium 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 recovery backup file for your PxM Virtual Appliance. The backup file, called osirium_backup, is an archive file containing the PxM database, templates, and task logs.


Do not back up your PxM Virtual Appliance while a Credentials Refresh task is running. If a Credentials Refresh task is running, wait until completion before beginning the backup procedure.

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 refresh. The Status column indicates whether or not a task is running.

    Webui System queue: password refresh

To create a PxM backup:

  1. Log in to the PxM Client as a SuperAdmin.

    Osirium server

  2. Within the PxM Platform window, under Osirium Server, double-click Backup. The Execute task Backup window appears.

    Execute backup

  3. Within the EXECUTE ON DEVICES table, confirm the list of of devices to back up.


    If you want to edit the list of devices to back up:

    • Click Choose devices. The SELECT DEVICES table appears.
    • Within the SELECT DEVICES table, deselect the device(s) you do not want to back up.
    • Click Confirm. The EXECUTE ON DEVICES table will appear.
  4. Click Execute. The Question window appears.

    Confirm backup

  5. Click Yes. The backup task executes and the Action queue window will appear.

  6. When the backup task successfully completes, click Done. The Output files tab appears, displaying the osirium_backup file on the table.

    Output files tab

  7. Within the Output files tab, click the Download Save icon icon for the osirium_backup file. The Save As window appears.

  8. Save the file to your preferred location.

  9. Within the Execute task Backup window, click Done. The backup procedure is complete.


If necessary, you can retrieve the PxM backup file from the PxM Client Web Management Interface on the Manage files page. For more information, see Downloading a file in the PxM Administrator’s Guide.

To restore your PxM Virtual Appliance from the backup file, see PxM Virtual Appliance Restore Procedure.