Add-VBRFileToTapeJob

In this article

    Short Description

    Creates file to tape job.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Add-VBRFileToTapeJob -Name <string> -FullBackupMediaPool <VBRTapeMediaPool> [-Description <string>][-EjectCurrentMedium] [-ExportCurrentMediaSet] [-IncrementalBackupMediaPool <VBRTapeMediaPool>] [-ExportDays{Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-FullBackupPolicy <VBRFileToTapeBackupPolicy>] [-IncrementalBackupPolicy <VBRFileToTapeBackupPolicy>] [-Object <VBRFileToTapeObject[]>] [-NdmpObject <VBRNDMPVolume[]>] [-UseVSS] [-UseHardwareCompression] [-NotificationOptions <VBRNotificationOptions>] [-JobScriptOptions <VBRJobScriptOptions>] [-Force]  [<CommonParameters>]

    Detailed Description

    This cmdlet creates a new file to tape job.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

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

    True

    Named

    False

    False

    Description

    Specifies the description of the file to tape job.

    False

    Named

    False

    False

    EjectCurrentMedium

    Indicates that the tapes will be automatically ejected from drive after the job finishes.

    The ejected tape is moved to a standard library slot.

    False

    Named

    False

    False

    ExportCurrentMediaSet

    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

    FullBackupMediaPool

    Specifies the media pool where you want to store full backups produced by this tape job.

    Accepts VBRTapeMediaPool, GUID or string type.

    True

    Named

    False

    False

    IncrementalBackupMediaPool

    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, 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

    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

    FullBackupPolicy

    Specifies virtualized synthetic full backup for tape settings.

    Accepts VBRFileToTapeBackupPolicy type.

    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

    IncrementalBackupPolicy

    Specifies incremental backup settings.

    Accepts VBRFileToTapeBackupPolicy type.

    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 array of file to tape job sources.

    Accepts VBRFileToTapeJob type.

    False

    Named

    False

    False

    NdmpObject

    Specifies an array of NDMP server volumes.

    Accepts the VBRNDMPVolume[] object. Run the Get-VBRNDMPVolume cmdlet to get this object.

    False

    Named

    False

    False

    UseVSS

    Indicates that the VSS (Microsoft Volume Shadow Copy) must be used.

    Default: True.

    False

    Named

    False

    False

    UseHardwareCompression

    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

    NotificationOptions

    Specifies the email notification options.

    Accepts VBRNotificationOptions type.

    False

    Named

    False

    False

    JobScriptOptions

    Specifies scripting options.

    Accepts VBRJobScriptOptions type.

    False

    Named

    False

    False

    Force

    Indicates that the cmdlet will create a job even if the geographical location of the repositories where VM backups reside and the target media pool location do not match.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    VBRFileToTapeJob

    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.

    1. Run Get-VBRServer to get the server where the files are located. Save it to the $server variable.
    2. Run Get-VBRCredentials to get the credentials to access the Fileserver08. Save the credentials to the $creds variable.
    3. Run New-VBRFileToTapeObject. Use the $server and the $creds variables to create the object for the job.
    4. Get the media pool with the Get-VBRTapeMediaPool and save it to the $mediapool variable.
    5. Run New-VBRMonthlyOptions to create the monthly options object and save it to the $monthlyoptions variable.
    6. Create the job schedule with New-VBRFileToTapeBackupPolicy. Use the $monthlyoptions. Save the result to the $policy variable.
    7. Create the tape job. Run Add-VBRFileToTapeJob and use the saved variables.

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

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

    $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

    Related Commands

    Get-VBRTapeMediaPool

    New-VBRFileToTapeBackupPolicy

    New-VBRFileToTapeObject

    New-VBRNotificationOptions

    New-VBRJobScriptOptions

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.