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

RemoveScheduledArchive

Use this command to discontinue an existing Rapid Recoveryscheduled continuous archive.

Usage

The usage for the command is as follows: 

/removescheduledarchive -core [host name] -user [user name] -password [password] name] -all -ids [id | id1 id2]
Command Options

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

Table 57: RemoveScheduledArchive 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. 
-all
 This option specifies whether to remove all scheduled archives associated with this Core. 
-ids
 Use this option to list the ID or IDs for each scheduled archive you want to remove. Separate multiples IDs with spaces.
Examples:

Remove all scheduled archives: 

>cmdutil /removescheduledarchive -all

Remove one scheduled archive: 

>cmdutil /removescheduledarchive -ids 6c123c39-5058-4586-bd0c-7c375e72017b

RemoveVirtualStandby

Use this command to discontinue the continuous export of data to a virtual machine in the Rapid Recovery command utility.

Usage

The usage for the command is as follows: 

/removevirtualstandby -core [host name] -user [user name] -password [password login] -protectedserver [name] | -all
Command Options

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

Table 58: RemoveVirtualStandby 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 space-separated names of virtualized machines. 
-all
 This command specifies whether to remove all scheduled virtual exports.
Examples:

Remove all virtual standby exports: 

>cmdutil /removevirtualstandby -all

Remove virtual standby export for two machines: 

>cmdutil /removevirtualstandby -protectedserver 10.10.35.48 10.10.35.69

Replicate

Use the Replicate command to set up replication between two Rapid Recovery Cores.

Usage

The usage for the command is as follows: 

/replicate -request [email | email customer ID] -targetserver [host name | hostname port | hostname user name password | hostname port user name password] -replicationname [name] -seeddrive [localpath | network path username password] [comment] -protectedserver [name | name repository]
Command Options

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

Table 59: Replicate 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 
-request
 Optional. Specify this option if you want to use a subscription to a third-party provider of off-site backup and disaster recovery services. 
-targetserver
 The name of the server where you want to establish replication. It includes the following parameters:
  • port
  • user name
  • password
The port parameter is optional, with a default of 8006. If you used the request option, you should also use the user name and password for the target server. 
-replicationname
 Optional. Use the name of the replication job if you do not use the request option. 
-seeddrive
 Optional. Use this option to specify a seed drive for the initial data transfer. The comment parameter is optional. 
-protectedserver
 The list of protected machines you want to replicate. If you use the request option, list only the names or IP addresses of protected machines. Otherwise, list both protected machines and the corresponding remote repository name.
Example:

Replicate two protected machines to the remote Core using a seed drive from a network share: 

>cmdutil /replicate -targetserver 10.10.1.100 Administrator 123Q -replicationname ReplicationName -seeddrive Network \\10.10.1.100\seeddrive Administrator 123Q -protectedserver 10.10.1.1 Repository1 10.10.1.2 Repository2

Replication

Use the replication command to control existing replication between two Rapid Recovery Cores and manage pending replication requests.

NOTE: This command succeeds the Replicate command, which establishes the connection—called pairing—between the Cores and uses a seed drive for the initial data transfer. For more information about this command, see Replicate.

Usage

The usage for the command is as follows: 

/replication [-list [incoming | outgoing | pending] -accept | -deny | -ignore | -delete | -edit] -id [replication ID] -protectedserver [name | name repository] -responsecomment [comment] -deleterecoverypoints -scheduletype [type] -dailystarttime [time] -dailyendtime [time] -weekdaystarttime [time] -weekdayendtime [time] -weekendstarttime [time] -weekendendtime [time]
Command Options

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

Table 60: Replication 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 
-list
 The list of incoming or outgoing replication jobs or pending replication requests. 
-accept
 Accepts the replication request. 
-deny
 Denies the replication request. 
-ignore
 Ignores the replication request. 
-delete
 Use this option to delete an existing replication job or a machine from the replication job. Specify only the -id parameter to delete an entire replication relationship, or specify both the -id and -protectedserver parameters to delete only specific machines from replication. 
-edit
 Edits the schedule of existing replication jobs. 
-id
 The identifier for the replication job or pending replication request. It can be a remote Core ID, host name, customer ID, email address, or pending replication request ID. 
-protectedserver
 When responding to a replication request, use this option to apply your response to list of protected servers with a repository name or ID. Use the parameter "all" to apply response to all requested machines. 
-responsecomment
 The comment you provide with the response to a pending replication request. 
-deleterecoverypoints
 Use this option if specific recovery points from a deleted replicated machine should also be removed. 
-scheduletype
 If you use the -edit option, this option specifies the type of replication schedule. Include one of the following four values:
  • atalltimes - Automatically replicate at any time.
  • daily - Replicate daily. Specify the -dailystarttime and -dailyendtime parameters.
  • custom - When using daily replication, use this value to schedule replication on weekdays or weekends. Specify the -weekdaystarttime, -weekdayendtime, -weekendstarttime, and -weekendendtime parameters. 
-dailystarttime
 Use only for the daily value of the -scheduletype option. It is used to establish a window of time for when replication should occur. Use this option to specify the earliest time of day when you want replication to start.
Confirm with Dev. 
-dailyendtime
 Use only for the daily value of the -scheduletype option. It is used to establish a window of time for when replication should occur. Use this option to specify the latest time of day when you want replication to start.
Confirm with Dev. 
-weekdaystarttime
 Use only for the custom value of the -scheduletype option. It is used to establish a window of time for when replication should occur. Use this option to specify the earliest time of a weekday when you want replication to start.
Confirm with Dev. 
-weekdayendtime
 Use only for the custom value of the -scheduletype option. It is used to establish a window of time for when replication should occur. Use this option to specify the latest time of a weekday when you want replication to start.
Confirm with Dev. 
-weekendstarttime
 Use only for the custom value of the -scheduletype option. It is used to establish a window of time for when replication should occur. Use this option to specify the earliest time of the weekend when you want replication to start.
Confirm with Dev. 
-weekendendtime
 Use only for the custom value of the -scheduletype option. It is used to establish a window of time for when replication should occur. Use this option to specify the latest time of the weekend when you want replication to start.
Confirm with Dev.
Examples:

List all incoming replication: 

>cmdutil /replication -list incoming

Accept pending replication requests for two protected machines: 

>cmdutil /replication -accept -id customer@email.address -protectedserver 10.10.1.1 Repository1 10.10.1.2 Repository2 -responsecomment A response comment

Deny a pending replication request: 

>cmdutil /replication -deny -id customer@email.address

Delete existing replication with replicated recovery points: 

>cmdutil /replication -delete -id RemoteServerHostname -deleterecoverypoints

Remove two machines from existing replication: 

>cmdutil /replication -delete -id "156d7a46-8e44-43f4-9ed8-60d998e582bf" -protectedserver 10.10.1.1 10.10.1.2

Edit schedule of replication with specified weekday and weekend times: 

>cmdutil /replication -edit -id RemoteServerHostName -scheduletype custom -weekdaystarttime "9:00 AM" -weekdayendtime "6:00 PM" -weekendstarttime "9:00 AM" -weekendendtime "6:00 PM"
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating