Find-VSBVirtualLab (obsolete)

Short Description

Looks for virtual labs created on the specified ESXi host.

Find-VSBVirtualLab (obsolete) 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 the Find-VSBHvVirtualLab cmdlet.

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 the Connect-VSBVirtualLab cmdlet to add the unregistered virtual labs to Veeam Backup & Replication.

Parameters

Parameter	Description	Type	Required	Position	Accept Pipeline Input
Server	Specifies the VMware host. The cmdlet will return virtual labs created on this host.	Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.	True	1	True (ByValue, ByProperty Name)
Name	Specifies the array of virtual lab names. The cmdlet will return virtual labs with these names.	String[]	False	Named	False

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

Server

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

Accepts the CHost object. To get this object, run the Get-VBRServer cmdlet.

True

True (ByValue,
ByProperty
Name)

Name

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

String[]

False

Named

False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

CVirtualLabDescriptor

Examples

Example 1. Getting All Virtual Labs on ESXi Hosts [Using Pipeline]

This example shows how to get the list of all virtual labs located on the ESXi hosts.

Get-VBRServer -Type ESXi | Find-VSBVirtualLab

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Type parameter value.
Pipe the cmdlet output to the Find-VSBVirtualLab cmdlet.

Example 2. Getting All Virtual Labs on ESXi Hosts [Using Pipeline]

This example shows how to get the MailServer_VLab virtual lab connected to the ESXiHost ESXi host.

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

Perform the following steps:

Run the Get-VBRServer cmdlet. Specify the Name parameter value.
Pipe the cmdlet output to the Find-VSBVirtualLab cmdlet. Specify the Name parameter value.

Related Commands

Get-VBRServer