Get-VBORestoreSession

Short Description

Returns Veeam Backup for Microsoft 365 restore sessions.

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get a restore session with a specified ID.

Get-VBORestoreSession -Id <guid>  [<CommonParameters>]

  • Get a restore session with a specified name, status or result.

Get-VBORestoreSession [-Name <string>] [-Status <VBORestoreSessionStatus>] [-Result <VBORestoreSessionResult>] [-Last]  [<CommonParameters>]

Detailed Description

This cmdlet returns restore sessions.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Id

Specifies system ID assigned to a restore session. The cmdlet will return the restore session with this ID.

Guid

True

Named

False

False

Name

Specifies a name of the restore session. The cmdlet will return the restore session with this name.

String

False

Named

False

False

Status

Specifies the current status of the restore session:

  • Running
  • Stopped

The cmdlet will return the restore session with the specified status.

VBORestoreSessionStatus

False

Named

False

False

Last

Defines that the cmdlet will return the latest restore session.

SwitchParameter

False

Named

False

False

Result

Specifies the status of the completed restore session:

  • Success
  • Warning
  • Failed

The cmdlet will return the restore session with the specified result.

VBORestoreSessionResult

False

Named

False

False

<CommonParameters>

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

Example

Get-VBORestoreSessionExample 1. Getting Specific Restore Session by ID

This command returns a restore session with the specified ID:

Get-VBORestoreSession -Id 4a4aaaa4-4aa4-44a4-aaa4-a4a444444aa4

Get-VBORestoreSessionExample 2. Getting Specific Restore Session by Name

This command returns a restore session with the specified name:

Get-VBORestoreSession -Name "TestRestoreSession"