You can use the OVF authoring options that are included in a virtual machine vApp options to specify custom information that is preserved when you export the virtual machine as an OVF template.

vApp properties are a central concept to vApp deployment and self-configuration. They can turn a general OVF package into a running vApp instance with a custom configuration.

The set of properties assigned to a running vApp is determined by the OVF package from which the vApp is deployed.
  • When an OVF package is created the author adds the set of properties necessary for the vApp to function in an unknown environment. For example, properties that contain network configuration, a property that contains the email address of the system administrator, or a property that contains the number of expected vApp users.
  • Some property values are entered by the user when the vApp is deployed, while other property values are configured by vCenter Server when the vApp is powered on. How properties are handled depends on the property type and the vCenter Server configuration.

When vCenter Server powers on a vApp, it creates an XML document that contains all properties and their values. This document is made available to each virtual machine in the vApp, and allows the virtual machines to apply the properties to their own environment.

Edit vApp Product Information for a Virtual Machine

If you want to export a virtual machine as an OVF template, you can specify product information that becomes available when you deploy a new virtual machine from the OVF template.

Procedure

  1. Navigate to a virtual machine from the vCenter Server inventory.
  2. On the Configure tab, expand Settings and select vApp options.
  3. Click the Edit button.
    The Edit vApp Options dialog box opens.
  4. To enter product and vendor information, click the Details tab.
    vApp Setting Description
    Name Product name.
    Product URL If you enter a product URL, a user can click the product name on the virtual machine summary page and go to the product's web page.
    Vendor Vendor name.
    Vendor URL If you enter a vendor URL, a user can click the vendor name from the Summary page of the virtual machine and go to the vendor's web page.
  5. Click OK.

Manage vApp Custom Properties for a Virtual Machine

You can define and manage custom properties that are stored in the OVF template when you export a virtual machine or vApp and are used by vCenter Server when you deploy the OVF template. OVF templates support static properties, which are often configured by the user, and dynamic properties, which are always set by the vCenter Server.

To customize your virtual machine or vApp with properties, perform the following steps.
  1. Define the OVF properties, for example a DNS address or gateway, in the virtual machine or vApp.
  2. If you plan to export the virtual machine or the vApp to an OVF template:
    1. Set up the OVF environment transport to carry the settings into the virtual machine. See Edit OVF Details for a Virtual Machine.
    2. Write some glue-code to access and apply the information to the virtual machine.

See the VMware vApp Developer blog topic Self-Configuration and the OVF Environment for a discussion, sample code, and a video.

Procedure

  1. Navigate to a virtual machine from the vCenter Server inventory.
  2. On the Configure tab, expand Settings and select vApp options.
  3. You can manage custom properties from the Properties panel.
    Option Description
    Add To create a property, click Add.
    Edit To edit an existing property, select the property and click Edit.
    Set Value To set a new value to the existing property, select the property and click Set Value.
    Delete To delete an existing property, select the property and click Delete.

Edit vApp IP Allocation Policy for a Virtual Machine

You can set or edit the IP allocation policy that the virtual machine uses when you export it to an OVF template and deploy the OVF template.

Procedure

  1. Navigate to a virtual machine from the vCenter Server inventory.
  2. On the Configure tab, expand Settings and select vApp options.
  3. Click the Edit button.
    The Edit vApp Options dialog box opens.
  4. If vApp options are not enabled, select the Enable vApp options check box.
  5. Select the IP protocol and an IP allocation scheme.

    The supported protocols are IPv4, IPv6, or both.

    Consult the following table to learn more about the IP allocation schemes.

    Option Description
    OVF environment IP allocation is determined by the environment in which you deploy the OVF template.
    DHCP The IP addresses are allocated through a DHCP server when the virtual machine is powered on.
    The information you specify in the Authoring section will be used if you export the virtual machine to OVF and deploy the OVF at a later time.
  6. Click OK.

Edit OVF Details for a Virtual Machine

A virtual machine's OVF settings allow you to customize the OVF environment, OVF transport, and boot behavior after OVF deployment. You can edit and configure settings that affect the OVF environment in the Virtual Machine Properties dialog box.

Prerequisites

vApp options must be enabled in order to access these options.

Procedure

  1. Navigate to a virtual machine from the vCenter Server inventory.
  2. On the Configure tab, expand Settings and select vApp options.
  3. Click the Edit button.
    The Edit vApp Options dialog box opens.
  4. If vApp options are not enabled, select the Enable vApp options check box.
  5. To customize the OVF settings for the virtual machine, click the OVF Details tab.
    Option Description
    OVF environment transport
    • If you select ISO image, an ISO image that contains the OVF template information is mounted in the CD-ROM drive.
    • If you select VMware Tools, the VMware Tools guestInfo.ovfEnv variable is initialized with the OVF environment document.
    Installation boot If you click Enable, the virtual machine reboots after the OVF deployment completes. You can specify the delay time in seconds before the virtual machine starts the reboot operation.
  6. Click OK to save your changes.
    In the vApp Options are enabled pane, you can view the OVF Settings panel with information about the OVF settings.
  7. (Optional) To view information about the OVF environment settings, power on the virtual machine and click the View OVF Environment button in the vApp Options are enabled pane.
    The information is displayed in XML format.