Version: 8.0

LESSON

The Command Line Utility

Description

The Command Line Utility which interacts with the Ignition Gateway server allows you to get information such as running status, version number, and port numbers. It also lets you start and stop the server, make backups, and most importantly you can reset the Gateway password from it.

Video recorded using: Ignition 8.0

Transcript

(open in window)

[00:00] On the server that Ignition is installed on there is a command-line utility that allows you to run some basic actions against the gateway. These basic actions include things like: taking a backup of your Ignition Gateway, changing the ports that the gateway is running on, or even activating a new license. For a full list of the available actions, see our User Manual on the page Gateway Command Line Utility. Let's take a look at it in action. I have my gateway webpage open here but I seem to have forgotten the password for my admin user account. The gateway command-line utility can help with that. The command-line utility is run from a command shell program. So for my Windows operating system, I'm going to need to open up Command Prompt, whereas in a Linux or Mac operating system, it's usually the Terminal application that you open instead. I already have Command Prompt open here. You may have noticed that the Command Prompt application that I've opened up is running with administrative privileges. The command-line utility does need administrative privileges to work properly. To use the command-line utility, the first thing that I need to do is I need to navigate to the location that Ignition is installed at. This is typically in the C drive in Program Files, Inductive Automation and then Ignition. Once here, to use the utility, you simply run the command "gwcmd" and then specify an option after. In this case, to reset the password, I use the option "p". When I run that, you'll notice we get a message letting us know that the password has been reset and that the gateway needs to be restarted. To restart the gateway, I simply need to run another command. In this case, with the option "r". This is going to go ahead and restart my gateway. Once the gateway restarts, we now get the message that the gateway needs to be commissioned. Because the commissioning process was added in Ignition 8, where you can set up a new user account the first time you install Ignition, we can't just reset the password. So we have to run through the commissioning process again. To do that, I simply need to navigate my web browser to localhost:8088. Because I already have it open here in the background, I can just reload the page. You'll notice it's brought us to the Welcome screen where we can go through the commissioning process. Here I can create a new user account. This time, I'll make a user called "ignition" and I will give them a password. Once I have that filled out, I can then click on the next button, and I can finish starting my gateway. Now that my gateway has finished starting, I can go to my Gateway Homepage, and now I should be able to log in using that new account I just set up. Username was "ignition" and now I'm logged in as the "ignition" user. You'll notice, if I go to the Configure tab and look at my list of users and roles in the default user source, you'll notice that not only is my new "ignition" user there, but my old "admin" user account is still there as well.

You are editing this transcript.

Make any corrections to improve this transcript. We'll review any changes before posting them.

close

Share this video