Find-VSBVirtualLab

In this article

    Short Description

    Looks for virtual labs created on the specified ESXi host.

    Find-VSBVirtualLab Note:

    This cmdlet is deprecated and will be marked as obsolete in the future. It is recommended to re-write your scripts using the Connect-VBRViVirtualLab cmdlet.

    Applies to

    Platform: VMware

    For Hyper-V, run Find-VSBHvVirtualLab.

    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 ESXi host, both registered in Veeam Backup & Replication and not.

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

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

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Server

    Specifies the VMware host. The cmdlet will return virtual labs created on this host.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    Name

    Specifies the array of virtual lab names. 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

    CVirtualLabDescriptor

    Example 1

    This command looks for the list of all virtual labs located on the ESXi hosts. The servers are obtained with Get-VBRServer, sorted by "Type" and piped down.

    Get-VBRServer -Type ESXi | Find-VSBVirtualLab

    Example 2

    This command looks for the virtual lab named "MailServer_VLab" connected to the ESXi host named "ESXiHost". The server is obtained with Get-VBRServer and piped down.

    Get-VBRServer -Name "ESXiHost" | Find-VSBVirtualLab -Name "MailServer_VLab"

    Related Commands

    Get-VBRServer

    I want to report a typo

    There is a misspelling right here:

     

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