You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
Command-line Utility 'gwcmd' Options
The following table lists all available 'gwcmd' options.
|Creates an |
activation_request.txt file that can be used to request a
license.ipl file from the Inductive Automation website. You must specify the license key to use for activation. The
activation_request.txt file is saved in the current directory.
-b,--backup <new filepath>
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.
.gwbk file with the same name already exists, you will be prompted whether it is OK to overwrite the file . You can override with the
-y option to force the file to always be overwritten.
Clears the gateway's SSL / TLS setup. The gateway's SSL / TLS connector will be immediately shut down.
|Use with the |
--restore flag to disable all items after gateway restoration and restart.
-e, --exportks <new filepath>
Exports the gateway's SSL key store in PKCS12 format and saves to the specified path.
-f, --exportpk <new filepath>
Exports the private key from the gateway's SSL key store in PEM format and saves to the specified path.
Reloads the Gateway's SSL keystore from disk. Any update to the keystore will be automatically applied to any new connections.
|Shows the usage for this command.|
|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.|
Use with the --restore flag to skip contacting a running gateway and stage the restore file directly.
The following feature is new in Ignition version 8.1.6
to check out the other new features
Add to the export private key command to not encrypt the private key.
-o,--name <new gateway name>
Specifies a Gateway name while restoring a backup. Additionally, the
-y command now skips prompts asking for a Gateway name override.
|Enables a password reset command, which will allow you to create a temporary user that can access the gateway again. Requires a gateway restart to take effect. See Gateway Password Reset below. |
|Restarts the Gateway.|
-s,--restore <backup file path>
Restores from a Gateway backup, using the file specified at the path.
|Performs a thread dump in the Gateway and prints the dump to the command-line.|
|Creates an |
unactivation_message.txt file that you can use to unactivate a license via the Inductive Automation website. The
unactivation_message.txt file is saved in the current directory.
-w,--uselicense <license.ipl path>
|Applies a |
license.ipl file that was downloaded from the Inductive Automation website. You must supply the location of the
license.ipl file. If it is in the current directory, use
license.ipl for the location.
|Automatically answers |
yes to any prompt that may appear in the above commands, such as permission to overwrite an existing file.