Add-VBRReplicaJob (obsolete)

In this article

    Short Description

    Creates new replication job.

    Note

    This cmdlet is obsolete and is not supported. Run Add-VBRViReplicaJob or Add-VBRHvReplicaJob cmdlets to create a new replication job.

    Applies to

    Platform: VMware

    Syntax

    Add-VBRReplicaJob [-Name] <String> [[-Type] <String>] [-Server] <CHost> [-Datastore] <Datastore> -Objects <String[]> [-Suffix <String>] [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

    Detailed Description

    This cmdlet allows you to create a new replication job.

    Replication is a process of copying a VM from its primary location (source host) to a destination location (redundant target host). Veeam Backup & Replication creates an exact copy of a VM (replica), registers it on the target host and maintains it in synch with the original VM.

    Note that when you create a replica job, you need to run it manually unless you enable a job schedule.

    Run Start-VBRJob to start the created job.

    Run Set-VBRJobSchedule to set schedule for the job.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the string with the name you want to assign to the replication job.

    True

    1

    False

    False

    Type

    Specifies the string with the type of the created replication job which defines how VM data is retrieved:

    • VDDK – Virtual Disk Development Kit (VMware vStorage API)
    • VCB – VMware Consolidated Backup (legacy mode)
    • NET – Network replication (legacy mode)

    False

    2

    False

    False

    Server

    Specifies the host where the created replica should be stored.

    True

    3

    False

    False

    Datastore

    Specifies the datastore where the created replica should reside.

    True

    4

    False

    False

    Objects

    Specifies the string with the names of VMs that you want to replicate.

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Suffix

    Specifies the suffix that will be appended to the name of the VM you are replicating. This name will be used to register the replicated VM on the target server.

    False

    Named

    False

    False

    Description

    Specifies the description of the replica job.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

    Example

    This example allows you to create a replication job with the following parameters:

    • Name of a replication job: Replica1
    • Replication type: VDDK
    • Variable which contains target host DNS name or IP address: $server
    • Variable which contains datastore name: $datastore
    • Replicated VM: vm4

    Add-VBRReplicaJob –Name “Replica1”–Type VDDK –Server $server –Datastore $datastore
    –Objects vm4

    Related Commands

    Get-VBRServer

    Find-VBRViDatastore