Stop-VBORestoreSession

Short Description

Stops Veeam Backup for Microsoft 365 restore sessions.

Syntax

Stop-VBORestoreSession -Session <VBORestoreSession> [-WhatIf] [-Confirm]  [<CommonParameters>]

Detailed Description

This cmdlet stops a specific restore session.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Session

Specifies a restore session that you want to stop.

Accepts the VBORestoreSession object.

To get this object, run the Get-VBORestoreSession cmdlet.

True

Named

True (ByValue)

WhatIf

Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

Default: False

SwitchParameter

False

Named

False

Confirm

Defines that the cmdlet will display a prompt that asks if the user is sure that he wants to continue.

Default: True

SwitchParameter

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Example

Stopping Restore Session

This example shows how to stop the restore session.

$session = Get-VBORestoreSession

Stop-VBORestoreSession -Session $session

Perform the following steps:

  1. Run the Get-VBORestoreSession cmdlet to get the restore session you want to stop. Save the result to the $session variable.
  2. Run the Stop-VBORestoreSession cmdlet with the $session variable.

Related Commands

Get-VBORestoreSession

Page updated 5/14/2024

Page content applies to build 8.0.2.200