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

Start-OracleLogTruncationJob

The command Start-OracleLogTruncationJob lets you start a log truncation job for a specified Oracle instance on a protected server.

Usage

The usage for the command is as follows: 

Start-OracleLogTruncationJob -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -instancename [instance SID] -deletionpolicy [automatic | keepnewest | keepspecificnumber] -retentionduration [duration value] -retentionunit [day | week | month | year] -numberoffiles [number of archive files to create]

Command Options

The following table describes the options available for the Start-OracleLogTruncationJob command:

Table 175: Start-OracleLogTruncationJob 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. 
-protectedserver
 Use this option to specify the protected machine for which you want to enable Oracle log truncation as a nightly job. 
-instancename
 The name of the Oracle instance for which you want to start log truncation. 
-deletionpolicy
 Optional. This option must be represented by one of the following values:
  • "automatic"
  • "keepnewest"
  • "keepspecificnumber"
-retentionduration
 Optional. This value determines the length of time to keep a log before truncating and is constrained to positive integer values. If using the "keepnewest" value of the -deletionpolicy option, a retention duration value is required. 
-retentionunit
 Optional. This option identifies the time unit for the -retentionduration option. It must be represented by one of the following values:
  • "day"
  • "week"
  • "month"
  • "year"
-numberoffiles
 Optional. This option sets the number of recent archive log files to keep. If using the "keepspecificnumber" value of the -deletionpolicy option, a number of files value is required.

Examples:

Start the Oracle log truncation job for the ORCL instance on a specified protected server: 

>Start-OracleLogTruncationJob -core 10.10.127.42 -user admin -password 676df#df -protectedserver 10.10.34.88 -instancename ORCL

Start the Oracle log truncation job for the ORCL instance on a specified protected server and configure the deletion policy as "keepnewest" with the logs kept for 10 days: 

>Start-OracleLogTruncationJob -protectedserver 10.10.34.88 -instancename ORCL -deletionpolicy keepnewest -retentionduration 10 -retentionunit day

Start-Protect

The Start-Protect command lets an administrator add a server under protection by a Core.

Usage

Start-Protect -core [host name] -user [user name] -password [password] -repository [repository name] -agent [name | IP address] -agentusername [user name] 
-agentpassword [password] -agentport [port] -volumes [volume names]

Command Options

The following table describes the options available for the Start-Protect command:

Table 176: Start-Protect 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. 
-repository
 Name of a repository on the Core where the protected machine's data is stored. 
-agentname
 Protected machine name or IP address. 
-agentusername
 Log on to the server to be protected. 
-agentpassword
 Password to the server to be protected. 
-agentport
 Protected server port number. 
-volumes
 List of volumes to protect. Values must be enclosed in double quotes and separated by a space. Do not use trailing slashes in volume names. For example, "c:" or "d:".

Example:

Put volumes of a server under protection: 

>Start-Protect -repository "Repository 1" -agentname 10.10.9.120 -agentusername administrator -agentpassword 12345 -agentport 5002 -volumes "c:" "d:"

Start-ProtectCluster

The Start-ProtectCluster command lets an administrator add a server cluster under protection by a Core.

Usage

Usage for the command is as follows: 

Start-ProtectCluster -core [host name] -user [user name] -password [password] -repository [repository name] -clustername [name | IP address] -clusterusername [user name for cluster] -clusterpassword [password for cluster] -clusterport [port] -clustervolumes [volume names] -clusternodes [cluster nodes names and volumes]

Command Options

The following table describes the options available for the Start-ProtectCluster command:

Table 177: Start-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 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. 
-repository
 Name of a repository on the Core where the protected machine's data is stored. The name must be enclosed in double quotes. 
-clustername
 The name of the cluster to protect. 
-clusterusername
 User name for the cluster to be protected. 
-clusterpassword
 Password to the cluster to be protected. 
-clusterport
 Port number for the cluster to be protected. 
-clustervolumes
 List of volumes to protect. Values must be in double quotes and separated by a space. Do not use trailing slashes in volume names. For example, “c:”, “d”. 
-clusternodes
 List of cluster nodes with volumes to protect. First specify label “nodename” and then type the name of the node. Then, specify label “volumes” and then type a list of volumes for the node.

For example: “nodename”, “10.10.10.10”, “volumes”, “c:”, “e:”, “nodename”, “10.10.10.11,” “volumes”, “c:”

Example:

Put volumes of a server under protection: 

>Start-ProtectCluster -repository "Repository 1" -clustername 10.10.9.120 -clusterusername administrator -clusterpassword 12345 -clusterport 5002 -clustervolumes "c:" "d:" -clusternodes nodename 10.10.10.10 volumes “c:” “e:”

Start-ProtectEsxServer

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

Usage

The usage for the command is as follows: 

Start-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 Start-ProtectEsxServer command:

Table 178: Start-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: 

>Start-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"
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating