jevent, jtool event

A platform agent tool used from a command line inside or outside a process to raise a named event inside Redwood Server.

Syntax

jevent [-h|-?|-help] [-l <loglevel>] [-f <logfile>] -j|-job-context|<connfile>
       [-s|-silent] <event> [<comment>]

Argument	Description
-s	Silent, no output will be generated
-h, -?, -help	Show usage and exit.
-l <loglevel>	Set the logging level.
-f <logfile>	Log to file instead of stdout/stderr.
-j,-job-context	Specifies that jevent is run inside of a context of a process, when this is not the case, a connection file <connfile> is required.
<connfile>	A file containing connection details, like host, port, username, and password. Required when -job-context is not specified. You generate this file with jsecret -c.
<event name>	The name (<partition>.<name>) of the event to raise; default partition is GLOBAL.
<comment>	The raiser comment.

TLS Arguments

Argument	Environment Variable	Description
-tlsv1_3, -tls13	JCS_SSL_METHOD=tlsv1_3	Use TLS v1.3 secured connection.
-tlsv1_2, -tls12	JCS_SSL_METHOD=tlsv1_2	Use TLS v1.2 secured connection.
-tlsv1_1, -tls11	JCS_SSL_METHOD=tlsv1_1	Use TLS v1.1 or better secured connection.
-tlsv1, -tls	JCS_SSL_METHOD=tlsv1	Use TLS v1.0 or better secured connection (default).
-sslv3, -ssl	JCS_SSL_METHOD=sslv3	Use SSL v3 or better secured connection.
-cipherlist <text>	JCS_SSL_CIPHERLIST	Set list of available ciphers.
-passphrase <text>	JCS_SSL_PASSPHRASE	Set passphrase for private key.
-key <file>	JCS_SSL_KEYPATH	Set private key.
-cert <file>	JCS_SSL_CERTIFICATE_PATH	Set public certificate.
-ca `<file	path>`	JCS_SSL_TRUSTED_CERTIFICATE_FILE	Trusted CA certificates path or file.
-[no]verify	JCS_SSL_VERIFY_CERT	(Do not) verify peer (server or client) certificate.
-verify-names <namelist>	JCS_SSL_VERIFY_SERVER_NAMES, JCS_SSL_VERIFY_CLIENT_NAMES	Verify peer (server or client) certificate hostname against list.

Proxy Settings

The following environment variables are used to retrieve proxy server connection details:

• HTTP_PROXY - The URL to the proxy server, https://proxy.example.com:3128
• PROXY_USER - The user for the proxy server, ignored if HTTP_PROXY is not set
• PROXY_PASSWORD - The password for the proxy user, ignored if HTTP_PROXY is not set
• NO_PROXY - Enforce a direct connection

note

These environment variables override the settings in the connection file.

Example

In this example, the Redwood Server is named pr1.example.com, its port is 50000. Note: when you enter your password for the connection file, no text is displayed as you type; this improves the security of your password.

D:\Agent\&agent_release;\bin>jsecret -c ..\..\net\instance\default\example.conn pr1.example.com:50000 GLOBAL
 Username:jdoe
 Password:

D:\Agent\2023_3_0_20231116_10\bin>jevent ..\..\net\instance\default\example.conn -s "FinancialsLoadedSuccessfully" "Event raised from jevent"
Login successful on pr1.example.com
Successfully raised event with ID 74

D:\Agent\2023_3_0_20231116_10\bin>

note

Redwood recommends you store your connection files in the directory for your instance.

See Also

• Command Line System Tools