This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VBRNASBackup

Short Description

Returns backup files created by the file backup job.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to:

  • Getting all backup files created by the file backup job.

Get-VBRNASBackup  [<CommonParameters>]

  • Getting backup files by the file backup job name.

Get-VBRNASBackup -Name <string[]>  [<CommonParameters>]

  • Getting backup files by the file backup job ID.

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

Detailed Description

This cmdlet returns backup files created by the file backup job.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Name

Specifies a name of the file backup job. The cmdlet will return an array of backup files that are created by this file backup job.

String[]

True

Named

False

 

Id

Specifies an ID of the file backup job. The cmdlet will return an array of backup files that are created by this file backup job.

Guid[]

True

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 VBRNASBackup object that contains backup files created by the file backup job.

Examples

Get-VBRNASBackupExample 1. Getting All Backup Files

Get-VBRNASBackupExample 2. Getting Backup Files by Name

Get-VBRNASBackupExample 3. Getting Backup Files by ID