- Display network and session information
- Administer users and sessions
- Perform routine and special diagnostics
- Reload TLS configuration and certificate/key pair.
Specifying a Host
Some commands require you to specify a host group before you can initiate the command action. To specify a host group, use the SELECT HOST command. SELECT HOST allows input of a specific host group number to define the scope used by a subsequent command function.
The following sections summarize the functions of each command, and indicate whether the command requires the use of SELECT HOST.
Displaying Network and Session Information
DISPLAY commands allow you to display your network configuration, sessions, and vprocs associated with the gateway, plus information about specific sessions.
| Command | Function | Requires SELECT HOST |
|---|---|---|
| DISPLAY DISCONNECT | Displays a list of sessions that have disconnected. | Yes |
| DISPLAY FORCE | Displays sessions that have been successfully killed or aborted using Performance Monitoring and Production Control (PMPC) abort process. | Yes |
| DISPLAY GTW | Displays all sessions connected to the gateway. | No |
| DISPLAY NETWORK | Displays network configuration information. | No |
| DISPLAY SESSION | Displays the following information on a specific session: User name, IP address, TCP socket number, state, event, action, partition, and authentication method. | Yes |
| DISPLAY STATS | Displays the RSS statistics for the gateway vproc. | No |
| DISPLAY TIMEOUT | Displays the timeout value. | Yes |
| DISPLAY USER | Displays the session number, PE number, User name, IP address, and current connection status. | Yes |
Administering Users and Sessions
These commands allow you to control gateway traffic and access to the database.
| Command | Function | Requires SELECT HOST |
|---|---|---|
| DISABLE LOGONS | Disables all logons to the database through the gateway. | Yes |
| ENABLE LOGONS | Enables logons to the database through the gateway. | Yes |
| KILL SESSION | Terminates a specific session. | Yes |
| KILL USER | Terminates all sessions of a specific user. | Yes |
| SET TIMEOUT | Sets a timeout value. | Yes |
Reloading TLS Configuration and Certificate/Key Pair
These commands allow you to update the TLS configuration file and load a new certificate/key pair.
| Command | Function | Requires SELECT HOST |
|---|---|---|
| REREAD TLS CONFIG | Updates the TLS configuration, such as cipher suites, from the gateway TLS file. If you make changes in the TLS configuration file /usr/tgtw/etc/gtwtls.cfg, you can use REread TLS Config to reload that configuration file with the new changes. |
Yes |
| REREAD TLS CERTIFICATE | Updates the TLS certificate and private key from the new gateway TLS certificate and key files. If you installed a new certificate/pair, you can use REread TLS Certificate to load them. |
Yes |
Performing Special Diagnostics
The TRACE commands allow you to debug internal gateway errors or anomalies.
| Command | Function | Requires SELECT HOST |
|---|---|---|
| ENABLE TRACE | Records internal gateway events. | Yes |
| DISABLE TRACE | Turns off the recording of event tracing and writing to the gateway log files. | Yes |
| FLUSH TRACE | Directs the gateway to write the contents of its internal trace buffers to the gateway log files. | Yes |
Logging Sessions Off Using KILL
When you issue a KILL command, any outstanding requests are first aborted. The specified session is logged off. The following table describes the KILL command behavior.
| IF the session is currently... | THEN... |
|---|---|
| disconnected | the assign task attempts a log off by setting the KILL flag to indicate that an attempt has been made to log off. |
| logged on | a kill message is sent to the connect task to abort any outstanding requests and then to log off. |
Getting Help
To list all the Gateway Global commands, type help at the command line. The help command displays a menu of all Gateway Global commands alphabetically, and shows the syntax for each command. The letter h can be used as a synonym for help.