Get-VBRTaskSession

Short Description

Returns tasks performed during job sessions.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Get-VBRTaskSession -Session <CBackupSession> [-Name <String[]>] [<CommonParameters>]

Detailed Description

This cmdlet returns tasks performed during the specified session. The tasks are VMs processed during one job session.

Run the Get-VBRSureBackupTaskSession cmdlet to get the tasks for SureBackup jobs session.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Session	Specifies the session tasks which you want to get.	Accepts the following objects: CBackupSession To get this object, run the Get-VBRBackupSession cmdlet. VBRSession To get this object, run the Get-VBRSession cmdlet. VBRComputerBackupJobSession To get this object, run the Get-VBRComputerBackupJobSession cmdlet. VBREPSession To get this object, run the Get-VBREPSession cmdlet. VBRPluginBackupSession To get this object, run the Get-VBRPluginBackupSession cmdlet. VBRTapeBackupSession To get this object, run the Get-VBRTapeBackupSession cmdlet.	True	1	True (ByValue, ByProperty Name)
Name	Specifies the array of job object names (for example, VMs in job). The cmdlet will return tasks performed for these objects during the selected session.	String[]	False	Named	False

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Session

Specifies the session tasks which you want to get.

Accepts the following objects:

CBackupSession

To get this object, run the Get-VBRBackupSession cmdlet.

VBRSession

To get this object, run the Get-VBRSession cmdlet.

VBRComputerBackupJobSession

To get this object, run the Get-VBRComputerBackupJobSession cmdlet.

VBREPSession

To get this object, run the Get-VBREPSession cmdlet.

VBRPluginBackupSession

To get this object, run the Get-VBRPluginBackupSession cmdlet.

VBRTapeBackupSession

To get this object, run the Get-VBRTapeBackupSession cmdlet.

True

True (ByValue,
ByProperty
Name)

Name

Specifies the array of job object names (for example, VMs in job). The cmdlet will return tasks performed for these objects during the selected session.

String[]

False

Named

False

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

Output Object

VBRTaskSession

Examples

Get-VBRTaskSession Example 1. Getting List of Tasks Performed for VMs [Using Pipeline]

This example shows how to get the list of tasks performed for the DC and DNS VMs in the backup job session with incremental backups named Exchange Backup.

Get-VBRBackupSession -Name "Exchange Backup (Incremental)" | Get-VBRTaskSession -Name "DC", "DNS"

Perform the following steps:

Run the Get-VBRBackupSession cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Get-VBRTaskSession cmdlet. Specify the Name parameter value.

Get-VBRTaskSession Example 2. Getting List of Tasks Performed for VMs [Using Variable]

This example shows how to get the list of tasks performed for the DC and DNS VMs in the backup job session with incremental backups named Exchange Backup.

$ExchangeSession = Get-VBRBackupSession -Name "Exchange Backup (Incremental)"

Get-VBRTaskSession -Session $ExchangeSession -Name "DC", "DNS"

Perform the following steps:

Run the Get-VBRBackupSession cmdlet. Specify the Name parameter value. Save the result to the $ExchangeSession variable.
Run the Get-VBRTaskSession cmdlet. Set the $ExchangeSession variable as the Session parameter value. Specify the Name parameter value.

Related Commands

Get-VBRBackupSession