Start-VEODRestoreSession

In this article

    Short Description

    Starts restore sessions to explore backed-up OneDrive items and to perform operations with these items.

    Applies to Veeam Backup for Microsoft Office 365

    Product Edition: Community, Rental, Subscription

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Explore and perform operations with OneDrive items from a specific restore point.

    Start-VEODRestoreSession [-RestorePoint] <IVBORestorePoint> [-Job <IVBOJob>] [-Organization <IVBOOrganization>][-Server <string>] [-Credential <pscredential>] [-Port <int>] [-ShowDeleted] [-ShowAllVersions]  [<CommonParameters>]

    • Explore and perform operations with OneDrive items from the latest restore point.

    Start-VEODRestoreSession -LatestState [-Job <IVBOJob>] [-Organization <IVBOOrganization>] [-Server <string>][-Credential <pscredential>] [-Port <int>] [-ShowDeleted] [-ShowAllVersions]  [<CommonParameters>]

    Updated Cmdlet Sets

    In Veeam Backup for Microsoft Office 365 3.0, the following cmdlet sets have been updated. If you had already used these cmdlet sets in previous versions, mind the syntax. The ShowDeleted and ShowAllVersions parameters have been added.

    • Explore and perform operations with OneDrive items from backups created by a specific job.

    Start-VEODRestoreSession [-Job] <IVBOJob> [-Server <string>] [-Credential <pscredential>] [-Port <int>] [-ShowDeleted] [-ShowAllVersions]  [<CommonParameters>]

    • Explore and perform operations with OneDrive items from backups created for a specific organization.

    Start-VEODRestoreSession [-Organization] <IVBOOrganization> [-Server <string>] [-Credential <pscredential>] [-Port <int>] [-ShowDeleted] [-ShowAllVersions]  [<CommonParameters>]

    Detailed Description

    This cmdlet starts a new restore session, establishes a connection to the Veeam Backup for Microsoft Office 365 server and retrieves data on OneDrive items backed up on this server. Within the restore session, you can get backed-up items using the following cmdlets:

    After you get backed-up items, you can perform the following operations with these items:

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Job

    Specifies a backup job to start a new restore session. You will be able to use the session to perform operations with items backed up by this job.

    Accepts the IVBOJob object. To get this object, run the Get-VBOJob cmdlet.

    True

    0

    True (ByValue)

    RestorePoint

    Specifies a restore point to start a new restore session. You will be able to use the session to perform operations with items that this restore point contains.

    Accepts the RestorePoint object.  To get this object, run the Get-VBORestorePoint cmdlet.

    True

    0

    True (ByValue)

    LatestState

    Defines that the cmdlet will retrieve items from the latest restore point. If you provide this parameter, you will be able to perform operations with items in the most recent restore state.

    SwitchParameter

    True

    Named

    False

    Organization

    Specifies an organization to start a new restore session. You will be able to use the session to perform operations with items backed up for this organization.

    Accepts the IVBOOrganization object. To get this object, run the Get-VBOOrganization cmdlet.

    True

    0

    True (ByValue)

    Server

    Specifies a DNS name or an IP address of Veeam Backup for Microsoft Office 365 server that backed up items you want to restore.

    Sting

    False

    Named

    False

    Credential

    Specifies credentials that will be used to authenticate against the Veeam Backup for Microsoft Office 365 server.

    PSCredential

    False

    Named

    False

    Port

    Specifies a port number that will be used to connect to the Veeam Backup for Microsoft Office 365 server.

    Default: 9194.

    Int

    False

    Named

    False

    ShowDeleted

    Defines that deleted items will be included in the current session. If you provide this parameter, you will be able to perform operations with these items.

    Note: If you provide this parameter, the amount of data returned by cmdlets within the current session may significantly increase.

    SwitchParameter

    False

    Named

    False

    ShowAllVersions

    Defines that all versions of SharePoint items will be included in the current session. If you provide this parameter, you will be able to perform operations with these items.

    Note: If you provide this parameter, the amount of data returned by cmdlets within the current session may significantly increase.

    SwitchParameter

    False

    Named

    False

    <CommonParameters>

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

    Examples

    Start-VEODRestoreSessionExample 1. Starting Restore Session from Restore Point

    This example shows how to start a restore session to retrieve items from a specific restore point created on the srv08.veeam.local server. The cmdlet will use the default port number (9194) connect to the Veeam Backup for Microsoft Office 365 server.

    $credentials = Get-Credential

    $restorepoint = Get-VBORestorePoint

    Start-VEODRestoreSession -ResotorePoint $restorepoint[0] -Server "srv08.veeam.local" -Credentials $credentials

    Perform the following steps:

    1. Run the Get-Credential cmdlet to create a credential object. Enter credentials that will be used to connect to the Veeam Backup for Microsoft Office 365 server. Save the result to the $credentials variable.
    2. Run the Get-VBORestorePoint cmdlet. Save the result to the $restorepoint variable.

    The Get-VBORestorePoint cmdlet will return an array of all restore points created on the srv08.veeam.local server. Mind the ordinal number of the necessary restore point (in our example, it is the first restore point in the array).

    1. Run the Start-VEODRestoreSession cmdlet. Specify the following settings:
    • Set the $restorepoint[0] variable as the ResotorePoint parameter value.
    • Set srv08.veeam.local as the Server parameter value.
    • Set the $credentials variable as the Credential parameter value.

    Start-VEODRestoreSessionExample 2. Starting Restore Session from Latest State

    This example shows how to start a restore session to retrieve items from a specific restore point created on the srv08.veeam.local server. The cmdlet will use the default port number (9194) connect to the Veeam Backup for Microsoft Office 365 server.

    $credentials = Get-Credential

    $job = Get-VBOJob -Name "Monthly Backup"

    Start-VEODRestoreSession -LatestState -Job $job

    Perform the following steps:

    1. Run the Get-Credential cmdlet to create a credential object. Enter credentials that will be used to connect to the Veeam Backup for Microsoft Office 365 server. Save the result to the $credentials variable.
    2. Run the Get-VBOJob cmdlet. Save the result to the $job variable.
    3. Run the Start-VEODRestoreSession cmdlet. Specify the $job variable as the Job parameter value. Provide the LatestState parameter.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.