| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
AbortCustomization_Task, CustomizeGuest_Task, StartGuestNetwork_Task |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualMachineGuestCustomizationManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
The Virtual Machine managed object reference.
Since vSphere API 6.8.7 |
auth P | GuestAuthentication |
The guest authentication data. See
GuestAuthentication.
Since vSphere API 6.8.7 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualMachineGuestCustomizationManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
The Virtual Machine managed object reference.
Since vSphere API 6.8.7 |
auth P | GuestAuthentication |
The guest authentication data. See
GuestAuthentication.
Since vSphere API 6.8.7 |
spec P | CustomizationSpec |
Is a CustomizationSpec.
It specifies the virtual machine's configuration.
Since vSphere API 6.8.7 |
configParams* P | OptionValue[] |
addtional key/value pair list to support
third party customization.
Since vSphere API 6.8.7 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | 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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VirtualMachineGuestCustomizationManager used to make the method call. |
vm P | ManagedObjectReference
to a VirtualMachine |
The Virtual Machine managed object reference.
Since vSphere API 6.8.7 |
auth P | GuestAuthentication |
The guest authentication data. See
GuestAuthentication.
Since vSphere API 6.8.7 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Task | 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 |