Gateway appliance troubleshooting tools - version 1.9 and older

[EcoStruxureIT]

Support for Gateway Appliances ended in December 2023.

It is strongly advised that you migrate to a new installation of the Gateway software.

See How to replace your EcoStruxure IT Gateway with a new installation

There are several tools provided with the Gateway appliance to help you troubleshoot the device if needed. All of these tools are available in Webmin. To access Webmin, connect a laptop to the Gateway appliance private network (Port 2), open a browser, and go to https://192.168.0.1:10000.

Tools

After you log in to Webmin, go to System Configuration >Tools to find utilities to help you troubleshoot the appliance.

webmin_tools_360019038233.jpg

Check EcoStruxureITGateway Status

This is a one-click command to see the current running state of the system. It outputs current IP configuration on all ethernet adapters, state of the EcoStruxure Gateway services, and the Gateway version information. Additionally, the command will try to confirm the status of the Gateway webserver on all available networks. Each attempt will return an HTTP status code. Typically, you will see a 000 code if the webserver was not running and a 200 code if it is online and running properly.

Note: Starting with Gateway version 1.8.0, the HTTP status return codes for the Gateway Server Web API incorrectly return as 403 when the system is actually working normally. This is a false failure and should be disregarded. 

Configure DHCP Interface

Use this utility to configure which physical adapter is listening for DHCP client requests. By default, this is set to the Private network, Port 2 (eth1). Use this utility to set the value DISABLED to turn off listening for DHCP requests. This is especially useful when putting a Gateway appliance along side a DCE on the private side of the DCE where the DCE is the DHCP provider.

Reboot Server

This executes an OS level system reboot of the Gateway appliance.

Reset Gateway Admin Password

This utility resets the Gateway "admin" user password back to the default password in case you lock yourself out. Run the reset script and then restart the Gateway services for the change to take effect. This reset only affects the "admin" user account.

Restart EcoStruxure IT Gateway

This utility performs an OS level service restart on both Gateway services: the web application and the database.

Restore to Defaults

This utility reverts the selected component back to default values:

Webmin - Reverts any Webmin customization back to default. This restarts Webmin; you will temporarily lose connection

Network - Reverts eth0 and eth1 to their default out of box config. Also clears values from /etc/resolve.conf (DNS entries) and /etc/sysconfig/network (hostname) After reverting, it initiates an OS reboot.

DHCP - Recreates the DHCP scope and enables DHCP server on Private network, Port 2 (eth1)

Gateway - Performs an uninstall / reinstall of the Gateway software using the installer included with the original ISO.

Shutdown Server

This initiates an OS shutdown. Someone needs to physically press the power button on the appliance to turn it back on. This should be used anytime the device needs to be powered off gracefully.

Start SSH server

This issues a service start request for SSH on the appliance. By default, SSH is disabled.

Warning: Do not enable SSH access unless Schneider Electric technical support requests it for troubleshooting.

Enabling SSH increases the risk of remote login attempts to your Gateway on the standard SSH port, and makes your system a potential target for obtaining shell access.

Stop SSH server

This issues a service stop request for SSH on the appliance. Note that rebooting the device will also cause the SSH server to stop.