Get-VBRRestorePoint
Short Description
Returns restore points.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Get all restore points.
Get-VBRRestorePoint [[-Backup] <CBackup[]>] [-Name <string[]>] [-ObjectId <guid[]>] [<CommonParameters>] |
- Get restore points by their ID.
Detailed Description
This cmdlet returns restore points created by Veeam Backup & Replication.
Restore points created by replication jobs are represented as snapshots.
Restore points created by backup jobs are represented as full and increment backup files.
Important |
To get a list of restore points for a Veeam Agent job, you must provide the asterisks sign for the Name parameter value: Name "AgentJob*". Otherwise, the Get-VBRRestorePoint will not return any restore points for the Veeam Agent job. |
Parameters
Parameter | Description | Type | Required | Position | Accept Pipeline Input |
---|---|---|---|---|---|
Id | Note: This parameter is available starting from Veeam Backup & Replication 11a (build 11.0.1.1261). Specifies an array of IDs of backed-up VMs. The cmdlet will return restore points of these VMs | Guid[] | True | Named | True ( |
Backup | Specifies the array of backups. The cmdlet will return restore points of these backups. | Accepts the CBackup[] object. To get this object, run the Get-VBRBackup cmdlet. | False | 1 | True (ByValue, |
Name | Specifies an array of VM names. The cmdlet will return restore points of these VMs. | String[] | False | Named | False |
ObjectId | Specifies an array of IDs of backed-up hosts and VM. The cmdlet will return restore points of these hosts and VMs. | Guid[] | False | Named | True ( |
|
|
|
|
|
|
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.
The cmdlet returns the VBOApplicationOnlyConnectionSettings object that defines Azure AD application settings.
Examples
Example 1. Getting all Restore Points
Example 2. Getting Restore Points by ID
This command looks for the 2ee79fec-9aa8-4058-a147-ff6b76ef2924 restore point. |
Example 3. Getting Restore Points Created by Backup Job
This example shows how to get all restore points of the MSExchange02 VM that is backed up by the MSExchange backup job. Perform the following steps:
|
Example 4. Getting Restore Points Created by Replication Job
This example shows how to get all restore points of VMs that are replicated by the DC Replica replication job. Perform the following steps:
|
Example 5. Getting Restore Points Created by Veeam Agent
This example shows how to get all restore points of Windows-based machines backed up by the WinBackup Veeam Agent job. Perform the following steps:
Note: To get a list of restore points for a Veeam Agent job, you must provide the asterisks sign for the Name parameter value: Name "AgentJob*". Otherwise, the Get-VBRRestorePoint cmdlet will not return any restore points for the Veeam Agent job.
|
Example 6. Getting Latest Restore Point Created by Backup Job [Using Pipeline]
This command looks for the latest restore point of VMs that are backed up by the MSExchange Backup backup job.
Perform the following steps:
|
Example 7. Getting Latest Restore Point Created by Replication Job [Using Pipeline]
This command returns the latest restore point of the MSExchange02 VM that is replicated by the Replica_Exchange replication job.
Perform the following steps:
|
Related Commands