WebtoB Console Tool
WebtoB provides the following tools to manage engine processes and server processes.
-
Admin Tools
Console Tool Description A tool used for the overall WebtoB system management, supporting system information retrieval and administrator tasks.
-
Other Tools
Console Tool Description Migrates WebtoB 5 configuration files to WebtoB 6.
Performs schema validation on WebtoB environment files.
Creates a file to store passwords for SSL certificate keys.
wsadmin
wsadmin provides a text-based administration environment. It always waits at a prompt and executes user-entered commands.
-
Execution
To run the wsadmin tool, use the wsadmin command.
$ wsadminIf the wsadmin tool runs successfully, the following message is displayed at the prompt:
$$1 [wsadmin]>>
-
Exit
To exit the wsadmin tool, use the exit command.
$$3 [wsadmin]>> exit
The following describes the commands provided by wsadmin.
| Command | Abbreviation | Description |
|---|---|---|
Displays help for commands available in the wsadmin tool. |
||
(cli) |
Displays client connection information for WebtoB. |
|
Connects to a specific WebtoB Admin server. |
||
(st) |
Displays statistics about destination and service status. |
|
(cfg) |
Displays environment settings information. |
|
Reloads the configuration file to dynamically apply settings. |
||
(cachelist) |
Displays information about the HTTP response cache. |
|
(cr) |
Deletes responses stored in the HTTP response cache. |
|
(cr) |
Refreshes WebtoB’s certificate information. |
|
(and) |
Displays information about the destination that handles the client requests. |
|
(There) |
Displays connection information between WebtoB’s clients and destinations. |
|
(down) |
Shuts down the WebtoB. |
|
Exits the wsadmin tool. |
||
Retrieves patch information applied after the release. |
||
Displays the WebtoB system information. |
||
Displays the specified license information. |
||
Displays information about the current system. |
Each command provides the following common options:
| Option | Description |
|---|---|
[-i <repeat interval>] |
Specifies the repetition interval in seconds of the command. (Default: 1 second) |
[-r <number of repetitions>] |
Specifies the number of repetitions. (Default: 0) |
The following is an example of executing the cli command 2 times with a 2-second interval.
wsadmin]>> cli -i 2 -r 2 Command will be executed repeatedly. Count=2. Interval=2(sec). * Repeat count = 1 ---------------------------------------------------------------------------------------------------------- | Client Info : HTH-0 | ---------------------------------------------------------------------------------------------------------- | No | Status | Request Count | Response Count | Idle | Local Address | Remote Address | Ssl | ---------------------------------------------------------------------------------------------------------- | 12 | READY | 1 | 1 | 22 | 192.168.15.120:8080 | 192.168.15.120:53844 | No | ---------------------------------------------------------------------------------------------------------- * Repeat count = 2 ---------------------------------------------------------------------------------------------------------- | Client Info : HTH-0 | ---------------------------------------------------------------------------------------------------------- | No | Status | Request Count | Response Count | Idle | Local Address | Remote Address | Ssl | ---------------------------------------------------------------------------------------------------------- | 12 | READY | 1 | 1 | 24 | 192.168.15.120:8080 | 192.168.15.120:53844 | No | ---------------------------------------------------------------------------------------------------------- Repeat done.
When wsadmin is executed with commands enclosed in double quotation marks ( " ), the results of each command are output sequentially without waiting at a prompt.
The following example shows how the results of the cli and st commands are output directly to the console.
$ wsadmin "cli" "st"
Environment variables for WebtoB:
WEBTOB_HOME_PATH = /home/tmax/webtob6/
Welcome to WebtoB Demo system.
Enterprise edition License in used.
Schema file path: /home/tmax/webtob6/schema/webtob-config-enterprise.schema.json
Start config validation
1. Opened schema file
2. Opened config file
3. Config parsing finished
4. Pre-validation process finished
5. Validation using json-schema finished
6. Post-validation process finished
Config file "/home/tmax/webtob6/config/webtob-config.json" is validated with schema file "/home/tmax/webtob6/schema/webtob-config-enterprise.schema.json"
Success to load config files : webtob-config.json
Validation success
Current WebtoB Configuration:
Number of client handlers (HTH) = 1
Number of worker threads per handler (HTH) = 1
Number of connection pool size per handler (HTH) = 100
Today is 2025-05-28
License expires on 2099-12-31 (27245 days remaining)
Connection established successfully with localhost:9090.
----------------------------------------------------------------------------------------------
| Client Info : HTH-0 |
----------------------------------------------------------------------------------------------
| No | Status | Request Count | Response Count | Idle | Local Address | Remote Address | Ssl |
----------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------------------
Prints all information. Use options to print specific items ( -jeus, -rproxy, -htmls )
---------------------------------------------------------------------------------------------------------------------------------------------
| HTH-0 : JEUS statistic |
---------------------------------------------------------------------------------------------------------------------------------------------
| Server | Server Group | Connections | Average Processed Time | Request Count | Response Count | Sticky Routed Count |
---------------------------------------------------------------------------------------------------------------------------------------------
| ZG9tYWluMS9hZG1pblNlcnZlcg== | MyGroup1 | 10 | 0.000000 | 0 | 0 | 0 |
---------------------------------------------------------------------------------------------------------------------------------------------
-----------------------------------------------------------------------------------------------------------------------------------
| HTH-0 : Reverse Proxy statistic |
-----------------------------------------------------------------------------------------------------------------------------------
| Server | Server Group | Connections | Average Processed Time | Request Count | Response Count | Sticky Routed Count |
-----------------------------------------------------------------------------------------------------------------------------------
| tmaxsoft:80 | rproxyg1 | 0 | 0.000000 | 0 | 0 | 0 |
-----------------------------------------------------------------------------------------------------------------------------------
----------------------------------------------------------------------------------
| HTH-0 : HTMLS statistic |
----------------------------------------------------------------------------------
| Server | Queue Count | Average Processed Time | Request Count | Response Count |
----------------------------------------------------------------------------------
| HTMLS | 0 | 0.000000 | 0 | 0 |
----------------------------------------------------------------------------------help
Displays the help for commands available in the wsadmin tool.
-
Usage
> help [command]
Option Description [Command]
Specifies the command for which to output usage information.
-
Example
No Options Used[wsadmin]>> help ---------------------------------------------------------------------------------------------- | Help | ---------------------------------------------------------------------------------------------- | Command Name | Command Alias | Command Descriptor | ---------------------------------------------------------------------------------------------- | client-info | cliinfo, cli | show client info | | connect | | connect to the WebtoB admin server | | stat-info | stat, st | show statistics info | | | | JEUS, Reverse proxy server, HTMLS statistic | | restat | | clear target statistics info | | config | cfg | show config info | | update-config | | update config info | | cache-list | cachelist | show cache info | | cache-refresh | cr, cacherefresh | removes responses stored in the HTTP response cache | | svg-info | svginfo, sgi, si | show server group info | | connection-info | coninfo, coni, ci | show connection info | | shutdown | down | shutdown WebtoB | ---------------------------------------------------------------------------------------------- | You can use the help command for each individual command. | ----------------------------------------------------------------------------------------------
Options Used[wsadmin]>> help st --------------------------------------------------------------------------------------------------------------------------------------- | Help : stat-info( stat, st ) | --------------------------------------------------------------------------------------------------------------------------------------- | OptionName | IsRequired | HasArgs | Description | --------------------------------------------------------------------------------------------------------------------------------------- | hth_number | No | Yes | target hth number | | jeus | No | Yes | JEUS statistic info | | rproxy | No | Yes | Reverse proxy statistic info | | htmls | No | No | HTMLS statistic info | | --- | --- | --- | --- | | i | No | Yes | Default: 1 (second) if a repeat is needed. Interval specifies the time delay between repeats. | | r | No | Yes | Default: 0 (unlimited) if a repeat is needed. To limit the repeats, set a value greater than 0. | --------------------------------------------------------------------------------------------------------------------------------------- | Show statistics info. | | JEUS, Reverser Proxy, HTMLS statistic. | ---------------------------------------------------------------------------------------------------------------------------------------
client-info (cli, cliinfo)
Displays the environment settings, such as the current status, IP address, number of processed requests, of the currently connected client (usually a web browser).
-
Usage
> cli [-vhost <VHOST name>][-hth <HTH number>]
Option Description [-vhost <VHOST name>]
Specifies the VHOST name for which client information will be displayed.
[-hth <HTH number>]
Specifies the HTH number for which client information will be displayed.
-
Example
Using the cli without options displays the following result. Each entry represents one client.
[wsadmin]>> cli ---------------------------------------------------------------------------------------------------------- | Client Info : HTH-0 | ---------------------------------------------------------------------------------------------------------- | No | Status | Request Count | Response Count | Idle | Local Address | Remote Address | Ssl | ---------------------------------------------------------------------------------------------------------- | 5 | READY | 0 | 0 | 4 | 192.168.15.120:8080 | 192.168.15.120:38572 | No | ----------------------------------------------------------------------------------------------------------
The following describes each output item.
Item Description No
The connection number managed internally by WebtoB.
Status
Client status for the destination
-
READY: Receiving requests from the client.
-
RUNNING: A client request is being processed at the destination.
Request Count
The number of requests sent by the client.
Response Count
The number of responses received by that client.
Idle
Client idle time with no data exchanges.
Local Address,
Remote AddressIP addresses and port numbers of the server and client
Ssl
Specifies whether the client is using an SSL connection.
-
connect
This command is used to connect to the WebtoB Admin server from wsadmin.
-
Usage
> connect [-ip <Admin server IP>][-port <Admin server port>]
Option Description [-ip <Admin server IP>]
Specifies the IP address of the WebtoB Admin server to connect to.
[-port <Admin server port>]
Specifies the port number of the WebtoB Admin server to connect to.
-
Example
[wsadmin]>> connect -ip localhost -port 9090 Connection established successfully with localhost:9090.
patch-info (patchinfo)
Retrieves information about patches applied after the release.
-
Usage
> patch-info [-version <version iformation>]
Option Description [-version <version information>]
Path version name or version number.
If omitted, all changes made after the release will be retrieved.
-
Example
[wsadmin]>> patch-info -version 6.0_B18 ---------------------------------------------------------------------- | Patch info | ---------------------------------------------------------------------- | | | WebtoB 6 Linux B19 epoll 2025.04.07 | | | | | | * 6_B18 (2025.03.31) | | - Added the PatchInfo command | | - Fixed an issue | | | | | ----------------------------------------------------------------------
webtob-info (webtobinfo, wi)
Displays general information about the currently running WebtoB.
-
Usage
This command does not require any separate options.
-
Example
[wsadmin]>> webtob-info ------------------------------------------------------------------------------------------------------- | WebtoB Version: WebtoB 6 Linux B19 epoll 2025.04.07 | ------------------------------------------------------------------------------------------------------- | License Type | Expiration Date | HTH Count | Worker Thread Count | Connection Pool Size | ------------------------------------------------------------------------------------------------------- | Cloud Enterprise edition | 0000/00/00 | 1 | 8 | 2 | -------------------------------------------------------------------------------------------------------
license-info (licenseinfo, li)
Displays information about a specific license. This command can be executed even when WebtoB is not running.
-
Usage
> license-info [-file <file path/file name>]
Option Description [-file <file path/file name>]
Specifies the file path and file name of the license.
If the path does not start with '/', it is resolved relative to the the current directory where wsadmin was executed. If the path ends with '/', the file name
license.datis automatically specified. -
Example
[wsadmin]>> license-info -file ../license/ ------------------------------------------------------------------------------------- | License info (file: license.dat) | ------------------------------------------------------------------------------------- | Sequence Number | Issue Date | Type | Edition | Expiration Date | Policy | ------------------------------------------------------------------------------------- | AAA-0000-000-0000 | 0000/00/00 | Cloud | Enterprise | 0000/00/00 | Unlimited | -------------------------------------------------------------------------------------
system-info (systeminfo)
Displays general information about the current system, including the host name. This command can be executed even when WebtoB is not running.
-
Usage
This command does not require any separate options.
-
Example
[wsadmin]>> systeminfo -------------------------------------------------------- | System info | -------------------------------------------------------- | Host Name | Host ID | Number of CPUs | Open Files | -------------------------------------------------------- | webtob0 | 000A0000 | 12 | 1024/1048576 | -------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------ | Kernel and Hardware Details | ------------------------------------------------------------------------------------------------------------------ | Kernel Name | Kernel Release | Machine Hardware Name | Processor Type | Hardware Platform | Operating System | ------------------------------------------------------------------------------------------------------------------ | Linux | 6.8.0-52-generic | x86_64 | x86_64 | x86_64 | GNU/Linux | ------------------------------------------------------------------------------------------------------------------ | Kernal Version : #53~22.04.1-Ubuntu SMP PREEMPT_DYNAMIC Wed Jan 15 19:18:46 UTC 2 | ------------------------------------------------------------------------------------------------------------------
stat-info (st, stat)
Provides information about the operational state of the system and destinations in operation.
You can check dynamic information such as the current status of the destination, the names of the services being processed, the number of services processed, service status, and the number of requests waiting in the service queue.
-
Usage
> st [-hth <HTH number>][-jeus <JEUS destination name>][-rproxy <reverse proxy destination name>][-htmls <HTML server name>]
Option Description [-hth <HTH number>]
Specifies the HTH number for which destination statistics are displayed.
[-jeus <JEUS destination name>]
Specifies the JEUS destination name for which statistics are displayed.
[-rproxy <reverse proxy destination name>]
Specifies the name of the reverse proxy destination for which statistics are displayed.
[-htmls]
Specifies whether to display statistical information.
-
Example
[wsadmin]>> st Prints all information. Use options to print specific items ( -jeus, -rproxy, -htmls ) ------------------------------------------------------------------------------------------------------------------------------------------------- | HTH-0 : JEUS statistic | ------------------------------------------------------------------------------------------------------------------------------------------------- | Server | Server Group | Connections | Average Processed Time | Request Count | Response Count | Sticky Routed Count | ------------------------------------------------------------------------------------------------------------------------------------------------- | amV1c19kb21haW4vYWRtaW5TZXJ2ZXI= | MyGroup1 | 10 | 0.000000 | 0 | 0 | 0 | ------------------------------------------------------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------------------ | HTH-0 : Reverse Proxy statistic | ------------------------------------------------------------------------------------------------------------------------------------ | Server | Server Group | Connections | Average Processed Time | Request Count | Response Count | Sticky Routed Count | ------------------------------------------------------------------------------------------------------------------------------------ | 192.168.15.120:8088 | rproxyg1 | 0 | 0.000000 | 0 | 0 | 0 | ------------------------------------------------------------------------------------------------------------------------------------ ---------------------------------------------------------------------------------- | HTH-0 : HTMLS statistic | ---------------------------------------------------------------------------------- | Server | Queue Count | Average Processed Time | Request Count | Response Count | ---------------------------------------------------------------------------------- | HTMLS | 0 | 0.002725 | 10 | 10 | ----------------------------------------------------------------------------------
The following describes each output item.
-
Output items for JEUS destination statistics
Item Description Server
The name of the JEUS destination managed internally.
Server Group
The name of the JEUS destination group.
Connections
The number of connections established with the JEUS destination.
Average Processed Time
The average processing time. (Unit: seconds)
Request Count
The number of requests sent to the destination.
Response Count
The number of requests processed by the destination.
Sticky Routed Count
The number of requests sent to the destination with a Sticky ID from the client.
-
Output items for reverse proxy destination statistics
Item Description Server
The address of the reverse proxy destination.
Server Group
The name of the reverse proxy destination.
Connections
The number of connections established with the reverse proxy destination.
Average Processed Time
The average processing time. (Unit: seconds)
Request Count
The number of requests sent to the destination.
Response Count
The number of requests processed by the destination.
Sticky Routed Count
The number of requests sent to the destination with a Sticky ID from the client.
-
Output items for HTMLS destination statistics
Item Description Server
The HTMLS destination name.
Queue Count
The number of requests waiting in HTMLS.
Average Processed Time
The average processing time. (Unit: seconds)
Request Count
The number of requests sent to HTMS.
Response Count
The number of requests processed by HTMLS.
-
restat
Resets destination statistics.
-
Usage
> restat [-hth <HTH number>][-jeus <JEUS destination name>][-rproxy <reverse proxy destination name>][-htmls]
Option Description [-hth <HTH number>]
Specifies the HTH number for which destination statistics are reset.
[-jeus <JEUS destination name>]
Specifies the JEUS destination name for which statistical information is reset.
[-rproxy <reverse proxy destination name>]
Specifies the reverse proxy destination name for which statistical information is reset.
[-htmls]
Specifies whether to reset HTMLS destination statistics.
-
Example
Using this command without any options resets all statistical information.
[wsadmin]>> restat Prints all information. Use options to print specific items ( -jeus, -rproxy, -htmls ) ----------------------------------------------------- | HTH-0 | ----------------------------------------------------- | List of JEUS with cleared statistical information | ----------------------------------------------------- | MyGroup2 | | MyGroup1 | ----------------------------------------------------- ------------------------------------------------------------- | HTH-0 | ------------------------------------------------------------- | List of Reverse Proxy with cleared statistical information| ------------------------------------------------------------- | rproxyg1 | ------------------------------------------------------------- ----------------------------------------------------- | HTH-0 | ----------------------------------------------------- | List of HTMLS with cleared statistical information| ----------------------------------------------------- | [HTMLS] | -----------------------------------------------------
config (cfg)
Displays the environment information of the currently running system. It allows you to check all environment information including default values by nodes, server groups, servers, destinations, and services defined in the environment configuration file.
-
Usage
> config [-path <JSON path>]
Option Description [-path <JSON path>]
Specifies the JSON path to the configuration file to check. The path must always start with '/'.
If the path is omitted or set to '/', all currently set environment information will be retrieved. -
Example
The following is an example of displaying the environment configuration for the NODE section. For detailed information about the configuration items in the NODE section, refer to Configuration Items.
[wsadmin]>> cfg -path /node ---------------------------------------------- | Target Config /node | ---------------------------------------------- | Values | ---------------------------------------------- | { | | "cache_entry": 128, | | "cache_key": "HOST_URI", | | "cache_max_file_size": 8192, | | "connection_pool_size": 8192, | | "graceful_shutdown_timeout": 60, | | "hth_count": 1, | | "hth_schedule": "RR", | | "limit_request_body_size": 0, | | "limit_request_header_field_count": 100, | | "limit_request_header_field_size": 8190, | | "limit_request_line_size": 8190, | | "listen_backlog": 4096, | | "max_cache_memory_size": 100, | | "name": "ksh", | | "system_filters": [], | | "worker_threads": 1 | | } | ----------------------------------------------
update-config
Reloads the configuration file and applies changes dynamically. Only settings specified with the |dynamic| key in the schema file are applied.
-
Usage
This command does not require any separate options.
cache-list (cachelist)
Displays information about the responses stored in WebtoB’s HTTP response cache.
-
Usage
> cachelist [-hth <HTH number>]
Option Description [-hth <HTH number>]
Specifies the HTH for which to retrieve cache information. If not specified, cache information for all HTHs is retrieved.
-
Example
The following is an example of a cached response to the request "/test.txt". The rest of the request path is used only for internal server debugging.
[wsadmin]>> cachelist ------------------------------------------------------------------- | HTH-0: Cache List Info | ------------------------------------------------------------------- | Cache key | Expired time | Cache size | ------------------------------------------------------------------- | 192.168.15.120:8080/test.txt | 2024-10-29 12:34:53 | 286| ------------------------------------------------------------------- | Cache count : 1 | | Memory usages : 286 | -------------------------------------------------------------------
cache-refresh (cr)
Removes the response data from the WebtoB HTTP response cache.
-
Usage
> cacherefresh { [-url <URL>] | [-ext <extension>] }Option Description [-url <URL>]
Specifies the URL of the cache to be removed.
[-ext <extension>]
Specifies the extension of the cache to be removed.
-
Example
Using this command without any options removes all stored cache information.
[wsadmin]>> cr [HTH-0] Number of removed cache items: 10
cert-refresh (cr)
Refreshes WebtoB’s certificate information.
-
Usage
This command does not require any separate options.
svg-info (si, sgi, svginfo)
Displays information about the destination that processes the client’s request.
-
Usage
> si [-htmls][-jeus <JEUS destination name>][-rproxy <reverse proxy destination name>]
Option Description [-htmls]
Specifies whether to display the HTMLS destination information.
[-jeus <JEUS destination name>]
Specifies the JEUS destination name for which information is displayed.
[-rproxy <reverse proxy destination name>]
Specifies the reverse proxy destination name for which information is displayed.
-
Example
[wsadmin]>> si ------------------------------------------------------------------- | HTH-0 : HTMLS Destination Info | ------------------------------------------------------------------- | svgname | status | aqcnt | count | cqcnt | qpcnt | reqs | rscnt | ------------------------------------------------------------------- | HTMLS | RDY | 0 | 0 | 0 | 0 | 0 | 0 | ------------------------------------------------------------------- -------------------------------------------------------------------- | HTH-0 : JEUS Destination Info | -------------------------------------------------------------------- | svgname | status | aqcnt | count | cqcnt | qpcnt | reqs | rscnt | -------------------------------------------------------------------- | MyGroup2 | NRDY | 0 | 0 | 0 | 0 | 0 | 0 | | MyGroup1 | RDY | 0 | 0 | 0 | 0 | 0 | 0 | -------------------------------------------------------------------- -------------------------------------------------------------------- | HTH-0 : Reverse Proxy Destination Info | -------------------------------------------------------------------- | svgname | status | aqcnt | count | cqcnt | qpcnt | reqs | rscnt | -------------------------------------------------------------------- | rproxyg1 | RDY | 0 | 0 | 0 | 0 | 0 | 0 | --------------------------------------------------------------------
The following describes each output item.
Item Description svgname
Destination name.
status
Client status within the destination.
-
RDY: The destination can process requests and there are destinations connected to WebtoB.
-
NRDY: The destination cannot process requests and there are no destinations connected to WebtoB.
-
BLK: The destination has been temporarily suspended by an administrator command and cannot process requests.
aqcnt
Cumulative number of queued requests. (Cumulative cqcnt value)
count
Number of processed requests.
cqcnt
Number of requests in the queue.
qpcnt
Number of queued requests that have been removed from the queue due to request timeout, qp command, etc.
reqs
Number of requests sent to the destination.
rscnt
Number of destination restarts due to abnormal termination.
-
connection-info (ci, coni, coninfo)
Displays connection information between WebtoB’s clients and destinations.
-
Usage
> ci [-jeus <JEUS destination name>][-rproxy <reverse proxy destination name>]
Option Description [-jeus <JEUS destination name>]
Specifies the JEUS destination name for which information is displayed.
[-rproxy <reverse proxy destination name>]
Specifies the reverse proxy destination name for which information is displayed.
-
Example
[wsadmin]>> ci --------------------------------------------------------------------------------------------------------------------------------------------------- | HTH-0 : Connection info | --------------------------------------------------------------------------------------------------------------------------------------------------- | No | Server | Local Address | Remote Address | Remote Type | Ssl | Status | Request Count | Response Count | Idle Time | Mapping No | --------------------------------------------------------------------------------------------------------------------------------------------------- | 0 | WJP-0 | 192.168.15.120:9999 | 192.168.15.120:40158 | JSV | No | READY | 1 | 1 | 23 | -1 | | 1 | WJP-0 | 192.168.15.120:9999 | 192.168.15.120:40170 | JSV | No | READY | 1 | 1 | 13 | -1 | | 2 | WJP-0 | 192.168.15.120:9999 | 192.168.15.120:40186 | JSV | No | READY | 1 | 1 | 42 | -1 | | 3 | WJP-0 | 192.168.15.120:9999 | 192.168.15.120:40202 | JSV | No | READY | 1 | 1 | 31 | -1 | | 4 | WJP-0 | 192.168.15.120:9999 | 192.168.15.120:40214 | JSV | No | READY | 1 | 1 | 26 | -1 | | 5 | WJP-0 | 192.168.15.120:9999 | 192.168.15.120:40220 | JSV | No | READY | 1 | 1 | 12 | -1 | | 6 | WJP-0 | 192.168.15.120:9999 | 192.168.15.120:40224 | JSV | No | READY | 0 | 0 | 27 | -1 | | 7 | WJP-0 | 192.168.15.120:9999 | 192.168.15.120:40230 | JSV | No | READY | 0 | 0 | 27 | -1 | | 8 | WJP-0 | 192.168.15.120:9999 | 192.168.15.120:40234 | JSV | No | READY | 0 | 0 | 27 | -1 | | 9 | WJP-0 | 192.168.15.120:9999 | 192.168.15.120:40240 | JSV | No | READY | 0 | 0 | 27 | -1 | | 21 | http1 | 192.168.15.120:8080 | 192.168.15.120:47098 | CLIENT | No | READY | 3 | 3 | 12 | -1 | ---------------------------------------------------------------------------------------------------------------------------------------------------
The following describes each output item.
Item Description No
The connection number managed internally by WebtoB.
Server
The server name managed internally by WebtoB.
Local Address,
Remote AddressIP address and port number of the server and client.
Remote Type
The type of connection.
-
CLIENT: Connection with the client
-
CLIENT_WEBSOCKET: Websocket connection with the client
-
RPROXY: Connection with an internal reverse proxy destination
-
RPROXY_PERSISTENT: Keep-Alive connection with an internal reverse proxy destination
-
RPROXY_WEBSOCKET: Websocket connection with an internal reverse proxy destination
-
JSV: Connection with an internal JEUS destination
Ssl
Specifies whether the connection is established using SSL.
Status
The status of the connection.
-
READY: Ready to receive requests from clients.
-
RUNNING: Processing the client’s request.
Request Count
The number of requests sent through this connection.
Response Count
The number of requests processed through this connection.
Idle Time
Idle time with no data exchanges.
Mapping No
The connection number associated with this connection.
If it is a client connection, it displays the destination connection number handling the request. If it is a destination connection, it displays the client connection number that sent the request. If there is no associated connection, it displays -1. -
configMigrator
Migrates WebtoB 5 configuration files to WebtoB 6.
Internally, the configMigrator compiles WebtoB 5 configuration file into an intermediate file (wsconfig) and then performs migration based on the compilation results.
|
By default, all files related to configMigrator are based on the config directory unless a separate path is specified. Therefore, the wsconfig file is also created in the config directory by default. |
-
Usage
$ configMigrator [-h|--help] [-v|--version] [-i|--input_config_name <WebtoB5 config file name>] [-o|--output_config_name <WebtoB6 config file name>] [-f|--format <WebtoB6 config file extension>]Option Description [-h|--help]
Displays descriptions of options available in configMigrator.
※ Any other options used with the
-hoption are ignored.[-v|--version]
Displays the WebtoB version.
※ Any other options used with the
-voption are ignored except for the-hoption).[-i|--input_config_name <WebtoB 5 config file name>]
Specifies the WebtoB 5 configuration file.
Relative or absolute paths can be specified based on the config directory. (Default: http.m)
[-o|--output_config_name <WebtoB 6 config file name>]
Specifies the WebtoB 6 configuration file.
Relative or absolute paths can be specified based on the config directory. (Default: webtob-config-generated)
[-f|--format <WebtoB 6 config file extension>]
Specifies the extension for the WebtoB 6 configuration file. (Default: json)
-
json
-
yml
-
yaml
※ This option can be omitted if the extension is specified with the
-ooption. -
-
Example
No Options Used (when the http.m file exists in the config directory)$ configMigrator Environment variables for WebtoB6: WEBTOB_HOME = /home/tmax/webtob6/ Current configuration: Number of client handler(HTH) = 1 Supported maximum user per node = 16357 Supported maximum user per handler = 16357 Successfully created the configuration file (/home/tmax/webtob6/config/wsconfig) for node webtob1. The host name of the running machine is tmax. legacy config file: /home/tmax/webtob6/config/http.m modern config file: /home/tmax/webtob6/config/webtob-config-generated.json migration complete: /home/tmax/webtob6/config/webtob-config-generated.jsonSpecifying input_config_name and output_config_name with Paths$ configMigrator -i ~/webtob5/config/http.m -o ~/webtob6/config/webtob-config-migrated.yaml Environment variables for WebtoB6: WEBTOB_HOME = /home/tmax/webtob6/ Current configuration: Number of client handler(HTH) = 1 Supported maximum user per node = 16337 Supported maximum user per handler = 16337 Successfully created the configuration file (/home/tmax/webtob6/config/wsconfig) for node webtob1. The host name of the running machine is tmax. legacy config file: /home/tmax/webtob5/config/http.m modern config file: /home/tmax/webtob6/config/webtob-config-migrated.yaml migration complete: /home/tmax/webtob6/config/webtob-config-migrated.yaml
configValidator
The configValidator performs schema validation on WebtoB configuration files.
Before running WebtoB, you can check the verification results for the configuration file using the configValidator tool.
|
WebtoB’s default configuration file is webtob-config.json, and you can change it by setting the environment variable WEBTOB_CONFIG_FILE_NAME. |
-
Usage
$ configValidator -
Example
Validating a Normal WebtoB Configuration File$ configValidator Config file path: ../config/webtob-config.json Schema file path: ../config/webtob-config.schema.json WEBTOB_HOME = ../ ******* Start config validation ******* 1. Opened schema file 2. Opened config file 3. Config parsing finished 4. Pre-validation process finished 5. Validation using json-schema finished 6. Post-validation process finished Config file "../config/webtob-config.json" is validated with schema file "../schema/webtob-config.schema.json" Success to load config files : webtob-config.json ******* Validation success *******Validating an Abnormal WebtoB Configuration File$ configValidator Config file path: ../config/webtob-config.json Schema file path: ../config/webtob-config.schema.json WEBTOB_HOME = ../ ******* Start config validation ******* 1. Opened schema file 2. Opened config file 3. Config parsing finished 4. Pre-validation process finished [Exception on json-schema validation][Config validation failed]At /node/hth_count of -1 - instance is below minimum of 1
mkpwd
mkpwd is a tool to support certificate_key_password in the SSL section.
When an encrypted private key is set in the SSL section, WebtoB prompts you to enter a passphrase every time it starts. To avoid repeatedly entering the passphrase, you can set the certificate_key_password. The mkpwd tool creates a passphrase file that stores the passphrase so that it can be applied to the certificate_key_password.
|
For more information on using certificate_key_password, refer to Configuration Items. |
-
Usage
$ mkpwd <file path> <SSL name>Options Description <file path>
Name of the file used for certificate_key_password. The result of running mkpwd is saved to this file.
<SSL name>
The name set in the SSL section.
-
Example
No Options Used$ mkpwd << Usage >> $ mkpwd file_path ssl_name file_path: output file for ssl certificate key password ssl_name: name of SSL sectionSpeficying file_path and ssl_name$ mkpwd ssl.ppd ssl1 Make password for SSL certificate key password Enter password: (Enter password) Successfully Added password for [ssl1] to a file [ssl.ppd]. $ls -al ssl.ppd -rw-rw-r-- 1 webtob webtob 14 Nov 6 12:34 ssl.ppd -
Verifying File Contents
$ cat ssl.ppd ssl1 dGVzdA==