com.vmware.vcenter.vm.hardware

Interface Cpu

All Superinterfaces:

CpuTypes, Service

All Known Implementing Classes:

CpuStub

public interface Cpu
extends Service, CpuTypes

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

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.vm.hardware.CpuTypes

CpuTypes.Info, CpuTypes.UpdateSpec

Method Summary

Methods

Modifier and Type	Method and Description
CpuTypes.Info	get(String vm) Returns the CPU-related settings of a virtual machine.
void	get(String vm, AsyncCallback<CpuTypes.Info> asyncCallback) Returns the CPU-related settings of a virtual machine.
void	get(String vm, AsyncCallback<CpuTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the CPU-related settings of a virtual machine.
CpuTypes.Info	get(String vm, InvocationConfig invocationConfig) Returns the CPU-related settings of a virtual machine.
void	update(String vm, CpuTypes.UpdateSpec spec) Updates the CPU-related settings of a virtual machine.
void	update(String vm, CpuTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback) Updates the CPU-related settings of a virtual machine.
void	update(String vm, CpuTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Updates the CPU-related settings of a virtual machine.
void	update(String vm, CpuTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the CPU-related settings of a virtual machine.

Method Detail

get

CpuTypes.Info get(String vm)

Returns the CPU-related settings of a virtual machine.

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

Parameters:

vm - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

Returns:

CPU-related settings of the virtual machine.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.

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.

get

CpuTypes.Info get(String vm,
                InvocationConfig invocationConfig)

Returns the CPU-related settings of a virtual machine.

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 - Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

invocationConfig - Configuration for the method invocation.

Returns:

CPU-related settings of the virtual machine.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.

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.

get

void get(String vm,
       AsyncCallback<CpuTypes.Info> asyncCallback)

Returns the CPU-related settings of a virtual machine.

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

Operation Result:
CPU-related settings of the virtual machine.

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

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

get

void get(String vm,
       AsyncCallback<CpuTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Returns the CPU-related settings of a virtual machine.

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

Operation Result:
CPU-related settings of the virtual machine.

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

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

invocationConfig - Configuration for the method invocation.

update

void update(String vm,
          CpuTypes.UpdateSpec spec)

Updates the CPU-related settings of a virtual machine.

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

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.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

InvalidArgument - if one of the provided settings is not permitted; for example, specifying a negative value for getCount().

NotAllowedInCurrentState - if getHotAddEnabled() or getHotRemoveEnabled() is specified and the virtual machine is not powered off.

NotAllowedInCurrentState - if getCount() is specified and is greater than getCount(), getHotAddEnabled() is false, and the virtual machine is not powered off.

NotAllowedInCurrentState - if getCount() is specified and is less than getCount(), getHotRemoveEnabled() is false, and the virtual machine is not powered off.

ResourceBusy - if the virtual machine is busy performing another operation.

ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.

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.

update

void update(String vm,
          CpuTypes.UpdateSpec spec,
          InvocationConfig invocationConfig)

Updates the CPU-related settings of a virtual machine.

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 - 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.

invocationConfig - Configuration for the method invocation.

Throws:

Error - if the system reports an error while responding to the request.

NotFound - if the virtual machine is not found.

InvalidArgument - if one of the provided settings is not permitted; for example, specifying a negative value for getCount().

NotAllowedInCurrentState - if getHotAddEnabled() or getHotRemoveEnabled() is specified and the virtual machine is not powered off.

NotAllowedInCurrentState - if getCount() is specified and is greater than getCount(), getHotAddEnabled() is false, and the virtual machine is not powered off.

NotAllowedInCurrentState - if getCount() is specified and is less than getCount(), getHotRemoveEnabled() is false, and the virtual machine is not powered off.

ResourceBusy - if the virtual machine is busy performing another operation.

ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.

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.

update

void update(String vm,
          CpuTypes.UpdateSpec spec,
          AsyncCallback<Void> asyncCallback)

Updates the CPU-related settings of a virtual machine.

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

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
InvalidArgument - if one of the provided settings is not permitted; for example, specifying a negative value for getCount().
NotAllowedInCurrentState - if getHotAddEnabled() or getHotRemoveEnabled() is specified and the virtual machine is not powered off.
NotAllowedInCurrentState - if getCount() is specified and is greater than getCount(), getHotAddEnabled() is false, and the virtual machine is not powered off.
NotAllowedInCurrentState - if getCount() is specified and is less than getCount(), getHotRemoveEnabled() is false, and the virtual machine is not powered off.
ResourceBusy - if the virtual machine is busy performing another operation.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
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 - 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.

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

update

void update(String vm,
          CpuTypes.UpdateSpec spec,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Updates the CPU-related settings of a virtual machine.

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:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
InvalidArgument - if one of the provided settings is not permitted; for example, specifying a negative value for getCount().
NotAllowedInCurrentState - if getHotAddEnabled() or getHotRemoveEnabled() is specified and the virtual machine is not powered off.
NotAllowedInCurrentState - if getCount() is specified and is greater than getCount(), getHotAddEnabled() is false, and the virtual machine is not powered off.
NotAllowedInCurrentState - if getCount() is specified and is less than getCount(), getHotRemoveEnabled() is false, and the virtual machine is not powered off.
ResourceBusy - if the virtual machine is busy performing another operation.
ResourceInaccessible - if the virtual machine's configuration state cannot be accessed.
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 - 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.

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

invocationConfig - Configuration for the method invocation.