Get-VBRNASBackupJob

Short Description

Returns file backup jobs.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get all file backup jobs.

Get-VBRNASBackupJob  [<CommonParameters>]

  • Get a file backup job by the file backup job name.

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

  • Get a file backup job by the file backup job ID.

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

Detailed Description

This cmdlet returns file backup jobs.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Name

Specifies a name of a file backup job. The cmdlet will return an array of jobs with the specified name.

String[]

True

Named

False

 

Id

Specifies an ID of a file backup job. The cmdlet will return an array of jobs with the specified ID.

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 VBRNASBackupJob object that contains settings of file backup jobs.

Examples

Get-VBRNASBackupJobExample 1. Getting all File Backup Jobs

This command returns all file backup jobs that are added to the Veeam Backup & Replication infrastructure.

Get-VBRNASBackupJob

Get-VBRNASBackupJobExample 2. Getting File Backup Job by Name

This command returns the SMB Backup file backup job.

Get-VBRNASBackupJob -Name "SMB Backup"

Get-VBRNASBackupJobExample 3. Getting File Backup Job by ID

This command returns the 0789b522-c02c-4d05-a619-dee26520495d file backup job.

Get-VBRNASBackupJob -ID "0789b522-c02c-4d05-a619-dee26520495d"

I want to report a typo

There is a misspelling right here:

 

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