Chat now with support
Chat with Support

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

RestartCoreService

If the Core service on the Core machine is stopped, use the restartcoreservice command to start it again.

Usage

The usage for the command is as follows: 

/restartcoreservice -core [host name] -user [user name] -password [password] -cancelactivejobs [true | false] -wait [time in seconds]
Command Options

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

Table 61: RestartCoreService 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. 
-cancelactivejobs
 Optional. Use this option to cancel all active jobs on the Core. The default setting is "false." 
-wait
 Optional. This option indicates that the command should wait until the Core service is fully restarted for the specified period of time in seconds before canceling active jobs.
Example:

Restart the Core service: 

>cmdutil /restartcoreservice -core 10.10.127.42 -user admin -password 676df#df -cancelactivejobs true -wait 600

RestoreAgent

The restoreagent command lets you restore a protected machine or volume from a specific Rapid Recovery recovery point.

Usage

The usage for the command is as follows: 

/restoreagent -protectedserver [name | IP address] -rpn [recovery point number] -volumes [IDs | names | all] -targetmachine [name] -targetvolume [volume name] -forcedismount -autorestart
Command Options

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

Table 62: RestoreAgent 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 IP address of the server you want to restore. 
-rpn
 The identification number of the recovery point you want to use to restore the machine. To find the correct number, use the command /list rps. 
-volumes
 The IDs or names of the volumes you want to restore. To restore all protected volumes, use -volumes all. 
-targetmacchine
 The name of the machine to which you want to restore the protected machine. 
-targetvolume
 The name or ID of the volume to which you want to restore the machine. 
-forcedismount
 Optional. Use this option to force the dismount of the database on demand. 
-autorestart
 Optional. Use this command if restarting an Exchange Server machine is necessary.
Example:

Restore a machine to a protected machine with the IP address 192.168.20.130, including the force database dismount option: 

>cmdutil /restoreagent -protectedserver 192.168.20.130 -rpn 259 -volumes "F:" "E:" "C:" -targetmachine 192.168.20.174 -targetvolume "E:" "G:" "F:" -forcedismount

RestoreArchive

This command restores an archive from a local archive or share and places the restored data in a specified repository.

Usage

The usage for the command is as follows: 

/restorearchive -core [host name] -user [user name] -password [password] -all | -protectedserver [name | IP address] -repository [name] -archiveusername [name] -archivepassword [password] -path [location]
Command Options

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

Table 63: RestoreArchive 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. 
-all
 Restore data for all protected machines from the archive files. 
-protectedserver
 Protected machine with recovery points to restore. You can specify several machine names enclosed in double quotes and separated by spaces. 
-repository
 Name of a repository on the Core to which the restored recovery points should be placed. The name must be enclosed in double quotes. 
-archiveusername
 Optional. User name for the remote machine. Required for network path only. 
-archivepassword
 Optional. Password to the remote machine. Required for network path only. 
-path
 Location of the archived data to be restored; for example: d:\work\archive or network path \\servename\sharename.
Examples:

Restore archived data for all protected servers: 

>cmdutil /restorearchive -core 10.10.10.10 -username administrator -password 23WE@#$sdd -all -repository repository1 -path d:\work\archive

Restore archived data for specific protected servers: 

>cmdutil /restorearchive -core 10.10.10.10 -username administrator -password 23WE@#$sdd -protectedserver “10.10.20.30” “20.10.10.5” -repository repository1 -path d:\work\archive

RestoreSettings

The restoresettings command lets you restore the settings of only the Core, or of the Core with repositories.

NOTE: Before you can restore Core settings, you must back them up, as described in BackupSettings.

Usage

The usage for the command is as follows: 

/restoresettings -localpath [local path] -restorerepositories [restores the repositories with the settings]
Command Options

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

Table 64: RestoreSettings command options
Option Description 
-?
 Display this help message. 
-localpath
 The path for the configuration backup. 
-restorerepositories
 Optional. Restores repositories as well as the Core settings.
Example:

Restore only the Core settings: 

>cmdutil /restoresettings -localpath D:\work\archive

Restore the Core settings and the repositories: 

>cmdutil /restoresettings -localpath D:\work\archive -restorerepositories
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating