Add-VBRFileToTapeJob

Short Description

Creates a file to tape job or a GFS file to tape job.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

SimpleMediaPool

Add-VBRFileToTapeJob -Name <String> [-Description <String>] [-EjectCurrentMedium] [-ExportCurrentMediaSet]

-FullBackupMediaPool <VBRTapeMediaPool> [-IncrementalBackupMediaPool <VBRTapeMediaPool>]

[-ExportDays <DayOfWeek[]>] [-FullBackupPolicy <VBRFileToTapeBackupPolicy>]

[-IncrementalBackupPolicy <VBRFileToTapeBackupPolicy>] [-Object <VBRFileToTapeObject[]>]

[-NdmpObject <VBRNDMPVolume[]>] [-UseVSS] [-UseHardwareCompression]

[-NotificationOptions <VBRNotificationOptions>] [-JobScriptOptions <VBRJobScriptOptions>] [-Force]

[-EnableParallelDrivesUsage] [-LimitTapeDrives <Int32>] [-EnableFileAclChangeTracking] [<CommonParameters>]

GFSMediaPool

Add-VBRFileToTapeJob -Name <String> [-Description <String>] [-EjectCurrentMedium] [-ExportCurrentMediaSet]

-GFSMediaPool <VBRTapeGFSMediaPool> [-GFSMediaSetsToExport <VBRGFSMediaSetTypeToExport[]>]

[-FullBackupPolicy <VBRFileToTapeBackupPolicy>] [-IncrementalBackupPolicy <VBRFileToTapeBackupPolicy>]

[-Object <VBRFileToTapeObject[]>] [-NdmpObject <VBRNDMPVolume[]>] [-UseVSS] [-UseHardwareCompression]

[-GFSScheduleOptions <VBRTapeGFSScheduleOptions>] [-NotificationOptions <VBRNotificationOptions>]

[-JobScriptOptions <VBRJobScriptOptions>] [-Force] [-EnableParallelDrivesUsage] [-LimitTapeDrives <Int32>]

[-EnableFileAclChangeTracking] [<CommonParameters>]

Detailed Description

This cmdlet creates a new file to tape job or a GFS file to tape job. You can target the job to a simple or a GFS media pool.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Description	Specifies the description of the file to tape job.	`String`	False	Named	False
EjectCurrentMedium	Defines that the tapes will be automatically ejected from drive after the job finishes. The ejected tape is moved to a standard library slot.	`SwitchParameter`	False	Named	False
EnableFileAclChangeTracking	Enables backup of permissions and attributes for files. Default: `False`.	`SwitchParameter`	False	Named	False
EnableParallelDrivesUsage	Enables parallel processing of media pools. Default: `False`.	`SwitchParameter`	False	Named	False
ExportCurrentMediaSet	For non-GFS file to tape jobs. Defines 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.	`SwitchParameter`	False	Named	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`.	`DayOfWeek[]`	False	Named	False
Force	Defines that the cmdlet will create a job even if the geographic location of the repositories where VM backups reside and the target media pool location do not match.	`SwitchParameter`	False	Named	False
FullBackupMediaPool	For non-GFS file to tape jobs. Specifies the media pool where you want to store full backups produced by this tape job. Accepts the `VBRTapeMediaPool` obejct, GUID or string. To get this object, run the `Get-VBRTapeMediaPool` cmdlet.	`VBRTapeMediaPool`	True	Named	False
FullBackupPolicy	Specifies virtualized synthetic full backup for tape settings. 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` Accepts the `VBRFileToTapeBackupPolicy` object. To create this object, run the `New-VBRFileToTapeBackupPolicy` cmdlet.	`VBRFileToTapeBackupPolicy`	False	Named	False
GFSMediaPool	For GFS file to tape jobs. Specifies the target GFS media pool. Accepts the `VBRTapeGFSMediaPool` object, GUID or string. To get this object, run the `Get-VBRTapeMediaPool` cmdlet.	`VBRTapeGFSMediaPool`	True	Named	False
GFSMediaSetsToExport	For GFS file to tape jobs. Specifies GFS media sets for which the tapes will be automatically exported once the tape job is finished: `Daily` `Weekly` `Monthly` `Quarterly` `Yearly`	`VBRGFSMediaSetTypeToExport[]`	False	Named	False
GFSScheduleOptions	For GFS file to tape jobs. Specifies the schedule settings for the GFS media pool. Accepts the `VBRTapeGFSScheduleOptions` object. To create this object, run the `New-VBRTapeGFSScheduleOptions` cmdlet.	`VBRTapeGFSScheduleOptions`	False	Named	False
IncrementalBackupMediaPool	For non-GFS file to tape 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. If you do not specify a media pool, incremental backups will be stored to the media pool the you set for full backups. Accepts the `VBRTapeMediaPool` obejct, GUID or string. To get this object, run the `Get-VBRTapeMediaPool` cmdlet.	`VBRTapeMediaPool`	False	Named	False
IncrementalBackupPolicy	Specifies incremental backup settings. 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.` Accepts the `VBRFileToTapeBackupPolicy` object. To create this object, run the `New-VBRFileToTapeBackupPolicy` cmdlet.	`VBRFileToTapeBackupPolicy`	False	Named	False
JobScriptOptions	Specifies the scripting options. Accepts the `VBRJobScriptOptions` object. To create this object, run the `New-VBRJobScriptOptions` cmdlet.	`VBRJobScriptOptions`	False	Named	False
LimitTapeDrives	Defines that the cmdlet will limit the number of drives to use for processing this tape job. Default: 2 drives.	`Int32`	False	Named	False
Name	Specifies the name you want to assign to the file to tape job.	`String`	True	Named	False
NdmpObject	Specifies the array of NDMP server volumes. Accepts the `VBRNDMPVolume[]` object. Run the `Get-VBRNDMPVolume` cmdlet to get this object.	`VBRNDMPVolume[]`	False	Named	False
NotificationOptions	Specifies the email notification options. Accepts the `VBRNotificationOptions` object. To create this object, run the `New-VBRNotificationOptions` cmdlet.	`VBRNotificationOptions`	False	Named	False
Object	Specifies the array of file to tape job sources. Accepts the `VBRFileToTapeJob` object. To create this object, run the `New-VBRFileToTapeObject` cmdlet.	`VBRFileToTapeObject[]`	False	Named	False
UseHardwareCompression	Defines that tape library must perform hardware compression for archives. Do not use this option for archiving Veeam backups or other already compressed files.	`SwitchParameter`	False	Named	False
UseVSS	Defines that the VSS (Microsoft Volume Shadow Copy) must be used. Default: `True`. Note: To disable this option, set the parameter value to `$false`. That is, parameter_name`:$false`.	`SwitchParameter`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRFileToTapeJob

Examples

Add-VBRFileToTapeJob Example 1. Creating File to Tape Job

This example shows how to create a file to tape job that backs up the Payroll Reports folder. The job runs once a month and creates only full backups.

$server = Get-VBRServer -Name "fileserver08.tech.local"

$creds = Get-VBRCredentials -Description "Fileserver08 Administrator"

$object = New-VBRFileToTapeObject -Server $server -Path "D:\Summary Reports\Payroll Reports" -Credentials $creds

$mediapool = Get-VBRTapeMediaPool -Name "File Backup Media Pool"

$monthlyoptions = New-VBRMonthlyOptions -DayNumberInMonth Last -DayOfWeek Sunday -Period 22:00

$policy = New-VBRFileToTapeBackupPolicy -Type Monthly -MonthlyOptions $monthlyoptions -Enabled

Add-VBRFileToTapeJob -Name "Payroll Reports to Tape" -Description "Finance reports: summary reports" -Object $object -FullBackupMediaPool $mediapool -FullBackupPolicy $policy

Perform the following steps:

Run the Get-VBRServer cmdlet to get the server where the files are located. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-VBRCredentials cmdlet. Specify the Description parameter value. Save the result to the $creds variable.
Run the New-VBRFileToTapeObject cmdlet. Set the $server variable as the Server parameter value. Specify the Path parameter value. Set the $creds variable as the Credentials parameter value. Save the result to the $object variable.
Run the Get-VBRTapeMediaPool cmdlet. Specify the Name parameter value. Save the result to the $mediapool variable.
Run the New-VBRMonthlyOptions cmdlet. Specify the DayNumberInMonth, DayOfWeek and Period parameter values. Save the result to the $monthlyoptions variable.
Run the New-VBRFileToTapeBackupPolicy cmdlet. Set the Monthly option for the Type parameter. Set the $monthlyoptions variable as the MonthlyOptions parameter value. Provide the Enabled parameter. Save the result to the $policy variable.
Run the Add-VBRFileToTapeJob cmdlet. Specify the following settings:
- Specify the Name and the Description parameter values.
- Set the $object variable as the Object parameter value.
- Set the $mediapool variable as the FullBackupMediaPool parameter value.
- Set the $policy variable as the FullBackupPolicy parameter value.

Add-VBRFileToTapeJob Example 2. Creating GFS File to Tape Job

This example shows how to create a GFS file to tape job that backs up the Payroll Reports folder.

$server = Get-VBRServer -Name "fileserver08.tech.local"

$creds = Get-VBRCredentials -Description "Fileserver08 Administrator"

$object = New-VBRFileToTapeObject -Server $server -Path "D:\Summary Reports\Payroll Reports" -Credentials $creds

$mediapool = Get-VBRTapeMediaPool -Name "GFS Media Pool"

$schedule = New-VBRTapeGFSScheduleOptions -MonthlyKind DayOfMonth -MonthlyDayOfMonth 1

Add-VBRFileToTapeJob -Name "Payroll Reports to Tape" -Description "Finance reports: summary reports" -Object $object -GFSMediaPool $mediapool -GFSScheduleOptions $schedule -GFSMediaSetsToExport Yearly

Perform the following steps:

Run the Get-VBRServer cmdlet to get the server where the files are located. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-VBRCredentials cmdlet. Specify the Description parameter value. Save the result to the $creds variable.
Run the New-VBRFileToTapeObject cmdlet. Set the $server variable as the Server parameter value. Specify the Path parameter value. Set the $creds variable as the Credentials parameter value. Save the result to the $object variable.
Run the Get-VBRTapeMediaPool cmdlet. Specify the Name parameter value. Save the result to the $mediapool variable.
Run the New-VBRTapeGFSScheduleOptions cmdlet. Specify the MonthlyKind and MonthlyDayOfMonth parameter values. Save the result to the $schedule variable.
the Add-VBRFileToTapeJob cmdlet. Specify the following settings:
- Specify the Name and the Description parameter values.
- Set the $object variable as the Object parameter value.
- Set the $mediapool variable as the GFSMediaPool parameter value.
- Set the $schedule variable as the GFSScheduleOptions parameter value.
- Set the Yearly value as the GFSMediaSetsToExport parameter value.