1. Installing the PxM Virtual Appliance on AWS

This document provides instructions for deploying the PxM Virtual Appliance on the Amazon Web Services cloud computing services environment.

1.1. PxM Platform components

The PxM Platform consists of the following components:

PxM Components

Component Description
PxM Virtual Appliance Main component which drives the PxM Platform. It incorporates the virtual appliance, database, and Web Management Interface.
PxM Client

Allows Superadmins to access the Web Management Interface to manage PxM Platform and users to single sign onto devices and run device tasks.


This is included in the PxM Virtual Appliance.

PxM MAP Server

Enables remote applications to be launched from the PxM Client.

The PxM MAP Server software is installed on a Microsoft Windows Server.

1.2. Prerequisites

To deploy the PxM Virtual Appliance you will need access to the Amazon Web Services (AWS) web portal.

When installing the PxM Virtual Appliance ensure it meets the following minimum recommended requirement.

PxM Component Prereq

1.3. Deployment and setup steps

To install the PxM Virtual Appliance:

  1. Log onto the AWS Management Console.

  2. Within the AWS services window select EC2 within the All services > Compute heading.

    AWS Mgt Console

  3. Click Launch Instance within the EC2 Dashboard > Resources window.

    EC2 Dashboard

  4. Step 1: Choose an Amazon Machine Image (AMI) window, click AWS Marketplace from the left-hand menu. Search for Osirium PxM Virtual Appliance.

    Step 1 AMI

  5. Click Select next to the latest version found. You will be presented with the Osirium PxM Platform pricing information. Click Continue.


  6. Step 2: Choose an Instance Type window, select the instance you want to deploy the PxM Virtual Appliance onto.


    Recommendation is a minimum instance size of 2 vCPUs and 8 GiB.

    Step 2 Choose instance type

  7. Click Next: Configure Instance Details.

  8. Step 3: Configure Instance Details window, configuring as per your requirements.

    Step 3 Configure instance details

  9. Click Next: Add Storage.

  10. Step 4 Add Storage window, configure a minimum storage size of 40GB.

    Step 4 Add storage


    To add an additional volume see: Adding Instances Store Volumes to Your EC2 Instance.

  11. Click Next: Add Tags.

  12. Step 5: Add tags window: configure tags as per your requirements.

    Step 5 Add tags

  13. Click Next: Configure Security Group.

  14. Step 6: Configure Security Groups window, Click Next: Configure Security Groups. The PxM Platform preconfigured security group will be visible and the required firewall rules that need to be applied will be listed.

    Step 6 Configure security groups

  15. Click Review and Launch.

  16. Step 7: Review Instance Launch window, review and click Launch.

    Step 7 Review Instance Launch

  17. Within the Select an existing key pair or create a new key pair window select the option you want to use. If you use an existing key pair or create a new key pair, make sure the private key file is made available to auperadmin who may need to login to the default ubuntu account.

    Key Pair

  18. Click Launch Instances.

  19. Within the Launch Status window, click View Instances. Wait while the instance is initialised and passed the Status Checks.

    Launch status

  20. From the instances list, right-click the PxM Virtual Appliance instance created and click Connect.

    Instance list

  21. You will be presented with the Connect To Your Instance window which provides the instructions on how to connect to your instance. Leave this window open.

    Connect to your instance

  22. Open an SSH client of your choice and follow the instructions in the Connect To Your Instance window to get to your instance using the private key file.

  23. Within the ssh client type the command sudo pxm-install to start the installation.

    ssh window

  24. At the prompt press ENTER

    Press ENTER

  25. The system configures and the EULA screen appears. Press ENTER to accept.


  26. Press ENTER to Continue without restoring a backup.

    continue without restoring backup

  27. Your Master Encryption Key will be shown.


    Type Description
    Master encryption key

    This key is very important so make sure it is securely stored externally for future reference as it is not stored within PxM Platform.

    It will be required during a backup/restore procedure to recreate the hash file and decrypt the PxM Platform database stored within the backup file.

    See PxM Virtual Appliance backup and restore guide.


    During the installation process the master encryption key is combined with the Salt to generate a hash which is stored in a file.

    The Salt is stored on the PxM Virtual Appliance and will be included in the backup file.


    Is generated during the installation process and stored on the PxM Virtual Appliance. The hash file will not be included in the backup file.

    During a backup/restore procedure the master encryption key will be used with the salt to recreate the hash and decrypt the backup database file to reinstate the PxM Virtual Appliance.

  28. TAB down to the OK button and hit ENTER.

  29. Enter the Master Encryption Key to verify.

  30. TAB to <ok> and hit ENTER.

  31. Enter a password for your primary superadmin.


    You will need the username: superadmin and the password entered to login to the PxM Client later so make a note of it.

    primary superadmin

  32. TAB to <ok> and hit ENTER.

  33. Reenter your chosen primary superadmin password.

    confirm primary superadmin

  34. TAB to <ok> and hit ENTER.

  35. When the installation has been completed the system will be rebooted. You can close your ssh session.

    install complete