restoresnapshots CLI command
Use this command to restore data from archives for a specified period. You can also use this command to see the status of or cancel an ongoing restore process.
Syntax
Note
Before you run the command, note the following points:
- Set up the CLI. For more information, see Managing the product from the command line interface.
- Prefix this command with the following, as appropriate:
- For Windows: itda.bat
- For Linux: ./itda.sh
restoresnapshots -u <username> -w <password> -p <port> -d <hostname> -action <action> -l [locale] -s[Protocol to connect with IT Data Analytics] -retentionDays [number of days]Angle brackets (< >) indicate a variable value that needs to be user defined.
Square brackets ([ ]) indicate optional parameters.
The following table describes the parameters used in the syntax:
| Parameter | Description |
|---|---|
-d | Host name of the Console Server. |
-p | Port number of the Console Server. |
-u | Admin username of TrueSight IT Data Analytics. |
-w | Admin Password of TrueSight IT Data Analytics. |
-action | You can specify the action to be executed in the following ways:
|
-s | (Optional) Indicates an HTTPS connection. |
-l | (Optional) Indicates the locale in which you want to display messages when the command is run. You can set one of the following locales:
By default, the messages are displayed in the locale of the system on which the CLI is run. The value can be set to one of the following depending on the locale you choose:
Example: If you want to set the locale as Simplified Chinese, you need to specify, |
-retentionDays | (optional) The number of days for which the restored data is to be retained in live data. The default value is 2 days. |
Example inputs
The following example provides the input for restoring data for a specified period:
restoresnapshots -u admin -w admin12345 -p 9797 -d localhost -action restore -startDate 2016-10-10 -endDate 2016-12-12 -retentionDays 4The following example provides the input to get the status of the ongoing restore process:
restoresnapshots -u admin -w admin12345 -p 9797 -d localhost -action status -retentionDays 4The following example provides the input to cancel the ongoing restore process:
restoresnapshots -u admin -w admin12345 -p 9797 -d localhost -action cancel -retentionDays 4
Comments