Add-VBRTapeVMJob (obsolete)

In this article

    Short Description

    Creates a new backup to tape copy job.

    Add-VBRTapeVMJob (obsolete) Note:

    This cmdlet is obsolete. The cmdlet still works, but it is recommended to create backup to tape copy jobs using the Add-VBRBackupToTapeJob cmdlet.

    Applies to

    Platform: VMware, Hyper-V

    Syntax

    Add-VBRTapeVMJob [-Name <String>] [-Repository <CBackupRepository[]>] [-BackupJob <CBackupJob[]>] -MediaPool <MediaPool> [-MediaPoolIncremental <MediaPool>] [-DisableIncremental] [-HardwareCompression] [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet creates a new job that copies VM backups to tape.

    To be able to create a backup to tape copy job, you need to have existing backups available.

    You can copy VM backups in two ways:

    • From backup jobs: the tape job looks for backup files that have been produced by the specified backup job from the moment of the last tape job run,
    • From backup repository: the tape job looks for all VM backups that have written to the specified backup repository from the moment of the last tape job run.

    Note that when you create a copy job, you need to run it manually.

    Run Start-VBRJob to start the created job.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the name you want to assign to the VM to tape copy job.

    False

    Named

    False

    False

    Repository

    Specifies a source backup repository you want to use as the source for the VM backups.

    You can assign multiple backup repositories to this object.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    BackupJob

    Specifies the backup job you want to use as the source for the VM backups.

    You can assign multiple backup jobs to this object.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    MediaPool

    Specifies the target media pool you want to use for full backups.

    You can input string up to 255 symbols.

    True

    Named

    False

    False

    MediaPool
    Incremental

    Specifies the target media pool you want to use for incremental backups.

    False

    Named

    False

    False

    Disable
    Incremental

    If set, the tape job will copy only the full backup files. Otherwise, the incremental backups will be written to the media pool set in the -MediaPoolIncremental.

    Please be careful to set this parameter in case you do not want to store the incremental backups on tape. If it is not set, the incremental backups will be written to the media pool you set for the full backups.

    False

    Named

    False

    False

    Hardware
    Compression

    Enables hardware compression option.

    Note that if you plan to use hardware compression when recording backups to tape, consider that although it decreases traffic, this option affects performance.

    False

    Named

    False

    False

    Description

    Specifies the description of the new VM to tape copy job.

    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 1

    This command creates a job named "CRM Backup Copy to Tape" copying files from the backup job named "CRM Backup" to tape. The backup job is obtained with Get-VBRJob and piped down. The target media pools for full backups and incremental backups are obtained with Get-VBRTapeMediaPool and assigned to $full and $increment variables beforehand accordingly. The job description is "CRM Backup Copy to Tape".

    Get-VBRJob -Name "CRM Backup" | Add-VBRTapeVMJob -Name "CRM Backup Copy to Tape" - MediaPool $full -MediaPoolIncremental $increment -Description "CRM Backup Copy to Tape"

    Example 2

    This command creates a job named "Local Backup Copy to Tape" copying files from the backup repository named "Local Repository 01" to tape. The backup repository is obtained with Get-VBRBackupRepository and piped down. The target media pools for full backups is obtained with Get-VBRTapeMediaPool and assigned to $full variable beforehand. The incremental backups are not written to tape. The hardware compression option is enabled.

    Get-VBRBackupRepository -Name "Local Repository 01" | Add-VBRTapeVMJob -Name "Local Backup Copy to Tape" - MediaPool $full -DisableIncremental -HardwareCompression

    Example 3

    This command creates a job named "Local Backup Copy to Tape" copying files from the backup repository represented by the $repository variable. The backup repository is obtained with Get-VBRBackupRepository and assigned to the variable beforehand. The target media pools for full backups is obtained with Get-VBRTapeMediaPool and assigned to $full variable beforehand. The incremental backups are not written to tape.

    Add-VBRTapeVMJob -Name "Local Backup Copy to Tape" -Repository $repository -MediaPool $full -DisableIncremental

    Related Commands

    Get-VBRTapeMediaPool

    Get-VBRBackupRepository

    Get-VBRJob

    I want to report a typo

    There is a misspelling right here:

     

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