Get-VBRSession
Short Description
Returns jobs sessions.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Get the session for the specified job.
Get-VBRSession -Job <VBRJob> [-Last] [<CommonParameters>] |
- Get the session with the specified ID.
Get-VBRSession -Id <guid[]> [<CommonParameters>] |
- Get the specified session.
Get-VBRSession -Session <VBRSession> [<CommonParameters>] |
- Get the session for the job with the specified result.
Get-VBRSession -Job <VBRJob> [-Result <VBRSessionResult> {None | Success | Warning | Failed}] [<CommonParameters>] |
- Get the session for the job with the specified state.
Get-VBRSession -Job <VBRJob> [-State <VBRSessionState> {Stopped | Starting | Stopping | Working | Pausing |Resuming | WaitingTape | Idle | Postprocessing | WaitingRepository | Pending}] [<CommonParameters>] |
- Get the session for the job with the specified state.
Get-VBRSession -Type <EDbJobType> [<CommonParameters>] |
Detailed Description
This cmdlet returns sessions for a selected job.
Parameters
Parameter | Description | Type | Required | Position | Accept |
---|---|---|---|---|---|
Job | Specifies the job for which you want to get sessions that have been run. | Accepts the VBRJob object. To get this object, run the Get-VBRJob cmdlet. | True | Named | True (ByProperty |
Type | Specifies the type of the session. The cmdlet will return the session of this ID. | EDbJobType | True | Named | True (ByPropertyName) |
ID | Specifies the ID of the session. The cmdlet will return the session with this ID. | Guid[] | False | Named | False |
Last | Defines that the command returns the last session of the specified job. | SwitchParameter | False | Named | False |
Session | Specifies the job session for which you want to get an updated state. | Accepts the VBRSession object. To get this object, run the Get-VBRSession cmdlet. | True | Named | True (ByValue, |
State | Specifies the session state. The cmdlet will return sessions with the specified state. | False | Named | False | |
Result | Specifies the session result. The cmdlet will return sessions with the specified result:
| VBRSessionResult | False | Named | False |
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.
Output Object
Examples
Getting Sessions for Specific Job
This example shows how to get the session for the specified job.
$job = Get-VBRJob -Name "Backup Copy Job" $session = Get-VBRSession -Job $job |
Perform the following steps:
- Run the Get-VBRJob cmdlet to get the backup job. Specify the Name parameter value. Save the result to the $job variable.
- Run the Get-VBRSession cmdlet. Set the $job variable as the Job parameter value.
Related Commands