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

Get-VirtualizedServers

The Get-VirtualizedServers command returns information about virtualized servers.

Usage

The usage for the command is as follows: 

Get-VirtualizedServers -core [host name] -user [user name] -password [password]

Command Options

The following table describes the options available for the Get-VirtualizedServers command:

Table 119: Get-VirtualizedServers 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.

Example:

Lists all virtualized servers on the local Core: 

>Get-VirtualizedServers

Get-Volumes

The Get-Volumes command returns information about volumes on a specified machine that is protected by the Core.

Usage

The usage for the command is as follows: 

Get-Volumes -core [host name] -user [user name] -password [password] 
-protectedserver [server name or IP address]

Command Options

The following table describes the options available for the Get-Volumes command:

Table 120: Get-Volumes 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.

Example:

Lists all volumes on the specified machine: 

>Get-Volumes -protectedserver 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 121: 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 of additional volume names to be exported. If you use the value all or use no value, then all volumes export. Values must be enclosed in double quotes and separated by a space. Do not use trailing slashes in volumes names; for example, use "c:" "d:".
-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.

Example:

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 122: 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.

Example:

Force base image for all protected machines: 

>New-Base –all
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating