RecomposeVAppParamsType

Element:
RecomposeVAppParams
Type:
RecomposeVAppParamsType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Parameters for a recompose vApp request.
Since:
1.0
Schema:
vApp.xsd
Media type(s):
application/vnd.vmware.vcloud.recomposeVAppParams+xml
Extends:
ComposeVAppParamsType
XML Representation:
<RecomposeVAppParams xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
        xmlns:environment_1="http://schemas.dmtf.org/ovf/environment/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>
    <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>
        </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"/>
        <LocalityParams>
            <ResourceEntity href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        </LocalityParams>
    </SourcedItem>
    <AllEULAsAccepted> xs:boolean </AllEULAsAccepted>
    <CreateItem href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
            name="xs:string" status="xs:int" deployed="xs:boolean" needsCustomization="xs:boolean"
            nestedHypervisorEnabled="xs:boolean">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <Description> xs:string </Description>
        <Tasks>
            <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                    name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                    serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                    cancelRequested="xs:boolean">
                <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                        rel="xs:string"/>
                <Description> xs:string </Description>
                <Tasks> TasksInProgressType </Tasks>
                <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                <Error message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"
                        stackTrace="xs:string"/>
                <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                <Progress> xs:int </Progress>
                <Params> ... </Params>
                <Details> xs:string </Details>
            </Task>
        </Tasks>
        <Files>
            <File href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                    name="xs:string" size="xs:long" bytesTransferred="xs:long" checksum="xs:normalizedString">
                <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                        rel="xs:string"/>
                <Description> xs:string </Description>
                <Tasks>
                    <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                            name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                            serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                            cancelRequested="xs:boolean">
                        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                                rel="xs:string"/>
                        <Description> xs:string </Description>
                        <Tasks> TasksInProgressType </Tasks>
                        <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                        <Error message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"
                                stackTrace="xs:string"/>
                        <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                        <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                        <Progress> xs:int </Progress>
                        <Params> ... </Params>
                        <Details> xs:string </Details>
                    </Task>
                </Tasks>
            </File>
        </Files>
        <VAppParent href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        <ovf:Section> ovf:Section_Type </ovf:Section>
        <DateCreated> xs:dateTime </DateCreated>
        <VAppScopedLocalId> xs:string </VAppScopedLocalId>
        <environment_1:Environment> environment_1:Environment_Type </environment_1:Environment>
        <VmCapabilities href="xs:anyURI" type="xs:string">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <MemoryHotAddEnabled> xs:boolean </MemoryHotAddEnabled>
            <CpuHotAddEnabled> xs:boolean </CpuHotAddEnabled>
        </VmCapabilities>
        <StorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </CreateItem>
    <DeleteItem href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</RecomposeVAppParams>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
name string No always 1.0 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 1.0 True if the vApp should be deployed at instantiation. Defaults to true.
powerOn boolean No always 1.0 True if the vApp should be powered-on at instantiation. Defaults to true.
linkedClone boolean No always 1.0 Reserved. Unimplemented.

Elements

Element Type Required Modifiable Since Deprecated 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.
CreateItem VmType No none 1.0 Read-only information about a Vm added during recomposition. This information appears in the Task returned by a recomposeVApp request.
DeleteItem ReferenceType No always 1.0 Reference to a Vm to be deleted during recomposition.
Description string No always 1.0 Optional description.
InstantiationParams InstantiationParamsType No always 1.0 Instantiation parameters for the composed vApp.
SourcedItem SourcedCompositionItemParamType No always 1.0 Composition item. One of:
vApp
vAppTemplate
Vm.
VAppParent ReferenceType No always 1.0 Reserved. Unimplemented.
VCloudExtension VCloudExtensionType No always 1.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 /vApp/{id}/action/recomposeVApp Recompose a vApp to add or remove VMs. 1.0