This is an archive version of the document. To get the most up-to-date information, see the current version.

Get-VSBVirtualLab

Short Description

Returns VMware virtual labs.

Get-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 Get-VBRVirtualLab cmdlet.

Applies to

Platform: VMware

For Hyper-V, run Get-VSBHvVirtualLab.

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides 2 parameter sets.

  • For getting VMware virtual labs by name:

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

  • For getting VMware virtual labs by ID:

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

Detailed Description

This cmdlet returns existing VMware virtual labs.

Run Find-VSBVirtualLab 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 VMware virtual lab names. The cmdlet will return VMware virtual labs with these names.

False

Named

False

True

Id

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

Accepts GUID or string type.

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.

Example 1

This command returns the list of all virtual labs.

Get-VSBVirtualLab

Example 2

This command returns virtual labs by name.

Get-VSBVirtualLab -Name "MailServer VLab 01", "MailServer VLab 05"

Example 3

This command returns virtual labs by Id.

Get-VSBVirtualLab -Id 3fw1505l-8811-4283-b066-718bdf7280ea, 909fg28c-14f5-9a9d-6ve7-0b40d1k5a9jm