Chat now with support
Chat with Support

Welcome, ApexSQL customers to Quest Support Portal click here for for frequently asked questions regarding servicing your supported assets.

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

Remove-CredentialsVaultAccount

The Remove-CredentialsVaultAccount cmdlet removes the Credentials Vault account from the specified Core.

Usage

The usage for the command is as follows:

Remove-CredentialsVaultAccount [-AccountId <string>] [-User <string>] [-Core <string>] [-Password <string>] [<CommonParameters>]
Command Options

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

Table 152: Remove-CredentialsVaultAccount 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.

-accountid
Required. The identifier of the Credentials Vault account that you want to remove.
Examples:

Remove a Credentials Vault account from the Core:

>Remove-CredentialsVaultAccount -accountid CVaccount1 -core 10.10.10.10

Remove-EncryptionKey

The Remove-EncryptionKey cmdlet lets you add specific VMs on vCenter or ESXi server under the protection of a Core.

Usage

The usage for the command is as follows:

Remove-EncryptionKey -core [host name] -user [user name] -password [password] -keyname [name of the encryption key]
Command Options

The following table describes the options available for the Remove-EncryptionKey command:

Table 153: Remove-EncryptionKey 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.

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

Examples:

Remove an encryption key from the Core:

>Remove-EncryptionKey -core 10.10.10.10 -user admin -password password -keyname EKname

Remove-EsxAutoProtectObjects

The Remove-EsxAutoProtectObjects cmdlet lets you remove specific objects on vCenter or ESXi server from protection by a Core.

Usage

The usage for the command is as follows:

Remove-EsxAutoProtectObjects -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -autoprotectobjects
Command Options

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

Table 154: Remove-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.

-protectedserver
Use this option to edit the vCenter or ESXi objects for a specific protected machine.
-autoprotectobjects
A list of vCenter or ESXi objects each enclosed in double quotes and separated by a comma.
Examples:

Remove specific vCenter or ESXi objects from protection auto-protection by the Core:

>Remove-EsxAutoProtectObjects -protectedserver 10.10.8.150 -autoprotectobjects "vm1", "vm2"

Remove-EsxVirtualMachines

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

Usage

The usage for the command is as follows:

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

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

Table 155: Remove-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.

-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.
-deleterecoverypoints
Deletes the recovery points of the removed machine from the repository. If you omit this option, then the repository retains the recovery points of the removed machine.
Examples:

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

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