Chat now with support
Chat with Support

Rapid Recovery 6.8 - 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

Get-Failed

The Get-Failed command returns information about failed recovery points on the local Core.

Usage

The usage for the command is as follows: 

Get-Failed -core [host name] -user [user name] -password [password] -all | 
-protectedserver [server name or IP address] -number [all | f[number] |l[number] | number]

Command Options

The following table describes the options available for the Get-Failed command:

Table 99: Get-Failed 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. 
-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.

Example:

Lists all failed recovery points: 

>Get-failed -protectedserver 10.10.10.10

Get-FailedJobs

The Get-FailedJobs command returns all failed jobs from the local Core.

Usage

The usage for the command is as follows: 

Get-FailedJobs -core [host name] -user [user name] -password [password] -all | 
-protectedserver [server name or IP address] -number [all | f[number] |l[number] | number] -jobtype [type] -time [time]

Command Options

The following table describes the options available for the Get-FailedJobs command:

Table 100: Get-FailedJobs 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).

Example:

Lists all failed jobs on the local Core: 

>Get-FailedJobs –all

Lists all failed create backup jobs on the local Core: 

>Get-FailedJobs -type backup

Get-HyperVClusterSharedVirtualDisks

The Get-HyperVClusterSharedVirtualDisks command provides information about machines protected on the local Core.

Usage

The usage for the command is as follows: 

Get-HyperVClusterSharedVirtualDisks -protectedserver [name | IP address] -shareddisk [shared virtual disk name (path)]

Command Options

The following table describes the options available for the Get-HyperVClusterSharedVirtualDisks command:

Table 101: Get-HyperVClusterSharedVirtualDisks 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
 This option shows all of the shared virtual disks for a specific protected cluster. 
-shareddisk
 The name of a specific shared disk.

Example:

Retrieve a collection of all shared disks: 

>Get-HyperVClusterSharedVirtualDisks -protectedserver "HV-2012R2" -shareddisk "Shared Disk 1"

Get-ListAzureVMSizes

The Get-ListAzureVMSizes command provides a list of the available virtual machines sizes for deploying to Azure.

Usage

The usage for the command is as follows: 

Get-ListAzureVMSizes -core [host name] -user [user name] -password [password] -cloudaccountname [Azure account name] -storageaccountname [Azure storage account name] -subscriptionid [subscription ID] -cloudservicename [service name]

Command Options

The following table describes the options available for the Get-ListAzureVMSizes command:

Table 102: Get-ListAzureVMSizes 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. 

-cloudaccountname
 Optional when specifying -storageaccountname. Specify the name of the Azure cloud account. 
-storageaccountname
 Optional when specifying -cloudaccountname. Specify the name of the Azure storage account. 
-subscriptionid
 The Azure subscription ID. 
-cloudservicename
 The name of the Azure cloud service.

Example:

View a list of the available virtual machine sizes for the cloud account Account1: 

>Get-CloudAccounts -cloudaccountname Account1 -cloudservicename Service

View a list of the available virtual machine sizes for the storage account named "teststorage:" 

>Get-CloudAccounts -storageaccountname teststorage -cloudservicename Service
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating