Get Data Sets
Returns information describing a data set. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetGet.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/data-sets/{data_set}
Path Parameters
Path Parameters
string
vm
Required
Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.
string
data_set
Required
Identifier of the data set to be queried. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VmDataSetsInfo
of type application/json
Details about the data set.
{
"description": "string",
"guest": "NONE",
"host": "NONE",
"name": "string",
"omit_from_snapshot_and_clone": false,
"used": 0
}
string
description
Required
A description of how the data set is used by its creator.
guest
Required
Possible Entry access modes.
NONE : No access is allowed for data set Entries.
READ_ONLY : Only read access is allowed for data set Entries.
READ_WRITE : Full read, write and delete access is allowed on data set Entries.
Possible values are: NONE , READ_ONLY , READ_WRITE
host
Required
Possible Entry access modes.
NONE : No access is allowed for data set Entries.
READ_ONLY : Only read access is allowed for data set Entries.
READ_WRITE : Full read, write and delete access is allowed on data set Entries.
Possible values are: NONE , READ_ONLY , READ_WRITE
string
name
Required
The name of the data set.
boolean
omit_from_snapshot_and_clone
Required
If set, the data set is considered a property of the virtual machine, and is not included in a snapshot operation or when the virtual machine is cloned. When a virtual machine is reverted to a snapshot, any data set with {@link #omitFromSnapshotAndClone) set will be destroyed. Any data set with DataSets.Info.omit-from-snapshot-and-clone unset will be restored to the state when the snapshot was created.
integer
used
Required
The total size in bytes of the Entry data in use by this data set.
Errors
400
com.vmware.vapi.std.errors.unsupported : if the virtual hardware version of the virtual machine does not support DataSets if the ESXi host version does not support DataSets
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn’t have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if the virtual machine is not found. if the data set is not found.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetVmDataSet -Vm "MyVm" -DataSet "MyDataSet"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/data-sets/{data_set}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 8.0.0.0
On This Page
Data Sets Operations
get
post
get
patch
delete
