Create Data Sets
Creates a new 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.DataSetCreate.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/data-sets
Path Parameters
Path Parameters
string
vm
Required
Identifier of the virtual machine. The parameter must be an identifier for the resource type: VirtualMachine.
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"
Request Body
Request Body
VmDataSetsCreateSpec of mimetype application/json
Required
Specification of the data set to be created.
{
"description": "string",
"guest": "NONE",
"host": "NONE",
"name": "string"
}
string
description
Required
A description of how the data set is used by its creator. This field can contain up to 1024 bytes.
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. It is recommended that this value take the form “com.company.project” to avoid conflict with other uses.
boolean
omit_from_snapshot_and_clone
Optional
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.CreateSpec.omit-from-snapshot-and-clone unset will be restored to the state when the snapshot was created. If unset, the data set is not copied when a virtual machine is cloned or a snapshot is taken.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
string
of type application/json
The identifier of the new data set. The result will be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.
Errors
400
com.vmware.vapi.std.errors.already_exists : if the data set with the same name already exists. | com.vmware.vapi.std.errors.invalid_argument : if the specification is incorrect. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is in a state that doesn’t allow modifications, for example suspended. | 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.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.unable_to_allocate_resource : if the new data set requires more resources than are available.
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
$VmDataSetsCreateSpec = Initialize-VmDataSetsCreateSpec -Name "MyName" -Description "MyDescription" -VarHost "NONE" -Guest "NONE"
Invoke-CreateVmDataSets -Vm "MyVm" -VmDataSetsCreateSpec $VmDataSetsCreateSpec
PowerCLI Client SDK All Parameters Example
$VmDataSetsCreateSpec = Initialize-VmDataSetsCreateSpec -Name "MyName" -Description "MyDescription" -VarHost "NONE" -Guest "NONE" -OmitFromSnapshotAndClone $false
Invoke-CreateVmDataSets -Vm "MyVm" -VmDataSetsCreateSpec $VmDataSetsCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"description":"string","guest":"NONE","host":"NONE","name":"string","omit_from_snapshot_and_clone":false}' https://{api_host}/api/vcenter/vm/{vm}/data-sets
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: create
Availability
Added in 8.0.0.0
On This Page
Data Sets Operations
get
post
get
patch
delete
