Rapid Recovery 6.3 - Command Line and Scripting Reference Guide

Rapid Recovery overview and system requirements Command Line Management Utility PowerShell Module
Prerequisites for using PowerShell Working with commands and cmdlets Rapid Recovery PowerShell module cmdlets
Add-CredentialsVaultAccount AddEncryptionKeytoProtectedMachine Add-EsxAutoProtectObjects Add-EsxVirtualMachines Add-HyperVClusterSharedVirtualDisks Add-HyperVClusterVirtualMachines Add-HyperVVirtualMachines Disable-HyperVAutoProtection Edit-ActiveBlockMapping Edit-AzureVirtualStandby Edit-EsxiVirtualStandby Edit-EsxServerProtectionRules Edit-ExcludedFilesAndFolders Edit-HyperVClusterProtectionRules Edit-HyperVServerProtectionRules 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-CredentialsVaultAccounts Get-ExchangeMailStores Get-Failed Get-FailedJobs Get-HyperVClusterSharedVirtualDisks Get-ListAzureVMSizes Get-Mounts Get-OracleInstanceMetadata Get-OracleInstances Get-Passed Get-ProtectedServers Get-ProtectionGroups Get-ProtectionRules Get-QueuedJobs Get-RecoveryPoints Get-ReplicatedServers Get-Repositories Get-ScheduledArchives Get-SqlDatabases Get-TransferQueueEntries Get-UnprotectedVolumes Get-Version Get-VirtualizedServers Get-Volumes Join-CredentialsVaultAccount 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-VBVirtualStandby New-VMVirtualStandby Open-DvmRepository Push-Replication Push-Rollup Remove-Agent Remove-CredentialsVaultAccount Remove-EncryptionKey Remove-EsxAutoProtectObjects Remove-EsxVirtualMachines Remove-HyperVClusterSharedVirtualDisks Remove-HyperVClusterVirtualMachines Remove-HyperVVirtualMachines Remove-Mount Remove-Mounts Remove-RecoveryPoints Remove-Replication Remove-Repository Remove-ScheduledArchive Remove-VirtualStandby Restart-CoreService Resume-Replication Resume-ScheduledArchive Resume-Scheduler Resume-Snapshot Resume-VirtualStandby Set-AgentMetadataCredentials Set-CredentialsVaultAccount Set-DedupCacheConfiguration Set-License Set-OracleMetadataCredentials Set-ReplicationResponse Start-Archive Start-AttachabilityCheck Start-AzureDeploy Start-AzureExport Start-BackupSettings Start-ChecksumCheck Start-ConfigureAgentMigration 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-RestoreSettings Start-RestoreUrc Start-ScheduledArchive Start-VBExport Start-VirtualStandby Start-VMExport Stop-ActiveJobs Stop-CoreService Suspend-Replication Suspend-ScheduledArchive Suspend-Scheduler Suspend-Snapshot Suspend-VirtualStandby Update-Repository
Localization Qualifiers
Scripting

Rapid Recovery overview and system requirements

This section contains an introduction to Rapid Recovery and where you can find its system requirements.

This section includes the following topics:

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 (VMs), regardless of origin. Rapid Recovery lets you create backup archives to a wide range of supported systems including archiving to the cloud. 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).
  • Live Recovery. With our Live Recovery feature, you have instant access to critical data first, while remaining restore operations complete in parallel. You can use Live Recovery to restore data from a recovery point of any non-system volume of a Windows machine, physical or virtual. The machine must be protected by Rapid Recovery Agent. Live Recovery is not supported for agentlessly protected machines, Linux machines, or cluster-shared volumes.
  • 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 Rapid Recovery Core Console.
  • Virtual machine export. Rapid Recovery supports one-time virtual export, letting you generate a VM from a recovery point; and virtual standby, in which the VM you generate is continually updated after each backup. Compatible VM hypervisors include vCenter/ESXi, VMware Workstation, Hyper-V, VirtualBox, and Azure. 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 software agent installed. Host-based protection supports installing Rapid Recovery Agenton a Microsoft Hyper-V host only, letting you agentlessly protect all its guest VMs.
  • Application support. Rapid Recovery is built with application support. When you protect SQL Server or Microsoft Exchange machines (whether using Rapid Recovery Agent or agentless protection), the backup snapshots captured 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 checks (for SQL Server) and database checksum and mountability checks (for Exchange Server). If you protect Oracle 12c servers with Rapid Recovery Agent, you can also perform DBVERIFY database integrity checks.

See the following resources for more information about Rapid Recovery.

Where to find Rapid Recovery system requirements

For every software release, Quest reviews and updates the system requirements for Rapid Recovery software and related components. This information is exclusively available in the release-specific Rapid Recovery System Requirements Guide. Use that document as your single authoritative source for system requirements for each release.

You can find system requirements and all other documentation at the technical documentation website at https://support.quest.com/rapid-recovery/technical-documents/.

NOTE: The default view of the technical documentation website shows documentation for the most recent generally available version of the Rapid Recovery software. Using the filters at the top of the page, you can view documentation for a different software release, or filter the view by document type.

About this document

Administrators often use command line interfaces (CLIs) and scripting to extend the functionality of an application.

Rapid Recovery ships with two CLI modules that allow users to invoke application commands and functionality at the command line instead of using the Rapid Recovery Core Console graphic user interface (GUI). Quest also provides a small collection of useful sample PowerShell scripts.

CLI modules

The Rapid Recovery Command Line Management utility, cmdutil.exe, is a CLI created for use with Rapid Recovery. Using the commands described in this document as a guide, administrators have third-party access to manage Rapid Recovery Core system functions. Long-time users may refer to this tool as aacmd.

The Rapid Recovery PowerShell module is a Windows utility that lets users interact with the Core server by using Windows PowerShell® scripts. Using the commands described in this document, administrators can access at the command line much of the functionality offered by the Rapid Recovery Core Console.

Scripting

Administrators can run scripts from both the Rapid Recovery Core and from a protected machine. Scripts can accept parameters, and the output of a script is written to Core and protected machine log files.

While customized scripts are not supported by Quest Data Protection Support, knowedgeable users can use the sample PowerShell scripts or customize their own scripts to run at designated occurrences; for example, before or after a snapshot, before or after attachability and mountability checks, and so on. (Because the scripts run before or after a specific Rapid Recovery process, they are referred to as pre- and post- scripts.)

The Scripting section of this document includes information such as the location of sample PowerShell pre- and post scripts, suggestions for testing scripts, and qualifiers available for use in all PowerShell scripts.

Input parameters for sample scripts are listed, as are the names and full code for each sample script.

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