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

Suspend-ScheduledArchive

The Suspend-ScheduledArchive PowerShell command lets you pause a Rapid Recovery scheduled archive. This command prevents the archive from occurring as scheduled until you reactivate it.

If the topic is relevant, include and re-link:

For more information, see Resume-ScheduledArchive.

.

Usage

The usage for the command is as follows: 

Suspend-ScheduledArchive -core [host name] -user [login] -password [password] -all -ids [id | id1 id2]

Command Options

The following table describes the options available for the Suspend-ScheduledArchive command:

Table 191: Suspend-ScheduledArchive 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
 Pauses all scheduled archives. 
-id
 The identification number or space-separated numbers of scheduled archives to suspend.

Example:

Suspend multiple scheduled archives: 

>Suspend-ScheduledArchive -ids 799138c8-3dfc-4398-9711-1823733c2a31, 26c29bb7-b320-47f5-b5a8-dffc49f50e25

Suspend-Scheduler

This command lets you suspend or pause the task scheduler it has been paused.

Usage

The usage for the command is as follows: 

Suspend-Scheduler -core [host name] -user [user name] -password [password] -cancelactivejobs [true | false]

Command Options

The following table describes the options available for the Suspend-Scheduler command:

Table 192: Suspend-Scheduler command options
Option Description 
-?
 Display this help message. 
-restore
 [snapshots], [replication] or [vmexport]. 
-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. 
-cancelactivejobs
 Optional. Use this option to cancel all active jobs on the Core. The default setting is "false."

Example:

Pause the task scheduler: 

>Suspend-Scheduler -core 10.10.127.42 -user admin -password 676df#df -cancelactivejobs true

Suspend-Snapshot

The Suspend-Snapshot command lets an administrator pause snapshots.

Usage

The usage for the command is as follows: 

Suspend-Snapshot -core [host name] -user [user name] -password [password] -all | 
-protectedserver [name | IP address] -time [time string]

Command Options

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

Table 193: Suspend-Snapshot command options
Option Description 
-?
 Display this help message. 
-all
 Pauses all protected machines on the selected Core. 
-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 user name. If none are provided, then the logged-on user's credentials will be used. 
-time
 The time in the format ‘Day-Hours-Minutes’ when the snapshots will be resumed (only for snapshots pause).

Example:

Pause snapshots for the protected machine with IP 10.10.10.4 for the local Core with a certain time to resume: 

>Suspend-Snapshot -protectedserver 10.10.10.4 –time 3-20-50

Suspend-VirtualStandby

The Suspend-VirtualStandby PowerShell command lets you pause the export of data to a Rapid Recovery virtual standby machine.

Usage

The usage for the command is as follows: 

Suspend-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 Suspend-VirtualStandby command:

Table 194: Suspend-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
 Pause 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 suspend.

Example:

Suspend virtual standby exports for a protected machine: 

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

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating