VMware Cloud Director API - InstantiateVmParams

InstantiateVmParamsType

Element:

InstantiateVmParams

Type:

Namespace:

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

Description:

Instantiation parameters for a VM in a vApp.

Since:

5.5

Schema:

vApp.xsd

Media type(s):

None

Extends:

VCloudExtensibleType

XML Representation:

<InstantiateVmParams xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1" id="xs:string">
    <NetworkConnectionSection href="xs:anyURI" type="xs:string">
        <PrimaryNetworkConnectionIndex> xs:int </PrimaryNetworkConnectionIndex>
        <NetworkConnection network="xs:string" needsCustomization="xs:boolean">
            <NetworkConnectionIndex> xs:int </NetworkConnectionIndex>
            <IpAddress> IpAddressType </IpAddress>
            <IpType> IpTypeType </IpType>
            <SecondaryIpAddress> xs:string </SecondaryIpAddress>
            <SecondaryIpType> IpTypeType </SecondaryIpType>
            <ExternalIpAddress> IpAddressType </ExternalIpAddress>
            <IsConnected> xs:boolean </IsConnected>
            <MACAddress> xs:string </MACAddress>
            <IpAddressAllocationMode> xs:string </IpAddressAllocationMode>
            <SecondaryIpAddressAllocationMode> xs:string </SecondaryIpAddressAllocationMode>
            <NetworkAdapterType> xs:string </NetworkAdapterType>
        </NetworkConnection>
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string" model="xs:string"/>
    </NetworkConnectionSection>
    <ComputerName> xs:string </ComputerName>
    <VdcStorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <HardwareCustomization>
        <NumberOfCpus> xs:int </NumberOfCpus>
        <CoresPerSocket> xs:int </CoresPerSocket>
        <MemorySize> xs:long </MemorySize>
        <Disk instanceId="xs:string">
            <Size> xs:long </Size>
        </Disk>
    </HardwareCustomization>
</InstantiateVmParams>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
id	string	No	always	5.5		The ovf:id of the VirtualSystem in the source OVF that the instantiation parameters apply to.

Elements

Element	Type	Required	Modifiable	Since	Description
ComputerName	string	No	always	5.5	Represents the computer name that is part of guest customization.
HardwareCustomization	InstantiateVmHardwareCustomizationParamsType	No	always	5.5	Specification of common virtual machine hardware parameters. This is a simple way to customize hardware settings without modifying the source OVF descriptor before uploading it.
NetworkConnectionSection	NetworkConnectionSectionType	No	always	5.5	Network connection configuration for a VM.
VCloudExtension	VCloudExtensionType	No	always	5.5	An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
VdcStorageProfile	ReferenceType	No	always	5.5	The VDC storage profile to use. If set, the value must refer to an existing and enabled storage profile on the VDC.