Get-VESQLPluginDatabaseRestore
Short Description
Returns active restore jobs for databases backed up with Veeam Plug-in for Microsoft SQL Server.
Applies to
Veeam Backup & Replication
Product Edition: Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Get an active restore job using the job ID.
Get-VESQLPluginDatabaseRestore -JobId <Guid> [<CommonParameters>] |
- Get an active restore job using the name of the restored database.
Get-VESQLPluginDatabaseRestore [-DatabaseName <String[]>] [<CommonParameters>] |
Detailed Description
This cmdlet returns information about active restore jobs for a database backed up by Veeam Plug-in for Microsoft SQL Server. You can stop the restore process with the Stop-VESQLPluginDatabaseRestore cmdlet.
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 |
|---|---|---|---|---|---|
JobId | Specifies the job ID of the required restore job. The cmdlet will return information about the specified restore job. | GUID | True | Named | True (ByValue) |
DatabaseName | Specifies names of restored Microsoft SQL Server databases. The cmdlet will return restore jobs performed for the specified databases. This parameter accepts wildcard characters. | String[] | False | Named | False |
<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 VESQLPluginRestore[] array that contains information about the restore process of databases backed up with Veeam Plug-in for Microsoft SQL Server.
Examples
Example 1. Getting All Restore Processes
This command returns a list of all active restore processes for databases backed up by Veeam Plug-in for Microsoft SQL Server. Save the result to the $restore variable to be able to use it with other cmdlets.
|
Example 2. Getting Restore Process by Job ID
This example shows how to get a specific restore job by its job ID. Save the result to the $restore variable to be able to use it with other cmdlets.
|
Example 3. Getting Restore Processes for Specific Database
This command returns all active restore processes for a specific database. Save the result to the $restore variable to be able to use it with other cmdlets.
|
Example 4. Getting Restore Processes for Specific Databases Using Wildcards
This command returns all active restore jobs for databases whose names begin with "db". Save the result to the $restore variable to be able to use it with other cmdlets.
|