Remove-VBRVirtualLab

In this article

    Short Description

    Removes virtual labs from Veeam Backup & Replication.

    Applies to

    Platform: VMware

    Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

    Syntax

    Remove-VBRVirtualLab [-VirtualLab] <VBRVirtualLab[]> [-FromHost] [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet removes virtual labs from Veeam Backup & Replication.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    VirtualLab

    Specifies a virtual lab. The cmdlet will remove this virtual lab from the Veeam Backup & Replication infrastructure.

    Accepts the VBRVirtualLab[] object. To get this object, run the Get-VBRVirtualLab cmdlet.

    True

    0

    True (ByValue,
    ByProperty
    Name)

    FromHost

    Defines that the cmdlet will remove virtual lab from Veeam Backup & Replication and VMware infrastructure.

    If you specify this parameter, the cmdlet will remove a virtual lab from both Veeam Backup & Replication and VMware infrastructures. Otherwise, the cmdlet will remove the virtual lab from the VMware infrastructure only.

    SwitchParamter

    False

    Named

    False

    WhatIf

    Defines that the cmdlet will write a message that describes the effects of running the cmdlet without actually performing any action.

    SwitchParamter

    False

    Named

    False

    Confirm

    Defines that the cmdlet will display a prompt that asks if the user is sure that he wants to continue.

    SwitchParamter

    False

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Examples

    Remove-VBRVirtualLabExample 1. Removing Virtual Lab from Veeam Backup & Replication

    This example shows how to remove the Exchange 01 virtual lab from Veeam Backup & Replication.

    $lab = Get-VBRVirtualLab -Name "Exchange 01"

    Remove-VBRVirtualLab -VirtualLab $lab

    Perform the following steps:

    1. Run the Get-VBRVirtualLab cmdlet. Specify the Name parameter value. Save the result to the $lab variable.
    2. Run the Remove-VBRVirtualLab cmdlet. Set the $lab variable as the VirtualLab parameter value.

    Remove-VBRVirtualLabExample 2. Removing Virtual Lab from Veeam Backup & Replication and VMware Infrastructure

    This example shows how to remove the SQL07 virtual lab from Veeam Backup & Replication and the VMware infrastructure.

    $lab = Get-VBRVirtualLab -Name "SQL07"

    Remove-VBRVirtualLab -VirtualLab $lab -FromHost

    Perform the following steps:

    1. Run the Get-VBRVirtualLab cmdlet. Specify the Name parameter value. Save the result to the $lab variable.
    2. Run the Remove-VBRVirtualLab cmdlet. Set the $lab variable as the VirtualLab parameter value. Specify the FromHost parameter.

    Related Commands

    Get-VBRVirtualLab

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.