The zRemote module processes monitoring data received from the zLocal and routes that data, compressed and encrypted, via its local ActiveGate to Dynatrace. Hence, the zRemote module offloads much of the processing work from the CICS, IMS, and z/OS Java code modules incurred in instrumenting subsystems and applications to an open system.
You can customize the zRemote module to enable optional features like Host groups and Db2 SQL statement fetch.
The hardware requirements of the machine where the zRemote module runs depend on the number of anticipated CICS and IMS transactions to be monitored per second. See the hardware requirements for x86-64 and s390 architecture machines below.
We recommend installing the zRemote module on an IBM Z or LinuxONE mainframe, on an supported Linux operating system for s390. The following system requirements apply:
You can install the zRemote module on any Linux and Windows operating system listed below.
| Distribution | Versions | CPU architectures |
|---|---|---|
| Oracle Linux | 8.10 | x86-64 |
| Red Hat Enterprise Linux | 8.10, 9.4 | s390, x86-64 |
| Rocky Linux | 8.10 | x86-64 |
| SUSE Enterprise Linux | 15.6 | s390, x86-64 |
| Ubuntu | 16.04, 18.04, 20.04, 22.04, 24.04 | x86-64 |
| Ubuntu | 20.04, 22.04, 24.04 | s390 |
| Windows | 10, 11 | x86-64 |
| Windows Server | 2016, 2019, 2022, 2025 | x86-64 |
The overview outlines the key components of the zRemote application, the zRemote configuration, and their default installation directories. Non-persistent directories are replaced during updates and uninstallation.
Base path: /opt/dynatrace/zremote
All of the following directories are not retained in the event of a zRemote update or uninstallation. If you make changes here, they will be overwritten or deleted.
Base path: /var/lib/dynatrace/zremote
All of the following directories are not retained during zRemote update or uninstallation. If you make changes here, they will be overwritten or deleted.
The following directories are retained in case of update or uninstallation. You can make changes here. For more details, see Customize the zRemote module.
The zRemote module is downloaded and installed automatically during the ActiveGate installation procedure on Linux or Windows.
In Dynatrace Hub, select ActiveGate > Set up.
On the Install Environment ActiveGate page, select Linux or Windows.
Linux only Select installer type s390 (recommended) or x86/64.
Select the purpose Install the zRemote module for z/OS monitoring, download the installer, and start the installation procedure.
Optional Customize the listening port selection.
By default, the zRemote module listens on port 8898 for connections from the zLocal running as part of the zDC. To listen on a different port, set the zdclistenerport parameter to your port in the zremoteagentuserconfig.conf file. Make sure this port is not blocked by a firewall.
For details on the default installation settings, see ActiveGate default installation settings for Linux or Windows.
For details on customizing the installation, see customize ActiveGate installation on Linux or Windows.
The zRemote logs are created on the machine where the zRemote module is installed, in the default directories for Linux and Windows. You can view the zRemote logs either directly on the machine hosting the zRemote or by requesting them from Dynatrace via the OneAgent diagnostics workflow.
The actual zRemote log should contain the following messages:
To stay current, you can update the zRemote module automatically to a newer version by using the ActiveGate auto-update procedure.
To manually update the zRemote module
zremoteagentuserconfig.conf file of the zRemote module and the custom.properties file of the ActiveGate. The installer should not overwrite these files, but we recommended backing them up for safety./opt/dynatrace/gateway/uninstall.sh
./bin/bash Dynatrace-ActiveGate-Linux-<arch>-<version>.sh --enable-zremote
To stop, start, or restart the zRemote module, you can use the following commands.
You need root privileges to execute these commands.
To query the current status of the zRemote module:
service zremote status
To stop, start, or restart the zRemote module:
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.