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

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

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.

Table 228. Cmdlets in the Rapid Recovery PowerShell Module

Cmdlet name

Description

Edit-EsxiVirtualStandby

Edit an existing ESXi virtual standby configuration.

Edit-HyperVVirtualStandby

Edit an existing Hyper-V virtual standby configuration.

Edit-VBVirtualStandby

Edit an existing VirtualBox virtual standby configuration.

Edit-VMVirtualStandby

Edit an existing VMware Workstation virtual standby configuration.

Edit-ScheduledArchive

Edit an existing scheduled archive configuration.

Get-ActiveJobs

Retrieve a collection of active jobs.

Get-CloudAccounts

Get information about the cloud accounts saved to the Core.

Get-Clusters

Retrieve a collection of protected clusters.

Get-CompletedJobs

Retrieve a collection of completed jobs.

Get-ExchangeMailStores

Retrieve a collection of Exchange mail stores.

Get-Failed

Get information about failed recovery points.

Get-FailedJobs

Retrieve a collection of failed jobs.

Get-Mounts

Show all mounted recovery points.

Get-Passed

Get information about passed recovery points.

Get-ProtectedServers

Get information about protected servers.

Get-ProtectionGroups

Retrieve a collection of protection groups.

Get-QueuedJobs

Retrieve a collection of jobs waiting in the queue.

Get-RecoveryPoints

Get information about recovery points.

Get-ReplicatedServers

Get information about replicated servers.

Get-Repositories

Get information about repositories.

Get-ScheduledArchive

Get information about recurring archive jobs.

Get-SqlDatabases

Retrieve a collection of SQL databases.

Get-UnprotectedVolumes

Retrieve a collection of unprotected volumes.

Get-VirtualizedServers

Get information about virtualized servers.

Get-Volumes

Get information about volumes.

New-Base

Force base image snapshot.

New-CloudAccount

Add a new cloud account to the Core.

New-EncryptionKey

Create a new encryption key.

New-EsxiVirtualStandby

Create a new ESXi virtual standby virtual machine.

New-HyperVVirtualStandby

Create a new Hyper-V virtual standby virtual machine.

New-Mount

Mount recovery points.

New-Replication

Set up and force replication.

New-Repository

Create new DVM repository.

New-ScheduledArchive

Schedule a new recurring archive.

New-Snapshot

Force snapshot.

New-VBVirtualStandby

Create a new VirtualBox virtual standby virtual machine.

New-VMVirtualStandby

Create a new VMware Workstation virtual standby virtual machine.

Push-Replication

Force replication.

Push-Rollup

Force rollup.

Remove-Agent

Remove a machine from protection.

Remove-Mount

Dismount recovery point.

Remove-Mounts

Dismount all mounted recovery points.

Remove-RecoveryPoints

Delete recovery points for a protected machine.

Remove-Repository

Delete an existing DVM repository.

Remove-ScheduledArchive

Discontinue a scheduled archive.

Remove-VirtualStandby

Remove a virtual standby virtual machine from the Core.

Resume-Replication

Resume replication.

Resume-RepositoryActivity

Resume repository activity.

Resume-ScheduledArchive

Resume a scheduled archive.

Resume-Snapshot

Resume snapshot.

Resume-VirtualStandby

Resume exporting data to a virtual standby virtual machine.

Start-Archive

Archive recovery points.

Start-AttachabilityCheck

Force attachability check for protected MS SQL databases.

Start-ChecksumCheck

Force a checksum check for protected Exchange mail stores.

Start-EsxiExport

Force export to an ESXi server.

Start-HypervExport

Force export to a Hyper-V server.

Start-LogTruncation

Force log truncation.

Start-MountabilityCheck

Force mountability check for protected Exchange mail stores.

Start-Protect

Put a server under protection.

Start-ProtectCluster

Put a cluster under protection.

Start-RepositoryCheck

Force a DVM repository check.

Start-RestoreArchive

Restore archive with recovery points.

Start-ScheduledArchive

Force a data transfer for a scheduled archive.

Start-VBExport

Force export to a VirtualBox server.

Start-VirtualStandby

Force a data transfer to an existing virtual standby virtual machine.

Start-VMExport

Force export to a VMWare Workstation server.

Stop-ActiveJobs

Cancel active jobs.

Suspend-Replication

Pause replication.

Suspend-RepositoryActivity

Pause activity for a repository.

Suspend-ScheduledArchive

Pause data transfers for a scheduled archive.

Suspend-Snapshot

Pause snapshot.

Suspend-VirtualStandby

Pause data transfers to a virtual standby virtual machine.

Update-Repository

Add extent to DVM repository.

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:

Table 229. Edit-EsxiVirtualStandby command options

Option

Description

Display this help message.

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.

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.

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.

Show jobs for a specific protected machine, indicated by IP address.

Show all jobs, including those performed by the Core and all protected servers.

Optional. Determine how many records to display. available values are:

all (display all jobs); l[number] or [number] (fetches ## most recent jobs sorted by execution and time); f[number] (displays first ## recovery jobs sorted by execution and time). By default, the 20 most recent jobs are shown.

Optional. Specifies the job type filter. Available values are: 'transfer' (data transfer), 'repository' (repository maintenance), 'replication' (local and remote replications), 'backup' (backup and restore), 'bootcdbuilder' (create boot CDs), 'diagnostics' (upload logs), 'exchange' (Exchange Server files check), 'export' (recovery point export), 'pushinstall' (deploy agents), 'rollback' (restoring from a recovery point), 'rollup' (recovery point rollups), 'sqlattach' (agent attachability checks), and 'mount' (mount repository). By default, all jobs of the specified type are returned.

Optional. Filter output by date and time for the job started. Available types of input include:

#d or DD (where # is a number for the period of time of days before now until now)

#h or #H (where # is number for the period of hours before now until now)

“time date 1”, “time date 2” (to show a custom range of time from a specific date appearing before the comma to a specific date following the comma).

Example:

Lists all active jobs on the local Core:

Related Documents