VMware Cloud Director API - RegisterVAppParams

RegisterVAppParamsType

Element:

RegisterVAppParams

Type:

Namespace:

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

Description:

Represents vApp registration parameters.

Since:

5.5

Schema:

vApp.xsd

Media type(s):

application/vnd.vmware.admin.registerVAppParams+xml
application/vnd.vmware.admin.registerVAppParams+json

Extends:

ParamsType

XML Representation:

<RegisterVAppParams xmlns="http://www.vmware.com/vcloud/v1.5" name="xs:string">
    <Description> xs:string </Description>
    <Ovf> xs:string </Ovf>
    <VsToVmxMap>
        <Entry biosUuid="xs:string" datastorePath="xs:string" storageProfile="xs:string"/>
    </VsToVmxMap>
    <OvfToVdcNetworkMap>
        <Entry ovfNetwork="xs:string" vdcNetwork="xs:string"/>
    </OvfToVdcNetworkMap>
    <ExternalNatIpMap>
        <Entry sourceNatIp="xs:string" destinationNatIp="xs:string"/>
    </ExternalNatIpMap>
    <NicIpMap>
        <Entry sourceNicIp="xs:string" destinationNicIp="xs:string"/>
    </NicIpMap>
</RegisterVAppParams>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
name	string	No	always	5.5		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
Description	string	No	always	5.5	Optional description.
ExternalNatIpMap	ExternalNatIpMapType	Yes	always	5.5	Maps source site external NAT IP addresses to destination site external NAT IP addresses.
NicIpMap	NicIpMapType	Yes	always	5.5	VM's with NICs that are connected directly to a VDC network and where the NICs have manually assigned IP addresses needs to be mapped to a valid IP address within the IP range of the destination site's VDC network. This element provides that mapping.
Ovf	string	Yes	always	5.5	Embedded OVF. Must be embedded as CDATA.
OvfToVdcNetworkMap	OvfToVdcNetworkMapType	Yes	always	5.5	Maps from OVF to site specific networks.
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.
VsToVmxMap	VsToVmxMapType	Yes	always	5.5	Map from OVF Virtual Systems via the BIOS UUID to the datastore location of the replicated VM's files on the destination site.

Operations

CRUD	Operation	Description	Since	Deprecated
as input	POST /admin/vdc/{id}/action/registerVApp	Create a vApp based on a set of .vmx files and resource mappings	5.5