Add-BEConvertToVirtualStageBackupTask Help

Synopsis

Adds a convert to virtual stage to a backup definition in Backup Exec.

Syntax

Add-BEConvertToVirtualStageBackupTask -BackupDefinition [<BEBackupDefinition>] -SimultaneouslyWithBackup [<SwitchParameter>] -TargetEnvironment [<BEConvertToVirtualTargetEnvironment>] [-OverwriteExistingVirtualMachine [<Boolean>]] [-VirtualMachinePhysicalRamMB [<UInt32>]] [-VirtualMachineCpuCount [<UInt32>]] [-VirtualMachineName [<String>]] [<CommonParameters>]

Add-BEConvertToVirtualStageBackupTask -BackupDefinition [<BEBackupDefinition>] -ImmediatelyAfterFullBackup [<String>] -TargetEnvironment [<BEConvertToVirtualTargetEnvironment>] [-VirtualMachinePhysicalRamMB [<UInt32>]] [-OverwriteExistingVirtualMachine [<Boolean>]] [-SubmitOnHold [<Boolean>]] [-VirtualMachineCpuCount [<UInt32>]] [-Name [<String>]] [-VirtualMachineName [<String>]] [<CommonParameters>]

Add-BEConvertToVirtualStageBackupTask -BackupDefinition [<BEBackupDefinition>] [-SourceBackup] {AllBackups | MostRecentFullBackup} -Schedule [<BESchedule>] -TargetEnvironment [<BEConvertToVirtualTargetEnvironment>] [-VirtualMachinePhysicalRamMB [<UInt32>]] [-OverwriteExistingVirtualMachine [<Boolean>]] [-SubmitOnHold [<Boolean>]] [-VirtualMachineCpuCount [<UInt32>]] [-VirtualMachineName [<String>]] [-Name [<String>]] [<CommonParameters>]

Description

Adds a convert to virtual stage to a backup definition in Backup Exec.

You can add a convert to virtual stage to a new backup definition or edit a backup definition.

To add a convert to virtual stage to a new backup definition, use Add-BEConvertToVirtualStageBackupTask and New-BEBackupDefinition.

To edit a backup definition and add a convert to virtual stage, use Add-BEConvertToVirtualStageBackupTask and Get-BEBackupDefinition.

When you create or edit a backup definition, the backup definition must be passed to Save-BEBackupDefinition to commit the changes.

Parameters

-BackupDefinition <BEBackupDefinition>

Specifies the backup definition to modify.

Required	true
Position	Named
Accepts pipeline input	true (ByValue)
Accepts wildcard characters	false

-Name <String>

Specifies the name of the convert to virtual stage.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SimultaneouslyWithBackup <SwitchParameter>

Creates a backup job with the simultaneous conversion to a virtual machine.

Required	true
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-ImmediatelyAfterFullBackup <String>

Creates a backup job and runs the conversion to virtual machine immediately after the backup.

Required	true
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SourceBackup

Specifies the backup source in the backup definition for the convert to a virtual machine.

The valid values are:
AllBackups
MostRecentFullBackup

Required	true
Position	0
Accepts pipeline input	false
Accepts wildcard characters	false

-Schedule <BESchedule>

Specifies the time and frequency that you want to run the job. See New-BESchedule.

Required	true
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-TargetEnvironment <BEConvertToVirtualTargetEnvironment>

Specifies the virtual environment to create the virtual machine. See New-BEConvertToVirtualTargetEnvironment.

Required	true
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-VirtualMachineName <String>

Specifies the name of the virtual machine to create.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-OverwriteExistingVirtualMachine <Boolean>

Overwrites an existing virtual machine with the same name if it already exists.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-VirtualMachinePhysicalRamMB <UInt32>

Specifies the amount of RAM in MB for the virtual machine.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-VirtualMachineCpuCount <UInt32>

Specifies the number of CPUs for the virtual machine.

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

-SubmitOnHold <Boolean>

Submits the job with an on-hold status.

The valid values are:
$true
$false

Required	false
Position	Named
Accepts pipeline input	false
Accepts wildcard characters	false

For more information about common parameters, type "Get-Help about_commonparameters".

Input Type

BackupExec.Management.CLI.BEBackupDefinition

You can pipe a Backup Exec backup definition object to Add-BEConvertToVirtualStageBackupTask.

Return Value

BackupExec.Management.CLI.BEBackupDefinition

The backup definition that has been modified.

Examples

Example 1

C:\PS> $targetEnvironment = New-BEConvertToVirtualTargetEnvironment -HyperVServerName hypervserver01 -HyperVDestinationPath c:\vms -LogonAccount "System Logon Account" -ToolsIsoPath c:\hypervtools.iso
C:\PS> Get-BEAgentServer -Local | New-BEBackupDefinition BackupToDisk | Add-BEConvertToVirtualStageBackupTask -SimultaneouslyWithBackup -TargetEnvironment $targetEnvironment | Save-BEBackupDefinition

These commands create a backup definition that has a convert to virtual stage that creates a virtual machine on a Hyper-V server simultaneously with a backup job.

Example 2

C:\PS> $targetEnvironment = New-BEConvertToVirtualTargetEnvironment -VMwareVCenterServerName vcenterserver01 -VMwareHostName hostserver01 -VMwareDataStoreName datastore01 -LogonAccount "System Logon Account" -ToolsIsoPath c:\vmwaretools.iso
C:\PS> Get-BEAgentServer -Local | New-BEBackupDefinition BackupToDisk | Add-BEConvertToVirtualStageBackupTask -SourceBackup AllBackups -Schedule (New-BESchedule -Weekdays -StartingAt 10PM) -TargetEnvironment $targetEnvironment | Save-BEBackupDefinition

These commands create a backup definition that has a convert to virtual stage that creates a virtual machine in a VMware vCenter from any of the backup jobs every weekday at 10pm.