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

Push-Rollup

The Push-Rollup command forces rollup for a protected machine.

Usage

The usage for the command is as follows:

Push-Rollup -core [host name] -user [user name] -password [password] -protectedserver [machine name | IP address]

Command Options

The following table describes the options available for the Push-Rollup command:

Table 135: Push-Rollup command options
Option Description
-?
Display this help message.
-all
Force all protected machines.
-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.
-protectedserver
Force for the current protected machine’s name.
-user
Optional. Login for the remote Core host machine. If you specify a login, you also have to provide a password. If none are provided, then the logged-on user's credentials will be used.

Example:

Push rollup for a single protected machine:

>Push-Rollup -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd –protectedserver 10.10.5.22

Push rollup for all protected machines:

>Push-Rollup -all

Remove-Agent

The Remove-Agent PowerShell command lets you remove a machine from Rapid Recovery Core protection.

Usage

The usage for the command is as follows:

Remove-Agent -core [host name] -user [login] -password [password] -protectedserver [name | IP address] -deleterecoverypoints -all

Command Options

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

Table 136: Remove-Agent 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
Dismount all mounted recovery points for the current protected machine.
-deleterecoverypoints
Optional. Delete all recovery points for this protected machine.
-all
Optional. Delete all protected machines from the Core.

Example:

Dismount all protected machines and their recovery points:

>Remove-Agent -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -deleterecoverypoints -all

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

Example:

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

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

Remove-HyperVClusterSharedVirtualDisks

The Remove-HyperVClusterSharedVirtualDisks cmdlet lets you remove shared Hyper-V virtual disks from protection of a Core.

Usage

The usage for the command is as follows:

Remove-HyperVClusterSharedVirtualDisks -core [host name] -user [user name] -password [password] -shareddisks [shared virtual disks name or path collection | all]

Command Options

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

Table 138: Remove-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
Use this option to edit the shared virtual disks for a specific protected machine.
-shareddisks
A list of shared disks each separate by a comma.

Example:

Remove one shared virtual disk from protection:

>Remove-HyprVClusterSharedVirtualDisks -protectedserver "HV-2012R2" -shareddisks "Shared Disk 1"
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating