VMware Cloud Director API - CloneVAppParams

VMware Cloud Director API - CloneVAppParams

CloneVAppParamsType

Element:
CloneVAppParams
Type:
CloneVAppParamsType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Parameters for a clonevApp request.
Since:
0.9
Schema:
vApp.xsd
Media type(s):
application/vnd.vmware.vcloud.cloneVAppParams+xml
application/vnd.vmware.vcloud.cloneVAppParams+json
Extends:
InstantiateVAppParamsType
XML Representation:
<CloneVAppParams 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>
    </SourcedItem>
</CloneVAppParams>

Attributes

Attribute Type Required Modifiable Since Deprecated 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 Deprecated Description
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/cloneVApp Create a copy of a vApp. 0.9