On the upper-left of the window, Status 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 Gateway has failed. For example, this can occur when the Gateway has faulted on startup.
Start and Stop
At the top right of the window sits start and stop button. Start looks like a green play button while stop looks like a red stop sign. These buttons will start and stop the gateway, respectively.
These buttons are only available on windows installations.
The version of Ignition that is running on this computer.
On the lower-left of the window, Port shows the primary, non-encrypted port used by clients and web pages to communicate with the server. You can see the ports that you are using and you can change the ports and click the Save button to save the ports to the Gateway. Note that Gateway must be restarted for the changes to take effect.
When using any of the functions listed below in the Gateway Control Utility, the gateway must be running for them to work properly.
Go to web page
On the right side of the window, Go to web page launches a web browser to the Gateway home page.
On the right side of the window, Restart restarts the Ignition web server. This should only be used while the server is running to stop the gateway then automatically start it back up.
On the right side of the window, Reset Password will reset the root password of the system. This default is Username: admin, password: password and will grant access to the Gateway Webpage. Normally, this is not 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 about this feature 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.
On the right side of the window, Thread Dump downloads a file with the current states of all threads in the server. Inductive Automation uses this file for troubleshooting problems.
On the right side of the window, Gateway Backup downloads a Gateway backup
.gwbk file to the local file system. This creates the exact same file as the Gateway Backup in the Gateway Webpage. A Save dialog opens to let you specify where you want to save the file.
On the right side of the window, Gateway Restore asks for a Gateway backup
.gwbk file and restores it. This does the exact same restore as the Gateway Restore in the Gateway Webpage. Note: this will completely overwrite your existing Gateway.
Create offline activation request
On the right side of the window, Create offline activation request creates a file to use on the offline activation process. This is the same file created in the manual activation process.
On the right side of the window, Apply license.ipl asks for an .ipl file to use to complete the offline activation process. This is the same file used in the manual activation process.
Create offline unactivation request
On the right side of the window, Create offline unactivation request creates a file to use on the offline activation process. This is the same file created in the manual unactivation process.
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:
Options are as follows:
|Creates an |
Downloads a Gateway backup
You will be prompted whether it is OK to overwrite the file if another
|Shows the usage for this command.|
|Retrieves server status and port information from the Gateway if it is running.|
|Changes the Gateway http port.|
|Changes the Gateway https port.|
|Reset the password for the admin user.|
|Restarts the Gateway.|
Restores a gateway backup (.gwbk) file.
|Performs a thread dump in the Gateway and prints the dump to the command-line.|
|Creates an |
|-w,--||Applies a |
|Automatically answers |