This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VBRSession

In this article

    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>]

    Related Commands

    Get-VBRJob

    Return Type

    VBRBackupSession

    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.

    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.

    True

    Named

    True (by Value
    FromPipeline, ValueFromPipeline
    ByPropertyName)

    False

    State

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

    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.