JRLY Command-line Options for Windows
This section describes command-line options that are available from the Windows version of JRLY.exe
.
Note the following:
- JRLY as a Windows service is available only for Windows.
- When the display suffix is optional (when
[
display_suffix
]
is shown), all operations are performed on the default JRLY Windows service instance. - For manually installed, additional JRLY services, a suffix (any string) is required. Also, you can install the default service manually by omitting the optional string suffix.
- Each instance of JRLY Windows service uses the same binary executable file.
- A new process is started for each instance of JRLY Windows service.
- The syntax for these options is:
jrly -command.
- Text specified within brackets ( [ ] ) is optional.
- All commands in the following list of command options except
-start
and-stop
require that you have write access to Windows Registry. - The
-start
and-stop
commands require that you have Windows Service control access. These requirements are based on Windows user restrictions.
The JRLY command-line options are detailed in the following table:
Table 3-2 RLY Command-line Options for Windows
Option | Description |
---|---|
|
Install jrly as a Windows service.
Example 1: In this example, the default JRLY is installed as a Windows Service and is displayed in the Service Control Manager (SCM) as Jolt Relay. Example 2: In this case, an instance of JRLY is installed as a Windows Service and is displayed in the SCM as Jolt Relay_master. The suffix, master, does not have any significance; it is only used to uniquely identify various instances of JRLYs. At this point, this instance of JRLY is not ready to start. It must be assigned the configuration file (see the set command discussion) that specifies the listening TCP/IP port, JSH connection TCP/IP port, log files, and |
jrly -remove
|
Remove one or all instances of JRLY from Windows service.
If If If the
are removed. |
jrly -set
|
Update the registry with the full path of a new configuration file.
Example 1: In this example, the default JRLY Windows Service (Jolt Relay) is assigned a configuration file called Example 2: jrly -set -d MASTER -f
Here, the JRLY Windows Service instance, called Jolt Relay_master is assigned a configuration file called |
jrly -manual [display_suffix]
|
Set the start/stop to manual.
This command sets the specified JRLY instance to be manually controlled, using either the command-line options or the SCM. |
jrly -auto [display_suffix]
|
Set the start/stop to automatic.
This command sets all the operations for a specified Windows Service to be automatically started when the OS boots and stopped when the OS shuts down. |
jrly -start [display_suffix]
|
Start the specified JRLY. |
jrly -stop [display_suffix]
|
Stop the specified JRLY. |
jryl -version
|
Print the current version of JRLY binary. |
jrly -help
|
Print command-line options with brief descriptions. |
Parent topic: Jolt Relay