Chat now with support
Chat with Support

Rapid Recovery 6.7 - 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

Set-ReplicationResponse

Use the Set-ReplicationResponse command to manage pending replication requests.

Usage

The usage for the command is as follows: 

Set-ReplicationResponse -core [host name] -user [user name] -password [password] -id [replication ID] -accept | -deny | -ignore -protectedserver [name | IP address]

Command Options

The following table describes the options available for the Set-ReplicationResponse command:

Table 159: Set-ReplicationResponse 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 must also provide a password. If none is provided, then the credentials for the logged-on user are 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 is provided, then the credentials for the logged-on user are used 
-id
 The identifier for the replication job or pending replication request. It can be a remote Core ID, host name, customer ID, email address, or pending replication request ID. 
-accept
 Accepts the replication request. 
-deny
 Denies the replication request. 
-ignore
 Ignores the replication request. 
-protectedserver
 When responding to a replication request, use this option to apply your response to list of protected servers with a repository name or ID. Use the parameter "all" to apply response to all requested machines.

Examples:

Accept a pending replication request for one protected machines: 

>Set-ReplicationResponse -id customer@email.address -accepted -protectedserver 10.10.1.1 Repository1 10.10.1.2 Repository2 -responsecomment A response comment

Deny a pending replication request: 

>Set-ReplicationResponse -id customer@email.address -deny

Start-Archive

Businesses often use long-term storage to archive both compliant and non-compliant data. The archive feature in Rapid Recovery is used to support the extended retention for compliant and non-compliant data. The administrator can save an archive on the local storage or network location by specifying the /Path command and credentials.

Usage

The usage for the command is as follows: 

Start-Archive -path -startdate -enddate [-all] | -protectedserver [machine name] or [IP]] -core [host name] -user [user name] -password [password]

Command Options

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

Table 160: Start-Archive command options
Option Description 
-?
 Display this help message. 
-path
 Location path. Example path: ‘D:\work\archive’ or network path: ‘\\servername\sharename’. 
-all
 Archive recovery points for all machines on the Core. 
-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. 
-startdate
 Start date of the date range for the created recovery points. Should be in the format specified by the OS on the current PC. 
-enddate
 End date of the date range. Defaults to the current time. 
-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 recovery points for the specified 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. 
-archiveusername
 Optional. Required for network path only. 
-archivepassword
 Optional. Required for network path only. 
-comment
 Optional. Example: -comment 'Before install new application'.

Example:

Archive all recovery points for all machines on the Core: 

>Start-Archive -path D:\work\archive -startdate 'Example 04/30/2012' –all

Start-AttachabilityCheck

The Start-AttachabilityCheck command forces an attachability check for all SQL Server databases protected by the Core.

Usage

The usage for the command is as follows: 

Start-AttachabilityCheck -core [host name] -user [username] - password [password] 
- protectedserver [machine name | IP address] -rpn [number | numbers] | -time [time string]

Command Options

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

Table 161: Start-AttachabilityCheck 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
 The protected machine on which to perform the SQL attachability check. 
-rpn
 Optional. The sequential number of a recovery point on which to perform the SQL attachability check.

You can use the -GetRecoveryPoints command to obtain recovery point numbers. You can specify several space-separated numbers to perform the checks against multiple recovery points with a single command.

Note: If neither ‘time’ nor ‘rpn’ option is specified in this command, than the most recent recovery point is used for the attachability check. 
-time
 Optional. Determines recovery point to be selected for SQL attachability check. 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.

Example:

Perform a SQL attachability check on the most recent recovery point for the specified protected SQL server: 

>Start-AttachabilityCheck - protectedserver 10.10.9.120

Start-AzureDeploy

You can use the Start-AzureDeploy command to export a virtual machine (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 162: 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 -publictransferport nor -privatetransferport 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
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating