Add-VBRCopyJob

In this article

    Short Description

    Creates VM copy jobs.

    Applies to

    Platform: VMware

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

    Syntax

    Add-VBRCopyJob [-Name] <string> [-Type] <ESourceType> {NET | VCB | VDDK | Files | HyperV | Backup | Unknown} -Server <CHost> -Folder <string> -SourceServer <CHost> -Objects <string[]> [-FileName <string>] [-Description <string>] [-Force]  [<CommonParameters>]

    -OR-

    Add-VBRCopyJob [-Name] <string> [-Type] <ESourceType> {NET | VCB | VDDK | Files | HyperV | Backup | Unknown} -Objects <string[]> -Repository <CBackupRepository> [-FileName <string>] [-Description <string>] [-Force] [<CommonParameters>]

    Detailed Description

    This cmdlet creates a new job that copies the selected VMs to another location.

    With a VM copy job, you can create a fully-functioning copy of a VM that will require no manual editing and adjustments. VM copying can be helpful if you want to move your datacenter, mirror your production environment to test lab storage, etc.

    Note that when you create a copy 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.

    Run Copy-VBRJob to create a copy of a job.

    Starting from Veeam Backup & Replication version 9.5 Update 3, the cmdlet checks if the data of the VMs added to the job changes its geographical location.

    Add-VBRCopyJob Note:

    The cmdlet will not run if the geographical location of the VMs added to the job and the job target host location do not match. If you still want to run the cmdlet, use the Force parameter.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the name you want to assign to the new copy job.

    True

    1

    False

    False

    Type

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

    • VDDK – Virtual Disk Development Kit (VMware vStorage API): used for VM backup jobs data.
    • Files: used for file backup data.
    • Backup: not supported (legacy mode).
    • Hyper-V: not supported (legacy mode).
    • VCB: not supported (legacy mode).
    • NET: not supported (legacy mode).

    True

    2

    False

    False

    Server

    Specifies the host where the created copy should be stored.

    True

    Named

    False

    False

    Folder

    Specifies the string with full path to the folder where the created VM copy should be stored.

    True

    Named

    False

    False

    FileName

    Specifies the string with the file name for the created VM copy (by default, a copied file is given the same name as the VM).

    False

    Named

    False

    False

    SourceServer

    Specifies the server where the target files for file copy job are located.

    Accepts server object or string (host name) type.

    True

    Named

    False

    False

    Objects

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

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    False

    Description

    Specifies the description of the copy job.

    False

    Named

    False

    False

    Repository

    Specifies the backup repository to which you want to place the copied VMs.

    You cannot use scale-out backup repository as target to the VM copy job.

    True

    Named

    False

    False

    Force

    Indicates that the cmdlet will create a VM copy job even if the geographical location of the VMs added to the job and the target host location do not match.

    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.

    Related Commands

    Get-VBRServer

    Get-VBRLocation

    I want to report a typo

    There is a misspelling right here:

     

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