Tessabyte Client Command-Line Parameters
Tessabyte Client can be launched from the command prompt if you want it to connect to a specific hostname or IP address immediately after startup. Additionally, it can be launched in console mode (no graphical user interface), making it suitable for scripting and output redirection.
Standard (UI) and Console Modes
- On Windows, standard (UI) and console modes are launched using different executable files.
TessabyteClient.exe is used to launch Tessabyte Client in standard mode, whereas TessabyteConsole.exe is used to launch Tessabyte Client in console mode. Both files are typically located in C:\Program Files\Tessabyte.
- On macOS, standard (UI) and console modes should be launched using the same executable file,
TessabyteClient. Since Tessabyte Client is packaged as an .app bundle, so when running Tessabyte Client from a terminal, you must invoke the actual executable file inside the bundle, not the bundle itself. The file is typically located at /Applications/Tessabyte Client.app/Contents/MacOS/TessabyteClient.
Commands Syntax
- -c - Specifies the IP address or hostname to connect to.
This is the only mandatory argument. The following arguments are optional. If they are not used, Tessabyte Client applies default values:
- -p - Specifies the port number to connect to. If not specified, the default value is 32500 .
- -r - Specifies the protocols to test. Acceptable values are "tu" (TCP and UDP), "t" (TCP only), and "u" (UDP only). If not specified, the default value is "tu".
- -q - Specifies the QoS traffic type. Acceptable values range from 0 (Best Effort) to 6 (User-defined). These numbers correspond to the QoS traffic type list shown in the user interface. If not specified, the default value is 0.
- -l - Specifies the rate limit in Mbps. Acceptable values range from 1 to 20000. If not specified, no rate limitation is applied.
- -s - Enables stress mode. No additional value is required. The stress mode may be useful in certain testing scenarios where you need to emulate frequent TCP connections and disconnections. When this mode is enabled, Tessabyte Client connects to the server, runs the tests, disconnects after a random number of seconds (between 5 and 60), and then reconnects within three seconds. This cycle continues until the application is closed.
- -w - On macOS, runs Tessabyte Client in console mode (no graphical user interface). On Windows, this argument is not supported; console mode is available by running a different executable file, as explained at the beginning of this chapter.
- -x - When running in console mode, specifies the number of test cycles to perform. Acceptable values range from 1 to 1000000. If not specified, the default value is 10. After completing the specified number of cycles, the application exits. In standard (UI) mode, this option is not supported.
- -f - When running in console mode on Windows, specifies an output file to save the test results to. Do not use standard Windows console redirection (>) for this purpose, as different shells may apply inconsistent text encodings. The file created with -f is written explicitly in UTF-8 encoding. In standard (UI) mode, this option is not supported. On macOS, this option is not supported; use standard shell redirection (>) instead.
Examples
The image below illustrates how you can run Tessabyte on console mode:
Windows Command Prompt
"C:\Program Files\Tessabyte\TessabyteClient.exe" -c 192.168.12.9 -p 32500 -r u -q 1 -l 500 -s
"C:\Program Files\Tessabyte\TessabyteConsole.exe" -c node5.cloud.com -x 25
"C:\Program Files\Tessabyte\TessabyteConsole.exe" -c 192.168.0.4 -x 25 -f "C:\Logs\test1.txt"
Windows PowerShell
& "C:\Program Files\Tessabyte\TessabyteConsole.exe" -c 192.168.55.4
& "C:\Program Files\Tessabyte\TessabyteConsole.exe" -c 192.168.55.4 -f "C:\Logs\test1.txt"
macOS Terminal
"/Applications/Tessabyte Client.app/Contents/MacOS/TessabyteClient" -c 192.168.12.9 -q 3
"/Applications/Tessabyte Client.app/Contents/MacOS/TessabyteClient" -c 192.168.12.9 -w > /Users/Dan/Desktop/test1.txt