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

Start-OracleDBVerifyJob

Use the Start-OracleDBVerifyJob cmdlet to start the DBVerify job for one or more specified recovery points on a protected server.

Usage

The usage for the command is as follows: 

Start-OracleDBVerifyJob -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -recoverypointnumber [number | numbers]
Command Options

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

Table 192: Start-OracleDBVerifyJob 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 the Oracle DBVerify nightly job. 
-recoverypointnumber
 The sequential number of a recovery point that you want to export (use the /list rps command to get the numbers). To start the job on multiple recovery points with one command, separate each recovery point number with a space.
Examples:

Start the Oracle DBVerify job for the recovery points on the specified protected server: 

>Start-OracleDBVerifyJob -core 10.10.127.42 -user admin -password 676df#df -protectedserver 10.10.34.88 -recoverypointnumber 1 2

Start-OracleLogTruncationJob

©

The Start-OracleLogTruncationJob cmdlet 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 193: 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 cmdlet lets an administrator add a machine to protection on a Rapid Recovery Core.

Usage
Start-Protect -core [host name] -user [user name] -password [password] -repository [repository name] -agentname [name | IP address] -agentusername [user name] -agentpassword [password] -agentCredentialsVaultAccount [id | user name | description] -agentport [port] -volumes [all | volume names] -encryptionkeyname [encryption key name] -initialpause
Command Options

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

Table 194: 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. 
-agentCredentialsVaultAccount
 Optional. If you want to use credentials that are already defined in the Credentials Vault for your Core, specify the unique combination of user name, password, and description.
-agentport
 Protected server port number. 
-volumes
 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:" or "d:". 

-encryptionkeyname
 Optional. If you want to use an encryption key to safeguard the snapshots for the machine you are adding to the Core for protection, provide the encryption key name.
-initialpause
 Optional. If you want to delay protection of the specified machine until you explicitly tell the Core to resume (or start) protection, enter this parameter.
Examples:

Protected the specified volumes of a machine in your Core:

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

Start-ProtectCluster

The Start-ProtectCluster cmdlet lets an administrator add a server cluster to protection on a Rapid Recovery 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 195: 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.

NOTE: Do not use trailing slashes in volume names. For example, use “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:”

Examples:

Protect nodes on a server cluster:

>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:”
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating