com.vmware.vcenter.vm.guest

Interface Customization

All Superinterfaces:

CustomizationTypes, Service

All Known Implementing Classes:

CustomizationStub

public interface Customization
extends Service, CustomizationTypes

The Customization interface provides methods to apply a customization specification to a virtual machine. This interface was added in vSphere API 7.0.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm.guest.CustomizationTypes

CustomizationTypes.SetSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.vm.guest.CustomizationTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	set(java.lang.String vm, CustomizationTypes.SetSpec spec) Applies a customization specification in spec on the virtual machine in vm.
void	set(java.lang.String vm, CustomizationTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Applies a customization specification in spec on the virtual machine in vm.
void	set(java.lang.String vm, CustomizationTypes.SetSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Applies a customization specification in spec on the virtual machine in vm.
void	set(java.lang.String vm, CustomizationTypes.SetSpec spec, InvocationConfig invocationConfig) Applies a customization specification in spec on the virtual machine in vm.

Method Detail

set

void set(java.lang.String vm,
         CustomizationTypes.SetSpec spec)

Applies a customization specification in spec on the virtual machine in vm. This method only sets the specification settings for the virtual machine. The actual customization happens inside the guest when the virtual machine is powered on. If spec has null values, then any pending customization settings for the virtual machine are cleared. If there is a pending customization for the virtual machine and spec has valid content, then the existing customization setting will be overwritten with the new settings. This method was added in vSphere API 7.0.0.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

vm - The unique identifier of the virtual machine that needs to be customized. The parameter must be an identifier for the resource type: VirtualMachine.

spec - The customization settings to be applied to the guest operating system.

Throws:

InvalidArgument - if the customization settings in spec are not valid.

NotAllowedInCurrentState - if the virtual machine vm is not in a powered off state.

NotFound - if a customization specification is not found with the unique name in spec.

NotFound - If the virtual machine vm is not found.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

set

void set(java.lang.String vm,
         CustomizationTypes.SetSpec spec,
         InvocationConfig invocationConfig)

Applies a customization specification in spec on the virtual machine in vm. This method only sets the specification settings for the virtual machine. The actual customization happens inside the guest when the virtual machine is powered on. If spec has null values, then any pending customization settings for the virtual machine are cleared. If there is a pending customization for the virtual machine and spec has valid content, then the existing customization setting will be overwritten with the new settings. This method was added in vSphere API 7.0.0.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

vm - The unique identifier of the virtual machine that needs to be customized. The parameter must be an identifier for the resource type: VirtualMachine.

spec - The customization settings to be applied to the guest operating system.

invocationConfig - Configuration for the method invocation.

Throws:

InvalidArgument - if the customization settings in spec are not valid.

NotAllowedInCurrentState - if the virtual machine vm is not in a powered off state.

NotFound - if a customization specification is not found with the unique name in spec.

NotFound - If the virtual machine vm is not found.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthenticated - if the user can not be authenticated.

Unauthorized - if the user doesn't have the required privileges.

set

void set(java.lang.String vm,
         CustomizationTypes.SetSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

Applies a customization specification in spec on the virtual machine in vm. This method only sets the specification settings for the virtual machine. The actual customization happens inside the guest when the virtual machine is powered on. If spec has null values, then any pending customization settings for the virtual machine are cleared. If there is a pending customization for the virtual machine and spec has valid content, then the existing customization setting will be overwritten with the new settings. This method was added in vSphere API 7.0.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
InvalidArgument - if the customization settings in spec are not valid.
NotAllowedInCurrentState - if the virtual machine vm is not in a powered off state.
NotFound - if a customization specification is not found with the unique name in spec.
NotFound - If the virtual machine vm is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

vm - The unique identifier of the virtual machine that needs to be customized. The parameter must be an identifier for the resource type: VirtualMachine.

spec - The customization settings to be applied to the guest operating system.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

set

void set(java.lang.String vm,
         CustomizationTypes.SetSpec spec,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

Applies a customization specification in spec on the virtual machine in vm. This method only sets the specification settings for the virtual machine. The actual customization happens inside the guest when the virtual machine is powered on. If spec has null values, then any pending customization settings for the virtual machine are cleared. If there is a pending customization for the virtual machine and spec has valid content, then the existing customization setting will be overwritten with the new settings. This method was added in vSphere API 7.0.0.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
InvalidArgument - if the customization settings in spec are not valid.
NotAllowedInCurrentState - if the virtual machine vm is not in a powered off state.
NotFound - if a customization specification is not found with the unique name in spec.
NotFound - If the virtual machine vm is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if the user doesn't have the required privileges.

Parameters:

vm - The unique identifier of the virtual machine that needs to be customized. The parameter must be an identifier for the resource type: VirtualMachine.

spec - The customization settings to be applied to the guest operating system.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.