Vm_DataSets_CreateSpec

Vm_DataSets_CreateSpec
Vm_DataSets_CreateSpec

The DataSets.CreateSpec structure describes a data set to be created.

JSON Example
{
    "name": "string",
    "description": "string",
    "host": "string",
    "guest": "string",
    "omit_from_snapshot_and_clone": false
}
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.

string
description
Required

A description of how the data set is used by its creator. This field can contain up to 1024 bytes.

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.

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.

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 copied when a virtual machine is cloned or a snapshot is taken.