This is an archive version of the document. To get the most up-to-date information, see the current version.Add-VBRFileToTapeJob
Short Description
Creates file to tape job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRFileToTapeJob -Name <String> [-Description <String>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] -FullBackupMediaPool <VBRTapeMediaPool> [-IncrementalBackupMediaPool <VBRTapeMediaPool>] [-ExportDays <DayOfWeek[]>] [-FullBackupPolicy <VBRFileToTapeBackupPolicy>] [-IncrementalBackupPolicy <VBRFileToTapeBackupPolicy>] [-Object <VBRFileToTapeObject[]>] [-UseVSS] [-UseHardwareCompression] [-NotificationOptions] [-JobScriptOptions] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] |
Related Commands
Return Type
Detailed Description
This cmdlet creates a new file to tape job.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
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 | 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 |
FullBackup | 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 | 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 |
Export | 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 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 | 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 VBRFileToTapeJob 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 | 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 | Specifies the email notification options. Accepts VBRNotificationOptions object. | False | Named | False | False |
JobScript | Specifies scripting options. Accepts VBRJobScriptOptions 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
This command creates a file to tape job that backs up the "Payroll Reports" folder. The job runs once a month and creates only full backups.
- Run Get-VBRServer to get the server where the files are located. Save it to the $server variable.
- Run Get-VBRCredentials to get the credentials to access the Fileserver08. Save the credentials to the $creds variable.
- Run New-VBRFileToTapeObject. Use the $server and the $creds variables to create the object for the job.
- Get the media pool with the Get-VBRTapeMediaPool and save it to the $mediapool variable.
- Run New-VBRMonthlyOptions to create the monthly options object and save it to the $monthlyoptions variable.
- Create the job schedule with New-VBRFileToTapeBackupPolicy. Use the $monthlyoptions. Save the result to the $policy variable.
- Create the tape job. Run Add-VBRFileToTapeJob and use the saved variables.
PS C:\PS> $server = Get-VBRServer -Name "fileserver08.tech.local" PS C:\PS> $creds = Get-VBRCredentials -Description "Fileserver08 Adminisrator" PS C:\PS> $object = New-VBRFileToTapeObject -Server $server -Path "D:\Summary Reports\Payroll Reports" -Credentials $creds PS C:\PS> $mediapool = Get-VBRTapeMediaPool -Name "File Backup Media Pool" PS C:\PS> $monthlyoptions = New-VBRMonthlyOptions -DayNumberInMonth Last -DayOfWeek Sunday -Period 22:00 PS C:\PS> $policy = New-VBRFileToTapeBackupPolicy -Type Monthly -MonthlyOptions $monthlyoptions -Enabled PS C:\PS> Add-VBRFileToTapeJob -Name "Payroll Reports to Tape" -Description "Finance reports: summary reports" -Object $object -FullBackupMediaPool $mediapool -FullBackupPolicy $policy |
