2. Upgrading your PxM Virtual Appliance

This chapter describes how to upgrade your PxM Virtual Appliance for new features and enhancements.

2.1. Upgrade paths

To upgrade your PxM Virtual Appliance from a version earlier than v5.4.x, you must successively upgrade to all major releases until v5.4.x. For example, if you are using PxM v5.2.x, you must upgrade to v5.3.x before upgrading to v5.4.x.

To upgrade PxM from v5.4.x to v6.0.x, you must first back up and restore your existing PxM Virtual Appliance.


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

To upgrade PxM 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:

Upgrade paths chart

2.2. Upgrade flow

The following diagram illustrates the process for upgrading your PxM Virtual Appliance.

VA upgrade flow

2.3. Upgrade procedure

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


Before continuing, complete the Pre-upgrade tasks.

2.3.1. Enable the osirium_support account

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

  2. Open the Web Management Interface.

  3. On the left-hand menu, under SYSTEM, click System configuration. The System configuration screen appears.

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

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

    Edit entry

  6. Within the Edit entry window:

    • In the Password field, type a password.
    • In the Password again field, type the password again to confirm.
    • Ensure the Enabled checkbox is selected.
  7. Click Save. The osirium_support acccount password is enabled.

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

2.3.2. Download and install the PxM Virtual Appliance upgrade file

  1. Download the necessary PxM Virtual Appliance upgrade file from the Osirium Software Releases page.

    Refer to the Version upgrade paths chart for details on which upgrade file to download.


    A SHA256 checksum is available to verify the download integrity.

  2. Transfer the PxM Virtual Appliance upgrade file to the Osirium server using the osirium_support account.


    Transfer mode must be set to binary.

  3. From your virtual environment, open the PxM console.

    Virtual Appliance

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


    Alternatively, you could use an SSH connection to the Osirium Server.

    Server login

  5. In the login field, type osirium_support and press ENTER. A password field appears.

    Server login password

  6. In the password field, type the password you set for your osirium_support account and press ENTER. You will be directed to the osirium_support home directory.

    osirium_support directory

  7. Within the osirium_support home directory, extract the upgrade kit by using the following command:

    $ sudo bash [Osirium_kit_name] i.e. Osirium_6.0.1-23_upgrade.bin


    Ensure the version and build numbers match those of the upgrade kit being installed.

  8. Type the osirium_support account password and press ENTER. The upgrade kit begins extracting and the checksum verifies.

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

    Installing kit

    The following message appears:

    Press ENTER

  10. Press ENTER. The system configures and the EULA screen appears.

  11. Press ENTER to accept. The system configures and the following screen appears:

    Continue without restoring a backup

  12. Press ENTER to Continue without restoring a backup.

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

  14. Once the setup is complete, the following message will be displayed in the console window:

    Console setup finished

  15. Close your virtual environment.

2.3.3. 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 server for the version it should be correctly communicating with and auto updates if required.

See the following depending on the version of the PxM client you are using:

2.4. 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 Active Directory from the Manage Active Directory page, and then clicking Trigger audit.

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 Regenerate Account Credentials for all devices tasks within the profiles.
  • 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.