Remove-VSBVirtualLab
Short Description
Removes a specified VMware virtual lab.
Applies to
Platform: VMware
For Hyper-V, run Remove-VSBHvVirtualLab.
Product Edition: Enterprise, Enterprise Plus
Syntax
Remove-VSBVirtualLab [-VirtualLab] <CViSbVirtualLab[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>] |
Related Commands
Detailed Description
This cmdlet removes a specified VMware virtual lab from Veeam Backup & Replication.
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-VSBVirtualLab.
Parameters
Parameter | Description | Required | Position | Accept | Accept |
VirtualLab | Specifies the virtual lab you want to remove. You can assign multiple virtual labs to this object. | True | 1 | True (ByValue, | 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 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-VSBVirtualLab and piped down.
PS C:\PS> Get-VSBVirtualLab -Name "Virtual Lab 01" | Remove-VSBVirtualLab |
Example 2
This command removes a virtual lab represented by the $vlab variable. The virtual lab object is obtained with Get-VSBVirtualLab and assigned to the variable beforehand.
PS C:\PS> Remove-VSBVirtualLab -VirtualLab $vlab |