Gateway Control Utility

The Gateway Control Utility, sometimes referred to as simply the "GCU", is a lightweight stand-alone application that can provide information about the Ignition gateway. It also provides basic administrative controls, such as stopping and restarting the server, and setting the ports used between the gateway and clients. Note that the Gateway Control Utility must run on the same machine as the Ignition gateway.

Windows: The GCU can be launched from the start menu under Programs > Inductive Automation > Ignition > Launch Gateway Control Utility. You can also launch the GCU from either a command line or from the Start -> Run dialog by typing launch-gcu

Linux: The GCU can be launched by opening a command shell and typing gcu. If you receive an error saying that "gcu can't be found", then you need to add the Ignition installation directory to your system path. See the Installation (Linux) section for instructions. If you are running in a headless Linux environment, or you have logged into the Linux machine through an SSH shell, then the functions of the GCU are still available in command-line form. See the Command Line Utility section below.

The upper left side of the screen shows the state of the Tomcat web server and the Ignition Gateway web application. It is possible for the web server to be running while the Gateway has failed. For example, this can occur when the Gateway has faulted upon startup.

Allows you to reset the root password of the system. This is not normally considered a security risk, because the GCU can only be used from the machine the software is installed on, which should be secure. However, it is important to know that this function is here, so that the GCU can be removed if the machine can't be properly secured (for example, when the server is also used as a client).

Downloads a file with the current states of all threads in the server, used by Inductive Automation for troubleshooting problems.

Downloads a Gateway backup (.gwbk) file to the local file system. A Save File dialog will open, allowing you to specify where to save the .gwbk file.

Sets the primary, non-encrypted port used by clients to communicate with the server. Click the Save button to apply the port change to the gateway. The gateway must be restarted for the change to take effect.

Sets the port that will be used by clients for SSL communication. Click the Save button to apply the port change to the gateway. The gateway must be restarted for the change to take effect.

Windows users get two additional buttons at the top. The stop button stops the Ignition Windows service, and the start button starts the Ignition Windows service. Linux users can stop and start the gateway with these command-line commands:

All the functions in the GCU are also available as a command line utility for both Windows and Linux. To run the utility, open a command shell and type in:

-b,--backup <new file path>	Downloads a Gateway backup (.gwbk) file and saves the file to the specified path. The path can be either an absolute path or a relative path.If a new file name is not specified at the end of the path, then the file name will become the current date and time along with the .gwbk extension. You will be prompted whether it is OK to overwrite the file if another .gwbk file with the same name already exists (override with the -y option to force the file to always be overwritten).
-h,--help	Shows the usage for this command
-i,--info	Retrieves server status and port information from the Gateway if it is running
-k,--port <new port>	Changes the Gateway http port
-l,--sslport <new port>	Changes the Gateway https port
-p,--passwd	Resets the Gateway login password
-r,--restart	Restarts the Gateway
-t,--tdump	Performs a thread dump in the Gateway and prints the dump to the command line
-y,--promptyes	Automatically answers "yes" to any prompt that may appear in the above commands (such as permission to overwrite an existing file).