Get-VBRTapeBackupSession

Short Description

Returns tape backup job sessions.

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

Syntax

This cmdlet provides the following parameter sets:

Name (Default)

Get-VBRTapeBackupSession [-Name <String[]>] [<CommonParameters>]
Id

Get-VBRTapeBackupSession [-Id <Guid[]>] [<CommonParameters>]
Job

Get-VBRTapeBackupSession [-Job <VBRTapeJob>] [<CommonParameters>]

Detailed Description

This cmdlet returns tape backup job sessions.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Id	Specifies an array of tape backup session IDs. The cmdlet will return tape backup sessions with these IDs.	`Guid[]`	False	Named	False
Job	Specifies a tape backup job. The cmdlet will return tape backup sessions run for this tape backup job. Accepts the `VBRTapeJob` object. To create this object, run the `Get-VBRTapeJob` cmdlet.	`VBRTapeJob`	False	Named	False
Name	Specifies an array of tape backup job names. The cmdlet will return tape backup sessions run for this tape backup job.	`String[]`	False	Named	False

<CommonParameters>

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

Output Object

The cmdlet returns the VBRTapeBackupSession object that defines the tape backup job session with the following attributes: Progress, RunManually, Log, Initiator, CreationTime, EndTime, JobId, Result, State, Id.

Examples

Get-VBRTapeBackupSession Example 1. Getting Tape Backup Sessions with Certain IDs

This example shows how to get tape backup sessions with certain IDs.

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

Get-VBRTapeBackupSession Example 2. Getting Tape Backup Sessions for Certain Tape Backup Job

This example shows how to get tape backup sessions run for a certain tape backup job.

$tapejob = Get-VBRTapeJob -Name "Payroll Reports to Tape (Q1-Q2)"

Get-VBRTapeBackupSession -Job $tapejob

Perform the following steps:

Run the Get-VBRTapeJob cmdlet. Specify the Name parameter value. Save the result to the $tapejob variable.
Run the Get-VBRTapeBackupSession cmdlet. Set the $tapejob variable as the Job parameter value.

Get-VBRTapeJob