Get-VSBHvVirtualLab

In this article

    Short Description

    Returns Hyper-V virtual labs.

    Applies to

    Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    This cmdlet provides 2 parameter sets.

    • For getting Hyper-V virtual labs by name:

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

    • For getting Hyper-V virtual labs by ID:

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

    Detailed Description

    This cmdlet returns Hyper-V virtual labs that are connected to the Veeam backup console.

    Run Find-VSBHvVirtualLab to look for virtual labs that are not managed by Veeam Backup & Replication.

    You can get the list of all virtual labs or search for instances directly by name or ID.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the array of Hyper-V virtual lab names. The cmdlet will return Hyper-V virtual labs with these names.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    True

    Id

    Specifies the array of Hyper-V virtual lab IDs. The cmdlet will return Hyper-V virtual labs with these IDs.

    Accepts GUID or string type.

    False

    Named

    True (ByValue,
    ByProperty
    Name)

    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 returns the list of all virtual labs created or connected to Veeam Backup & Replication.

    Get-VSBHvVirtualLab

    Example 2

    This command returns the list of virtual labs with names starting with "Exchange".

    Get-VSBHvVirtualLab -Name Exchange*

    Example 3

    This command returns virtual labs by Id.

    Get-VSBVirtualLab -Id 1022504c-9008-4883-b166-718bdf7280ea, 502dc485-84f5-4a9d-86e7-8b00d1d5a0be