Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Add-VBRCopyJob

Short Description

Creates VM copy jobs.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Add-VBRCopyJob [-Name] <String> [-Type] <CDbBackupJobInfo+ESourceType> -Server <CHost> -Folder <String> [-FileName <String>] -SourceServer <CHost> -Objects <String[]> [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

-OR-

Add-VBRCopyJob [-Name] <String> [-Type] <CDbBackupJobInfo+ESourceType> [-FileName <String>] -Objects <String[]> [-Description <String>] -Repository <CBackupRepository> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]

Detailed Description

This cmdlet creates a new job that copies the selected VM(s) 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.

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 name(s) of VM(s) 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

<CommonParameters>

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

Related Commands

Get-VBRServer

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation