Add-VBRObjectToTapeJob

Short Description

Creates an object to tape job.

Note

This cmdlet is available starting from Veeam Backup & Replication 12.1 (build 12.1.0.2131).

Applies to

Platform: VMware, Hyper-V

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

Syntax

Add-VBRObjectToTapeJob -Name <string> -FullBackupMediaPool <VBRTapeMediaPool> -Object <VBRObjectStorageBackupJobObject[]> [-Description <string>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] [-IncrementalBackupMediaPool <VBRTapeMediaPool>] [-ExportDays {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-FullBackupPolicy <VBRFileToTapeBackupPolicy>] [-IncrementalBackupPolicy <VBRFileToTapeBackupPolicy>] [-UseHardwareCompression] [-NotificationOptions <VBRNotificationOptions>] [-JobScriptOptions <VBRJobScriptOptions>] [-EnableFileAclChangeTracking]  [<CommonParameters>]

Detailed Description

This cmdlet creates a new object to tape job.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Name

Specifies the name you want to assign to the object to tape job.

String

True

Named

False

Description

Specifies the description of the object to tape job.

String

False

Named

False

FullBackupMediaPool

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.

True

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.

True

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

ExportCurrentMediaSet

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

IncrementalBackupMediaPool

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.

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

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.

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.

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

NotificationOptions

Specifies the email notification options.

Accepts the VBRNotificationOptions object. To create this object, run the New-VBRNotificationOptions cmdlet.

False

Named

False

JobScriptOptions

Specifies scripting options.

Accepts the VBRJobScriptOptions object. To create this object, run the New-VBRJobScriptOptions cmdlet.

False

Named

False

EnableFileAclChangeTracking

Enables backup of permissions and attributes for files.

Default: False.

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

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:

  1. Run the Get-VBRUnstructuredServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  2. 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.
  3. Run the Get-VBRTapeMediaPool cmdlet. Specify the Name parameter value. Save it to the $mediapool variable.
  4. Run the New-VBRMonthlyOptions cmdlet. Set Last as the DayNumberInMonth parameter value and Sunday as the DayOfWeek parameter value. Save the result to the $monthlyoptions variable.
  5. 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.
  6. 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.
  7. 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 $policy variable.
  8. Run the Add-VBRObjectToTapeJob cmdlet. Specify the following settings:
  • Specify the Name and the Description parameter value.
  • 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.

Related Commands