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

ForceAttach

The forceattach command lets you force a SQL database files attachability check. When you force an attachability check, the check begins immediately.

Usage

The usage for the command is as follows: 

/forceattach -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -rpn [number | numbers] | -time [time string]
Command Options

The following table describes the options available for the forceattach command:

Table 30: ForceAttach 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
 Protected machine against which to perform the attachability check. 
-rpn
 The sequential number of a recovery point against which to perform checks (run command /list rps to obtain the numbers). To perform checks against multiple recovery points with a single command, you can specify several numbers separated by spaces. 
-time
 Select a recovery point by its creation time. You must specify the exact time in the format “mm/dd/yyyy hh:mm tt” (for example, “2/24/2012 09:00 AM”). Keep in mind to specify the date and time values of the time zone set on your PC.
Example:

Perform attachability checks for recovery points with numbers 5 and 7: 

>cmdutil /forceattach -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -rpn 5 7

ForceChecksum

The forcechecksum command lets you force an integrity check of any Exchange Message Databases (MDBs) present on the specified recovery point or points. When you force a checksum check, the command begins immediately.

Usage

The usage for the command is as follows: 

/forcechecksum -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -rpn [number | numbers] -time [time string]
Command Options

The following table describes the options available for the forcechecksum command:

Table 31: ForceChecksum 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
 Protected machine against which to perform the checksum check. 
-rpn
 The sequential number of a recovery point against which to perform checks (run command /list rps to obtain the numbers). To perform checks against multiple recovery points with a single command, you can specify several numbers separated by spaces. 
-time
 Select a recovery point by its creation time. You must specify the exact time in the format “mm/dd/yyyy hh:mm tt” (for example, “2/24/2012 09:00 AM”). Keep in mind to specify the date and time values of the time zone set on your PC.
Example:

Perform a checksum check for recovery points with numbers 5 and 7: 

>cmdutil /forcechecksum -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -rpn 5 7

ForceLogTruncation

Forcing log truncation lets you perform this job one time, on-demand. It immediately truncates the logs for the specified SQL Server agent machine.

Usage

The usage for the command is as follows: 

/[forcelogtruncation | flt] -core [host name] -user [user name] -password [password] -protectedserver [name | IP address]
Command Options

The following table describes the options available for the forcelogtruncation command:

Table 32: ForceLogTruncation 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
 Protected machine against which to perform log file truncation.
Example:

Force log truncation for a protected server: 

>cmdutil /forcelogtruncation -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.20.20

ForceMount

Use the forcemount command to conduct an one-time recovery point mountability check. This determines whether or not the specified recovery point or recovery points can be mounted and used to restore backed up data. You must list either one or more specific recovery points on which to conduct the check, or a time range during which the recovery points were created.

Usage

The usage for the command is as follows: 

/forcemount -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -rpn [number | numbers] | -time [time string]
Command Options

The following table describes the options available for the forcemount command:

Table 33: ForceMount 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
 Protected machine against which to perform a mountability check. 
-rpn
 The sequential number of a recovery point against which to perform checks (run command /list rps to obtain the numbers). To perform checks against multiple recovery points with a single command, you can specify several numbers separated by spaces. 
-time
 Select a recovery point by its creation time. You must specify the exact time in the format “mm/dd/yyyy hh:mm tt” (for example, “2/24/2012 09:00 AM”). Keep in mind to specify the date and time values of the time zone set on your PC.
Example:

Perform mountability checks for recovery points with numbers 5 and 7: 

>cmdutil /forcemount -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.20.20 -rpn 5 7
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating