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-AzureDeploy

You can use the Start-AzureDeploy cmdlet to export a VM to a Microsoft Azure cloud account.

Usage

The usage for the command is as follows: 

Start-AzureDeploy -core [host name] -user [user name for Core]
		-password [password for Core] -protectedserver [name | IP address] -volumes
		[volume names | all] -destinationcontainer [Azure destination container]
		-deploymentname [name of deployment] -subscriptionid [Azure subscription ID]
		-cloudservicename [cloud service name] -vmname [virtual machine name] -vmsize
		[virtual machine size] -endpointname [rdp | ssh] -protocol [tcp | udp]
		-publicremoteaccessport [public port number] -privateremoteaccessport [private
		port number]
Command Options

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

Table 180: Start-AzureDeploy 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 for the deploy. If you use the value all or use no value, then all volumes deploy. 
-destinationcontainer
 The name of the Azure destination container you want to use for the deploy. 
-deploymentname
 The name of the deployment. 
-subscriptionid
 The Azure subscription ID. 
-cloudservicename
 The name of the Azure cloud service. 
-vmname
 The name of the virtual machine. 
-vmsize
 The size of the virtual machine; for example, A0, Basic_A4, or Standard_G1. 
-endpointname
 The Azure endpoint protocol used only for remote access rdp or ssh. The default value is rdp. 
-protocol
 The protocol used only for remote access tcp or udp. The default value is tcp. 
-publicremoteaccessport
 The public port for using remote access. The default value is 3389. 
-privateremoteaccessport
 The private port for using remote access. The default value is 3389. 
-privateagentport
 Optional. The Agent port. If the port value is 0, then the value is determined by the Agent configuration.

NOTE: If neither the parameter -publicagentport nor -privateagentport is specified, then no endpoint is added. 

-publicagentport
 Optional. The external Agent port. If the port value is 0, then the value is determined by the Agent configuration.

NOTE: If neither the parameter -publicagentport nor -privateagentport is specified, then no endpoint is added. 

-privatetransferport
 Optional. The TCP port upon which to accept connections from the Core for the transfer of data from the Agent. If the port value is 0, then the value is determined by the Agent configuration.

NOTE: If neither the parameter -publicagentport nor -privateagentport is specified, then no endpoint is added. 

-publictransferport
 Optional. The external TCP port upon which to accept connections from the Core for the transfer of data from the Agent. If the port value is 0, then the value is determined by the Agent configuration.

NOTE: If neither the parameter -publictransferport nor -privatetransferport is specified, then no endpoint is added.

Examples:

Deploy data to Azure: 

>Start-AzureDeploy -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -deploymentname Deploy1 -destinationcontainer container1 -subscriptionid "111111-22222-33333-4444-555555" -cloudservicename Service1 -vmname VirtualMachine -vmsize A0

Deploy data to Azure using a specified endpoint: 

>Start-AzureDeploy -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -deploymentname Deploy1 -destinationcontainer container1 -subscriptionid "111111-22222-33333-4444-555555" -cloudservicename Service1 -vmname VirtualMachine -vmsize A0 -endpointname ssh -protocol udp -publicremoteaccessport 1555 -privateremoteaccessport 22

Deploy data to Azure with specified Agent and transfer endpoint when the -privateagentport option has a user-defined value of 8006. The parameter for -publicagentport uses the special value 0, which is copied from -privateagentport. The parameter for -privatetransferport uses the special value 0, which is taken from the Agent configuration. The parameter for -publictransferport uses the special value 0, which is copied from -privatetransferport: 

>Start-AzureDeploy -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -deploymentname Deploy1 -destinationcontainer container1 -subscriptionid "111111-22222-33333-4444-555555" -cloudservicename Service1 -vmname VirtualMachine -vmsize A0 -privateagentport 8006 -publicagentport 0 -privatetransferport 0 -publictransferport 0

Deploy data to Azure using all available disks: 

>Start-AzureDeploy -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -deploymentname Deploy1 -destinationcontainer container1 -subscriptionid "111111-22222-33333-4444-555555" -cloudservicename Service1 -vmname VirtualMachine -vmsize A0 -privateagentport 8006 -publicagentport 0 -privatetransferport 0 -publictransferport 0 -Volumes all

Start-AzureExport

You can use the Start-AzureExport cmdlet to force the virtual export of data from a protected machine to a Microsoft Azure virtual server.

Usage

The usage for the command is as follows: 

Start-AzureExport -core [host name] -user [user name for Core] -password [password for Core] -protectedserver [name | IP address] -volumes [volume names | all] -rpn [number | numbers] -time [time string] -cloudaccountname [Azure account name] -storageaccountname[ storage account name] -containername [container name] -foldername [folder name] -deploymentname [deployment name] -destinationcontainer [Azure destination container] -subscriptionid [Azure subscription ID] -cloudservicename [cloud service name] -vmname [virtual machine name] -vmsize [virtual machine size] -endpointname [rdp | ssh] -protocol [tcp | udp] -publicremoteaccessport [public remote access port number] -privateremoteaccessport [private port number]
Command Options

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

Table 181: Start-AzureExport 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 for the deploy. If you use the value all or use no value, the all volumes deploy. 
-rpn
 Optional. The sequential number of a recovery point that you want to export (use the /list rps command to get the numbers). If neither -time nor -rpn is specified, then the most recent recovery point is exported. 
-time
 Optional. This option determines the recovery points to select for export. 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 time value of the time zone set on your PC. If neither -time nor -rpn is specified, then the most recent recovery point is exported. 
-cloudaccountname
 Optional, if the -storageaccountname is specified. Specify the Azure cloud account name. 
-storageaccountname
 Optional, if the -cloudaccountname is specified. Specify the Azure storage account name. 
-containername
 The name of the Azure container. 
-foldername
 Optional. The name of the Azure folder. 
-deploymentname
 Use this option to specify the name of the deployment. It is required for a deploy after export only. 
-destinationcontainer
 The name of the Azure destination container you want to use for the deploy. 
-subscriptionid
 The Azure subscription ID. It is required for a deploy after export only. 
-cloudservicename
 The name of the Azure cloud service. It is required for a deploy after export only. 
-vmname
 The name of the virtual machine. It is required for a deploy after export only. 
-vmsize
 The size of the virtual machine; for example, A0, Basic_A4, or Standard_G1. 
-endpointname
 The Azure endpoint protocol used only for remote access rdp or ssh. The default value is rdp. It is required for a deploy after export only. 
-protocol
 The protocol used only for remote access tcp or udp. It is required for a deploy after export only. The default value is tcp. 
-publicremoteaccessport
 The public port for using remote access. The default value is 3389. 
-privateremoteaccessport
 The private port for using remote access. The default value is 3389. 
-privateagentport
 Optional. The Agent port. If the port value is 0, then the value is determined by the Agent configuration.

NOTE: If neither the parameter -publicagentport nor -privateagentport is specified, then no endpoint is added. 

-publicagentport
 Optional. The external Agent port. If the port value is 0, then the value is determined by the Agent configuration.

NOTE: If neither the parameter -publicagentport nor -privateagentport is specified, then no endpoint is added. 

-privatetransferport
 Optional. The TCP port upon which to accept connections from the Core for the transfer of data from the Agent. If the port value is 0, then the value is determined by the Agent configuration.

NOTE: If neither the parameter -publicagentport nor -privateagentport is specified, then no endpoint is added. 

-publictransferport
 Optional. The external TCP port upon which to accept connections from the Core for the transfer of data from the Agent. If the port value is 0, then the value is determined by the Agent configuration.

NOTE: If neither the parameter -publictransferport nor -privatetransferport is specified, then no endpoint is added.

Examples:

Export data to Azure: 

>Start-AzureExport -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -cloudaccountname "Cloud Account 1" -containername "mycontainer" -foldername "folder" -deploymentname Deploy1 -destinationcontainer container1 -subscriptionid "111111-22222-33333-4444-555555" -cloudservicename Service1 -vmname VirtualMachine -vmsize A0

Export data to Azure using a specified endpoint: 

>Start-AzureExport -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -cloudaccountname "Cloud Account 1" -containername "mycontainer" -foldername "folder" -deploymentname Deploy1 -destinationcontainer container1 -subscriptionid "111111-22222-33333-4444-555555" -cloudservicename Service1 -vmname VirtualMachine -vmsize A0 -endpointname ssh -protocol udp -publicremoteaccessport 1555 -privateremoteaccessport 22

Export data to Azure with a specified Agent endpoint when the -privateagentport option uses the special value 0, which is taken from the Agent configuration. The -publicagentport option has the user-defined value of 1888: 

>Start-AzureExport -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -cloudaccountname "Cloud Account 1" -containername "mycontainer" -deploymentname Deploy1 -destinationcontainer container1 -subscriptionid "111111-22222-33333-4444-555555" -cloudservicename Service1 -vmname VirtualMachine -vmsize A0 -privateagentport 0 -publicagentport 1888

Export data to Azure with specified Agent and transfer endpoints. The -privateagentport option has the user-defined value of 8006. The parameter for -publicagentport uses the special value of 0, which is copied from the -privateagentport option. The parameter for -privatetransferport uses the special value of 0, which is taken from the Agent configuration. The parameter for -publictransferport uses the special value 0, which is copied from the -privatetransferport option.: 

>Start-AzureExport -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -cloudaccountname "Cloud Account 1" -containername "mycontainer" -foldername "folder" -deploymentname Deploy1 -destinationcontainer container1 -subscriptionid "111111-22222-33333-4444-555555" -cloudservicename Service1 -vmname VirtualMachine -vmsize A0 -privateagentport 8006 -publicagentport 0 -privatetransferport 0 -publictransferport 0

Start-BackupSettings

The Start-BackupSettings cmdlet lets you start backing up the settings for the local Core.

Usage

The usage for the command is as follows: 

Start-BackupSettings -local path [local path]
Command Options

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

Table 182: Start-BackupSettings command options
Option Description 
-?
 Display this help message. 
-localpath
 The path of where you want to store the configuration backup.
Examples:

Back up your settings of the Core: 

>Start-BackupSettings -localpath D:\work\archive

Start-ChecksumCheck

The Start-ChecksumCheck PowerShell cmdlet lets you force a checksum check of Exchange Server recovery points.

Usage

The usage for the command is as follows: 

Start-ChecksumCheck -core [host name] -user [login] -password [password] -protectedserver [name | IP address] -rpn [number | numbers] | -time [time string]
Command Options

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

Table 183: Start-ChecksumCheck 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
 The name of the protected machine. 
-rpn
 Optional. Only for chain deletion (base image with chain of incrementals or orphaned points). The sequential number of a recovery point to check (use the Get-RecoveryPoints command to obtain the numbers). You can specify several space-separated numbers to delete multiple recovery points with a single command. 
-time

Optional. Select the recovery point to check by its creation time, instead of its sequential number. 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 date and time values of the time zone set on your computer.

Examples:

Start a checksum check on two recovery points.: 

> Start-ChecksumCheck -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22 -rpn 5 7
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating