Install-VBRCDPFilter

In this article

    Short Description

    Installs VeeamCDP filters on VMware clusters.

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

    Syntax

    Install-VBRCDPFilter -CDPCluster <CViClusterItem[]> [-Force]  [<CommonParameters>]

    Detailed Description

    This cmdlet installs VeeamCDP filters on VMware clusters.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    CDPCluster

    Specifies an array of VMware clusters on which you want to install 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 install a VeeamCDP filter on a VMware cluster 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

    The cmdlet returns the VBRCDPFilter[] object that contains VeeamCDP filters that are installed on VMware clusters.

    Examples

    Installing VeeamCDP Filter to VMware Cluster

    This example shows how to install a VeeamCDP filter on the CDPCluster VMware cluster. The cmdlet will install the same version of the VeeamCDP filter on the CDPHost VMware host.

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

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

    Install-VBRCDPFilter -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 Install-VBRCDPFilter cmdlet. 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.