Remove-VBRCDPPolicy

In this article

    Short Description

    Removes CDP policies.

    Applies to

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

    Syntax

    Remove-VBRCDPPolicy -Policy <VBRCDPPolicy[]> [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet removes CDP policies.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Policy

    Specifies an array of CDP policies that you want to remove.

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

    True

    Named

    True (ByValue, ByPropertyName)

    WhatIf

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

    SwitchParameter

    False

    Named

    False

    Confirm

    Defines that the cmdlet will display a prompt that asks if you want to continue running the command.

    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 all CDP Policies

    This example shows how to remove all CDP policies.

    $policy = Get-VBRCDPPolicy

    Remove-VBRCDPPolicy -Policy $policy

    Perform the following steps:

    1. Run the Get-VBRCDPPolicy cmdlet. Save the result to the $policy variable.
    2. Run the Remove-VBRCDPPolicy cmdlet. Set the $policy variable as the Policy parameter value.

    Related Commands

    Get-VBRCDPPolicy