Chat now with support
Chat with Support

Rapid Recovery 6.9 - Commands and Scripting Reference Guide

Introduction to Rapid Recovery Command Line Management utility PowerShell module
Prerequisites for using PowerShell Working with commands and cmdlets Rapid Recovery PowerShell module cmdlets
Add-EsxAutoProtectObjects Add-EsxVirtualMachines Add-HyperVClusterSharedVirtualDisks Add-HyperVClusterVirtualMachines Add-HyperVVirtualMachines Disable-HyperVAutoProtection Edit-AzureVirtualStandby Edit-EsxiVirtualStandby 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-ExchangeMailStores Get-Failed Get-FailedJobs Get-HyperVClusterSharedVirtualDisks Get-ListAzureVMSizes Get-Mounts Get-OracleInstances Get-Passed Get-ProtectedServers Get-ProtectionGroups Get-QueuedJobs Get-RecoveryPoints Get-ReplicatedServers Get-Repositories Get-ScheduledArchives Get-SqlDatabases Get-TransferQueueEntries Get-UnprotectedVolumes Get-Version Get-VirtualizedServers Get-Volumes 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 Push-Replication Push-Rollup Remove-Agent Remove-EsxAutoProtectObjects Remove-HyperVClusterSharedVirtualDisks Remove-HyperVClusterVirtualMachines Remove-HyperVVirtualMachines Remove-Mount Remove-Mounts Remove-RecoveryPoints Remove-RemoteMount Remove-RemoteMounts Remove-Replication Remove-Repository Remove-ScheduledArchive Remove-VirtualStandby Restart-CoreService Resume-Replication Resume-ScheduledArchive Resume-Snapshot Resume-VirtualStandby Set-AgentMetadataCredentials Set-DedupCacheConfiguration Set-License Set-OracleMetadataCredentials Set-ReplicationResponse Start-Archive Start-AttachabilityCheck Start-AzureDeploy Start-AzureExport Start-ChecksumCheck 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-ScheduledArchive Start-VBExport Start-VirtualStandby Start-VMExport Stop-ActiveJobs Stop-CoreService Suspend-Replication Suspend-ScheduledArchive Suspend-Scheduler Suspend-Snapshot Suspend-VirtualStandby Suspend-VMExport Update-Repository
Localization Qualifiers
Scripting

Resume-Snapshot

An administrator is able to resume snapshots, export to virtual machines, and perform replication. See Start-VMExport for more details.

Usage

The usage for the command is as follows: 

Resume-Snapshot -core [host name] -user [user name] -password [password] -all | -protectedserver [name | IP address]

Command Options

The following table describes the options available for the Resume-Snapshot command:

Table 155: Resume-Snapshot 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. 
-password
 Optional. Password to the remote Core host machine. If you specify a password, you also have to provide a user name. If none are provided, then the logged-on user's credentials will be used. 
-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. 
-all
 All protected servers. 
-protectedserver
 Resume snapshot for the specified machine.

Example:

Resume snapshots for the protected machine with IP 10.10.10.4 for the local Core: 

>Resume-Snapshot -protectedserver 10.10.10.4

Resume-VirtualStandby

The Resume-VirtualStandby PowerShell command lets you resume the suspended export of data to a Rapid Recovery virtual standby machine.

Usage

The usage for the command is as follows: 

Resume-VirtualStandby -core [host name] -user [login] -password [password] -all | -protectedserver [name(s) | IP address]

Command Options

The following table describes the options available for the Resume-VirtualStandby command:

Table 156: Resume-VirtualStandby 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. 

-all
 Resume exports for all virtual standby machines. 
-protectedserver
 The name or names—separated by a comma and space—of the protected machines with virtual standby machines that you want to resume.

Example:

Resume virtual standby exports for a protected machine: 

>Resume-VirtualStandby -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22

Set-AgentMetadataCredentials

The Set-AgentMetadataCredentials command sets the metadata credentials for a specified protected machine.

Usage

The usage for the command is as follows: 

Set-AgentMetadataCredentials -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -target [default | SQL | Exchange] -metadatausername [user name] -metadatapassword [password] -sqlinstancename [SQL instance name] -usewindowsauthentication

Command Options

The following table describes the options available for the Set-AgentMetadataCredentials command:

Table 157: Set-AgentMetadataCredentials 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
 The name or IP address of the protected machine. 
-target
 Optional. The type of metadata, such as SQL, Exchange, or default. 
-metadatausername
 Optional. The metadata-related login. 
-metadatapassword
 Optional. The metadata-related password. 
-sqlinstancename
 Optional. The specific SQL instance name. Use this option in conjunction with the -target "sql." 
-usewindowsauthentication
 Optional. Use this option if your SQL credentials are also used for Windows authentication.

Example:

Set credentials for Exchange metadata: 

>Set-AgentMetadataCredentials -core 10.10.10.10 -user administrator -password -23WE@#$sdd -protectedserver 10.10.20.20 -target exchange -metadatausername administrator -metadatapassword 123#

Set-DedupCacheConfiguration

This command lets you used the Command Line Utility to set the location, size, and metadata location for the primary and secondary cache of a DVM repository.

Usage

The usage for the command when creating a DVM repository is as follows: 

Set-DedupCacheConfiguration -core [host name] -user [user name] -password [password] -primary [cache location] -secondary [cache location] -metadata [metadata location] -size [cache size] -restoredefault

Command Options

The following table describes the options available for the Set-DedupCacheConfiguration command:

Table 158: Set-DedupCacheConfiguration command options
Option Description 
-?
 Display help on the command. 
-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 must also provide a password. If none is provided, then the credentials for the logged-on user are used. 
-password
 Optional. 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. 
-primary
 Optional. Primary cache location. 
-secondary
 Optional. Secondary cache location. 
-metadata
 Optional. Metadata cache location. 
-size
 Optional. Deduplication cache size in GB. 
-restoredefault
 Optional. Restore to default deduplication cache configuration. If this parameter is specified, all other parameters are ignored.

Examples:

Set primary deduplication cache location and deduplication cache size: 

>Set-DedupCacheConfiguration -primary D:\primary -size 6

Set secondary and metadata deduplication location: 

>Set-DedupCacheConfiguration -secondary D:\secondary -metadata D:\metadata

Restore default deduplication configuration: 

>Set-DedupCacheConfiguration -restoredefault
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating