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

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 164: 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.
Examples:

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 165: 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.

Examples:

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 166: 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.
Examples:

Restart the Core service: 

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

Resume-Replication

The Resume-Replication PowerShell cmdlet lets you resume replication after it has been suspended. For the cmdlet to suspend replication, see Suspend-Replication.

Usage

The usage for the command is as follows: 

Resume-Replication -core [host name] -user [user name] -password [password] -all | -protectedserver [machine name | IP address] -incoming [host name] | -outgoing [host name]
Command Options

The following table describes the options available for the Resume-Replication command:

Table 167:

Resume-Replication .

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. 
-password
 Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a user name. If none are provided, then the logged-on user's credentials will be used. 
-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. 
-all
 All protected servers. 
-protectedserver
 Resume replication for the specified machine. 
-incoming
 Host name of the remote Core that replicates to the Core machine. Replication is resumed for all protected machines on the remote Core. 
-outgoing
 Host name of the remote target core to which data is replicating. Replication is resumed for all protected machines on the remote core.
Examples:

Resume replication for the protected machine with IP 10.10.10.128 for the local Core, specifying the repository being used: 

>Resume-Replication replicationname Replication1 -targetserver 10.10.10.128,Administrator,123asdQ -protectedserver 10.10.10.4

# Repository
- ----------

1 Repository A
2 Repository B
Please, input number of Repository from the list above or type 'exit' to exit:

Script pauses, requiring user to specify an index number for the appropriate repository. Enter the index number for the script to complete (in this case, 2). Example continues: 

2
Replication job was started.
True
PS C:\Users\Administrator>
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating