Rapid Recovery 6.1.3 - User Guide

Launching PowerShell and importing the module

Unlike other system modules, the Rapid Recovery PowerShell Module is not loaded by default. For each session, you can open Windows PowerShell with administrative privileges, and then import the module. Complete the steps in this procedure to launch PowerShell and import the Rapid Recovery PowerShell Module.

Windows PowerShell opens in a new command window.

The Rapid Recovery PowerShell module is imported for your current session. You can begin to run cmdlets in the existing command window.

Working with commands and cmdlets

Cmdlets are specialized commands in a Windows PowerShell script that perform a single function. A cmdlet is typically expressed as a verb-noun pair. The result returned by a cmdlet is an object.

You can pipeline PowerShell commands, which enables the output of one cmdlet to be piped as input to another cmdlet. As a simple example, you can request the list of commands in the Rapid Recovery PowerShell module, and sort that list by name. The example script for this is:

Getting cmdlet help and examples

After you open PowerShell and import the Rapid Recovery PowerShell module, you can request additional information at any time by using the Get-Help <command_name> cmdlet. For example, to get information about the virtual machine export cmdlet, enter the following cmdlet and then press Enter:

The object returned includes the command name, synopsis, syntax, and any options you can use with the command.

Another method to get help for a specific cmdlet is to type the command name followed by -?. For example:

You can also request examples for a cmdlet by executing the following command:

Rapid Recovery PowerShell module cmdlets

This section describes the cmdlets and options available in the Rapid Recovery PowerShell Module. All cmdlets in the Rapid Recovery PowerShell Module support the following common parameters:

For more information, use Get-Help about_commonparameters.

The available cmdlets are listed in the following table.

Edit-EsxiVirtualStandby

The Edit-EsxiVirtualStandby command lets you use PowerShell to make changes to an existing virtual export to an ESXi virtual machine (VM).

Usage

The usage for the command is as follows:

Command Options

The following table describes the options available for the Edit-EsxiVirtualStandby command:

Example:

Lists all active jobs on the local Core: