Export-VBRRestorePoint

Short Description

Exports backup files of a specific restore point.

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

Syntax

Export-VBRRestorePoint [-RestorePoint] <COib> [-RetentionPeriod <VBRExportRetentionPeriod>]

[-RetentionNumber <Int32>] [-RetentionPeriodType <VBRRetentionPeriodType>] [-Reason <String>]

[-Repository <CBackupRepository>] [<CommonParameters>]

Detailed Description

This cmdlet exports backup files of a specific restore point.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Reason	Specifies the reason of the export.	`String`	False	Named	False
Repository	Specifies the repository to which you want to export the restore point. Accepts the `CBackupRepository` object. To get this object, run the `Get-VBRBackupRepository` cmdlet.	`CBackupRepository`	False	Named	False
RestorePoint	Specifies a restore point. The cmdlet will export backup files of this restore point. Accepts the `COib` object. To get this object, run the `Get-VBRRestorePoint` cmdlet.	`COib`	True	0	True (ByPropertyName, ByValue)
RetentionNumber	For the `RetentionPeriodType` option. Specifies the period of time to keep the exported data. After this period finishes, Veeam Backup & Replication will remove data.	`Int32`	False	Named	False
RetentionPeriod	Specifies a retention period of exported backup files. The cmdlet will delete exported backup files within one of the following retention periods: `Never` `In1Month` `In3Months` `In6Months` `In1Year` `In2Years` `In3Years` `In5Years` Note: Use this parameter if the `RetentionPeriodType` and `RetentionNumber` parameters are not specified.	`VBRExportRetentionPeriod`	False	Named	False
RetentionPeriodType	Specifies the type of the retention policy. You can set the following types: `Days`: use this option if you want Veeam Backup & Replication to apply retention policy daily. `Months`: use this option if you want Veeam Backup & Replication to apply retention policy monthly. `Years`: use this option if you want Veeam Backup & Replication to apply retention policy yearly. Use the `RetentionNumber` to specify the number of days, months or years. Note: Use this parameter if the `RetentionPeriod` parameter is not specified.	`VBRRetentionPeriodType`	False	Named	False

<CommonParameters>

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

Examples

Exporting Backup Files of Specific Restore Point

This example shows how to export backup files of a specific restore point.

$restorepoint = Get-VBRRestorePoint

Export-VBRRestorePoint -RestorePoint $restorepoint[2]

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Save the result to the $restorepoint variable.
Run the Export-VBRRestorePoint cmdlet. Set the third $restorepoint as the RestorePoint parameter value.

Get-VBRRestorePoint