VMware Cloud Director API - RecomposeVAppParams
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
application/vnd.vmware.vcloud.recomposeVAppParams+json
- 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>
<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>
<CreateItem href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
name="xs:string" status="xs:int" deployed="xs:boolean" encrypted="xs:boolean"
needsCustomization="xs:boolean" nestedHypervisorEnabled="xs:boolean">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="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" model="xs:string"/>
<Description> xs:string </Description>
<Tasks> TasksInProgressType </Tasks>
<Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
vendorSpecificErrorCode="xs:string">
<TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
</Error>
<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>
<VcTaskList>
<VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
</VcTaskList>
<Result>
<ResultContent> ... </ResultContent>
<ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</Result>
</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" model="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" model="xs:string"/>
<Description> xs:string </Description>
<Tasks> TasksInProgressType </Tasks>
<Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
vendorSpecificErrorCode="xs:string">
<TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
</Error>
<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>
<VcTaskList>
<VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
</VcTaskList>
<Result>
<ResultContent> ... </ResultContent>
<ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</Result>
</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" model="xs:string"/>
<MemoryHotAddEnabled> xs:boolean </MemoryHotAddEnabled>
<CpuHotAddEnabled> xs:boolean </CpuHotAddEnabled>
</VmCapabilities>
<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>
<ComputePolicyCompliance 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"/>
<LastComplianceCheckTime> xs:dateTime </LastComplianceCheckTime>
<PolicyName> xs:string </PolicyName>
<NonComplianceMessage> xs:string </NonComplianceMessage>
</ComputePolicyCompliance>
<IsComputePolicyCompliant> xs:boolean </IsComputePolicyCompliant>
<BootOptions 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"/>
<BootDelay> xs:long </BootDelay>
<EnterBIOSSetup> xs:boolean </EnterBIOSSetup>
<BootRetryEnabled> xs:boolean </BootRetryEnabled>
<BootRetryDelay> xs:long </BootRetryDelay>
<EfiSecureBootEnabled> xs:boolean </EfiSecureBootEnabled>
<NetworkBootProtocol> xs:string </NetworkBootProtocol>
</BootOptions>
<Media href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<ReplicationTrackingDiskSection>
<ReplicationTrackingDiskSettings>
<DiskUuid> xs:string </DiskUuid>
<StorageProvisionedKb> xs:long </StorageProvisionedKb>
<StorageOverheadKb> xs:long </StorageOverheadKb>
<StoragePolicy href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<PlacementRecommendation> xs:string </PlacementRecommendation>
</ReplicationTrackingDiskSettings>
</ReplicationTrackingDiskSection>
<ReplicationTrackingSettings 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"/>
<ReplicationTrackingVmState> xs:string </ReplicationTrackingVmState>
</ReplicationTrackingSettings>
<TrustedPlatformModule 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"/>
<TpmPresent> xs:boolean </TpmPresent>
</TrustedPlatformModule>
<IsVAppConfigRemoved> xs:boolean </IsVAppConfigRemoved>
</CreateItem>
<AllEULAsAccepted> xs:boolean </AllEULAsAccepted>
<DeleteItem href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<ReconfigureItem href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
name="xs:string" status="xs:int" deployed="xs:boolean" encrypted="xs:boolean"
needsCustomization="xs:boolean" nestedHypervisorEnabled="xs:boolean">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="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" model="xs:string"/>
<Description> xs:string </Description>
<Tasks> TasksInProgressType </Tasks>
<Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
vendorSpecificErrorCode="xs:string">
<TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
</Error>
<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>
<VcTaskList>
<VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
</VcTaskList>
<Result>
<ResultContent> ... </ResultContent>
<ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</Result>
</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" model="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" model="xs:string"/>
<Description> xs:string </Description>
<Tasks> TasksInProgressType </Tasks>
<Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
vendorSpecificErrorCode="xs:string">
<TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
</Error>
<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>
<VcTaskList>
<VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
</VcTaskList>
<Result>
<ResultContent> ... </ResultContent>
<ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</Result>
</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" model="xs:string"/>
<MemoryHotAddEnabled> xs:boolean </MemoryHotAddEnabled>
<CpuHotAddEnabled> xs:boolean </CpuHotAddEnabled>
</VmCapabilities>
<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>
<ComputePolicyCompliance 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"/>
<LastComplianceCheckTime> xs:dateTime </LastComplianceCheckTime>
<PolicyName> xs:string </PolicyName>
<NonComplianceMessage> xs:string </NonComplianceMessage>
</ComputePolicyCompliance>
<IsComputePolicyCompliant> xs:boolean </IsComputePolicyCompliant>
<BootOptions 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"/>
<BootDelay> xs:long </BootDelay>
<EnterBIOSSetup> xs:boolean </EnterBIOSSetup>
<BootRetryEnabled> xs:boolean </BootRetryEnabled>
<BootRetryDelay> xs:long </BootRetryDelay>
<EfiSecureBootEnabled> xs:boolean </EfiSecureBootEnabled>
<NetworkBootProtocol> xs:string </NetworkBootProtocol>
</BootOptions>
<Media href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<ReplicationTrackingDiskSection>
<ReplicationTrackingDiskSettings>
<DiskUuid> xs:string </DiskUuid>
<StorageProvisionedKb> xs:long </StorageProvisionedKb>
<StorageOverheadKb> xs:long </StorageOverheadKb>
<StoragePolicy href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<PlacementRecommendation> xs:string </PlacementRecommendation>
</ReplicationTrackingDiskSettings>
</ReplicationTrackingDiskSection>
<ReplicationTrackingSettings 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"/>
<ReplicationTrackingVmState> xs:string </ReplicationTrackingVmState>
</ReplicationTrackingSettings>
<TrustedPlatformModule 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"/>
<TpmPresent> xs:boolean </TpmPresent>
</TrustedPlatformModule>
<IsVAppConfigRemoved> xs:boolean </IsVAppConfigRemoved>
</ReconfigureItem>
</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 30.0 Read-only information about a VM added during vApp composition or recomposition. 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. ReconfigureItem VmType No always 5.7 Existing Vm to be reconfigured during recomposition. SourcedItem SourcedCompositionItemParamType No always 1.0 Composition item. One of:
vApp
vAppTemplate
Vm
Vms must be powered off and cannot have an independent disk attached.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