Managed Object - VirtualMachineSnapshot

Property of
OvfCreateDescriptorParams, VirtualMachine, VirtualMachineCloneSpec, VirtualMachineFileLayoutExSnapshotLayout, VirtualMachineFileLayoutSnapshotLayout, VirtualMachineSnapshot, VirtualMachineSnapshotInfo, VirtualMachineSnapshotTree
Parameter to
QueryChangedDiskAreas, StartReplaying_Task
Returned by
CreateSnapshot_Task, CreateSnapshotEx_Task, StartRecording_Task
Extends
ExtensibleManagedObject
See also
HostSystem, HttpNfcLease, VirtualMachine, VirtualMachineConfigInfo,
Since
null


Managed Object Description

Properties

Name Type Description
childSnapshot*ManagedObjectReference[]
to a VirtualMachineSnapshot[]

Since vSphere API 4.1
configVirtualMachineConfigInfo


vmManagedObjectReference
to a VirtualMachine

Since vSphere API 6.0
Properties inherited from ExtensibleManagedObject
availableField, value
*May not be present

Methods

Methods defined in this Managed Object
ExportSnapshot, RemoveSnapshot_Task, RenameSnapshot, RevertToSnapshot_Task
Methods inherited from ExtensibleManagedObject
setCustomValue

ExportSnapshot

Required Privileges
VApp.Export
Since
vSphere API 5.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachineSnapshot used to make the method call.

Return Value

Type Description
ManagedObjectReference
to a HttpNfcLease

Faults

Type Description
FileFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



RemoveSnapshot_Task

Required Privileges
VirtualMachine.State.RemoveSnapshot

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachineSnapshot used to make the method call.
removeChildren Pxsd:boolean

Since null
consolidate* Pxsd:boolean

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



RenameSnapshot

Required Privileges
VirtualMachine.State.RenameSnapshot

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachineSnapshot used to make the method call.
name* Pxsd:string

Since null
description* Pxsd:string

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
InvalidName
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



RevertToSnapshot_Task

Required Privileges
VirtualMachine.State.RevertToSnapshot

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VirtualMachineSnapshot used to make the method call.
host* PManagedObjectReference
to a HostSystem

Since null
suppressPowerOn* Pxsd:boolean

Since null
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
FileFault
InsufficientResourcesFault
InvalidState
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress
VmConfigFault

Events

Type
None