This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBRBackupToTapeJob

In this article

Short Description

Modifies backup to tape job or a GFS job.

Applies to

Platform: VMware, Hyper-V

Product Edition: Enterprise, Enterprise Plus

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] [<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] [<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] [<CommonParameters>]

Related Commands

Get-VBRJob

Get-VBREPJob

Get-VBRBackupRepository

Get-VBRTapeMediaPool

New-VBRFullBackupToTapePolicy

New-VBRBackupToTapeScheduleOptions

Get-VBRBackupRepository

New-VBRNotificationOptions

New-VBRJobScriptOptions

Return Type

VBRBackupToTapeJob

Detailed Description

This cmdlet modifies a selected backup to tape job or a GFS job. To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
Job	Specifies the backup to tape job to which you want to apply new settings. Accepts VBRBackupToTapeJob or TapeJob objects, GUID or string type.	True	Named	False	False
Name	Specifies the name you want to assign to the backup to tape job. Accepts string type.	False	Named	False	False
Description	Specifies the description of the backup to tape job. If not set, Veeam Backup & Replication will enter date and time of creation by default.	False	Named	False	False
Eject Current Medium	Indicates that the tape(s) will be automatically ejected from drive after the job finishes. The ejected tape is moved to a standard library slot.	False	Named	False	False
Export Current MediaSet	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
Full Backup Media Pool	For non-GFS jobs. Specifies the media pool where you want to store full backups produced by this tape job. Accepts VBRTapeMediaPool object, GUID or string type.	True	Named	False	False
Incremental Backup Media Pool	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 VBRTapeMediaPool object, GUID or string type.	False	Named	False	False
GFSMedia Pool	For GFS jobs. Specifies the target GFS media pool. Accepts VBRTapeGFSMediaPool object, 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
FullBackup Policy	Specifies virtualized synthetic full backup for tape settings. Accepts VBRFullBackupToTapePolicy object.	False	Named	False	False
Schedule Options	Specifies backup to tape job schedule. Default: Enabled: False. Type: Daily. DailyOptions: Type: SelectedDays, Period: 18:00, DayOfWeek: Saturday. MonthlyOptions: Period: 22:00, DayNumberInMonth: Fourth, DayOfWeek: Saturday, Months: January, February, March, April, May, June, July, August, September, October, November, December. ScheduleOptions: From Sunday to Saturday, from 00:00 to 23:00, Enabled: True. JobId: Null.	False	Named	False	False
Object	Specifies the backup job or backup repository that will be the source for this tape job. Accepts CBackupJob, VBREPJob or CBackupRepository objects. You can assign multiple jobs or repositories to this object.	False	Named	False	False
Process Incremental Backup	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 the you set for full backups.	False	Named	False	False
UseHardware Compression	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 TipeSpan, integer or string types.	False	Named	False	False
WaitFor BackupJob	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
Notification Options	Specifies the email notification options. Accepts VBRNotificationOptions object.	False	Named	False	False
JobScript Options	Specifies scripting options. Accepts VBRJobScriptOptions object.	False	Named	False	False
AlwaysCopy FromLatest Full	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 job(s) that are available on disk.	False	Named	False	False
GFS Schedule Options	Specifies the schedule settings for the GFS media pool. Accepts the VBRTapeGFSScheduleOptions object.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

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.

PS C:\PS> $newpool = Get-VBRTapeMediaPool -Name "Incremental Backups"

PS C:\PS> Get-VBRTapeJob -Name "Daily WebApp Backup" | Set-VBRBackupToTapeJob -IncrementalBackupMediaPool $newpool