Data Object - VirtualDiskSeSparseBackingInfo(vim.vm.device.VirtualDisk.SeSparseBackingInfo)

Property of
See also
vSphere API 5.1

Data Object Description

Backing type for virtual disks that use the space efficient sparse format.

Space for space efficient sparse disks is allocated on demand and optimizations are applied to achieve additional space savings. The effective space usage of such a disk can be obtained from VirtualMachineFileLayoutEx.


Name Type Description

The change ID of the virtual disk for the corresponding snapshot or virtual machine. This can be used to track incremental changes to a virtual disk. See QueryChangedDiskAreas.

Content ID of the virtual disk file, if available.

A content ID indicates the logical contents of the disk backing and its parents.

This property is only guaranteed to be up to date if this disk backing is not currently being written to by any virtual machine.

The only supported operation is comparing if two content IDs are equal or not. The guarantee provided by the content ID is that if two disk backings have the same content ID and are not currently being written to, then reads issued from the guest operating system to those disk backings will return the same data.


The format of the delta disk.

This field is valid only for a delta disk.

See DeltaDiskFormat for the supported formats. If not specified, the default value used is redoLogFormat.


Indicates whether the disk backing has digest file enabled.

The disk persistence mode. Valid modes are:
  • vim.vm.device.VirtualDiskOption.DiskMode#persistent
  • vim.vm.device.VirtualDiskOption.DiskMode#independent_persistent
  • vim.vm.device.VirtualDiskOption.DiskMode#independent_nonpersistent
  • vim.vm.device.VirtualDiskOption.DiskMode#nonpersistent
  • vim.vm.device.VirtualDiskOption.DiskMode#undoable
  • vim.vm.device.VirtualDiskOption.DiskMode#append

See VirtualDiskMode


Specify the grain size in kB. The default size is 4 kB.

Virtual Disk Backing encryption options. On modification operations the value is ignored, use the specification crypto in backing.

Since vSphere API 6.5

The parent of this virtual disk file, if this is a delta disk backing. This will be unset if this is not a delta disk backing.

A delta disk backing is a way to preserve a virtual disk backing at some point in time. A delta disk backing is a file backing which in turn points to the original virtual disk backing (the parent). After a delta disk backing is added, all writes go to the delta disk backing. All reads first try the delta disk backing and then try the parent backing if needed.

A delta disk backing can be added to a disk either implicitly during snapshot operations, or explicitly during create or reconfigure of the virtual machine.

Note that the type of the backing is consistent throughout the chain; any new delta disk backing which is added is of the same type as the original disk . Also note that since the parent backing is not being written to, it is possible that the parent backing may be shared among multiple disks belonging to multiple virtual machines.

During virtual machine CreateVM_Task and ReconfigVM_Task this property is only checked if the VirtualDeviceConfigSpec specifies an add operation with a create file operation. In this case, a new delta disk backing is created which points to the parent disk backing. Only the fileName property is important; all other properties will be ignored. The parent backing is assumed to exist and will not be recursively created.

This property may only be set if deltaDiskBackingsSupported is true.


Disk UUID for the virtual disk, if available.

Flag to indicate whether writes should go directly to the file system or should be buffered.
Properties inherited from VirtualDeviceFileBackingInfo
backingObjectId, datastore, fileName
Properties inherited from VirtualDeviceBackingInfo
Properties inherited from DynamicData
*Need not be set
Show WSDL type definition