Get-VBRNASBackupJob
Short Description
Returns file 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 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 |
|---|---|---|---|---|---|
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 Microsoft Docs.
Output Object
The cmdlet returns the VBRNASBackupJob object that contains settings of file backup jobs.
Examples
Example 1. Getting all File Backup Jobs
This command returns all file backup jobs that are added to the Veeam Backup & Replication infrastructure.
|
Example 2. Getting File Backup Job by Name
This command returns the SMB Backup file backup job.
|
Example 3. Getting File Backup Job by ID
This command returns the 0789b522-c02c-4d05-a619-dee26520495d file backup job.
|