立即与支持人员聊天
与支持团队交流

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

Edit-ActiveBlockMapping

The Edit-ActiveBlockMapping cmdlet lets you make changes to the Active Block Mapping settings for a specified protected machine.

Usage

The usage for the command is as follows: 

Edit-ActiveBlockMapping -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -enable | -disable [enable/disable feature] -swapfiles [enable | disable] -subdirectories [enable | disable] -usedefaultsettings [enable | disable]
Command Options

The following table describes the options available for the Edit-ActiveBlockMapping command:

Table 88: Edit-ActiveBlockMapping 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
 Use this option to edit the vCenter or ESXi objects for a specific protected machine. 
-enable
 Optional. The enable option does not change the settings for swap files and exclusion lists; it turns Active Block Mapping on. If swap files are off and the exclusion list is empty, using the enable option alone only ignores the blocks of deleted files. 
-disable
 Optional. The disable option does not change the settings for swap files and exclusion lists; it turns Active Block Mapping off so all blocks are backed up, including swap files and excluded paths. If you call the enable option later, the Core uses the same settings for swap files and exclusion lists. 
-swapfiles
 Optional. 'Enable' and 'disable' values determine whether to block swap files from exclusion. 
-subdirectories
 Optional. 'Enable' and 'disable' values determine whether to exclude child items. 
-usedefaultsettings
Optional. 'Enable' and 'disable' values determine whether to use the parent server settings.
Examples:

Enable Active Block Mapping so that swap files are excluded from backups of machine 10.10.8.150: 

>Edit-ActiveBlockMapping -protectedserver 10.10.8.150 -enable -swapfiles enable

Reverse the previous command so that Active Block Mapping is enabled and swap files are included in backups of machine 10.10.8.150: 

>Edit-ActiveBlockMapping -protectedserver 10.10.8.150 -enable -swapfiles disable

Edit-AzureVirtualStandby

You can use the Edit-AzureVirtualStandby cmdlet to change the parameters of an existing Azure virtual standby continuous export.

Usage

The usage for the command is as follows: 

Edit-AzureVirtualStandby -core [host name] -user [user name for Core] -password [password for Core] -protectedserver [name | IP address] -volumes [volume names | all] -containername [container] -foldername [folder name] -subscriptionid [Azure subscription ID] -forceedit
Command Options

The following table describes the options available for the Edit-AzureVirtualStandby command:

Table 89: Edit-AzureVirtualStandby 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. 
-protectedserver
 Protected machine with recovery points that you want to export. 
-volumes
 Optional. List of additional volume names to be exported. If you use the value all or use no value, then all volumes export. Values must be enclosed in double quotes and separated by a space.

NOTE: Do not use trailing slashes in volume names; for example, use "c:" "d:".

-containername
 The name of the container in the Azure storage account (classic). The name must container between three and 63 characters (lowercase letters, numbers, and hyphens only), and start with a letter or a number. Every hyphen must be preceded and followed by a letter or number. 
-foldername
 Optional. The name of a folder inside of the Azure storage container. A folder name cannot contain any of the following characters: \ / : * ? " < > |. 
-subscriptionid
 The identifier of a previously added Azure subscription. 
-forceedit
 Optional. This option lets you delete existing export files when you change an export location.
Examples:

Edit an Azure virtual standby export: 

>Edit-AzureVirtualStandby -protectedserver 10.10.5.22 -subscriptionid "111111-22222-33333-4444-555555" -containername container1 -foldername folder2

Edit-EsxiVirtualStandby

The Edit-EsxiVirtualStandby command lets you use PowerShell to make changes to an existing virtual export to an ESXi virtual machine (VM).

Usage

The usage for the command is as follows: 

Edit-EsxiVirtualStandby [-HostName <String>] [-HostPort <String>] [-HostUserName <String>] [-HostPassword <String>] [-DiskProvisioning <String>] [-DiskMapping <String>] [-ProtectedServer <String>] [-Volumes <String[]>] [-VMName <String>] [-UseSourceRam] [-Ram <String>] [-User <String>] [-Core <String>] [-Password <String>] [-Verbose] [-Debug] [-ErroAction<ActionPreference>] [-WarningAction<ActionPreference>] [-ErrorVariable String>] [-WarningVariable <String> [-OutVariable <String>] [-OutBuffer <Int32>]
Command Options

The following table describes the options available for the Edit-EsxiVirtualStandby command:

Updated option descriptions TK.

Table 90: Edit-EsxiVirtualStandby 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
 Show jobs for a specific protected machine, indicated by IP address. 
-all
 Show all jobs, including those performed by the Core and all protected servers. 
-number
 Optional. Determine how many records to display. available values are:

all (display all jobs); l[number] or [number] (fetches ## most recent jobs sorted by execution and time); f[number] (displays first ## recovery jobs sorted by execution and time). By default, the 20 most recent jobs are shown. 

-jobtype
 Optional. Specifies the job type filter. Available values are: 'transfer' (data transfer), 'repository' (repository maintenance), 'replication' (local and remote replications), 'backup' (backup and restore), 'bootcdbuilder' (create boot CDs), 'diagnostics' (upload logs), 'exchange' (Exchange Server files check), 'export' (recovery point export), 'pushinstall' (deploy agents), 'rollback' (restoring from a recovery point), 'rollup' (recovery point rollups), 'sqlattach' (agent attachability checks), and 'mount' (mount repository). By default, all jobs of the specified type are returned. 
-time
 Optional. Filter output by date and time for the job started. Available types of input include:

#d or DD (where # is a number for the period of time of days before now until now)

#h or #H (where # is number for the period of hours before now until now)

“time date 1”, “time date 2” (to show a custom range of time from a specific date appearing before the comma to a specific date following the comma).

Examples:

Lists all active jobs on the local Core: 

>Get-activejobs –all

Edit-EsxServerProtectionRules

The Edit-EsxServerProtectionRules cmdlet lets you edit the protection rules for a specified ESXi server.

Usage

The usage for the command is as follows: 

Edit-EsxServerProtectionRules -protectedserver [name | IP address] -protectionrules [protection rule names collection | all | none]
Command Options

The following table describes the options available for the Edit-EsxServerProtectionRules command:

Table 91: Edit-EsxServerProtectionRules command options
Option Description 
-?
 Display this help message. 
-protectedserver
 Use this option to edit the rules for a specific protected machine. 
-protectionrules

Use a comma to separate a list of protection rules to add or remove.

Supported protection rules include:

  • ProtectOrphaned
  • ProtectWithRecoveryPoints
  • ProtectAgentlessly
  • ProtectPairedToAnotherCore
  • DeleteOldSnapshots.

Common protection rules settings include:

  • -ProtectionRules all: All available protection rules will be set to 'true.'
  • -ProtectionRules none: All protection rules will be cleared or set to 'false.'
  • -ProtectionRules [one or more rules]: The provided rules will be 'true,' while all other rules will be 'false.'
Examples:

Set the ProtectAgentlessly and ProtectPairedToAnotherCore porotection rules to 'true' for the server 10.10.10.10, making all other rules 'false:' 

>Edit-EsxServerProtectionRules -protectedserver 10.10.10.10 -protectionrules ProtectAgentlessly, ProtectPairedToAnotherCore
相关文档

The document was helpful.

选择评级

I easily found the information I needed.

选择评级