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

New-HyperVVirtualStandby

The New-HyperVVirtualStandby PowerShell command lets you create a new Hyper-V virtual machine (VM) using Rapid Recovery.

Usage

The usage for the command is as follows: 

New-HyperVVirtualStandby -core [host name] -user [login] -password [password] -protectedserver [name | IP address]
    -volumes [volumes names] -vmname [virtual machine name] [-gen2] -useVhdx [-uselocalmachine] | -hostname [virtual ho
    st name] -hostport [virtual host port number] -hostusername [virtual host login] -hostpassword [virtual host passwo
    rd]] -vmlocation [location] [-ram [total megabytes] | -usesourceram] -initialexport
Command Options

The following table describes the options available for the New-HyperVVirtualStandby command:

Table 140: New-HyperVVirtualStandby 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. 

-protectedserver
 Show jobs for a specific protected machine, indicated by IP address. 
-volumes
 Optional. List the volume names you want to export. If you use the value all or use no value, then all volumes in the recovery points are exported. Values must be enclosed in double quotes and separated by a space.

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

-vmname
 The Microsoft 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 to the local Hyper-V server. When you specify this value, Rapid Recovery ignores the following options:
  • hostname
  • hostport
  • hostusername
  • hostpassword 
-hostname
 The name of the virtual server host. 
-hostport
 The port number to use for communicating with the virtual server. 
-hostusername
 The user name for logging in to the virtual server host. 
-hostpassword
 The password for logging in to the virtual server host. 
-vmlocation
 Local or network path to the folder where you want to store the virtual machine files. 
-ram
 Allocate a specific amount of RAM on the virtual server. 
-usesourceram
 Optional. Allocate the same amount of RAM on the virtual server that the source protected machine has. 
-initialexport
 Optional. Specify this option if you need to start an initial on-demand virtual machine export after configuring the virtual standby.
Examples:

Create a new Hyper-V virtual standby machine: 

>New-HyperVVirtualStandby -core [host name] -user [login] -password [password] -protectedserver [name | IP address]
    -volumes [volumes names] -vmname [virtual machine name] [-gen2] -useVhdx [-uselocalmachine] | -hostname [virtual ho
    st name] -hostport [virtual host port number] -hostusername [virtual host login] -hostpassword [virtual host passwo
    rd]] -vmlocation [location] [-ram [total megabytes] | -usesourceram] -initialexport

New-Mount

The New-Mount command mounts a snapshot of one or more drives.

Usage

The usage for the command is as follows: 

New-Mount -core [host name] -user [user name] -password [password] -protectedserver [machine name] -mounttype [read | write | readonlywithpreviouswrites] -drives [drive names] -path [location] –time [MM/DD/YYYY hh:mm:ss tt | passed | latest] –rpn [number]
Command Options

The following table describes the options available for the New-Mount command:

Table 141: New-Mount 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. 
-protectedserver
 The protected server IP address or machine name (depends on how the particular machine was protected. 
-time
 Optional. The timestamp of the Recovery Point to mount. This should be in the format that is specified by the OS on the current PC. The administrator is able to get the latest recovery point by specifying latest or last checked recovery point by passed parameter value. By default the latest time option is chosen. 
-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. 

-path
 Path on the Core machine to which recovery points will be mounted. 
-mounttype
 Optional. Specifies a mount mode. Available options are 'read', 'readOnlyWithPreviousWrites' (read-only with previous writes), 'write' (writable). Default mode is read-only. 
-volumes
 Optional. Space-separated list of volume names to mount. If the volume’s name contains spaces or special characters, it has to be specified using double quotes. If not specified, all volumes will be mounted. 
-rpn
 Optional. Recovery point number for the mount. You can obtain this using the get-mounts command. Specify several numbers for the rpn parameter to mount different points with a single command.
Note: If you set an array of points to mount, each point will be located in a separate child directory. The name describes the time when the recovery point was created. When you call dismount, all child directories will be removed. You should remove the parent directory manually.
Examples:
>New-Mount -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -path C:\MountedRecoveryPoint -mounttype read -volumes c “d, ko”

Mount an array of recovery points: 

>New-Mount –rpn 10 52 41 -protectedserver localhost –path “D:/Folder for mount”

Mount a recovery point with certain time created: 

>New-Mount -protectedserver 10.10.5.56 –path “D:/Folder for mount” –time “8/24/2012 11:46 AM”

New-Replication

The New-Replication command lets you set up and force replication for a protected server or servers.

Usage

The usage for the command is as follows: 

New-Replication -core [host name] -user [login] -password [password] -targetserver [host name] -protectedserver [name | IP address]
Command Options

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

Table 142: New-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. 
-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. 
-replicationname
 Name of the replication configuration on the target Core. 
-targetserver
 The host name, user name, and password for the target Core. 
-protectedserver
 The name of the protected machine and repository on the target Core for setting up replication.
Examples:

Create new replication for the protected machine with IP 10.10.10.4:

Pending examples from QA. 

>New-Replication -targetserver 10.10.10.128 -protectedserver 10.10.10.4

New-Repository

The New-Repository command creates a new DVM repository in the Rapid Recovery Core. The size specified must be between 250MB and 16TB.

Usage

The usage for the command is as follows: 

New-Repository | –name [name] -size [size] -datapath [location] -metadatapath [location]
Command Options

The following table describes the options available for the New-Repository command:

Table 143: New-Repository 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. 
-name
 Repository name. 
-size
 Size of repository extent. Available units are: b, Kb, MB, GB, TB, PB. 
-datapath
 For local location only. Determines data path of repository extent. 
-metadatapath
 For local location only. Determines metadata path of repository extent. 
-uncpath
 For share location only. Determines data and metadata paths of repository extent. 
-shareusername
 For share location only. Determines login to share location. 
-sharepassword
 For share location only. Determines password to share location. 
-comment
 Optional. Description of repository. 
-concurrent
Operations
 Optional. Maximum number of operations that can be pending at one time. Value by default: 64.
Examples:

Create new DVM repository of minimum size in local drive E: 

>New-Repository –name Repository2 -size 250Mb -datapath e:\Repository\Data -metadatapath e:\Repository\Metadata
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating