Add-VBRObjectToTapeJob

Short Description

Creates an object to tape or GFS object to tape job.

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

Syntax

This cmdlet provides the following parameter sets:

SimpleMediaPool

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

-FullBackupMediaPool <VBRTapeMediaPool> -IncrementalBackupMediaPool <VBRTapeMediaPool>

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

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

[-UseHardwareCompression] [-NotificationOptions <VBRNotificationOptions>]

[-JobScriptOptions <VBRJobScriptOptions>] [-EnableFileAclChangeTracking] [<CommonParameters>]

GFSMediaPool

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

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

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

-Object <VBRObjectStorageBackupJobObject[]> [-UseHardwareCompression]

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

[-JobScriptOptions <VBRJobScriptOptions>] [-EnableFileAclChangeTracking] [<CommonParameters>]

Detailed Description

This cmdlet creates a new object to tape or GFS object to tape job.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Description	Specifies the description of the object 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
ExportCurrentMediaSet	For non-GFS object 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
FullBackupMediaPool	For non-GFS object to tape jobs. Specifies the media pool where you want to store full backups produced by this tape job. Accepts the `VBRTapeMediaPool` object, GUID or string. To get this object, run the `Get-VBRTapeMediaPool` cmdlet.	`VBRTapeMediaPool`	True	Named	False
FullBackupPolicy	Specifies virtual 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 `VBRFullBackupToTapePolicy` object. To create this object, run the `New-VBRFullBackupToTapePolicy` cmdlet.	`VBRFileToTapeBackupPolicy`	False	Named	False
GFSMediaPool	For GFS object 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 object 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 object 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 object to tape jobs. Specifies the media pool where you want to store incremental backups produced by this tape job. Accepts the `VBRTapeMediaPool` object, GUID or string. To get this object, run the `Get-VBRTapeMediaPool` cmdlet.	`VBRTapeMediaPool`	True	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
Name	Specifies the name you want to assign to the object to tape job.	`String`	True	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 object to tape job sources. Accepts the `VBRObjectStorageBackupJobObject[]` object, GUID or string. To create this object, run the `New-VBRObjectStorageBackupJobObject` cmdlet.	`VBRObjectStorageBackupJobObject[]`	True	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

<CommonParameters>

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

Output Object

VBRObjectToTapeJob

Examples

Add-VBRObjectToTapeJob Example 1. Creating Object to Tape Job

This example shows how to create an object to tape job that backs up the Sydney Container Microsoft Azure container. The full backup runs every last Sunday of the month and incremental backups run daily at 22:00.

$server = Get-VBRUnstructuredServer -Name "Azure Blob Storage"

$object = New-VBRObjectStorageBackupJobObject -Server $server -Container "Sydney Container"

$mediapool = Get-VBRTapeMediaPool -Name "Object Storage Backup Media Pool"

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

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

$dailyoptions = New-VBRDailyOptions -Type Everyday -Period 22:00

$dailypolicy = New-VBRFileToTapeBackupPolicy -Type Daily -DailyOptions $dailyoptions -Enabled

Add-VBRObjectToTapeJob -Name "Sydney Container to Tape" -Description "Backing up Sydney Azure Container" -Object $object -FullBackupMediaPool $mediapool -FullBackupPolicy $monthlypolicy -IncrementalBackupMediaPool $mediapool -IncrementalBackupPolicy $dailypolicy

Perform the following steps:

Run the Get-VBRUnstructuredServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the New-VBRObjectStorageBackupJobObject cmdlet. Set the $server variable as the Server parameter value. Specify the Container 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. Set Last as the DayNumberInMonth parameter value and Sunday as the DayOfWeek parameter value. Specify the Period parameter. Save the result to the $monthlyoptions variable.
Run the New-VBRFileToTapeBackupPolicy cmdlet. Set Monthly as the Type parameter value. Set the $monthlyoptions variable as the MonthlyOptions parameter value. Provide the Enabled parameter. Save the result to the $monthlypolicy variable.
Run the New-VBRDailyOptions cmdlet. Set Everyday as the Type parameter value and 22:00 as the Period parameter value. Save the result to the $dailyoptions variable.
Run the New-VBRFileToTapeBackupPolicy cmdlet. Set Daily as the Type parameter value. Set the $dailyoptions variable as the DailyOptions parameter value. Provide the Enabled parameter. Save the result to the $dailypolicy variable.
Run the Add-VBRObjectToTapeJob 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 $monthlypolicy variable as the FullBackupPolicy parameter value.
- Set the $mediapool variable as the IncrementalBackupMediaPool parameter value.
- Set the $dailypolicy variable as the IncrementalBackupPolicy parameter value.

Add-VBRObjectToTapeJob Example 2. Creating GFS Object to Tape Job

This example shows how to create a GFS object to tape job that backs up the Sydney Container Microsoft Azure container.

$server = Get-VBRUnstructuredServer -Name "Azure Blob Storage"

$object = New-VBRObjectStorageBackupJobObject -Server $server -Container "Sydney Container"

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

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

Add-VBRObjectToTapeJob -Name "Sydney Container to Tape" -Description "Backing up Sydney Azure Container" -Object $object -GFSMediaPool $mediapool -GFSScheduleOptions $schedule

Perform the following steps:

Run the Get-VBRUnstructuredServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the New-VBRObjectStorageBackupJobObject cmdlet. Set the $server variable as the Server parameter value. Specify the Container 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.
Run the Add-VBRObjectToTapeJob 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.