The New-EncryptionKey command lets you create a new encryption key for securing your Rapid Recovery backed up data.
Usage
The usage for the command is as follows:
New-EncryptionKey -core [host name] -user [login] -password [password] -name [encryption key name] -passphrase [pas
sphrase] -comment [comment]
Command Options
The following table describes the options available for the New-EncryptionKey command:
Table 123: New-EncryptionKey command options
-? |
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 log on.
If none are provided, then the logged-on user's credentials will be used. |
-name |
The name of the encryption key that you want to create. |
-passphrase |
The passphrase to the encryption key that you want to create. |
-comment |
Optional. The description of the encryption key. |
Example:
Create an encryption key on the local Core:
>New-EncryptionKey –name EncryptionKey1 -passphrase 123456
The New-EsxiVirtualStandby PowerShell command lets you create a new ESXi virtual standby machine using Rapid Recovery.
Usage
The usage for the command is as follows:
New-EsxiVirtualStandby -core [host name] -user [login] -password [password] -protectedserver [name | IP address] -volumes [volumes names] -vmname [virtual machine name] -hostname [virtual host name] -hostport [virtual host port number] -hostusername [virtual host login] -hostpassword [virtual host password] [-ram [total megabytes] | -usesourceram] -diskprovisioning [thin | thick] -diskmapping [automatic | manual | withvm] -initialexport
Command Options
The following table describes the options available for the New-EsxiVirtualStandby command:
Table 124: New-EsxiVirtualStandby command options
-? |
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 log on.
If none are provided, then the logged-on user's credentials will be used. |
-protectedserver |
Show jobs for a specific protected machine, indicated by IP address. |
-volumes |
Optional. List the volume names you want to export. If not specified, all volumes in the recovery point(s) are exported. Values must be enclosed in double quotes and separated by space; for example, "c:", "d:".
Note: Do not use trailing slashes in volume names. |
-vmname |
The Microsoft Windows name of the virtual machine. |
-hostname |
The name of the virtual server host. |
-hostport |
The port number to use for communicating with the virtual server. |
-hostusername |
The user name for logging in to the virtual server host. |
-hostpassword |
The password for logging in to the virtual server host. |
-ram |
Allocate a specific amount of RAM on the virtual server. |
-usesourceram |
Optional. Allocate the same amount of RAM on the virtual server that the source protected machine has. |
-diskprovisioning |
Optional. The amount of disk space to allocate on the virtual machine. Available values include:
- Thick - Specify 'thick' to make the virtual disk as large as the original drive on the protected server.
- Thin - Specify 'thin' to allocate the amount of actual disk space occupied on the original drive plus some additional megabytes.
The default disk provisioning is 'thin'. |
-diskmappinjg |
Optional. It determines how to map the disks from the recovery point to the virtual machine. Available values include:
The default setting is 'auto'. |
-initialexport |
Optional. Specify this option if you need to start an initial on-demand virtual machine export after configuring the virtual standby. |
Example:
Create a new ESXi virtual standby:
>New-EsxiVirtualStandby -protectedserver 10.10.10.4 -vmname ExportedMachine -hostname 10.10.10.127 -hostport 443 -hostusername root -hostpassword pass123 -usesourceram -diskprovisioning thin -diskmapping auto
The New-FileSearch command lets you search for a specific file among the recovery points in a repository, which helps you determine which recovery point you need to mount for a restore.
Usage
The usage for the command is as follows:
New-FileSearch -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -startdate [start date] -enddate [end date] -filemasks [file masks] -paths [paths] -subdiroff -ntfsfastoff -limitsearch [limit search]
Command Options
The following table describes the options available for the New-FileSearch command:
Table 125: New-FileSearch command options
-? |
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. The user name for the remote Core host machine. If you specify a user name, you must also provide a password. If none is provided, then the credentials for the logged-on user are used. |
-password |
Optional. The password to the remote Core host machine. If you specify a password, you also have to provide a user name. If none is provided, then the credentials for the logged-on user are used. |
-protectedserver |
Use this option to specify the protected machine for which you want to enable the Oracle archive log mode. |
-startdate |
The earliest date of a period within you want to conduct your search. Use the date pattern "MM/DD/YYYY HH:mm:ss AM." |
-enddate |
The latest date of a period within you want to conduct your search. Use the date pattern "MM/DD/YYYY HH:mm:ss AM." |
-filemasks |
A combination of fixed and wildcard characters to search for the file. It can be one string or an array of strings. All masks should be separated by a space; for example: -filemasks "first" "second." |
-paths |
Optional. If there are specific directories in which you want to search, use this option to list the paths. It can be one string or an array of strings. All directories should be separated by a space; for example: -paths "E:\" "C:\Program Files." |
-subdiroff |
Optional. By default, the file search is performed in subdirectories. Use this option if you want to turn this feature off and not search in subdirectories. |
-ntfsfastoff |
Optional. By default, the file search is performed using the NTFS fast algorithm. If you want to perform the search without this feature, specify this option. |
-limitsearch |
Optional. Use this option to limit the number of search results. The default value is 1000. |
Examples:
Perform a file search with one file mask:
New-FileSearch -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.10.10 -filemasks "sample"
Perform a file search with multiple file masks in specified directories and without the NTFS fast algorithm:
New-FileSearch -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.10.10 -filemasks "sample" "second" -paths "C:\dir" -ntfsfastoff
The New-HyperVVirtualStandby PowerShell command lets you create a new Hyper-V virtual machine (VM) using Rapid Recovery.
Usage
The usage for the command is as follows:
New-HyperVVirtualStandby -core [host name] -user [login] -password [password] -protectedserver [name | IP address]
-volumes [volumes names] -vmname [virtual machine name] [-gen2] -useVhdx [-uselocalmachine] | -hostname [virtual ho
st name] -hostport [virtual host port number] -hostusername [virtual host login] -hostpassword [virtual host passwo
rd]] -vmlocation [location] [-ram [total megabytes] | -usesourceram] -initialexport -exportvmconfigfiles
Command Options
The following table describes the options available for the New-HyperVVirtualStandby command:
Table 126: New-HyperVVirtualStandby command options
-? |
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 log on.
If none are provided, then the logged-on user's credentials will be used. |
-protectedserver |
Show jobs for a specific protected machine, indicated by IP address. |
-volumes |
Optional. List the volume names you want to export. If not specified, all volumes in the recovery point(s) are exported. Values must be enclosed in double quotes and separated by space; for example, "c:", "d:".
Note: Do not use trailing slashes in volume names. |
-vmname |
The Microsoft 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 to the local Hyper-V server. When you specify this value, Rapid Recovery ignores the following options:
- hostname
- hostport
- hostusername
- hostpassword
|
-hostname |
The name of the virtual server host. |
-hostport |
The port number to use for communicating with the virtual server. |
-hostusername |
The user name for logging in to the virtual server host. |
-hostpassword |
The password for logging in to the virtual server host. |
-vmlocation |
Local or network path to the folder where you want to store the virtual machine files. |
-ram |
Allocate a specific amount of RAM on the virtual server. |
-usesourceram |
Optional. Allocate the same amount of RAM on the virtual server that the source protected machine has. |
-initialexport |
Optional. Specify this option if you need to start an initial on-demand virtual machine export after configuring the virtual standby. |
-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 new Hyper-V virtual standby machine:
>New-HyperVVirtualStandby -core [host name] -user [login] -password [password] -protectedserver [name | IP address]
-volumes [volumes names] -vmname [virtual machine name] [-gen2] -useVhdx [-uselocalmachine] | -hostname [virtual ho
st name] -hostport [virtual host port number] -hostusername [virtual host login] -hostpassword [virtual host passwo
rd]] -vmlocation [location] [-ram [total megabytes] | -usesourceram] -initialexport
