Vm_DataSets_Info

Vm_DataSets_Info

The DataSets.Info structure describes a data set.

JSON Example

{
    "name": "string",
    "description": "string",
    "host": "string",
    "guest": "string",
    "used": 0,
    "omit_from_snapshot_and_clone": false
}

string

name

Required

The name of the data set.

string

description

Required

A description of how the data set is used by its creator.

Vm_DataSets_Access

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.

Vm_DataSets_Access

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.

integer As int64

used

Required

The total size in bytes of the Entry data in use by this 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.