CreateVmParamsType

Element:

CreateVmParams

Type:

CreateVmParamsType

Namespace:

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

Description:

Represents VM creation parameters.

Since:

32.0

Schema:

vApp.xsd

Media type(s):

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

Extends:

ParamsType

XML Representation:

<CreateVmParams 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" powerOn="xs:boolean">
    <Description> xs:string </Description>
    <CreateVm 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>
        </BootOptions>
        <Media href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </CreateVm>
    <Media href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</CreateVmParams>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
name	string	No	always	32.0		Typically used to name or identify the subject of the request. For example, the name of the object being created or modified.
powerOn	boolean	No	none	32.0		True if the VM should be powered-on after creation. Defaults to false.

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
CreateVm	VmType	No	none	32.0		Read-only information about the Vm to create. This information appears in the Task returned by a createVm request.
Description	string	No	always	32.0		Optional description.
Media	ReferenceType	No	none	32.0		Reference to the media object to insert in the new VM.
VCloudExtension	VCloudExtensionType	No	always	32.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 /vdc/{id}/action/createVm	Create a standalone blank VM and nest it under a new auto-nature vApp.	32.0