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

DeleteReplication

This command lets you remove a replication configuration from a source Core or target Core, as well as remove replicated recovery points.

Usage

The usage for the command is as follows: 

/deletereplication -incoming [replication IDs] -outgoing [replication IDs] -deleterecoverypoints
Command Options

The following table describes the options available for the DeleteReplication command:

Table 14: DeleteReplication 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. 
-incoming
 The identifier (ID) of the incoming replication that should be deleted. It could be a remote Core ID or a host name. Use the word "all" to delete all replications.

Note: You can specify different protected machines for different replications by using the following pattern: Replication1:Agent1,Agent2;Replication2:Agent2,Agent3. If you do not specify a machine after the colon (:), the replication is deleted for all replicated machines. 

-outgoing
 The identifier (ID) of the outgoing replication that should be deleted. It could be a remote Core ID or a host name. Use the word "all" to delete all replications.

Note: You can specify different protected machines for different replications by using the following pattern: Replication1:Agent1,Agent2;Replication2:Agent2,Agent3. If you do not specify a machine after the colon (:), the replication is deleted for all replicated machines. 

-deletepoints
 Specify which recovery points, if any, of the replicated machine that you want to remove.
Example:

Delete all incoming and all outgoing replications: 

>cmdutil /deletereplication -incoming all -outgoing all

Delete two outgoing replications with all machines: 

>cmdutil /deletereplication -outgoing TargetCore1;TargetCore2

Delete one protected machine from incoming replication and delete recovery points: 

>cmdutil /deletereplication -incoming TargetCore1:10.10.10.10 -deletepoints

DeleteRepository

You can use the DeleteRepository command to remove an entire DVM repository created in AppAssure Core or Rapid Recovery Core.

Usage

The usage for the command is as follows: 

/deleterepository -core [host name] -user [user name] -password [password] name] -name [repository name] | -a [all repositories]
Command Options

The following table describes the options available for the DeleteRepository command:

Table 15: DeleteRepository 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. 
-a
 Optional. This option deletes all DVM repositories associated with the Core. 
-name
 The name of the DVM repository you want to delete.
Example:

Delete all DVM repositories: 

>cmdutil /deleterepository -a

Delete the repository with the name "RepositoryName:" 

>cmdutil /deleterepository -name RepositoryName

DeployToAzure

You can use the deploytoazure command to export a virtual machine (VM) to a Microsoft Azure cloud account.

Usage

The usage for the command is as follows: 

/deploytoazure -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 DeployToAzure command:

Table 16: DeployToAzure 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.

Example:

Deploy data to Azure: 

>cmdutil /deploytoazure -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: 

>cmdutil /deploytoazure -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: 

>cmdutil /deploytoazure -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: 

>cmdutil /deploytoazure -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

Dismount

Use the dismount command to dismount a mounted recovery point specified by the -path option, dismount points for the selected agent by the -protectedserver parameter, or dismount all mounted recovery points—-all.

Usage

The usage for the command is as follows: 

/dis[mount] -core [host name] -user [user name] -password [password] [-all | -protectedserver [name | IP address] | -path [location]
Command Options

The following table describes the options available for the dismount command:

Table 17: Dismount 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. 
-all
 Dismount all mounted recovery points. 
-protectedserver
 Dismount all mounted recovery points for current agent. 
-path
 Dismount selected mount point.
Example:

Dismount a recovery point that was mounted to folder c:\mountedrecoverypoint: 

>cmdutil /dismount -core 10.10.10.10 -user administrator -password 23WE@#$sdd -path c:\mountedRecoveryPoint
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating