Publish-StoragePluginArchivedSnapshot

Short Description

Retrieves and restores an archived snapshot.

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Publish-StoragePluginArchivedSnapshot -Snapshot <VBRStoragePluginArchivedSnapshot> [-Force] [<CommonParameters>]

Detailed Description

This cmdlet retrieves an archived snapshot and restores it to the storage system. An archived snapshots is a long-term snapshot offloaded to a 3rd party storage solution supported by a storage vendor.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Force	Defines that the cmdlet will retrieve and restore this archived snapshot without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
Snapshot	Specifies the archived snapshot. The cmdlet will retrieve this archived snapshot and restore it to the storage system. Accepts the `CSanArchivedSnapshot` object. To get this object, run the `Get-StoragePluginArchivedSnapshot` cmdlet.	`VBRStoragePluginArchivedSnapshot`	True	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

The cmdlet returns the CBaseSession object that defines the restore session.

Examples

Retrieving and Restoring Data from Archived Snapshot

This example shows how to retrieve and restore the archived snapshot that has the pdcqastg11:-pure14-AAB97A18587ghudDaPRSF-t5kbsdr1E name.

$snapshot = Get-StoragePluginArchivedSnapshot -Name pdcqastg11:-pure14-AAB97A18587ghudDaPRSF-t5kbsdr1E

Publish-StoragePluginArchivedSnapshot -Snapshot $snapshot

Perform the following steps:

Run the Get-StoragePluginArchivedSnapshot cmdlet. Specify the Name parameter value. Save the result to the $snapshot variable.
Run the Publish-StoragePluginArchivedSnapshot cmdlet. Set the $snapshot variable as the Snapshot parameter value.

Get-StoragePluginArchivedSnapshot