Archive
Businesses often use long-term storage to archive both compliant and non-compliant data. The archive feature in Rapid Recovery supports extended retention for compliant and non-compliant data. The administrator can save an archive on the local storage or network location by specifying the -path parameter and credentials.
Usage
The usage for the command is as follows:
Start-Archive -core [host name] -user [login] -password [password] -all | -protectedserver [name | IP address | "[name1 | IP address1]" "[name2 | IP address2]"] -path [location] -startdate [time string] -enddate [time string] -archiveusername [name] -archivepassword [password] -comment [text] -cloudaccountname [name] -cloudcontainer [name] -recycleaction [type] -legalhold -retentionmode [mode] -retain [days] -usecompatibleformat -useglacierfordatafiles
Command Options
The following table describes the options available for the archive command:
Table 2: Archive command options
-? |
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. |
-all |
Archive all recovery points for all protected machines on the Core. |
-protectedserver |
Protected machine with recovery points to be archived. You can specify several machine names enclosed in double quotes and separated by spaces. |
-path |
Path where archived data should be placed; for example: d:\work\archive or network path \\servername\sharename. |
-startdate |
Start date for selecting recovery points by creation date. The value must be enclosed in double quotes; for example, "04/30/2012 02:55 PM". |
-enddate |
Optional. End date for selecting recovery points by creation date. Value must be enclosed in double quotes; for example, "05/31/2012 11:00 AM". The current time system is used by default. |
-archiveusername |
Optional. User name for the remote machine. Required for network path only. |
-archivepassword |
Optional. Password to the remote machine. Required for network path only. |
-comment |
Optional. Comment text must be enclosed in double quotes; for example: -comment “comment goes here...”. |
-usecompatibleformat |
Not supported for scheduled archives. The new format has improved performance, but it is not compatible with Cores older than release 6.2. Use this flag to create an archive that can be used with the old format. |
-cloudaccountname |
Optional. The name of the cloud account to which you want to save the archive. |
-cloudcontainer |
Optional. The name of the cloud container in the specified cloud account to which you want to save the archive. |
-recycleaction |
Specifies one of the following recycle action types:
"donotreuse" - This type is not supported for scheduled archive. It does not overwrite or clear any existing archived data from the location. If the location is not empty, the archive write fails.
"replacethiscore" - This type overwrites any pre-existing archived data that pertains to this Core, but leaves the data for other Cores intact.
"erasecompletely" - This type clears all archived data from the directory before writing the new archive.
"incremental" - This type lets you add recovery points to an existing archive. It compares recovery points to avoid duplicating data that already exists in the archive. |
-initialpause |
Optional. Specify whether you want to initially pause the archive job when you create it. |
-useglacierfordatafiles |
Optional. Only when archiving to an Amazon cloud. Specify this option if you want to use Amazon Glacier for archiving data files. |
| -legalhold |
Optional. Supported only for Amazon S3 and S3-compatible cloud storage. Provides the same protection as a retention period, but it has no expiration date. Instead, a legal hold remains in place until you explicitly remove it. Legal holds are independent from retention periods. |
| -retentionmode |
Optional. Supported only for Amazon S3 and S3-compatible cloud storage. Retention period and retention mode are always configured in tandem, unlike legal holds, which are configured independently. S3 Object Lock provides two retention modes that apply different levels of protection to your archives:
- "governance" mode - In governance mode, users can't overwrite or delete an object version or alter its lock settings unless they have special permissions. With governance mode, you protect objects against being deleted by most users, but you can still grant some users permission to alter the retention settings or delete the object if necessary.
- "compliance" mode - In compliance mode, a protected object version can't be overwritten or deleted by any user, including the root user in your AWS account. When an object is locked in compliance mode, you cannot change the retention mode, and you cannot shorten the retention period. Compliance mode helps ensure that an object version can't be overwritten or deleted for the duration of the retention period.
|
| -retain |
Optional. Supported only for Amazon S3 and S3-compatible cloud storage. Specifies a fixed period of time during which an object remains locked. During this period, your object is WORM-protected and can't be overwritten or deleted. |
| -vaultlegalhold |
Optional. Supported only for Amazon Glacier! "Legal hold" vault locking mode. Provides the same protection as a retention period, but it has no expiration date. |
| -vaultretain |
Optional. Supported only for Amazon Glacier! Specifies a fixed period of time during which an vault remains locked. During this period, your vault is WORM-protected and can't be overwritten or deleted. |
Examples:
Example 1 : Start archive of a particular protected machine to local target:
>Start-Archive -user administrator -password qwerty123 -protectedserver 10.23.20.186 -path E:\Archives\W7AGENT -startdate "6/12/2015 12:00:00 AM" -enddate "6/13/2015 12:00:00 AM" -recycleaction "incremental"
Example 2 - Start archive of a particular protected machine to network target:
>Start-Archive -user administrator -password qwerty123 -protectedserver 10.23.20.186 -path \\10.23.20.137\share -archiveusername administrator -archivepassword 321ytrewq -startdate "6/12/2015 12:00:00 AM" -enddate "6/13/2015 12:00:00 AM" -recycleaction "incremental"
Example 3 - Start archive of a particular protected machine to cloud target (Note: Configured cloud account is required):
>Start-Archive -user administrator -password qwerty123 -protectedserver 10.23.20.186 -path W7AGENT -cloudaccountname "Cloud Account 1" -cloudcontainer Archive -startdate "6/12/2015 12:00:00 AM" -enddate "6/13/2015 12:00:00 AM" -recycleaction "incremental"
Example 4 - Start archive all recovery points to Amazon S3 cloud storage with creation dates starting from 12/31/2023 12:00:00 PM for specified machine on the core, set object lock mode "Legal hold" and retention mode "Governance" with retain period of 5 days:
>Start-Archive -protectedserver localhost -cloudaccountname "storage account name" -cloudcontainer "bucket-01" -path "Archive-0000001" -startdate "12/31/2023 12:00:00 PM" -recycleaction donotreuse -legalhold -retentionmode governance -retain 5
CancelActiveJobs
Use the cancelactivejobs command to cancel the execution of all in-progress jobs of a specific type, such as transfer or replication.
Usage
The usage for the command is as follows:
/cancelactivejobs [-protectedserver [name : IP address] : -a[ll]] -core [host name] -user [user name] -password [password] -jobtype [job type filter]
Command Options
The following table describes the options available for the cancelactivejobs command:
Table 3: CancelActiveJobs command options
-? |
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 must also provide a user name. If none is provided, the logged-in user’s credentials are used. |
-protectedserver |
Determines the protected machine on which the jobs should be canceled. |
-all |
Select and cancel events of specified type for all protected servers. |
-jobtype |
Optional. Specifies job type filter. Available values are:
- ‘transfer’ (data transfer)
- ‘repository’ (repository maintenance)
- ‘replication’ (local and remote replications)
- ‘backup’ (backup and restore)
- ‘bootcdbuilder’ (create boot CDs)
- ‘diagnostics’ (upload logs)
- ‘exchange’ (Exchange Server files check)
- ‘export’ (recovery point export)
- ‘pushinstall’ (deploy agents)
- ‘restore’ (recovery point restore)
- ‘rollup’ (recovery point rollups)
- ‘sqlattach’ (agent attachability checks)
- ‘mount’ (mount repository)
By default, all jobs of the specified type are canceled. |
Example:
Cancel all transfer jobs on Core 10.10.10.10:
>cmdutil /cancelactivejobs -core 10.10.10.10:8006 -user administrator -password 23WE@#$sdd -jobtype transfer
CheckRepository
You can use the CheckRepository command to verify the integrity of an existing DVM repository created in AppAssure Core or Rapid Recovery Core.
Usage
The usage for the command is as follows:
/checkrepository -repository [repository name] | -all [check all repositories] -core [host name] -user [user name] -password [password] name] -force
Command Options
The following table describes the options available for the CheckRepository command:
Table 4: CheckRepository 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 |
Optional. This option checks all DVM repositories associated with the Core. |
-repository |
The name of the DVM repository. |
-force |
Optional. This option performs the check without your confirmation. |
Example:
Start checking the DVM repository:
>cmdutil /checkrepository -repository "Repository1" -core 10.10.10.10 -user administrator -password 23WE@#$sdd
ConfigureAgentMigration
This command lets you move the recovery points of a protected machine from an AppAssure repository to a Rapid Recovery repository. This command also reassigns the protected machine to the new repository.
Usage
The usage for the command is as follows:
/configureagentmigration -core [host name] -user [user name] -password [password] name] -agentname [name of the protected machine] -targetrepository [repository name] -lastrecoverypointdate [MM/dd/yyyy HH:mm:ss tt] -asnightlyjob
Command Options
The following table describes the options available for the ConfigureAgentMigration command:
Table 5: ConfigureAgentMigration command options
-? |
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. |
-agentname |
The name of the protect machine you want to migrate. |
-targetrepositoryname |
The name of the repository to which you want to migrate the protected machine. |
-lastrecoverypointdate |
Optional. The date and time of the last recovery point you want to migrate. Migration will not occur for recovery points older than the specified date and time. If you do not specify a date and time, then all recovery points for the protected machine will migrate. |
-asnightlyjob |
Optional. Use this option if you want the command to occur as a nightly job rather than during peak business hours. |
Example:
Migrate the protected machine from an AppAssure repository to a Rapid Recovery repository:
>cmdutil /configureagentmigration -agentname localhost -targetrepositoryname repository1 -lastRecoveryPointDate "10/15/2014 3:19:10 PM" -asNightlyJob
