Backup/restore upgrade procedure

This section covers:

Upgrade procedure

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

Backup/restore upgrade procedure flowchart

Upgrade procedure

Prerequisites

Before starting your upgrade make sure the following prerequisites are met:

Prerequisite Description
Hardware & Software Ensure the correct resources are available before deploying. The following outlines the hardware and software requirements.

Prerequisites
Licencing A valid license file will be required during the finalise setup step. If you don't have a license file contact Osirium.
Ports Ensure TCP ports 443 and 9002 are open as they are required for the client-side and PxM UI.

TCP 2380 (etcd, i.e. key-value store), 2390 (cluster setup API), 2391 (cluster delegation API), 5432 (postgres, i.e. database)

For a full list of ports used by the PxM Platform click here .

Software packages downloaded Download the latest PxM Virtual Appliance software release package for deployment into your infrastructure.

To download the latest PxM Virtual Appliance software, click here.

NOTE: SHA256 checksum is available to verify the integrity of the download.

Master Encryption Key Ensure you have the Master Encryption Key (MEK) of the current PxM Virtual Appliance leader node.
Recent backup Ensure you have a recent backup of all your nodes (leader and followers).
No active user connections Ensure there are no active user connections.
Regenerate Account Credentials for all devices task is disabled Within the Web Management Interface, disable all scheduled Regenerate Account Credentials for all devices tasks.
Osirium Support account is enabled Ensure the Osirium Support account has been enabled.

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 Edit pencil. 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 box.

    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.

Software packages and downloads

To download the latest PxM Virtual Appliance software release package for deployment into your infrastructure, click here.

A SHA256 checksum is available to verify the download integrity.

Note

The transfer mode must be set to binary.

Deploying the PxM Virtual Appliance

Deployment into the different supported infrastructures may vary therefore, click on a link below to be navigated to the correct deployment steps.

Upgrading the PxM Virtual Appliance

Once the PxM Virtual Appliance has been successfully deployed into your infrastructure you will need to run through the setup and configuration.

  1. Open the console window of the new PxM Virtual Appliance.

  2. Within the Console window, press ENTER when prompted to start the setup and configuration.

    Enter setup

  3. Read and accept the EULA to continue.

    eula

  4. Within the Configure Networking screen, configure the following virtual appliance settings. Press TAB to navigate between the fields.

    • IP Address: Enter the IP Address which will be used to connect to the virtual appliance.
    • Netmask: Enter the network mask.
    • Gateway: Enter the network default gateway IP address.
    • Primary DNS: Enter the network primary DNS IP address.
    • (Secondary DNS): Enter the secondary DNS IP address if relevant, else leave blank.

    configure networking

  5. Once completed TAB down to the OK button and press ENTER.

  6. When you get to the PxM Platform Restore screen, SFTP onto the virtual appliance using the IP Address, username and password shown on the screen.

    sftp details

  7. Copy the backup file of the PxM Virtual Appliance you want to restore onto this new PxM Virtual Appliance. Once successfully copied, the screen will update and the copied backup file will appear in the list.

    Backup restore file

  8. Select the backup file and press ENTER. When prompted TAB to the OK button and press ENTER.

    Backup restore confirmation

  9. Enter the Master Encryption Key (including dashes) of the PxM Virtual Appliance that the backup was taken from. Select OK and press ENTER.

    Backup restore MEK

  10. Within the Enter a hostname window, enter a name to identify the new PxM Virtual Appliance.

    hostname

  11. TAB down to the OK button and press ENTER.

  12. Enter the FQDN or IP Address which will be assigned to the node. The configuration entered here is used to communicate between nodes. FQDN or IP Address

    If the following error occurs then make sure that the hostname can be resolved and check if it has been included in the DNS A records - see Prerequisites.

    Hostname resolution error

  13. TAB down to the OK button and press ENTER.

  14. Set a password for the primary superadmin account. The username (superadmin) and the password will be used later to log into the PxM Client. superadmin password

  15. TAB down to the OK button and press TAB.

  16. Confirm the primary superadmin account password.

  17. TAB down to the OK button and press TAB. Wait while the system is configured.

    Make a note of the https address which will be required to connect to the PxM Virtual Appliance from the PxM UI. For instructions to install and configure the PxM UI click here. Console window

Upgrading the PxM UI

After upgrading your PxM Virtual Appliance you must ensure that you are using the appropriate version of the PxM UI.

Click here for the PxM UI installation and upgrade guide.

Note

We recommend that you use the PxM UI rather than the PxM Client to connect to the PxM Virtual Appliance. This approach will enable you to use new features which are not supported by the PxM Client.

Click here for the PxM Client guide.

Finalise setup

Uploading an Osirium product licence

Once the configuration has completed and your virtual appliance has rebooted, you will need to log on using the PxM UI and upload a valid Osirium product licence to get started.

  1. Click here for instructions on how to log on to the PxM Virtual Appliance via the PxM UI.

    Alternatively if you wish to use the PxM Client to log on to the PxM Virtual Appliance please contact Osirium support by clicking here.

  2. Once successfully logged on, open up the Web Management Interface. You will be prompted to upload a valid Osirium licence before you can start using the PxM Platform.

    Click Choose File and select the licence file.

    Licence upload

  3. Click Upload.

  4. Click Acknowledge within the Action notifications window. Your browser will be refreshed.

  5. Your PxM Virtual Appliance is now ready.

    PxM Client login

  6. To confirm the cluster status, on the Web Management Interface navigate to the System configuration > Clustering tab. Information on this page will update if additional nodes (followers) are joined to the cluster.

    If there is only one node the Local role will be displayed as Standalone.

    Cluster tab standalone

    Once a second node has been created and joined to the cluster the Local role will be updated to Leader and the Node status will be displayed as Clustered.

    Cluster tab clustered

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.

Once the backup has successfully installed, log onto the PxM Virtual Appliance using the PxM UI.

Before allowing users to connect back onto the PxM Platform:

  • Ensure the devices are running successfully.

  • Ensure the devices are still accessible through the PxM UI.

  • Within the Web Management Interface, re-enable scheduled Regenerate Account Credentials for all devices tasks.

  • Take a backup of the new PxM Virtual Appliance.