Chat now with support
Chat with Support

Rapid Recovery 6.7 - 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 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-Mounts Get-OracleInstances Get-Passed Get-ProtectedServers Get-ProtectionGroups Get-QueuedJobs Get-RecoveryPoints Get-ReplicatedServers Get-Repositories Get-ScheduledArchives Get-SqlDatabases 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-VBVirtualStandby New-VMVirtualStandby Push-Replication Push-Rollup Remove-Agent Remove-EsxAutoProtectObjects Remove-HyperVClusterSharedVirtualDisks Remove-HyperVClusterVirtualMachines Remove-HyperVVirtualMachines Remove-Mount Remove-Mounts Remove-RecoveryPoints Remove-RemoteMount Remove-RemoteMounts Remove-Replication Remove-Repository Remove-ScheduledArchive Remove-VirtualStandby Restart-CoreService Resume-Replication Resume-ScheduledArchive Resume-Snapshot Resume-VirtualStandby 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-ScheduledArchive Start-VBExport Start-VirtualStandby Start-VMExport Stop-ActiveJobs Stop-CoreService Suspend-Replication Suspend-ScheduledArchive Suspend-Scheduler Suspend-Snapshot Suspend-VirtualStandby Suspend-VMExport Update-Repository
Localization Qualifiers
Scripting

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 61: 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

RestoreUrc

The restoreurc command lets you restore a protected machine or volume from a specific Rapid Recovery recovery point to a bare-metal machine using the Universal Recovery Console (URC).

Usage

The usage for the command is as follows:

/restoreurc -protectedserver [name | IP address] -rpn [recovery point number] -volumes [IDs | names | all] -targetmachine [IP address] -urcpassword [password from the URC] -targetdisk [disk number | all]

Command Options

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

Table 62: RestoreUrc 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 which you want to restore the URC.
-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.
-urcpassword
The authentication key from the URC.
-targetdisk
The numbers of the disks on which you want to restore the machine. To select all disks from the machine using the URC, use -targetdisk all.

Example:

Restore a machine to disks 0 and 1 of the machine using the URC, when the IP address for the URC machine is 192.168.20.175:

>cmdutil /restoreurc -protectedserver 192.168.20.130 -rpn 259 -volumes "C:" "E:" -targetmachine 192.168.20.175 -urcpassword ******** -targetdisk 0 1

Resume

The administrator can use this command to resume snapshots, export to a virtual machine, and replicate. You must specify your need to resume by a parameter. The following parameters are valid: snapshot, vmexport, and replication. See Pause for more details.

Usage

The usage for the command is as follows:

/resume [snapshot | vmexport | replication] -core [host name] -user [user name] -password [password] -all | -protectedserver [name | IP address] -incoming [host name] | outgoing [host name] -time [time string]

Command Options

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

Table 63: Resume command options
Option Description
-?
Display this help message.
-restore
[snapshots], [replication] or [vmexport].
-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
Resume all agents on the selected Core.
-protectedserver
Resume current protected server.
-incoming
Host name of the remote core that replicates to the core machine.
-outgoing
Host name of the remote target core to which data is replicated.

Examples:

Resume snapshots for specific protected server:

>cmdutil /resume snapshot -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.10.4

Resume export to a virtual machine for all protected machines on the core:

>cmdutil /resume vmexport –core 10.10.10.10 -user administrator -password 23WE@#$sdd -all

Resume outgoing replication on the core for a specific protected machine:

>cmdutil /resume replication -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.1.76

Resume outgoing replication for all protected machines on the target core:

>cmdutil /resume replication -core 10.10.10.10 -user administrator -password 23WE@#$sdd -outgoing 10.10.1.63

Resume incoming replication for all machines on the target core:

>cmdutil /resume replication -core 10.10.10.10 -user administrator -password 23WE@#$sdd -incoming 10.10.1.82

ResumeScheduler

This command lets you resume the task scheduler it has been paused.

Usage

The usage for the command is as follows:

/resumescheduler -core [host name] -user [user name] -password [password]

Command Options

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

Table 64: ResumeScheduler command options
Option Description
-?
Display this help message.
-restore
[snapshots], [replication] or [vmexport].
-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.

Example:

Resume snapshots for specific protected server:

>cmdutil /resumescheduler -core 10.10.127.42 -user admin -password 676df#df
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating