Get-VBRNASBackupRestorePoint

In this article

    Short Description

    Returns restore points of backups created by file share backup jobs.

    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 that are created by file backup jobs.

    Get-VBRNASBackupRestorePoint  [<CommonParameters>]

    • Get a restore point by the restore point ID.

    Get-VBRNASBackupRestorePoint -Id <guid[]>  [<CommonParameters>]

    • Get a restore point available for the specific backup located on the specific file share.

    Get-VBRNASBackupRestorePoint -NASBackup <VBRNASBackup[]> [-NASServer <VBRNASServer[]>]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns restore points created by file share backup jobs.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Accept Wildcard Characters

    Id

    Specifies an array of restore point IDs. The cmdlet will return restore points with the specified IDs.

    Guid[]

    True

    Named

    False

     

    NASBackup

    Specifies an array of backup files created by the file backup job. The cmdlet will return restore points that are available for these backup files.

    Accepts the VBRNASBackup[] object. To get this object, run the Get-VBRNASBackup cmdlet.

    True

    Named

    True (ByValue, ByPropertyName)

     

    NASServer

    Specifies an array of file shares. The cmdlet will return backup files that are located on these file shares.

    Accepts the VBRNASServer[] object. To get this object, run the Get-VBRNASServer cmdlet.

    False

    Named

    True (ByPropertyName)

     

    <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 VBRNASBackupRestorePoint object that contains settings of restore points created by the file backup jobs.

    Examples

    Get-VBRNASBackupRestorePointExample 1. Getting All Restore Points

    This command returns all restore points that are created by file backup jobs.

    Get-VBRNASBackupRestorePoint

    Get-VBRNASBackupRestorePointExample 2. Getting Restore Point by ID

    This command returns the 51e4eced-3fce-465b-b516-f24cb5a068a4 restore point.

    Get-VBRNASBackupRestorePoint -ID "51e4eced-3fce-465b-b516-f24cb5a068a4"

    Get-VBRNASBackupRestorePointExample 3. Getting Restore Point From Specific File Share

    This example shows how to get restore points of the NFS Backup backup file. The restore points are located on the \\WinSRV2049\Documents file share.

    $backupfile = Get-VBRNASBackup -Name "NFS Backup"

    $server = Get-VBRNASServer -Name "\\WinSRV2049\Documents"

    Get-VBRNASBackupRestorePoint -NASServer $server -NASBackup $backupfile

    Perform the following steps:

    1. Run the Get-VBRNASBackup cmdlet. Specify the Name parameter value. Save the result to the $backupfile variable.
    2. Run the Get-VBRNASServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
    3. Run the Get-VBRNASBackupRestorePoint cmdlet. Set the $server variable as the NASServer parameter value. Set the $backupfile variable as the NASBackup parameter value

    Get-VBRNASBackupRestorePointExample 4. Getting Latest Restore Point

    This command gets the latest restore point from an array of restore points.

    $restorepoint = Get-VBRNASBackupRestorePoint | Sort-Object -Property CreationTime | Select-Object -Last 1

    Perform the following steps:

    1. Run the Get-VBRNASBackupRestorePoint cmdlet. Save the result to the $restorepoint variable.
    2. Pipe the cmdlet output to the Sort-Object cmdlet. Set the CreationTime value as the Property parameter. Provide the Descending parameter.
    3. Run the Select-Object cmdlet. Set the 1 value for the Last parameter.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.