VMware Cloud Director API - InstantiateOvfParams

InstantiateOvfParamsType

Element:

InstantiateOvfParams

Type:

InstantiateOvfParamsType

Namespace:

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

Description:

Represents vApp instantiation from OVF parameters

Since:

Schema:

vApp.xsd

Media type(s):

application/vnd.vmware.vcloud.instantiateOvfParams+xml
application/vnd.vmware.vcloud.instantiateOvfParams+json

Extends:

VAppCreationParamsType

XML Representation:

<InstantiateOvfParams xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1" name="xs:string" deploy="xs:boolean" powerOn="xs:boolean" transferFormat="xs:string">
    <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>
    <AllEULAsAccepted> xs:boolean </AllEULAsAccepted>
    <RemoveNonStandardOvfExtensions> xs:boolean </RemoveNonStandardOvfExtensions>
    <NetworkMapping>
        <Source> xs:string </Source>
        <Target> xs:string </Target>
    </NetworkMapping>
    <InstantiateOvfProperty>
        <ClassId> xs:string </ClassId>
        <InstanceId> xs:string </InstanceId>
        <Key> xs:string </Key>
        <Value> xs:string </Value>
    </InstantiateOvfProperty>
    <InstantiateVmParams 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>
</InstantiateOvfParams>

Attributes

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

Elements

Element	Type	Required	Modifiable	Since	Description
AllEULAsAccepted	boolean	No	always	0.9	True confirms acceptance of all EULAs in an OVF. Instantiation fails if this element is missing, empty, or set to false and one or more EulaSection elements are present.
Description	string	No	always		Optional description.
InstantiateOvfProperty	InstantiateOvfPropertyType	No			A mapping from OVF properties to instantiation values.
InstantiateVmParams	InstantiateVmParamsType	No			Instantiation parameters for the VMs in the vApp.
InstantiationParams	InstantiationParamsType	No	always		Instantiation parameters for the composed vApp.
NetworkMapping	NetworkMappingType	No			A mapping from an OVF network name to a vCloud network name. Used to update network properties in the OVF.
RemoveNonStandardOvfExtensions	boolean	No	always	5.9	If true, remove elements in the uploaded descriptor if they are not defined in the OVF XML namespace (http://schemas.dmtf.org/ovf/envelope/1). Default is false.
VAppParent	ReferenceType	No	always		Reserved. Unimplemented.
VCloudExtension	VCloudExtensionType	No	always		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 /vdc/{id}/action/instantiateOvf	Instantiate a vApp or VM from an OVF	5.5