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

The Start-LogTruncation command forces log truncation for the specified protected SQL Server or Microsoft Exchange server.

Usage

The usage for the command is as follows: 

Start-LogTruncation -core [host name] -user [user name] -password [password] -protectedserver [[machine name] or [IP address]] -target [sql | exchange]

Command Options

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

Table 171: Start-LogTruncation 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 user name. If none are provided, then the logged-on user's credentials will be used. 
-protectedserver
 Archive of recovery points for the specified machine. 
-target
 Specify the type of log truncation (either ‘sql’ or ‘exchange’). If not specified, logs are truncated on all databases.

Example:

Truncate SQL logs: 

>Start-LogTruncation -protectedserver SQL1 -target sql

Truncate Exchange server logs: all recovery points for all machines on the Core: 

> start-LogTruncation -protectedserver ExServer2 -target exchange

Start-MountabilityCheck

The Start-MountabilityCheck command forces a mountability check for protected Microsoft Exchange mail stores.

Usage

The usage for the command is as follows: 

Start-MountabilityCheck -core [host name] -user [user name] -password [password] -protectedserver [[machine name] or [IP address]] -rpn [number | numbers] | 
-time [time string]

Command Options

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

Table 172: Start-MountabilityCheck 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 user name. If none are provided, then the logged-on user's credentials will be used. 
-protectedserver
 Archive of recovery points for the specified machine. 
-rpn
 Optional. The sequential number of a recovery point to be exported. (You can use the -GetRecoveryPoints command to obtain recovery point numbers.
Note: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most recent recovery point will be exported. 
-time
 Optional. Determines recovery point to be selected for export. You need to specify exact time in the format “MM/DD/YYYY hh:mm tt” (for example: “04/24/2015 09:00 AM”).” Specify date time values of the time zone set on your local machine.
Note: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most recent recovery point will be exported.

Example:

Start a mountability check for oall recovery points for all machines on the Core: 

> Start-MountabilityCheck -protected EX01

Start-OptimizationJob

The Start-OptimizationJob command lets you perform optimize a repository on demand.

Usage

The usage for the command is as follows: 

Start-OptimizationJob -core [host name] -user [user name] -password [password] -repository [repository name] | -all

Command Options

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

Table 173: Start-OptimizationJob 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. The 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. The 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
 The name of the repository that you want to optimize. 
-all
 Use this option to perform the optimization job on all repositories for this Core.

Example:

Start a repository optimization job: 

>Start-OptimizationJob -repository "Repository 1" -core 10.10.10.10 -user administrator -password 23WE@#$sdd

Start-OracleDBVerifyJob

Use the command Start-OracleDBVerifyJob to start the DBVerify job for one or more specified recovery points on a protected server.

Usage

The usage for the command is as follows: 

Start-OracleDBVerifyJob -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -recoverypointnumber [number | numbers]

Command Options

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

Table 174: Start-OracleDBVerifyJob 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. The 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. The 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
 Use this option to specify the protected machine for which you want to enable the Oracle DBVerify nightly job. 
-recoverypointnumber
 The sequential number of a recovery point that you want to export (use the /list rps command to get the numbers). To start the job on multiple recovery points with one command, separate each recovery point number with a space.

Example:

Start the Oracle DBVerify job for the recovery points on the specified protected server: 

>Start-OracleDBVerifyJob -core 10.10.127.42 -user admin -password 676df#df -protectedserver 10.10.34.88 -recoverypointnumber 1 2
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating