Get-VBRScanTaskSession

Short Description

Returns scan task sessions performed during the specified SureBackup session.

Note

This cmdlet is available starting from Veeam Backup & Replication 12.1 (build 12.1.0.2131).

Applies to

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Get-VBRScanTaskSession -InitiatorSessionId <Guid[]> [<CommonParameters>]

Detailed Description

This cmdlet returns scan task sessions performed during the specified SureBackup session.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

InitiatorSessionId

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

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

True

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 VBRSureBackupScanTaskSession object that contains scan tasks performed during the SureBackup session.

Examples

Getting List of SureBackup Scan Task Sessions

This example shows how to get the list of scan task sessions performed during the SureBackup job session with 8e3cf452-23cb-490a-a86a-f802940e26df ID.

$sbs = Get-VBRSureBackupSession -ID 8e3cf452-23cb-490a-a86a-f802940e26df

$ts = Get-VBRSureBackupTaskSession -Session $sbs

Get-VBRScanTaskSession -InitiatorSessionId $ts.id

Perform the following steps:

  1. Run the Get-VBRSureBackupSession cmdlet. Specify the ID parameter. Save the result to the $sbs variable.
  2. Run the Get-VBRSureBackupTaskSession cmdlet. Set the $sbs variable as the Session parameter value. Save the result to the $ts variable.
  3. Run the Get-VBRScanTaskSession cmdlet. Set the $ts.id variable as the InitiatorSessionId parameter value.