Chat now with support
Chat mit 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

Localization

When running on the same machine on which Rapid Recovery Core is installed, the Rapid Recovery PowerShell module bases its display language on the language set for the Core. Localized Rapid Recovery versions such as this one support English, Chinese (Simplified), French, Korean, German, Japanese, Portuguese (Brazil), and Spanish.

Qualifiers

The following table describes the qualifiers available for Rapid Recovery PowerShell Module.

Table 216: Rapid Recovery PowerShell module qualifiers
Qualifier Usage 
-core <Rapid Recovery Core Name>
 Host name of the Core.

Default: Localhost

-ProtectedServer <Protected Server Name>
 Host name/IP address of the Rapid Recovery Agent

Default: Localhost if multiple servers protected, otherwise the single server protected. 

-Mode <READ, READWRITE, WRITE>
 Recovery Point Mount mode.

Default: Read. 

-Volumes <Snapshot Volume Letter>
 Snapshot volume letter from Rapid Recovery Agent.

Default: All. 

-User <User Name>
 User name used to connect to the Rapid Recovery Core.

This is typically the service user. 

-Domain <Domain Name>
 Domain to which the user defined in /User belongs. 
-Password <Password>
 Password of the user defined in /User. 
-Path <Target path to mount, dismount 
recovery points or archive location>
 For example: C:\RapidRecoveryMount.

Scripting

Rapid Recovery enables administrators to automate the administration and management of resources at certain occurrences through the execution of commands and scripts. The Rapid Recovery software supports the use of PowerShell scripting for Windows and Bourne shell and Bash scripting for Linux.

Core jobs are automatically created whenever you initiate operations on the Rapid Recovery Core such as replication, virtual export, or a backup transfer. You can extend these jobs by running a script before it or after it. These are known as pre- and post- scripts.

This section describes the scripts that can be used by administrators at designated occurrences in Rapid Recovery for Windows and Linux.

Caution: The sample PowerShell and shell scripts provided in this document will function when run as designed by qualified administrators. Take precautions when modifying functioning scripts to retain working versions. Any modifications to the script samples included here, or any scripts you create, are considered customization, which is not typically covered by Quest Data Protection Support.

Using PowerShell scripting with Rapid Recovery

Windows PowerShell is a Microsoft .NET Framework-connected environment designed for administrative automation. Rapid Recovery includes comprehensive client software development kits (SDKs) for PowerShell scripting that lets administrative users run user-provided PowerShell scripts at designated occurrences; for example, before or after a snapshot, attachability and mountability checks, and so on. Administrators can run scripts from both the Rapid Recovery Core and the protected machine. Scripts can accept parameters, and the output of a script is written to Core and protected machine log files.

NOTE: For nightly jobs, preserve one script file and the JobType input parameter to distinguish between nightly jobs.

Windows PowerShell must be installed before running Rapid Recovery scripts.

Script files are located in the %AllUsersProfile%\AppRecovery\Core\PowerShellScripts folder, typically c:\Program Files\AppRecovery\Core\PowerShellScripts.

For more information on how using PowerShell scripts see Sample PowerShell scripts, Input Parameters for PowerShell Scripting, Input parameters for shell scripting, and Sample shell scripts.

Prerequisites for PowerShell scripting

Before running PowerShell scripts for Rapid Recovery, you must have Windows PowerShell 4.0 or later installed. Some users find Windows PowerShell ISE to be easier to work with. This tool is included with Windows. When typing cmdlets, the built-in help for PowerShell ISE lists relevant cmdlets, anticipating your keystrokes and letting you select the appropriate command.

Testing PowerShell Scripts

If you want to test the scripts you plan to run, you can do so by using the PowerShell graphical editor, powershell_is.

Caution: If a PowerShell pre- or post- script fails, the related job also fails.

Localization

When running on the same machine on which Rapid Recovery Coreis installed, the Rapid Recovery PowerShell module bases its display language on the language set for the Core. Localized Rapid Recovery versions such as this one support English, Chinese (Simplified), French, Korean, German, Japanese, Portuguese (Brazil), and Spanish.

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen