Chat now with support
Chat with Support

Rapid Recovery 6.1.2 - User Guide

Introduction to Rapid Recovery Core Console Core settings Repositories Encryption keys Protecting machines
About protecting machines with Rapid Recovery Support for dynamic and basic volumes Understanding the Rapid Recovery Agent software installer Deploying Agent to multiple machines simultaneously from the Core Console Using the Deploy Agent Software Wizard to deploy to one or more machines Modifying deploy settings Understanding protection schedules Protecting a machine About protecting multiple machines Settings and functions for protected Exchange servers Settings and functions for protected SQL servers
Managing protected machines Snapshots and recovery points Replication Events Reporting VM export Restoring data Bare metal restore
Bare metal restore for Windows machines Understanding boot CD creation for Windows machines Using the Universal Recovery Console for a BMR Performing a bare metal restore for Linux machines Viewing the recovery progress Starting a restored target server Troubleshooting connections to the Universal Recovery Console Repairing boot problems Performing a file system check on the restored volume
Managing aging data Archiving Cloud storage accounts The Local Mount Utility The Central Management Console Core Console references Command Line Management utility PowerShell module
Prerequisites for using PowerShell Working with commands and cmdlets Rapid Recovery PowerShell module cmdlets Localization Qualifiers
Scripting REST APIs About us Glossary

Qualifiers

The following table describes the qualifiers available for Rapid Recovery PowerShell Module.

Table 301. Rapid Recovery PowerShell module qualifiers

Qualifier

Usage

-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.

Scripting

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.

Using PowerShell scripting with Rapid Recovery

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.

Script files are located in the %ALLUSERSPROFILE%\AppRecovery\Scripts folder.

In Windows 2003, the path to locate the folder is: Documents and Settings\All Users\Application Data\.

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.

powershell.exe.config

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.

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.

Qualifiers

The following table describes the qualifiers available for Rapid Recovery PowerShell Module.

Table 302. Rapid Recovery PowerShell module qualifiers

Qualifier

Usage

-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.

Related Documents