Virtual Machine Guest Customization Manager Customize Guest Task
Customize a running virtual machine.
The virtual machine must be in the powered-on state and the VMware Tools must be running. The VM is typically a cloned VM after the InstantClone operation. See InstantClone_Task.
Required privileges: VirtualMachine.Provisioning.Customize
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 VirtualMachineGuestCustomizationManager/{moId}
.
The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.
"CustomizeGuestRequestType Object"
The Virtual Machine managed object reference.
The guest authentication data. See GuestAuthentication.
Is a CustomizationSpec. It specifies the virtual machine's configuration.
addtional key/value pair list to support third party customization.
This method returns a Task object with which to monitor the operation.
"MoRefTask Object"
TaskInProgress: if the virtual machine is busy.
InvalidPowerState: if the VM is not powered on.
InvalidState: if the operation cannot be performed because of the virtual machine's current state. For example, if the VMware Tools is not running.
InvalidGuestLogin: if the the guest authentication information was not accepted.
GuestPermissionDenied: if the provided guest authentication is not sufficient to perform the guest customization.
CustomizationFault: if a customization error occurs.
"VimFault Object"
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/VirtualMachineGuestCustomizationManager/{moId}/CustomizeGuest_Task