This is an archive version of the document. To get the most up-to-date information, see the current version.Stop-VESQLRestoreSession
Short Description
Stops active restore sessions initiated to perform operations with Microsoft SQL databases.
Applies to Veeam Backup & Replication
Product Edition: Community, Standard, Enterprise, Enterprise Plus
Syntax
Stop-VESQLRestoreSession [-Session] <VESQLRestoreSession> [<CommonParameters>] |
Detailed Description
This cmdlet stops active restore sessions initiated to perform operations with Microsoft SQL databases.
|
|
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input | Accept Wildcard Characters |
|---|---|---|---|---|---|---|
Session | Specifies a restore session initiated to perform operations with Microsoft SQL databases. The cmdlet will stop this session. | Accepts the VESQLRestoreSession object. To get this object, run the Get-VESQLRestoreSession 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.
Example
Stopping Restore Session
This example shows how to stop a restore session initiated to perform operations with the Microsoft SQL database.
$session = Get-VESQLRestoreSession Stop-VESQLRestoreSession -Session $session[3] |
Perform the following steps:
- Run the Get-VESQLRestoreSession cmdlet. Save the result to the $session variable.
The Get-VESQLRestoreSession cmdlet will return an array of active restore sessions. Mind the ordinal number of the necessary restore session (in our example, it is the fourth restore session in the array).
- Run the Stop-VESQLRestoreSession cmdlet. Set the $session variable as the Session parameter value.
Related Commands