Set Data Sets Entries
Creates or updates an entry in a data set. If an entry whose key matches key already exists, it will replace the existing value, otherwise it will create a new entry. if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.DataSets.DataSetEntrySet.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/data-sets/{data_set}/entries/{key}
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. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.
string
key
Required
The key of the entry to set. A key can be at most 4096 bytes. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.data_sets.Entry.
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
string of mimetype application/json
Required
The value of the entry to set. A value can be at most 1MB.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the key is too large. if the value is too large. | 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 data set access mode prevents the operation.
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. | 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
Invoke-SetVmDataSetKeyVmEntries -Vm "MyVm" -DataSet "MyDataSet" -Key "MyKey" -Body "MyBody"
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" https://{api_host}/api/vcenter/vm/{vm}/data-sets/{data_set}/entries/{key}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: set
Availability
Added in 8.0.0.0
On This Page
Data Sets Entries Operations
delete
