PxM Virtual Appliance upgrade procedure

This section covers:

Upgrade 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


For more information on backing up and restoring the PxM Virtual Appliance, see the PxM Virtual Appliance Restore Guide.

To upgrade PxM Virtual Appliance from a version earlier than 5.0.0, contact Osirium Support for help.

The following diagram displays the different upgrade paths to follow depending on the PxM version you are currently using. To ensure a smooth upgrade ensure these upgrade paths are followed.

Upgrade paths

Upgrade procedure

The diagram provides a high-level overview of the process for upgrading your PxM Virtual Appliance.

Upgrade procedure

The following steps guide you through upgrading your existing PxM Virtual Appliance.

Enabling the Osirium Support account

If the PxM Virtual Appliance support account has NOT already been enabled and a password set then this MUST be done as the account is required to run the upgrade.

  1. Log into the the PxM Client as a SuperAdmin.

  2. Open the Web Management Interface browser window.

  3. On the left-hand menu, click System configuration. The System configuration page opens.

  4. Within the System configuration, click the System settings tab.

  5. On the table, locate Support account and click the Edit pencil icon. The Edit entry window opens.

  6. Within the Edit entry window, enter a password to be assigned to the support account and check the Enabled checkbox.

    Edit entry window

  7. Click Save. The support account password is set and user account is enabled.

  8. Close the Web Management Interface and log out of the PxM Client.

Downloading the upgrade kit

The PxM Virtual Appliance is upgraded using the upgrade kit binary file.

To download the latest PxM Virtual Appliance upgrade kit:

  • Go to the PxM Platform Virtual Appliance page of the Software Releases page.

  • Scroll down to the Upgrading existing appliances section and from the table download the latest upgrade binary file.

  • A SHA256 checksum is available to verify the download integrity.

  • Depending on the version you are upgrading from you may need an earlier version as well which can be downloaded from the same page.


The transfer mode must be set to binary.

Upgrading the PxM Virtual Appliance

  1. Transfer the downloaded upgrade kit onto the PxM Virtual Appliance using the Osirium Support account username and password enabled and set earlier.

  2. From your virtual environment, open the PxM Virtual Appliance console window.

    Console window

  3. Within the PxM Virtual Appliance Console window, press ALT + F2. The server login prompt appears.


    Alternatively, you could use an SSH connection to the PxM Virtual Appliance.

  4. At the login prompt, type osirium_support and press ENTER.

  5. In the Password prompt, type the password set for the Osirium Support account and press ENTER. The account will be verified and you will be logged onto the PxM Virtual Appliance.

    SSH login

  6. Extract the upgrade kit copied to the server using the following command:

    #! $ sudo bash [Osirium_kit_name] i.e. Osirium_PxM_Virtual_Appliance_v6.5. 0_upgrade.bin

  7. Enter the Osirium Support account password when prompted and press ENTER. The upgrade kit will be extracted.

  8. When the extraction completes, type the command specified on the screen and press ENTER.

    Extracted kit

    The following message appears:

    Press enter

  9. Press ENTER.

  10. The system configures and the EULA screen appears. Press ENTER once you have read and accepted. The system configures and the following screen appears:

    Continue without restore

  11. Press ENTER to Continue without restoring a backup.

  12. Wait while the upgrade completes and PxM Virtual Appliance is rebooted.


  13. Close your virtual environment session.

Updating the PxM Client

When a PxM Virtual Appliance has been upgraded, the first time a user logs on, the PxM Client checks the PxM for the version it should be correctly communicating with and auto updates if required.

Click here for the PxM Client.

Post upgrade tasks

Before opening any device connections that use an Active Directory account, an audit needs to be manually triggered on all provisioned Active Directories. You can do this by right clicking the named Active Directory from the Manage Active Directory page, and select Trigger audit from the menu.

This will allow:

  • Additional fields on the Active Directory account page to be populated.
  • Pre-6.1.0 account history to be updated to match the naming formats.

Before allowing users to connect back onto the PxM Client:

  • Ensure the devices are still accessible through the PxM Client.
  • Ensure device tasks run successfully.
  • Reschedule all scheduled Regenerate Account Credentials for all devices tasks.
  • Ensure email notifications are working.
  • Once you are satisfied that the upgrade has been successful, you may want to delete the PxM Virtual Appliance snapshot.