CreateSnapshotRequestType

CreateSnapshotRequestType
CreateSnapshotRequestType

The parameters of CreateSnapshot_Task.

JSON Example
{
    "name": "string",
    "description": "string",
    "memory": false,
    "quiesce": false
}
string
name
Required

The name for this snapshot. The name need not be unique for this virtual machine.

string
description
Optional

A description for this snapshot. If omitted, a default description may be provided.

boolean
memory
Required

If TRUE, a dump of the internal state of the virtual machine (basically a memory dump) is included in the snapshot. Memory snapshots consume time and resources, and thus take longer to create. When set to FALSE, the power state of the snapshot is set to powered off.

capabilities indicates whether or not this virtual machine supports this operation. For a virtual machine in suspended state we always include memory unless VirtualMachineCapability.diskOnlySnapshotOnSuspendedVMSupported is true.

boolean
quiesce
Required

If TRUE and the virtual machine is powered on when the snapshot is taken, VMware Tools is used to quiesce the file system in the virtual machine. This assures that a disk snapshot represents a consistent state of the guest file systems. If the virtual machine is powered off or VMware Tools are not available, the quiesce flag is ignored.