VMware Cloud Director API - InstantiateVAppTemplateParams

InstantiateVAppTemplateParamsType

Element:

InstantiateVAppTemplateParams

Type:

Namespace:

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

Description:

Represents vApp template instantiation parameters.

Since:

0.9

Schema:

vApp.xsd

Media type(s):

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

Extends:

InstantiateVAppParamsType

XML Representation:

<InstantiateVAppTemplateParams xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1" name="xs:string" deploy="xs:boolean" powerOn="xs:boolean" linkedClone="xs:boolean">
    <Description> xs:string </Description>
    <VAppParent href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <InstantiationParams>
        <ovf:Section> ovf:Section_Type </ovf:Section>
    </InstantiationParams>
    <Source href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <IsSourceDelete> xs:boolean </IsSourceDelete>
    <SourcedItem sourceDelete="xs:boolean">
        <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>
        <VAppScopedLocalId> xs:string </VAppScopedLocalId>
        <InstantiationParams>
            <ovf:Section> ovf:Section_Type </ovf:Section>
        </InstantiationParams>
        <NetworkAssignment innerNetwork="xs:string" containerNetwork="xs:string"/>
        <StorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        <VdcComputePolicy href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        <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>
        <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>
        <ReplaceTpm> xs:boolean </ReplaceTpm>
    </SourcedItem>
    <AllEULAsAccepted> xs:boolean </AllEULAsAccepted>
</InstantiateVAppTemplateParams>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
name	string	No	always	0.9	Typically used to name or identify the subject of the request. For example, the name of the object being created or modified.
deploy	boolean	No	always	0.9	True if the vApp should be deployed at instantiation. Defaults to true.
powerOn	boolean	No	always	0.9	True if the vApp should be powered-on at instantiation. Defaults to true.
linkedClone	boolean	No	always	0.9	Reserved. Unimplemented.

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.
Description	string	No	always	0.9	Optional description.
InstantiationParams	InstantiationParamsType	No	always	0.9	Instantiation parameters for the composed vApp.
IsSourceDelete	boolean	No	always	1.0	Set to true to delete the source object after the operation completes.
Source	ReferenceType	Yes	always	0.9	A reference to a source object. One of: vApp vAppTemplate Vm Vms must be powered off and cannot have an independent disk attached.
SourcedItem	SourcedCompositionItemParamType	No	always	5.6	Represents VM instantiation parameters. If this section is present, then SourcedVmInstantiationParamsType section (if present) will be ignored.
VAppParent	ReferenceType	No	always	0.9	Reserved. Unimplemented.
VCloudExtension	VCloudExtensionType	No	always	0.9	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/instantiateVAppTemplate	Create a vApp from a vApp template	0.9