Chat now with support
Chat with Support

Rapid Recovery 6.9 - 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-ProtectHyperVCluster

The Start-ProtectHyperVCluster command adds a Hyper-V cluster under protection by a Core using agentless protection.

Usage

The usage for the command is as follows: 

Start-ProtectHyperVCluster -core [host name] -user [user name] -password [password] -repository [name] -server [name | IP address] -serverusername [user name] -serverpassword [password] -serverport [port] -virtualmachines [virtual machines collection | all] -isagentprotection

Command Options

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

Table 179: Start-ProtectHyperVCluster 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. 
-repository
 Name of a repository on the Core to which the protected machine data should be stored. The name must be enclosed in double quotes. 
-server
 Name or IP address of the Hyper-V server that you want to protect. 
-serverusername
 User name for the Hyper-V server to be protected. 
-serverpassword
 Password for the Hyper-V server to be protected. 
-serverport
 Optional. Protected Hyper-V server port number. 
-virtualmachines
 Optional. List of virtual machines to protect. Values must be enclosed in double quotes and separated by a space. If you exclude this parameter, only the Hyper-V cluster container is protected. 
-isagentprotection
 Optional. Use this option to protect a cluster with an Agent in each guest virtual machine, which is false by default. 
-autoprotect
 Optional. This option enables the autoprotect feature for the Hyper-V server. It is not compatible with the -isagentprotection option.

Example:

Protect specific virtual machines of a Hyper-V cluster: 

>Start-ProtectHyperVCluster -core 10.10.10.10 -username admin -password password -repository “Repository 1” -server 10.10.8.150 -serverport 443 -serverusername root clusterpassword password -virtualmachines “VM1” "VM2" -autoprotect

Start-ProtectHyperVServer

The Start-ProtectHyperVServer command adds a Hyper-V server under protection by a Core using agentless protection.

Usage

The usage for the command is as follows: 

Start-ProtectHyperVServer -core [host name] -user [user name] -password [password] -repository [name] -server [name | IP address] -serverusername [user name] -serverpassword [password] -serverport [port] -virtualmachines [virtual machines collection | all] -isagentprotection

Command Options

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

Table 180: Start-ProtectHyperVServer 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. 
-repository
 Name of a repository on the Core to which the protected machine data should be stored. The name must be enclosed in double quotes. 
-server
 Name or IP address of the Hyper-V server that you want to protect. 
-serverusername
 User name for the Hyper-V server to be protected. 
-serverpassword
 Password for the Hyper-V server to be protected. 
-serverport
 Optional. Protected Hyper-V server port number. 
-virtualmachines
 Optional. List of virtual machines to protect. Values must be enclosed in double quotes and separated by a space. If you exclude this parameter, only the Hyper-V cluster container is protected.

Example:

Protect specific virtual machines of a Hyper-V server: 

>Start-ProtectHyperVServer -core 10.10.10.10 -username admin -password password -repository “Repository 1” -server 10.10.8.150 -serverport 443 -serverusername root clusterpassword password -virtualmachines “VM1” "VM2"

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 181: 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 182: 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
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating