OVF Configuration

Overview

QuantaStor supports automatic configuration of new VM instances via OVF configuration properties. This helps with QuantaStor virtual appliance deployment as things like the management IP address, license keys, and the default 'admin' user password can all be configured via the OVF Configuration Properties for the system to configure itself with on first boot.

Supported Properties

To configure the 'admin' management user default password you can set the 'password' property. Note that after the password has been applied the system will automatically clear the password property from the VM instance's OVF Configuration Property settings for security purposes.

• password
  • Default password is just "password" but this property gives one the opportunity to change the default password on first boot to any password of your choice that fits within QuantaStor's default password policy rules.

To configure the management ethernet interface on a new VM these properties are required:

• mgmt-intf
  • Name of the network interface to be configured, example "ens192"

• mgmt-intf-ip
  • Static IP address to apply to the network interface.

• mgmt-intf-subnet
  • IP subnet to apply to the interface, for example "255.255.0.0"

To automatically inject a license key into the new VM apply these properties, note that each QuantaStor VM will need its own unique system license key and for paid systems a unique support license key. If you're using Community Edition or Trial Edition keys there will only be a system key and no support license key required. Trial Edition and Community Edition license keys are available from our auto-provisioning system at https://osnexus.com/downloads

• lic-key-system
  • Storage System license key, this must contain the whole key block including the start and end tags which contain "START KEY" and "END KEY".

• lic-key-support
  • Support license key, this does not apply for Community Edition or Trail Edition licenses. As with system keys, this must contain the whole key block including the start and end tags which contain "START KEY" and "END KEY".

OVF Configuration Properties XML

This block of XML can be added into your OVF configuration file to insert the properties directly into an OVF file.

  <PropertySection>
        <Property oe:key="lic-key-support" oe:value=""/>
        <Property oe:key="lic-key-system" oe:value=""/>
        <Property oe:key="mgmt-intf" oe:value=""/>
        <Property oe:key="mgmt-intf-ip" oe:value=""/>
        <Property oe:key="mgmt-intf-subnet" oe:value=""/>
        <Property oe:key="password" oe:value=""/>
  </PropertySection>

Manually Configuring OVF Configuration Properties in VMware

The above mentioned properties can be manually added to the OVF configuration after a VM template has been created within VMWare. This is done through a few steps outlined here:

Step 1 - Enable OVF Custom Properties

Step 2 - Add Property for Password Customization

Step 3 - Add Properties for Licensing Customization

Repeat for lic-key-support.

Step 4 - Add Properties for IP Address Customization

Repeat for mgmt-intf-ip and mgmt-intf-subnet.

Compare your results with the following image:

Deploying an OVF With Configuration Properties in VMware

Set your configuration properties when deploying an OVF with Configuration Properties to a new VM. Your entries should look similar to the following screenshot:

Note that the 'lic-key-system' and 'lic-key-support' fields must contain the entire license key from "--------START KEY BLOCK--------" to "---------END KEY BLOCK---------".

Configuration will take place once the VM is turned on and run for the first time.