RecomposeVAppParams

Element:

RecomposeVAppParams

Type:

RecomposeVAppParamsType

Namespace:

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

Description:

Represents vApp re-composition parameters.

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"/>
        <VAppScopedLocalId> xs:string </VAppScopedLocalId>
        <InstantiationParams>
            <ovf:Section> ovf:Section_Type </ovf:Section>
        </InstantiationParams>
        <NetworkAssignment innerNetwork="xs:string" containerNetwork="xs:string"/>
    </SourcedItem>
    <AllEULAsAccepted> xs:boolean </AllEULAsAccepted>
    <CreateItem href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
            status="xs:int" deployed="xs:boolean" needsCustomization="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" name="xs:string" id="xs:string"
                    status="xs:string" operation="xs:string" operationName="xs:string" startTime="xs:dateTime"
                    endTime="xs:dateTime" expiryTime="xs:dateTime">
                <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>
            </Task>
        </Tasks>
        <Files>
            <File href="xs:anyURI" type="xs:string" name="xs:string" id="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" name="xs:string" id="xs:string"
                            status="xs:string" operation="xs:string" operationName="xs:string" startTime="xs:dateTime"
                            endTime="xs:dateTime" expiryTime="xs:dateTime">
                        <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>
                    </Task>
                </Tasks>
            </File>
        </Files>
        <VAppParent href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        <ovf:Section> ovf:Section_Type </ovf:Section>
        <VAppScopedLocalId> xs:string </VAppScopedLocalId>
        <environment_1:Environment> environment_1:Environment_Type </environment_1:Environment>
    </CreateItem>
    <DeleteItem href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</RecomposeVAppParams>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
name	string	No	always	1.0	A name as parameter.
deploy	boolean	No	always	1.0	Flag to deploy the VApp after successful creation.
powerOn	boolean	No	always	1.0	Flag to deploy and power on the VApp after successful creation.
linkedClone	boolean	No	always	1.0	Reserved. Unimplemented.

Elements

Element	Type	Occurrence	Modifiable	Since	Description
VCloudExtension	VCloudExtensionType	0..*	always	1.0	An optional extension element that can contain an arbitrary number of elements and attributes.
Description	string	0..1	always	1.0	Optional description.
VAppParent	ReferenceType	0..1	always	1.0	Reserved. Unimplemented.
InstantiationParams	InstantiationParamsType	0..1	always	1.0	Instantiation parameters of a VApp.
SourcedItem	SourcedCompositionItemParamType	0..*	always	1.0	Composition item. One of: vApp, vAppTemplate, Vm.
AllEULAsAccepted	boolean	0..1	always	0.9	Used to confirm 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	0..*	none	1.0	A VM to be added during composition.
DeleteItem	ReferenceType	0..*	always	1.0	Reference to a VM to be deleted during composition.

Operations

CRUD	Operation	Description	Since
as input	POST /vApp/{id}/action/recomposeVApp	Recompose a vApp by removing its own VMs and/or adding new ones from other vApps or vApp templates.	1.0