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

Get-HyperVClusterSharedVirtualDisks

The Get-HyperVClusterSharedVirtualDisks command returns information about machines protected on the local Core.

Usage

The usage for the command is as follows:

Get-HyperVClusterSharedVirtualDisks -protectedserver [name | IP address] -shareddisk [shared virtual disk name (path)]
Command Options

The following table describes the options available for the Get-HyperVClusterSharedVirtualDisks command:

Table 112: Get-HyperVClusterSharedVirtualDisks 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 log on.

If none are provided, then the logged-on user's credentials will be used.

-protectedserver
This option shows all of the shared virtual disks for a specific protected cluster.
-shareddisk
The name of a specific shared disk.
Examples:

Retrieve a collection of all shared disks:

>Get-HyperVClusterSharedVirtualDisks -protectedserver "HV-2012R2" -shareddisk "Shared Disk 1"

Get-ListAzureVMSizes

The Get-ListAzureVMSizes command returns a list of the available virtual machines sizes for deploying to Azure.

Usage

The usage for the command is as follows:

Get-ListAzureVMSizes -core [host name] -user [user name] -password [password] -cloudaccountname [Azure account name] -storageaccountname [Azure storage account name] -subscriptionid [subscription ID] -cloudservicename [service name]
Command Options

The following table describes the options available for the Get-ListAzureVMSizes command:

Table 113: Get-ListAzureVMSizes 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 log on.

If none are provided, then the logged-on user's credentials will be used.

-cloudaccountname
Optional when specifying -storageaccountname. Specify the name of the Azure cloud account.
-storageaccountname
Optional when specifying -cloudaccountname. Specify the name of the Azure storage account.
-subscriptionid
The Azure subscription ID.
-cloudservicename
The name of the Azure cloud service.
Examples:

View a list of the available virtual machine sizes for the cloud account Account1:

>Get-CloudAccounts -cloudaccountname Account1 -cloudservicename Service

View a list of the available virtual machine sizes for the storage account named "teststorage:"

>Get-CloudAccounts -storageaccountname teststorage -cloudservicename Service

Get-Mounts

The Get-Mounts command returns all recovery points mounted on the local Core.

Usage

The usage for the command is as follows:

Get-Mounts -core [host name] -user [user name] -password [password] -protectedserver [server name or IP address]
Command Options

The following table describes the options available for the Get-Mounts command:

Table 114: Get-Mounts 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 log on.

If none are provided, then the logged-on user's credentials will be used.

-protectedserver
Show jobs for a specific protected machine, indicated by IP address.
Examples:

Show all mounted recovery points:

>Get-Mounts -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -protectedserver 10.10.5.22

Get-OracleInstanceMetadata

The Get-OracleInstanceMetadata cmdlet lets you retrieve the detailed metadata for a specified Oracle instance.

Usage

The usage for the command is as follows:

Get-OracleInstanceMetadata -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 Get-OracleInstanceMetadata command:

Table 115: Get-OracleInstanceMetadata 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.
Examples:

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

>Get-OracleInstanceMetadata -core 10.10.127.42 -user admin -password -676df#df -protectedserver 10.10.34.88 -instancename ORCL
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating