Skip to main content
Version: 2024.1

vCenter VM From Image Deployment Path Attributes

The following attributes would be used to define the vCenter VM From Image:

AttributevCenter shell versionDescription
Cloud ProviderAllName of the vCenter cloud provider resource to be used
vCenter ImageAll

Full path to the vCenter OVF image file, relative to the datacenter. For example: My-OVF-Images/Image.ovf

note

Path must be accessible to all execution servers. OVF tool must be installed on all execution servers.

vCenter NameAllName of the vCenter resource to be used
vCenter Image ArgumentsAll

(Optional) vCenter-specific arguments to use when deploying the virtual machine.

Example for OVF:

--allowExtraConfig --prop:Hostname=ASAvtest --prop:HARole=Standalone --prop:SSHEnable=True --prop:DHCP=True --net:Management0-0='Office LAN 41' --net:GigabitEthernet0-0='VLAN_access_101'

Behavior During SaveAll

(Applies to the Save and Restore paid add-on) The VM's state while the sandbox is being saved. Options are Remain Powered On and Power Off.

  • Inherit: (Default) Uses the setting defined on the vCenter cloud provider resource
  • Remain Powered On: The VM will remain powered on during the saving state.
  • Power Off: If the VM was powered on before the sandbox entered the saving state, the VM will shut down (power off) for the duration of the save.
Notes
  • The value configured here overrides the configuration in the vCenter cloud provider resource, see Add VMware vCenter Cloud Provider Resource.
  • After save has ended, the VM returns to its state prior to saving, regardless of the behavior during the save.
Saved Sandbox StorageAll

(Applies to the Save and Restore paid add-on) During the saving process, CloudShell creates a clone of the sandbox's App VMs in this vCenter storage, which CloudShell will later use to restore the VM when the user restores the saved sandbox. See Save a Sandbox for more information.

For storage purposes, these VM clones can be stored in a different data storage than the one configured in the VM Storage attribute defined on the vCenter cloud provider resource. The storage can be either a datastore or a datastore cluster. For example: datastore1 or clustername/datastore1.

note

The value configured here overrides the configuration in the vCenter cloud provider resource, see Add VMware vCenter Cloud Provider Resource.

Customization Spec2nd Gen onlyName of the vSphere VM Customization Specification to apply to the App's VM.
Hostname2nd Gen only

(Only applies to Windows and Linux VMs) The hostname to set on the VM.

note

If Customization Spec is specified, the value specified in the Hostname attribute will be used. If Customization Spec is not specified, a new one will be created for the VM. For Windows VMs, make sure to specify a password in the App resource page

Private IP2nd Gen only

(Only applies to Windows and Linux VMs) The private static IP to set on the first vNIC of the VM. If there's a default gateway, specify it after the private IP. For example: "192.168.4.124:80.114.1.87" where 80.114.1.87 is the default gateway

Notes
  • If there is no gateway, the .1 IP of the same subnet will be used as the gateway. So, for private IP "192.168.4.124", gateway "192.168.4.1" will be used.
  • It is also possible to provide a subnet mask here. For example: "192.168.4.124/24:80.114.1.87"
  • If Customization Spec is specified, the value specified in the Private IP attribute will be used.
  • If Customization Spec is not specified, a new one will be created for the VM. For Windows VMs, make sure to specify a Password in the App resource page.
  • If Customization Spec is specified, the value specified in the Private IP attribute will be used. If Customization Spec is not specified, a new one will be created for the VM. For Windows VMs, make sure to specify a Password in the App resource page.
CPU2nd Gen onlyNumber of CPU core s to configure on the VM.
RAM2nd Gen onlyAmount of RAM (GB) to configure on the VM.
HDD2nd Gen onlyAllows to add/edit hard disk size to the VM. The syntax is semi-colon separated disk pairs 'Hard Disk Label: Disk Size (GB)'. For example: 'Hard Disk 1:100;Hard Disk 2:200'. Short-hand format is also valid: '1:100;2:200'.