Get-VBORestoreSession

In this article

    Short Description

    Returns Veeam Backup for Microsoft Office 365 restore sessions.

    Syntax

    This cmdlet provides the following parameter sets.

    • 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

    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 on common parameters, see the About CommonParameters section of Microsoft Docs.

    Example

    Example 1

    This command returns restore session with a specified ID:

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

    Example 2

    This command returns restore session with a specified name:

    Get-VBORestoreSession -Name TestRestoreSession