Stop-VBRMoveBackupSession

Short Description

Specifies how to process backups for which a move sessions failed.

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

Syntax

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

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

Detailed Description

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

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
ActionType	Specifies what to do: `DetachFailed`: do not move backups for which the session failed. `Undo`: cancel all changes the move 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 move session that failed (has the User action required status). Accepts the `VBRMoveBackupSession` object. To get this object, run the `Get-VBRMoveBackupSession` cmdlet.	`VBRMoveBackupSession`	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 move session.

Examples

Not Moving Backups for Which Session Failed

This example shows how not to move backups for which the session failed.

$sessions = Get-VBRMoveBackupSession

Stop-VBRMoveBackupSession -ActionType DetachFailed -Session $sessions

Perform the following steps:

Run the Get-VBRMoveBackupSession cmdlet. Save the result to the $sessions variable.
Run the Stop-VBRMoveBackupSession cmdlet. Set the DetachFailed option for the ActionType parameter. Set the $sessions variable as the Session parameter value.