Configure Gateway restore on Gateway 1.7.0

[EcoStruxureIT]

For configuring restore in Gateway 1.8 and newer, see Configure Gateway restore in Gateway 1.8 

Backup files contain operating system-specific parameters. Restore a Windows system from a Windows backup, and a Linux system from a Linux backup.

IMPORTANT: You can restore a backup from the same version of Gateway only. 

The backup keeps the existing Gateway serial number.

If you are using a proxy server, run this command before you run the restore:

SET _JAVA_OPTIONS=-Dhttp.proxyHost=x.x.x.x -Dhttp.proxyPort=443

Note: x.x.x.x is the IP address of the proxy server. You might also need to change the port if the proxy server is not at 443.

Windows restore

Restore is run from a Windows command prompt.

To restore from a previously created backup:

1. Open a command prompt as administrator on the computer where the Gateway is installed.
2. Navigate to C:\Program Files\EcoStruxure IT Gateway\x.x.x\restore
   Type the command cd C:\Program Files\EcoStruxure IT Gateway\x.x.x\restore
3. Type the command restore.bat
   The utility searches for backups at the location you specify, and prompts you to choose the correct backup.
   After a series of confirmations, the restore process will begin.

When you do not add arguments to the command, all the possible arguments are displayed on the screen, including examples of how to execute the restore process.

Examples

restore.bat restore -serviceName EcoStruxureITGateway-1.7.0.64 -mntType WINDOWS_SHARE -server 1.2.3.4 -share backupShare -dir backupDir -domain aa.bb.com -user admin -pw -zipPw

Note: -user and -pw  and -zipPw are required. Specify the user for the file server.

You will be prompted for the backup location and the encrypted zipfile password after the command is run. The encrypted zipfile password is the serial number of your Gateway.

restore.bat password-reset 

Note: This resets the Gateway admin user’s password. To reset the admin password, you must also go to Control Panel > Administrative Tools > Services and restart the EcoStruxure IT Gateway Server service.

Linux restore

To restore from a previously created backup:

1. Open a command prompt on the computer where the Gateway is installed.

2. Type the command cd /opt/EcoStruxureITGateway/x.x.x/restore

3. Type the command ./restore.sh
   The utility searches for backups at the location you specify, and prompts you to choose the correct backup.
   After a series of confirmations, the restore process will begin.

When you do not add arguments to the command, all the possible arguments are displayed on the screen, including examples of how to execute the restore process

Examples

./restore.sh restore -serviceName EcoStruxureITGateway-1.7.0.64 -mntType WINDOWS_SHARE -server 1.2.3.4 -share backupShare -dir backupDir -domain aa.bb.com -user admin -pw -zipPw

Note: -user and -pw  and -zipPw are required. Specify the user for the file server.

You will be prompted for the backup location and the encrypted zipfile password after the command is run. The encrypted zipfile password is the serial number of your Gateway.

./restore.sh password-reset

Note: This resets the Gateway admin user’s password. To reset the admin password, you must also restart the EcoStruxure IT Gateway Server.  The command can be run from any directory by sudo users. Type systemctl restart EcoStruxureITGateway-x.x.x.service 

Possible arguments

list List database backups
Usage: list [options]
Options:
-backup
backup to restore to
* -dir
backup directory on remote server
-domain
domain of remote server
* -mntType
mountType 'WINDOWS_SHARE'|'NFS'  Note: There is an issue using NFS shares for backup. Windows shares work as expected for the gateway installed on both Linux and Windows.
-pw
prompt for password for file server
-zipPw
prompt for encrypted zipfile password
* -server
remote backup server ip or name
* -share
remote mount point
-user
username for file server

restore Restore database
Usage: restore [options]
Options:
-backup
backup to restore to
* -dir
backup directory on remote server
-domain
domain of remote server
* -mntType
mountType 'WINDOWS_SHARE'|'NFS'
-pw
prompt for password for file server
-zipPw
prompt for encrypted zipfile password
* -server
remote backup server ip or name
* -share
remote mount point
-user
username for file server

 password-reset Reset Gateway administrator password
Usage: password-reset [options]