Name

Description

($err, $result) = VMGetNumRootSnapshots($vmHandle);

This function returns the number of top-level (root) snapshots belonging to a virtual machine.

Parameters

vmHandle

Identifies a virtual machine. Call VMOpen() to create a virtual machine handle.

Return Value

$result. The number of root snapshots on this virtual machine.

Remarks

• This function returns the number of top-level (root) snapshots belonging to a virtual machine. A top-level snapshot is one that is not based on any previous snapshot. If the virtual machine has more than one snapshot, the snapshots can be a sequence in which each snapshot is based on the previous one, leaving only a single top-level snapshot. However, if applications create branched trees of snapshots, a single virtual machine can have several top-level snapshots.
• VMware Server can manage only a single snapshot for each virtual machine. All other snapshots in a sequence are ignored. The value of the result parameter is always 0 or 1.
• This function is not supported when using the VIX_SERVICEPROVIDER_VMWARE_PLAYER host type.

Side Effects

Requirements

use VMware::Vix::Simple;
use VMware::Vix::API::Constants;