Get-VBRTapeBackupSession
Short Description
Returns tape backup job sessions.
Applies to
Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License
Syntax
This cmdlet provides parameter sets that allow you to:
- Get tape backup sessions with certain IDs.
Get-VBRTapeBackupSession [-Id <Guid[]>] [<CommonParameters>] |
- Get tape backup sessions run for a certain tape backup job.
Get-VBRTapeBackupSession [-Job <VBRTapeJob>] [<CommonParameters>] |
Detailed Description
This cmdlet returns tape backup job sessions.
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. | 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
Example 1. Getting Tape Backup Sessions with Certain IDs
This example shows how to get tape backup sessions with certain IDs.
|
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.
Perform the following steps:
|
Related Commands