com.vmware.vcenter.vm

Interface Hardware

All Superinterfaces:

HardwareTypes, Service

All Known Implementing Classes:

HardwareStub

public interface Hardware
extends Service, HardwareTypes

The Hardware interface provides methods for configuring the virtual hardware of a virtual machine.

Nested Class Summary

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

HardwareTypes.Info, HardwareTypes.UpdateSpec, HardwareTypes.UpgradePolicy, HardwareTypes.UpgradeStatus, HardwareTypes.Version

Method Summary

Methods

Modifier and Type	Method and Description
HardwareTypes.Info	get(String vm) Returns the virtual hardware settings of a virtual machine.
void	get(String vm, AsyncCallback<HardwareTypes.Info> asyncCallback) Returns the virtual hardware settings of a virtual machine.
void	get(String vm, AsyncCallback<HardwareTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the virtual hardware settings of a virtual machine.
HardwareTypes.Info	get(String vm, InvocationConfig invocationConfig) Returns the virtual hardware settings of a virtual machine.
void	update(String vm, HardwareTypes.UpdateSpec spec) Updates the virtual hardware settings of a virtual machine.
void	update(String vm, HardwareTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback) Updates the virtual hardware settings of a virtual machine.
void	update(String vm, HardwareTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Updates the virtual hardware settings of a virtual machine.
void	update(String vm, HardwareTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the virtual hardware settings of a virtual machine.
void	upgrade(String vm, HardwareTypes.Version version) Upgrades the virtual machine to a newer virtual hardware version.
void	upgrade(String vm, HardwareTypes.Version version, AsyncCallback<Void> asyncCallback) Upgrades the virtual machine to a newer virtual hardware version.
void	upgrade(String vm, HardwareTypes.Version version, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Upgrades the virtual machine to a newer virtual hardware version.
void	upgrade(String vm, HardwareTypes.Version version, InvocationConfig invocationConfig) Upgrades the virtual machine to a newer virtual hardware version.

Method Detail

get

HardwareTypes.Info get(String vm)

Returns the virtual hardware 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:

Virtual hardware 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

HardwareTypes.Info get(String vm,
                     InvocationConfig invocationConfig)

Returns the virtual hardware 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:

Virtual hardware 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<HardwareTypes.Info> asyncCallback)

Returns the virtual hardware settings of a virtual machine.

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

Operation Result:
Virtual hardware 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<HardwareTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Returns the virtual hardware 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:
Virtual hardware 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,
          HardwareTypes.UpdateSpec spec)

Updates the virtual hardware 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 virtual hardware 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.

AlreadyInDesiredState - if the virtual machine is already configured for the desired hardware version.

InvalidArgument - if the requested virtual hardware version is not newer than the current version.

Unsupported - if the requested virtual hardware version is not supported by the server.

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,
          HardwareTypes.UpdateSpec spec,
          InvocationConfig invocationConfig)

Updates the virtual hardware 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 virtual hardware 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.

AlreadyInDesiredState - if the virtual machine is already configured for the desired hardware version.

InvalidArgument - if the requested virtual hardware version is not newer than the current version.

Unsupported - if the requested virtual hardware version is not supported by the server.

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,
          HardwareTypes.UpdateSpec spec,
          AsyncCallback<Void> asyncCallback)

Updates the virtual hardware 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.
AlreadyInDesiredState - if the virtual machine is already configured for the desired hardware version.
InvalidArgument - if the requested virtual hardware version is not newer than the current version.
Unsupported - if the requested virtual hardware version is not supported by the server.
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 virtual hardware settings of the virtual machine.

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

update

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

Updates the virtual hardware 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.
AlreadyInDesiredState - if the virtual machine is already configured for the desired hardware version.
InvalidArgument - if the requested virtual hardware version is not newer than the current version.
Unsupported - if the requested virtual hardware version is not supported by the server.
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 virtual hardware settings of the virtual machine.

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

invocationConfig - Configuration for the method invocation.

upgrade

void upgrade(String vm,
           HardwareTypes.Version version)

Upgrades the virtual machine to a newer virtual hardware version.

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.

version - New virtual machine version. If null, defaults to the most recent virtual hardware version supported by the server.

Throws:

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

NotFound - if the virtual machine is not found.

NotAllowedInCurrentState - if the virtual machine is not powered off.

AlreadyInDesiredState - if the virtual machine is already configured for the desired hardware version.

InvalidArgument - if version is older than the current virtual hardware version.

Unsupported - if version is not supported by the server.

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.

upgrade

void upgrade(String vm,
           HardwareTypes.Version version,
           InvocationConfig invocationConfig)

Upgrades the virtual machine to a newer virtual hardware version.

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.

version - New virtual machine version. If null, defaults to the most recent virtual hardware version supported by the server.

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.

NotAllowedInCurrentState - if the virtual machine is not powered off.

AlreadyInDesiredState - if the virtual machine is already configured for the desired hardware version.

InvalidArgument - if version is older than the current virtual hardware version.

Unsupported - if version is not supported by the server.

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.

upgrade

void upgrade(String vm,
           HardwareTypes.Version version,
           AsyncCallback<Void> asyncCallback)

Upgrades the virtual machine to a newer virtual hardware version.

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.
NotAllowedInCurrentState - if the virtual machine is not powered off.
AlreadyInDesiredState - if the virtual machine is already configured for the desired hardware version.
InvalidArgument - if version is older than the current virtual hardware version.
Unsupported - if version is not supported by the server.
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.

version - New virtual machine version. If null, defaults to the most recent virtual hardware version supported by the server.

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

upgrade

void upgrade(String vm,
           HardwareTypes.Version version,
           AsyncCallback<Void> asyncCallback,
           InvocationConfig invocationConfig)

Upgrades the virtual machine to a newer virtual hardware version.

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.
NotAllowedInCurrentState - if the virtual machine is not powered off.
AlreadyInDesiredState - if the virtual machine is already configured for the desired hardware version.
InvalidArgument - if version is older than the current virtual hardware version.
Unsupported - if version is not supported by the server.
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.

version - New virtual machine version. If null, defaults to the most recent virtual hardware version supported by the server.

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

invocationConfig - Configuration for the method invocation.