Schema for the vCloud VApp
0.9
Represents a base type for VAppType and VmType.
none
Reserved. Unimplemented.
false
always
An OVF Section with additional custom attributes.
false
none
Creation date/time of the vApp.
false
1.0
none
True if the virtual machine is deployed.
false
application/vnd.vmware.vcloud.vm
0.9
Represents a virtual machine.
1.0
none
A unique identifier for the virtual machine in
the scope of the vApp.
false
always
OVF environment section.
false
always
Allows you to specify certain capabilities of
this virtual machine.
false
always
A reference to a storage profile to be used
for this object. The specified storage profile
must exist in the organization vDC that
contains the object. If not specified, the
default storage profile for the vDC is used.
false
31.0
33.0
always
A reference to a vdc compute policy. A VM will always belong
to vdc compute policy. The specified vDC compute policy must exist
in organization vDC. If not specified, default vDC compute policy
will be used.
false
VM_SIZING_POLICY
always
A reference to a vdc compute policy. This contains VM's actual
vdc compute policy reference and also optionally an add-on
policy which always defines VM's sizing.
false
VM_SIZING_POLICY
always
This element shows VM's non compliance details against a
given compute policy.
false
33.0
none
True if VM is compliant with the associated compute policies
false
always
Boot options for this virtual machine.
false
RECOMPOSE_BLANK_VM
none
Reference to the media object to insert in a new VM.
false
none
True if VM is encrypted. This is a read-only value.
false
none
True if this virtual machine needs customization.
false
none
True if hardware-assisted CPU virtualization
capabilities in the host should be exposed to the
guest operating system.
false
application/vnd.vmware.vcloud.vm.checkPostGuestCustomizationSection
13.0
Checks the status of if post guest customization script should be checked. Internal Use only.
always
Checks the status of if post guest customization script would be added
false
application/vnd.vmware.vcloud.guestCustomizationStatusSection
13.0
Represents a guest customization status. Internal Use only.
none
Current status of guest customization.
false
A reference to the section in URL format.
Current status of guest customization.
application/vnd.vmware.vcloud.bootOptionsSection
21.0
Allows you to specify boot options for this virtual
machine.
always
Number of milliseconds to wait between powering-on and booting this
virtual machine. Defaults to 0.
Maximum permissible value is 10000 milliseconds.
false
always
Set to true to force this virtual machine to enter BIOS setup mode when rebooted.
This value is reset to false after the next reboot.
false
application/vnd.vmware.vcloud.computePolicySection
VM_SIZING_POLICY
Compute policy details of the VM.
always
VdcComputePolicy that defines VM's placement on a host through
various affinity constraints.
false
always
True indicates that the placement policy cannot be removed from a VM that is
instantiated with it. This value defaults to false.
false
always
VdcComputePolicy that defines VM's sizing and resource allocation.
false
always
True indicates that the sizing policy cannot be removed from a VM that is
instantiated with it. This value defaults to false.
false
application/vnd.vmware.vcloud.computePolicyComplianceSection
VM_SIZING_POLICY
Compute policy compliance details of the VM.
none
Time when last compliance check for this VM for this policy was done.
This is a read-only value.
true
none
Name of the policy whose compliance details are presented here.
This is a read-only value.
true
none
Detailed reason about non-compliance of the VM. This is a read-only value.
true
application/vnd.vmware.vcloud.vmCapabilitiesSection
5.1
Allows you to specify certain capabilities of this virtual
machine.
always
True if the virtual machine supports addition
of memory while powered on.
false
always
True if the virtual machine supports addition
of virtual CPUs while powered on.
false
application/vnd.vmware.vcloud.vApp
0.9
Represents a vApp.
none
vApp owner.
false
none
True if this vApp is automatically created by vCD
when a new VM is discovered in a vCenter Resource Pool
attached to an Organization VDC.
false
True if this vApp is in maintenance mode. Prevents
users from changing vApp metadata.
false
none
Container for virtual machines included in this
vApp.
false
none
Read-only indicator that the OVF descriptor for
this vApp has been uploaded.
false
0.9
Container for virtual machines included in this vApp.
none
Reserved. Unimplemented.
false
none
Rerpresents a virtual machine.
false
application/vnd.vmware.vcloud.rasdItemsList
0.9
Represents a list of RASD items specifying a group of related
DMTF Resource Allocation Setting Data properties of this
virtual machine.
always
An individual RASD item.
false
0.9
Container for ovf:Section_Type elements that specify vApp
configuration on instantiate, compose, or recompose.
always
An ovf:Section_Type element that specifies vApp
configuration on instantiate, compose, or
recompose.
[http://www.vmware.com/vcloud/v1.5] NetworkConnectionSection,
[http://www.vmware.com/vcloud/v1.5] LeaseSettingsSection,
[http://www.vmware.com/vcloud/v1.5] CustomizationSection,
[http://www.vmware.com/vcloud/v1.5] DefaultStorageProfileSection,
[http://www.vmware.com/vcloud/v1.5] SnapshotSection,
[http://www.vmware.com/vcloud/v1.5] NetworkConfigSection,
[http://www.vmware.com/vcloud/v1.5] GuestCustomizationSection,
[http://www.vmware.com/vcloud/v1.5] ProductSection
false
0.9
Represents a vApp network configuration.
always
Optional description.
false
always
Represents a vApp network configuration.
true
none
True if this network has been deployed.
false
always
The name of the vApp network.
true
application/vnd.vmware.vcloud.networkConfigSection
0.9
Container for vApp networks.
none
Optional link to an entity or operation
associated with this section.
false
always
Represents the the configuration of a vApp
network.
false
none
A reference to the section in URL format.
false
none
The MIME type of the section.
false
application/vnd.vmware.vcloud.leaseSettingsSection
0.9
Represents vApp lease settings.
none
Optional link to an entity or operation
associated with this section.
false
always
Deployment lease in seconds.
false
always
Storage lease in seconds.
false
none
Expiration date/time of deployment lease.
false
none
Expiration date/time of storage lease.
false
none
A reference to the section in URL format.
false
none
The MIME type of the section.
false
0.9
Represents a network connection in the virtual machine.
always
Virtual slot number associated with this NIC.
First slot number is 0.
true
always
IP address assigned to this NIC.
false
Type of the IP address assigned to this NIC.
false
always
Secondary IP address associated with this NIC.
Type of the secondary IP address assigned to this NIC. This will be populated with 'IPv6'
for dual stack networks, even if there is no secondary IP.
false
none
If the network to which this NIC connects
provides NAT services, the external address
assigned to this NIC appears here.
false
always
If the virtual machine is undeployed, this value specifies
whether the NIC should be connected upon
deployment. If the virtual machine is deployed, this value
reports the current status of this NIC's
connection, and can be updated to change that
connection status.
true
always
MAC address associated with the NIC.
false
always
IP address allocation mode for this connection.
One of:
POOL (A static IP address is allocated
automatically from a pool of addresses.),
DHCP (The IP address is obtained from a DHCP
service.),
MANUAL (The IP address is assigned manually in
the IpAddress element.),
NONE (No IP addressing mode specified.)
true
always
Secondary IP address allocation mode for the secondary IP address associated with this connection.
One of:
POOL (A static IP address is allocated
automatically from a pool of addresses.),
DHCP (The IP address is obtained from a DHCP
service.),
MANUAL (The IP address is assigned manually in
the IpAddress element.),
NONE (No IP addressing mode specified.)
always
Type of network adapter to be used for this connection.
One of:<br>
<b>VLANCE (emulated version of the AMD 79C970 PCnet32-LANCE NIC)</b><br>
<b>E1000 (emulated version of the Intel 82545EM Gigabit Ethernet NIC)</b><br>
<b>E1000E (emulates a newer model of Intel Gigabit NIC (number 82574))</b><br>
<b>VMXNET (has no physical counterpart; optimized for performance in a virtual machine)</b><br>
<b>VMXNET2 (based on the VMXNET adapter but provides some high-performance features)</b><br>
<b>VMXNET3 (next generation of a paravirtualized NIC designed for performance; not related to VMXNET or VMXNET2)</b><br>
<b>FLEXIBLE (identifies itself as a Vlance adapter when a virtual machine boots, but initializes itself and functions as either a Vlance or a VMXNET adapter, depending on which driver initializes it)</b><br>
<b>SRIOVETHERNETCARD (Single Root I/O Virtualization virtual NIC, see https://kb.vmware.com/s/article/2038739)</b><br>
false
always
Name of the network to which this NIC is connected.
true
none
True if this NIC needs customization.
false
CREATE_BLANK_VM
Describes virtualCpu type of VM.
VM32 -- for VMs which do not support longMode;
VM64 -- for VMs which support longMode.
CREATE_BLANK_VM
Represents media supported by VM. This can be an ISO image and/or floppy.
CREATE_BLANK_VM
Describes the possible configuration states of a media device. One of:<br>
DISCONNECTED --
The media device is disconnected, i.e., it isn't configured to provide access
to any local or remote media<br>
SERVER --
The media device is configured to use a media file made available
on the cell side.<br>
REMOTE --
The media device is configured as a client side device through
the VM console.
CREATE_BLANK_VM
Describes a media in a VM device and what media is attached to it.
none
Describes the media device whose media mount is being specified here.
This deviceId must match the RASD.InstanceID attribute in the
VirtualHardwareSection of the vApp's OVF description.
false
none
The media image that is mounted onto the device.
This property can be 'null' which represents that no media is mounted on
the device.
false
none
Specified the type of media that is mounted onto the device.
false
none
Specifies the state of the media device.
false
always
The device number on the controller of the media device.
true
always
The bus number of the media device controller.
true
none
The type of controller, e.g. IDE vs SCSI and if SCSI bus-logic vs LSI
logic.
false
CREATE_BLANK_VM
A description of a virtual disk of a VM.
always
Specifies a unique identifier for this disk in the scope of the
corresponding VM.
This element is optional when creating a VM, but if it is provided
it should be unique.
This element is mandatory when updating an existing disk.
false
always
The size of the disk in MB.
true
always
The device number on the SCSI or IDE controller of the disk.
true
always
The number of the SCSI or IDE controller itself.
true
always
The type of disk controller, e.g. IDE vs SCSI and if SCSI bus-logic vs LSI
logic.
true
always
Specifies whether the disk storage is pre-allocated or allocated
on demand.
false
always
Specifies reference to a named disk.
false
always
Specifies reference to a storage profile to be associated with the disk.
false
always
Specifies that the disk storage profile overrides the VM's default
storage profile.
false
always
Specifies the IOPS for the disk.
false
none
The units in which VirtualQuantity is measured.
false
none
The actual size of the disk.
false
34.0
none
True if the disk can be grown. This is a read-only value.
false
34.0
none
True if the disk is encrypted. This is a read-only value.
false
35.0
36.0
none
True if the disk is shareable. This is a read-only value.
This attribute is deprecated; use sharingType instead.
false
36.0
none
Sharing type of the disk. This attribute is immutable.
This attribute can only have values defined by DiskSharingType.
false
36.0
Sharing type of named disks.
CREATE_BLANK_VM
Allocation level for how much of a resource can be consumed by the
underlying virtualization infrastructure. These levels map to a
pre-determined set of numeric values for shares. Custom shares can be
specified by using ResourceShareLevel as Custom.
CREATE_BLANK_VM
The section of the VM representation that has to do with the VM's media
devices (floppies and CDROM)
always
Describes a media in a VM device and what media is attached to it.
true
CREATE_BLANK_VM
The section of the VM representation that has to do with the VM's disks.
always
A description of a virtual disk of a VM.
true
CREATE_BLANK_VM
Stores the configured value, reservation, shares and limit for compute
resources such CPU and Memory for a virtualized workload.
always
The amount of resource configured on the virtual machine.
true
always
The amount of reservation of this resource on the underlying
virtualization infrastructure.
false
always
The limit for how much of this resource can be consumed on the
underlying virtualization infrastructure. This is only valid when
the resource allocation is not unlimited.
false
always
Pre-determined relative priorities according to which the
non-reserved portion of this resource is made available to the
virtualized workload.
false
always
Custom priority for the resource. This is a read-only, unless the
share level is CUSTOM.
false
DYNAMIC_HW_VERSION_SUPPORT
Represents a supported virtual hardware version.
always
DYNAMIC_HW_VERSION_SUPPORT
The URI of the entity.
false
always
Contains the type of the the entity.
false
application/vnd.vmware.vcloud.simpleVirtualHardwareSection
CREATE_BLANK_VM
Container for the specification of this virtual machine.
This is an alternate to using ovf:VirtualHardwareSection + ovf:OperatingSystemSection
always
The type of the OS.
This parameter may be omitted when using the VmSpec to update the contents
of an existing VM.
false
always
Number of CPUs.
This parameter may be omitted when using the VmSpec to update the contents
of an existing VM.
false
always
Number of cores among which to distribute CPUs in this virtual machine..
This parameter may be omitted when using the VmSpec to update the contents
of an existing VM.
false
always
CPU compute resources.
This parameter may be omitted when using the VmSpec to update the contents
of an existing VM.
false
always
Memory compute resources.
This parameter may be omitted when using the VmSpec to update the contents
of an existing VM.
true
always
The media devices of this VM.
false
always
virtual disks of this VM.
false
always
vSphere name of Virtual Hardware Version of this VM. Example: vmx-13
This parameter may be omitted when using the VmSpec to update the contents
of an existing VM.
true
none
VMware tools version of this VM.
false
none
The tools guest os identifier of a VM when VM is powered on and has VM
Tools installed on it.
false
always
The capabilities settings for this VM.
This parameter may be omitted when using the VmSpec to update the contents
of an existing VM.
false
always
Synchronize the VM's time with the host.
false
always
True indicates that this section overrides any possible VirtualHardware
and OperatingSystem sections during a PUT or POST action.
false
application/vnd.vmware.vcloud.networkConnectionSection
0.9
Container for the network connections of this virtual machine.
always
Virtual slot number associated with the NIC
that should be considered this virtual machine's
primary network connection. Defaults to slot 0.
false
always
Represents a network connection in the virtual
machine.
false
none
A link to an operation on this section.
false
none
A reference to the section in URL format.
false
none
The MIME type of the section.
false
application/vnd.vmware.vcloud.runtimeInfoSection
1.5
VMware Tools and other runtime information for
this virtual machine.
VMware Tools information for this virtual machine.
false
none
The version of VMmware tools installed
on this virtual machine.
application/vnd.vmware.vcloud.guestCustomizationSection
1.0
Represents a guest customization settings.
always
True if guest customization is enabled.
false
always
True if customization can change the Windows
SID of this virtual machine.
false
none
Virtual machine ID to apply.
false
always
True if this virtual machine can join a Windows
Domain.
false
always
True if customization should use organization
settings (OrgGuestPersonalizationSettings)
when joining a Windows Domain.
false
always
The name of the Windows Domain to join.
false
always
User name to specify when joining a Windows
Domain.
false
always
Password to use with DomainUserName.
false
always
The name of the Windows Domain Organizational
Unit (OU) in which the computer account for this
virtual machine will be created.
false
always
True if guest customization can modify
administrator password settings for this
virtual machine.
false
always
True if the administrator password for this
virtual machine should be automatically
generated.
false
always
True if the administrator password for this
virtual machine should be set to this string.
(AdminPasswordAuto must be false.)
false
always
True if guest administrator should automatically
log into this virtual machine.
false
always
Number of times administrator can automatically
log into this virtual machine.
In case AdminAutoLogon is set to True, this
value should be between 1 and 100. Otherwise, it
should be 0.
false
always
True if the administrator password for this
virtual machine must be reset after first use.
false
always
Script to run on guest customization. The
entire script must appear in this element.
Use the XML entity &#13; to represent
a newline. Unicode characters can be
represented in the form &#xxxx; where
xxxx is the character number.
false
always
Computer name to assign to this virtual
machine.
false
none
A link to an operation on this section.
false
none
A reference to the section in URL format.
false
none
The MIME type of the section.
false
application/vnd.vmware.vcloud.snapshot
5.1
Represents a virtual machine snapshot.
none
True if the virtual machine was powered on when the
snapshot was created.
true
none
Creation date/time of the snapshot.
true
none
Size of the snapshot.
true
application/vnd.vmware.vcloud.snapshotSection
5.1
Represents information about vApp and virtual machine
snapshots.
5.1
none
A link to the section.
false
5.1
none
Information about a snapshot.
false
5.1
none
A reference to the section in URL format.
false
5.1
none
The MIME type of the section.
false
0.9
Maps a network name specified in a Vm to the network name of a
vApp network defined in the VApp that contains the Vm
always
Name of the network as specified in the Vm.
true
always
Name of the vApp network to map to.
true
0.9
always
True confirms acceptance of all EULAs in a vApp template.
Instantiation fails if this element is missing, empty, or set to
false and one or more EulaSection elements are present.
0.9
Represents vApp creation parameters.
always
Reserved. Unimplemented.
false
always
Instantiation parameters for the composed vApp.
false
always
True if the vApp should be deployed at
instantiation. Defaults to true.
false
always
True if the vApp should be powered-on
at instantiation. Defaults to true.
false
0.9
Represents a vApp, vApp template or Vm to include in a
composed vApp.
always
A reference to a source object.
One of:<br>
vApp<br>
vAppTemplate<br>
Vm<br>
Vms must be powered off and cannot have an
independent disk attached.
true
5.6
always
Specify name, description, and other
properties of a VM during instantiation.
false
1.0
always
If Source references a Vm, this value
provides a unique identifier for the Vm
in the scope of the composed vApp.
false
always
If Source references a Vm this can
include any of the following OVF
sections:<br>
VirtualHardwareSection<br>
OperatingSystemSection<br>
NetworkConnectionSection<br>
GuestCustomizationSection.
false
always
If Source references a Vm, this element
maps a network name specified in the Vm
to the network name of a vApp network
defined in the composed vApp.
false
always
If Source references a Vm, this element
contains a reference to a storage
profile to be used for the Vm. The
specified storage profile must exist in
the organization vDC that contains the
composed vApp. If not specified, the
default storage profile for the vDC is
used.
false
31.0
always
33.0
A reference to a vdc compute policy. A VM will always belong
to vdc compute policy. The specified vDC compute policy must exist
in organization vDC. If not specified, default vDC compute policy
will be used.
false
VM_SIZING_POLICY
always
A reference to a vdc compute policy. This contains VM's actual
vdc compute policy reference and also optionally an add-on
policy which always defines VM's sizing.
false
5.6
always
Locality parameters provide a hint that may help
optimize placement of a VM and an independent a Disk so
that the VM can make efficient use of
the disk.
See <a href="http://kb.vmware.com/kb/2105352">KB 2105352</a>.
false
5.6
always
If Source references a Vm, this element
describes the capabilities (hot swap, etc.)
the instantiated VM should have.
false
1.0
always
True if the source item should be deleted after
composition is complete.
false
INSTANTIATE_VM_TEMPLATE
Represents an existing VM template from a Catalog.
always
A reference to an existing VM template.
true
INSTANTIATE_VM_TEMPLATE
always
Specify name, description, and other
properties of a VM during instantiation.
false
always
This can include any of the following OVF
sections and more:<br>
NetworkConnectionSection<br>
LeaseSettingsSection<br>
GuestCustomizationSection.
false
INSTANTIATE_VM_TEMPLATE
always
A reference to a storage
profile to be used for the Vm. The
specified storage profile must exist in
the organization vDC that contains the
composed vApp. If not specified, the
default storage profile for the vDC is
used.
false
INSTANTIATE_VM_TEMPLATE
always
Locality parameters provide a hint that
may help optimize placement of a VM and
an independent a Disk so that the VM can
make efficient use of the disk.
See <a
href="http://kb.vmware.com/kb/2105352">KB
2105352</a>.
false
INSTANTIATE_VM_TEMPLATE
always
Describes the capabilities (hot swap,
etc.) the instantiated VM should have.
false
application/vnd.vmware.vcloud.instantiateVmTemplateParams
INSTANTIATE_VM_TEMPLATE
Represents VM template instantiation parameters.
INSTANTIATE_VM_TEMPLATE
always
Represents virtual machine instantiation
parameters.
false
always
True confirms acceptance of all EULAs in
a vApp template. Instantiation fails if
this element is missing, empty, or set
to false and one or more EulaSection
elements are present.
false
VM_SIZING_POLICY
always
A reference to a vdc compute policy. This contains VM's actual
vdc compute policy reference and also optionally an add-on
policy which always defines VM's sizing.
false
always
True if the VM should be powered-on
at instantiation. Defaults to false.
false
5.6
A set of overrides to source VM properties to apply to target VM during copying.
5.6
always
Name of VM
false
5.6
always
VM description
false
5.6
always
True if this VM needs guest customization
false
True if BIOS UUID of the virtual machine should be regenerated so that it is
unique, and not the same as the source virtual machine's BIOS UUID.
REGENERATE_BIOS_UUID
always
false
application/vnd.vmware.vcloud.composeVAppParams
0.9
Represents vApp composition parameters.
always
Composition item. One of:<br>
vApp<br>
vAppTemplate<br>
Vm<br>
Vms must be powered off and cannot have an
independent disk attached.
false
RECOMPOSE_BLANK_VM
none
Read-only information about a VM added during vApp
composition or recomposition.
false
always
True confirms acceptance of all EULAs in a
vApp template. Instantiation fails if this
element is missing, empty, or set to false
and one or more EulaSection elements are
present.
false
always
Reserved. Unimplemented.
false
application/vnd.vmware.vcloud.CreateVmParams
CREATE_BLANK_VM
Represents VM creation parameters.
none
Read-only information about the Vm to
create.
This information appears in the Task
returned by a createVm request.
false
none
Reference to the media object to insert in the new VM.
false
none
True if the VM should be powered-on
after creation. Defaults to false.
false
application/vnd.vmware.vcloud.recomposeVAppParams
1.0
Parameters for a recompose vApp request.
always
Reference to a Vm to be deleted during recomposition.
false
always
Existing Vm to be reconfigured during recomposition.
false
application/vnd.vmware.admin.registerVAppParams
5.5
Represents vApp registration parameters.
always
Embedded OVF. Must be embedded as CDATA.
confirm
always
Map from OVF Virtual Systems via the BIOS UUID to the datastore location of the replicated
VM's files on the destination site.
confirm
always
Maps from OVF to site specific networks.
confirm
always
Maps source site external NAT IP addresses to destination site
external NAT IP addresses.
confirm
always
VM's with NICs that are connected directly to a VDC network and
where the NICs have manually assigned IP addresses needs to be
mapped to a valid IP address within the IP range of the destination
site's VDC network.
This element provides that mapping.
confirm
application/vnd.vmware.vcloud.vsToVmxMapType
always
Map from OVF Virtual Systems via the BIOS UUID to the datastore location of
the replicated VM's files on the destination site.
confirm
always
VM BIOS UUID as described in the OVF Virtual System
always
Datastore path of replicated VM's vmx file.
always
Destination storage profile to associate with VM. This must be a
valid profile for the given datastore path.
application/vnd.vmware.vcloud.ovfToVdcNetworkMapType
always
Map from OVF to Org networks.
confirm
always
OVF network name.
always
Name of organization network.
application/vnd.vmware.vcloud.externalNatIpMapType
always
Maps source site external NAT IP addresses to destination site
external NAT IP addresses.
confirm
always
External NAT IP address on source site.
always
External NAT IP address on destination site.
application/vnd.vmware.vcloud.nicIpMapType
always
VM's with NICs that are connected directly to a VDC network and where the NICs
have manually assigned IP addresses needs to be mapped to a valid IP address
within the IP range of the destination site's VDC network.
This type provides that mapping.
confirm
always
Source site NIC IP address.
always
Destination site NIC IP address.
5.1
Locality parameters provide a hint that may help optimize
placement of a VM with respect to another VM or an independent
disk.
See <a href="http://kb.vmware.com/kb/2105352">KB 2105352</a>.
always
Reference to a Disk, or a VM.
false
5.1
5.6
API_VERSION_POST9_1_UPDATE
Represents instantiation parameters. Deprecated in favor of
SourcedCompositionItemParamType
always
A reference to a source Vm.
true
always
A reference to a storage profile to be used for
this object. The specified storage profile must
exist in the organization vDC that contains the
object. If not specified, the default storage
profile for the vDC is used.
false
always
Locality parameters provide a hint that may
help optimize placement of a VM with respect to
another VM or an independent disk.
See <a href="http://kb.vmware.com/kb/2105352">KB 2105352</a>.
false
Specification of common hardware parameters that
should be applied to the VM upon instantiation. This only applies when
instantiating a vApp template and is otherwise ignored.
5.5
always
false
0.9
Represents vApp instantiation parameters.
always
A reference to a source object.
One of:<br>
vApp<br>
vAppTemplate<br>
Vm<br>
Vms must be powered off and cannot have an
independent disk attached.
true
1.0
always
Set to true to delete the source object after
the operation completes.
false
5.6
always
Represents virtual machine instantiation parameters.
false
API_VERSION_POST9_1_UPDATE
5.6
always
Represents VM instantiation parameters. If this section
is present, then SourcedVmInstantiationParamsType section (if present)
will be ignored.
false
always
Reserved. Unimplemented.
false
application/vnd.vmware.vcloud.instantiateVAppTemplateParams
0.9
Represents vApp template instantiation parameters.
always
True confirms acceptance of all EULAs in a
vApp template. Instantiation fails if this
element is missing, empty, or set to false
and one or more EulaSection elements are
present.
false
application/vnd.vmware.vcloud.instantiateOvfParams
Represents vApp instantiation from OVF parameters
always
True confirms acceptance of all EULAs in an
OVF. Instantiation fails if this element is
missing, empty, or set to false and one or
more EulaSection elements are present.
false
always
If true, remove elements in the uploaded descriptor if they
are not defined in the OVF XML namespace
(http://schemas.dmtf.org/ovf/envelope/1). Default is false.
false
A mapping from an OVF network name to a vCloud network name.
Used to update network properties in the OVF.
false
5.5
always
A mapping from OVF properties to instantiation values.
false
5.5
always
Instantiation parameters for the VMs in the vApp.
false
5.5
always
false
application/vnd.vmware.vcloud.networkMapping
Represents a mapping from an OVF source network to a vCloud target network.
Used to update network properties in the OVF.
5.5
The name of an OVF network.
5.5
always
The name of a vCloud network.
5.5
always
application/vnd.vmware.vcloud.instantiateOvfProperty
Represents an OVF property value assignment.
5.5
The class ID of the product section to which the property belongs.
false
5.5
always
The instance ID of the product section to which the property belongs.
false
5.5
always
The key of the OVF property.
5.5
always
The value to assign to the OVF property.
5.5
always
application/vnd.vmware.vcloud.instantiateVmParams
Instantiation parameters for a VM in a vApp.
5.5
Network connection configuration for a VM.
false
5.5
always
Represents the computer name that is part of guest customization.
false
5.5
always
The VDC storage profile to use. If set, the value must refer to an
existing and enabled storage profile on the VDC.
false
5.5
always
Specification of common virtual machine hardware parameters. This is
a simple way to customize hardware settings without modifying
the source OVF descriptor before uploading it.
5.5
always
false
always
The ovf:id of the VirtualSystem in the source OVF that the instantiation
parameters apply to.
5.5
true
application/vnd.vmware.vcloud.instantiateVmHardwareCustomizationParams
Hardware parameter customization applied to a virtual machine in a vApp when instantiated.
5.5
The number of vCPUs configured for the virtual machine. Note that
if CoresPerSocket is specified in the OVF or included in the
customization parameters then the number of CPUs must be evenly
divisible by the number of cores per socket. The minimum value is 1.
5.5
always
false
Specifies the distribution of the total number of CPUs over a number
of virtual sockets. The number of vCPUs must be evenly divisible by
the number of cores per socket. The minimum value is 1.
5.5
always
false
The amount of virtual machine memory in megabytes. Must be a
multiple of four. Minimum size is four megabytes.
5.5
always
false
Parameters of a single disk in the virtual machine.
5.5
always
false
Size of the disk in megabytes. Minimum size is
four megabytes. Note that disk size cannot be
reduced during instantiation.
5.5
always
false
always
Identifies a specific disk of the virtual machine.
This must match the InstanceId in the disk RASD
element.
5.5
true
application/vnd.vmware.vcloud.cloneVAppParams
0.9
Parameters for a clonevApp request.
application/vnd.vmware.vcloud.moveVAppParams
34.0
Parameters for a MoveVApp request.
always
A reference to a source vApp that will be moved.
true
always
An ovf:Section_Type element that specifies vApp
configuration on instantiate, compose, or
recompose.
[http://www.vmware.com/vcloud/v1.5] NetworkConfigSection
false
always
Represents VM instantiation parameters of the VMs in the source vApp.
SourceDelete is always ignored in the Move vApp context.
false
application/vnd.vmware.vcloud.deployVAppParams
0.9
Parameters to a deploy vApp request.
always
Used to specify whether to power on vapp on deployment,
if not set default value is true.
false
always
Lease in seconds for deployment. A value of 0 is
replaced by the organization default
deploymentLeaseSeconds value.
false
Used to specify whether to force customization on deployment,
if not set default value is false.
false
application/vnd.vmware.vcloud.undeployVAppParams
0.9
Parameters to an undeploy vApp request.
1.5
always
The specified action is applied to all virtual machines in
the vApp. All values other than <b>default</b>
ignore actions, order, and delay specified in
the StartupSection. One of:<br>
<b>powerOff</b> (Power off the virtual machines. This is the default
action if this attribute is missing or empty)<br>
<b>suspend</b> (Suspend the virtual machines)<br>
<b>shutdown</b> (Shut down the virtual machines)<br>
<b>force</b> (Attempt to power off the virtual machines. Failures
in undeploying the virtual machine or associated networks
are ignored. All references to the vApp and its
virtual machines are removed from the database)<br>
<b>default</b> (Use the actions, order, and delay
specified in the StartupSection).
false
application/vnd.vmware.vcloud.mediaInsertOrEjectParams
0.9
Parameters for an insertMedia or ejectMedia request.
always
Reference to the media object to insert or eject.
In API requests that specify version 29.0 or higher, this element
is optional when ejecting the media.
true
application/vnd.vmware.vcloud.captureVAppParams
0.9
Parameters for a captureVapp request.
always
Contains a reference to the vApp to capture.
true
always
Params to customize template VM during capture
false
always
An ovf:Section to configure the vAppTemplate.
false
5.5
always
A reference to the storage profile to be
specified in the vApp template created by this
capture. Ignored by vCloud Director 5.5 and later.
false
API_VERSION_POST9_1_UPDATE
5.5
always
To overwrite an existing vApp template with the one created by this
capture, place a reference to the existing template here. Otherwise,
the operation creates a new vApp template.
false
application/vnd.vmware.vcloud.captureVmParams
0.9
Parameters for a VM which is being captured.
31.0
always
A reference to VM being captured.
true
31.0
always
33.0
A reference to a vdc compute policy for template VM. During instantiation
this vdc compute policy should be present in destination vDC.
false
application/vnd.vmware.vcloud.vmPendingQuestion
0.9
Represents a question posted by a virtual machine that is
WAITING_FOR_INPUT (status="5").
none
Question text.
true
always
Question ID of this question.
true
always
Choices of answers to the question.
true
application/vnd.vmware.vcloud.vmPendingAnswer
0.9
Represents the answer to a question posted by a virtual machine that is
WAITING_FOR_INPUT (status="5").
always
Choice ID of this answer.
true
always
Question ID of the question.
true
0.9
Represents the answer to a question posted by a virtual machine that is
WAITING_FOR_INPUT (status="5").
none
Choice ID of the answer.
true
none
Answer text.
false
application/vnd.vmware.vcloud.relocateVmParams
1.5
Parameters to be used for virtual machine relocation.
always
Reference to destination datastore.
true
application/vnd.vmware.vcloud.createSnapshotParams
5.1
Parameters for a createSnapshot request.
always
True if the snapshot should include the virtual
machine's memory.
false
always
True if the file system of the virtual machine
should be quiesced before the snapshot is created.
false
application/vnd.vmware.vm.complianceResult
5.1
Represents the results of a
GET /vApp/vm-{id}/complianceResult
request. Empty if such a request has never been made.
none
The compliance status for the entity.
true
none
A descriptive message detailing the compliance result.
false
none
The date/time when the compliance check was run.
false
5.1
Name of the storage profile that will be specified for this
virtual machine. The named storage profile must exist
in the organization vDC that contains the virtual machine. If
not specified, the default storage profile for the vDC is used.
5.1
Name of the storage profile that will be
specified for this virtual machine. The named
storage profile must exist in the organization
vDC that contains the virtual machine. If not
specified, the default storage profile for the
vDC is used.
false