vmware::vcenter::vm::HardwareStub Class Reference

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

Inherits vmware::vcenter::vm::Hardware.

List of all members.

Public Member Functions
	HardwareStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.TypeConverter typeConverter, vmware.vapi.bindings.IStubConfiguration config)
	HardwareStub (vmware.vapi.core.IApiProvider iApiProvider, vmware.vapi.bindings.IStubConfiguration config)
vmware.vcenter.vm.HardwareTypes.Info	Get (string vm)
	Returns the virtual hardware settings of a virtual machine.
vmware.vcenter.vm.HardwareTypes.Info	Get (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the virtual hardware settings of a virtual machine.
global::System.Threading.Tasks.Task < vmware.vcenter.vm.HardwareTypes.Info >	GetAsync (string vm)
	Returns the virtual hardware settings of a virtual machine.
global::System.Threading.Tasks.Task < vmware.vcenter.vm.HardwareTypes.Info >	GetAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the virtual hardware settings of a virtual machine.
void	Update (string vm, vmware.vcenter.vm.HardwareTypes.UpdateSpec spec)
	Updates the virtual hardware settings of a virtual machine.
void	Update (string vm, vmware.vcenter.vm.HardwareTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Updates the virtual hardware settings of a virtual machine.
global::System.Threading.Tasks.Task	UpdateAsync (string vm, vmware.vcenter.vm.HardwareTypes.UpdateSpec spec)
	Updates the virtual hardware settings of a virtual machine.
global::System.Threading.Tasks.Task	UpdateAsync (string vm, vmware.vcenter.vm.HardwareTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Updates the virtual hardware settings of a virtual machine.
void	Upgrade (string vm, vmware.vcenter.vm.HardwareTypes.Version version)
	Upgrades the virtual machine to a newer virtual hardware version.
void	Upgrade (string vm, vmware.vcenter.vm.HardwareTypes.Version version, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Upgrades the virtual machine to a newer virtual hardware version.
global::System.Threading.Tasks.Task	UpgradeAsync (string vm, vmware.vcenter.vm.HardwareTypes.Version version)
	Upgrades the virtual machine to a newer virtual hardware version.
global::System.Threading.Tasks.Task	UpgradeAsync (string vm, vmware.vcenter.vm.HardwareTypes.Version version, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Upgrades the virtual machine to a newer virtual hardware version.

---

Detailed Description

Remote stub implementation of the Hardware API service.

---

Constructor & Destructor Documentation

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

vmware::vcenter::vm::HardwareStub::HardwareStub	(	vmware.vapi.core.IApiProvider	iApiProvider,
		vmware.vapi.bindings.IStubConfiguration	config
	)		[inline]

---

Member Function Documentation

vmware.vcenter.vm.HardwareTypes.Info vmware::vcenter::vm::HardwareStub::Get

(

string

vm

)

[inline]

Returns the virtual hardware settings of a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
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	Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .

Returns:

Virtual hardware settings of the virtual machine.

Implements vmware::vcenter::vm::Hardware.

vmware.vcenter.vm.HardwareTypes.Info vmware::vcenter::vm::HardwareStub::Get	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Returns the virtual hardware settings of a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
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	Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Virtual hardware settings of the virtual machine.

Implements vmware::vcenter::vm::Hardware.

global::System.Threading.Tasks.Task<vmware.vcenter.vm.HardwareTypes.Info> vmware::vcenter::vm::HardwareStub::GetAsync	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Returns the virtual hardware settings of a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
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	Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Returns:

Virtual hardware settings of the virtual machine.

Implements vmware::vcenter::vm::Hardware.

global::System.Threading.Tasks.Task<vmware.vcenter.vm.HardwareTypes.Info> vmware::vcenter::vm::HardwareStub::GetAsync

(

string

vm

)

[inline]

Returns the virtual hardware settings of a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
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	Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .

Returns:

Virtual hardware settings of the virtual machine.

Implements vmware::vcenter::vm::Hardware.

void vmware::vcenter::vm::HardwareStub::Update	(	string	vm,
		vmware.vcenter.vm.HardwareTypes.UpdateSpec	spec
	)		[inline]

Updates the virtual hardware settings of a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredState	if the virtual machine is already configured for the desired hardware version.
vmware.vapi.std.errors.InvalidArgument	if the requested virtual hardware version is not newer than the current version.
vmware.vapi.std.errors.Unsupported	if the requested virtual hardware version is not supported by the server.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
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	Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
spec	Specification for updating the virtual hardware settings of the virtual machine.

Implements vmware::vcenter::vm::Hardware.

void vmware::vcenter::vm::HardwareStub::Update	(	string	vm,
		vmware.vcenter.vm.HardwareTypes.UpdateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Updates the virtual hardware settings of a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredState	if the virtual machine is already configured for the desired hardware version.
vmware.vapi.std.errors.InvalidArgument	if the requested virtual hardware version is not newer than the current version.
vmware.vapi.std.errors.Unsupported	if the requested virtual hardware version is not supported by the server.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
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	Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
spec	Specification for updating the virtual hardware settings of the virtual machine.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::vcenter::vm::Hardware.

global::System.Threading.Tasks.Task vmware::vcenter::vm::HardwareStub::UpdateAsync	(	string	vm,
		vmware.vcenter.vm.HardwareTypes.UpdateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Updates the virtual hardware settings of a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredState	if the virtual machine is already configured for the desired hardware version.
vmware.vapi.std.errors.InvalidArgument	if the requested virtual hardware version is not newer than the current version.
vmware.vapi.std.errors.Unsupported	if the requested virtual hardware version is not supported by the server.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
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	Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
spec	Specification for updating the virtual hardware settings of the virtual machine.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::vcenter::vm::Hardware.

global::System.Threading.Tasks.Task vmware::vcenter::vm::HardwareStub::UpdateAsync	(	string	vm,
		vmware.vcenter.vm.HardwareTypes.UpdateSpec	spec
	)		[inline]

Updates the virtual hardware settings of a virtual machine.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.AlreadyInDesiredState	if the virtual machine is already configured for the desired hardware version.
vmware.vapi.std.errors.InvalidArgument	if the requested virtual hardware version is not newer than the current version.
vmware.vapi.std.errors.Unsupported	if the requested virtual hardware version is not supported by the server.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
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	Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
spec	Specification for updating the virtual hardware settings of the virtual machine.

Implements vmware::vcenter::vm::Hardware.

void vmware::vcenter::vm::HardwareStub::Upgrade	(	string	vm,
		vmware.vcenter.vm.HardwareTypes.Version	version,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Upgrades the virtual machine to a newer virtual hardware version.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered off.
vmware.vapi.std.errors.AlreadyInDesiredState	if the virtual machine is already configured for the desired hardware version.
vmware.vapi.std.errors.InvalidArgument	if version is older than the current virtual hardware version.
vmware.vapi.std.errors.Unsupported	if version is not supported by the server.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
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	Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
version	New virtual machine version. If null, defaults to the most recent virtual hardware version supported by the server.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::vcenter::vm::Hardware.

void vmware::vcenter::vm::HardwareStub::Upgrade	(	string	vm,
		vmware.vcenter.vm.HardwareTypes.Version	version
	)		[inline]

Upgrades the virtual machine to a newer virtual hardware version.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered off.
vmware.vapi.std.errors.AlreadyInDesiredState	if the virtual machine is already configured for the desired hardware version.
vmware.vapi.std.errors.InvalidArgument	if version is older than the current virtual hardware version.
vmware.vapi.std.errors.Unsupported	if version is not supported by the server.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
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	Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
version	New virtual machine version. If null, defaults to the most recent virtual hardware version supported by the server.

Implements vmware::vcenter::vm::Hardware.

global::System.Threading.Tasks.Task vmware::vcenter::vm::HardwareStub::UpgradeAsync	(	string	vm,
		vmware.vcenter.vm.HardwareTypes.Version	version
	)		[inline]

Upgrades the virtual machine to a newer virtual hardware version.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered off.
vmware.vapi.std.errors.AlreadyInDesiredState	if the virtual machine is already configured for the desired hardware version.
vmware.vapi.std.errors.InvalidArgument	if version is older than the current virtual hardware version.
vmware.vapi.std.errors.Unsupported	if version is not supported by the server.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
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	Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
version	New virtual machine version. If null, defaults to the most recent virtual hardware version supported by the server.

Implements vmware::vcenter::vm::Hardware.

global::System.Threading.Tasks.Task vmware::vcenter::vm::HardwareStub::UpgradeAsync	(	string	vm,
		vmware.vcenter.vm.HardwareTypes.Version	version,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)		[inline]

Upgrades the virtual machine to a newer virtual hardware version.

Exceptions:

vmware.vapi.std.errors.Error	if the system reports an error while responding to the request.
vmware.vapi.std.errors.NotFound	if the virtual machine is not found.
vmware.vapi.std.errors.NotAllowedInCurrentState	if the virtual machine is not powered off.
vmware.vapi.std.errors.AlreadyInDesiredState	if the virtual machine is already configured for the desired hardware version.
vmware.vapi.std.errors.InvalidArgument	if version is older than the current virtual hardware version.
vmware.vapi.std.errors.Unsupported	if version is not supported by the server.
vmware.vapi.std.errors.ResourceBusy	if the virtual machine is busy performing another operation.
vmware.vapi.std.errors.ResourceInaccessible	if the virtual machine's configuration state cannot be accessed.
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	Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine .
version	New virtual machine version. If null, defaults to the most recent virtual hardware version supported by the server.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implements vmware::vcenter::vm::Hardware.

---

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

• HardwareStub.cs