VirtualMachineSnapshotTree

VirtualMachineSnapshotTree
VirtualMachineSnapshotTree

SnapshotTree encapsulates all the read-only data produced by the snapshot.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "snapshot": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "name": "string",
    "description": "string",
    "id": 0,
    "createTime": "string",
    "state": "string",
    "quiesced": false,
    "backupManifest": "string",
    "childSnapshotList": [
        {
            "_typeName": "string",
            "snapshot": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "vm": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "name": "string",
            "description": "string",
            "id": 0,
            "createTime": "string",
            "state": "string",
            "quiesced": false,
            "backupManifest": "string",
            "childSnapshotList": [
                "VirtualMachineSnapshotTree Object"
            ],
            "replaySupported": false
        }
    ],
    "replaySupported": false
}
snapshot
Required

Reference to an instance of the VirtualMachineSnapshot managed object.

vm
Required

Reference to an instance of the VirtualMachine managed object.

string
name
Required

Name of the snapshot.

string
description
Required

Description of the snapshot.

integer As int32 As int32
id
Required

The unique identifier that distinguishes this snapshot from other snapshots of the virtual machine.

string As date-time As date-time
createTime
Required

The date and time the snapshot was taken.

state
Required

The PowerState type defines a simple set of states for a virtual machine: poweredOn, poweredOff, and suspended.

This type does not model substates, such as when a task is running to change the virtual machine state. If the virtual machine is in a state with a task in progress, it transitions to a new state when the task completes. For example, a virtual machine continues to be in the poweredOn state while a suspend task is running, and changes to the suspended state once the task finishes.

As a consequence of this approach, clients interested in monitoring the status of a virtual machine should typically track the activeTask data object in addition to the powerState object.

Possible values:

  • poweredOff: The virtual machine is currently powered off.
  • poweredOn: The virtual machine is currently powered on.
  • suspended: The virtual machine is currently suspended.
Possible values are : poweredOff, poweredOn, suspended,
boolean
quiesced
Required

Flag to indicate whether or not the snapshot was created with the "quiesce" option, ensuring a consistent state of the file system.

string
backupManifest
Optional

The relative path from the snapshotDirectory pointing to the backup manifest.

Available for certain quiesced snapshots only.

childSnapshotList
Optional

The snapshot data for all snapshots for which this snapshot is the parent.

boolean
replaySupported
Optional

Deprecated as of vSphere API 6.0.

Flag to indicate whether this snapshot is associated with a recording session on the virtual machine that can be replayed.