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

PowerShell Module

Rapid Recovery consists of several software components. Key components relevant to this topic include the following:

  • The Rapid Recovery Core manages authentication for protected machines, schedules for transferring data for backup and replication, export to virtual machines, reporting, and bare metal restore (BMR) to similar or dissimilar hardware.
  • The Rapid Recovery Agent is responsible for taking volume snapshots and for fast transfer of the data to the repository managed by the Core.
  • The Rapid Recovery PowerShell module is a Windows utility that lets users interact with the Core server by using Windows PowerShell® scripts. This module offers some of the same functionality that the Rapid Recovery Core Console graphic user interface (GUI) provides. For example, the Rapid Recovery PowerShell module can mount Rapid Recovery recovery points or force a snapshot of a protected machine.

Figure 2: The PowerShell module interacts with the Rapid Recovery Core

PowerShell is a Microsoft .NET Framework-connected environment designed for administrative automation. This section describes the Rapid Recovery PowerShell module and the cmdlets administrators can use to script certain functions without interaction with the Rapid Recovery Core GUI.

NOTE: You can also run PowerShell scripts as pre- and post- scripts. For more information and sample scripts, see Scripting.

The Rapid Recovery PowerShell module is automatically installed and registered when you install the Rapid Recovery Core. The module is installed in your Windows system directory in the path: [Environment.SystemDirectory]\WindowsPowerShell\v1.0\Modules\RapidRecoveryPowerShellModule. For example, for a 64-bit OS, it is installed in C:\Windows\System32\WindowsPowerShell\v1.0\Modules\RapidRecoveryPowerShellModule. When using the module, run PowerShell as an Administrator.

Prerequisites for using PowerShell

Before using the Rapid Recovery PowerShell module, you must have Windows PowerShell 4.0 or later installed. Some users find Windows PowerShell Integrated Scripting Environment (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.

Working with commands and cmdlets

Cmdlets are specialized commands in a Windows PowerShell script that perform a single function. A cmdlet is typically expressed as a verb-noun pair. The result returned by a cmdlet is an object.

You can pipeline PowerShell commands, which enables the output of one cmdlet to be piped as input to another cmdlet. As a simple example, you can request the list of commands in the Rapid Recovery PowerShell module, and sort that list by name. The example script for this is: 

Get-Command -module rapidrecoverypowershellmodule | sort-object name
Getting cmdlet help and examples

After you open PowerShell, you can request additional information at any time by using the Get-Help cmdlet. For example, to get information about the virtual machine export cmdlet, enter the following cmdlet and then press [Enter]: 

>Get-Help Start-VMExport

The object returned includes the command name, synopsis, syntax, and any options you can use with the command.

Command options

For more information about the specified command, you can append the following command options to the command syntax listed above:

Table 80: Get-Help command options
Option Description 
-examples
 Optional. Shows cmdlet name, synopsis, and usage examples of the specified cmdlet. 
-detailed
 Optional. Shows cmdlet name, synopsis, syntax, description, parameters, and remarks. 
-full
 Optional. In addition to the information listed above for the specified cmdlet, this option shows technical information such as inputs, outputs, notes, and related links.
Examples

Get basic help information for the Start-VMExport cmdlet using the Get-Help cmdlet:

>Get-Help Start-VMExport

Get basic help information for the Start-VMExport cmdlet:

>Start-VMExport -?

Show the name, synopsis, and usage examples for the Start-VMExport cmdlet:

>Get-Help Start-VMExport -examples

Shows cmdlet name, synopsis, syntax, description, parameters, and remarks for the Start-VMExport cmdlet:

>Get-Help Start-VMExport -detailed

Shows the full set of detailed and technical information for the Start-VMExport cmdlet:

>Get-Help Start-VMExport -full

Rapid Recovery PowerShell module cmdlets

This section describes the cmdlets and options available in the Rapid Recovery PowerShell Module. All cmdlets in the Rapid Recovery PowerShell Module support the following common parameters:

  • Verbose
  • Debug
  • ErrorAction
  • ErrorVariable
  • WarningAction
  • WarningVariable
  • OutBuffer
  • OutVariable

For more information, use Get-Help about_commonparameters.

Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen