com.vmware.vcenter.vm.hardware

Interface Disk

All Superinterfaces:

DiskTypes, Service

All Known Implementing Classes:

DiskStub

public interface Disk
extends Service, DiskTypes

The Disk interface provides methods for configuring the virtual disks of a virtual machine. A virtual disk has a backing such as a VMDK file. The backing has an independent lifecycle from the virtual machine when it is detached from the virtual machine. The create(java.lang.String, com.vmware.vcenter.vm.hardware.DiskTypes.CreateSpec) method provides the ability to create a new virtual disk. When creating a virtual disk, a new VMDK file may be created or an existing VMDK file may used as a backing. Once a VMDK file is associated with a virtual machine, its lifecycle will be bound to the virtual machine. In other words, it will be deleted when the virtual machine is deleted. The delete(java.lang.String, java.lang.String) method provides the ability to detach a VMDK file from the virtual machine. The delete(java.lang.String, java.lang.String) method does not delete the VMDK file that backs the virtual disk. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

Nested Class Summary

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

DiskTypes.BackingInfo, DiskTypes.BackingSpec, DiskTypes.BackingType, DiskTypes.CreateSpec, DiskTypes.HostBusAdapterType, DiskTypes.Info, DiskTypes.StoragePolicySpec, DiskTypes.Summary, DiskTypes.UpdateSpec, DiskTypes.VmdkCreateSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.vm.hardware.DiskTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

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

Method Detail

list

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

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

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<DiskTypes.Summary> list(java.lang.String vm,
                                       InvocationConfig invocationConfig)

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

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<DiskTypes.Summary>> asyncCallback)

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

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<DiskTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

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

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

DiskTypes.Info get(java.lang.String vm,
                   java.lang.String disk)

Returns information about a virtual disk.

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.

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

Returns:

Information about the specified virtual disk.

Throws:

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

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

DiskTypes.Info get(java.lang.String vm,
                   java.lang.String disk,
                   InvocationConfig invocationConfig)

Returns information about a virtual disk.

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.

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

invocationConfig - Configuration for the method invocation.

Returns:

Information about the specified virtual disk.

Throws:

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

NotFound - if the virtual machine or virtual disk 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 disk,
         AsyncCallback<DiskTypes.Info> asyncCallback)

Returns information about a virtual disk.

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

Invocation Result:
Information about the specified virtual disk.

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

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

get

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

Returns information about a virtual disk.

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

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

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

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,
                        DiskTypes.CreateSpec spec)

Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk.

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

Returns:

Virtual disk identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

Throws:

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

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 suspended or if the virtual machine is powered on and virtual disk type is IDE.

UnableToAllocateResource - if the specified storage address is unavailable; for example, if the SCSI adapter requested does not exist.

ResourceInUse - if the specified storage address is in use.

InvalidArgument - if the specified storage address is out of bounds or if the specified storage policy is invalid.

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,
                        DiskTypes.CreateSpec spec,
                        InvocationConfig invocationConfig)

Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk.

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

invocationConfig - Configuration for the method invocation.

Returns:

Virtual disk identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

Throws:

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

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 suspended or if the virtual machine is powered on and virtual disk type is IDE.

UnableToAllocateResource - if the specified storage address is unavailable; for example, if the SCSI adapter requested does not exist.

ResourceInUse - if the specified storage address is in use.

InvalidArgument - if the specified storage address is out of bounds or if the specified storage policy is invalid.

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,
            DiskTypes.CreateSpec spec,
            AsyncCallback<java.lang.String> asyncCallback)

Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk.

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

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

Operation Errors:
Error - if system reported that the disk device was created but was unable to confirm the creation because the identifier of the new device could not be determined.
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 suspended or if the virtual machine is powered on and virtual disk type is IDE.
UnableToAllocateResource - if the specified storage address is unavailable; for example, if the SCSI adapter requested does not exist.
ResourceInUse - if the specified storage address is in use.
InvalidArgument - if the specified storage address is out of bounds or if the specified storage policy is invalid.
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 disk.

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

create

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

Adds a virtual disk to the virtual machine. While adding the virtual disk, a new VMDK file may be created or an existing VMDK file may be used to back the virtual disk.

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 disk identifier. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

Operation Errors:
Error - if system reported that the disk device was created but was unable to confirm the creation because the identifier of the new device could not be determined.
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 suspended or if the virtual machine is powered on and virtual disk type is IDE.
UnableToAllocateResource - if the specified storage address is unavailable; for example, if the SCSI adapter requested does not exist.
ResourceInUse - if the specified storage address is in use.
InvalidArgument - if the specified storage address is out of bounds or if the specified storage policy is invalid.
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 disk.

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

invocationConfig - Configuration for the method invocation.

update

void update(java.lang.String vm,
            java.lang.String disk,
            DiskTypes.UpdateSpec spec)

Updates the configuration of a virtual disk. An update method can be used to detach the existing VMDK file and attach another VMDK file 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.

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

spec - Specification for updating the virtual disk.

Throws:

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

NotFound - if the virtual machine or virtual disk 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 disk.

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(java.lang.String vm,
            java.lang.String disk,
            DiskTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Updates the configuration of a virtual disk. An update method can be used to detach the existing VMDK file and attach another VMDK file 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.

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

spec - Specification for updating the virtual disk.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotFound - if the virtual machine or virtual disk 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 disk.

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(java.lang.String vm,
            java.lang.String disk,
            DiskTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Updates the configuration of a virtual disk. An update method can be used to detach the existing VMDK file and attach another VMDK file to 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.
NotFound - if the virtual machine or virtual disk 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 disk.
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.

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

spec - Specification for updating the virtual disk.

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

update

void update(java.lang.String vm,
            java.lang.String disk,
            DiskTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Updates the configuration of a virtual disk. An update method can be used to detach the existing VMDK file and attach another VMDK file 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 Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine or virtual disk 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 disk.
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.

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

spec - Specification for updating the virtual disk.

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 disk)

Removes a virtual disk from the virtual machine. This method does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

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.

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

Throws:

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

NotFound - if the virtual machine or virtual disk is not found.

NotAllowedInCurrentState - if the virtual machine is suspended or if the virtual machine is powered on and virtual disk type is IDE.

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 disk,
            InvocationConfig invocationConfig)

Removes a virtual disk from the virtual machine. This method does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

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.

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

invocationConfig - Configuration for the method invocation.

Throws:

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

NotFound - if the virtual machine or virtual disk is not found.

NotAllowedInCurrentState - if the virtual machine is suspended or if the virtual machine is powered on and virtual disk type is IDE.

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 disk,
            AsyncCallback<java.lang.Void> asyncCallback)

Removes a virtual disk from the virtual machine. This method does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

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 disk is not found.
NotAllowedInCurrentState - if the virtual machine is suspended or if the virtual machine is powered on and virtual disk type is IDE.
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.

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

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

delete

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

Removes a virtual disk from the virtual machine. This method does not destroy the VMDK file that backs the virtual disk. It only detaches the VMDK file from the virtual machine. Once detached, the VMDK file will not be destroyed when the virtual machine to which it was associated is deleted.

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 disk is not found.
NotAllowedInCurrentState - if the virtual machine is suspended or if the virtual machine is powered on and virtual disk type is IDE.
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.

disk - Virtual disk identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.

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

invocationConfig - Configuration for the method invocation.