Remove-VBRBackupCopyJob
Short Description
Removes backup copy jobs.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
Remove-VBRBackupCopyJob -Job <VBRBackupCopyJob[]> [-WhatIf] [-Confirm] [<CommonParameters>] |
Detailed Description
This cmdlet removes backup copy jobs.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Job | Specifies an array of backup copy jobs that you want to remove. | Accepts the VBRBackupCopyJob[] object. To create this object, run the Get-VBRBackupCopyJob cmdlet. | True | 0 | True(ByValue, ByPropertyName) |
WhatIf | Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action. | SwitchParameter | False | Named | False |
Confirm | Defines that the cmdlet will display a prompt that asks if you want to continue running the command. Note: Microsoft PowerShell enables the Confirm parameter for this cmdlet by default. To disable this option, set the parameter value to $false. That is, Confirm:$false. | SwitchParameter | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
None.
Examples
Removing Backup Copy Job
This example shows how to remove a backup copy job.
$job = Get-VBRBackupCopyJob Remove-VBRBackupCopyJob -Job $job |
Perform the following steps:
- Run the Get-VBRBackupCopyJob cmdlet. Save the result to the $job variable.
- Run the Remove-VBRBackupCopyJob cmdlet. Set the $job variable as the Job parameter value.
Related Commands