Scripting Object - VcVirtualMachineSnapshot

Scripting-object corresponding to
VirtualMachineSnapshot
Attribute of
VcOvfCreateDescriptorParams, VcVirtualMachine, VcVirtualMachineCloneSpec, VcVirtualMachineFileLayoutExSnapshotLayout, VcVirtualMachineFileLayoutSnapshotLayout, VcVirtualMachineSnapshot, VcVirtualMachineSnapshotInfo, VcVirtualMachineSnapshotTree
Parameter to
acquireLease, acquireLeaseExt, queryChangedDiskAreas, startReplaying_Task
Returned by
getAllVirtualMachineSnapshots, getAllVirtualMachineSnapshots

Scripting Object Description

The Snapshot managed object type specifies the interface to individual snapshots of a virtual machine. Although these are managed objects, they are subordinate to their virtual machine.

Attributes

Name Type Description
availableFieldVcCustomFieldDef []

@since VI API 2.5
childSnapshotVcVirtualMachineSnapshot []

@since vSphere API 4.1
configVcVirtualMachineConfigInfo

@since VI API 2.5
descriptionString

@since Unknown
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
nameString

@since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
valueVcCustomFieldValue []

@since VI API 2.5
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown
virtualMachineVcVirtualMachine

Need to add this method for compatibility with the 2015Q3 plugin. @since Unknown
virtualMachineNameString

@since Unknown
vmVcVirtualMachine

This method works for all versions of vSphere plugin. @since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createLinkedClone_Task, createTrigger, exportSnapshot, removeSnapshot_Task, renameSnapshot, revertToSnapshot_Task, setCustomValue

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createLinkedClone_Task

@since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String

arg2Boolean


Return Value

Type Description
VcTask

renameSnapshot

Rename this snapshot with either a new name or a new description or both. At least one of these must be specified when calling the rename method.

@since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

revertToSnapshot_Task

Change the execution state of the virtual machine to the state of this snapshot. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostSystem

arg1Boolean


Return Value

Type Description
VcTask

setCustomValue

Assigns a value to a custom field. The setCustomValue method requires whichever updatePrivilege is defined as one of the {@link CustomFieldsManager.FieldDef#fieldInstancePrivileges} for the CustomFieldDef whose value is being changed. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

removeSnapshot_Task

Removes this snapshot and deletes any associated storage. @since VI API 2.5

Parameters

NameTypeDescription
arg0Boolean

arg1Boolean


Return Value

Type Description
VcTask

exportSnapshot

Obtains an export lease on this snapshot. The export lease contains a list of URLs for the virtual disks for this snapshot, as well as a ticket giving access to the URLs.

See {@link vim.HttpNfcLease} for information on how to use the lease. @since vSphere API 5.5

Parameters

NameTypeDescription
None

Return Value

Type Description
VcHttpNfcLease