Get-VBRRestoreSession

Short Description

Returns restore sessions.

Applies to

Platform: VMware, Hyper-V

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get restore sessions of specific VMs.

Get-VBRRestoreSession [-Name <string[]>]  [<CommonParameters>]

  • Get restore sessions with specific IDs.

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

Detailed Description

This cmdlet returns restore sessions stored in Veeam Backup & Replication database.

You can get the list of all restore sessions or get the restore sessions of a specific VM or VMs.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Name

Specifies the array of VM names. The cmdlet will return the restore sessions of these VMs.

String[]

False

Named

False

Id

Specifies the array of the restore sessions IDs. The cmdlet will return the restore sessions with these IDs.

Guid[]

False

Named

False

<CommonParameters>

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

Examples

Get-VBRRestoreSessionExample 1. Getting All Restore Sessions in Database

This command looks for all restore sessions stored in the database.

Get-VBRRestoreSession

Get-VBRRestoreSessionExample 2. Getting Restore Sessions of Specific VMs

This command looks for the restore sessions of the Hv_DNS and Hv_DC VMs.

Get-VBRRestoreSession -Name "Hv_DNS", "Hv_DC"

Page updated 12/18/2023

Page content applies to build 12.3.0.310