Working with vApp Templates

A vApp template is a virtual machine image that is loaded with an operating system, applications, and data. These templates ensure that virtual machines are consistently configured across an entire organization.

  • Open a vApp Template
  • Add a vApp Template to My Cloud
  • Download a vApp Template
  • Upload an OVF Package as a vApp Template
  • Resume the Upload of a vApp Template
  • Add a vApp Template from a Catalog
  • Copy a vApp Template from a Catalog
  • Move a vApp Template to a Catalog
  • Delete a vApp Template
  • Save a vApp as a vApp Template
  • Modify vApp Template Properties
  • Open a vApp Template

    When you open a vApp template, you can access the virtual machine that is based on the template.

    You are at least a vApp user.

    Procedure

    1. Click Catalogs.
      You can open vApp templates in your organization's catalogs or, if you are an organization administrator, from the public catalog.
    2. On the vApp Templates tab, select a vApp template, right-click, and select Open.

    Add a vApp Template to My Cloud

    You can add a vApp template as a vApp from your catalog to My Cloud.

    You are at least a vApp author.

    Prerequisites

    A vApp template is available in a locally shared catalog or a public catalog.

    Procedure

    1. Click Catalogs.
    2. On the vApp Templates tab, select a vApp template, right-click, and select Add to My Cloud.
    3. Proceed through the wizard and provide information when prompted.
    4. Click Finish.

    The vApp template appears as a vApp on the vApps page.

    Download a vApp Template

    You can download a vApp template from a catalog locally as an OVF file.

    You are at least a catalog author.

    Prerequisites

    The computer from which you are downloading have Java Plug-in 1.6.0_10 or later installed.

    NOTE: The file transfer tool is compatible with Firefox or Internet Explorer running on a Windows or Linux operating system.

    Procedure

    1. Click Catalogs.
    2. Select a vApp template, right-click, and select Download.
    3. Navigate to the local folder where you want to save the OVF file.
    4. Click Save.

    You can click the Launch the Uploads and Downloads Progress Window button to track the progress.

    Upload an OVF Package as a vApp Template

    You can upload an ovf package from remote shares and your local directory to vmForge as a vApp template.

    NOTE: We can not provide support for any virtual machines or vApps imported using this method.

    You are at least a catalog creator.

    Prerequisites

    • The computer from which you are uploading must have Java Plug-in 1.6.0_10 or later installed.
    • NOTE: The file transfer tool is compatible with Firefox or Internet Explorer running on a Windows or Linux operating system.
    • For information about creating OVFs, see the OVF Tool User Guide and VMware vCenter Converter 4.0.1 User's Guide.
    • We do not support uploading compressed OVF files.

    Procedure

    1. Click Catalogs.
    2. On the vApp Templates tab, click the Upload button.
    3. Type the name and path of the OVF file to upload.
    4. If you click Browse, select a local file or mapped remote drive and click Open.
    5. Type a destination name and description for the file.
    6. Select a destination vDC and catalog.
    7. Click Upload.

    What to do next

    You must verify that VMware Tools is installed in each virtual machine's Properties page. You can click the Launch the Uploads and Downloads Progress Window button to track the progress.

    Resume the Upload of a vApp Template

    If the upload process is interrupted, paused, or cancelled you can resume it.

    • You are at least a catalog creator.
    • If you log out of vmForge and log in, transfer history is lost. You cannot resume the upload.
    • The default timeout for pending transfer sessions is one hour. You can configure this value up to one hour.
    • During pending or stopped transfers, the session keep alive heartbeat kicks in every 15 minutes. To ensure that the session does not time out while tasks are paused, make sure the session timeout value is more than 15 minutes.

    Prerequisites

    You have initiated the upload or download of a vApp template.

    Procedure

    1. In the Launch the Uploads and Downloads Progress Window, click Pause or Cancel.
      The status changes to Stopped in the progress window and Waiting in the vApp Template page.
    2. In the Launch the Uploads and Downloads Progress Window, click Resume.
      The upload or download process resumes.
    3. Monitor the progress in the Launch the Uploads and Downloads Progress Window.

    Add a vApp Template from a Catalog

    You can add a vApp template from a the public catalog to your catalog.

    You are at least a catalog author.

    Prerequisites

    You have set up multiple catalogs and vDCs.

    Procedure

    1. Click Catalogs.
    2. In the left pane, click Public Catalogs.
    3. On the vApp Templates tab, select a vApp template, right-click, and select Copy To Catalog.
    4. Modify the name and select a destination catalog and vDC.
    5. Click OK.

    The added vApp template appears in My Organization's Catalogs. See "Customizing Your Guest Operating System," for more information on customizing the guest OS in a virtual machine in a vApp template.

    Copy a vApp Template from a Catalog

    When you copy a vApp template from a catalog to another catalog in your organization, you can group these templates in a new catalog.

    You are an organization administrator.

    Prerequisites

    A catalog and a vDC must be available.

    Procedure

    1. Click Catalogs.
    2. In the left pane, click Public Catalogs or My Organization's Catalogs.
    3. In the right pane, select a vApp template, right-click, and select Copy to Catalog.
    4. Type a name and select the destination catalog and vDC.
    5. Click OK.

    Move a vApp Template to a Catalog

    You can move a vApp template to another catalog and vDC in your organization.

    You are at least a catalog author.

    Prerequisites

    • Multiple catalogs and vDCs are available.
    • You cannot move vApp templates to the public catalog in another organization.

    Procedure

    1. Click Catalogs.
    2. Click My Organization's Catalogs.
    3. On the vApp Templates tab, select a vApp template, right-click, and select Move To Catalog.
    4. Select the catalog to which you want to move the vApp template.
    5. Click OK.

    Delete a vApp Template

    You can delete a vApp template from your catalog.

    You are at least a vApp owner.

    Procedure

    1. Click Catalogs.
    2. On the vApp Templates tab, select a vApp template, right-click, and select Delete.
    3. Click Yes.

    The selected vApp is deleted.

    Save a vApp as a vApp Template

    You can save a vApp as a vApp template to a catalog.

    You are at least a vApp author.

    Prerequisites

    • You have a catalog.
    • The vApp must be stopped.

    Procedure

    1. Click My Cloud.
    2. In the left pane, click vApps.
    3. Select a vApp, right-click, and select Add to Catalog.
    4. Type a name, select a vDC, a catalog, and a storage lease.
    5. Select an option.
      These options are not used when you use a virtual machine, when you create a new vApp, or add a new virtual machine.
      • Make Identical Copy
        vApps that are created from this vApp template must follow the guest operating system settings of the vApp template. If you select this option, and guest customization is enabled, the guest operating system is personalized.
      • Customize VM Settings
        Guest operating system is personalized regardless of the vApp template settings, and the guest operating system is personalized when the vApp is deployed.
    6. Click OK.

    The vApp is saved as a vApp template and appears in the destination catalog.

    Modify vApp Template Properties

    You can modify the properties of your vApp template.

    You are an organization administrator.

    Procedure

    1. Click Catalogs.
    2. On the vApp Templates tab, select a vApp template, right-click, and select Properties.
    3. On the General tab, modify the vApp name and determine whether you want to allow your users to reset their runtime and storage leases. If you leave the Reset leases check box deselected, users cannot update leases.
    4. On the Running tab, review the current boot sequence and modify it as necessary. You must type numbers that are in progression, for example, 0, 25, and 1,000 to set the sequence. Negative numbers are not allowed.
    5. On the Shared tab, you can search for and select the users which whom you want to share the vApp.
    6. Click OK.