Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Get-VBRSession

Short Description

Returns tape jobs sessions.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Get-VBRSession -Job <VBRJob> [-Last] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Get-VBRSession -Session <VBRSession> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Get-VBRSession -Job <VBRJob> [-State <VBRSessionState>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Get-VBRSession -Job <VBRJob> [-Result <VBRSessionResult>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet returns sessions for a selected tape job.

You can get all tape job sessions that have been run, update the job session state or filter the sessions by session state or result. Use an appropriate scenario for each case.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Job

Specifies the tape job for which you want to get sessions that have been run.

Accepts VBRJob (BackupToTape or FileToTape) type.

True

Named

True (by  ValueFromPipeline
ByPropertyName)

False

Last

Indicates that the command returns the last session of the specified job.

False

Named

False

False

Session

Specifies the job session for which you want to get updated state.

Accepts VBRSession type.

True

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

False

State

Specifies the session state with which you want to get sessions.

See VBRSessionState.

False

Named

False

False

Result

Specifies the session result with which you want to get sessions.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRBackupSession

Related Commands

Get-VBRJob

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation