KB Article #180641
LEC: Backup and Restore for Windows-based Secure Transport installations with external database
Problem
This article provides instructions for backup and restore of the SecureTransport software on Windows and provides information on the following topics:
- Back up the existing Secure Transport installation
- Database backups - MSSQL and Oracle
- Database restore - MSSQL and Oracle
- Recover the SecureTransport installation from backup
For Unix-based Secure Transport installations, refer to KB article 180639.
Back up the existing installation
A full SecureTransport backup must include:
- Application backup
- Database backup
IMPORTANT NOTE: The backups created with the below procedure, should be restored on machines with the same IP(s) and hostname and into the original installation folder of your previous SecureTransport installation.
Application backup
Prerequisites and considerations
The backup consist of copying the contents of the Secure Transport directories, preserving the subdirectory structure.
When ST is installed on a VM, another backup mechanism is to take a snapshot of the VM machine, with the ST services stopped. Refer to your virtualization administrator for suggestions.
In case of multiple ST nodes in the cluster, it is recommended that application backup and restore is done for each ST node independently.
Make sure the Cygwin console and all Cygwin tools installed with your previous SecureTransport installation, including the Cygwin cron service, are closed. Check the Users tab in the Windows Task Manager to make sure no one else is using Cygwin. If necessary, close the Cygwin console and tools manually.
Make sure that no folder in $FILEDRIVEHOME
or $FILEDRIVEHOME\..\cygwin
is in use or open in Windows Explorer or in a command window and that no file in those folders is in use or open in any application. Close Windows Explorer and any other application accessing the folders in question. Make sure no SecureTransport services, including Cygwin, are running
Steps
Stop all the SecureTransport services with $FILEDRIVEHOME\bin\stop_all
You can also open CMD as an administrator and simply run stop_all
.
Verify all services are stopped by checking for running processes and looking for .pid files in the $FILEDRIVEHOME/var/run
directory (there should not be leftover .pid files there). Being extra cautious, in the rare case where there are no .pid files but some processes still remained active, you can examine the process tree with the appropriate OS tools for running processes before proceeding further.
Back up Windows registry entries. Run regedit.exe
.
Select each of the following registry entries:
HKEY_LOCAL_MACHINE\SOFTWARE\Axway Software HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\Axway_Installer_4.8.0 SecureTransport01 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\cygwin_cron HKEY_LOCAL_MACHINE\SOFTWARE\Tumbleweed HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Cygnus Solutions HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\AxwaySecureTransport*
where AxwaySecureTransport* represents all the registry entries that start with "AxwaySecureTransport".
Right click each entry, select Export → Export Registry File, and save the registry entry to a safe location.
When you are finished backing up the registry entries, exit regedit.
Back up the files of the existing SecureTransport installation by copying the contents of the following directories, preserving the subdirectory structure, to a ZIP file or some other achrive type.
- The Axway Installer directory (for example:
C:\Axway\
) - The SecureTransport home directory (this is required when the SecureTransport directory is outside of the Axway Installer directory from the previous point)
Move the archives to a safe location (or multiple) outside the ST host server as best practice
Database Backup
- For a SecureTransport Server using an external Oracle database, refer to KB 180637.
- For a SecureTransport Server using an external Microsoft SQL Server database, refer to KB 180635.
Recover the SecureTransport installation from a backup
The two main situations in which the SecureTransport installation needs to be recovered:
- A failed application upgrade
- In case of Disaster Recovery (i.e. after a hardware failure)
Recover ST installation after a failed upgrade
Prerequisites and considerations
Secure Transport should be recovered on the original machine the backup was taken from.
In case of multiple ST servers, each of them should be restored independently.
WARNING: You can not use a backup of a Server A to restore ST on Server B, when both servers A and B are part of a cluster. Each node of a cluster MUST have its own separate backup!
Database Restore
Make sure all ST services are stopped with $FILEDRIVEHOME\bin\stop_all
.
Uninstall the current failed SecureTransport installation before you attempt to recover.
Restore the database
- For a SecureTransport Server using an external Oracle database, restore the database using standard Oracle procedures or refer to KB 180637.
- For a SecureTransport Server using an external Microsoft SQL Server database, restore the database using standard Microsoft procedures or refer to KB 180635.
Application Restore
Move or delete the current Axway Installation directory and Secure Transport home directory
Extract the backup archive files into the original folders of your previous SecureTransport installation.
Run regedit.exe
and delete the following registry entries:
HKEY_LOCAL_MACHINE\SOFTWARE\Axway Software HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\Axway_Installer_4.8.0 SecureTransport01 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\AxwaySecureTransport*
Restore the registry entries that you backed up. To import a registry entry into the Windows registry, double-click the name of the respective .reg files you saved when you backed up your installation.
Make sure the file cygwin1.dll
is included in your PATH environment variable. For example, the following directory should be included in the PATH: C:\Axway\SecureTransport\cygwin\bin
.
Make sure the folder STServer\bin
is included in your PATH environment variable. For example, the following directory should be included in the PATH: C:\Axway\SecureTransport\STServer\bin
.
Install the SecureTransport services: execute the following files from the $FILEDRIVEHOME\bin
directory:
install_ftpd_service.com install_httpd_service.com install_sshd_service.com install_tm_service.com install_admin_service.com install_as2d_service.com install_pesitd_service.com
Change the account the SecureTransport services are running, to the same account as before the upgrade.
Install Cygwin cron: launch the Sygwin shell as described in KB 178648. In the Cygwin shell window, type:
cygrunsrv -I cygwin_cron -d Cygwin_cron -p /usr/sbin/cron \-a -D -f Cygwin_Cron
Reboot your system.
Start ST's services with $FILEDRIVEHOME\bin\start_all
NOTE: If some of the ST services are not added and registry keys are not created for them, for example, service for AS2 or PeSIT protocol, you can start at least the Admin service, just enable them from the Admin UI → Operations → Server Control page and try to add them again using install_*_service.com
scripts located in the $FILEDRIVEHOME\bin
folder.
Secure Transport Disaster Recovery
In case the server where Secure Transport was installed fails beyond repair and has to be rebuilt, follow the procedure below to recover the Secure Transport instance.
On the newly installed system, change the hostname and IP to match the ones of the failed server.
Make sure the new server meets the OS prerequisites from the ST Installation Guide, chapter Prerequisites → Windows platforms.
Make sure you have administrative privileges on the machine where you want to install SecureTransport Server or Edge.
Local Administrator credentials are required to install SecureTransport. Installation by an LDAP user with Administrator privileges is not supported.
Add the file cygwin1.dll
to your PATH environment variable. For example, the following directory should be included in the PATH: C:\Axway\SecureTransport\cygwin\bin
.
Add the folder STServer\bin
to your PATH environment variable. For example, the following directory should be included in the PATH: C:\Axway\SecureTransport\STServer\bin
.
Restore the registry entries that you backed up, except the keys listed below:
[HKEY_LOCAL_MACHINE\SOFTWARE\Axway Software] [HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\Axway_Installer_4.8.0 SecureTransport01] [HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Cygnus Solutions] [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\cygwin_cron] [HKEY_LOCAL_MACHINE\SOFTWARE\Tumbleweed]
Install the SecureTransport services: execute the following files from the $FILEDRIVEHOME\bin
directory:
install_ftpd_service.com install_httpd_service.com install_sshd_service.com install_tm_service.com install_admin_service.com install_as2d_service.com install_pesitd_service.com
Install Cygwin cron: launch the Sygwin shell as described in KB 178648. In the Cygwin shell window, type:
cygrunsrv -I cygwin_cron -d Cygwin_cron -p /usr/sbin/cron \-a -D -f Cygwin_Cron
Reboot your system.
Start ST's services with $FILEDRIVEHOME\bin\start_all