Copy-VBRBackup
Short Description
Copies backups to a repository or local or shared folder.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Copy backups to a local or shared folder.
Copy-VBRBackup -Backup <CBackup> [-Name <String[]>] [-Path <String>] [-ShareCredentials <CCredentials>] [-AutoDelete <VBRMoveCopyRetention>] [-RetentionNumber <Int32>] [-RetentionPeriodType <VBRRetentionPeriodType>] [-RunAsync] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] |
- Copy backups to a repository.
Copy-VBRBackup -Backup <CBackup> [-Name <String[]>] [-Repository <CBackupRepository>] [-AutoDelete <VBRMoveCopyRetention>] [-RetentionNumber <Int32>] [-RetentionPeriodType <VBRRetentionPeriodType>] [-RunAsync] [-Force] [-WhatIf] [-Confirm] [<CommonParameters>] |
Detailed Description
This cmdlet copies the whole backup chains to a repository or local or shared folder.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Backup | Specifies the backups that will be copied. | Accepts the CBackup object. To get this object, run the Get-VBRBackup cmdlet. | True | Named | True (ByPropertyName, ByValue) |
Name | Specifies an array of names of the workloads that you want to move. Note: This parameter applies only if backups are per-machine with metadata for each workload. | String[] | False | Named | True (ByPropertyName, ByValue) |
Path | Specifies a path to the local or shared folder to which you want to copy backups. | String | False | Named | True (ByPropertyName, ByValue) |
ShareCredentials | Specifies the credentials that will be used to access the shared folder. | Accepts the CCredentials object. To get this object, run the Get-VBRCredentials cmdlet. | False | Named | True (ByPropertyName, ByValue) |
Repository | Specifies the repository to which you want to copy backups. | Accepts the CBackupRepository object. To get this object, run the Get-VBRBackupRepository cmdlet. | False | Named | True (ByPropertyName, ByValue) |
AutoDelete | Specifies the time interval after which Veeam Backup & Replication will delete copied backups. The parameter accepts the following values:
| AutoDelete | False | Named | False |
RetentionPeriodType | Specifies the type of the retention policy. You can set the following types:
Use the RetentionNumber to specify the number of days, months or years. Note: Use this parameter if the AutoDelete parameter is not specified. | VBRRetentionPeriodType | False | Named | False |
RetentionNumber | For the RetentionPeriodType option. Specifies the period of time to keep the copied data. After this period finishes, Veeam Backup & Replication will remove data. | Int32 | False | Named | False |
RunAsync | Defines that the command returns immediately without waiting for the task to complete. | SwitchParameter | False | Named | False |
Force | Defines that the cmdlet will copy backups without showing warnings in the PowerShell console. | SwitchParameter | False | Named | False |
WhatIf | Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action. | SwitchParameter | False | Named | False |
Confirm | Defines that the cmdlet will display a prompt that asks if you want to continue running the command. | SwitchParameter | False | 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 VBRCopyBackupSession object that contains settings of the copy session.
Examples
Copying Backups
This example shows how to copy backups to a repository.
$backup = Get-VBRBackup $repository = Get-VBRBackupRepository Copy-VBRBackup -Backup $backup -Repository $repository |
Perform the following steps:
- Run the Get-VBRBackup cmdlet. Save the result to the $backup variable.
- Run the Get-VBRBackupRepository cmdlet. Save the result to the $repository variable.
- Run the Copy-VBRBackup cmdlet. Set the $backup variable as the Backup parameter value. Set the $repository variable as the Repository parameter value.
Related Commands