Virtual Machine Guest Customization Manager Abort Customization Task

Virtual Machine Guest Customization Manager Abort Customization Task

Abort any running guest customization process in the guest and remove the guest customization lock in the guest as well.

As a result of the operation, the guest configuration may be left in an undefined state, which is however fine because guest customization is idempotent. A later successful guest customization can set the guest configuration to a valid state. 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

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/VirtualMachineGuestCustomizationManager/{moId}/AbortCustomization_Task
COPY
Path Parameters
string
moId
Required

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}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.

Request Body
AbortCustomizationRequestType of type(s) application/json
Required 
{
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "auth": {
        "_typeName": "string",
        "interactiveSession": false
    }
}
MoRefVirtualMachine
vm
Required

Reference to an instance of the VirtualMachine managed object.

GuestAuthentication
auth
Required

GuestAuthentication is an abstract base class for authentication in the guest.

Authentication
This operation uses the following authentication methods.
Responses
200

This method returns a Task object with which to monitor the operation.

Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject 
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

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.

Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page
Virtual Machine Guest Customization Manager Operations
POST
Virtual Machine Guest Customization Manager Abort Customization Task
POST
Virtual Machine Guest Customization Manager Customize Guest Task
POST
Virtual Machine Guest Customization Manager Start Guest Network Task