VMware Cloud Director API - SourcedCompositionItemParamType

SourcedCompositionItemParamType

Type:

SourcedCompositionItemParamType

Namespace:

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

Description:

Represents a vApp, vApp template or Vm to include in a composed vApp.

Since:

0.9

Schema:

vApp.xsd

Media type(s):

None

Extends:

VCloudExtensibleType

XML Representation:

<SourcedCompositionItemParamType xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1" 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>
</SourcedCompositionItemParamType>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
sourceDelete	boolean	No	always	1.0		True if the source item should be deleted after composition is complete.

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
ComputePolicy	ComputePolicyType	No	always	33.0		A reference to a vdc compute policy. This contains VM's actual vdc compute policy reference and also optionally an add-on policy which always defines VM's sizing.
InstantiationParams	InstantiationParamsType	No	always	0.9		If Source references a Vm this can include any of the following OVF sections: VirtualHardwareSection OperatingSystemSection NetworkConnectionSection GuestCustomizationSection.
LocalityParams	LocalityParamsType	No	always	5.6		Locality parameters provide a hint that may help optimize placement of a VM and an independent a Disk so that the VM can make efficient use of the disk. See KB 2105352.
NetworkAssignment	NetworkAssignmentType	No	always	0.9		If Source references a Vm, this element maps a network name specified in the Vm to the network name of a vApp network defined in the composed vApp.
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.
StorageProfile	ReferenceType	No	always	5.1		If Source references a Vm, this element contains a reference to a storage profile to be used for the Vm. The specified storage profile must exist in the organization vDC that contains the composed vApp. If not specified, the default storage profile for the vDC is used.
VAppScopedLocalId	string	No	always	1.0		If Source references a Vm, this value provides a unique identifier for the Vm in the scope of the composed vApp.
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.
VdcComputePolicy	ReferenceType	No	always	31.0	33.0	A reference to a vdc compute policy. A VM will always belong to vdc compute policy. The specified vDC compute policy must exist in organization vDC. If not specified, default vDC compute policy will be used.
VmCapabilities	VmCapabilitiesType	No	always	5.6		If Source references a Vm, this element describes the capabilities (hot swap, etc.) the instantiated VM should have.
VmGeneralParams	VmGeneralParamsType	No	always	5.6		Specify name, description, and other properties of a VM during instantiation.