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

Start-RepositoryCheck

The Start-RepositoryCheck PowerShell command lets you check the integrity of a repository.

Usage

The usage for the command is as follows: 

Start-RepositoryCheck -name [repository name] | -all [check all repositories] -password [password] -force

Command Options

The following table describes the options available for the Start-RepositoryCheck command:

Table 179: Start-RepositoryCheck 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 also have to provide a password. If none are provided, then the logged-on user's credentials will be used. 
-password
 Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a log on.

If none are provided, then the logged-on user's credentials will be used. 

-repository
 Required. The name of the repository that you want to check. 
-all
 Optional. Check all repositories associated with this Core. 
-force
 Optional. Perform the repository check without confirmation.

Example:

Start checking a repository: 

>Start-RepositoryCheck -repository newRepository1 -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd

Start-RestoreAgent

The Start-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: 

Start-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 Start-RestoreAgent command:

Table 180: Start-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: 

>Start-RestoreAgent -protectedserver 192.168.20.130 -rpn 259 -volumes "F:" "E:" "C:" -targetmachine 192.168.20.174 -targetvolume "E:" "G:" "F:" -forcedismount

Start-RestoreArchive

Businesses often use long-term storage to archive both compliant and non-compliant data. The archive feature in Rapid Recovery is used to support the extended retention for compliant and non-compliant data. The administrator can save an archive on the local storage or network location by specifying the -Path command and credentials.

Usage

The usage for the command is as follows: 

Start-RestoreArchive -core [host name] -user [login] -password [password] -all | -protectedserver [name | IP address | "[name1 | IP address1]" "[name2 | IP address2]"] -repository [name] -archiveusername [name] -archivepassword [password] -path [location]  -cloudaccountname [name] -cloudcontainer [name]

Command Options

The following table describes the options available for the Start-RestoreArchive command:

Table 181: Start-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 also have to provide a password.

If none are provided, then the logged-on user's credentials will be used. 

-password
 Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a log on.

If none are provided, then the logged-on user's credentials will be used. 

-all
 Archive recovery points for all protected machines. 
-protectedserver
 The protected machine with recovery points that you want to archive. You can specify multiple machine names enclosed in double quotes and separated by commas. 
-repository
 The name of the repository where you want to place restored recovery points. You must enclose the name in double quotes; for example, "Repository1." 
-archiveusername
 Optional. The user name for logging in to the remote machine. It is required for a network path only. 
-archivepassword
 Optional. The password for logging in to the remote machine. It is required for a network path only. 
-path
 The path to where to save the archived data. For example:
  • Local machine: "d:\work\archive"
  • Network path: "\\servername\sharename"
  • Folder in a cloud account: "Folder Name"
Note: The number of symbols should not be greater than 100 for local and network locations, and should not be greater than 150 for a cloud location. 
-cloudaccountname

Optional. Use only for cloud archiving. The name of the cloud account where you want to save the archive. 

-cloudcontainer

Optional. Use only for cloud archiving. The name of the cloud container in the chosen cloud account, where the archive will be saved. When you use this option, you should also specify the "-cloudaccountname" parameter. 

-manifestcore
 Optional. Specify the Core that you want to use from the manifest of the restored archive.

Example:

Archive all recovery points for all machines on the Core and store them on the local machine: 

>Start-RestoreArchive -path D:\work\archive -startdate 'Example 04/30/2012' –all

Start-ScheduledArchive

The Start-ScheduledArchive PowerShell command lets you force a Rapid Recovery scheduled archive to begin on demand, regardless of the pre-established schedule.

Usage

The usage for the command is as follows: 

Start-ScheduledArchive -core [host name] -user [login] -password [password] -all -ids [id | id1 id2]

Command Options

The following table describes the options available for the Start-ScheduledArchive command:

Table 182: Start-ScheduledArchive 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 also have to provide a password.

If none are provided, then the logged-on user's credentials will be used. 

-password
 Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a log on.

If none are provided, then the logged-on user's credentials will be used. 

-all
 Force all scheduled archives. 
-id
 The identification number or space-separated identifiers of the scheduled archives that you want to force.

Example:

Start multiple scheduled archive jobs: 

>Start-ScheduledArchive -ids 799138c8-3dfc-4398-9711-1823733c2a31, 26c29bb7-b320-47f5-b5a8-dffc49f50e25
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating