Find-VSBHvVirtualLab

In this article

    Short Description

    Looks for virtual labs created on the specified Hyper-V host.

    Applies to

    Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Find-VSBVirtualLab [-Server] <CHost> [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet returns virtual labs created on the specified Hyper-V host, both registered in Veeam Backup & Replication and not.

    You can get the list of all virtual labs on the specified Hyper-V host or look for instances directly by name.

    Run Connect-VSBHvVirtualLab to add the unregistered virtual labs to Veeam Backup & Replication.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Server

    Specifies the Hyper-V host. The cmdlet will return virtual labs created on this host.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    Name

    Specifies the array of names of the virtual labs. The cmdlet will return virtual labs with these names.

    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.

    Return Type

    CHvSbVirtualLab

    Example 1

    This command looks for the list of all virtual labs created on the Hyper-V server named "Hyper-V Host". The server object is obtained with Get-VBRServer and piped down.

    Get-VBRServer -Name "Hyper-V Host" | Find-VSBHvVirtualLab

    Example 2

    This command looks for the virtual labs with names starting with "Hv" on the server represented by the $server variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand.

    Find-VSBHvVirtualLab -Server $server -Name Hv*

    Related Commands

    Get-VBRServer