Remove-VSBVirtualLab (obsolete)

Short Description

Removes a specified VMware virtual lab.

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

Applies to

Platform: VMware

For Hyper-V, run the Remove-VSBHvVirtualLab cmdlet.

Product Edition: Enterprise, Enterprise Plus, Veeam Universal License

Syntax

Remove-VSBVirtualLab -VirtualLab <CViSbVirtualLab[]> [-FromHost] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet removes VMware virtual labs.

You can remove virtual labs from the Veeam Backup & Replication console or from ESXi hosts. To remove virtual labs from ESXi hosts, use the FromHost parameter.

If you remove a virtual lab from the Veeam Backup & Replication console, you can add it back by running the Connect-VSBHvVirtualLab cmdlet.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
VirtualLab	Specifies the array of virtual lab names. The cmdlet will remove these virtual labs.	Accepts the CViSbVirtualLab[] object. To get this object, run the Get-VSBVirtualLab cmdlet.	True	1	True (ByValue, ByProperty Name)
FromHost	Defines that the cmdlet will remove virtual labs from ESXi hosts.	SwitchParameter	False	Named	False
WhatIf	Defines whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.	SwitchParameter	False	Named	False
Confirm	Defines whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.	SwitchParameter	False	False	False

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

Examples

Example 1. Removing Virtual Lab from Console

This example shows how to remove a virtual lab from the Veeam Backup & Replication console.

$vlab = Get-VSBVirtualLab -Name "Virtual Lab"

Remove-VSBVirtualLab -VirtualLab $vlab

Perform the following steps:

Run the Get-VSBVirtualLab cmdlet. Specify the Name parameter value. Save the result to the $vlab variable.
Run the Remove-VSBVirtualLab cmdlet. Set the $vlab variable as the VirtualLab parameter value.

Example 2. Removing Virtual Lab from ESXi Host

This example shows how to remove a virtual lab from the ESXi host.

$vlab = Get-VSBVirtualLab -Name "Virtual Lab"

Remove-VSBVirtualLab -VirtualLab $vlab -FromHost

Perform the following steps:

Run the Get-VSBVirtualLab cmdlet. Specify the Name parameter value. Save the result to the $vlab variable.
Run the Remove-VSBVirtualLab cmdlet. Set the $vlab variable as the VirtualLab parameter value. Provide the FromHost parameter.

Related Commands

Get-VSBVirtualLab