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

DismountArchiveRepository

After retrieving the information you want from a mounted archive, you should dismount the archive to avoid potential issues.

Usage

The usage for the command is as follows: 

/dismountarchiverepository -core [host name] -user [user name] -password [password] name] -name [archive repository name]
Command Options

The following table describes the options available for the DismountArchiveRepository command:

Table 18: DismountArchiveRepository 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. 
-name
 Required. The name of the archive repository.
Examples:

Dismount the repository named "NewArchive:" 

>cmdutil /dismountarchiverepository -name NewArchive -core 10.10.10.10 -user administrator -password 23WE@#$sdd -path d:\work\archive

EditActiveBlockMapping

The editactiveblockmapping command lets you make changes to the Active Block Mapping setting for protecting VMware and vSphere virtual machines.

Usage

The usage for the command is as follows: 

/editactiveblockmapping -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 EditActiveBlockMapping command:

Table 19: EditActiveBlockMapping 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 for which you want to use active block mapping. 
-enable
 Optional. The -enable option does not change the settings for swapfiles and exclusion lists; it turns Active Block Mapping on. If swapfiles are off and the exclusion list is empty, using the -enable option alone only ignores the blocks of deleted files. 
-comment
 Optional. A comment on or a description of the encryption key that you want to create.
Example:

Enable active block mapping so that swap files are excluded from backups of the machine 10.10.8.150: 

>cmdutil /editactiveblockmapping -protectedserver 10.10.8.150 -enable -swapfiles enable

Following the previous command with the next command disables swap files exclusion; meaning swap files will be backed up from machine 10.10.8.150: 

>cmdutil /editactiveblockmapping -protectedserver 10.10.8.150 -enable -swapfiles disable

EditEsxServer

You can use the editesxserver command whenever you want to make changes to the number of VMware ESX(i) virtual machines that you want to protect agentlessly.

Usage

The usage for the command is as follows: 

/editEsxServer -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -add | -remove -virtualMachines [virtual machines collection | all] -autoprotect [object ID or name collection]
Command Options

The following table describes the options available for the editesxserver command:

Table 20: EditEsxServer 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. 
-repository
 Required. The name of the repository that is associated with the Core that you want to use to protect the virtual machine.
Note: You must enclose the name in double quotes. 
-protectedserver
 Use this option to edit vCenter and ESX(i) objects for a specific protected machine. 
-add
 Use this option to add a specified vCenter or ESXi object. 
-remove
 Use this option to remove a specified vCenter or ESXi object. 
-virtualmachines
 Optional. This option lets you list the virtual machines that you want to protect. 
-autoprotect
 Optional. This option lets you list the new virtual machines that you want to automatically protect.
Examples:

Automatically protect specific vCenter or ESXi objects of a vCenter or ESXi server with the Core: 

>cmdutil /editEsxServer -protectedserver 10.10.8.150 -add -autoprotect "Folder1" "Folder2"

EditExcludedFilesandFolders

The editexcludedfilesandfolders command 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 EditExcludedFilesandFolders command:

Table 21: EditExcludedFilesandFolders 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 for which you want to edit excluded paths. 
-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.
Example:

Add paths to the exclusion list for the machine 10.10.8.150: 

>cmdutil /editexcludedfilesandfolders -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: 

>cmdutil /editexcludedfilesandfolders -protectedserver 10.10.8.150 -removepath "*.exe" "*.avi" -removevolume "\Hard disk 1\Volume1"
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating