Remove-VBRCDPReplica

In this article

    Short Description

    Removes CDP replicas from a backup infrastructure.

    Applies to

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

    Syntax

    Remove-VBRCDPReplica -Replica <VBRCDPReplica> [-FromDisk] [-Force] [-WhatIf] [-Confirm]  [<CommonParameters>]

    Detailed Description

    This cmdlet removes CDP replicas from a backup infrastructure.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Replica

    Specifies a CDP replica that you want to remove from a backup infrastructure.

    Accepts the VBRCDPReplica object. To create this object, run the Get-VBRCDPReplica cmdlet.

    True

    Named

    True (ByValue, ByPropertyName)

    FromDisk

    Defines that the cmdlet will permanently remove a CDP replica from disk. If you do not provide this parameter, the cmdlet will exclude the replica from processing by a CDP policy.

    SwitchParameter

    False

    Named

    False

    Force

    Defines that the cmdlet will remove a CDP replica showing warnings in the PowerShell console.

    SwitchParameter

    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.

    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 CDP Replica from Backup Infrastructure

    This examples shows how to remove the Win05_replicant CDP replica from a backup infrastructure. The cmdlet will permanently remove a CDP replica from a disk.

    $replica = Get-VBRCDPReplica -Name "Win05_replicant"

    Remove-VBRCDPReplica -Replica $replica -FromDisk

    Perform the following steps:

    1. Run the Get-VBRCDPReplica cmdlet. Specify the Name parameter value. Save the result to the $replica variable.
    2. Run the Remove-VBRCDPReplica cmdlet. Set the $replica variable as the Replica parameter. Provide the FromDisk parameter.

    Related Commands

    Get-VBRCDPReplica

    I want to report a typo

    There is a misspelling right here:

     

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