The Start-HypervExport
PowerShell command initiates the launch of a virtual export from the selected Rapid Recovery recovery point to a Hyper-V server virtual machine.
Usage
The usage for the command is as follows:
Start-HypervExport
-core [host name] -user [user name] -password [password] -protectedserver [[machine name] or [IP address]] -volumes [volume names] -rpn [number | numbers] | -time [time string] [-vmname [uselocalmachine] | -hostname [virtual host name] -hostport [virtual host port number] -hostusername [virtual host user name] -hostpassword [virtual host password] -vmlocation [location]] [-ram [total megabytes] | -usesourceram] -diskformat [VHD | VHDX] -exportvmconfigfiles
Command Options
The following table describes the options available for the Start-HypervExport
command:
Option | Description |
---|---|
-? |
Display this help message. |
-core |
Optional. Remote Core host machine IP address (with an optional port number). By default the connection is made to the Core installed on the local machine. |
-user |
Optional. User name for the remote Core host machine. If you specify a user name, you also have to provide a password. If none are provided, then the logged-on user's credentials will be used. |
-password |
Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a user name. If none are provided, then the logged-on user's credentials will be used. |
-protectedserver |
Protected machine with recovery points to be exported. |
-volumes |
Optional. List of volume names to be exported. If not specified, all volumes in the specified recovery points will be exported. Values must be enclosed in double quotes, each separated by a space. do not use trailing slashes in volume names. For example, specify “C:” not “C:/” |
-rpn |
Optional. The sequential number of a recovery point to be exported. (You can use the Get-RecoveryPoints command to obtain recovery point numbers.
Note: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most recent recovery point will be exported. |
-time |
Optional. Determines recovery point to be selected for export. You need to specify exact time in the format “MM/DD/YYYY hh:mm tt” (for example: “04/24/2015 09:00 AM”).” Specify date time values of the time zone set on your local machine.
Note: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most recent recovery point will be exported. |
-vmname |
Windows name of the virtual machine. |
-gen2 |
Optional. Specify to use the second VM generation. If not specified, generation 1 is used. Rapid Recovery supports generation 2 from Windows Server 2012 R2 through Windows 8.1. |
-usevhdx |
Optional. If you specify this option, Rapid Recovery uses the VHDX disk format to create the VM. If you do not, it uses the VHD disk format. Generation 2 uses only the VHDX format. |
-uselocalmachine |
Optional. Connect the local Hyper-V server. If this parameter is used, the following options are ignored: hostname, host port, host username, host password. |
-hostname |
The virtual server host name. |
-hostport |
The virtual server port number. |
-hostusername |
The user name to the virtual server host. |
-hostpassword |
The password to the virtual server host. |
-vmlocation |
Local or network path to the folder where you want to store the virtual machine files. |
-ram |
Allocate specific amount of RAM on the virtual server. |
-usesourceram |
Optional. Allocate the same amount of RAM on the virtual server as the source protected machine. |
-exportvmconfigfiles |
Optional. Specify whether to export virtual machine configuration files. This option is available only both when the source is a virtual protected agentlessly and when the target hpyervisor is the same as the source hypervisor. |
Example:
Create a Hyper-V machine file to be stored on a remote machine:
>Start-HypervExport -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -vmlocation \\WIN7-Bobby\virtualmachines -hostname 10.10.10.23 -hostport 443 –hostusername root –hostpassword 12QWsdxc@# -ram 4096