VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::vcenter::vm::guest::CustomizationStub Class Reference

Remote stub implementation of the Customization API service. More...

Inherits vmware::vcenter::vm::guest::Customization.

List of all members.

Public Member Functions

 CustomizationStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
 CustomizationStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
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

Remote stub implementation of the Customization API service.


Constructor & Destructor Documentation

vmware::vcenter::vm::guest::CustomizationStub::CustomizationStub ( vmware.vapi.core.IApiProvider  iApiProvider,
vmware.vapi.bindings.TypeConverter  typeConverter,
vmware.vapi.bindings.IStubConfiguration  config 
) [inline]
vmware::vcenter::vm::guest::CustomizationStub::CustomizationStub ( vmware.vapi.core.IApiProvider  iApiProvider,
vmware.vapi.bindings.IStubConfiguration  config 
) [inline]

Member Function Documentation

void vmware::vcenter::vm::guest::CustomizationStub::Set ( string  vm,
vmware.vcenter.vm.guest.CustomizationTypes.SetSpec  spec 
) [inline]

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.InvalidArgumentif the customization settings in spec are not valid.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the virtual machine vm is not in a powered off state.
vmware.vapi.std.errors.NotFoundif a customization specification is not found with the unique name in spec .
vmware.vapi.std.errors.NotFoundIf the virtual machine vm is not found.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
Parameters:
vmThe unique identifier of the virtual machine that needs to be customized. The parameter must be an identifier for the resource type: VirtualMachine .
specThe customization settings to be applied to the guest operating system.

Implements vmware::vcenter::vm::guest::Customization.

void vmware::vcenter::vm::guest::CustomizationStub::Set ( string  vm,
vmware.vcenter.vm.guest.CustomizationTypes.SetSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

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.InvalidArgumentif the customization settings in spec are not valid.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the virtual machine vm is not in a powered off state.
vmware.vapi.std.errors.NotFoundif a customization specification is not found with the unique name in spec .
vmware.vapi.std.errors.NotFoundIf the virtual machine vm is not found.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
Parameters:
vmThe unique identifier of the virtual machine that needs to be customized. The parameter must be an identifier for the resource type: VirtualMachine .
specThe customization settings to be applied to the guest operating system.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implements vmware::vcenter::vm::guest::Customization.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::CustomizationStub::SetAsync ( string  vm,
vmware.vcenter.vm.guest.CustomizationTypes.SetSpec  spec 
) [inline]

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.InvalidArgumentif the customization settings in spec are not valid.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the virtual machine vm is not in a powered off state.
vmware.vapi.std.errors.NotFoundif a customization specification is not found with the unique name in spec .
vmware.vapi.std.errors.NotFoundIf the virtual machine vm is not found.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
Parameters:
vmThe unique identifier of the virtual machine that needs to be customized. The parameter must be an identifier for the resource type: VirtualMachine .
specThe customization settings to be applied to the guest operating system.

Implements vmware::vcenter::vm::guest::Customization.

global::System.Threading.Tasks.Task vmware::vcenter::vm::guest::CustomizationStub::SetAsync ( string  vm,
vmware.vcenter.vm.guest.CustomizationTypes.SetSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
) [inline]

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.InvalidArgumentif the customization settings in spec are not valid.
vmware.vapi.std.errors.NotAllowedInCurrentStateif the virtual machine vm is not in a powered off state.
vmware.vapi.std.errors.NotFoundif a customization specification is not found with the unique name in spec .
vmware.vapi.std.errors.NotFoundIf the virtual machine vm is not found.
vmware.vapi.std.errors.ServiceUnavailableif the system is unable to communicate with a service to complete the request.
vmware.vapi.std.errors.Unauthenticatedif the user can not be authenticated.
vmware.vapi.std.errors.Unauthorizedif the user doesn't have the required privileges.
Parameters:
vmThe unique identifier of the virtual machine that needs to be customized. The parameter must be an identifier for the resource type: VirtualMachine .
specThe customization settings to be applied to the guest operating system.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation

Implements vmware::vcenter::vm::guest::Customization.


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