Chat now with support
Chat with Support

Rapid Recovery 6.7 - 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

ForceScheduledArchive

The forcescheduledarchive command lets you force an archive to occur outside of its regularly scheduled time.

Usage

The usage for the command is as follows: 

/forcescheduledarchive -core [host name] -user [user name] -password [password] -all -ids [id | id1 id2]

Command Options

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

Table 34: ForceScheduledArchive 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
 Use this option to force all scheduled archives. 
-ids
 The identifier (ID) or IDs separated by spaces of the scheduled archives that you want to force.

Examples:

Force all scheduled archives: 

>cmdutil /forcescheduledarchive -all

Force one scheduled archive: 

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

ForceVirtualStandby

Exporting data from a protected machine to a virtual machine creates a virtual standby machine. If you have continuous virtual export set up, you can use this command to force Rapid Recovery to export data on demand, regardless of the predetermined schedule.

Usage

The usage for the command is as follows: 

/forcevirtualstandby -core [host name] -user [user name] -password [password login] -protectedserver [name] | -all

Command Options

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

Table 35: ForceVirtualStandby 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 force all scheduled virtual exports.

Examples:

Force all virtual standby exports: 

>cmdutil /forcevirtualstandby -all

Force virtual standby for two machines: 

>cmdutil /forcevirtualstandby -protectedserver 10.10.35.48 10.10.35.69

GetOracleInstanceMetadata

The getoracleinstancemetadata command lets you retrieve the detailed metadata for a specified Oracle instance.

Usage

The usage for the command is as follows: 

/getoracleinstancemetadata -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -instancename [Oracle instance SID]

Command Options

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

Table 36: GetOracleInstanceMetadata 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
 The name or IP address of the protected machine. 
-instancename
 The Oracle SID from which you want to fetch metadata.

Example:

Get detailed metadata for the named Oracle instance. If no metadata credentials are set, then only summary metadata displays: 

>cmdutil /getoracleinstancemetadata -core 10.10.127.42 -user admin -password -676df#df -protectedserver 10.10.34.88 -instancename ORCL

Help

The help command displays a list of the available commands and their definitions. It also provides copyright and version details.

Usage

The usage for the command is as follows: 

/help

Example:

Request Command Line help: 

>cmdutil /help
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating