Help Center
Choose product document...
Veeam Backup for Microsoft Office 365 2.0
PowerShell Reference

Get-VBORestoreSession

Short Description

Returns restore sessions.

Syntax

This cmdlet provides 2 parameter sets:

  • For getting a restore session with a specified id:

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

  • For getting 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

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.

True

Named

False

False

Name

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

True

Named

False

False

Status

Specifies the current status of the restore session:

  • Running
  • Stopped

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

False

Named

False

False

Last

Indicates that the cmdlet will select the last restore session.

False

Named

False

False

Result

Specifies the status of the completed restore session:

  • Success
  • Warning
  • Failed

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

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This command returns restore session with a specified ID:

PS C:\PS> Get-VBORestoreSession -Id 4a4aaaa4-4aa4-44a4-aaa4-a4a444444aa4

Example 2

This command returns restore session with a specified name:

PS C:\PS> Get-VBORestoreSession -Name TestRestoreSession

Veeam Large Logo

User Guide

RESTful API Reference

PowerShell Reference