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

Get-VSBHvVirtualLab

Short Description

Returns Hyper-V virtual labs.

Applies to

Platform: Hyper-V

For VMware, run Get-VSBVirtualLab.

Product Edition: Enterprise, Enterprise Plus

Syntax

This cmdlet provides 2 parameter sets.

  • For getting Hyper-V virtual labs by name:

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

  • For getting Hyper-V virtual labs by ID:

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

Detailed Description

This cmdlet returns Hyper-V virtual labs that are connected to the Veeam backup console.

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

False

Named

True (ByValue,
ByProperty
Name)

True

Id

Specifies the array of Hyper-V virtual lab IDs. The cmdlet will return Hyper-V virtual labs with these IDs.

Accepts GUID or string type.

False

Named

True (ByValue,
ByProperty
Name)

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 created or connected to Veeam Backup & Replication.

PS C:\PS> Get-VSBHvVirtualLab

Example 2

This command returns the list of virtual labs with names starting with "Exchange".

PS C:\PS> Get-VSBHvVirtualLab -Name Exchange*

Example 3

This command returns virtual labs by Id.

PS C:\PS> Get-VSBVirtualLab -Id 1022504c-9008-4883-b166-718bdf7280ea, 502dc485-84f5-4a9d-86e7-8b00d1d5a0be

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

Backup and Restore of SQL Server Databases

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