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 the following parameter sets:

  • To get the session for the specified job

Get-VBRSession -Job <VBRJob> [-Last]  [<CommonParameters>]

  • To get the session with the specified ID

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

  • To get the specified session

Get-VBRSession -Session <VBRSession>  [<CommonParameters>]

  • To get the session for the job with the specified result

Get-VBRSession -Job <VBRJob> [-Result <VBRSessionResult> {None | Success | Warning | Failed}]  [<CommonParameters>]

  • To 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>]>]

  • To 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

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies the job for which you want to get sessions that have been run.

Accepts the VBRJob type.

True

Named

True (ByProperty
Name)

False

Type

Specifies the type of the session. The cmdlet will return the session of this ID.

True

Named

True (ByPropertyName)

False

ID

Specifies the ID of the session. The cmdlet will return the session with this ID.

False

Named

False

 

Last

Indicates that the command returns the last session of the specified job.

False

Named

False

False

Session

Specifies the job session for which you want to get an updated state.

Accepts VBRSession type.

True

Named

True (ByValue,
ByProperty
Name)

False

State

Specifies the session state. The cmdlet will return sessions with the specified state.

See VBRSessionState.

False

Named

False

False

Result

Specifies the session result. The cmdlet will return sessions with the specified result.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

VBRBackupSession

Example

This example shows how to get the session for the specified job.

  1. Run the Get-VBRJob cmdlet to get the backup job. Save the result to the $job variable.
  2. Run the Get-VBRSession cmdlet. Set the $job variable as the Job parameter value.

$job = Get-VBRJob -Name "Backup Copy Job"

$session = Get-VBRSession -Job $job

Related Commands

Get-VBRJob