VMware Cloud Director API - CaptureVAppParams

CaptureVAppParamsType

Element:

CaptureVAppParams

Type:

Namespace:

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

Description:

Parameters for a captureVapp request.

Since:

0.9

Schema:

vApp.xsd

Media type(s):

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

Extends:

ParamsType

XML Representation:

<CaptureVAppParams xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1" name="xs:string">
    <Description> xs:string </Description>
    <Source href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <CaptureVmParams name="xs:string">
        <Description> xs:string </Description>
        <Source 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"/>
    </CaptureVmParams>
    <ovf:Section> ovf:Section_Type </ovf:Section>
    <TargetCatalogItem href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <CopyTpmOnInstantiate> xs:boolean </CopyTpmOnInstantiate>
</CaptureVAppParams>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
name	string	No	always	0.9		Typically used to name or identify the subject of the request. For example, the name of the object being created or modified.

Elements

Element	Type	Required	Modifiable	Since	Description
CaptureVmParams	CaptureVmParamsType	No	always	0.9	Params to customize template VM during capture
CopyTpmOnInstantiate	boolean	No	always	37.2	True if TPM device is copied to instantiated vApp from this template. False if a new TPM device is created for instantiated vApp.
Description	string	No	always	0.9	Optional description.
Section	Section_Type	No		0.9	An ovf:Section to configure the vAppTemplate.
Source	ReferenceType	Yes	always	0.9	Contains a reference to the vApp to capture.
TargetCatalogItem	ReferenceType	No	always	5.5	To overwrite an existing vApp template with the one created by this capture, place a reference to the existing template here. Otherwise, the operation creates a new vApp template.
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.

Operations

CRUD	Operation	Description	Since	Deprecated
as input	POST /catalog/{id}/action/captureVApp	Create a vApp template in this catalog from a vApp.	5.5
as input	POST /vdc/{id}/action/captureVApp	Create a vApp template from a vApp.	0.9	5.5