This is an archive version of the document. To get the most up-to-date information, see the current version.Get-VBREPJob
Short Description
Returns Veeam Agent for Microsoft Windows jobs.
Syntax
This cmdlet provides 3 parameter sets.
- For looking for all Veeam Agent for Microsoft Windows jobs:
Get-VBREPJob [<CommonParameters>] |
- For looking for Veeam Agent for Microsoft Windows jobs by job name:
Get-VBREPJob [-Name <string[]>] [<CommonParameters>] |
- For looking for Veeam Agent for Microsoft Windows jobs by job ID:
Get-VBREPJob [-Id <guid[]>] [<CommonParameters>] |
Detailed Description
This cmdlet returns Veeam Agent for Microsoft Windows jobs.
You can get all Veeam Agent for Microsoft Windows jobs or search for instances directly by name or ID. Use an appropriate parameter set for each case.
|
Veeam Agent for Microsoft Windows cmdlets will not work for jobs that were created using Veeam Agent management functionality. The ability to manage Veeam Agent management jobs will be provided in future versions of Veeam PowerShell. |
Parameters
Parameter | Description | Required | Position | Accept | Accept |
Name | Specifies the array of Veeam Agent for Microsoft Windows job names. The cmdlet will return jobs with these names. | False | Named | False | True |
Id | Specifies the array of job IDs. The cmdlet will return the Veeam Agent for Microsoft Windows jobs with these IDs. Accepts GUID or string type. | False | Named | False | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Return Type
VBREPJob[]
Example 1
This command returns all Veeam Agent for Microsoft Windows jobs.
Get-VBREPJob |
Example 2
This command gets a Veeam Agent for Microsoft Windows job by name.
Get-VBREPJob -Name "Backup Job Mediaserver" |
