Chat now with support
Chat with Support

Rapid Recovery 6.2.1 - Commands and Scripting Reference Guide

Introduction to Rapid Recovery Command Line Management utility PowerShell module
Prerequisites for using PowerShell Working with commands and cmdlets Rapid Recovery PowerShell module cmdlets
Add-EsxAutoProtectObjects Add-EsxVirtualMachines Add-HyperVClusterSharedVirtualDisks Add-HyperVClusterVirtualMachines Add-HyperVVirtualMachines Add-ManagementCertificates Disable-HyperVAutoProtection Edit-AzureVirtualStandby Edit-EsxiVirtualStandby Edit-HyperVVirtualStandby Edit-OracleDBVerifyNightlyJob Edit-OracleLogTruncationNightlyJob Edit-Replication Edit-ScheduledArchive Edit-VBVirtualStandby Edit-VMVirtualStandby Enable-HyperVAutoProtection Enable-OracleArchiveLogMode Get-ActiveJobs Get-CloudAccounts Get-Clusters Get-CompletedJobs Get-ExchangeMailStores Get-Failed Get-FailedJobs Get-HyperVClusterSharedVirtualDisks Get-ListAzureVMSizes Get-ManagementCertificates Get-Mounts Get-OracleInstances Get-Passed Get-ProtectedServers Get-ProtectionGroups Get-QueuedJobs Get-RecoveryPoints Get-ReplicatedServers Get-Repositories Get-ScheduledArchives Get-SqlDatabases Get-TieredRepositories Get-TransferQueueEntries Get-UnprotectedVolumes Get-Version Get-VirtualizedServers Get-Volumes New-AzureVirtualStandby New-Base New-BootCD New-CloudAccount New-EncryptionKey New-EsxiVirtualStandby New-FileSearch New-HyperVVirtualStandby New-Mount New-Replication New-Repository New-ScheduledArchive New-Snapshot New-TieredRepository New-VBVirtualStandby New-VMVirtualStandby Push-Replication Push-Rollup Remove-Agent Remove-EsxAutoProtectObjects Remove-HyperVClusterSharedVirtualDisks Remove-HyperVClusterVirtualMachines Remove-HyperVVirtualMachines Remove-ManagementCertificates Remove-Mount Remove-Mounts Remove-RecoveryPoints Remove-Replication Remove-Repository Remove-ScheduledArchive Remove-TieredRepository Remove-VirtualStandby Restart-CoreService Resume-Replication Resume-ScheduledArchive Resume-Snapshot Resume-VirtualStandby Resume-VMExport Set-AgentMetadataCredentials Set-DedupCacheConfiguration Set-License Set-OracleMetadataCredentials Set-ReplicationResponse Start-Archive Start-AttachabilityCheck Start-AzureDeploy Start-AzureExport Start-ChecksumCheck Start-ConsumeSeedDrive Start-CopySeedDrive Start-EsxiExport Start-HypervExport Start-LogTruncation Start-MountabilityCheck Start-OptimizationJob Start-OracleDBVerifyJob Start-OracleLogTruncationJob Start-Protect Start-ProtectCluster Start-ProtectEsxServer Start-ProtectHyperVCluster Start-ProtectHyperVServer Start-RepositoryCheck Start-RestoreAgent Start-RestoreArchive Start-RestoreUrc Start-ScheduledArchive Start-TieredRepositoryCheck Start-VBExport Start-VirtualStandby Start-VMExport Stop-ActiveJobs Stop-CoreService Suspend-Replication Suspend-RepositoryActivity Suspend-ScheduledArchive Suspend-Scheduler Suspend-Snapshot Suspend-VirtualStandby Suspend-VMExport Update-Repository
Localization Qualifiers

Introduction to Rapid Recovery

Rapid Recovery is a backup, replication, and recovery solution that offers near-zero recovery time objectives and recovery point objectives. Rapid Recovery offers data protection, disaster recovery, data migration and data management. You have the flexibility of performing bare-metal restore (to similar or dissimilar hardware), and you can restore backups to physical or virtual machines, regardless of origin. Rapid Recovery can also archive to the cloud, to a DL series backup and recovery appliance, or to a supported system of your choice. With Rapid Recovery, you can replicate to one or more targets for added redundancy and security.

Rapid Recovery offers:

Flexibility. You can perform universal recovery to multiple platforms, including restoring from physical to virtual, virtual to physical, virtual to virtual, and physical to physical.
Cloud integration. You can export a VM, archive and replicate to the cloud, and perform bare metal restore from archives in the cloud. Compatible cloud services include Microsoft Azure, Amazon Web Services (AWS), any OpenStack-based provider (including Rackspace), and Google Cloud. US government-specific platforms include AWS GovCloud (US) and Azure Government.
Intelligent deduplication. You can reduce storage requirements by storing data once, and referencing it thereafter (once per repository or encryption domain).
Instant recovery. Our Live Recovery feature allows you to access critical data first, while remaining restore operations complete in parallel.
File-level recovery. You can recover data at the file level on-premises, from a remote location, or from the cloud.
File-level search. Using criteria you specify, you can search a range of recovery points for one or more files. From the search results, you can then select and restore the files you want to the local Core machine directly from the Core Console.
Virtual support. Rapid Recovery supports one-time virtual export, letting you generate a bootable VM from a recovery point; and virtual standby, in which the bootable VM you generate is continually updated after each backup. You can even perform virtual export to Microsoft Hyper-V cluster-shared volumes.
Rapid Snap for Virtual support. Enhanced support for virtualization includes agentless protection for vCenter/ESXi VMs and for Hyper-V VMs. Rapid Snap for Virtual includes protection and autodiscovery for VMware ESXi 5.5 and higher with no agent software installed. Host-based protection supports installing Rapid Recovery Agent on a Microsoft Hyper-V host only, letting you agentlessly protect all its guest VMs.
Application support. Rapid Recovery Agent is built with application support for Microsoft Exchange, SQL Server, and Oracle. When you protect these application servers in your Core, the backup snapshots are automatically application-aware; open transactions and rolling transaction logs are completed and caches are flushed to disk before creating snapshots. Specific application features are supported, including SQL attachability (for SQL Server) and database integrity DBVERIFY checks (for Oracle). Application awareness also extends to agentless protection for SQL Server and Exchange Server.

See the following resources for more information about Rapid Recovery.

The Rapid Recovery product support website at

Command Line Management utility

Rapid Recovery consists of several software components. Key components relevant to this topic include the following:

The Rapid Recovery Core manages authentication for protected machines, schedules for transferring data for backup and replication, export to virtual machines, reporting, and bare metal restore (BMR) to similar or dissimilar hardware.
The Rapid Recovery Agent is responsible for volume snapshots and fast transfer of the data to the repository managed by the Core.
The Rapid Recovery Command Line Management utility, cmdutil.exe, provides third-party access to manage system functionality. This tool permits scripting of the Rapid Recovery Core management functions.

Figure 1. Rapid Recovery Command Line Management provides command-line functions

Rapid Recovery Command Line Management is a Windows command line utility that lets users interact with the Rapid Recovery Core server. It offers some of the same functions that the Rapid Recovery Core Console graphic user interface provides. For example, Rapid Recovery Command Line Management utility can mount recovery points or force a snapshot.

The Rapid Recovery Command Line Management utility is embedded in every installation of the Rapid Recovery Core. To open the Command Line Management utility for a default installation, navigate to the path C:\Program Files\AppRecovery\Core\CoreService\, and double-click the cmdutil.exe file.

In Command Line mode, action flags can be passed to the Rapid Recovery Command Line Management utility through a selection of command options and qualifiers to perform limited management functions.


This section describes the commands and options available for the Rapid Recovery Command Line Management utility.


There may be times when you need to change the license applied to a machine, such as when moving from a trial license to a subscription or perpetual license. In such instances, you can change the license in the Command Prompt by using the applylicense command.


The usage for the command is as follows:

Command Options

The following table describes the options available for the applylicense command:

Table 1. ApplyLicense command options



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 must also provide a password. If none is provided, then the credentials for the logged-on user are used.

Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a user name. If none is provided, then the credentials for the logged-on user are used.

Optional. A 30-character key comprising six groups of five alphanumeric characters, each separate by a hyphen. Use this key when a license file is not available.

Optional. The path to the file that ends with the .lic extension. If a license file is available, you can use this option instead of the -licensekey.

Optional. You may have received this nine-digit license number in an order confirmation email. If you provide this number, use the email address that received it for verification.

Optional. If you use the -licensenumber, you must include the email address that received it for verification.


Change the license key associated with this Core to JL09F-89FSD-6THFS-DSE34-KS3D5-65DF2:

Change the license key associated with this Core to the key contained in the license file:

Change the license number associated with this Core to 111-111-111 using to verify the license:

Self Service Tools
Knowledge Base
Notifications & Alerts
Product Support
Software Downloads
Technical Documentation
User Forums
Video Tutorials
RSS Feed
Contact Us
Licensing Assistance
Technical Support
View All
Related Documents