jtool

jtool is a Redwood command-line tool that lets you run various useful processes.

Installing jtool

To install jtool:

  1. Navigate to Configure > Admin > Configuration > Software Groups.

  2. Expand Download Client Tools.

  3. Right-click client-tools.zip and choose Download from the context menu.

  4. Expand the client-tools.zip file and locate the directory for your platform.

  5. Display a command-line window, navigate to that directory, and issue the desired command.

Using jtool

jtool includes a number of useful commands. You can run these commands in two ways:

  • Run jtool install to install each command as a separate executable. For example, after you do this, you run the cat command by entering jcat.

  • Use the jtool executable. For example, to use the cat command, you can enter jtool cat.

The commands included in jtool are as follows.

Tool Command Purpose Connection File Job Context Platform Availability
jcat cat Output the contents of a file to stdout. - -

jdescription description Sets the description of the current process. - Mandatory All
jecho echo Prints messages to stdout and decrypts credential passwords. - -

jevent event Raises an Event. Yes Yes All
jftp ftp Transfers files via FTP. - -

jgetcredential getcredential Retrieves a credential. - Mandatory

jgetfile getfile Gets an output file. Yes Yes

jgetpar getpar Gets configuration parameter data. - Mandatory

jjoin join Joins files previously split with jsplit. - -

jlink link Links files to processes. - Mandatory

jlog log Logs in a common logging format. - -

jmail mail Sends an email message. - -

jmessage message Sends an Operator Message. - Mandatory

jmonitor monitor Sends monitoring data values. - Mandatory

jputfile putfile Uploads files to a server. Yes Yes

jregister register Registers a Job Server. - -

jrfc rfc Retrieves output on spool hosts. - - Linux 64-bit and Windows 64-bit
jscp scp Aliveness and network testing. - -

jscript script Runs a script. Yes Yes All
jsecret secret Generates a user or network-processor secret. Yes - All
jsleep sleep Sleeps for a number of seconds. - - All
jsplit split Splits a file. - -

To learn how to use these individual modes, issue a command like jtool <command> -h. For example:

Copy 
>jtool monitor -h

Usage: monitor  [-h|-?|-help] [-l <loglevel>] [-f <logfile>] -j|-job-context <path>=<value> ...

  Option              Default                Purpose
  ------------------- ---------------------- -----------------------------------
  -h|-?|-help                                Show this help and exit
  -l <loglevel>       ${JCS_LOGLEVEL:-info}  Set the logging level
  -f <logfile>        ${JCS_LOGFILE:-stderr} Log to file instead of stdout/stderr
  -j|-job-context                            Obtain environment from job-context
  <path>=<value> ...                         One or more path/value pairs to set monitor values for

Note: jtool uses TLS and SSH. To inspect the version of OpenSSL jtool uses, run jtool -v.