Stop-VBRCopyBackupSession

Short Description

Specifies how to process backups for which a copy session failed.

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

Syntax

Stop-VBRCopyBackupSession -Session <VBRCopyBackupSession> [-ActionType <VBRBackupMoveCopySessionStopAction>]

[-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet specifies how to process backups for which a copy session failed.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ActionType	Specifies what to do: `DetachFailed`: do not copy backups for which the session failed. `Undo`: cancel all changes the copy session made.	`VBRBackupMoveCopySessionStopAction`	False	Named	False
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	`SwitchParameter`	False	Named	False
Session	Specifies the copy session that failed (has the User action required status). Accepts the `VBRCopyBackupSession` object. To get this object, run the `Get-VBRCopyBackupSession` cmdlet.	`VBRCopyBackupSession`	True	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
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

<CommonParameters>

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

Output Object

The cmdlet returns the VBRSession object that contains settings of the copy session.

Examples

Canceling Changes Made by Failed Copy Session

This example shows how to cancel all changes made by the copy session of the Exchange Backup backup.

$backup = Get-VBRBackup -Name "Exchange Backup"

$session = Get-VBRCopyBackupSession -Backup $backup

Stop-VBRCopyBackupSession -Session $session -ActionType Undo

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRCopyBackupSession cmdlet. Set the $backup variable as the Backup parameter value. Save the result to the $session variable.
Run the Stop-VBRCopyBackupSession cmdlet. Specify the following settings:
- Set the $session variable as the Session parameter value.
- Set the Undo value for the ActionType parameter.