Deploy OneAgent on zRemote

The zRemote is an aggregation and data processing component that installs in the distributed environment and extends the zLocal. The zRemote offloads much of the Oneagent processing from the "Code Modules", reducing the MIPS load incurred in instrumenting mainframe applications.

Note

The zRemote should only service one zDC and its zLocal (zDC). It is possible to run more than one zDC zLocal pair per LPAR.

Installation and configuration

The zRemote is downloaded and installed automatically during the ActiveGate installation procedure. You only need to select the Mainframe monitoring option during ActiveGate installation.

Note that zRemote isn't supported by Environment ActiveGates that are configured for multi-environment support.

No further configuration of the zRemote is required, as it obtains all necessary settings from the ActiveGate.

By default, the zRemote listens on port 8898 for connections from the mainframe. You can configure it to listen on a different port by using the zdclistenerport parameter in ruxitagent.conf. You should ensure that this port is not blocked by a firewall.

Supported operating systems

Windows x64
Linux x64

Stopping and Restarting the zRemote service

Under unusual circumstances, it may be necessary to stop or restart the zRemote service. You can use the following commands to stop/restart the zRemote service.

On Linux

You need root privileges to execute these commands.

To query the current status of the zRemote service:

service zremote status

To stop, start, or restart the zRemote service:

service zremote stop|start|restart|forcestop

The difference between stop and forcestop is that the stop command instructs the process to execute its controlled shutdown routine, while forcestop forces the process shutdown.

On Windows

You need admin privileges to execute these commands.

On Windows, stopping/starting the zRemote service can be done using the Services tab of the Windows Task Manager. You can also use the following command:

sc stop|start|restart "DESK zRemote"

The sc command is asynchronous, so you need to query the status of the service, to determine when it has fully stopped:

sc query "DESK zRemote"

Uninstalling the zRemote

Although the zRemote is installed automatically during ActiveGate installation, it isn't removed when the ActiveGate is removed. You must uninstall the zRemote separately.

On Linux

You need root priviliges to execute this command.

/bin/sh /opt/desk/zremote/uninstall.sh

On Windows

As the zRemote is managed by a standard MSI installation package, it can be uninstalled via the standard Windows list of installed programs, or via the usual command-line and Powershell commands for un-installing programs.