Install the DataStax Agent automatically

A DataStax Agent must be installed on every managed node in a cluster and are necessary to perform most of the functionality within DSE OpsCenter. Installation is automatic or manual, depending on the deployment tool.

  • Using Lifecycle Manager (LCM) to create a new cluster automatically installs agents.

  • Using OpsCenter to add a new cluster offers a choice of automatically or manually installing agents.

If you add an existing cluster, OpsCenter determines whether agents are already properly installed and configured. If they are not, OpsCenter prompts you to check the status of the agents and install them from the Agents tab.

Use the Agents Status View to see what is already installed as well as to review the status of the agents that you are currently installing.

Prepare the infrastructure for automatic agent installation

Configure your cluster for automatic agent installation

  1. Start your DSE cluster and the OpsCenter daemon.

  2. Connect to OpsCenter in a web browser at http://opscenter-host:8888/.

  3. Click Manage Existing Cluster, and then click Get Started.

  4. In Connect to Existing Cluster, enter one or more hostnames or IP addresses for the nodes in the cluster.

    Private IP addresses are recommended.

  5. Depending on your cluster configuration, change the port numbers and select connection security options as needed.

  6. Click Next.

  7. On the Set up agents dialog, click Next to use the default option: Install or start agents automatically.

  8. Enter SSH credentials to connect to the nodes.

    These credentials aren’t saved or stored after authenticating to the nodes.

    1. For Username, enter the name of a user that has root or sudo privileges.

    2. If you are using a sudo password for the specified user, enter the password in the Password field.

    3. If you are using an SSH private key, enter the key in the Private Key field.

  9. Click Submit to begin installing the agents.

Monitor agent installation

After you click Submit, the Agents tab shows the progress of the agent installations.

It is normal for DataStax Agent services to stop and start multiple times during the installation process.

Each installation deploys and configures an agent on each managed node in your DSE cluster. Monitor the process to ensure that all installations complete successfully.

Troubleshoot agent installation issues

If there are any issues with installing agents, a banner appears at the top of the OpsCenter workspace.

The banner cannot be dismissed until the agent issues are resolved, but the banner does not prevent you from using or navigating the OpsCenter UI.

Click the Show Details link in the banner to inspect the clusters that have issues with the agent and the number of problems currently detected by OpsCenter.

Click the # problems link to open the Agent Status tab where you can view more detailed information about agent status, troubleshooting suggestions, and use Set Up Agents to retry installing the agents.

If you are unable to install the agents automatically through the OpsCenter UI, then you must manually install them. Use the DataStax Agent installation procedure that matches each node’s DSE installation type:

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