Stop-VESQLPluginRestoreSession
Short Description
Stops an active restore session 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
Stop-VESQLPluginRestoreSession [-Session] <VESQLPluginRestoreSession> [<CommonParameters>] |
Detailed Description
This cmdlet stops an active restore session initiated to explore and perform operations with databases backed up with Veeam Plug-in for Microsoft SQL Server.
|
|
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
|---|---|---|---|---|---|
Session | Specifies a restore session for databases backed up with Veeam Plug-in for Microsoft SQL Server. The cmdlet will stop this session. | Accepts the VESQLPluginRestoreSession object. To get this object, run the Get-VESQLPluginRestoreSession cmdlet. | True | 0 | 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
None.
Example
Stopping Restore Session
This example shows how to stop a restore session for databases backed up with Veeam Plug-in for Microsoft SQL Server.
$session = Get-VESQLPluginRestoreSession Stop-VESQLPluginRestoreSession -Session $session[3] |
Perform the following steps:
- Run the Get-VESQLPluginRestoreSession cmdlet. Save the result to the $session variable.
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).
- Run the Stop-VESQLPluginRestoreSession cmdlet. Set the $session variable as the Session parameter value and select the necessary restore session.
Related Commands