Vcenter Vm DataSets create
Creates a new data set.
This operation was added in vSphere API 8.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- The resource
VirtualMachinereferenced by the parameter vm requiresVirtualMachine.DataSets.DataSetCreate.
Identifier of the virtual machine.
The parameter must be an identifier for the resource type: VirtualMachine.
Specification of the data set to be created.
Show optional properties
{
"name": "string",
"description": "string",
"host": "string",
"guest": "string"
}{
"name": "string",
"description": "string",
"host": "string",
"guest": "string",
"omit_from_snapshot_and_clone": false
}The name of the data set. __ It is recommended that this value take the form "com.company.project" to avoid conflict with other uses.__
This property was added in vSphere API 8.0.0.0.
A description of how the data set is used by its creator. This field can contain up to 1024 bytes.
This property was added in vSphere API 8.0.0.0.
Host access control.
Controls access to the data set by the Vcenter Vm DataSets Entries operations.
For more information see: Vcenter Vm DataSets Access.
This property was added in vSphere API 8.0.0.0.
Guest access control.
Controls access to the data set from the in-guest APIs.
For more information see: Vcenter Vm DataSets Access.
This property was added in vSphere API 8.0.0.0.
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) {@term set} will be destroyed. Any data set with {@link #omitFromSnapshotAndClone} {@term unset} will be restored to the state when the snapshot was created.
This property was added in vSphere API 8.0.0.0.
If missing or null, the data set is copied when a virtual machine is cloned or a snapshot is taken.
The identifier of the new data set.
The response will be an identifier for the resource type: com.vmware.vcenter.vm.DataSet.
Vapi Std Errors AlreadyExists if the data set with the same name already exists.
Vapi Std Errors InvalidArgument if the specification is incorrect.
Vapi Std Errors NotAllowedInCurrentState if the virtual machine is in a state that doesn't allow modifications, for example suspended.
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
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
}Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the user doesn't have the required privileges.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
}if the virtual machine is not found.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
}Vapi Std Errors Error if the system reports an error while responding to the request.
Vapi Std Errors UnableToAllocateResource if the new data set requires more resources than are available.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the system is unable to communicate with a service to complete the request.
{
"messages": [
{
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
],
"data": {},
"error_type": "string"
} curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"description:"string","guest:"string","host:"string","name:"string"}' https://{api_host}/api/vcenter/vm/{vm}/data-sets