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

Remove-VSBHvVirtualLab

In this article

    Short Description

    Removes a Hyper-V virtual lab.

    Applies to

    Platform: Hyper-V

    For VMware, run Remove-VSBVirtualLab.

    Product Edition: Enterprise, Enterprise Plus

    Syntax

    Remove-VSBHvVirtualLab [-VirtualLab] <CHvSbVirtualLab[]> [-WarningAction <ActionPreference>][-WarningVariable <String>] [-WhatIf][-Confirm][<CommonParameters>]

    Related Commands

    Get-VSBHvVirtualLab

    Detailed Description

    This cmdlet removes a specified Hyper-V virtual lab from Veeam Backup & Replication console.

    The virtual lab is not deleted from server where it was created. When you remove a virtual lab, you stop managing it via your Veeam Backup & Replication console. Note that you cannot remove a virtual lab from server with Veeam PowerShell.

    You can add a removed virtual lab to your console by running Connect-VSBHvVirtualLab.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    VirtualLab

    Specifies the virtual lab you want to remove from your Veeam Backup & Replication console.

    True

    Named

    True(ByValue,
    ByProperty
    Name)

    False

    WhatIf

    Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

    False

    Named

    False

    False

    Confirm

    Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

    False

    Named

    False

    False

    <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 removes a virtual lab named "Virtual Lab 01". The virtual lab object is obtained with Get-VSBHvVirtualLab and piped down.

    PS C:\PS> Get-VSBHvVirtualLab -Name "Virtual Lab 01" | Remove-VSBHvVirtualLab

    Example 2

    This command removes a virtual lab represented by the $vlab variable. The virtual lab object is obtained with Get-VSBHvVirtualLab and assigned to variable beforehand.

    PS C:\PS> Remove-VSBHvVirtualLab -VirtualLab $vlab