VMware Cloud Director API - InstantiateVmTemplateParams

InstantiateVmTemplateParamsType

Element:

InstantiateVmTemplateParams

Type:

Namespace:

http://www.vmware.com/vcloud/v1.5

Description:

Represents VM template instantiation parameters.

Since:

32.0

Schema:

vApp.xsd

Media type(s):

application/vnd.vmware.vcloud.instantiateVmTemplateParams+json
application/vnd.vmware.vcloud.instantiateVmTemplateParams+xml

Extends:

ParamsType

XML Representation:

<InstantiateVmTemplateParams xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1" name="xs:string" powerOn="xs:boolean">
    <Description> xs:string </Description>
    <SourcedVmTemplateItem>
        <Source href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        <VmGeneralParams>
            <Name> xs:string </Name>
            <Description> xs:string </Description>
            <NeedsCustomization> xs:boolean </NeedsCustomization>
            <RegenerateBiosUuid> xs:boolean </RegenerateBiosUuid>
        </VmGeneralParams>
        <VmTemplateInstantiationParams>
            <ovf:Section> ovf:Section_Type </ovf:Section>
        </VmTemplateInstantiationParams>
        <StorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        <LocalityParams>
            <ResourceEntity href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        </LocalityParams>
        <VmCapabilities href="xs:anyURI" type="xs:string">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string" model="xs:string"/>
            <MemoryHotAddEnabled> xs:boolean </MemoryHotAddEnabled>
            <CpuHotAddEnabled> xs:boolean </CpuHotAddEnabled>
        </VmCapabilities>
    </SourcedVmTemplateItem>
    <AllEULAsAccepted> xs:boolean </AllEULAsAccepted>
    <ComputePolicy href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string" model="xs:string"/>
        <VmPlacementPolicy href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        <VmPlacementPolicyFinal> xs:boolean </VmPlacementPolicyFinal>
        <VmSizingPolicy href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        <VmSizingPolicyFinal> xs:boolean </VmSizingPolicyFinal>
    </ComputePolicy>
</InstantiateVmTemplateParams>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
name	string	No	always	32.0		Typically used to name or identify the subject of the request. For example, the name of the object being created or modified.
powerOn	boolean	No	always	32.0		True if the VM should be powered-on at instantiation. Defaults to false.

Elements

Element	Type	Required	Modifiable	Since	Description
AllEULAsAccepted	boolean	No	always	0.9	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.
ComputePolicy	ComputePolicyType	No	always	33.0	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.
Description	string	No	always	32.0	Optional description.
SourcedVmTemplateItem	SourcedVmTemplateParamsType	No	always	32.0	Represents virtual machine instantiation parameters.
VCloudExtension	VCloudExtensionType	No	always	32.0	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Operations

CRUD	Operation	Description	Since	Deprecated
as input	POST /vdc/{id}/action/instantiateVmFromTemplate	Create a auto natured vApp from a VM template.	32.0