Get-VBRCDPReplica

Short Description

Returns VM replicas.

Applies to

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

Syntax

This cmdlet provides cmdlet sets that allow you to:

  • Get VM replicas by their name.

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

  • Get VM replicas by their ID.

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

Detailed Description

This cmdlet returns VM replicas.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Name

Specifies an array of VM replicas names. The cmdlet will return a list of replicas with these names.

String[]

False

Named

True (ByValue, ByPropertyName)

Id

Specifies an array of IDs for VM replicas. The cmdlet will return a list of replicas 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 VBRCDPReplica object that contains a list of VM replicas.

Examples

Get-VBRCDPReplicaExample 1. Getting VM Protected with CDP by Name

This command returns the Win07 VM protected with CDP.

Get-VBRCDPReplica -Name "Win07"

Get-VBRCDPReplicaExample 2. Getting VM Protected with CDP by ID

This command returns the 13744fce-e8ea-4b77-9092-26e3f09e6a6e VM protected with CDP.

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

Get-VBRCDPReplicaExample 3. Getting all VM Replicas Available in Backup Infrastructure

This command returns all VM replicas that are available in the backup Infrastructure

Get-VBRCDPReplica