Uninstall-VBRCDPFilter

In this article

    Short Description

    Removes VeeamCDP filters from VMware clusters.

    Applies to

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

    Syntax

    Uninstall-VBRCDPFilter -Server <CHost> -CDPCluster <CViClusterItem[]> [-Force]  [<CommonParameters>]

    Detailed Description

    This cmdlet removes VeeamCDP filters from VMware clusters.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Server

    Specifies a VMware host that is located on a VMware cluster from which you want to remove a VeeamCDP filter. After you remove the filter from this VMware cluster, Veeam Backup & Replication will remove the filter from this VMware host.

    Accepts the CHost object. To get this object, run the Find-VBRViEntity cmdlet.

    True

    Named

    True (ByValue, ByPropertyName

    CDPCluster

    Specifies an array of VMware clusters from which you want to remove a VeeamCDP filter.

    Accepts the  CViClusterItem[] object. To get this object, run the Find-VBRViEntity cmdlet.

    True

    Named

    False

    Force

    Defines that the cmdlet will remove VeeamCDP filters from VMware clusters without showing warnings in the PowerShell console.

    SwitchParameter

    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.

    Output Object

    None.

    Examples

    Removing VeeamCDP Filters from VMware Clusters

    This example shows how to remove a VeeamCDP filter from the CDPCluster VMware cluster. The cmdlet will also remove the VeeamCDP filter from the CDPHost VMware host.

    $server = Get-VBRServer -Name "ESXiHost 01"

    $cluster = Find-VBRViEntity -Server $server -HostsAndClusters -Name "CDPCluster"

    Uninstall-VBRCDPFilter -Server $host -CDPCluster $cluster

    Perform the following steps:

    1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
    2. Run the Find-VBRViEntity cmdlet. Specify the Server, HostsAndClusters and Name parameters. Save the result to the $cluster variable.
    3. Run the Uninstall-VBRCDPFilter cmdlet. Set the $server variable as the Server parameter value. Set the $cluster variable as the CDPCluster parameter value.

    Related Commands

    I want to report a typo

    There is a misspelling right here:

     

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