Share via


ExportSnapshot method of the Msvm_CollectionSnapshotService class

Exports a snapshot of a virtual system collection to a file. The snapshot collection, its associated configuration settings, and its associated resource settings are preserved in the resulting file.

Syntax

uint32 ExportSnapshot(
  [in]  CIM_Collection  REF SnapshotCollection,
  [in]  string              ExportDirectory,
  [in]  string              ExportSettingData,
  [out] CIM_ConcreteJob REF Job
);

Parameters

SnapshotCollection [in]

A reference to a CIM_Collection object that represents the snapshot collection to export.

ExportDirectory [in]

The fully-qualified path of the directory that receives the exported virtual system collection. If the CreateVmExportSubdirectory property in the ExportSettingData parameter is set to true, then this directory can be reused for exporting multiple virtual system collections, and this method places each virtual system collection in a separate subdirectory under this path.

ExportSettingData [in]

An instance of Msvm_CollectionSnapshotExportSettingData that represents the settings for the export operation.

Job [out]

An optional job to use for this operation if it is performed asynchronously.

Return value

If this method is executed synchronously, it returns "0" if it succeeds. If this method is executed asynchronously, it returns "4096" and the Job output parameter can be used to track the progress of the asynchronous operation. Any other return value indicates an error.

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2016
Namespace
Root\HyperVCluster\v2
MOF
WindowsHyperVCluster.V2.mof
DLL
VMMS.exe

See also

Msvm_CollectionSnapshotService