New-BEConvertToVirtualTargetEnvironment Help

Synopsis

Defines the target environment for a convert to virtual job.

Syntax

New-BEConvertToVirtualTargetEnvironment -LogonAccount [<BELogonAccount>] -ToolsIsoPath [<String>] -HyperVServerName [<String>] -HyperVDestinationPath [<String>] [<CommonParameters>]

New-BEConvertToVirtualTargetEnvironment -LogonAccount [<BELogonAccount>] -ToolsIsoPath [<String>] -VMwareVCenterServerName [<String>] -VMwareHostName [<String>] -VMwareDataStoreName [<String>] [-VMwareResourcePoolName [<String>]] [-VMwareVirtualMachineFolder [<String>]] [<CommonParameters>]

New-BEConvertToVirtualTargetEnvironment -LogonAccount [<BELogonAccount>] -ToolsIsoPath [<String>] -VMwareEsxServerName [<String>] -VMwareDataStoreName [<String>] [-VMwareResourcePoolName [<String>]] [<CommonParameters>]

Description

Defines the target environment for a convert to virtual job.

The output of New-BEConvertToVirtualTargetEnvironment is used for the TargetEnvironment parameter of the Submit-BEConvertBackupToVirtualJob and Add-BEConvertToVirtualStageBackupTask commands.

Parameters

-VMwareVCenterServerName <String>

Specifies the name of the VMware vCenter server where the virtual machine will be created.

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

-VMwareHostName <String>

Specifies the name of a host in a VMware vCenter where the virtual machine will be created.

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

-VMwareEsxServerName <String>

Specifies the name of a VMware ESX server where the virtual machine will be created.

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

-VMwareDataStoreName <String>

Specifies the name of a data store in a VMware host where the virtual machine will be created.

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

-VMwareVirtualMachineFolder <String>

Specifies the folder path of a virutal machine folder in VMware vCenter where the virtual machine will be created.

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

-VMwareResourcePoolName <String>

Specifies the name of VMware resource pool.

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

-HyperVServerName <String>

Specifies the name of a Microsoft Hyper-V server.

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

-HyperVDestinationPath <String>

Specifies the directory where the Microsoft Hyper-V virtual machine will be created.

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

-LogonAccount <BELogonAccount>

Specifies the Backup Exec logon account used to log into the target virtual environment.

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

-ToolsIsoPath <String>

Specifies the full path of the VMware Tools or Hyper-V Integration Components ISO image.

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

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

Input Type

None

This cmdlet does not accept any input.

Return Value

BackupExec.Management.CLI.BEConvertToVirtualTargetEnvironment

The object that represents convert to virtual environment that has been specified.

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 HyperV 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 within a VMware vCenter from any of the backup jobs every weekday at 10pm.