Chat now with support
Chat with Support

Welcome, ApexSQL customers to Quest Support Portal click here for for frequently asked questions regarding servicing your supported assets.

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

ForceVirtualStandby

Exporting data from a protected machine to a virtual machine creates a virtual standby machine. If you have continuous virtual export set up, you can use this command to force Rapid Recovery to export data on demand, regardless of the predetermined schedule.

Usage

The usage for the command is as follows:

/forcevirtualstandby -core [host name] -user [user name] -password [password login] -protectedserver [name] | -all
Command Options

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

Table 38: ForceVirtualStandby command options
Option Description
-?
Display this help message.
-core
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.
-user
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.
-password
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.
-protectedserver
The name or space-separated names of virtualized machines.
-all
This command specifies whether to force all scheduled virtual exports.
Examples:

Force all virtual standby exports:

>cmdutil /forcevirtualstandby -all

Force virtual standby for two machines:

>cmdutil /forcevirtualstandby -protectedserver 10.10.35.48 10.10.35.69

GetOracleInstanceMetadata

The getoracleinstancemetadata command lets you retrieve the detailed metadata for a specified Oracle instance.

Usage

The usage for the command is as follows:

/getoracleinstancemetadata -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -instancename [Oracle instance SID]
Command Options

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

Table 39: GetOracleInstanceMetadata command options
Option Description
-?
Display this help message.
-core
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.
-user
Optional. The 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.
-password
Optional. The 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.
-protectedserver
The name or IP address of the protected machine.
-instancename
The Oracle SID from which you want to fetch metadata.
Example:

Get detailed metadata for the named Oracle instance. If no metadata credentials are set, then only summary metadata displays:

>cmdutil /getoracleinstancemetadata -core 10.10.127.42 -user admin -password -676df#df -protectedserver 10.10.34.88 -instancename ORCL

Help

The help command displays a list of the available commands and their definitions. It also provides copyright and version details.

Usage

The usage for the command is as follows:

/help
Example:

Request Command Line help:

>cmdutil /help

List

The list command returns information about all recovery points, active jobs, completed jobs, failed jobs, invalid (failed) recovery points, valid (passed) recovery points, mounts, protected servers, volumes, virtualized servers, unprotected volumes, clusters, protection groups, SQL databases, Exchange databases, replicated servers, and repositories for the specified agent or list of servers currently protected by the Core. The most recent records return by default. You can list all records or specify how many records display by using a number parameter. This parameter should contain the letter "l" for the latest recovery points and "f" for the first recovery point. Each recovery point has its own number, which the administrator can use for mounting.

Usage

The usage for the command is as follows:

/list [rps | passed | failed | mounts | volumes | protectedservers | activejobs | completed jobs | failedjobs | virtualizedservers | unprotectedvolumes | clusters | protectiongroups | sqldatabases | exchangemailstores | replicatedservers | repositories] -protectedserver [name | IP address] -core [host name] -user [user name] -password [password] –number [all | l<number> | f<number> | <number>] -jobtype
Command Options

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

Table 40: List command options
Option Description
-?
Display this help message.
-list
Select one of the following options:
  • all recovery points ('rps')
  • valid recovery points ('passed')
  • invalid recovery points ('failed')
  • mounts ('mounts')
  • protected volumes ('volumes')
  • unprotected volumes ('unprotectedvolumes')
  • protected machines ('protectedservers')
  • active jobs ('activejobs')
  • failed jobs ('failedjobs')
  • completed jobs ('completedjobs')
  • virtualized servers ('virtualizedservers')
  • clusters ('clusters')
  • protection groups ('protectiongroups')
  • SQL Server databases ('sqldatabases')
  • MS Exchange databases ('exchangemailstores')
  • replicated servers ('replicatedservers')
  • repositories (‘repositories’)
-core
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.
-user
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.
-password
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.
-all
For show jobs only. Display al events of a specific type (active/failed/completed) on the core server.
-protectedserver
Protected machine with recovery points to display.
-number
Optional. Number of data items to display. Use only with the following specifiers: 'rps', 'activejobs', 'completedjobs', 'failedjobs'. Available values are:
  • all (fetch all data items)
  • l[number] or [number] (fetches top ## data items)
  • f[number] (fetches first ## data items)

    Only takes effect when displaying recovery points and jobs.

-jobtype
Optional. Filter output by job type. Available values include:
  • '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)
  • 'restore' (recovery point restores)
  • 'rollup' (protected machine rollups)
  • 'sqlattach' (agent attachability checks)
  • 'mount' (mount repository)
Examples:

List the 30 most recent recovery points:

>cmdutil /list rps -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -number l30

View all failed data transfer jobs performed by a protected machine:

>cmdutil /list failed jobs -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -number all -jobtype transfer
Related Documents