VMware Cloud Director vApp consists of one or more virtual servers that communicate over a network and use resources and services in a deployed environment. A vApp can contain multiple virtual servers. To view the list of the current vApp functions you can perform in OnApp Control Panel refer to the Supported Functionality section of this guide.

This document provides the information on how you can manage the vApps imported from your VMware Cloud Director. 

This functionality is available for users with the following roles:

  • vCloud Catalog Author

  • vCloud vApp Author

  • vCloud vApp User

  • vCloud Organization Administrator

You can also access vApps shared with you by the administrator on the VMware Cloud Director side, depending on the access level granted to you.

View vApps

  1. Go to your Control Panel > Cloud > vApps menu to see an overview of all vApps in the cloud.
  2. The page that loads will show the list of vApps together with their details: 

    • Name - the name of the vApp

    • User - the owner of the vApp. Click the user name to see the owner details. The owner of the vApp can be changed in VMware Cloud Director. These changes are synchronized with OnApp and can be seen in Control Panel > Cloud > vApps menu.

    • Resource pool - the label of the resource pool of this vApp

    • Number of virtual servers - the number of virtual servers within the vApp

    • Number of networks - the amount of vApp networks associated with this vApp

    • Status - the vApp status:
      • Failed creation - the vApp could not be created
      • Unresolved - the vApp is damaged and cannot be controlled by vCloud
      • Resolved - the vApp has been created but it does not contain VSs
      • Suspended - the vApp has been suspended; all virtual servers in the vApp are suspended
      • Powered on - all the VSs in the vApp are on
      • Waiting for input - the vApp is waiting for user input
      • Unknown - the vApp is in a state that is identified but is not known to the system
      • Unrecognized - the vApp is in a state that cannot be identified by the system
      • Powered off - all the VSs in the vApp are off
      • Inconsistent state - the vApp is in an inconsistent state. This status appears when the vApp was edited from the vSphere associated with the VCD in which the vApp resides, therefore, the vSphere and VCD databases are not yet fully synchronized.
      • Mixed (number/number) - the amount of virtual servers in the vApp that have different power statuses: the first number before the slash indicates the amount of powered-on VSs, the second number - total amount of VSs in the vApp. 
      • Building - after the vApp is created or imported, its status will be Building, until the creation/import process is finished. On the overview screen of a specific vApp, its status will be shown as Pending. The user cannot perform any actions to the pending vApp except for deleting it.

    • Power - the power status of the vApp. To change the status, click the on/off buttons and confirm. 

    • Actions - click the Actions button to perform one of the following processes on the vApp:
      • Edit
      • Recompose
      • Add to Catalog
      • Stop/Start
      • Change owner
      • Delete
      • Spin up Network


      

vApp Details

Click the name of the vApp to view its details:

  • Name - the name of the vApp
  • Description - the description of the vApp
  • Status - the status of the vApp. The vApp can have the following statuses:
    • Failed creation - the vApp could not be created
    • Unresolved - the vApp is damaged and cannot be controlled by vCloud
    • Resolved - the vApp has been created but it does not contain VSs
    • Suspended - the vApp has been suspended; all virtual servers in the vApp are suspended
    • Powered on - all the VSs in the vApp are on
    • Waiting for input - the vApp is waiting for user input
    • Unknown - the vApp is in a state that is identified but is not known to the system
    • Unrecognized - the vApp is in a state that cannot be identified by the system
    • Powered off - all the VSs in the vApp are off
    • Inconsistent state - the vApp is in an inconsistent state. This status appears when the vApp was edited from the vSphere associated with the VCD in which the vApp resides, therefore, the vSphere and VCD databases are not yet fully synchronized.
    • Mixed (number/number) - the amount of virtual servers in the vApp that have different power statuses: the first number before the slash indicates the amount of powered-on VSs, the second number - total amount of VSs in the vApp. 
    • Pending - after the vApp is created or imported, its status will be Pending, until the creation/import process is finished. The user cannot perform any actions to the pending vApp except for deleting it.
  • Virtual servers - the number of virtual servers within the vApp
  • Number of CPUs - the number of CPUs used by the vApp
  • Virtual Servers - the list of VSs associated with this vApp and their details. By pressing the "+" button you can recompose this vApp.
  • vApp Networks - the list of vApp networks associated with this vApp and their details: label, status, network address. Click the Actions button to delete a vApp network. Removing the network will restart the vApp.
  • Activity log - the list of log items associated with this vApp. Click the Ref number of a log item to view its details (data, action, status, initiator of transaction etc.)

Alternatively, you can access the details page of a particular vApp from the Overview page of a VS assigned to this vApp. To view the details of the vApp with which the VS is associated, click the Tools button on the VS Overview screen at Control Panel > Cloud > Virtual Servers > label of the VS you are interested in > Tools > Go to vApp.


Creating vApps

You can create a new vApp based on a vApp template stored in a catalog to which you have access. Alternatively, you can compose a new vApp using virtual servers from vApp templates, new virtual servers, or a combination of both.

You cannot add vApps when being logged in as a non VMware Cloud Director user.


Deploy New vApp


To configure guest customization and recipes during vApp creation you need to have the Assign recipes to VS and Customize VS guest OS permissions.


To create a new vApp:

  1. Go to your Control Panel > Cloud > vApps menu to see an overview of all vApps in the cloud.

  2. Click the Deploy New vApp button. If a new vApp template is created and added to catalog in VMware Cloud Director, it will be synchronized with OnApp. This vApp template will be added to the list of all vApp templates.

  3. On the screen that appears, fill in the vApps creation form:

    Step 1. vApp

    • Name - specify the vApp label
    • Description - enter the description for the vApp
    • Resource Pool - select the resource pool for the new vApp

    • vApp Template - select the vApp template

    • Click Next.


    Step 2. VS Resources

    Click the template to set the resources for the VS that will be created from this template:

    • Label - specify the name of VS
    • CPU Cores - use the slider to set the number of CPU cores 
    • Cores per socket  - set the number of cores per socket for the VS
    • RAM - use the slider to set the RAM for the VS
    • Default Data Store - choose the default data store from the drop-down list. If fast provisioning is not enabled for the previously selected resource pool, you can choose a different data store for the VS's disks. 
    • Data Store for Hard Disk 1 - choose a data store from the drop-down list. This option appears only if the selected resource pool has fast provisioning disabled. If you do not select a data store, the disk will be built on the default data store.
    • Hard disk 1 Size - set the size in GB
    • NIC 0 Connection - select the network to which the NIC will be connected
    • Adapter Type for NIC 0 - select the type of the network adapter for NIC 0
    • Click Next to proceed. 


    Step 3. Guest Customization

    Click the template to configure guest customization for the VS that will be created from this template:

    General

    • Host Name - VS's computer name

    • Enabled - whether guest customization is enabled for the VS or not. The computer name and network settings configured for this VS are applied to its Guest OS when the VS is booted. Guest customization should be enabled if you want to configure recipes for this VS.

      If you do not tick the Enabled checkbox, the PerformGuestCustomizationOnVirtualMachines transaction will still run after you confirm vApp deployment: it will not perform guest customization on the VS, but only save the attributes selected at the Guest Customization step.

    • Change SID - this parameter is applicable for Windows VSs only and will run Sysprep to change Windows SID. On Windows NT, VCD uses Sidgen. Running sysprep is a prerequisite for completing domain join.
    • Automatically Reboot - enable this option if you want the VS to be automatically rebooted after guest customization settings are updated.

    Password Reset

    • Allow Local Admin Password - select whether the local admin password is allowed or not. This option should be enabled if you want to configure recipes for this VS.
    • Auto Generate Password - select whether the admin password is generated automatically or not
    • Admin password - enter the administrator password
    • Automatically log on as Administrator - if this option is disabled, you will not be automatically logged in to the server's OS. This option applies only to Windows VSs.
    • Number of Times to log on automatically - after the indicated time is exceeded and you were not able to log in, the VS will remain running and you will need to enter your credentials. This option applies only if the Automatically log on as Administrator option is enabled.
    • Require Administrator to Change Password on First Login - if this option is disabled, the administrator will be able to log in to the virtual server's OS without changing their password

    Customization Script

    • Script - a script for guest customization
    • Click Next to proceed. 


    Step 4. Recipes or Service Add-ons

    If you want to configure recipes for the VS, you need to enable the Enable and Allow Local Admin Password options at the Guest Customization step. Click the template to configure recipes for the VS that will be created from this template:

    Recipes

    Use the drag and drop feature to assign recipes to the provisioning event.

    1. Select the required recipe in the left pane and hold it down with the left mouse button.
    2. Drag the recipe up to the right pane and release the mouse button to drop the recipe and add it to the required event.
    3. If required, you can remove the assigned recipe by clicking the delete icon next to it.

    Custom Recipe Variables

    1. Specify the custom variable name and its value.
    2. Move the Enabled slider to the right to allow use of this custom variable.
    3. If required, you can remove a custom variable by clicking the delete icon next to it.

    If mentioned below prerequisites are met, the Recipes step will be replaced with the Service Add-ons step.

    Service Add-ons

    Prerequisites

    Ensure that the following requirements are met to be able to assign service add-on to vApp during its creation:

    • Replace recipes permission is enabled

    • Service add-on groups are available in your bucket

    • The service add-on group within the bucket has the On Provisioning option enabled for some of those service add-ons. In case there are no available service add-ons, then this step of the wizard will be skipped.

    At this step you need to indicate the service add-ons you want to assign to your vApp. This step is optional. You can add service add-ons later if required.

    1. Click the service add-on group icon on the left  to expand the list of service add-ons on the right. Every service add-on contains the following info:
      • Label
      • VS's types, with which this service add-on is compatible
      • description of the service add-on
      • Price per hour
    2. Select the service add-on.

    3. Click Next to proceed to the next step of the wizard that completes the vApp creation process.

      If you are deploying more than one template, take the above mentioned steps for every template.


    Step 5. Confirm

    Click the template to review the details of the VS that will be created from this template. 

    • Disable guest customization after run - move the slider to the right to schedule disabling of guest customization after the VS provisoning is finished.

      The checkbox is available if you enabled guest customization at the third step of the wizard.

    • Boot VS - move the slider to the right to boot the VS after deploying vApp. 

      If Boot VS is disabled and guest customization is enabled at the third step of the wizard, guest customization will be saved but not performed after the confirmation.
      If Boot VS is disabled, guest customiation is enabled at the third step of the wizard, and Disable guest customization after run is enabled, guest customization will be saved, disabled, and not performed.

  4. Click  Deploy vApp to finish the process.


Compose vApp

  1. Go to your Control Panel > Cloud > vApps menu to see an overview of all vApps in the cloud.
  2. Click the Compose vApp button.
  3. On the screen that appears, fill in the form:

    Step 1. vApps and vApp Templates

    • Blank vApp - move the slider to the right if you want to create a blank vApp. Such a vApp will not contain any virtual servers. You need to fill in only the Name, Description, and Resource Pool for a blank vApp.
    • Name - specify the vApp label
    • Description - enter the description for the vApp
    • Resource Pool - select the virtual data center

    • vApp Templates - select one or several vApp templates from the drop-down list. All VSs built on those templates will be copied to your new vApp.

    • vApps - select one or several vApps from the drop-down list. All VSs within selected vApps will be copied to your new vApp.

    Click Next. 

    Step 2. VS Resources

    Depending on the vApp Templates and vApps that you selected during the previous step, you can apply the following hardware customization to virtual servers: 

    • Label - edit the label of the virtual server
    • CPU Cores - edit the number of CPU cores allocated to the virtual server
    • Cores per Socket - edit the number of cores per socket allocated to the virtual server
    • RAM - edit the amount of RAM allocated to the virtual server
    • Default Data Store - select the default data store from the drop-down list. If Fast Provisioning is not enabled for the previously selected resource pool, you can select a different data store for the VS's disks. 
    • Data Store for Hard disk 1 - select a data store for the first hard disk from the drop-down list. This option appears only if the selected resource pool has Fast Provisioning disabled. If you do not select a data store, the disk is built on the default data store.
    • Hard Disk 1 Size - set the size for the first hard disk
    • NIC 0 Connection - the network to which the NIC will be connected
    • Adapter Type for NIC 0 - the type of the network adapter for NIC 0


    Click Next. 

    Step 3. Guest Customization

    Click the template to configure guest customization for the VS that will be created from this template:

    General

    • Host Name - VS's computer name

    • Enabled - whether guest customization is enabled for the VS or not. The computer name and network settings configured for this VS are applied to its Guest OS when the VS is powered on. Guest customization should be enabled if you want to configure recipes for this VS.

      If you do not tick the Enabled checkbox, the PerformGuestCustomizationOnVirtualMachines transaction will still run after you confirm vApp compose: it will not perform Guest Customization on the VS, but only save the attributes selected at the Guest Customization step.

    • Change SID - this parameter is applicable for Windows VSs only and will run Sysprep to change Windows SID. On Windows NT, VCD uses Sidgen. Running sysprep is a prerequisite for completing domain join.
    • Automatically Reboot - enable this option if you want the VS to be automatically rebooted after guest customization settings are updated.

    Password Reset

    • Allow Local Admin Password - select whether the local admin password is allowed or not. This option should be enabled if you want to configure recipes for this VS.
    • Auto Generate Password - select whether the admin password is generated automatically or not
    • Admin password - enter the administrator password
    • Automatically log on as Administrator - if this option is disabled, you will not be automatically logged into the server's OS. This option applies only to Windows VSs.
    • Number of Times to log on automatically - after the indicated time is exceeded and you were not able to log in, the VS will remain running and you will need to enter your credentials. This option applies only if the Automatically log on as Administrator option is enabled.
    • Require Administrator to Change Password on First Login - if this option is disabled, the administrator will be able to log into the virtual server's OS without changing their password

    Customization Script

    • Script - a script for guest customization
    • Click Next to proceed. 


    Step 4. Confirm

    During the final step, you can overview the summary of virtual servers that the vApp will include and edit Automation Settings. 

    • Disable guest customization after run - move the slider to the right to schedule disabling of guest customization after the VS provisoning is finished.

      The checkbox is available if you enabled guest customization at the third step of the wizard.

    • Boot VS - move the slider to the right to boot the VS after deploying vApp. Enabled bu default.

      If Boot VS is disabled and guest customization is enabled at the third step of the wizard, guest customization will be saved but not performed after the confirmation.
      If Boot VS is disabled, guest customiation is enabled at the third step of the wizard, and Disable guest customization after run is enabled, guest customization will be saved, disabled, and not performed.

  4. Click the Compose vApp button.


Recompose vApp


To configure guest customization and recipes during vApp creation you need to have the Assign recipes to VS and Customize VS guest OS permissions.


Unlike a Compose vApp option, which helps you to create a new vApp, the Recompose vApp option allows you to modify an existing vApp. After you recompose a vApp, new virtual servers will be added to it.

To recompose a vApp:

  1. Go to your Control Panel > Cloud > vApps menu.
  2. Click the Actions button next to the vApp you want to change, then click Recompose.
  3. Complete the two-step vApp recompose process:

    Step 1. vApp Template

    • vApp Template - select the vApp template

    • Click Next.

    Step 2. VS Resources

    Click the template to set the resources for the VS that will be created from this template:

    • Label - the name of VS
    • CPU Cores - use the slider to set the number of CPU cores 
    • Cores per socket  - set the number of cores per socket for the VS
    • RAM - use the slider to set the RAM for the VS
    • Default Data Store - choose the default data store from the drop-down list. If fast provisioning is not enabled for the previously selected resource pool, you can choose a different data store for the VS's disks. 
    • Hard disk 1 Size - set the size in GB
    • Data Store for Hard Disk 1 - choose a data store from the drop-down list. This option appears only if the selected resource pool has fast provisioning disabled. If you do not select a data store, the disk will be built on the default data store.
    • NIC 0 Connection - the network to which the NIC will be connected
    • Adapter Type for NIC 0 - the type of the network adapter for NIC 0
    • Click Next to proceed. 


    Step 3. Guest Customization

    Click the template to configure guest customization for the VS that will be created from this template:

    General

    • Host Name - VS's computer name

    • Enabled - whether guest customization is enabled for the VS or not. The computer name and network settings configured for this VS are applied to its Guest OS when the VS is powered on. Guest customization should be enabled if you want to configure recipes for this VS.

      If you do not tick the Enabled checkbox, the PerformGuestCustomizationOnVirtualMachines transaction will still run after you confirm vApp recompose: it will not perform Guest Customization on the VS, but only save the attributes selected at the Guest Customization step.

    • Change SID - this parameter is applicable for Windows VSs only and will run Sysprep to change Windows SID. On Windows NT, VCD uses Sidgen. Running sysprep is a prerequisite for completing domain join.
    • Automatically Reboot - enable this option if you want the VS to be automatically rebooted after guest customization settings are updated.

    Password Reset

    • Allow Local Admin Password - select whether the local admin password is allowed or not. This option should be enabled if you want to configure recipes for this VS.
    • Auto Generate Password - select whether the admin password is generated automatically or not
    • Admin password - enter the administrator password
    • Automatically log on as Administrator - if this option is disabled, you will not be automatically logged into the server's OS. This option applies only to Windows VSs.
    • Number of Times to log on automatically - after the indicated time is exceeded and you were not able to log in, the VS will remain running and you will need to enter your credentials. This option applies only if the Automatically log on as Administrator option is enabled.
    • Require Administrator to Change Password on First Login - if this option is disabled, the administrator will be able to log into the virtual server's OS without changing their password

    Customization Script

    • Script - a script for guest customization
    • Click Next to proceed. 


    Step 4. Recipes

    If you want to configure recipes for the VS, you need to enable the Enable and Allow Local Admin Password options at the Guest Customization step. Click the template to configure recipes for the VS that will be created from this template:

    Recipes

    Use the drag and drop feature to assign recipes to the provisioning event.

    1. Select the required recipe in the left pane and hold it down with the left mouse button.
    2. Drag the recipe up to the right pane and release the mouse button to drop the recipe and add it to the required event.
    3. If required, you can remove the assigned recipe by clicking the delete icon next to it.

    Custom Recipe Variables

    1. Specify the custom variable name and its value.
    2. Move the Enabled slider to the right to allow use of this custom variable.
    3. If required, you can remove a custom variable by clicking the delete icon next to it.

    If mentioned below prerequisites are met, the Recipes step will be replaced with the Service Add-ons step.

    Service Add-ons

    Prerequisites

    Ensure that the following requirements are met to be able to assign service add-on to vApp during its creation:

    • Replace recipes permission is enabled

    • Service add-on groups are available in your bucket

    • The service add-on group within the bucket has the On Provisioning option enabled for some of those service add-ons. In case there are no available service add-ons, then this step of the wizard will be skipped.

    At this step you need to indicate the service add-ons you want to assign to your vApp. This step is optional. You can add service add-ons later if required.

    1. Click the service add-on group icon on the left  to expand the list of service add-ons on the right. Every service add-on contains the following info:
      • Label
      • VS's types, with which this service add-on is compatible
      • description of the service add-on
      • Price per hour
    2. Select the service add-on.
    3. Click Next to proceed to the next step of the wizard that completes the vApp creation process.


    Step 5. Confirm

    • Disable guest customization after run - move the slider to the right to schedule disabling of guest customization after the VS provisoning is finished.

      The checkbox is available if you enabled guest customization at the third step of the wizard.

    • Boot VS - move the slider to the right to boot the VS after deploying vApp. 

      If Boot VS is disabled and guest customization is enabled at the third step of the wizard, guest customization will be saved but not performed after the confirmation.
      If Boot VS is disabled, guest customiation is enabled at the third step of the wizard, and Disable guest customization after run is enabled, guest customization will be saved, disabled, and not performed.


      Click the template to review the details of the VS that will be created from this template. 

  4. Click Recompose vApp to finish the process.

You can also access the vApp recompose wizard at Control Panel > Cloud > vApps > Label >  icon in the Virtual Servers section.


Add vApp to Catalog


  1. Go to your Control Panel > Cloud > vApps menu.
  2. Click the Actions button next to the vApp you want to add to catalog, then click Add to Catalog.
  3. Fill in the following fields:

    • Catalog - choose the catalog from the drop-down list

      You can add vApp to a public catalog, which belongs to the same organization as vApp does.

    • Overwrite Catalog Item - move the slider to the right to save this vApp as template instead of another vApp template. In the Target vApp Template fileld choose the appropriate vApp template, which will be replaced, from the drop-down list.

      If you assign a system service add-on to a VS associated with a vApp, and then convert this vApp to a vApp template, the aforementioned system service add-on will also be assigned to the newly created vApp template.

    • Label - specify the name of the vApp. This option is missing if the Overwrite catalog item slider is enabled.
    • Description - add the appropriate vApp description
  4. Click Add vApp to Catalog.

After you add a vApp to catalog, you will be able to create a new vApp with the same configuration as the original one.

Prerequisites

Ensure that Convert vApp permission is on before adding vApp to catalog. For more information about permissions refer to the VMware Cloud Director Permissions section of this guide.



Change vApp Owner

  • You need to have the Change vApp Owner permission enabled to assign a vApp to the new owner.
  • When you share your vApp with the organization or specific users and groups on the VCD side, the changes are automatically synchronized to Control Panel. Depending on the access level that you set via VCD, the corresponding users can access shared vApps on CP.
  1. Go to your Control Panel > Cloud > vApps > Label.
  2. Click the Tools button and select Change Owner.
  3. In the pop-up window select the new owner of the vApp from the drop-down list.
  4. Click Change owner.


Edit vApp


  1. Go to your Control Panel > Cloud > vApps menu.
  2. Click the Actions button next to the vApp you are interested in, then click Edit.
  3. On the screen that appears, you can edit the name and description of the vApp.
  4. Click Save.


Start/Stop vApps


To start a vApp in the cloud:

  1. Go to your Control Panel > Cloud > vApps > Label.
  2. Click the Tools button and then click Start.

To shut down the vApp forcefully:

  1. Go to your Control Panel > Cloud > vApps > Label.
  2. Click the Tools button and then click Stop.

To shut down the vApp gracefully:

  1. Go to your Control Panel > Cloud > vApps > Label.

  2. Click the Tools button and then click Shutdown.


Start/Stop vApp Virtual Servers


You can schedule actions for starting and stopping virtual servers when the vApp is being started and stopped. 

To preconfigure the start/stop actions for virtual servers that the vApp contains: 

  1. Go to your Control Panel > Cloud > vApps > Label.
  2. Click the Tools button and then click Starting and stopping VSs.
  3. At the page that appears, you can set start/stop actions using the instructions from the table below.
  4. Click the Submit button to apply settings. 
Virtual Server LabelOrderStart ActionStart Delay (seconds)Stop ActionStop Delay (seconds)
The list of vApp virtual servers to start and stop when the vApp is being started and stopped.For vApps with multiple virtual servers, specify the order in which to start and stop VSs by typing numbers in the box. Virtual servers with lower numbers are started first and stopped last. You cannot specify negative numbers. Virtual servers with the same numbers are started and stopped at the same time.

Select an action to apply to virtual servers when you start the vApp:

  • Power On - select this option to power on virtual servers
  • None - select this option to run no start action on virtual servers
The delay in seconds after starting one virtual server and before starting the next virtual server.

Select an action to apply to virtual servers when you stop the vApp:

  • Power Off - select this option to power off virtual servers forcefully
  • Shutdown - select this option to shut down virtual servers gracefully
The delay in seconds to wait after stopping one virtual server and before stopping the next virtual server.



Suspend/Unsuspend vApp


To suspend a vApp:

  1. Go to your Control Panel > Cloud > vApps menu to view all vApps and click the label of the required vApp.

  2. Click the Tools button and select Suspend. The transaction to suspend all the VSs in the vApp will be scheduled.

There are two methods of unsuspending a vApp:

To shutdown all the vApp's VSs and unsuspend the vApp:

  1. Go to your Control Panel > Cloud > vApps menu to view all vApps and click the label of the required vApp.

  2. Click the Tools button and select Unsuspend. All the VSs in the vApp will shut down.


To start up all the vApp's VSs and unsuspend the vApp:

  1. Go to your Control Panel > Cloud > vApps menu to view all vApps and click the label of the required vApp.

  2. Click the Tools button and select Start. All the VSs in the vApp will scheduled to start.


Reboot vApp


To reboot a vApp and all the VSs in it:

  1. Go to your Control Panel > Cloud > vApps menu to view all vApps and click the label of the required vApp.

  2. Click the Tools button and select Reboot. All the VSs in the vApp will scheduled to reboot.


Delete vApps


  1. Go to your Control Panel > Cloud > vApps menu to view all vApps.
  2. Click the Actions button next to the required vApp.
  3. If the vApp is running, then choose the Stop action.
  4. When the vApp is stopped, click Delete.

See also: