Virtual App Clone V App Task
Creates a clone of this vApp.
Any % (percent) character used in this name parameter must be escaped, unless it is used to start an escape sequence. Clients may also escape any other characters in this name parameter.
When invoking this method, the following privilege checks occur:
- The privilege VApp.Clone is required on this vApp.
- If the target is a resource pool, the privilege Resource.AssignVAppToPool is required on it.
- If the target is a vApp, the privileges VApp.Clone and VApp.AssignVApp are required on it.
Additional privileges are required by the clone spec provided. See VAppCloneSpec for details.
Required privileges: VApp.Clone
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId
, in this case VirtualApp/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"name": "string",
"target": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"spec": {
"_typeName": "string",
"location": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"resourceSpec": {
"_typeName": "string",
"entity": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"changeVersion": "string",
"lastModified": "string",
"cpuAllocation": {
"_typeName": "string",
"reservation": 0,
"expandableReservation": false,
"limit": 0,
"shares": {
"_typeName": "string",
"shares": 0,
"level": "string"
},
"overheadLimit": 0
},
"memoryAllocation": {
"_typeName": "string",
"reservation": 0,
"expandableReservation": false,
"limit": 0,
"shares": {
"_typeName": "string",
"shares": 0,
"level": "string"
},
"overheadLimit": 0
},
"scaleDescendantsShares": "string"
},
"vmFolder": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"networkMapping": [
{
"_typeName": "string",
"source": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"destination": {
"_typeName": "string",
"type": "string",
"value": "string"
}
}
],
"property": [
{
"_typeName": "string",
"key": "string",
"value": "string"
}
],
"resourceMapping": [
{
"_typeName": "string",
"source": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"parent": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"resourceSpec": {
"_typeName": "string",
"entity": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"changeVersion": "string",
"lastModified": "string",
"cpuAllocation": {
"_typeName": "string",
"reservation": 0,
"expandableReservation": false,
"limit": 0,
"shares": {
"_typeName": "string",
"shares": 0,
"level": "string"
},
"overheadLimit": 0
},
"memoryAllocation": {
"_typeName": "string",
"reservation": 0,
"expandableReservation": false,
"limit": 0,
"shares": {
"_typeName": "string",
"shares": 0,
"level": "string"
},
"overheadLimit": 0
},
"scaleDescendantsShares": "string"
},
"location": {
"_typeName": "string",
"type": "string",
"value": "string"
}
}
],
"provisioning": "string"
}
}
The name of the new vApp.
OK
{
"_typeName": "string",
"type": "string",
"value": "string"
}
InvalidPowerState: if the vApp is powered on.
TaskInProgress: if the vApp is busy.
NotSupported: if the operation is not supported by the current agent.
InvalidState: if the operation cannot be performed because of the vApp's current state. For example, if the virtual machine configuration information is not available, or if the vApp is running.
InvalidDatastore: if the operation cannot be performed on the target datastores.
FileFault: if there was an error accessing one of the virtual machine files.
VmConfigFault: if one of the virtual machines are not compatible with a destination host. Typically, a specific subclass of this exception is thrown, such as IDEDiskNotSupported.
MigrationFault: if it is not possible to migrate one of the virtual machines to the destination. This is typically due to hosts being incompatible, such as mismatch in network polices or access to networks and datastores. Typically, a more specific subclass is thrown.
InsufficientResourcesFault: if this operation would violate a resource usage policy.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}