Businesses often use long-term storage to archive both compliant and non-compliant data. The archive feature in Rapid Recovery is used to support the extended retention for compliant and non-compliant data. The administrator can save an archive on the local storage or network location by specifying the -Path
command and credentials.
Usage
The usage for the command is as follows:
Start-RestoreArchive -core [host name] -user [login] -password [password] -all | -protectedserver [name | IP address | "[name1 | IP address1]" "[name2 | IP address2]"] -repository [name] -archiveusername [name] -archivepassword [password] -path [location] -cloudaccountname [name] -cloudcontainer [name]
Command Options
The following table describes the options available for the Start-RestoreArchive
command:
Table 183: Start-RestoreArchive 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. |
-all |
Archive recovery points for all protected machines. |
-protectedserver |
The protected machine with recovery points that you want to archive. You can specify multiple machine names enclosed in double quotes and separated by commas. |
-repository |
The name of the repository where you want to place restored recovery points. You must enclose the name in double quotes; for example, "Repository1." |
-archiveusername |
Optional. The user name for logging in to the remote machine. It is required for a network path only. |
-archivepassword |
Optional. The password for logging in to the remote machine. It is required for a network path only. |
-path |
The path to where to save the archived data. For example:
- Local machine: "d:\work\archive"
- Network path: "\\servername\sharename"
- Folder in a cloud account: "Folder Name"
Note: The number of symbols should not be greater than 100 for local and network locations, and should not be greater than 150 for a cloud location. |
-cloudaccountname |
Optional. Use only for cloud archiving. The name of the cloud account where you want to save the archive. |
-cloudcontainer |
Optional. Use only for cloud archiving. The name of the cloud container in the chosen cloud account, where the archive will be saved. When you use this option, you should also specify the "-cloudaccountname" parameter. |
-manifestcore |
Optional. Specify the Core that you want to use from the manifest of the restored archive. |
Example:
Archive all recovery points for all machines on the Core and store them on the local machine:
>Start-RestoreArchive -path D:\work\archive -startdate 'Example 04/30/2012' –all
The Start-ScheduledArchive
PowerShell command lets you force a Rapid Recovery scheduled archive to begin on demand, regardless of the pre-established schedule.
Usage
The usage for the command is as follows:
Start-ScheduledArchive -core [host name] -user [login] -password [password] -all -ids [id | id1 id2]
Command Options
The following table describes the options available for the Start-ScheduledArchive
command:
Table 184: Start-ScheduledArchive 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. |
-all |
Force all scheduled archives. |
-id |
The identification number or space-separated identifiers of the scheduled archives that you want to force. |
Example:
Start multiple scheduled archive jobs:
>Start-ScheduledArchive -ids 799138c8-3dfc-4398-9711-1823733c2a31, 26c29bb7-b320-47f5-b5a8-dffc49f50e25
The start-VBExport
command initiates the launch of a virtual export from the selected recovery point to an Oracle VirtualBox server virtual machine.
Required parameters include the name of the protected machine containing recovery points to export; the name of the virtual machine you are exporting to; the amount of RAM to be allocated on the virtual machine; the host name and port of the Linux server host, and the path to the local, network, or Linux folder where the resulting virtual machine files will be stored.
Usage
The usage for the command is as follows:
Start-VBExport -core -user [user name] -password [password] -protectedserver [machine name] or [IP address]] -volumes [volume names] -rpn [number | numbers] |
-time [time string] -vmname [virtual machine name] [-ram [total megabytes] |
-usesourceram] -linuxhostname [linux hostname] -hostport [linux port] -targetpath [location] pathusername [user name] - pathpassword [password]
Command Options
The following table describes the options available for the Start-
VBExport
command:
Table 185: Start-VBExport 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 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. |
-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. |
-linuxhostname |
Linux VirtualBox server hostname. |
-hostport |
Linux VirtualBox server port. |
-targetpath |
Local or network or Linux path to the folder where the virtual machine files are to be stored. |
-pathusername |
User name for network machine. Only required when you specify network path in parameter -targetpath . |
-pathpassword |
Password for network machine. Only required when you specify network path in parameter -targetpath . |
-accountusername |
Optional. Use if you can specify a user account to register the exported virtual machine. For local or network machine only. |
-accountpassword |
Optional. Use only when you specify a user account to register the exported virtual machine using parameter -accountusername. For local or network machine only. |
Example:
Export all volumes from the latest recovery point on machine 10.10.12.97 to a VM called NewVirtualBoxVM:
>Start-VBExport -protectedserver 10.10.12.97 -vmname NewVirtualBoxVM -ram usesourceram -targetpath D:/exports
The Start-VirtualStandby
PowerShell command lets you force a Rapid Recovery a data export to a virtual standby machine. This on-demand export can occur outside of the regularly scheduled virtual standby exports.
Usage
The usage for the command is as follows:
Start-VirtualStandby -core [host name] -user [login] -password [password] -all | -protectedserver [name(s) | IP address]
Command Options
The following table describes the options available for the Start-VirtualStandby
command:
Table 186: Start-VirtualStandby 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. |
-all |
Force an export for all virtual standby machines. |
-protectedserver |
The name or names—separated by a comma and space—of the protected machines that you want to force to export. |
Example:
Force a virtual standby export for a protected machine:
>Start-VirtualStandby -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22