Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Get-VSBVirtualLab

Short Description

Returns VMware virtual labs.

Applies to

Platform: VMware

For Hyper-V, run Get-VSBHvVirtualLab.

Product Edition: Enterprise, Enterprise Plus

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 about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example 1

This command returns the list of all virtual labs.

PS C:\PS> Get-VSBVirtualLab

Example 2

This command returns virtual labs by name.

PS C:\PS> Get-VSBVirtualLab -Name "MailServer VLab 01", "MailServer VLab 05"

Example 3

This command returns virtual labs by Id.

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

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation