System configuration backup/restore using the command line

An alternative to using the UI for a n Interchange system backup and restore is to use the command line tool: systemBackupRestore

You can use this tool to create backup files and to import these files to Interchange environments.

This tool is located in < install directory>\tools.

Note   As part of the restore procedure, Interchange restarts.

For a complete list of tool options, open a command console and enter the command:

systemBackupRestore ?

Command options are:

  • backup – Create an export/backup file.
  • restore – Import/restore a backup file.
  • user – The username to access Interchange.
  • pwd – The password to access Interchange.
  • certpwd – The export password, only used when importing private certificates.
  • importmode – (Optional) Options are REPLACE/IGNORE/UPDATE. Default = Replace) See Select the system import mode for details.
  • backupfile – The file name for the exported compressed file. Defaults to if not specified.

Export example:

./systemBackupRestore -backup -user admin -pwd Secret1 -certpwd Secret1 [-backupfile backupFileName]

Import example:

./systemBackupRestore -restore -user admin -pwd Secret1 [-certpwd Secret1] [-importmode REPLACE] [-backupfile backupFileName]

Log files

The systemBackupRestore tool records information in two log files.

  • To view a summary of import details, open this file:
  • < install directory>\logs\ImportOutput.log
  • To view a complete log, open this file:
  • < install directory>\logs\systemBackupRestore.log

Related topics

Related Links