Rapid Recovery 6.3 - Command Line and Scripting Reference Guide

AddEncryptionKeytoProtectedMachine ApplyLicense Archive BackupSettings CancelActiveJobs CheckRepository ConfigureAgentMigration CreateArchiveRepository CreateBootCD CreateEncryptionKey CreateRepository CredentialsVaultAccount DedupCacheConfig DeleteReplication DeleteRepository DeployToAzure Dismount DismountArchiveRepository EditActiveBlockMapping EditEsxServer EditExcludedFilesandFolders EditHyperVCluster EditHyperVServer EditOracleDBVerifyNightlyJob EditOracleLogTruncationNightlyJob EnableOracleArchiveLogMode ExportRMANBackup FileSearch Force ForceAttach ForceChecksum ForceLogTruncation ForceMount ForceOptimizationJob ForceReplication ForceRollup ForceScheduledArchive ForceVirtualStandby GetOracleInstanceMetadata Help List ListAzureVMSizes ListOracleInstances Mount MountArchiveRepository NewCloudAccount OpenDvmRepository Pause Protect ProtectCluster ProtectEsxServer ProtectHyperVCluster ProtectHyperVServer RemoveAgent RemoveArchiveRepository RemoveEncryptionKey RemovePoints RemoveScheduledArchive RemoveVirtualStandby Replicate Replication RestartCoreService RestoreAgent RestoreArchive RestoreSettings RestoreUrc Resume ResumeScheduler SeedDrive SetAgentMetadataCredentials SetOracleMetadataCredentials StartExport StartExportAzure StartOracleDBVerifyJob StartOracleLogTruncationJob StopCoreService SuspendScheduler UpdateRepository Version VirtualStandby

Localization

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

Using PowerShell scripting with Rapid Recovery

Qualifiers Input Parameters for PowerShell Scripting Sample PowerShell scripts

PreTransferScript.ps1 PostTransferScript.ps1 PreExportScript.ps1 PostExportScript.ps1 PreNightlyJobScript.ps1 PostNightlyJobScript.ps1

Using Bourne shell and Bash scripting with Rapid Recovery

Input parameters for shell scripting Sample shell scripts

PreTransferScript.sh PostTransferScript.sh PreSnapshotScript.sh PostSnapshotScript.sh PostExportScript.sh

Remove-Mounts

PowerShell Module > Rapid Recovery PowerShell module cmdlets > 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 160: 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.

Examples:

Dismount all recovery points on the specified Core:

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

Remove-RecoveryPoints

PowerShell Module > Rapid Recovery PowerShell module cmdlets > 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 161: 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.

Examples:

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

PowerShell Module > Rapid Recovery PowerShell module cmdlets > Remove-Replication

This cmdlet 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:

Remove-Replication -core [host name] -user [user name] -password [password] -incoming [host name] -outgoing [host name] -deletepoints

Command Options

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

Table 162: Remove-Replication 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.

Examples:

Delete all incoming and all outgoing replications:

>Remove-Replication -incoming all -outgoing all

Delete two outgoing replications with all machines:

>Remove-Replication -outgoing TargetCore1;TargetCore2

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

>Remove-Replication -incoming TargetCore1:10.10.10.10 -deletepoints

Remove-Repository

PowerShell Module > Rapid Recovery PowerShell module cmdlets > Remove-Repository

The Remove-Repository PowerShell cmdlet deletes a DVM repository and its contents from the Core.

Usage

The usage for the command is as follows:

Remove-Repository -core [host name] -user [login] -password [password] -name [repository name] -all

Command Options

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

Table 163: Remove-Repository 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.
-name	The name of the repository that you want to delete.
-all	Delete all repositories associated with this Core.

Examples:

Remove all repositories on the local Core:

>Remove-repository -all

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

Rapid Recovery 6.3 - Command Line and Scripting Reference Guide

Remove-Mounts

Usage

Command Options

Examples:

Remove-RecoveryPoints

Usage

Command Options

Examples:

Remove-Replication

Usage

Command Options

Examples:

Remove-Repository

Usage

Command Options

Examples: