3. Installing the PxM Virtual Appliance within Microsoft Azure

This chapter provides instructions on how to install the PxM Virtual Appliance within Microsoft Azure.

3.1. Introduction

When installing the PxM components ensure the virtual appliance meets the following minimum requirements as recommended by Osirium.

PxM Component Prereq

3.2. Microsoft Azure installation steps

To install the PxM Virtual Appliance:

  1. Logon to the Microsoft Azure portal.

  2. From the Microsoft Azure dashboard click the Create a resource option in the upper left-hand corner.

  3. Within the New window, type Osirium in the Search the Marketplace box and hit ENTER.

    new select offering

  4. Within the Everything window, the search results will show the Osirium PxM Platform offerings.

    We recommend you use the latest version for a new installation, otherwise select the version you require.

    Azure Everything

  5. Within the The Osirium PxM Platform Virtual Appliance window, read the information. There is only one deployment mode which is already selected and can not be changed. Click Create.

    Deployment model

  6. Within the Create virtual machine window, Basics tab, enter the virtual appliance information.


    When deploying the virtual machine, you MUST set the Username to osirium_support and use password based authentication type (and not SSH key based authentication).


    Field name Description
    Subscription Select based on your own deployment requirements.
    Resource group Select based on your own deployment requirements.


    Field name Description
    Virtual machine name

    Enter a name you want the PxM Virtual Appliance to be identified as. The name given will also be used as the hostname of the virtual appliance.


    The name can not contain non-ACSII or special characters.

    Region Select based on your own deployment requirements.
    Availability options Select based on your own deployment requirements.
    Image Leave as default.

    To view the PxM Platform recommended virtual appliance sizes, look on the Osirium PxM Platform > Plans + Pricing section of the Microsoft Azure Marketplace page.


    For a non production environment virtual appliance i.e. proof of concept, test or development, you would be fine with a smaller offering.


    Field name Description
    Authentication type

    MUST set to Password.


    The password value must be between 12 and 72 characters long and contain 3 of the following: 1 lower case character, 1 upper case character, 1 number, and 1 special character that is not or -.

    Username This MUST be osirium_support and will be used to log into the PxM Virtual Appliance to install the PxM software.
    Password Enter a password that fulfills the recommended criteria set by Manage accounts.
    Confirm password Reconfirm the password set.


    Azure Step 1 example

  7. Click Next : Disks >.

  8. Within the Create virtual machine window, Disks tab, enter the disk options.


    Field name Description
    OS disk type Recommended disk type is Standard SSD.
    Use unmanaged disks Leave as default.


    No configuration required.

    Azure Step 2

  9. Click Next : Networking >.

  10. Within the Create virtual machine window, Networking tab, select your preferred settings.


    As default the virtual appliance is given a public IP address and a corresponding Network security group (firewall) setting. This allows the PxM Virtual Appliance to be accessed and managed through the stated public ip address. If you don’t want to access via a public ip address then adjust the settings as required.

    If you are using a public ip address then set the Assignment to Static.

  11. Click Next : Management >, select your preferred settings.

  12. Click Next : Advanced >, select your preferred settings.

  13. Click Next : Tags >, select your preferred settings.

  14. Click Next : Review + Create >. Wait while the virtual machine is validated.

  15. Click Create once the validation has succeeded. Wait while the virtual appliance is created and deployed.

  16. Once the virtual appliance has been created, ssh onto the virtual appliance using your preferred tool and login using the osirium_support account and password set in step 1.

    Azure ssh

  17. Within the ssh session type sudo pxm-install to start the installation of the PxM Virtual Appliance software.

    Azure ssh logged in

  18. Hit ENTER to run the command.

  19. When prompted hit ENTER to continue.

  20. Within the EULA page hit ENTER to Accept.

  21. Within the blue screen window, hit ENTER to continue without restoring a backup as this is a new build.

  22. 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.

  23. TAB to <ok> and hit ENTER.

  24. Reenter your chosen primary superadmin password.

  25. TAB to <ok> and hit ENTER.

  26. Your Master Encryption Key will be shown.

    Master Encryption Key

    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 the 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.

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

  28. Enter the Master Encryption Key to verify.

  29. TAB to <ok> and hit ENTER.

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

    Azure installation completed

  31. Once the server has rebooted, you can start the initial configuration. See Virtual Appliance Initial Configuration for the next steps.