Get-VBRNASBackupFLRItem

Short Description

Returns objects backed up by file backup jobs.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Get-VBRNASBackupFLRItem -Session <VBRNASBackupFLRSession> [-Name <string>] [-Folder <VBRNASBackupFLRFolder>][-Recurse]  [<CommonParameters>]

Detailed Description

This cmdlet returns an array of objects that contain settings of guest OS files and folders backed up by file backup jobs.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Session

Specifies a restore session. The cmdlet will return backed-up objects within this restore session.

Accepts the VBRNASBackupFLRSes sion object. To get this object, run the Get-VBRNASBackupFLRSession cmdlet.

True

Named

True (ByValue, ByPropertyName)

Name

Specifies a name of the backed-up object. The cmdlet will return folders and files with the specified name.

Note: The cmdlet can return only 1000 folders and files.

String

False

Named

False

Folder

Specifies a backed-up folder. The cmdlet will return the specified folder and an array of objects that are added to this folder.

Accepts the VBRNASBackupFLRFolder object. To get this object, run the Get-VBRNASBackupFLRItem cmdlet.

False

Named

False

Recurse

Defines that the cmdlet will look for objects that are added to backed-up child folders.

If you provide this parameter, the cmdlet will return an array of all objects that are added to backed-up child folders. Otherwise, the cmdlet will return an array of objects that are added to the parent folder on the backed-up file share.

SwitchParamter

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 VBRNASBackupFLRItem and VBRNASBackupFLRFolder objects that contain settings of guest OS files and folders backed up by file backup jobs.

Examples

Get-VBRNASBackupFLRItemExample 1. Getting Objects Within Restore Session

This example shows how to get objects within the specified restore session.

$restorepoint = Get-VBRNASBackupRestorePoint

$session = Start-VBRNASBackupFLRSession -RestorePoint $restorepoint[3]

Get-VBRNASBackupFLRItem -Session $session

Perform the following steps:

  1. Run the Get-VBRNASBackupRestorePoint cmdlet. Save the result to the $restorepoint variable.

The Get-VBRNASBackupRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (An array starts with 0. In our example, it is the fourth restore point in the array).in our example, it is the fourth restore point in the array).

  1. Run the Start-VBRNASBackupFLRSession cmdlet. Set the $restorepoint as the RestorePoint parameter value. Save the result to the $session variable.
  2. Run the Get-VBRNASBackupFLRItem cmdlet. Set the $session as the Session parameter value.

Get-VBRNASBackupFLRItemExample 2. Getting Objects by Name

This example shows how to get the Report001.txt file within the specified restore session.

$restorepoint = Get-VBRNASBackupRestorePoint

$session = Start-VBRNASBackupFLRSession -RestorePoint $restorepoint[4]

Get-VBRNASBackupFLRItem -Session $session -Name "Report001.txt"

Perform the following steps:

  1. Run the Get-VBRNASBackupRestorePoint cmdlet. Save the result to the $restorepoint variable.

The Get-VBRNASBackupRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the fifth restore point in the array). Note that to count objects of the array you must start with 0.

  1. Run the Start-VBRNASBackupFLRSession cmdlet. Set the $restorepoint as the RestorePoint parameter value. Save the result to the $session variable.
  2. Run the Get-VBRNASBackupFLRItem cmdlet. Specify the Name parameter value. Set the $session as the Session parameter value.

Get-VBRNASBackupFLRItemExample 3. Getting Objects from Specific Folder

This example shows how to get all objects that are located in the the October Reports folder.

$restorepoint = Get-VBRNASBackupRestorePoint

$session = Start-VBRNASBackupFLRSession -RestorePoint $restorepoint[2]

$folder = Get-VBRNASBackupFLRItem -Session $session -Name "October Reports"

Get-VBRNASBackupFLRItem -Session $session -Folder $folder

Perform the following steps:

  1. Run the Get-VBRNASBackupRestorePoint cmdlet. Save the result to the $restorepoint variable.

The Get-VBRNASBackupRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the third restore point in the array). Note that to count objects of the array you must start with 0.

  1. Run the Start-VBRNASBackupFLRSession cmdlet. Set the $restorepoint as the RestorePoint parameter value. Save the result to the $session variable.
  2. Run the Get-VBRNASBackupFLRItem cmdlet. Set the $session as the Session parameter value. Specify the Name parameter value.
  3. Run the Get-VBRNASBackupFLRItem cmdlet. Set the $folder as the Folder parameter value. Set the $session as the Session parameter value.

Get-VBRNASBackupFLRItemExample 4. Getting All Objects Added to Backed-up Folders

This example shows how to get all objects that are added to the backed-up folders.

$restorepoint = Get-VBRNASBackupRestorePoint

$session = Start-VBRNASBackupFLRSession -RestorePoint $restorepoint[5]

Get-VBRNASBackupFLRItem -Session $session -Recurse

Perform the following steps:

  1. Run the Get-VBRNASBackupRestorePoint cmdlet. Save the result to the $restorepoint variable.

The Get-VBRNASBackupRestorePoint cmdlet will return an array of restore points. Mind the ordinal number of the necessary restore point (in our example, it is the sixth restore point in the array). Note that to count objects of the array you must start with 0.

  1. Run the Start-VBRNASBackupFLRSession cmdlet. Set the $restorepoint as the RestorePoint parameter value. Save the result to the $session variable.
  2. Run the Get-VBRNASBackupFLRItem cmdlet. Set the $session as the Session parameter value. Specify the Recurse 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.