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

Stop-ActiveJobs

The Stop-ActiveJobs cmdlet cancels active jobs for a specified protected machine.

Usage

The usage for the command is as follows: 

Stop-ActiveJobs [-protectedserver [machine name | IP address] | -core [host name]] -user [user name] -password [password] -jobtype [jobtype]
Command Options

The following table describes the options available for the Stop-ActiveJobs command:

Table 208: Stop-ActiveJobs command options
Option Description 
-?
 Display this help message. 
-all
 Select and cancel events of the specified type for all protected machines. 
-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 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. 
-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. 
-protectedserver
 Determines protected machine on which jobs should be canceled. 
-jobtype
 Optional. Specifies job type filter. Available values are: ‘transfer’ (data transfer), ‘repository’ (repository maintenance), ‘replication’ (local and remote replications), ‘backup’ 9backup and restore), ‘bootcdbuilder’ (create boot CDs), ‘diagnostics’(upload logs), ‘exchange’ (Exchange Server files check), ‘export (recovery point export), ‘pushinstall’ (deploy Agent software to protected machines), ‘rollback’ (restore data from recovery point), ‘rollup’ (recovery point rollup’s), ‘sqlattach’ (agent attachability checks), ‘mount’ (not repository). By default, all jobs of the specified type are canceled.
Examples:

Stop transfer job in protected machine: 

>Stop-ActiveJobs –protectedserver 10.10.1.76 -jobtype transfer

Stop all jobs for a specific protected machine: 

>Stop-ActiveJobs –protectedserver 10.10.1.76 -all

Stop-CoreService

Use the Stop-CoreService cmdlet to gracefully stop the Core service on a Core machine.

Usage

The usage for the command is as follows: 

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

Table 209: Stop-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 stopped for the specified period of time in seconds before canceling active jobs.
Examples:

Stop the Core service: 

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

Suspend-Replication

The Suspend-Replication cmdlet lets an administrator pause replication. Once paused, replication does not resume unless you explicitly run cmdlet Resume-Replication or resume from the Rapid Recovery Core Console.

A user can pause replication in three ways:

  • Pause replication on the source Core for all protected machines (-outgoing parameter)

    The administrator must specify the remote machine name with outgoing replication pairing to pause outgoing replication on the source Core. 

    		>Suspend-replication -outgoing 10.10.12.10
  • Pause replication on the source Core for a single protected machine (-protectedserver parameter) 
    		>Suspend-replication -protectedserver 10.10.12.97
  • Pause replication on the target Core (-incoming parameter)

    If the local Core is a target Core, the administrator can pause replication by specifying the source Core using the –incoming parameter.

Command Options

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

Table 210: Suspend-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. 
-incoming
 Host name of the remote Core that replicates to the Core machine. Replication is suspended for all protected machines on the remote Core. 
-outgoing
 Host name of the remote target core to which data is replicating. Replication is suspended for all protected machines on the remote core.
Examples:

Pause all replication (incoming and outgoing) for the local Core:

>Suspend-replication –incoming all -outgoing all

Pause outgoing replication on the remote Core with the IP address: 10.10.1.15, for the single protected machine with the IP address: 10.10.1.76: 

>Suspend-replication –core 10.10.1.15 –protectedserver 10.10.1.76

Pause outgoing replication from the local Core to remote target with the IP address: 10.10.1.63 for all protected machines: 

>Suspend-replication –outgoing 10.10.1.63

Pause incoming replication from 10.10.1.82 on the remote Core with the IP address: 10.10.1.15 (Administrator is able to pause incoming replication only for whole machine): 

>Suspend-replication –core 10.10.1.15 –incoming 10.10.1.82

Suspend-ScheduledArchive

The Suspend-ScheduledArchive PowerShell cmdlet lets you pause a scheduled archive. This command prevents the archive from occurring as scheduled until you reactivate it using Remove-ScheduledArchive or from the Rapid Recovery Core Console .

Usage

The usage for the command is as follows: 

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

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

Table 211: Suspend-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. 
-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
 Pauses all scheduled archives. 
-id or -ids
 The identification number or numbers of scheduled archives to suspend. If suspending more than one scheduled archive, separate each with a comma. Obtain IDs using command Get-ScheduledArchives
Examples:

Suspend multiple scheduled archives: 

>Suspend-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