com.vmware.vcenter.vm.hardware.adapter

Class ScsiStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.vcenter.vm.hardware.adapter.ScsiStub

All Implemented Interfaces:

Service, Scsi, ScsiTypes

public class ScsiStub
extends com.vmware.vapi.internal.bindings.Stub
implements Scsi

Remote stub implementation of the Scsi API service.

WARNING: Internal API, subject to change in future versions.

Nested Class Summary

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

ScsiTypes.CreateSpec, ScsiTypes.Info, ScsiTypes.Sharing, ScsiTypes.Summary, ScsiTypes.Type, ScsiTypes.UpdateSpec

Field Summary

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

RESOURCE_TYPE

Constructor Summary

Constructors

Constructor and Description
ScsiStub(ApiProvider apiProvider, StubConfigurationBase config)

Method Summary

Methods

Modifier and Type	Method and Description
String	create(String vm, ScsiTypes.CreateSpec spec) Adds a virtual SCSI adapter to the virtual machine.
void	create(String vm, ScsiTypes.CreateSpec spec, AsyncCallback<String> asyncCallback) Adds a virtual SCSI adapter to the virtual machine.
void	create(String vm, ScsiTypes.CreateSpec spec, AsyncCallback<String> asyncCallback, InvocationConfig invocationConfig) Adds a virtual SCSI adapter to the virtual machine.
String	create(String vm, ScsiTypes.CreateSpec spec, InvocationConfig invocationConfig) Adds a virtual SCSI adapter to the virtual machine.
void	delete(String vm, String adapter) Removes a virtual SCSI adapter from the virtual machine.
void	delete(String vm, String adapter, AsyncCallback<Void> asyncCallback) Removes a virtual SCSI adapter from the virtual machine.
void	delete(String vm, String adapter, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Removes a virtual SCSI adapter from the virtual machine.
void	delete(String vm, String adapter, InvocationConfig invocationConfig) Removes a virtual SCSI adapter from the virtual machine.
ScsiTypes.Info	get(String vm, String adapter) Returns information about a virtual SCSI adapter.
void	get(String vm, String adapter, AsyncCallback<ScsiTypes.Info> asyncCallback) Returns information about a virtual SCSI adapter.
void	get(String vm, String adapter, AsyncCallback<ScsiTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information about a virtual SCSI adapter.
ScsiTypes.Info	get(String vm, String adapter, InvocationConfig invocationConfig) Returns information about a virtual SCSI adapter.
List<ScsiTypes.Summary>	list(String vm) Returns commonly used information about the virtual SCSI adapters belonging to the virtual machine.
void	list(String vm, AsyncCallback<List<ScsiTypes.Summary>> asyncCallback) Returns commonly used information about the virtual SCSI adapters belonging to the virtual machine.
void	list(String vm, AsyncCallback<List<ScsiTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns commonly used information about the virtual SCSI adapters belonging to the virtual machine.
List<ScsiTypes.Summary>	list(String vm, InvocationConfig invocationConfig) Returns commonly used information about the virtual SCSI adapters belonging to the virtual machine.
void	update(String vm, String adapter, ScsiTypes.UpdateSpec spec) Updates the configuration of a virtual SCSI adapter.
void	update(String vm, String adapter, ScsiTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback) Updates the configuration of a virtual SCSI adapter.
void	update(String vm, String adapter, ScsiTypes.UpdateSpec spec, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig) Updates the configuration of a virtual SCSI adapter.
void	update(String vm, String adapter, ScsiTypes.UpdateSpec spec, InvocationConfig invocationConfig) Updates the configuration of a virtual SCSI adapter.

Methods inherited from class com.vmware.vapi.internal.bindings.Stub

toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ScsiStub

public ScsiStub(ApiProvider apiProvider,
        StubConfigurationBase config)

Method Detail

list

public List<ScsiTypes.Summary> list(String vm)

Description copied from interface: Scsi

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

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

Specified by:

list in interface Scsi

Parameters:

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

Returns:

List of commonly used information about virtual SCSI adapters.

list

public List<ScsiTypes.Summary> list(String vm,
                           InvocationConfig invocationConfig)

Description copied from interface: Scsi

Returns commonly used information about the virtual SCSI 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.

Specified by:

list in interface Scsi

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

list

public void list(String vm,
        AsyncCallback<List<ScsiTypes.Summary>> asyncCallback)

Description copied from interface: Scsi

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

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

Operation Result:
List of commonly used information about virtual SCSI 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.

Specified by:

list in interface Scsi

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

public void list(String vm,
        AsyncCallback<List<ScsiTypes.Summary>> asyncCallback,
        InvocationConfig invocationConfig)

Description copied from interface: Scsi

Returns commonly used information about the virtual SCSI 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.

Operation Result:
List of commonly used information about virtual SCSI 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.

Specified by:

list in interface Scsi

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

public ScsiTypes.Info get(String vm,
                 String adapter)

Description copied from interface: Scsi

Returns information about a virtual SCSI adapter.

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

Specified by:

get in interface Scsi

Parameters:

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

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

Returns:

Information about the specified virtual SCSI adapter.

get

public ScsiTypes.Info get(String vm,
                 String adapter,
                 InvocationConfig invocationConfig)

Description copied from interface: Scsi

Returns information about a virtual SCSI 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.

Specified by:

get in interface Scsi

Parameters:

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

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

invocationConfig - Configuration for the method invocation.

Returns:

Information about the specified virtual SCSI adapter.

get

public void get(String vm,
       String adapter,
       AsyncCallback<ScsiTypes.Info> asyncCallback)

Description copied from interface: Scsi

Returns information about a virtual SCSI adapter.

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

Operation Result:
Information about the specified virtual SCSI adapter.

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

Specified by:

get in interface Scsi

Parameters:

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

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

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

get

public void get(String vm,
       String adapter,
       AsyncCallback<ScsiTypes.Info> asyncCallback,
       InvocationConfig invocationConfig)

Description copied from interface: Scsi

Returns information about a virtual SCSI adapter.

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:
Information about the specified virtual SCSI adapter.

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

Specified by:

get in interface Scsi

Parameters:

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

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

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

invocationConfig - Configuration for the method invocation.

create

public String create(String vm,
            ScsiTypes.CreateSpec spec)

Description copied from interface: Scsi

Adds a virtual SCSI adapter to the virtual machine.

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

Specified by:

create in interface Scsi

Parameters:

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

spec - Specification for the new virtual SCSI adapter.

Returns:

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

create

public String create(String vm,
            ScsiTypes.CreateSpec spec,
            InvocationConfig invocationConfig)

Description copied from interface: Scsi

Adds a virtual SCSI 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.

Specified by:

create in interface Scsi

Parameters:

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

spec - Specification for the new virtual SCSI adapter.

invocationConfig - Configuration for the method invocation.

Returns:

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

create

public void create(String vm,
          ScsiTypes.CreateSpec spec,
          AsyncCallback<String> asyncCallback)

Description copied from interface: Scsi

Adds a virtual SCSI adapter to the virtual machine.

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

Operation Result:
Virtual SCSI adapter identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter.

Operation Errors:
Error - if the system reported that the SCSI adapter was created but was unable to confirm the creation because the identifier of the new adapter could not be determined.
Error - if the system reports an error while responding to the request.
NotAllowedInCurrentState - if the virtual machine is suspended
NotFound - if the virtual machine is not found.
UnableToAllocateResource - if there are no more available SCSI buses on the virtual machine.
ResourceInUse - if the specified SCSI bus 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.

Specified by:

create in interface Scsi

Parameters:

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

spec - Specification for the new virtual SCSI adapter.

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

create

public void create(String vm,
          ScsiTypes.CreateSpec spec,
          AsyncCallback<String> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: Scsi

Adds a virtual SCSI 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.

Operation Result:
Virtual SCSI adapter identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter.

Operation Errors:
Error - if the system reported that the SCSI adapter was created but was unable to confirm the creation because the identifier of the new adapter could not be determined.
Error - if the system reports an error while responding to the request.
NotAllowedInCurrentState - if the virtual machine is suspended
NotFound - if the virtual machine is not found.
UnableToAllocateResource - if there are no more available SCSI buses on the virtual machine.
ResourceInUse - if the specified SCSI bus 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.

Specified by:

create in interface Scsi

Parameters:

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

spec - Specification for the new virtual SCSI adapter.

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

invocationConfig - Configuration for the method invocation.

update

public void update(String vm,
          String adapter,
          ScsiTypes.UpdateSpec spec)

Description copied from interface: Scsi

Updates the configuration of a virtual SCSI adapter.

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

Specified by:

update in interface Scsi

Parameters:

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

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

spec - Specification for updating the virtual SCSI adapter.

update

public void update(String vm,
          String adapter,
          ScsiTypes.UpdateSpec spec,
          InvocationConfig invocationConfig)

Description copied from interface: Scsi

Updates the configuration of a virtual SCSI 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.

Specified by:

update in interface Scsi

Parameters:

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

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

spec - Specification for updating the virtual SCSI adapter.

invocationConfig - Configuration for the method invocation.

update

public void update(String vm,
          String adapter,
          ScsiTypes.UpdateSpec spec,
          AsyncCallback<Void> asyncCallback)

Description copied from interface: Scsi

Updates the configuration of a virtual SCSI adapter.

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 or virtual SCSI adapter is not found.
NotAllowedInCurrentState - if one or more of the properties specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual SCSI adapter.
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.

Specified by:

update in interface Scsi

Parameters:

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

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

spec - Specification for updating the virtual SCSI adapter.

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

update

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

Description copied from interface: Scsi

Updates the configuration of a virtual SCSI adapter.

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 or virtual SCSI adapter is not found.
NotAllowedInCurrentState - if one or more of the properties specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual SCSI adapter.
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.

Specified by:

update in interface Scsi

Parameters:

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

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

spec - Specification for updating the virtual SCSI adapter.

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(String vm,
          String adapter)

Description copied from interface: Scsi

Removes a virtual SCSI adapter from the virtual machine.

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

Specified by:

delete in interface Scsi

Parameters:

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

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

delete

public void delete(String vm,
          String adapter,
          InvocationConfig invocationConfig)

Description copied from interface: Scsi

Removes a virtual SCSI 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.

Specified by:

delete in interface Scsi

Parameters:

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

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

invocationConfig - Configuration for the method invocation.

delete

public void delete(String vm,
          String adapter,
          AsyncCallback<Void> asyncCallback)

Description copied from interface: Scsi

Removes a virtual SCSI 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 SCSI 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.

Specified by:

delete in interface Scsi

Parameters:

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

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

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

delete

public void delete(String vm,
          String adapter,
          AsyncCallback<Void> asyncCallback,
          InvocationConfig invocationConfig)

Description copied from interface: Scsi

Removes a virtual SCSI 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 SCSI 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.

Specified by:

delete in interface Scsi

Parameters:

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

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

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

invocationConfig - Configuration for the method invocation.