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

ProtectCluster

The protectcluster command adds a cluster under protection by a core.

Usage

The usage for the command is as follows: 

/protectcluster -core [host name] -user [user name] -password [password] -repository [name] -clustername [name | IP address] -clusterusername [user name] -clusterpassword [password] -clusterport [port] -clustervolumes [volume names] -clusternodes [cluster nodes collection]
Command Options

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

Table 49: ProtectCluster 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. 
-clustername
 Name or IP address of the cluster you want to protect. 
-clusterusername
 User name for the cluster to be protected. 
-clusterpassword
 Password for the cluster to be protected. 
-clusterport
 Protected cluster server port number. 
-clustervolumes
 List of volumes to protect. Values must be enclosed in double quotes and separated by a space.

NOTE: Do not use trailing slashes in volume names; for example, use “c:” “d:”. 

-clusternodes
 List of the cluster nodes and the volumes you want to protect on each node.
Example:

Protect specific volumes of a cluster server with the Core: 

>cmdutil /protectcluster -core 10.10.10.10 -username administrator -password 23WE@#$sdd -repository “Repository 1” -clustername 10.10.8.150 -clusterport 8006 -clusterusername clusterAdmin clusterpassword password -volumes “C:\ClusterStorage\Volume1” -clusternodes nodeName 10.10.8.150 volumes “c:” nodeName 10.10.8.151 volumes “c:”

ProtectEsxServer

You can use the protectesxserver command whenever you want to add a VMware ESX(i) virtual machine to protection.

Usage

The usage for the command is as follows: 

/protectesxserver -core [host name] -user [user name] -password [password] -repository [repository name] -server [name | IP address] -serverusername [user name] -serverpassword [password for server login] -serverport [port] -virtualMachines [virtual machines collection | all] -autoProtect [object ID or name collection]
Command Options

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

Table 50: ProtectEsxServer 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. 
-repository
 Required. The name of the repository that is associated with the Core that you want to use to protect the virtual machine.
Note: You must enclose the name in double quotes. 
-server
 The name or IP address for the vCenter or ESXi server you want to protect. 
-serverusername
 The user name for logging in to the vCenter or ESXi server that you want to protect. 
-serverpassword
 The password for logging in to the vCenter or ESXi server that you want to protect. 
-serverport
 Optional. The port number for the vCenter or ESXi server that you want to protect. 
-virtualmachines
 Optional. This option lets you list the virtual machines that you want to protect. 
-autoprotect
 Optional. This option lets you list new virtual machines that you want to automatically protect.
Example:

Protect specific virtual machines from a vCenter or ESXi server with the Core: 

>cmdutil /protectesxserver -core 10.10.10.10 -user admin -password password -repository "Repository 1" -server 10.10.8.150 -serverport 443 -serverusername root -serverpassword password -virtualmachines "VM1" "VM2" -autoprotect "Folder1"

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 51: 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 52: 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"
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating