Add-VBRCopyJob
Short Description
Creates a new VM copy job.
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>] |
Related Commands
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 | Accept |
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:
| 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 CHost object or string (host name). | True | Named | False | False |
Objects | Specifies the string with the name(s) of VM(s) that you want to copy. | True | Named | True (ByValue, | False |
Description | Specifies the description of the copy job. If not set, Veeam Backup & Replication will enter date and time of creation by default. | 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.