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

Remove-Repository

The Remove-Repository PowerShell command deletes a Rapid Recovery repository and its contents from the Core.

Usage

The usage for the command is as follows: 

Remove-Repository -core [host name] -user [login] -password [password] -name [repository name] -all

Command Options

The following table describes the options available for the Remove-Repository command:

Table 147: Remove-Repository 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. 

-name
 The name of the repository that you want to delete. 
-all
 Delete all repositories associated with this Core.

Example:

Remove all repositories on the local Core: 

>Remove-repository -all

Remove-ScheduledArchive

If you scheduled Rapid Recovery to regularly archive recovery points for a specific machine, you can use the Remove-ScheduledArchive PowerShell command to remove that scheduled archive from the Core.

Usage

The usage for the command is as follows: 

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

Command Options

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

Table 148: Remove-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
 Remove all archives associated with this Core. 
-id
 The identifier of the archive that you want to remove. To list more than one archive, separate each ID with a space.

Example:

Remove several scheduled archives from the local Core: 

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

Remove-VirtualStandby

If you scheduled Rapid Recovery to continuously export data to a virtual machine, then you can use the Remove-VirtualStandby PowerShell command to cancel and delete this scheduled job.

Usage

The usage for the command is as follows: 

Remove-VirtualStandby -core [host name] -user [login] -password [password] -all | -protectedserver [name(s) | IP ad
    dress]

Command Options

The following table describes the options available for the Remove-VirtualStandby command:

Table 149: Remove-VirtualStandby 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
 Remove all virtual standby jobs associated with this Core. 
-protectedserver

The name or IP address for the protected machine for which you want to remove virtual standby.

Example:

Remove all virtual standby jobs associated with this Core: 

>Remove-VirtualStandby -all

Restart-CoreService

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

Usage

The usage for the command is as follows: 

Restart-CoreService -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 Restart-CoreService command:

Table 150: Restart-CoreService 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: 

>Restart-CoreService -core 10.10.127.42 -user admin -password 676df#df -cancelactivejobs true -wait 600
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating