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

Add-CredentialsVaultAccount

The Add-CredentialsVaultAccount cmdlet lets you manage and create accounts in the credentials vault.

Usage

The usage for the command is as follows: 

Add-CredentialsVaultAccount [-AccountUsername <string>] [-AccountPassword <string>] [-Description <string>] [-User <string>] [-Core <string>] [-Password <string>] [<CommonParameters>]
Command Options

The following table describes the options available for the Add-CredentialsVaultAccount command:

Table 81: Add-CredentialsVaultAccount command options
Option Description 
-?
 Display this help message. 
-AccountUsername
 The user name for the Credentials Vault account. 
-AccountPassword
 The password for logging in to the Credentials Vault account. 
-Description
 The description of the Credentials Vault account. 
-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. 

-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. 
-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.

Examples:

Add a Credentials Vault account to the local Core: 

>Add-CredentialsVaultAccount -AccountUsername "user1" -AccountPassword "password1"

AddEncryptionKeytoProtectedMachine

The addencryptionkeytoprotectedmachine command lets you apply an existing encryption key to a machine that the Core is protecting.

Usage

The usage for the command is as follows: 

/addencryptionkeytoprotectedmachine -core [host name] -user [user name] -password [password name] -name [encryption key name] -comment [comment or description of key]
Command Options

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

Table 1: Addencryptionkeytoprotectedmachine 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
 Ocmdptional. 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 The name or IP address of the protected machine.
-keyname

Optional. The name of the encryption key. Specify this option if you know the name of the encryption key that you want to set for the protected machine.

NOTE:If the -keyname option is not specified, the list of existing encryption keys appears and you will be prompted to choose the number of the encryption key that you want to apply to the protected machine.

Example:

Apply an existing encryption key to a protected machine. If you want to disassociate the key from the protected machine, then select <none> or specify the <none> value for the -keyname option: 

>cmdutil /addencryptionkeytoprotectedmachine -protectedserver 10.10.8.150 -keyname EKname

Add-EsxAutoProtectObjects

The Add-EsxAutoProtectObjects cmdlet enables auto protection for specified objects on a vCenter or ESXi server.

Usage

The usage for the command is as follows: 

Add-EsxAutoProtectObjects -core [host name] -user [user name] -password [password] -repository [name] -protectedserver [name | IP address] -autoprotect [object name collection]
Command Options

The following table describes the options available for the Add-EsxAutoProtectObjects command:

Table 82: Add-EsxAutoProtectObjects 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. 

-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
 Show jobs for a specific protected machine, indicated by IP address. 
-autoprotect
 Optional. This option lets you list the new virtual machines that you want to automatically protect.
Examples:

Put specific objects from a vCenter or ESXi server under auto-protection by the Core: 

>Add-EsxAutoProtectObjects -protectedserver 10.10.8.150 -add -autoprotect "Folder1", "Folder2"

Add-EsxVirtualMachines

The Add-EsxVirtualMachines cmdlet lets you add specific virtual machines (VMs) on vCenter or ESXi server under the protection of a Core.

Usage

The usage for the command is as follows: 

Add-EsxVirtualMachines -core [host name] -user [user name] -password [password] -repository [name] -protectedserver [name | IP address] -virtualmachines [virtual machines collection | all]
Command Options

The following table describes the options available for the Add-EsxVirtualMachines command:

Table 83: Add-EsxVirtualMachines 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. 

-repository

Required. The name of the repository that is associated with the Core that you want to use to store the data of the virtual machine.

NOTE: You must enclose the name in double quotes.

-protectedserver
 Use this option to edit the vCenter or ESXi objects for a specific protected machine. 
-virtualmachines
 A list of virtual machines each separate by a comma.
Examples:

Add two VMs from a vCenter or ESXi server under protection by the Core: 

>Add-EsxVirtualMachines -repository "repository1" -protectedserver 10.10.10.10 -virtualmachines "vm1", "vm2"
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating