webMethods and Intelligent Business Operations 10.2 | API Gateway Configuration Guide | API Gateway Data Management | Backing up Your Data
 
Backing up Your Data
You can back up the API Gateway configuration information and data. At a later stage, you can restore the API Gateway database from the backup archive.
There are two types of backups: data backups and configuration backups.
The data backups are performed using the command tool apigatewayUtil.[bat|sh] create backup. The tool creates a backup archive of the Event Data Store data.
The configuration backups are performed using the command tool apigw-backup-tenant.[bat|sh]. The tool creates a backup archive of the API Gateway configuration information and data. It is typically used in the disaster recovery scenarios to backup the data periodically and restore the data in the event of any disaster.
The default location of the backed up data is the Integration Server_directory\EventDataStore\archives directory. You can write the backed up data to the EventDataStore\archives folder mount from an external NFS or S3 service. API Gateway uses NFS as the default repository in which the backup is stored.
Prerequisites for Backing up in a Distributed Environment
The following points are to be considered if API Gateway is installed in a clustered high availability setup:
*Configure a path to backup the Event Data Store.
*Restart the Event Data Store.
* To backup configurations and data
*Run the command apigw-backup-tenant.[bat|sh].
The syntax is of the format: C:\SoftwareAG\IntegrationServer\instances\default\packages\WmAPIGateway\cli\bin>apigw-backup-tenant.bat|sh -backupDestinationDirectory <directory_path_to_store_backup_file> -backupFileName <backup_file_name_without_spaces> -backupTemplate <file_path_to_backup_template> -packagesTemplate <file_path_to_packages_template> -help
The input parameters are:
Parameter
Description
-backupDestinationDirectory
Mandatory. The path to the destination folder where the backup will be created, for example: C:\SoftwareAG\AnotherBackupLocation
Specify this option only if you want to create the backup in a local directory or NFS itself.
-backupFileName
Optional. The file name for the data backup.
Note: The file name must not contain any spaces.
Default value is apigw_disaster_recovery_backup. .
If the file name is not specified, the default value is automatically set for this parameter.
-backupTemplate
Optional. The path to the configuration backup file, for example: C:\SoftwareAG\tenant-backup-template.txt
Note: The paths specified in the backup file should be relative to the Software AG root installation folder <SAGInstallDir>
Default value is C:\SoftwareAG\IntegrationServer\instances\{instance_name}\packages\WmAPIGateway\cli\bin\conf\tenant-backup-template.txt.
The backup file (tenant-backup-template.txt) contains a list of configuration files and folders that need to be backed up, with one file or folder name in each line. The backup file can also include custom configuration files, that are defined specifically for a particular API Gateway instance.
-packagesTemplate
Optional. The path to the backup file containing a list of custom packages to be backed up, one package name in each line.
Default value is conf/tenant-backup-packages.txt.
-help
Prints the help text summarizing the input parameters of this command.
The apigw-backup-tenant command creates the following entries in -backupDestinationDirectory:
*A ZIP file with the name specified for the parameter -backupFileName. This ZIP file contains the backup of API Gateway configurations.
If a file name is not specified in this parameter, then the command creates a ZIP file named -backupFileName.zip.
*Directory named default. This directory contains the backup of Event Data Store.
The command also creates a backup log file named backup-tenant.log in the <SAGInstallDir>\IntegrationServer\instances\{instance_name}\packages\WmAPIGateway\cli\bin directory.
Copyright © 2015- 2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release