Get-VBRAzureApplianceSession

In this article

    Short Description

    Returns statuses of deployment sessions for helper restore appliance.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    This cmdlet provides 3 parameter sets.

    • For getting the statuses of all sessions:

    Get-VBRAzureApplianceSession  [<CommonParameters>]

    • For getting the status of a specific session:

    Get-VBRAzureApplianceSession [-Session <VBRAzureRestoreSession>]  [<CommonParameters>]

    • For getting the status of a specific session by the session ID:

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

    Detailed Description

    This cmdlet returns status of process initiated by the Deploy-VBRAzureLinuxRestoreAppliance cmdlet.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Id

    Specifies the ID of the session. The cmdlet will return the statuses of the  sessions with this ID.

    False

    Named

    True (ByProperty
    Name)

    False

    Session

    Specifies the session. The cmdlet will return the status of this session.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    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

    VBRAzureApplianceSession

    Example 1

    This command returns statuses of all sessions.

    Get-VBRAzureApplianceSession

    Example 2

    This command returns status of a specific session. In this example, we assume that the user saved the session to a variable when they deployed the appliance. See examples for Deploy-VBRAzureLinuxRestoreAppliance for details.

    Get-VBRAzureApplianceSession - Session $appliancesession