Set-VBRBackupToTapeJob
Short Description
Modifies backup to tape job or a GFS job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides three parameter sets.
- For modifying all kinds of tape jobs without editing media poos:
Set-VBRBackupToTapeJob -Job <VBRBackupToTapeJob> [-Name <string>] [-Description <string>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] [-ExportDays <DayOfWeek[]> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-FullBackupPolicy <VBRFullBackupToTapePolicy>] [-ScheduleOptions <VBRBackupToTapeScheduleOptions>] [-Object <Object[]>] [-ProcessIncrementalBackup] [-UseHardwareCompression] [-WaitPeriod <timespan>] [-WaitForBackupJob] [-NotificationOptions <VBRNotificationOptions>] [-JobScriptOptions <VBRJobScriptOptions>] [-AlwaysCopyFromLatestFull] [-PassThru] [-Force] [<CommonParameters>] |
- For modifying a tape job targeted to a non-GFS media pool:
Set-VBRBackupToTapeJob -Job <VBRBackupToTapeJob> [-Name <string>] [-Description <string>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] [-FullBackupMediaPool <VBRTapeMediaPool>] [-IncrementalBackupMediaPool <VBRTapeMediaPoolBase>] [-ExportDays <DayOfWeek[]> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-FullBackupPolicy <VBRFullBackupToTapePolicy>] [-ScheduleOptions <VBRBackupToTapeScheduleOptions>] [-Object <Object[]>] [-ProcessIncrementalBackup] [-UseHardwareCompression] [-WaitPeriod <timespan>] [-WaitForBackupJob] [-NotificationOptions <VBRNotificationOptions>] [-JobScriptOptions <VBRJobScriptOptions>] [-AlwaysCopyFromLatestFull] [-PassThru] [-Force] [<CommonParameters>] |
- For modifying a tape job targeted to a GFS media pool:
Set-VBRBackupToTapeJob -Job <VBRBackupToTapeJob> [-Name <string>] [-Description <string>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] [-GFSMediaPool <VBRTapeGFSMediaPool>] [-ExportDays <DayOfWeek[]> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-FullBackupPolicy <VBRFullBackupToTapePolicy>] [-ScheduleOptions <VBRBackupToTapeScheduleOptions>] [-Object <Object[]>] [-ProcessIncrementalBackup] [-UseHardwareCompression] [-WaitPeriod <timespan>] [-WaitForBackupJob] [-NotificationOptions <VBRNotificationOptions>] [-JobScriptOptions <VBRJobScriptOptions>] [-AlwaysCopyFromLatestFull] [-GFSScheduleOptions <VBRTapeGFSScheduleOptions>] [-PassThru] [-Force] [<CommonParameters>] |
Detailed Description
This cmdlet modifies a selected backup to tape job or a GFS job. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.
Starting from Veeam Backup & Replication version 9.5 Update 3, the cmdlet checks if the data of the VMs added to the job changes its geographical location.
|
The cmdlet will not run if the geographical location of the repository where VM backups reside and the target media pool location do not match. If you still want to run the cmdlet, use the Force parameter. |
Parameters
Parameter | Description | Required | Position | Accept | Accept |
---|---|---|---|---|---|
Job | Specifies the backup to tape job to which you want to apply new settings. Accepts VBRBackupToTapeJob or TapeJob, GUID or string type. | True | Named | True (ByValue, | False |
Name | Specifies the name you want to assign to the backup to tape job. | False | Named | False | False |
Description | Specifies the description of the backup to tape job. | False | Named | False | False |
EjectCurrentMedium | Indicates that the tapes will be automatically ejected from drive after the job finishes. The ejected tape is moved to a standard library slot. | False | Named | False | False |
ExportCurrentMediaSet | Indicates that the tapes belonging to the media set will be automatically placed to Import/Export (Mail) slot for further export. Use the ExportDays parameter to set days on which you want to export tapes. If you use this parameter, but do not set the ExportDays parameter, the tapes will be exported every day. | False | Named | False | False |
FullBackupMediaPool | For non-GFS jobs. Specifies the media pool where you want to store full backups produced by this tape job. Accepts VBRTapeMediaPool, GUID or string type. | True | Named | False | False |
IncrementalBackupMediaPool | For non-GFS jobs. Used to set media pool for the ProcessIncrementalBackup parameter. Specifies the media pool where you want to store incremental backups produced by this tape job. Accepts VBRTapeMediaPoolBase, GUID or string type. | False | Named | False | False |
GFSMediaPool | For GFS jobs. Specifies the target GFS media pool. Accepts VBRTapeGFSMediaPool, GUID or string type. | True | Named | False | False |
ExportDays | Used to set days for exporting tapes for the ExportCurrentMediaSet parameter. Specifies days on which the tapes written by this tape job will be automatically exported: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday. | False | Named | False | False |
FullBackupPolicy | Specifies virtualized synthetic full backup for tape settings. Accepts VBRFullBackupToTapePolicy type. | False | Named | False | False |
ScheduleOptions | Specifies backup to tape job schedule. Default:
| False | Named | False | False |
Object | Specifies the array of backup to tape job sources. Tape job sources are backup jobs or backup repositories. Accepts either of the following types:
| False | Named | False | False |
ProcessIncrementalBackup | Indicates that this tape job will archive incremental backups. Use the IncrementalBackupMediaPool parameter to specify a separate media pool for storing incremental backups. If you do not set the IncrementalBackupMediaPool parameter, incremental backups will be stored to the media pool you set for full backups. | False | Named | False | False |
UseHardwareCompression | Indicates that tape library must perform hardware compression for archives. Do not use this option for archiving Veeam backups or other already compressed files. | False | Named | False | False |
WaitPeriod | Used to set time period for the WaitForBackupJob parameter. Specifies the time period for which the tape job must wait for the source backup jobs to finish. Can be set to 1-777 minutes. Accepts TimeSpan, integer or string types. | False | Named | False | False |
WaitForBackupJob | Indicates that the tape job must wait for the source backup job to finish. Use the WaitPeriod parameter to set the time period. | False | Named | False | False |
NotificationOptions | Specifies the email notification options. Accepts VBRNotificationOptions type. | False | Named | False | False |
JobScriptOptions | Specifies scripting options. Accepts VBRJobScriptOptions type. | False | Named | False | False |
AlwaysCopyFromLatestFull | Indicates that on each run the tape job must copy only the latest backup chain. Otherwise, on each run the tape job will copy all restore points produced by the source backup jobs that are available on disk. | False | Named | False | False |
GFSScheduleOptions | Specifies the schedule settings for the GFS media pool. Accepts VBRTapeGFSScheduleOptions type. | False | Named | False | False |
Force | Indicates that the cmdlet will create a job even if the geographical location of the repositories where VM backups reside and the target media pool location do not match. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Return Type
Example
This command sets a new media pool for the incremental backups.
- Run Get-VBRTapeMediaPool. Save it to the $newpool variable.
- Run Set-VBRBackupToTapeJob. Get the job with Get-VBRTapeJob and pipe it down. Use the $newpool variable.
$newpool = Get-VBRTapeMediaPool -Name "Incremental Backups" Get-VBRTapeJob -Name "Daily WebApp Backup" | Set-VBRBackupToTapeJob -IncrementalBackupMediaPool $newpool |
Related Commands