Get-VBRReplica

In this article

    Short Description

    Returns VM replicas or cloud VM replicas.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Get-VBRReplica [-Name <string[]>] [-Type <VBRReplicaType> {Local | Cloud | Tenant}]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns VM replicas or cloud VM replicas managed by Veeam Backup & Replication.

    You can look for all VM replicas or for replicas created by a particular replication job.

    With this cmdlet, you call get the replicas that are managed by your backup console. In case you have removed some replicas from the Veeam Backup console, but they remain on disk, you will not be able to get them.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the array of names of replicated VM. The cmdlet will return replicated VMs with these names.

    False

    Named

    False

    True

    Type

    Specifies the type of the replica you want to get:

    • Local: non-cloud replicas.
    • Cloud: [for cloud user] cloud replicas.
    • Tenant: [for cloud provider] cloud replicas created by cloud user.

    The cmdlet will return replicated VMs of the selected type.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Example 1

    This command looks for all replicas managed by Veeam Backup & Replication.

    Get-VBRReplica

    Example 2

    This command looks for the replicas created with the replication job.

    Get-VBRReplica -Name "DC Replica"

    Example 3

    This command looks for the local (non-cloud) replicas created with the replication job.

    Get-VBRReplica -Type Local -Name "DC Replica"