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.

Get-VBRRestorePoint -Id <Guid[]>  [<CommonParameters>]

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 cmdlet will not return any restore points for the Veeam Agent job.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Id

Specifies an array of IDs of backed-up VMs. The cmdlet will return restore points of these VMs.

Guid[]

True

Named

True (ByPropertyName)

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

0

True (ByValue,
ByProperty
Name)

Name

Specifies an array of VM names. The cmdlet will return restore points of these VMs.

Note: For Cloud Director and CDP replica you must specify a vApp.

String[]

False

Named

False

ObjectId

Specifies an array of IDs of backed-up hosts and VMs. The cmdlet will return restore points of these hosts and VMs.

Guid[]

False

Named

True (
ByProperty
Name)

<CommonParameters>

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

Output Object

The cmdlet returns the COib object that contains information on restore points created by Veeam Backup & Replication.

Examples

Get-VBRRestorePointExample 1. Getting all Restore Points

Get-VBRRestorePointExample 2. Getting Restore Points by ID

Get-VBRRestorePointExample 3. Getting Restore Points Created by Backup Job

Get-VBRRestorePointExample 4. Getting Restore Points Created by Replication Job

Get-VBRRestorePointExample 5. Getting Restore Points Created by Veeam Agent

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

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

Related Commands

Page updated 6/19/2024

Page content applies to build 12.3.1.1139