Virtual App Register Child VM Task
Adds an existing virtual machine to this resource pool or vApp.
This operation only works for vApps or resource pools that are children of vApps. To register a VM in a folder, see RegisterVM_Task.
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. In addition to the VirtualMachine.Inventory.Register privilege, it requires System.Read privilege on the datastore that the existing virtual machine resides on.
Required privileges: VirtualMachine.Inventory.Register
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.
{
"path": "string",
"name": "string",
"host": {
"_typeName": "string",
"type": "string",
"value": "string"
}
}A datastore path to the virtual machine. If the path ends with ".vmtx", indicating that it refers to a VM template, an InvalidArgument fault is thrown.
The name to be assigned to the virtual machine. If this parameter is not set, the displayName configuration parameter of the virtual machine is used. An entity name must be a non-empty string of less than 80 characters. The slash (/), backslash (\) and percent (%) will be escaped using the URL syntax. For example, %2F.
This method returns a Task object with which to monitor the operation. The info.result property in the Task contains the newly registered VirtualMachine upon success.
{
"_typeName": "string",
"type": "string",
"value": "string"
}NotSupported: if the operation is not supported. For example, if the operation is invoked on a resource pool that is unrelated to a vApp.
OutOfBounds: if the maximum number of VMs has been exceeded.
AlreadyExists: if the virtual machine is already registered.
InvalidDatastore: if the operation cannot be performed on the target datastores.
NotFound: if the configuration file is not found on the system.
InvalidName: if the entity name is invalid.
InvalidArgument: if any of the arguments are invalid and a more specific fault type does not apply.
VmConfigFault: if the format / configuration of the virtual machine is invalid. Typically, a more specific fault is thrown such as InvalidFormat if the configuration file cannot be read, or InvalidDiskFormat if the disks cannot be read.
FileFault: if there is an error accessing the files on disk.
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"
}
]
}