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

Set-VBRFileToTapeJob

On This Page

Short Description
Applies to
Syntax
Return Type
Detailed Description
Parameters
Example

Short Description

Modifies file to tape job.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRFileToTapeJob -Job <VBRFileToTapeJob> [-Name <String>] [-Description <String>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] [-FullBackupMediaPool <VBRTapeMediaPool>] [-IncrementalBackupMediaPool <VBRTapeMediaPool>] [-ExportDays <DayOfWeek[]>] [-FullBackupPolicy <VBRFileToTapeBackupPolicy>] [-IncrementalBackupPolicy <VBRFileToTapeBackupPolicy>] [-Object <VBRFileToTapeObject[]>] [-UseVSS] [-UseHardwareCompression] [-NotificationOptions] [-JobScriptOptions] [-PassThru] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Related Commands

Get-VBRTapeJob

Get-VBRTapeMediaPool

New-VBRFileToTapeBackupPolicy

New-VBRFileToTapeObject

Return Type

VBRFileToTapeJob

Detailed Description

This cmdlet modifies a selected file to tape job that was created before. 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 file to tape job to which you want to apply new settings. Accepts VBRFileToTapeJob or TapeJob objects, GUID or string type.	True	Named	True (by Value FromPipeline, ValueFromPipeline ByPropertyName)	False
Name	Specifies the name you want to assign to the file to tape job. Accepts string type.	True	Named	False	False
Description	Specifies the description of the file 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
FullBackup MediaPool	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 MediaPool	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. If you do not specify a media pool, incremental backups will be stored to the media pool the you set for full backups.	False	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 VBRFileToTapeBackupPolicy object. Default: 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 Enabled: false	False	Named	False	False
Incremental Backup Policy	Specifies incremental backup settings. Accepts VBRFileToTapeBackupPolicy object. Default: 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. Enabled: False.	False	Named	False	False
Object	Specifies the source file system object. Accepts VBRFileToTapeObject object. You can assign multiple files to this object.	False	Named	False	False
UseVSS	Indicates that the VSS (Microsoft Volume Shadow Copy) must be used. Default: true.	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
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

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 full 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 "File Backups"

PS C:\PS> Get-VBRTapeJob -Name "File Backup to Tape" | Set-VBRFileToTapeJob -FullBackupMediaPool $newpool