vmware::vcenter::vm::guest::Customization Interface Reference

The Customization interface provides methods to apply a customization specification to a virtual machine. More...

Inherited by vmware::vcenter::vm::guest::CustomizationStub.

List of all members.

Public Member Functions
void	Set (string vm, vmware.vcenter.vm.guest.CustomizationTypes.SetSpec spec)
	Applies a customization specification in spec on the virtual machine in vm .
void	Set (string vm, vmware.vcenter.vm.guest.CustomizationTypes.SetSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Applies a customization specification in spec on the virtual machine in vm .
global::System.Threading.Tasks.Task	SetAsync (string vm, vmware.vcenter.vm.guest.CustomizationTypes.SetSpec spec)
	Applies a customization specification in spec on the virtual machine in vm .
global::System.Threading.Tasks.Task	SetAsync (string vm, vmware.vcenter.vm.guest.CustomizationTypes.SetSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Applies a customization specification in spec on the virtual machine in vm .

---

Detailed Description

The Customization interface provides methods to apply a customization specification to a virtual machine.

This interface was added in vSphere API 7.0.0.

---

Member Function Documentation

void vmware::vcenter::vm::guest::Customization::Set	(	string	vm,
		vmware.vcenter.vm.guest.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.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the customization settings in spec are not valid.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine vm is not in a powered off state.
vmware.vapi.std.errors.NotFound	if a customization specification is not found with the unique name in spec .
vmware.vapi.std.errors.NotFound	If the virtual machine vm is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.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.

Implemented in vmware::vcenter::vm::guest::CustomizationStub.

void vmware::vcenter::vm::guest::Customization::Set	(	string	vm,
		vmware.vcenter.vm.guest.CustomizationTypes.SetSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the customization settings in spec are not valid.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine vm is not in a powered off state.
vmware.vapi.std.errors.NotFound	if a customization specification is not found with the unique name in spec .
vmware.vapi.std.errors.NotFound	If the virtual machine vm is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vm::guest::CustomizationStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::Customization::SetAsync	(	string	vm,
		vmware.vcenter.vm.guest.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.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the customization settings in spec are not valid.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine vm is not in a powered off state.
vmware.vapi.std.errors.NotFound	if a customization specification is not found with the unique name in spec .
vmware.vapi.std.errors.NotFound	If the virtual machine vm is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.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.

Implemented in vmware::vcenter::vm::guest::CustomizationStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::Customization::SetAsync	(	string	vm,
		vmware.vcenter.vm.guest.CustomizationTypes.SetSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.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.

Exceptions:

vmware.vapi.std.errors.InvalidArgument	if the customization settings in spec are not valid.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine vm is not in a powered off state.
vmware.vapi.std.errors.NotFound	if a customization specification is not found with the unique name in spec .
vmware.vapi.std.errors.NotFound	If the virtual machine vm is not found.
vmware.vapi.std.errors.ServiceUnavailable	if the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticated	if the user can not be authenticated.
vmware.vapi.std.errors.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.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vm::guest::CustomizationStub.

---

The documentation for this interface was generated from the following file:

• Customization.cs