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

Edit-ExcludedFilesAndFolders

The Edit-ExcludedFilesAndFolders cmdlet lets you change the list of path that you want Rapid Recovery to ignore during backup for the specified machine.

Usage

The usage for the command is as follows: 

/editexcludedfilesandfolders -core [host name] -user [user name] -password [password name] -protectedserver [name | IP address] -addpath | -removepath [excluded paths collection] -addvolume | -removevolume [excluded volumes collection]]
Command Options

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

Table 92: Edit-ExcludedFilesAndFolders 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. 
-addpath
 Optional. Add specific files or folders to the list of paths to ignore. 
-addvolume
 Optional. Add a specific volume to the list of paths to ignore.
-removepath
 Optional. Remove specific files or folders from the list of paths to ignore. 
-removevolume
Optional. Remove a specific volume from the list of paths to ignore.
Examples:

Add paths to the exclusion list for the machine 10.10.8.150: 

>Edit-ExcludedFileAandFolders -protectedserver 10.10.8.150 -addpath "*.exe" "*.avi" -addvolume "\Hard disk 1\Volume1"

Remove path from the exclusion list for the machine 10.10.8.150: 

>Edit-ExcludedFileAandFolders -protectedserver 10.10.8.150 -removepath "*.exe" "*.avi" -removevolume "\Hard disk 1\Volume1"

Edit-HyperVClusterProtectionRules

The Edit-HyperVClusterProtectionRules cmdlet lets you edit the protection rules for a specified Hyper-V server.

Usage

The usage for the command is as follows: 

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

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

Table 93: Edit-HyperVClusterProtectionRules command options
Option Description 
-?
 Display this help message. 
-protectedserver
 Use this option to edit the rules for a specific protected Hyper-V cluster. 
-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-HyperVClusterProtectionRules -protectedserver 10.10.10.10 -protectionrules ProtectAgentlessly, ProtectPairedToAnotherCore

Edit-HyperVServerProtectionRules

The Edit-HyperVServerProtectionRules cmdlet lets you edit the protection rules for a specified Hyper-V server.

Usage

The usage for the command is as follows: 

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

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

Table 94: Edit-HyperVClusterProtectionRules 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-HyperVServerProtectionRules -protectedserver 10.10.10.10 -protectionrules ProtectAgentlessly, ProtectPairedToAnotherCore

Edit-HyperVVirtualStandby

The Edit-HyperVVirtualStandby command lets you use PowerShell to make changes to an existing virtual export to a Hyper-V virtual machine (VM).

Usage

The usage for the command is as follows: 

Edit-HyperVVirtualStandby [-HostName <String>] [-HostPort <String>] [-HostUserName <String>] [-HostPassword <String>] [-VMLocation <String>] [-UseLocalMachine] [-gen2] [-UseVhdx] [-ProtectedServer <String>] [-Volumes <String[]>] [-VMName <String>] [-UseSourceRam] [-Ram <String>] [-User <String>] [-Core <String>] [-Password <String>] [-Verbose] [-Debug] [-ErrorAction <ActionPreference>] [-WarningAction <ActionPreference>] [-ErrorVariable <String>] [-WarningVariable <String>] [-OutVariable <String>] [-OutBuffer <Int32>]
Command Options

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

Updated option descriptions TK.

Table 95: Edit-HyperVVirtualStandby 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
Verwandte Dokumente

The document was helpful.

Bewertung auswählen

I easily found the information I needed.

Bewertung auswählen