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

Suspend-Scheduler

The Suspend-Scheduler cmdlet lets you suppress all scheduled tasks (backups, virtual export, replication, archiving, nightly jobs, and so on). Rapid Recovery Core continues to monitor tasks, but once suspended, no jobs are queued until the scheduler is resumed.

You can re-enable queing of all future tasks using cmdlet Resume-Scheduler. Once resumed, only new tasks are queued.

NOTE: To suspend specific functions (instead of all scheduled tasks), use the relevant individual cmdlets, such as Suspend-Snapshot, Suspend-Replication, and so on.

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 212: 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."
Examples:

Pause all scheduled tasks until resumed, including canceling any currently active jobs:

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

Pause all future scheduled tasks. Any tasks currently running will complete.

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

Suspend-Snapshot

The Suspend-Snapshot cmdlet lets an administrator pause snapshots. On-demand and scheduled backup snapshots remain paused until explicitly resumed by running cmdlet Resume-Snapshot.

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

-protectedserver 
Optional. Use to specify protected machine or machines for which you want to suspend snapshots. Specify two or more by separating machine ip addresses with a comma and space.
-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).
Examples:

Pause snapshots on a remote core with IP address 10.10.10.10 for a specific protected machine with IP address 10.10.10.4 until a resume command is sent:

>Suspend-Snapshot -core 10.10.10.10 -user administrator -password 23WE@#sdd -protectedserver 10.10.10.4 –time 3-20-50

Pause snapshots on the local Core for the protected machine with IP address 10.10.10.4 and resume snapshots after 3 days, 20 hours, and 50 minutes:

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

Pause snapshots for all protected machines on remote Core with IP address 10.10.10.10 and resume snapshots after one and a half hours:

>Suspend-Snapshot -core 10.10.10.10 -user administrator -password 23WE@#sdd -all –time 0-1-30

Pause snapshots on the local Core for the two specified protected machines with IP addresses 10.10.10.4 and 10.10.10.16 until a resume command is sent:

>Suspend-Snapshot -protectedserver "10.10.10.4" , "10.10.10.16" –time 3-20-50

Suspend-VirtualStandby

The Suspend-VirtualStandby PowerShell cmdlet lets you pause continual virtual export. After running this cmdlet, virtual export remains paused until it is explicitly resumed, either by running cmdlet Resume-VirtualStandby or by resuming from the Rapid Recovery Core Console.

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 214: 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.
Examples:

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

Update-Repository

The Update-Repository command adds an extent to an existing DVM repository. The size specified must be between 250MB and 16TB.

Usage
Update-Repository -name [repository name] -size [size] [[[-datapath [datapath] 
-metadatapath [metadata path]] | [-uncpath [UNC path] -shareusername [share user name] -sharepassword [share password]]] -core [host name] -user [user name] 
-password [password]
Command Options

The following table describes the options available for the Update-Repository command:

Table 215: Update-Repository 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 user name. If none are provided, then the logged-on user's credentials will be used.
-name
DVM repository name.
-size
Size of DVM repository extent. Available units are: b, Kb, MB, GB, TB, PB.
-datapath
For local location only. Determines data path of DVM repository extent.
-metadatapath
For local location only. Determines metadata path of DVM repository extent.
-uncpath
For share location only. Determines data and metadata paths of DVM repository extent.
-shareusername
For share location only. Determines login to share location.
-sharepassword
For share location only. Determines password to share location.
Examples:

Add an extent to the DVM repository of the minimum size:

>Update-Repository -name Repository1 -size 250Mb -datapath C:\Repository\Data -metadatapath C:\repository\Metadata
Related Documents