Rapid Recovery 6.9 - Commands and Scripting Reference Guide

Introduction to Rapid Recovery Command Line Management utility

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

Localization

PowerShell module

Prerequisites for using PowerShell

powershell.exe.config

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

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

PowerShell module > Rapid Recovery PowerShell module cmdlets > Remove-RemoteMounts

The Remove-RemoteMounts command dismounts all remotely mounted recovery points.

Usage

The usage for the command is as follows:

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

Command Options

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

Table 147: Remove-RemoteMounts 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 remotely mounted recovery points:

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

Remove-Replication

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

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:

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 148: 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.

Example:

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 command deletes a Rapid Recovery 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 149: 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.

Example:

Remove all repositories on the local Core:

>Remove-repository -all

Remove-ScheduledArchive

PowerShell module > Rapid Recovery PowerShell module cmdlets > Remove-ScheduledArchive

If you scheduled Rapid Recovery to regularly archive recovery points for a specific machine, you can use the Remove-ScheduledArchive PowerShell command to remove that scheduled archive from the Core.

Usage

The usage for the command is as follows:

Remove-ScheduledArchive -core [host name] -user [login] -password [password] -all -ids [id | id1 id2]

Command Options

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

Table 150: Remove-ScheduledArchive 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.
-all	Remove all archives associated with this Core.
-id	The identifier of the archive that you want to remove. To list more than one archive, separate each ID with a space.

Example:

Remove several scheduled archives from the local Core:

>Remove-ScheduledArchive -ids 799138c8-3dfc-4398-9711-1823733c2a31, 26c29bb7-b320-47f5-b5a8-dffc49f50e25

请选择您的产品：

为向您提供更好的服务，请填写'Purpose of your Chat'（联系目的）：

针对您的问题建议的解决方案

Rapid Recovery 6.9 - Commands and Scripting Reference Guide

Remove-RemoteMounts

Usage

Command Options

Example:

Remove-Replication

Usage

Command Options

Example:

Remove-Repository

Usage

Command Options

Example:

Remove-ScheduledArchive

Usage

Command Options

Example: