vmware::vcenter::vm::hardware::Cpu Interface Reference

The Cpu interface provides methods for configuring the CPU settings of a virtual machine. More...

Inherited by vmware::vcenter::vm::hardware::CpuStub.

List of all members.

Public Member Functions
vmware.vcenter.vm.hardware.CpuTypes.Info	Get (string vm)
	Returns the CPU-related settings of a virtual machine.
vmware.vcenter.vm.hardware.CpuTypes.Info	Get (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the CPU-related settings of a virtual machine.
global::System.Threading.Tasks.Task < vmware.vcenter.vm.hardware.CpuTypes.Info >	GetAsync (string vm)
	Returns the CPU-related settings of a virtual machine.
global::System.Threading.Tasks.Task < vmware.vcenter.vm.hardware.CpuTypes.Info >	GetAsync (string vm, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Returns the CPU-related settings of a virtual machine.
void	Update (string vm, vmware.vcenter.vm.hardware.CpuTypes.UpdateSpec spec)
	Updates the CPU-related settings of a virtual machine.
void	Update (string vm, vmware.vcenter.vm.hardware.CpuTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Updates the CPU-related settings of a virtual machine.
global::System.Threading.Tasks.Task	UpdateAsync (string vm, vmware.vcenter.vm.hardware.CpuTypes.UpdateSpec spec)
	Updates the CPU-related settings of a virtual machine.
global::System.Threading.Tasks.Task	UpdateAsync (string vm, vmware.vcenter.vm.hardware.CpuTypes.UpdateSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
	Updates the CPU-related settings of a virtual machine.

---

Detailed Description

The Cpu interface provides methods for configuring the CPU settings of a virtual machine.

---

Member Function Documentation

vmware.vcenter.vm.hardware.CpuTypes.Info vmware::vcenter::vm::hardware::Cpu::Get

(

string

vm

)

Returns the CPU-related 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:

CPU-related settings of the virtual machine.

Implemented in vmware::vcenter::vm::hardware::CpuStub.

vmware.vcenter.vm.hardware.CpuTypes.Info vmware::vcenter::vm::hardware::Cpu::Get	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the CPU-related 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:

CPU-related settings of the virtual machine.

Implemented in vmware::vcenter::vm::hardware::CpuStub.

global::System.Threading.Tasks.Task<vmware.vcenter.vm.hardware.CpuTypes.Info> vmware::vcenter::vm::hardware::Cpu::GetAsync	(	string	vm,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Returns the CPU-related 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:

CPU-related settings of the virtual machine.

Implemented in vmware::vcenter::vm::hardware::CpuStub.

global::System.Threading.Tasks.Task<vmware.vcenter.vm.hardware.CpuTypes.Info> vmware::vcenter::vm::hardware::Cpu::GetAsync

(

string

vm

)

Returns the CPU-related 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:

CPU-related settings of the virtual machine.

Implemented in vmware::vcenter::vm::hardware::CpuStub.

void vmware::vcenter::vm::hardware::Cpu::Update	(	string	vm,
		vmware.vcenter.vm.hardware.CpuTypes.UpdateSpec	spec
	)

Updates the CPU-related 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.InvalidArgument	if one of the provided settings is not permitted; for example, specifying a negative value for count .
vmware.vapi.std.errors.NotAllowedInCurrentState	if hotAddEnabled or hotRemoveEnabled is specified and the virtual machine is not powered off.
vmware.vapi.std.errors.NotAllowedInCurrentState	if count is specified and is greater than count , hotAddEnabled is false, and the virtual machine is not powered off.
vmware.vapi.std.errors.NotAllowedInCurrentState	if count is specified and is less than count , hotRemoveEnabled is false, and the virtual machine is not powered off.
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 CPU-related settings of the virtual machine.

Implemented in vmware::vcenter::vm::hardware::CpuStub.

void vmware::vcenter::vm::hardware::Cpu::Update	(	string	vm,
		vmware.vcenter.vm.hardware.CpuTypes.UpdateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Updates the CPU-related 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.InvalidArgument	if one of the provided settings is not permitted; for example, specifying a negative value for count .
vmware.vapi.std.errors.NotAllowedInCurrentState	if hotAddEnabled or hotRemoveEnabled is specified and the virtual machine is not powered off.
vmware.vapi.std.errors.NotAllowedInCurrentState	if count is specified and is greater than count , hotAddEnabled is false, and the virtual machine is not powered off.
vmware.vapi.std.errors.NotAllowedInCurrentState	if count is specified and is less than count , hotRemoveEnabled is false, and the virtual machine is not powered off.
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 CPU-related settings of the virtual machine.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vm::hardware::CpuStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::hardware::Cpu::UpdateAsync	(	string	vm,
		vmware.vcenter.vm.hardware.CpuTypes.UpdateSpec	spec,
		global::System.Action< vmware.vapi.std.Progress >	_progress,
		vmware.vapi.bindings.client.InvocationConfig	_invocationConfig
	)

Updates the CPU-related 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.InvalidArgument	if one of the provided settings is not permitted; for example, specifying a negative value for count .
vmware.vapi.std.errors.NotAllowedInCurrentState	if hotAddEnabled or hotRemoveEnabled is specified and the virtual machine is not powered off.
vmware.vapi.std.errors.NotAllowedInCurrentState	if count is specified and is greater than count , hotAddEnabled is false, and the virtual machine is not powered off.
vmware.vapi.std.errors.NotAllowedInCurrentState	if count is specified and is less than count , hotRemoveEnabled is false, and the virtual machine is not powered off.
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 CPU-related settings of the virtual machine.
_progress	Progress notification call back
_invocationConfig	Configuration for the method invocation

Implemented in vmware::vcenter::vm::hardware::CpuStub.

global::System.Threading.Tasks.Task vmware::vcenter::vm::hardware::Cpu::UpdateAsync	(	string	vm,
		vmware.vcenter.vm.hardware.CpuTypes.UpdateSpec	spec
	)

Updates the CPU-related 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.InvalidArgument	if one of the provided settings is not permitted; for example, specifying a negative value for count .
vmware.vapi.std.errors.NotAllowedInCurrentState	if hotAddEnabled or hotRemoveEnabled is specified and the virtual machine is not powered off.
vmware.vapi.std.errors.NotAllowedInCurrentState	if count is specified and is greater than count , hotAddEnabled is false, and the virtual machine is not powered off.
vmware.vapi.std.errors.NotAllowedInCurrentState	if count is specified and is less than count , hotRemoveEnabled is false, and the virtual machine is not powered off.
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 CPU-related settings of the virtual machine.

Implemented in vmware::vcenter::vm::hardware::CpuStub.

---

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

• vcenter/vm/hardware/Cpu.cs