Start-VEADRestoreSession

In this article

    Short Description

    Starts restore sessions to explore backed-up Microsoft Active Directory databases and to perform operations with these databases.

    Applies to Veeam Backup & Replication

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

    Syntax

    Start-VEADRestoreSession [-RestorePoint] <IVBRApplicationRestorePoint>  [<CommonParameters>]

    Detailed Description

    This cmdlet starts a new restore session, establishes a connection to the Veeam Backup & Replication server and retrieves Microsoft Active Directory databases backed up on this server. Within the restore session, you can get backed-up databases using the following cmdlets:

    After you get backed-up Microsoft Active Directory databases, you can restore these databases.

    Run the Restore-VEADItem cmdlet to restore Microsoft Active Directory databases.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    RestorePoint

    Specifies a restore point to start a new restore session. You will be able to use this session to perform operations with Microsoft Active Directory databases that this restore point contains.

    Accepts the IVBRApplicationRestorePoint object. To get this object, run the Get-VBRApplicationRestorePoint cmdlet.

    True

    0

    True (ByValue)

    False

    <CommonParameters>

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

    Output Object

    The cmdlet returns the VEADRestoreSession object that contains settings of  restore sessions started to explore backed-up Microsoft Active Directory databases and to perform operations with these databases.

    Examples

    Starting Restore Session

    This example shows how to start a restore session to perform operations with a Microsoft Active Directory database.

    $restorepoint = Get-VBRApplicationRestorePoint -ActiveDirectory

    Start-VEADRestoreSession -RestorePoint $restorepoint[0]

    Perform the following steps:

    1. Run the Get-VBRApplicationRestorePoint cmdlet with the ActiveDirectory parameter. Save the result to the $restorepoint variable.

    The Get-VBRApplicationRestorePoint cmdlet will return an array of restore points. 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-VEADRestoreSession cmdlet. Set the $restorepoint variable as the RestorePoint parameter value.

    Related Commands

    Get-VBRApplicationRestorePoint

    I want to report a typo

    There is a misspelling right here:

     

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