Manually install the DataStax Agent as a Debian package

Whenever possible, install the DataStax Agent automatically on the nodes in your DataStax Enterprise (DSE) clusters.

If automatic installation fails for any nodes, you must manually install the agent on those nodes.

Your DSE installation type determines the required agent installation type:

Prerequisites

  • Your DSE cluster is deployed and running.

  • OpsCenter is installed and configured to manage your DSE cluster.

  • JMX connectivity is enabled on each node in the cluster.

  • You have root or sudo access to the machines where the agents will be installed.

Download the agent package

To deploy agents manually, you need the agent software files. These files are available on IBM Fix Central in the OpsCenter fix packs for each OpsCenter version.

Find the OpsCenter fix pack for your current OpsCenter version, download the agent archive from that fix pack, and then deploy your agents:

  1. Find your version of OpsCenter on IBM Fix Central:

    1. Go to Fix Central.

    2. In the Product selector field, begin typing IBM DataStax OpsCenter, and then select that option from the menu.

    3. In the Release field, select the version that you want to install.

    4. Click Continue.

    5. On the Identify fixes page, click Continue to use the default Browse for fixes option.

    6. On the Select fixes page, select the fix pack (OpsCenter version) you want to install, and then click Continue.

      Depending on the product and version, more fix packs might be available if you set the Platform filter to All, and then click Submit.

    7. If prompted, sign in with your IBMid.

      An IBMid account with MFA enabled is required. If you don’t have one, create an IBMid account. If your organization uses Enterprise Federation (EF) for authentication with corporate credentials, see the IBMid EF documentation.

    8. On the Download options page, select Download using your browser (HTTPS), and then click Continue.

    9. Review the terms and conditions, and then click I agree to activate the download links.

  2. Click the DataStax Agent DEB package link to download the file, for example, datastax-agent-VERSION-deb.zip.

  3. Extract the DEB files from the zip file:

    unzip datastax-agent-VERSION-deb.zip

    You can use the included package signing public key (deb-signing.pub.key) to set up and verify the DEB packages.

  4. Set up a local APT repository to host the downloaded DataStax Agent Debian package.

  5. Add a DataStax repository file named datastax.sources.list at /etc/apt/sources.list.d/:

    echo "deb [trusted=yes] file:REPOSITORY_DIRECTORY_PATH ./" | sudo tee -a /etc/apt/sources.list.d/datastax.sources.list

    Replace REPOSITORY_DIRECTORY_PATH with the path to your local APT repository directory.

    The [trusted=yes] option allows APT to use the repository without GPG key verification.

Deploy the agent

  1. Install the DataStax Agent:

    sudo apt-get update
    sudo apt-get install datastax-agent

    If you are using an earlier version of OpsCenter, add the supported version to the command:

    sudo apt-get install datastax-agent=6.8.VERSION_NUMBER
  2. In the DataStax Agent configuration, set stomp_interface to the IP address that OpsCenter is using. You might have to create the address.yaml file.

    echo "stomp_interface: reachable_opscenterd_ip" | sudo tee -a /var/lib/datastax-agent/conf/address.yaml

    For package installations, address.yaml is located at /var/lib/datastax-agent/conf/address.yaml.

  3. If SSL communication is enabled in opscenterd.conf, use SSL in address.yaml:

    echo "use_ssl: 1" | sudo tee -a /var/lib/datastax-agent/conf/address.yaml

    For package installations, opscenterd.conf is located at /etc/opscenter/opscenterd.conf.

  4. Start the DataStax Agent:

    sudo service datastax-agent start

Configure JAVA_HOME for the DataStax Agent

The DataStax Agent cannot find the current user’s environment variables by default. Therefore, if Java isn’t in the machine’s PATH, then the agent’s log shows an error on startup:

nohup: cannot run command 'java': No such file or directory

To avoid this error, you can set the JAVA_HOME environment variable on the nodes where the agents are installed:

  1. Navigate to /etc/default/, and then create a file named datastax-agent.

  2. In this file, set JAVA_HOME and any other custom environment variables that the agent might need:

    JAVA_HOME = /usr/lib/jvm/java-8-oracle
  3. Repeat for all nodes where the agent is installed and Java isn’t set in the PATH.

Was this helpful?

Give Feedback

How can we improve the documentation?

© Copyright IBM Corporation 2026 | Privacy policy | Terms of use Manage Privacy Choices

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: Contact IBM