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 8.0.2.0 APIs.
{
"vm": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"auth": {
"_typeName": "string",
"interactiveSession": false
},
"spec": {
"_typeName": "string",
"options": {
"_typeName": "string"
},
"identity": {
"_typeName": "string"
},
"globalIPSettings": {
"_typeName": "string",
"dnsSuffixList": [
"string"
],
"dnsServerList": [
"string"
]
},
"nicSettingMap": [
{
"_typeName": "string",
"macAddress": "string",
"adapter": {
"_typeName": "string",
"ip": {
"_typeName": "string"
},
"subnetMask": "string",
"gateway": [
"string"
],
"ipV6Spec": {
"_typeName": "string",
"ip": [
{
"_typeName": "string"
}
],
"gateway": [
"string"
]
},
"dnsServerList": [
"string"
],
"dnsDomain": "string",
"primaryWINS": "string",
"secondaryWINS": "string",
"netBIOS": "string"
}
}
],
"encryptionKey": [
0
]
},
"configParams": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
]
}
GuestAuthentication is an abstract base class for authentication in the guest.
The Specification data object type contains information required to customize a virtual machine when deploying it or migrating it to a new host.
addtional key/value pair list to support third party customization.
This method returns a Task object with which to monitor the operation.
{
"_typeName": "string",
"type": "string",
"value": "string"
}
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.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}