Get-VBRSession

Short Description

Returns job sessions.

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

Job (Default)

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

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

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

Get-VBRSession -Job <VBRJob> [-Result <VBRSessionResult>] [<CommonParameters>]
State

Get-VBRSession -Job <VBRJob> [-State <VBRSessionState>] [<CommonParameters>]
Type

Get-VBRSession -Type <EDbJobType> [<CommonParameters>]

Detailed Description

This cmdlet returns sessions for a selected job.

Important

To get tape backup job sessions, run the Get-VBRTapeBackupSession cmdlet.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Id	Specifies the ID of the session. The cmdlet will return the session with this ID.	`Guid[]`	True	Named	False
Job	Specifies the job for which you want to get sessions that have been run. Note: This parameter does not accept VM copy and file copy job objects. Accepts the `VBRJob` object. To get this object, run the `Get-VBRJob` cmdlet.	`VBRJob`	True	Named	True (ByPropertyName)
Last	Defines that the command returns the last session of the specified job.	`SwitchParameter`	False	Named	False
Result	Specifies the session result. The cmdlet will return sessions with the specified result: `None` `Success` `Warning` `Failed`	`VBRSessionResult`	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.	`VBRSession`	True	Named	True (ByPropertyName, ByValue)
State	Specifies the session state. The cmdlet will return sessions with the specified state.	`VBRSessionState`	False	Named	False
Type	Specifies the type of the session. The cmdlet will return the session of this type.	`EDbJobType`	True	Named	True (ByPropertyName)

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

Examples

Get-VBRSession Example 1. Getting Sessions for Specific Job [Using Variable]

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.

Get-VBRSession Example 2. Getting Sessions for VM Copy and File Copy Type of Jobs

This command shows how to get the sessions for the specified type of jobs.

Get-VBRSession -Type Copy