Get-VBRObjectRestorePoint

Short Description

Returns restore points created by jobs.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

AllParameterSets (Default)

Get-VBRObjectRestorePoint [<CommonParameters>]
Backup

Get-VBRObjectRestorePoint -Backup <CBackup[]> [<CommonParameters>]
Id

Get-VBRObjectRestorePoint -Id <Guid[]> [<CommonParameters>]
Name

Get-VBRObjectRestorePoint -Name <String[]> [<CommonParameters>]
ObjectId

Get-VBRObjectRestorePoint -ObjectId <Guid[]> [<CommonParameters>]

Detailed Description

This cmdlet returns restore points created by jobs.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Backup	Specifies an array of backup or replica objects. The cmdlet will return restore points of these backups or replicas. Accepts the `CBackup[]` object. To get this object, run the `Get-VBRBackup` or `Get-VBRReplica` cmdlet.	`CBackup[]`	True	Named	True (ByPropertyName, ByValue)
Id	Specifies an array of IDs, The cmdlet will return restore points of these backups or replicas.	`Guid[]`	True	Named	True (ByPropertyName, ByValue)
Name	Specifies an array of names for backed-up machines or replicated VMs. The cmdlet will return restore points of these machines. Note: For Cloud Director and CDP replica you must specify a vApp.	`String[]`	True	Named	True (ByPropertyName, ByValue)
ObjectId	Specifies an array of IDs of backed-up hosts and machines. The cmdlet will return restore points of these hosts and machines.	`Guid[]`	True	Named	True (ByPropertyName, ByValue)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRObjectRestorePoint

Examples

Get-VBRObjectRestorePoint Example 1. Getting all Restore Points

This command looks for all restore points of all machines registered in the database.

Get-VBRObjectRestorePoint

Get-VBRObjectRestorePoint Example 2. Getting Restore Points by ID

This command looks for the 2ee79fec-9aa8-4058-a147-ff6b76ef2924 restore point.

Get-VBRObjectRestorePoint -Id "2ee79fec-9aa8-4058-a147-ff6b76ef2924"

Get-VBRObjectRestorePoint Example 3. Getting Restore Points Created by Backup Job

This example shows how to get all restore points of the MSExchange02 machine that is backed up by the MSExchange backup job.

$backup = Get-VBRBackup -Name "MSExchange"

Get-VBRObjectRestorePoint -Name *MSExchange02* -Backup $backup

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
Run the Get-VBRObjectRestorePoint cmdlet. Specify the Name parameter value. Set the $backup variable as the Backup parameter value.

Get-VBRObjectRestorePoint Example 4. Getting Restore Points Created by Replication Job

This example shows how to get all restore points of machines that are replicated by the DC Replica replication job.

$replica = Get-VBRReplica -Name "DC Replica"

Get-VBRObjectRestorePoint -Backup $replica

Perform the following steps:

Run the Get-VBRReplica cmdlet. Specify the Name parameter value. Save the result to the $replica variable.
Run the Get-VBRObjectRestorePoint cmdlet. Set the $replica variable as the Backup parameter value.

Get-VBRObjectRestorePoint 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.

$winbackup = Get-VBRBackup -Name "WinBackup*"

Get-VBRObjectRestorePoint -Backup $winbackup

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $winbackup variable.
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-VBRObjectRestorePoint cmdlet will not return any restore points for the Veeam Agent job.
Run the Get-VBRObjectRestorePoint cmdlet. Set the $winbackup variable as the Backup parameter value.

Get-VBRObjectRestorePoint Example 6. Getting Latest Restore Point Created by Backup Job [Using Pipeline]

This example shows how to look for the latest restore point of machines that are backed up by the MSExchange Backup backup job.

Get-VBRBackup -Name MSExchange Backup | Get-VBRObjectRestorePoint -Name MSExchange02 | Sort-Object -Property CreationTime -Descending | Select-Object -First 1

Perform the following steps:

Run the Get-VBRBackup cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Get-VBRObjectRestorePoint cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Sort-Object cmdlet. Set the CreationTime value for the Property parameter. Provide the Descending parameter.
Pipe the cmdlet output to the Select-Object cmdlet. Set the 1 number as the First parameter value.

Get-VBRObjectRestorePoint Example 7. Getting Latest Restore Point Created by Replication Job [Using Pipeline]

This example shows how to return the latest restore point of the MSExchange02 machine that is replicated by the Replica_Exchange replication job.

Get-VBRReplica -Name Replica_Exchange | Get-VBRObjectRestorePoint -Name MSExchange02 | Sort-Object -Property CreationTime -Descending | Select -First 1

Perform the following steps:

Run the Get-VBRReplica cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Get-VBRObjectRestorePoint cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Sort-Object cmdlet. Set the CreationTime value as the Property parameter value. Provide the Descending parameter.
Pipe the cmdlet output to the Select-Object cmdlet. Set the 1 number as the First parameter value.