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

Remove-Mount

The Remove-Mount command dismounts a mounted recovery point specified by the /Path. Dismount points for the selected machine using the -protectedserver parameter or dismount points for all the mounted recovery points by using the -all parameter.

Usage

The usage for the command is as follows: 

Remove-Mount -core [host name] -user [user name] -password [password] [-protectedserver [machine name] | -path [mount path]]

Command Options

The following table describes the options available for the Remove-Mount command:

Table 143: Remove-Mount command options
Option Description 
-?
 Display this help message. 
-all
 Dismount all mounted recovery points. 
-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 log on.

If none are provided, then the logged-on user's credentials will be used. 

-path
 Dismount selected mount point. 
-protectedserver
 Dismount all mounted recovery points for the current protected 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.

Example:

Dismount the recovery point specified by the path: 

>Remove-Mount -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -path C:\mountedRecoveryPoint

Remove-Mounts

The Remove-Mounts command dismounts all mounted recovery points.

Usage

The usage for the command is as follows: 

Remove-Mounts -core [host name] -user [user name] -password [password]

Command Options

The following table describes the options available for the Remove-Mounts command:

Table 144: Remove-Mounts 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. 
-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. 
-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:

Dismount all recovery points on the specified Core: 

>Remove-Mounts -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd

Remove-RecoveryPoints

The Remove-RecoveryPoints PowerShell command lets you delete recovery points for a specific machine.

Usage

The usage for the command is as follows: 

Remove-RecoveryPoints -core [host name] -user [login] -password [password] -[range | chain | all] -protectedserver 
    [name | IP address] -rpn [number | numbers] | -time [time string | time interval specified by two time strings]

Command Options

The following table describes the options available for the Remove-RecoveryPoints command:

Table 145: Remove-RecoveryPoints 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
 Dismount all mounted recovery points for the current 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 be deleted (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
 Use this option to delete a chain of recovery points.

Optional. To delete a single recovery point, select the recovery point by its creation time. 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.

Required. For a date range, specify a time interval using two time strings separated by coma and space to select the range of recovery points to delete. 

-range
 Optional. The range of recovery points to delete by time interval. 
-chain
 Optional. A base image with sequential incrementals or a sequential set of orphaned points to delete selected by recovery point number or time of recovery point creation. 
-all
 Optional. Delete all protected machines from the Core.

Example:

Delete the recovery point specified by the date: 

>Remove-RecoveryPoints -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -time "2/24/2012 09:00 AM"

Remove-RemoteMount

The Remove-RemoteMount command dismounts a remotely mounted recovery point.

Usage

The usage for the command is as follows: 

Remove-RemoteMount -core [host name] -user [user name] -password [password] [-protectedserver [machine name] | -path [mount path]]

Command Options

The following table describes the options available for the Remove-RemoteMount command:

Table 146: Remove-Mount command options
Option Description 
-?
 Display this help message. 
-all
 Dismount all mounted recovery points. 
-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 log on.

If none are provided, then the logged-on user's credentials will be used. 

-path
 Dismount selected mount point. 
-protectedserver
 Dismount all mounted recovery points for the current protected 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.

Examples:

Dismount the remotely mounted recovery point by a specified path: 

>Remove-RemoteMount -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -path C:\mountedRecoveryPoint

Dismount all remotely mounted recovery points for a specified protected server:

>Remove-RemoteMount -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver "11.11.11.11"
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating