Verifying Restore Status

Edit online

About this task

When you run the restore backup command, the restore process is initiated. You can then verify the status of a restore operation using the status restore command. This command checks the status of the given backup file and displays one of the following results:
Status Description
Success The restore of the given backup is successfully restored with the given parameters.
Failed The restore process has failed. If the error message instructs to perform open indices, follow the steps in the section, Troubleshooting a Failed Restore.
In progress The restore process is still in progress. This usually happens when the data being restore is large and you verify the status as soon as you initiate the restore process.
Completed with warnings The restore process is completed. However, there are some warning messages. You can check the warning messages in the log file found in the SAGInstallDir\InternalDataStore\logs folder.

To verify the status of a restore operation

Procedure

  1. From the command prompt, go to SAGInstallDir/IntegrationServer/instances/instance_name/packages/WmAPIGateway/cli/bin/.
  2. Run the following command:
    Linux 
    ./apigatewayUtil.sh status restore -name backup-file-name
    Windows 
    apigatewayUtil.bat status restore -name backup-file-name
    The restore status appears as shown below: 
    C:\SoftwareAG\IntegrationServer\instances\default\packages\WmAPIGateway\cli\bin>apigatewayutil.bat 
status restore -name sample

 The restore of sample is completed successfully

    You can include the following parameters as per your requirements:

    Parameter Description
    tenant Name of the tenant that you want to verify restore status.

    If you do not provide this parameter, the value is picked from pg.gateway.elasticsearch.tenantId property in config.properties file located at IntegrationServer\instances\instance_name\packages\WmAPIGateway\config\resources\elasticsearch.

    repoName Name of the repository that you want to verify.

    If you do not provide this parameter, the value is picked from the tenantparameter.

    analyticsDS Option to get the restore status of the analytics data store. Specify as true to get the restore status of the analytics data store.
    The sample command to get the restore status of the analytics data store is as follows: 
    apigatewayUtil.bat status restore -analyticsDS true 
-name samplebackup
    logLevel Allows you to specify the required level of log that you want to create. Log levels indicate the severity of logs. Available levels are:
    • Info. Provides the list of regular events that occur during the process. These events are informative.
    • Debug. Provides the events that could be useful, if you have to debug the process.
    • Warning. Indicates unexpected events that occurred during the process. Usually, these events do not interrupt or have an immediate effect on the process.
    • Error. Indicates the events that stop the functionality from working as designed.
    • Trace. Provides a much detailed events that could be useful for debugging.
    You can specify one of the log level with the logLevel parameter. For example, to create a log file of Warning level when listing backup files, you can run the following command: 
    apigatewayUtil.bat list backup -logLevel warning
    When you provide Error as the log level, then only the error level logs are saved. When you provide Debug as the log level, then Debug, Info, Warning and Error level logs are saved. When you provide Trace as log level, then all level logs are saved.

    This parameter is optional. If you do not specify the parameter, then the Info level logs are saved by default.

    logFileLocation Allows you to provide the location where you want to save the log file.
    For example, to save the log file in C:/apiglogs/backups, you can provide the location as seen in the following example: 
    apigatewayUtil.bat create backup -name samplebackup 
-logFileLocation C:/apiglogs/backups
    This parameter is optional. If you do not specify the parameter, the logs are saved in the following location SAGInstallDir/IntegrationServer/instances/instance_name/packages/WmAPIGateway/cli/logs/APIGWUtility.log.

    If you run the status restore command without the tenant and repoName parameters, then system checks for the given backup file in the default tenant and repository.