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

Start-HypervExport

The Start-HypervExport PowerShell cmdlet initiates the launch of a virtual export from the selected Rapid Recovery recovery point to a Hyper-V server virtual machine.

Usage

The usage for the command is as follows: 

Start-HypervExport -core [host name] -user [user name] -password [password] -protectedserver [[machine name] or [IP address]] -volumes [volume names] -rpn [number | numbers] | -time [time string] [-vmname [uselocalmachine] | -hostname [virtual host name] -hostport [virtual host port number] -hostusername [virtual host user name] -hostpassword [virtual host password] -vmlocation [location]] [-ram [total megabytes] | -usesourceram] -diskformat [VHD | VHDX]
Command Options

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

Table 188: Start-HypervExport 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
 Protected machine with recovery points to be exported. 
-volumes
 Optional. List of volume names to be exported. If not specified, all volumes in the specified recovery points will be exported. Values must be enclosed in double quotes, each separated by a space.

NOTE: Do not use trailing slashes in volume names. For example, specify “c:” not “c:/”.

-rpn
 Optional. The sequential number of a recovery point to be exported. (You can use the Get-RecoveryPoints 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/2019 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. 

-vmname
 Windows name of the virtual machine. 
-gen2
 Optional. Specify to use the second VM generation. If not specified, generation 1 is used. Rapid Recovery supports generation 2 from Windows Server 2012 R2 through Windows 8.1. 
-usevhdx
 Optional. If you specify this option, Rapid Recovery uses the VHDX disk format to create the VM. If you do not, it uses the VHD disk format. Generation 2 uses only the VHDX format. 
-uselocalmachine
 Optional. Connect the local Hyper-V server. If this parameter is used, the following options are ignored: hostname, host port, host username, host password. 
-hostname
 The virtual server host name. 
-hostport
 The virtual server port number. 
-hostusername
 The user name to the virtual server host. 
-hostpassword
 The password to the virtual server host. 
-vmlocation
 Local or network path to the folder where you want to store the virtual machine files. 
-ram
 Allocate specific amount of RAM on the virtual server. 
-usesourceram
 Optional. Allocate the same amount of RAM on the virtual server as the source protected machine.

Start-LogTruncation

The Start-LogTruncation cmdlet 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 189: 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.
Examples:

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 cmdlet 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 190: 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.

Examples:

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

> Start-MountabilityCheck -protected EX01

Start-OptimizationJob

The Start-OptimizationJob cmdlet 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 191: 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.
Examples:

Start a repository optimization job: 

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

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating