Local Methods
Managed Object Types	Data Object Types	All Properties	All Methods

Managed Object - VirtualMachineGuestCustomizationManager(vim.vm.GuestCustomizationManager)

Property of

ServiceContent

See also

CustomizationSpec, GuestAuthentication, OptionValue, VirtualMachine

Since

vSphere API Release 6.8.7

Managed Object Description

GuestCustomizationManager is a singleton managed object that provides APIs for guest customization of a running VM.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
AbortCustomization_Task, CustomizeGuest_Task, StartGuestNetwork_Task

AbortCustomization_Task(abortCustomization)

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualMachineGuestCustomizationManager used to make the method call.
vm	ManagedObjectReference to a VirtualMachine	The Virtual Machine managed object reference. Since vSphere API Release 6.8.7
auth	GuestAuthentication	The guest authentication data. See GuestAuthentication. Since vSphere API Release 6.8.7

Return Value

Type	Description
ManagedObjectReference to a SmsTask	This method returns a Task object with which to monitor the operation.

Faults

Type	Description
CustomizationFault	Thrown if a customization error occurs.
GuestPermissionDenied	Thrown if the provided guest authentication is not sufficient to perform the guest customization.
InvalidGuestLogin	Thrown if the the guest authentication information was not accepted.
InvalidPowerState	Thrown if the VM is not powered on.
InvalidState	Thrown if the operation cannot be performed because of the virtual machine's current state. For example, if the VMware Tools is not running.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if the virtual machine is busy.

Events

Type
None

CustomizeGuest_Task(customize)

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualMachineGuestCustomizationManager used to make the method call.
vm	ManagedObjectReference to a VirtualMachine	The Virtual Machine managed object reference. Since vSphere API Release 6.8.7
auth	GuestAuthentication	The guest authentication data. See GuestAuthentication. Since vSphere API Release 6.8.7
spec	CustomizationSpec	Is a CustomizationSpec. It specifies the virtual machine's configuration. Since vSphere API Release 6.8.7
configParams*	OptionValue[]	addtional key/value pair list to support third party customization. Since vSphere API Release 6.8.7

*Need not be set

Return Value

Type	Description
ManagedObjectReference to a SmsTask	This method returns a Task object with which to monitor the operation.

Faults

Type	Description
CustomizationFault	Thrown if a customization error occurs.
GuestPermissionDenied	Thrown if the provided guest authentication is not sufficient to perform the guest customization.
InvalidGuestLogin	Thrown if the the guest authentication information was not accepted.
InvalidPowerState	Thrown if the VM is not powered on.
InvalidState	Thrown if the operation cannot be performed because of the virtual machine's current state. For example, if the VMware Tools is not running.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if the virtual machine is busy.

Events

Type
None

StartGuestNetwork_Task(startNetwork)

Start the network service in the guest, e.g. acquire IPs from DHCP. 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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VirtualMachineGuestCustomizationManager used to make the method call.
vm	ManagedObjectReference to a VirtualMachine	The Virtual Machine managed object reference. Since vSphere API Release 6.8.7
auth	GuestAuthentication	The guest authentication data. See GuestAuthentication. Since vSphere API Release 6.8.7

Return Value

Type	Description
ManagedObjectReference to a SmsTask	This method returns a Task object with which to monitor the operation.

Faults

Type	Description
CustomizationFault	Thrown if a customization error occurs.
GuestPermissionDenied	Thrown if the provided guest authentication is not sufficient to perform the guest customization.
InvalidGuestLogin	Thrown if the the guest authentication information was not accepted.
InvalidPowerState	Thrown if the VM is not powered on.
InvalidState	Thrown if the operation cannot be performed because of the virtual machine's current state. For example, if the VMware Tools is not running.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if the virtual machine is busy.

Events

Type
None

Top of page			Local Methods
Managed Object Types	Data Object Types	All Properties	All Methods