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

ProtectHyperVCluster

The protecthypervcluster command adds a Hyper-V cluster under protection by a Core using agentless protection.

Usage

The usage for the command is as follows:

/protecthypervcluster -core [host name] -user [user name] -password [password] -repository [name] -server [name | IP address] -serverusername [user name] -serverpassword [password] -serverport [port] -virtualmachines [virtual machines collection | all] -isagentprotection

Command Options

The following table describes the options available for the protecthypervcluster command:

Table 49: ProtectHyperVCluster 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 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.
-repository
Name of a repository on the Core to which the protected machine data should be stored. The name must be enclosed in double quotes.
-server
Name or IP address of the Hyper-V server that you want to protect.
-serverusername
User name for the Hyper-V server to be protected.
-serverpassword
Password for the Hyper-V server to be protected.
-serverport
Optional. Protected Hyper-V server port number.
-virtualmachines
Optional. List of virtual machines to protect. Values must be enclosed in double quotes and separated by a space. If you exclude this parameter, only the Hyper-V cluster container is protected.
-isagentprotection
Optional. Use this option to protect a cluster with an Agent in each guest virtual machine, which is false by default.
-autoprotect
Optional. This option enables the autoprotect feature for the Hyper-V server. It is not compatible with the -isagentprotection option.

Example:

Protect specific virtual machines of a Hyper-V cluster:

>cmdutil /protecthypervcluster -core 10.10.10.10 -username admin -password password -repository “Repository 1” -server 10.10.8.150 -serverport 443 -serverusername root clusterpassword password -virtualmachines “VM1” "VM2" -autoprotect

ProtectHyperVServer

The protecthypervserver command adds a Hyper-V server under protection by a Core using agentless protection.

Usage

The usage for the command is as follows:

/protecthypervserver -core [host name] -user [user name] -password [password] -repository [name] -server [name | IP address] -serverusername [user name] -serverpassword [password] -serverport [port] -virtualmachines [virtual machines collection | all] -isagentprotection

Command Options

The following table describes the options available for the protecthypervserver command:

Table 50: ProtectHyperVServer 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 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.
-repository
Name of a repository on the Core to which the protected machine data should be stored. The name must be enclosed in double quotes.
-server
Name or IP address of the Hyper-V server that you want to protect.
-serverusername
User name for the Hyper-V server to be protected.
-serverpassword
Password for the Hyper-V server to be protected.
-serverport
Optional. Protected Hyper-V server port number.
-virtualmachines
Optional. List of virtual machines to protect. Values must be enclosed in double quotes and separated by a space. If you exclude this parameter, only the Hyper-V cluster container is protected.

Example:

Protect specific virtual machines of a Hyper-V server:

>cmdutil /protecthypervserver -core 10.10.10.10 -username admin -password password -repository “Repository 1” -server 10.10.8.150 -serverport 443 -serverusername root clusterpassword password -virtualmachines “VM1” "VM2"

RemoveAgent

The RemoveAgent command lets you remove a protected machine from the protection of a Core and optionally delete the recovery points of the removed machine. If you do not delete the recovery points, Rapid Recovery retains and labels them as a recovery points only machine.

Usage

The usage for the command is as follows:

/removeagent -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -deleterecoverypoints

Command Options

The following table describes the options available for the RemoveAgent command:

Table 51: RemoveAgent 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 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.
-protectedserver
The name or IP address of the server you want to remove from protection.
-deleterecoverypoints
Optional. Deletes all recovery points for the machine you want to remove.

Example:

Remove a machine from protection and delete the associated recovery points:

>cmdutil /removeagent -protectedserver 10.10.1.1 -deleterecoverypoints

RemoveArchiveRepository

You can use the removearchiverepository command to delete a repository from the Rapid Recovery Core.

Usage

The usage for the command is as follows:

/removearchiverepository -core [host name] -user [user name] -password [password] name] -name [archive repository name]

Command Options

The following table describes the options available for the removearchiverepository command:

Table 52: RemoveArchiveRepository 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.
-name
Required. The name of the archive repository.

Examples:

Remove the repository named "NewArchive" from the local Core:

>cmdutil /removearchiverepository -name NewArchive
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating