Get-VBRUnstructuredBackupTaskSession

Short Description

Returns tasks for file share and object storage backup sessions.

Note

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

Applies to

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Get file share and object storage backup session tasks by the file share names.

Get-VBRUnstructuredBackupTaskSession -Name <string[]>  [<CommonParameters>]

  • Get file share and object storage backup session tasks by their IDs.

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

  • Get file share and object storage backup session tasks for the backup session.

Get-VBRUnstructuredBackupTaskSession -Session <VBRUnstructuredBackupSession>  [<CommonParameters>]

Detailed Description

This cmdlet returns tasks for file share and object storage backup sessions. Veeam Backup & Replication creates a separate task for each file share within a backup session.

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Name

Specifies an array of file share and object storage names. The cmdlet will return tasks with these names.

String[]

True

Named

False

Id

Specifies an array of IDs for file share and object storage backup session tasks. The cmdlet will return tasks with these IDs.

Guid[]

True

Named

False

Session

Specifies the file share and object storage backup session. The cmdlet will return tasks that run within this session.

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

True

Named

False

<CommonParameters>

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

Output Object

VBRUnstructuredBackupTaskSession

Examples

Get-VBRUnstructuredBackupTaskSessionExample 1. Getting Backup Session Tasks for File Share by Its Name

This command returns all tasks run for the \\fileserv05\Documents file share.

Get-VBRUnstructuredBackupTaskSession -Name "\\fileserv05\Documents"

Get-VBRUnstructuredBackupTaskSessionExample 2. Getting Backup Session Tasks by Task IDs

This command returns the 49664A5F-9C55-4A1F-8E6A-1CD5705A684B and 42696B53-6FEC-4148-9354-AA9E4B52DED9 backup session tasks.

Get-VBRUnstructuredBackupTaskSession -Id ("49664A5F-9C55-4A1F-8E6A-1CD5705A684B", "42696B53-6FEC-4148-9354-AA9E4B52DED9")

Get-VBRUnstructuredBackupTaskSessionExample 3. Getting Backup Session Tasks for Backup Session

This command returns tasks that run within the 42636B53-6FEC-4148-9354-BB9E4B52DED9 backup session.

$session = Get-VBRUnstructuredBackupSession -Id "42636B53-6FEC-4148-9354-BB9E4B52DED9"
Get-VBRUnstructuredBackupTaskSession -Session $session

Perform the following steps:

  1. Run the Get-VBRUnstructuredBackupSession cmdlet. Specify the Id parameter value. Save the result to the $session variable.
  2. Run the Get-VBRUnstructuredBackupTaskSession cmdlet. Set the $session variable as the Session parameter value.

Related Commands

Get-VBRUnstructuredBackupSession