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

Join-CredentialsVaultAccount

The Join-CredentialsVaultAccount cmdlet connects a Core to the specified Credentials Vault account.

Usage

The usage for the command is as follows: 

Join-CredentialsVaultAccount [-AccountId <string>] [-TargetAccountId <string>] [-User <string>] [-Core <string>] [-Password <string>] [<CommonParameters>]
Command Options

The following table describes the options available for the Join-CredentialsVaultAccount command:

Table 132: Join-CredentialsVaultAccount 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. 

-accountid

The identifier for the Credentials Vault account.

-targetaccountid
 The identifier for the Credentials Vault account.
Examples:

Join a Core to a specified Credentials Vault account: 

>Join-CredentialsVaultAccount -AccountId cv12345 -Core 10.10.10.10

New-AzureVirtualStandby

You can use the New-AzureVirtualStandby command to export a virtual machine (VM) to a Microsoft Azure cloud account as a virtual standby machine.

Usage

The usage for the command is as follows: 

New-AzureVirtualStandby -core [host name] -user [user name for Core] -password [password for Core] -protectedserver [name | IP address] -volumes [volume names | all] -initialexport -cloudaccountname [cloud account name]	-storageaccountname [storage account name]-containername [container name] -foldername [folder name] -subscriptionid [Azure subscription ID]
Command Options

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

Table 133: New-AzureVirtualStandby 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
 Protected machine with recovery points that you want to export. 
-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:/”.

-initialexport
 Optional. Include this option if you need to start an initial ad-hoc virtual machines export to configure the virtual standby. 
-cloudaccountname
 Optional. You can use this option if you do not specify the -storageaccountname. It is the display name for the cloud account previously registered on the Core. 
-storageaccountname
 Optional. You can use this option if you do not specify the -cloudaccountname. It is the name of the storage account in Azure Classic. 
-containername
 The name of the container in the Azure storage account (classic). The name must container between three and 63 characters (lowercase letters, numbers, and hyphens only), and start with a letter or a number. Every hyphen must be preceded and followed by a letter or number. 
-foldername
 Optional. The name of a folder inside of the Azure storage container. A folder name cannot contain any of the following characters: \ / : * ? " < > |. 
-subscriptionid
 The identifier of a previously added Azure subscription.
Examples:

Create a new Azure virtual standby: 

>New-AzureVirtualStandby -protectedserver Win2008R2 -storageaccountname exports3 -containername container1 -foldername Win2008R2 -subscriptionid 4db3a063-0d9c-42d8-a994-d5e5c4b82c0

New-Base

The New-Base command forces a new base image resulting in a data transfer for the current protected machine. When you force a base image, the transfer will start immediately or will be added to the queue. Only the data that has changed from a previous recovery point will be transferred. If there is no previous recovery point, all data on the protected volumes will be transferred.

Usage

The usage for the command is as follows: 

New-Base [[-all] | -protectedserver [machine name]] -core [host name] -user [user name] -password [password]
Command Options

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

Table 134: New-Base command options
Option Description 
-?
 Display this help message. 
-all
 Base image for all agents. 
-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. 
-protectedserver
 Force for the current protected machine’s name. 
-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.
Examples:

Force base image for all protected machines: 

>New-Base –all

New-BootCD

This command lets you create a bare metal restore (BMR) boot CD without using the Rapid Recovery Core Console.

Usage

The usage for the command is as follows: 

New-BootCD -core [host name] -user [user name] -password [password] -ip [IP address] -mask [mask] -defaultgateway [defaultgateway] -dnsserver [dnsserver] -vncpassword [vncpassword] -vncport [vncport] -isofilepath [destination for the boot image] -driverspath [drivers path]
Command Options

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

Table 135: New-BootCD 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. 
-ip
 Optional. This option specifies the IP address of the target BMR machine. By default, it generates automatically. 
-mask
 Optional. This option specifies the subnet mask of the target BMR machine. By default, it generates automatically. 
-defaultgateway
 Optional. This option specifies the default gateway of the target BMR machine. By default, it generates automatically. 
-dnsserver
 Optional. This option specifies the DNS server for the target BMR machine. By default, it generates automatically. 
-vncpassword
 Optional. This option specifies the user password for an existing UltraVNC account. By default, this option is empty. 
-vncport
 Optional. This option specifies the port to use for UltraVNC. You can change it only if you used the -vncpassword option. By default, the port is 5900. 
-isofilepath
 Optional. This option specifies the patch to the boot CD file. The default path is C:\ProgramData\AppRecovery\Boot CDs. 
-driverspath
 Optional. This option specifies the path to the archive of drivers.
Examples:

Create a boot CD: 

>New-BootCD -ip 192.168.20.188 -mask 255.255.255.0 -defaultgateway 192.168.20.2 -dnsserver 192.168.20.2 -isofilepath D:\bcd\newbcd3.iso
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating