Get-VESQLPluginRestoreSession
Short Description
Returns active restore sessions started to explore and restore databases backed up with Veeam Plug-in for Microsoft SQL Server.
Applies to
Veeam Backup & Replication
Product Edition: Enterprise Plus, Veeam Universal License
Syntax
Get-VESQLPluginRestoreSession [[-SessionId] <Guid>] [<CommonParameters>] |
Detailed Description
This cmdlet returns an array of active restore sessions started to explore and restore databases.
After you get the restore session, run the Get-VESQLPluginDatabase cmdlet to get databases backed up with Veeam Plug-in for Microsoft SQL Server.
Note |
|
Note the difference between a restore session and a restore job. A restore session is a preliminary step where Veeam Explorer for Microsoft SQL Server has retrieved the backup from the backup repository, pending restore operations. A restore job is the process of restoring data from the backup to the target Microsoft SQL Server server.
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
SessionId | Specifies a restore session initiated to explore databases backed up with Veeam Plug-in for Microsoft SQL Server. The cmdlet will return this session. | GUID | False | 1 | True (ByValue) |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
Output Object
The cmdlet returns the VESQLPluginRestoreSession[] object that contains settings of restore sessions for databases backed up with Veeam Plug-in for Microsoft SQL Server.
Examples
Example 1. Getting all Running Restore Sessions
This command gets all running restore sessions for databases backed up with Veeam Plug-in for Microsoft SQL Server. Save the result to the $session variable to be able to use it with other cmdlets.
|
Example 2. Getting Specific Restore Session with Indexing
This example shows how to use indexing to get a specific restore session for databases backed up with Veeam Plug-in for Microsoft SQL Server.
Perform the following steps:
The cmdlet will return an array of active restore sessions. Note the ordinal number of the necessary restore session (in our example, it is the fourth restore session in the array).
|
Example 3. Getting Specific Restore Session with Session Id
This command returns a restore session with a specific session ID. Save the result to the $session variable to be able to use it with other cmdlets.
|