Command Line System Tools
The Platform agents for UNIX, Microsoft Windows and HP OpenVMS ship with the system tools.
The system tools are also available in a separate download from the Software section. These include the jtool binaries for all platforms, and are convenient if you want to install the tools on a system where there is no agent installed.
| Tool | Purpose | Connection file | Job-context | Platform availability |
|---|---|---|---|---|
| jcat | Output the contents of a file to stdout | - | - | |
| jdescription | Set the description of the current process | - | Mandatory | All |
| jecho | Print messages to stdout and decrypt credential passwords | - | - | |
| jevent | Raise an event | Yes | Yes | All |
| jftp | Transfer files via FTP | - | - | |
| jgetcredential | Retrieve a credential | - | Mandatory | |
| jgetfile | Get a output file | Yes | Yes | |
| jgetpar | Get configuration parameter data | - | Mandatory | |
| jjoin | Join files previously split up with jsplit | - | - | |
| jlink | Link files to processes | - | Mandatory | |
| jlog | Log in common logging format | - | - | |
| jmail | Send an email message | - | - | |
| jmessage | Send an operator message | - | Mandatory | |
| jmonitor | Send monitoring data values | - | Mandatory | |
| jputfile | Upload file to the server | Yes | Yes | |
| jregister | Register a process server | - | - | |
| jrfc | Retrieves output on spool hosts | - | - | Linux 64-bit and Windows 64-bit |
| jscp | Aliveness and network testing | - | - | |
| jscript | Run a script | Yes | Yes | All |
| jsecret | Generate a user or network-processor secret | Yes | - | All |
| jsleep | Sleep a number of seconds | - | - | All |
| jsplit | Split a file | - | - | no |
| jtool | install all or run any of the above | - | - | Yes |
| api-tool.jar | JAR program allowing you to raise events and run scripts | Mandatory | - | runs on any platform that provides a Java 1.4 or higher JVM |
All jtool tools are available in two forms: the j<tool> form such as jftp and as a sub-option of jtool such as jtool ftp. Both are available after the installation. If you do have jtool but not a particular j<tool> form, run the jtool install command.
File Paths
You might want to use these utilities outside of Redwood Server processes; in this case, you should take the following into account:
Since the path to the bin directory contains version information and that this will change when a new version is installed, Redwood recommends using the latest/ symbolic link on UNIX and environment variables on Windows and HP OpenVMS to contain the version that your scripts should use. Alternatively, you can use symbolic links on Microsoft Windows Vista or later, re-parse points/junctions on earlier versions of Windows (XP, 2003), and Logicals on HP OpenVMS.
Recommended path on UNIX:
PATH=/opt/redwood/agent/latest/bin:$PATH
Example DCL to find latest jtool on OpenVMS:
$!
$loop3:
$ x = f$search("[.agent.9*.bin]jtool.exe;")
$ if x .eqs. "" then goto stop3
$ bindir = f$parse(x,,,"DEVICE") + f$parse(x,,,"DIRECTORY")
$ write sys$output "- Found agent directory ''bindir' for JTOOL"
$ jtool=="$''bindir'jtool.exe"
$ goto loop3
$stop3:
You may copy any files that do not require a process context to another system and use them from there. Note, however, that these files are platform-specific; a HP-UX IA64 version of jsleep will not run on Microsoft Windows or on GNU/Linux, for example, even if you are using the IA64 version of the operating system.
Connection file
Some tools are suited to communicating with the central Redwood Server over the server's HTTP interface. This is useful when you want to run commands from outside of the Redwood Server environment, for instance from a server where you have not installed the platform agent. It is explicitly allowed to copy the jtool binary over to a different machine and call it from there. Note that tools connecting to the central Redwood Server require a connection file that can be created using jsecret.
Job-context
Other tools are meant for use within a Redwood Server OS process executed by the platform agent. This is called running in job-context. Such tools use the -j or -job-context argument to verify that you understand that they must be called in job-context.
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:3128PROXY_USER- The user for the proxy server, ignored ifHTTP_PROXYis not setPROXY_PASSWORD- The password for the proxy user, ignored ifHTTP_PROXYis not setNO_PROXY- Enforce a direct connection
Logging
All tools, including the platform agent itself, log in a common logging format and use the same arguments to overrule the default logging settings. See Agent Logging Settings for more information.
z/OS Availability
On z/OS most system tools are not available.
- As z/OS jobs run as JES jobs there is no job-context. System tools that depend on the process context are not supported.
- jftp has not been ported to function properly in an EBCDIC environment.
Specific instructions on how to use the system tools on z/OS are documented in z/OS System Tools.