com.vmware.vcenter.vm.hardware.adapter

Interface Sata

All Superinterfaces:

SataTypes, Service

All Known Implementing Classes:

SataStub

public interface Sata
extends Service, SataTypes

The Sata interface provides methods for configuring the virtual SATA adapters of a virtual machine.

Nested Class Summary

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

SataTypes.CreateSpec, SataTypes.Info, SataTypes.Summary, SataTypes.Type

Field Summary

Fields inherited from interface com.vmware.vcenter.vm.hardware.adapter.SataTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(java.lang.String vm, SataTypes.CreateSpec spec) Adds a virtual SATA adapter to the virtual machine.
void	create(java.lang.String vm, SataTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Adds a virtual SATA adapter to the virtual machine.
void	create(java.lang.String vm, SataTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Adds a virtual SATA adapter to the virtual machine.
java.lang.String	create(java.lang.String vm, SataTypes.CreateSpec spec, InvocationConfig invocationConfig) Adds a virtual SATA adapter to the virtual machine.
void	delete(java.lang.String vm, java.lang.String adapter) Removes a virtual SATA adapter from the virtual machine.
void	delete(java.lang.String vm, java.lang.String adapter, AsyncCallback<java.lang.Void> asyncCallback) Removes a virtual SATA adapter from the virtual machine.
void	delete(java.lang.String vm, java.lang.String adapter, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Removes a virtual SATA adapter from the virtual machine.
void	delete(java.lang.String vm, java.lang.String adapter, InvocationConfig invocationConfig) Removes a virtual SATA adapter from the virtual machine.
SataTypes.Info	get(java.lang.String vm, java.lang.String adapter) Returns information about a virtual SATA adapter.
void	get(java.lang.String vm, java.lang.String adapter, AsyncCallback<SataTypes.Info> asyncCallback) Returns information about a virtual SATA adapter.
void	get(java.lang.String vm, java.lang.String adapter, AsyncCallback<SataTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a virtual SATA adapter.
SataTypes.Info	get(java.lang.String vm, java.lang.String adapter, InvocationConfig invocationConfig) Returns information about a virtual SATA adapter.
java.util.List<SataTypes.Summary>	list(java.lang.String vm) Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.
void	list(java.lang.String vm, AsyncCallback<java.util.List<SataTypes.Summary>> asyncCallback) Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.
void	list(java.lang.String vm, AsyncCallback<java.util.List<SataTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.
java.util.List<SataTypes.Summary>	list(java.lang.String vm, InvocationConfig invocationConfig) Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.

Method Detail

list

java.util.List<SataTypes.Summary> list(java.lang.String vm)

Returns commonly used information about the virtual SATA adapters belonging to the 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:

List of commonly used information about virtual SATA adapters.

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.

list

java.util.List<SataTypes.Summary> list(java.lang.String vm,
                                       InvocationConfig invocationConfig)

Returns commonly used information about the virtual SATA adapters belonging to the 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:

List of commonly used information about virtual SATA adapters.

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.

list

void list(java.lang.String vm,
          AsyncCallback<java.util.List<SataTypes.Summary>> asyncCallback)

Returns commonly used information about the virtual SATA adapters belonging to the virtual machine.

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

Invocation Result:
List of commonly used information about virtual SATA adapters.

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.

list

void list(java.lang.String vm,
          AsyncCallback<java.util.List<SataTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns commonly used information about the virtual SATA adapters belonging to the 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.

Invocation Result:
List of commonly used information about virtual SATA adapters.

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.

get

SataTypes.Info get(java.lang.String vm,
                   java.lang.String adapter)

Returns information about a virtual SATA adapter.

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.

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

Returns:

Information about the specified virtual SATA adapter.

Throws:

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

NotFound - if the virtual machine or virtual SATA adapter 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

SataTypes.Info get(java.lang.String vm,
                   java.lang.String adapter,
                   InvocationConfig invocationConfig)

Returns information about a virtual SATA adapter.

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.

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the specified virtual SATA adapter.

Throws:

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

NotFound - if the virtual machine or virtual SATA adapter 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(java.lang.String vm,
         java.lang.String adapter,
         AsyncCallback<SataTypes.Info> asyncCallback)

Returns information about a virtual SATA adapter.

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

Invocation Result:
Information about the specified virtual SATA adapter.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine or virtual SATA adapter 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.

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

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

get

void get(java.lang.String vm,
         java.lang.String adapter,
         AsyncCallback<SataTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns information about a virtual SATA adapter.

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

Invocation Result:
Information about the specified virtual SATA adapter.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine or virtual SATA adapter 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.

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

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

invocationConfig - Configuration for the method invocation.

create

java.lang.String create(java.lang.String vm,
                        SataTypes.CreateSpec spec)

Adds a virtual SATA adapter to the 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 the new virtual SATA adapter.

Returns:

Virtual SATA adapter identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

Throws:

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

Error - if the system reported that the SATA adapter was created but was unable to confirm the creation because the identifier of the new adapter could not be determined.

NotAllowedInCurrentState - if the virtual machine is suspended

NotFound - if the virtual machine is not found.

UnableToAllocateResource - if there are no more available SATA buses on the virtual machine.

ResourceInUse - if the specified SATA bus or PCI address is in use.

InvalidArgument - if the specified SATA bus or PCI address is out of bounds.

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.

Unsupported - if the guest operating system of the virtual machine is not supported and spec includes null properties that default to guest-specific values.

create

java.lang.String create(java.lang.String vm,
                        SataTypes.CreateSpec spec,
                        InvocationConfig invocationConfig)

Adds a virtual SATA adapter to the 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 the new virtual SATA adapter.

invocationConfig - Configuration for the method invocation.

Returns:

Virtual SATA adapter identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

Throws:

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

Error - if the system reported that the SATA adapter was created but was unable to confirm the creation because the identifier of the new adapter could not be determined.

NotAllowedInCurrentState - if the virtual machine is suspended

NotFound - if the virtual machine is not found.

UnableToAllocateResource - if there are no more available SATA buses on the virtual machine.

ResourceInUse - if the specified SATA bus or PCI address is in use.

InvalidArgument - if the specified SATA bus or PCI address is out of bounds.

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.

Unsupported - if the guest operating system of the virtual machine is not supported and spec includes null properties that default to guest-specific values.

create

void create(java.lang.String vm,
            SataTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback)

Adds a virtual SATA adapter to the virtual machine.

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

Invocation Result:
Virtual SATA adapter identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

Operation Errors:
Error - if the system reports an error while responding to the request.
Error - if the system reported that the SATA adapter was created but was unable to confirm the creation because the identifier of the new adapter could not be determined.
NotAllowedInCurrentState - if the virtual machine is suspended
NotFound - if the virtual machine is not found.
UnableToAllocateResource - if there are no more available SATA buses on the virtual machine.
ResourceInUse - if the specified SATA bus or PCI address is in use.
InvalidArgument - if the specified SATA bus or PCI address is out of bounds.
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.
Unsupported - if the guest operating system of the virtual machine is not supported and spec includes null properties that default to guest-specific values.

Parameters:

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

spec - Specification for the new virtual SATA adapter.

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

create

void create(java.lang.String vm,
            SataTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback,
            InvocationConfig invocationConfig)

Adds a virtual SATA adapter to the 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.

Invocation Result:
Virtual SATA adapter identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

Operation Errors:
Error - if the system reports an error while responding to the request.
Error - if the system reported that the SATA adapter was created but was unable to confirm the creation because the identifier of the new adapter could not be determined.
NotAllowedInCurrentState - if the virtual machine is suspended
NotFound - if the virtual machine is not found.
UnableToAllocateResource - if there are no more available SATA buses on the virtual machine.
ResourceInUse - if the specified SATA bus or PCI address is in use.
InvalidArgument - if the specified SATA bus or PCI address is out of bounds.
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.
Unsupported - if the guest operating system of the virtual machine is not supported and spec includes null properties that default to guest-specific values.

Parameters:

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

spec - Specification for the new virtual SATA adapter.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String vm,
            java.lang.String adapter)

Removes a virtual SATA adapter from the 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.

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

Throws:

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

NotAllowedInCurrentState - if the virtual machine is suspended

NotFound - if the virtual machine or virtual SATA adapter is not found.

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.

delete

void delete(java.lang.String vm,
            java.lang.String adapter,
            InvocationConfig invocationConfig)

Removes a virtual SATA adapter from the 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.

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotAllowedInCurrentState - if the virtual machine is suspended

NotFound - if the virtual machine or virtual SATA adapter is not found.

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.

delete

void delete(java.lang.String vm,
            java.lang.String adapter,
            AsyncCallback<java.lang.Void> asyncCallback)

Removes a virtual SATA adapter from the 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.
NotAllowedInCurrentState - if the virtual machine is suspended
NotFound - if the virtual machine or virtual SATA adapter is not found.
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.

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

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

delete

void delete(java.lang.String vm,
            java.lang.String adapter,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Removes a virtual SATA adapter from the 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.
NotAllowedInCurrentState - if the virtual machine is suspended
NotFound - if the virtual machine or virtual SATA adapter is not found.
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.

adapter - Virtual SATA adapter identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.

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

invocationConfig - Configuration for the method invocation.