Get-VBRSureBackupTaskSession

Short Description

Returns tasks performed during the specified SureBackup session.

Applies to

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Get-VBRSureBackupTaskSession [-Session] <VBRSureBackupSession> [-Name <string[]>] [-Id <guid[]>]  [<CommonParameters>]

Detailed Description

This cmdlet returns the list of tasks performed during the specified SureBackup session.

Run the Get-VBRTaskSession cmdlet to get the tasks for backup, replication and backup copy sessions.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Session

Specifies the array of SureBackup sessions. The cmdlet will return tasks performed during these sessions.

Accepts the VBRSureBackupSession object. To get this object, run the Get-VBRSureBackupSession cmdlet.

True

0

True (ByValue,
ByProperty
Name)

Name

Specifies the array of SureBackup job names. The cmdlet will return tasks performed for VMs in these jobs during the selected job session.

string[]

False

Named

True (ByValue,
ByProperty
Name)

ID

Specifies the array of SureBackup sessions ID. The cmdlet will return sessions with this ID.

guid[]

False

Named

True (ByValue,
ByProperty
Name)

<CommonParameters>

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

Output Object

The cmdlet returns the VBRSureBackupTaskSession object that contains settings of tasks performed during the SureBackup session.

Examples

Getting List of SureBackup Sessions by Name

This example shows how to get the list of tasks performed for the VM named srv1 in the SureBackup job session named Winserver SureBackupJob.

$job = Get-VBRSureBackupSession -Name "Winserver SureBackupJob"

Get-VBRSureBackupTaskSession -Session $job -Name "srv1"

Perform the following steps:

  1. Run the Get-VBRSureBackupSession cmdlet. Specify the Name parameter value. Save the result to the $job variable.
  2. Run the Get-VBRSureBackupTaskSession cmdlet. Set the $job variable as the Session parameter value. Specify the Name parameter value.

Related Commands

Get-VSBSession