VirtualDiskFlatVer2BackingInfo

VirtualDiskFlatVer2BackingInfo
VirtualDiskFlatVer2BackingInfo

This data object type contains information about backing a virtual disk using a virtual disk file on the host, in the flat file format used by VMware Server, ESX Server 2.x, and ESX Server 3.x.

Flat disks are allocated when created, unlike sparse disks, which grow as needed.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "fileName": "string",
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "backingObjectId": "string",
    "diskMode": "string",
    "split": false,
    "writeThrough": false,
    "thinProvisioned": false,
    "eagerlyScrub": false,
    "uuid": "string",
    "contentId": "string",
    "changeId": "string",
    "parent": {
        "_typeName": "string",
        "fileName": "string",
        "datastore": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "backingObjectId": "string",
        "diskMode": "string",
        "split": false,
        "writeThrough": false,
        "thinProvisioned": false,
        "eagerlyScrub": false,
        "uuid": "string",
        "contentId": "string",
        "changeId": "string",
        "parent": "VirtualDiskFlatVer2BackingInfo Object",
        "deltaDiskFormat": "string",
        "digestEnabled": false,
        "deltaGrainSize": 0,
        "deltaDiskFormatVariant": "string",
        "sharing": "string",
        "keyId": {
            "_typeName": "string",
            "keyId": "string",
            "providerId": {
                "_typeName": "string",
                "id": "string"
            }
        }
    },
    "deltaDiskFormat": "string",
    "digestEnabled": false,
    "deltaGrainSize": 0,
    "deltaDiskFormatVariant": "string",
    "sharing": "string",
    "keyId": {
        "_typeName": "string",
        "keyId": "string",
        "providerId": {
            "_typeName": "string",
            "id": "string"
        }
    }
}
string
diskMode
Required
boolean
split
Optional

Flag to indicate the type of virtual disk file: split or monolithic.

If true, the virtual disk is stored in multiple files, each 2GB. On ESX this property is ignored when creating new disks or editing existing disks. This property is always false for disks created on ESX. When an existing split disk such as those created by VMware Server is added to a virtual machine on ESX, the property will be set to true when retrieved from VirtualMachineConfigInfo.

boolean
writeThrough
Optional

Flag to indicate whether writes should go directly to the file system or should be buffered.

boolean
thinProvisioned
Optional

Flag to indicate to the underlying filesystem, whether the virtual disk backing file should be allocated lazily (using thin provisioning). This flag is only used for file systems that support configuring the provisioning policy on a per file basis, such as VMFS3.

When specified as part of a VirtualMachineConfigSpec, this property applies only when creating a new virtual disk; it is ignored when editing an existing virtual disk.

see perFileThinProvisioningSupported

boolean
eagerlyScrub
Optional

Flag to indicate to the underlying filesystem whether the virtual disk backing file should be scrubbed completely at this time.

Virtual disks on some filesystems like VMFS3 are zeroed-out lazily so that disk creation time doesn't take too long. However, clustering applications and features like Fault Tolerance require that the virtual disk be completely scrubbed. This setting allows controlling the scrubbing policy on a per-disk basis.

If this flag is unset or set to false when creating a new disk, the disk scrubbing policy will be decided by the filesystem. If this flag is unset or set to false when editing an existing disk, it is ignored. When returned as part of a VirtualMachineConfigInfo, this property may be unset if its value is unknown.

string
uuid
Optional

Disk UUID for the virtual disk, if available.

string
contentId
Optional

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.

string
changeId
Optional

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.

parent
Optional

This data object type contains information about backing a virtual disk using a virtual disk file on the host, in the flat file format used by VMware Server, ESX Server 2.x, and ESX Server 3.x.

Flat disks are allocated when created, unlike sparse disks, which grow as needed.

string
deltaDiskFormat
Optional

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.

If nativeFormat is specified and the datastore does not support this format or the parent is on a different datastore, DeltaDiskFormatNotSupported is thrown.

vSphere server does not support relocation of virtual machines with nativeFormat. An exception is thrown for such requests.

boolean
digestEnabled
Optional

Indicates whether the disk backing has digest file enabled.

integer As int32 As int32
deltaGrainSize
Optional

Grain size in kB for a delta disk of format type seSparseFormat.

The default size is 4 kB. This setting is used to specify the grain size of Flex-SE delta disks when the base disk is of type FlatVer2BackingInfo. The DeltaDiskFormat must also be set to seSparseFormat.

string
deltaDiskFormatVariant
Optional

The delta disk format variant, if applicable.

This field is valid only for a delta disk and may specify more detailed information for the delta disk format specified in deltaDiskFormat.

If redoLogFormat is specified for the deltaDiskFormat, see DeltaDiskFormatVariant for the supported formats. If this is not specified for redoLogFormat, the default value used is vmfsSparseVariant.

For other delta disk formats, this currently remains unspecified.

string
sharing
Optional

The sharing mode of the virtual disk.

See VirtualDiskSharingEnum. The default value is no sharing.

keyId
Optional

Data Object representing a cryptographic key.