Remove-VSBVirtualLab

Short Description

Removes a specified VMware virtual lab.

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

Applies to

Platform: VMware

For Hyper-V, run Remove-VSBHvVirtualLab.

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 Connect-VSBHvVirtualLab.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

VirtualLab

Specifies the array of virtual lab names. The cmdlet will remove these virtual labs.

True

1

True (ByValue,
ByProperty
Name)

False

FromHost

Indicates that the cmdlet will remove virtual labs from ESXi hosts.

False

Named

False

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

False

False

False

<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 example shows how to remove a virtual lab from the Veeam Backup & Replication console.

You will need to perform the following steps:

  1. Run Get-VSBVirtualLab to get the virtual lab you want to remove. Save the result to the $vlab variable.
  2. Run Remove-VSBVirtualLab with the $vlab variable.

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

Remove-VSBVirtualLab -VirtualLab $vlab

Example 2

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

You will need to perform the following steps:

  1. Run Get-VSBVirtualLab to get the virtual lab you want to remove. Save the result to the $vlab variable.
  2. Run Remove-VSBVirtualLab with the $vlab variable and the FromHost parameter.

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

Remove-VSBVirtualLab -VirtualLab $vlab -FromHost

Related Commands

Get-VSBVirtualLab