com.vmware.vcenter.vm

Interface DataSets

All Superinterfaces:

DataSetsTypes, Service

All Known Implementing Classes:

DataSetsStub

public interface DataSets
extends Service, DataSetsTypes

The DataSets interface provides methods for sharing information between a virtual machine and its guest operating system.

See the VMware Guest SDK Programming Guide for details on using DataSets from within a virtual machine.

Information is grouped into data sets, each of which contains key-value entries comprising the data. It's expected that each application using the service will have at least one unique data set in which to store its data to avoid conflict with other applications. Each data set has attributes defining its access control and interoperability configuration.

It's not recommended that sensitive data (for example, passwords or private keys) be stored in plain-text. The data will be visible to other applications, running both on the management network and within the guest. The data can also be exposed by backups or templates.

Data set support requires the virtual machine be at virtual hardware version HardwareTypes.Version.VMX_20 or later.

Data sets should only be modified by the application that creates them. Otherwise the application may stop working.

. This interface was added in vSphere API 8.0.0.0.

Nested Class Summary

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

DataSetsTypes.Access, DataSetsTypes.CreateSpec, DataSetsTypes.Info, DataSetsTypes.Summary, DataSetsTypes.UpdateSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.vm.DataSetsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(java.lang.String vm, DataSetsTypes.CreateSpec spec) Creates a new data set.
void	create(java.lang.String vm, DataSetsTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Creates a new data set.
void	create(java.lang.String vm, DataSetsTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Creates a new data set.
java.lang.String	create(java.lang.String vm, DataSetsTypes.CreateSpec spec, InvocationConfig invocationConfig) Creates a new data set.
void	delete(java.lang.String vm, java.lang.String dataSet, java.lang.Boolean force) Delete a data set.
void	delete(java.lang.String vm, java.lang.String dataSet, java.lang.Boolean force, AsyncCallback<java.lang.Void> asyncCallback) Delete a data set.
void	delete(java.lang.String vm, java.lang.String dataSet, java.lang.Boolean force, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Delete a data set.
void	delete(java.lang.String vm, java.lang.String dataSet, java.lang.Boolean force, InvocationConfig invocationConfig) Delete a data set.
DataSetsTypes.Info	get(java.lang.String vm, java.lang.String dataSet) Returns information describing a data set.
void	get(java.lang.String vm, java.lang.String dataSet, AsyncCallback<DataSetsTypes.Info> asyncCallback) Returns information describing a data set.
void	get(java.lang.String vm, java.lang.String dataSet, AsyncCallback<DataSetsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns information describing a data set.
DataSetsTypes.Info	get(java.lang.String vm, java.lang.String dataSet, InvocationConfig invocationConfig) Returns information describing a data set.
java.util.List<DataSetsTypes.Summary>	list(java.lang.String vm) Lists the data sets of a virtual machine.
void	list(java.lang.String vm, AsyncCallback<java.util.List<DataSetsTypes.Summary>> asyncCallback) Lists the data sets of a virtual machine.
void	list(java.lang.String vm, AsyncCallback<java.util.List<DataSetsTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Lists the data sets of a virtual machine.
java.util.List<DataSetsTypes.Summary>	list(java.lang.String vm, InvocationConfig invocationConfig) Lists the data sets of a virtual machine.
void	update(java.lang.String vm, java.lang.String dataSet, DataSetsTypes.UpdateSpec spec) Modifies the attributes of a data set.
void	update(java.lang.String vm, java.lang.String dataSet, DataSetsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback) Modifies the attributes of a data set.
void	update(java.lang.String vm, java.lang.String dataSet, DataSetsTypes.UpdateSpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Modifies the attributes of a data set.
void	update(java.lang.String vm, java.lang.String dataSet, DataSetsTypes.UpdateSpec spec, InvocationConfig invocationConfig) Modifies the attributes of a data set.

Method Detail

create

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

Creates a new data set. This method was added in vSphere API 8.0.0.0.

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

Parameters:

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

spec - Specification of the data set to be created.

Returns:

The identifier of the new data set. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

Throws:

AlreadyExists - if the data set with the same name already exists.

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

InvalidArgument - if the specification is incorrect.

NotAllowedInCurrentState - if the virtual machine is in a state that doesn't allow modifications, for example suspended.

NotFound - if the virtual machine is not found.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

UnableToAllocateResource - if the new data set requires more resources than are available.

Unauthorized - if the user doesn't have the required privileges.

Unsupported - if the virtual hardware version of the virtual machine does not support DataSets

Unsupported - if the ESXi host version does not support DataSets

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetCreate.

create

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

Creates a new data set. This method was added in vSphere API 8.0.0.0.

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

spec - Specification of the data set to be created.

invocationConfig - Configuration for the method invocation.

Returns:

The identifier of the new data set. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

Throws:

AlreadyExists - if the data set with the same name already exists.

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

InvalidArgument - if the specification is incorrect.

NotAllowedInCurrentState - if the virtual machine is in a state that doesn't allow modifications, for example suspended.

NotFound - if the virtual machine is not found.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

UnableToAllocateResource - if the new data set requires more resources than are available.

Unauthorized - if the user doesn't have the required privileges.

Unsupported - if the virtual hardware version of the virtual machine does not support DataSets

Unsupported - if the ESXi host version does not support DataSets

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetCreate.

create

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

Creates a new data set. This method was added in vSphere API 8.0.0.0.

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

Invocation Result:
The identifier of the new data set. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

Operation Errors:
AlreadyExists - if the data set with the same name already exists.
Error - if the system reports an error while responding to the request.
InvalidArgument - if the specification is incorrect.
NotAllowedInCurrentState - if the virtual machine is in a state that doesn't allow modifications, for example suspended.
NotFound - if the virtual machine is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if the new data set requires more resources than are available.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetCreate.

Parameters:

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

spec - Specification of the data set to be created.

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

create

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

Creates a new data set. This method was added in vSphere API 8.0.0.0.

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:
The identifier of the new data set. The return value will be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

Operation Errors:
AlreadyExists - if the data set with the same name already exists.
Error - if the system reports an error while responding to the request.
InvalidArgument - if the specification is incorrect.
NotAllowedInCurrentState - if the virtual machine is in a state that doesn't allow modifications, for example suspended.
NotFound - if the virtual machine is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if the new data set requires more resources than are available.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetCreate.

Parameters:

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

spec - Specification of the data set to be created.

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 dataSet,
            java.lang.Boolean force)

Delete a data set. This method was added in vSphere API 8.0.0.0.

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

Parameters:

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

dataSet - Identifier of the data set to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

force - If true, delete the data set even if it is not empty. If null a ResourceInUse exception will be reported if the data set is not empty. This is the equivalent of passing the value false.

Throws:

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

NotAllowedInCurrentState - if the virtual machine is in a state that doesn't allow modifications, for example suspended.

NotFound - if the virtual machine is not found.

NotFound - if the data set is not found.

ResourceInUse - if the data set is not empty and force is not Set.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthorized - if the user doesn't have the required privileges.

Unsupported - if the virtual hardware version of the virtual machine does not support DataSets

Unsupported - if the ESXi host version does not support DataSets

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetDelete.

delete

void delete(java.lang.String vm,
            java.lang.String dataSet,
            java.lang.Boolean force,
            InvocationConfig invocationConfig)

Delete a data set. This method was added in vSphere API 8.0.0.0.

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

dataSet - Identifier of the data set to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

force - If true, delete the data set even if it is not empty. If null a ResourceInUse exception will be reported if the data set is not empty. This is the equivalent of passing the value false.

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 in a state that doesn't allow modifications, for example suspended.

NotFound - if the virtual machine is not found.

NotFound - if the data set is not found.

ResourceInUse - if the data set is not empty and force is not Set.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthorized - if the user doesn't have the required privileges.

Unsupported - if the virtual hardware version of the virtual machine does not support DataSets

Unsupported - if the ESXi host version does not support DataSets

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetDelete.

delete

void delete(java.lang.String vm,
            java.lang.String dataSet,
            java.lang.Boolean force,
            AsyncCallback<java.lang.Void> asyncCallback)

Delete a data set. This method was added in vSphere API 8.0.0.0.

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 in a state that doesn't allow modifications, for example suspended.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
ResourceInUse - if the data set is not empty and force is not Set.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetDelete.

Parameters:

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

dataSet - Identifier of the data set to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

force - If true, delete the data set even if it is not empty. If null a ResourceInUse exception will be reported if the data set is not empty. This is the equivalent of passing the value false.

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

delete

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

Delete a data set. This method was added in vSphere API 8.0.0.0.

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 in a state that doesn't allow modifications, for example suspended.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
ResourceInUse - if the data set is not empty and force is not Set.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetDelete.

Parameters:

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

dataSet - Identifier of the data set to be deleted. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

force - If true, delete the data set even if it is not empty. If null a ResourceInUse exception will be reported if the data set is not empty. This is the equivalent of passing the value false.

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

invocationConfig - Configuration for the method invocation.

get

DataSetsTypes.Info get(java.lang.String vm,
                       java.lang.String dataSet)

Returns information describing a data set. This method was added in vSphere API 8.0.0.0.

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

Parameters:

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

dataSet - Identifier of the data set to be queried. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

Returns:

Details about the data set.

Throws:

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

NotFound - if the virtual machine is not found.

NotFound - if the data set is not found.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthorized - if the user doesn't have the required privileges.

Unsupported - if the virtual hardware version of the virtual machine does not support DataSets

Unsupported - if the ESXi host version does not support DataSets

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetGet.

get

DataSetsTypes.Info get(java.lang.String vm,
                       java.lang.String dataSet,
                       InvocationConfig invocationConfig)

Returns information describing a data set. This method was added in vSphere API 8.0.0.0.

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

dataSet - Identifier of the data set to be queried. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

invocationConfig - Configuration for the method invocation.

Returns:

Details about the data set.

Throws:

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

NotFound - if the virtual machine is not found.

NotFound - if the data set is not found.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthorized - if the user doesn't have the required privileges.

Unsupported - if the virtual hardware version of the virtual machine does not support DataSets

Unsupported - if the ESXi host version does not support DataSets

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetGet.

get

void get(java.lang.String vm,
         java.lang.String dataSet,
         AsyncCallback<DataSetsTypes.Info> asyncCallback)

Returns information describing a data set. This method was added in vSphere API 8.0.0.0.

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

Invocation Result:
Details about the data set.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetGet.

Parameters:

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

dataSet - Identifier of the data set to be queried. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

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

get

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

Returns information describing a data set. This method was added in vSphere API 8.0.0.0.

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:
Details about the data set.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetGet.

Parameters:

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

dataSet - Identifier of the data set to be queried. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

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 dataSet,
            DataSetsTypes.UpdateSpec spec)

Modifies the attributes of a data set. This method was added in vSphere API 8.0.0.0.

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

Parameters:

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

dataSet - Identifier of the data set to be queried. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

spec - new attributes of the data set. Data sets should only be modified by the application that creates them. Otherwise the application may stop working.

Throws:

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

InvalidArgument - if any of the new attributes are invalid.

NotAllowedInCurrentState - if the virtual machine is in a state that doesn't allow modification, for example suspendeds.

NotFound - if the virtual machine is not found.

NotFound - if the data set is not found.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

UnableToAllocateResource - if the new data set attributes requires more resources than are available.

Unauthorized - if the user doesn't have the required privileges.

Unsupported - if the virtual hardware version of the virtual machine does not support DataSets

Unsupported - if the ESXi host version does not support DataSets

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetUpdate.

update

void update(java.lang.String vm,
            java.lang.String dataSet,
            DataSetsTypes.UpdateSpec spec,
            InvocationConfig invocationConfig)

Modifies the attributes of a data set. This method was added in vSphere API 8.0.0.0.

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

dataSet - Identifier of the data set to be queried. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

spec - new attributes of the data set. Data sets should only be modified by the application that creates them. Otherwise the application may stop working.

invocationConfig - Configuration for the method invocation.

Throws:

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

InvalidArgument - if any of the new attributes are invalid.

NotAllowedInCurrentState - if the virtual machine is in a state that doesn't allow modification, for example suspendeds.

NotFound - if the virtual machine is not found.

NotFound - if the data set is not found.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

UnableToAllocateResource - if the new data set attributes requires more resources than are available.

Unauthorized - if the user doesn't have the required privileges.

Unsupported - if the virtual hardware version of the virtual machine does not support DataSets

Unsupported - if the ESXi host version does not support DataSets

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetUpdate.

update

void update(java.lang.String vm,
            java.lang.String dataSet,
            DataSetsTypes.UpdateSpec spec,
            AsyncCallback<java.lang.Void> asyncCallback)

Modifies the attributes of a data set. This method was added in vSphere API 8.0.0.0.

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.
InvalidArgument - if any of the new attributes are invalid.
NotAllowedInCurrentState - if the virtual machine is in a state that doesn't allow modification, for example suspendeds.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if the new data set attributes requires more resources than are available.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetUpdate.

Parameters:

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

dataSet - Identifier of the data set to be queried. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

spec - new attributes of the data set. Data sets should only be modified by the application that creates them. Otherwise the application may stop working.

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

update

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

Modifies the attributes of a data set. This method was added in vSphere API 8.0.0.0.

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.
InvalidArgument - if any of the new attributes are invalid.
NotAllowedInCurrentState - if the virtual machine is in a state that doesn't allow modification, for example suspendeds.
NotFound - if the virtual machine is not found.
NotFound - if the data set is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
UnableToAllocateResource - if the new data set attributes requires more resources than are available.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetUpdate.

Parameters:

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

dataSet - Identifier of the data set to be queried. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.

spec - new attributes of the data set. Data sets should only be modified by the application that creates them. Otherwise the application may stop working.

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

invocationConfig - Configuration for the method invocation.

list

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

Lists the data sets of a virtual machine. This method was added in vSphere API 8.0.0.0.

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

Parameters:

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

Returns:

The list of data sets.

Throws:

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

NotFound - if the virtual machine is not found.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthorized - if the user doesn't have the required privileges.

Unsupported - if the virtual hardware version of the virtual machine does not support DataSets

Unsupported - if the ESXi host version does not support DataSets

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetList.

list

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

Lists the data sets of a virtual machine. This method was added in vSphere API 8.0.0.0.

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

invocationConfig - Configuration for the method invocation.

Returns:

The list of data sets.

Throws:

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

NotFound - if the virtual machine is not found.

ServiceUnavailable - if the system is unable to communicate with a service to complete the request.

Unauthorized - if the user doesn't have the required privileges.

Unsupported - if the virtual hardware version of the virtual machine does not support DataSets

Unsupported - if the ESXi host version does not support DataSets

Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetList.

list

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

Lists the data sets of a virtual machine. This method was added in vSphere API 8.0.0.0.

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

Invocation Result:
The list of data sets.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetList.

Parameters:

vm - Identifier of the virtual machine. 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<DataSetsTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Lists the data sets of a virtual machine. This method was added in vSphere API 8.0.0.0.

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:
The list of data sets.

Operation Errors:
Error - if the system reports an error while responding to the request.
NotFound - if the virtual machine is not found.
ServiceUnavailable - if the system is unable to communicate with a service to complete the request.
Unauthorized - if the user doesn't have the required privileges.
Unsupported - if the virtual hardware version of the virtual machine does not support DataSets
Unsupported - if the ESXi host version does not support DataSets
Unauthorized - if you do not have all of the privileges described as follows:

• The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetList.

Parameters:

vm - Identifier of the virtual machine. 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.