Virtual Machine Query Changed Disk Areas
Get a list of areas of a virtual disk belonging to this VM that have been modified since a well-defined point in the past.
The beginning of the change interval is identified by "changeId", while the end of the change interval is implied by the snapshot ID passed in.
Note that the result of this function may contain "false positives" (i.e: flag areas of the disk as modified that are not). However, it is guaranteed that no changes will be missed.
Required privileges: VirtualMachine.Provisioning.DiskRandomRead
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId
, in this case VirtualMachine/{moId}
.
The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.
{
"snapshot": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"deviceKey": 0,
"startOffset": 0,
"changeId": "string"
}
Reference to an instance of the VirtualMachineSnapshot managed object.
Identifies the virtual disk for which to compute changes.
Start Offset in bytes at which to start computing changes. Typically, callers will make multiple calls to this function, starting with startOffset 0 and then examine the "length" property in the returned DiskChangeInfo structure, repeatedly calling queryChangedDiskAreas until a map forthe entire virtual disk has been obtained.
Identifyer referring to a point in the past that should be used as the point in time at which to begin including changes to the disk in the result. A typical use case would be a backup application obtaining a changeId from a virtual disk's backing info when performing a backup. When a subsequent incremental backup is to be performed, this change Id can be used to obtain a list of changed areas on disk.
Returns a data structure specifying extents of the virtual disk that have changed since the thime the changeId string was obtained.
{
"_typeName": "string",
"startOffset": 0,
"length": 0,
"changedArea": [
{
"_typeName": "string",
"start": 0,
"length": 0
}
]
}
Start offset (in bytes) of disk area described by this data structure.
Length (in bytes) of disk area described by this data structure.
Modified disk areas.
Might be empty if no parts of the disk between startOffset and startOffset + length were modified.
NotFound: if the snapshot specified does not exist.
InvalidArgument: if deviceKey does not specify a virtual disk, startOffset is beyond the end of the virtual disk or changeId is invalid or change tracking is not supported for this particular disk.
FileFault: if the virtual disk files cannot be accessed/queried.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}