Stop-VBRMoveBackupSession

Short Description

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

Applies to

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

Syntax

Stop-VBRMoveBackupSession [-ActionType {DetachFailed | Undo}] [-RunAsync] -Session <VBRMoveBackupSession> [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

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

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Sessionv

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.

True

Named

False

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

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.

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.