Get-VBRTaskSession

In this article

    Short Description

    Returns tasks performed during job sessions.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Get-VBRTaskSession [-Session] <CBackupSession> [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet returns tasks performed during the specified session. The tasks are VMs processed during one job session.

    Run Get-VSBTaskSession to get the tasks for SureBackup jobs session.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Session

    Specifies the session the tasks of which you want to get.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    Name

    Specifies the array of job object names (for example, VMs in job). The cmdlet will return tasks performed for these objects during the selected session.

    False

    Named

    False

    True

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Example 1

    This command gets the list of tasks performed for the VMs named "DC" and "DNS" in the backup job session named "Exchange Backup". The backup session is obtained with Get-VBRBackupSession and piped down.

    Get-VBRBackupSession -Name "Exchange Backup" | Get-VBRTaskSession -Name "DC", "DNS"

    Example 2

    This command gets the list of tasks performed for the VMs named "DC" and "DNS" in the backup job session represented by the $ExchangeSession variable. The backup session is obtained with Get-VBRBackupSession and assigned to the variable beforehand.

    Get-VBRTaskSession -Session $ExchangeSession -Name "DC", "DNS"

    Related Commands

    Get-VBRBackupSession

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.