Get-VBRNASBackupSession

In this article

    Short Description

    Returns file share backup job sessions.

    Important

    This cmdlet is available starting from Veeam Backup & Replication 11a (build 11.0.1.1261).

    Applies to

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

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Get backup sessions for file share backup jobs with certain names.

    Get-VBRNASBackupSession -Name <string[]>  [<CommonParameters>]

    • Get file share backup sessions with certain IDs.

    Get-VBRNASBackupSession -Id <guid[]>  [<CommonParameters>]

    Detailed Description

    This cmdlet returns file share backup job sessions.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept
    Pipeline
    Input

    Name

    Specifies an array of file share backup jobs. The cmdlet will return backup sessions of the file share backup jobs with these names.

    Note: Veeam Backup & Replication adds (Full) at the end of the job name for full backup sessions. Depending on the type of the backup session you may specify the job name in one of the following ways:

    • To get incremental backup sessions, specify the job name as it was specified when creating the job.
    • To get full backup sessions, add (Full) at the end of the Name parameter.
    • To get both full and incremental backup sessions for the job, add * at the end of the Name parameter.

    String[]

    True

    Named

    False

    Id

    Specifies an array of file share backup session IDs. The cmdlet will return file share backup sessions with these IDs.

    Guid[]

    True

    Named

    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

    VBRNASBackupSession

    Example

    This command returns all backup sessions for the New backup session file share backup job.

    Get-VBRNASBackupSession -Name "New backup session*"