Get-VBRCDPPolicy

In this article

    Short Description

    Returns CDP policies.

    Applies to

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

    Syntax

    This cmdlet provides cmdlet sets that allow you to:

    • Getting CDP policies by their names.

    Get-VBRCDPPolicy [-Name <string[]>]  [<CommonParameters>]

    • Getting CDP policies by their IDs.

    Get-VBRCDPPolicy [-Id <guid[]>]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns CDP policies.

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

    Name

    Specifies an array of names for CDP policies. The cmdlet will return a list of policies with these names.

    String[]

    False

    Named

    True (ByValue, ByPropertyName)

    Id

    Specifies an array of Ids for CDP policies. The cmdlet will return a list of policies with the specified IDs.

    Guid[]

    False

    Named

    True (ByValue, ByPropertyName)

    <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 VBRCDPPolicy object that defines settings of CDP policies.

    Examples

    Get-VBRCDPPolicyExample 1. Getting CDP Policy by Name

    This command returns the VM079 CDP policy.

    Get-VBRCDPPolicy -Name "VM079"

    Get-VBRCDPPolicyExample 2. Getting CDP Policy by ID

    This command returns the 13744fce-e8ea-4b77-9092-26e3f09e6a6e CDP policy.

    Get-VBRCDPPolicy -Id "13744fce-e8ea-4b77-9092-26e3f09e6a6e"

    Get-VBRCDPPolicyExample 3. Getting all CDP Policies

    This command returns all CDP policies that are created on the backup server.

    Get-VBRCDPPolicy

    I want to report a typo

    There is a misspelling right here:

     

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