Rapid Recovery 6.3 - Command Line and Scripting Reference Guide

AddEncryptionKeytoProtectedMachine ApplyLicense Archive BackupSettings CancelActiveJobs CheckRepository ConfigureAgentMigration CreateArchiveRepository CreateBootCD CreateEncryptionKey CreateRepository CredentialsVaultAccount DedupCacheConfig DeleteReplication DeleteRepository DeployToAzure Dismount DismountArchiveRepository EditActiveBlockMapping EditEsxServer EditExcludedFilesandFolders EditHyperVCluster EditHyperVServer EditOracleDBVerifyNightlyJob EditOracleLogTruncationNightlyJob EnableOracleArchiveLogMode ExportRMANBackup FileSearch Force ForceAttach ForceChecksum ForceLogTruncation ForceMount ForceOptimizationJob ForceReplication ForceRollup ForceScheduledArchive ForceVirtualStandby GetOracleInstanceMetadata Help List ListAzureVMSizes ListOracleInstances Mount MountArchiveRepository NewCloudAccount OpenDvmRepository Pause Protect ProtectCluster ProtectEsxServer ProtectHyperVCluster ProtectHyperVServer RemoveAgent RemoveArchiveRepository RemoveEncryptionKey RemovePoints RemoveScheduledArchive RemoveVirtualStandby Replicate Replication RestartCoreService RestoreAgent RestoreArchive RestoreSettings RestoreUrc Resume ResumeScheduler SeedDrive SetAgentMetadataCredentials SetOracleMetadataCredentials StartExport StartExportAzure StartOracleDBVerifyJob StartOracleLogTruncationJob StopCoreService SuspendScheduler UpdateRepository Version VirtualStandby

Localization

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

Using PowerShell scripting with Rapid Recovery

Qualifiers Input Parameters for PowerShell Scripting Sample PowerShell scripts

PreTransferScript.ps1 PostTransferScript.ps1 PreExportScript.ps1 PostExportScript.ps1 PreNightlyJobScript.ps1 PostNightlyJobScript.ps1

Using Bourne shell and Bash scripting with Rapid Recovery

Input parameters for shell scripting Sample shell scripts

PreTransferScript.sh PostTransferScript.sh PreSnapshotScript.sh PostSnapshotScript.sh PostExportScript.sh

Get-UnprotectedVolumes

PowerShell Module > Rapid Recovery PowerShell module cmdlets > Get-UnprotectedVolumes

The Get-UnprotectedVolumes command returns information about volumes that are available for protection but not currently protected on the Core.

Usage

The usage for the command is as follows:

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

Table 128: Get-UnprotectedVolumes 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:

Lists all volumes available for protection (but not get protected) on the specified agent machine:

>Get-UnprotectedVolumes -protectedserver 10.10.10.10

Get-Version

PowerShell Module > Rapid Recovery PowerShell module cmdlets > Get-Version

The Get-Version command retrieves the product version of a Core or Agent software installation.

Usage

The usage for the command is as follows:

Get-Version -core [host name] -user [user name] -password [password] -protectedserver [name | IP address]

Command Options

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

Table 129: Get-Versioncommand 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.

Examples:

Retrieve the product version of the present Core installation:

Get-Version

Get-VirtualizedServers

PowerShell Module > Rapid Recovery PowerShell module cmdlets > Get-VirtualizedServers

The Get-VirtualizedServers command returns information about virtualized servers.

Usage

The usage for the command is as follows:

Get-VirtualizedServers -core [host name] -user [user name] -password [password]

Command Options

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

Table 130: Get-VirtualizedServers 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.

Examples:

Lists all virtualized servers on the local Core:

>Get-VirtualizedServers

Get-Volumes

PowerShell Module > Rapid Recovery PowerShell module cmdlets > Get-Volumes

The Get-Volumes command returns information about volumes on a specified machine that is protected by the Core.

Usage

The usage for the command is as follows:

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

Table 131: Get-Volumes 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:

Lists all volumes on the specified machine:

>Get-Volumes -protectedserver 10.10.10.10

Please select your product:

To serve you better, please complete the Purpose of your Chat:

Recommended Solutions for Your Problem

Rapid Recovery 6.3 - Command Line and Scripting Reference Guide

Get-UnprotectedVolumes

Usage

Command Options

Examples:

Get-Version

Usage

Command Options

Examples:

Get-VirtualizedServers

Usage

Command Options

Examples:

Get-Volumes

Usage

Command Options

Examples: