サポートと今すぐチャット
サポートとのチャット

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

NewCloudAccount

Use the NewCloudAccount command to add an account for a cloud provider to the Rapid Recovery Core. You can then use the account to store archives for retention or replication.

Usage

The usage for the command is as follows: 

/newcloudaccount -core [host name] -user [user name] -password [password] -displayname [name for the account] -type [cloud account provider] -useername [user name for the account] -key [secret key] -region [region for account] tenanatid [tenant ID] -authurl [authorization URL]
Command Options

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

Table 45: NewCloudAccount 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. 
-displayname
 The name you want to use for the cloud account. 
-type
 The type of cloud account. Supported values include:
  • amazon
  • openstack
  • rackspace
  • windowsazure
  • "windows azure"
  • azure 
-username
 The user name for the cloud account you want to add. This is the credential you use in the authentication process. The property has the following variations based on the cloud type:
  • Amazon - Access Key
  • OpenStack - User Name
  • Rackspace - User Name
  • Windows Azure - Storage Account Name 
-key
 The authentication key for the cloud account you want to add. This is the credential you use in the authentication process. The property has the following variations based on the cloud type:
  • Amazon - Secret Key
  • OpenStack - API Key
  • Rackspace - API Key
  • Windows Azure - Access Key 
-region
 The region of the cloud account you want to add. This option is required only for OpenStack and Rackspace acocunts. 
-tenantid
 The ID you use to authenticate an OpenStack cloud account. This option is required only for OpenStack accounts. 
-authurl
 The URL you use to authenticate an OpenStack cloud account. This option is required only for OpenStack accounts.
Examples:

Add a new cloud account with the name "Amazon S3 Account" with the access key "akey" and the secret key "skey:" 

>cmdutil /newcloudaccount -displayname "Amazon S3 Account" -type amazon -useername akey -key skey

OpenDvmRepository

Use this command to open an existing DVM repository created in AppAssure Core or Rapid Recovery Core.

Usage

The usage for the command is as follows: 

/opendvmrepository -localpath [local path] -sharepath [network share path] -shareusername [user name for network share] -sharepassword [network share password]
Command Options

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

Table 46: OpenDvmRepository command options
Option Description 
-?
 Display this help message. 
-localpath
 The path to the folder with a DVM repository on the local Core. 
-sharepath
 The path to the folder with the DVM repository on a CIFS share. 
-shareusername
 The user name you use to log in to the shared folder. 
-sharepassword
 The password you use to log in to the shared folder.
Example:

Open an existing DVM repository on the local machine: 

>cmdutil /opendvmrepository -localpath E:\Repository

Pause

An administrator can pause snapshots, export to virtual machines, or replicate a Core. The pause command accepts three parameters: snapshot, vmexport, and replication. Only one parameter can be specified. A snapshot can be paused until a certain time, if a time parameter is specified.

A user can pause replication in three ways:

  • On a source Core for all protected machines.(-[outgoing]).

    The administrator must specify the remote machine name with the outgoing replication pairing to pause outgoing replication on the source Core: 

    >cmdutil /pause replication /o 10.10.12.10
  • On the source Core for a single protected machine.(-protectedserver): 
    >cmdutil /pause replication /protectedserver 10.10.12.97
  • On target Core (-incoming).

    If the local Core is a target Core, the administrator can pause replication by specifying the source Core using the incoming parameter: 

    >cmdutil /pause replication /i 10.10.12.25
Usage

The usage for the command is as follows: 

/pause [snapshot | vmexport | replication] -core [host name] -user [user name] -password [password] -all | -protectedserver [name | IP address] -incoming [host name] | outgoing [host name] -time [time string]
Command Options

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

Table 47: Pause command options
Option Description 
-?
 Display this help message. 
-pause
 [snapshots], [replication] or [vmexport]. 
-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. 
-all
 Optional. Pause all agents on the selected Core. 
-protectedserver
 Optional. Pause current protected server. 
-incoming
 Optional. Host name of the remote core that replicates to the core machine. 
-outgoing
 Optional. Host name of the remote target core to which data is replicated. 
-time
 Optional. The time in the format ‘Day-Hours-Minutes’ when the snapshots will be resumed (only for snapshots pause).
Examples:

Pause creating snapshots for a specific protected server: 

>cmdutil /pause snapshot -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.10.4

Pause creating snapshots for a protected machine and resume it after three days, 20 hours, and 50 minutes: 

>cmdutil /pause snapshot -core 10.10.10.10 -user administrator -password 23WE@#$sdd -protectedserver 10.10.10.4 -time 3-20-50

Pause export to virtual machine for all protected machines on the core: 

>cmdutil /pause vmexport -core 10.10.10.10 /user administrator -password 23WE@#$sdd –all

Pause outgoing replication on the core for a specific protected machine: 

>cmdutil /pause replication –core 10.10.10.10 -user administrator -password 23WE@#$sdd –protectedserver 10.10.1.76

Pause outgoing replication for all protected machines on the target core: 

>cmdutil /pause replication -core 10.10.10.10 -user administrator -password -23WE@#$sdd –outgoing 10.10.1.63

Pause incoming replication for all machines on the target core: 

>cmdutil /pause replication –core 10.10.10.10 -user administrator -password 23WE@#$sdd –incoming 10.10.1.82

Protect

The protect command adds a server under protection by a core.

Usage

The usage for the command is as follows: 

/protect -core [host name] -user [user name] -password [password] -repository [name] -agentname [name | IP address] -agentusername [user name] -agentpassword [password] -agentport [port] -volumes [volume names]
Command Options

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

Table 48: Protect 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. 
-repository
 Name of a repository on the Core to which the protected machine data should be stored. The name must be enclosed in double quotes. 
-agentname
 Name or IP address of the server you want to protect. 
-agentusername
 User name for the server to be protected. 
-agentpassword
 Password for the server to be protected. 
-agentport
 Protected server port number. 
-volumes
 List of volumes to protect. Values must be enclosed in double quotes and separated by a space. Do not use trailing slashes in volume names; for example, use “c:” “d:”.

NOTE: Do not use trailing slashes in volume names.

Example:

Protect specific volumes of a server with the Core: 

>cmdutil /protect -core 10.10.10.10 -username administrator -password 23WE@#$sdd -repository “Repository 1” -agentname 10.10.9.120 -agentport 5002 -agentusername administrator agentpassword 12345 -volumes “c:” “d:”
関連ドキュメント

The document was helpful.

評価を選択

I easily found the information I needed.

評価を選択