This is an archive version of the document. To get the most up-to-date information, see the current version.Add-VBRBackupToTapeJob
Short Description
Creates backup to tape job or a GFS job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
This cmdlet provides two parameter sets.
- For creating a job targeted to a simple media pool:
Add-VBRBackupToTapeJob -Name <String> [-Description <String>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] -FullBackupMediaPool <VBRTapeMediaPool> [-IncrementalBackupMediaPool <VBRTapeMediaPool>] [-ExportDays <DayOfWeek[]>] [-FullBackupPolicy <VBRFullBackupToTapePolicy>] [-ScheduleOptions <VBRBackupToTapeScheduleOptions>] [-Object <Object[]>] [-ProcessIncrementalBackup] [-UseHardwareCompression] [-WaitPeriod <TimeSpan>] [-WaitForBackupJob] [-NotificationOptions <VBRNotificationOptions>] [-JobScriptOptions <VBRJobScriptOptions>] [-CopyFromLatestFull] [-AlwaysCopyFromLatestFull] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-PipelineVariable <String>] [<CommonParameters>] |
- For creating a GFS job:
Add-VBRBackupToTapeJob -Name <String> [-Description <String>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] -GFSMediaPool <VBRTapeGFSMediaPool> [-ExportDays <DayOfWeek[]>] [-FullBackupPolicy <VBRFullBackupToTapePolicy>] [-ScheduleOptions <VBRBackupToTapeScheduleOptions>] [-Object <Object[]>] [-ProcessIncrementalBackup] [-UseHardwareCompression] [-WaitPeriod <TimeSpan>] [-WaitForBackupJob] [-NotificationOptions <VBRNotificationOptions>] [-JobScriptOptions <VBRJobScriptOptions>] [-CopyFromLatestFull] [-AlwaysCopyFromLatestFull] [-GFSScheduleOptions <VBRTapeGFSScheduleOptions>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-PipelineVariable <String>] [<CommonParameters>] |
Related Commands
New-VBRBackupToTapeScheduleOptions
New-VBRBackupToTapeScheduleOptions
Return Type
Detailed Description
This cmdlet creates a new backup to tape job or a GFS job. Target the job to a simple or a GFS media pool respectively.
The backup to tape job archives backups that were produced by particular backup or Endpoint jobs or stored on particular backup repositories. Use the Object parameter to set a backup job or a backup repository as source to the tape job.
|
If you choose to archive data from backup repositories, the backup to tape job will process only the backups that were created with backup jobs configured on this Veeam backup server. Imported backups and configuration backups will be skipped from processing. |
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Name | Specifies the name you want to assign to the backup to tape job. Accepts string type. | True | 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 | 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 | 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 | 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 | 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 | 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 | Specifies virtualized synthetic full backup for tape settings. Accepts VBRFullBackupToTapePolicy object. | False | Named | False | False |
Schedule | Specifies backup to tape job schedule. By default, the following settings are applied: 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 | 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 | 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 | 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 | Specifies the email notification options. Accepts VBRNotificationOptions object. | False | Named | False | False |
JobScript | Specifies scripting options. Accepts VBRJobScriptOptions object. | False | Named | False | False |
CopyFrom | Indicates that on the first run the tape job must copy only the latest backup chain. Otherwise,on the first run the job will copy all restore points produced by the source backup job(s) that are available on disk. | False | Named | False | False |
AlwaysCopy | 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 | Specifies the schedule settings for the GFS media pool. Accepts the VBRTapeGFSScheduleOptions object. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example
Example
This example shows how to create a tape job that has a backup job as source. The tape job will use the same media pool to back up full and incremental backups.
- Run Get-VBRJob to get the backup job that will be the source. Save the job to the $job variable.
- Run Get-VBRTapeMediaPool to get the media pool. Use the same media pool to write full and incremental backups. Save the media pool to the $mediapool variable.
- Configure the job schedule. Run New-VBRDailyOptions to set the day and time. Save the result to the $dailyoptions variable. Run New-VBRBackupToTapeScheduleOptions with the $dailyoptions variable. Save the schedule to the $scheduleoptions variable.
- Run Add-VBRBackupToTapeJob to create the tape job. Use the saved variables.
PS C:\PS> $job = Get-VBRJob -Name "SQL 1 Backup" PS C:\PS> $mediapool = Get-VBRTapeMediaPool -Name "SQL Backups Media Pool" PS C:\PS> $dailyoptions = New-VBRDailyOptions -DayOfWeek Friday -Period 23:00 PS C:\PS> $scheduleoptions = New-VBRBackupToTapeScheduleOptions -DailyOptions $dailyoptions -Enabled PS C:\PS> Add-VBRBackupToTapeJob -Name "SQL to Tape" -Description "SQL archive" -Object $job -FullBackupMediaPool $mediapool -ProcessIncrementalBackup -IncrementalBackupMediaPool $mediapool -ExportDays Monday -ScheduleOptions $scheduleoptions |
