Add-VBRTapeVMJob (obsolete)

Short Description

Creates a new backup to tape copy job.

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.

Platform: VMware, Hyper-V

Syntax

Add-VBRTapeVMJob [-Name <String>] [-Repository <CBackupRepository[]>] [-BackupJob <CBackupJob[]>]

-MediaPool <CTapeMediaPool> [-MediaPoolIncremental <CTapeMediaPool>] [-DisableIncremental]

[-HardwareCompression] [-Description <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 the Start-VBRJob cmdlet to start the created job.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
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. Accepts the `CBackupJob[]` object. To get this object, run the `Get-VBRJob` cmdlet.	`CBackupJob[]`	False	Named	True (ByPropertyName, ByValue)
Description	Specifies the description of the new VM to tape copy job.	`String`	False	Named	False
DisableIncremental	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`. Note: 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.	`SwitchParameter`	False	Named	False
HardwareCompression	Enables hardware compression option. Note: If you plan to use hardware compression when recording backups to tape, consider that although it decreases traffic, this option affects performance.	`SwitchParameter`	False	Named	False
MediaPool	Specifies the target media pool you want to use for full backups. You can input string up to 255 symbols. Accepts the `MediaPool` object. To get this object, run the `Get-VBRTapeMediaPool` cmdlet.	`CTapeMediaPool`	True	Named	False
MediaPoolIncremental	Specifies the target media pool you want to use for incremental backups. Accepts the `MediaPool` object. To get this object, run the `Get-VBRTapeMediaPool` cmdlet.	`CTapeMediaPool`	False	Named	False
Name	Specifies the name you want to assign to the VM to tape copy job.	`String`	False	Named	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. Accepts the `CBackupRepository[]` object. To get this object, run the `Get-VBRBackupRepository` cmdlet.	`CBackupRepository[]`	False	Named	True (ByPropertyName, ByValue)

<CommonParameters>

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

Examples

Add-VBRTapeVMJob (obsolete) Example 1. Creating Backup to Tape Copy Job

This example shows how to create the CRM Backup Copy to Tape job copying files from the CRM Backup backup job to tape.

$full = Get-VBRTapeMediaPool -Name "File Backup Media Pool Full"

$increment = Get-VBRTapeMediaPool -Name "File Backup Media Pool Incremental"

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

Perform the following steps:

Run the Get-VBRTapeMediaPool cmdlet. Specify the Name parameter value. Save it to the $full variable.
Run the Get-VBRTapeMediaPool cmdlet. Specify the Name parameter value. Save it to the $increment variable.
Run the Get-VBRJob cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Add-VBRTapeVMJob cmdlet. Specify the following settings:
- Specify the Name parameter value.
- Set the $full variable as the MediaPool parameter value.
- Set the $increment variable as the MediaPoolIncremental parameter value.
- Specify the Description parameter value.

Add-VBRTapeVMJob (obsolete) Example 2. Creating Backup Repository to Tape Copy Job

This example shows how to create the Local Backup Copy to Tape job copying files from the Local Repository 01 backup repository to tape.

$full = Get-VBRTapeMediaPool -Name "File Backup Media Pool Full"

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

Perform the following steps:

Run the Get-VBRTapeMediaPool cmdlet. Specify the Name parameter value. Save it to the $full variable.
Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Add-VBRTapeVMJob cmdlet. Specify the following settings:
- Specify the Name parameter value.
- Set the $full variable as the MediaPool parameter value.
- Provide the DisableIncremental parameter.
- Provide the HardwareCompression parameter.

Add-VBRTapeVMJob (obsolete) Example 3. Creating Backup Repository to Tape Copy Job [Using Variable]

This example shows how to create the Local Backup Copy to Tape job copying files from the Local Repository 01 backup repository to tape.

$full = Get-VBRTapeMediaPool -Name "File Backup Media Pool Full"

$repository = Get-VBRBackupRepository -Name "Local Repository 01"

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

Perform the following steps:

Run the Get-VBRTapeMediaPool cmdlet. Specify the Name parameter value. Save it to the $full variable.
Run the Get-VBRBackupRepository cmdlet. Specify the Name parameter value. Save it to the $repository variable.
Run the Add-VBRTapeVMJob cmdlet. Specify the following settings:
- Specify the Name parameter value.
- Set the $repository variable as the Repository parameter value.
- Set the $full variable as the MediaPool parameter value.
- Provide the DisableIncremental parameter.