When running on the same machine on which Rapid Recovery Core is installed, the Rapid Recovery PowerShell module bases its display language on the language set for the Core. Localized Rapid Recovery versions such as this one support English, Chinese (Simplified), French, Korean, German, Japanese, Portuguese (Brazil), and Spanish.
If the
Rapid Recovery PowerShell module is installed on a separate machine, English is the only language supported.
The following table describes the qualifiers available for Rapid Recovery PowerShell Module.
Table 195: Rapid Recovery PowerShell module qualifiers
-core <Rapid Recovery Core Name> |
Host name of the Core.
Default: Localhost |
-ProtectedServer <Protected Server Name> |
Host name/IP address of the Rapid Recovery Agent.
Default: Localhost if multiple servers protected, otherwise the single server protected. |
-Mode <READ, READWRITE, WRITE> |
Recovery Point Mount mode.
Default: Read. |
-Volumes <Snapshot Volume Letter> |
Snapshot volume letter from Rapid Recovery Agent.
Default: All. |
-User <User Name> |
User name used to connect to the Rapid Recovery Core.
This is typically the service user. |
-Domain <Domain Name> |
Domain to which the user defined in /User belongs. |
-Password <Password> |
Password of the user defined in /User. |
-Path <Target path to mount, dismount recovery points or archive location> |
For example: C:\RapidRecoveryMount. |
Rapid Recovery enables administrators to automate the administration and management of resources at certain occurrences through the execution of commands and scripts. The Rapid Recovery software supports the use of PowerShell scripting for Windows and Bourne shell and Bash scripting for Linux.
Core jobs are automatically created whenever you initiate operations on the Rapid Recovery Core such as replication, virtual export, or a backup transfer. You can extend these jobs by running a script before it or after it. These are known as pre and post scripts.
This section describes the scripts that can be used by administrators at designated occurrences in Rapid Recovery for Windows and Linux.
Caution: The sample PowerShell and shell scripts provided in this document will function when run as designed by qualified administrators. Take precautions when modifying functioning scripts to retain working versions. Any modifications to the script samples included here, or any scripts you create, are considered customization, which is not typically covered by Quest Support.
Windows PowerShell is a Microsoft .NET Framework-connected environment designed for administrative automation. Rapid Recovery includes comprehensive client software development kits (SDKs) for PowerShell scripting that lets administrative users run user-provided PowerShell scripts at designated occurrences; for example, before or after a snapshot, attachability and mountability checks, and so on. Administrators can run scripts from both the Rapid Recovery Core and the protected machine. Scripts can accept parameters, and the output of a script is written to Core and protected machine log files.
Note: For nightly jobs, preserve one script file and the JobType input parameter to distinguish between nightly jobs.
Script files are located in the %ALLUSERSPROFILE%\AppRecovery\Scripts folder.
For more information on how using PowerShell scripts see Sample PowerShell scripts, Input Parameters for PowerShell Scripting, Input parameters for shell scripting, and Sample shell scripts.
Prerequisites for PowerShell scripting
Before running PowerShell scripts for Rapid Recovery, you must have Windows PowerShell 2.0 or later installed. Due to new features introduced in PowerShell 3.0, including easier access to object properties, PowerShell Web access, and support for REST calls, Quest recommends using PowerShell 3.0 or later.
Note: Place the powershell.exe.config file in the PowerShell home directory. For example, C:\WindowsPowerShell\powershell.exe.config.
powershell.exe.config
<?xml version="1.0"?>
<configuration>
<startup useLegacyV2RuntimeActivationPolicy="true">
<supportedRuntime version="v4.0.30319"/>
<supportedRuntime version="v2.0.50727"/>
</startup>
</configuration>
Testing PowerShell Scripts
If you want to test the scripts you plan to run, you can do so by using the PowerShell graphical editor, powershell_is. You also need to add the configuration file powershell_ise.exe.config to the same folder as the configuration file powershell.exe.config.
Note: The configuration file powershell_ise.exe.config must have the same content as the powershell.exe.config file.
Caution: If the pre-PowerShell or post-PowerShell script fails, the job also fails.
Localization
When running on the same machine on which Rapid Recovery Core is installed, the Rapid Recovery PowerShell module bases its display language on the language set for the Core. Localized Rapid Recovery versions such as this one support English, Chinese (Simplified), French, Korean, German, Japanese, Portuguese (Brazil), and Spanish.
If the Rapid Recovery PowerShell module is installed on a separate machine, English is the only language supported.
