Chat now 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

Set-AgentMetadataCredentials

The Set-AgentMetadataCredentials command sets the metadata credentials for a specified protected machine.

Usage

The usage for the command is as follows:

Set-AgentMetadataCredentials -core [host name] -user [user name] -password [password] -protectedserver [name | IP address] -target [default | SQL | Exchange] -metadatausername [user name] -metadatapassword [password] -sqlinstancename [SQL instance name] -usewindowsauthentication
Command Options

The following table describes the options available for the Set-AgentMetadataCredentials command:

Table 172: Set-AgentMetadataCredentials 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.
-target
Optional. The type of metadata, such as SQL, Exchange, or default.
-metadatausername
Optional. The metadata-related login.
-metadatapassword
Optional. The metadata-related password.
-sqlinstancename
Optional. The specific SQL instance name. Use this option in conjunction with the -target "sql."
-usewindowsauthentication
Optional. Use this option if your SQL credentials are also used for Windows authentication.
Examples:

Set credentials for Exchange metadata:

>Set-AgentMetadataCredentials -core 10.10.10.10 -user administrator -password -23WE@#$sdd -protectedserver 10.10.20.20 -target exchange -metadatausername administrator -metadatapassword 123#

Set-CredentialsVaultAccount

The Set-CredentialsVaultAccount cmdlet lets you set up a Credentials Vault account for a specified Core.

Usage

The usage for the command is as follows:

Set-CredentialsVaultAccount [-AccountId <string>] [-AccountUserName <string>] [-AccountPassword <string>] [-Description <string>] [-User <string>] [-Core <string>] [-Password <string>] [<CommonParameters>]
Command Options

The following table describes the options available for the Set-CredentialsVaultAccount command:

Table 173: Set-CredentialsVaultAccount 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.

-accountid
Required. The identifier of the Credentials Vault account that you want to remove.
-accountusername
Required. The user name for logging in to the Credentials Vault account that you want to set up.
-accountid
Required. The identifier of the Credentials Vault account that you want to remove.
-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.
Examples:

Establish a Credentials Vault account for the Core:

>Set-CredentialsVaultAccount -accountid CVaccount1 -accountusername user1 -accountpassword password1 -core 10.10.10.10

Set-DedupCacheConfiguration

This PowerShell cmdlet lets you set the location, size, and metadata location for the primary and secondary cache of a DVM repository.
Usage

The usage for the command when creating a DVM repository is as follows:

Set-DedupCacheConfiguration -core [host name] -user [user name] -password [password] -primary [cache location] -secondary [cache location] -metadata [metadata location] -size [cache size] -restoredefault
Command Options

The following table describes the options available for the Set-DedupCacheConfiguration command:

Table 174: Set-DedupCacheConfiguration command options
Option Description
-?
Display help on the command.
-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.
-primary
Optional. Primary cache location.
-secondary
Optional. Secondary cache location.
-metadata
Optional. Metadata cache location.
-size
Optional. Deduplication cache size in GB.
-restoredefault
Optional. Restore to default deduplication cache configuration. If this parameter is specified, all other parameters are ignored.
Examples:

Set primary deduplication cache location and deduplication cache size:

>Set-DedupCacheConfiguration -primary D:\primary -size 6

Set secondary and metadata deduplication location:

>Set-DedupCacheConfiguration -secondary D:\secondary -metadata D:\metadata

Restore default deduplication configuration:

>Set-DedupCacheConfiguration -restoredefault

Set-License

The Set-License PowerShell cmdlet lets you change the license associated with your Rapid Recovery Core. This is useful, for example, when moving from a trial license to a subscription or perpetual license.

Usage

The usage for the command is as follows:

Set-License -core [host name] -user [user name] -password [password] -licensekey [license key] -licensepath [license file path] -licensenumber [license number] -email [email address]
Command Options

The following table describes the options available for the Set-License command:

Table 175: Set-License 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.
-licensekey
Optional. A 30-character key comprising six groups of five alphanumeric characters, each separate by a hyphen. Use this key when a license file is not available.
-licensepath
Optional. The path to the file that ends with the .lic extension. If a license file is available, you can use this option instead of the -licensekey.
-licensenumber
Optional. You may have received this nine-digit license number in an order confirmation email. If you provide this number, use the email address that received it for verification.
-email
Optional. If you use the -licensenumber, you must include the email address that received it for verification.
Examples:

Change the license key associated with this Core to JL09F-89FSD-6THFS-DSE34-KS3D5-65DF2:

>Set-License -core 10.10.10.10 -user admin -password 676df#df -licensekey JL09F-89FSD-6THFS-DSE34-KS3D5-65DF2

Change the license key associated with this Core to the key contained in the license file:

>Set-License -core 10.10.10.10 -user admin -password 676df#df -licensepath C:\MyLicenseFile.lic

Change the license number associated with this Core to 111-111-111 using john.doe@example.com to verify the license:

>Set-License -core 10.10.10.10 -user admin -password 676df#df -licensenumber 111-111-111 -email john.doe@example.com
관련 문서