Installing the Agent for Java EE/JMX (Standalone)

The page guides you through the installation of an Agent in an AE system in which authentication is not used. Additional installation steps are required before the Agent can be started and used if you intend to use one of the available authentication methods. For more information, see Agent Authentication.

Tip! This page refers only to the manual installation process. If you want instructions on how to install a containerized Java agent, see Installing Containerized Java Agents.

The JMX Agent can run outside of an application server.

It is best to install the Agent in a separate directory (such as UC4/Agent/jmx or C:\AUTOMIC\Agent\jmx).

This page includes the following:

Connecting to the Automation Engine

The Automation Engine and the Windows, UNIX, and Java Agents communicate using TLS/SSL. These agents establish a connection with the Java communication process (JCP), which uses trusted certificates to prove their identity to other communication partners.

Note: The TLS/SSL implementation does not apply to the HP-UX Agent, as it is no longer supported in this version.

You can use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters in the respective INI file to point to the relevant certificates. If the trustedCertFolder= parameter is not set, the certificates should be installed in the respective store; that is the Java trust store for Java Agents, the Windows OS store for Windows Agents, or the TLS/SSL store for UNIX Agents. For more information, see Securing Connections to the AE (TLS/SSL).

For more information about the different certificate types and for detailed instructions on how to create and use them, see What Kind of Certificates Should I Use for Automic Automation v21.

TLS/SSL Agents (in containers or on-premises) and the TLS Gateway, when used for the Automic Automation Kubernetes Edition, establish a connection to an ingress / HTTPS load balancer and not the JCP directly. The ingress / HTTPS load balancer must be reachable and requires a certificate for authentication. The address of the load balancer must be defined on both sides: the Automation Engine and the Agent / TLS Gateway.

Important! When you install or upgrade Agents manually for an Automic Automation Kubernetes Edition system, you have to make sure that you configure your Agents and/or TLS Gateway to reach the TCP or HTTPS load balancer and not the CP or JCP directly. Also, make sure that your HTTPS load balancer has the required certificates in place. For more information, see Connecting to the AAKE Cluster.

Installing the Agent for Java EE/JMX

  1. In the admin and/or user computer, install Java Standard Edition.

    You can skip this step if the required version of Java Standard Edition is already available.

    • Use the following command to check the current version of your system's Java Virtual Machine (VM):

      java -version

      Note: The order of the indicated directories is relevant when specifying %PATH% or $PATH if several versions of JRE or Java SDK are installed on your computer. The Java Runtime Environment listed first is used.

    • Download the required Java Runtime Environment from the Java website and install it ,see http://java.sun.com.

  2. On the host, set up the Agent.

    • Create a separate folder for the JMX Agent and copy the supplied files and the sub-folder Logs to it. Optionally, you can use the program SETUP.EXE for the installation. It is available in the supplied directory (Agent).

    • In the INI file of the JMX Agent, set the Agent name, computer name, and port of the JCP to which the Agent should connect. For more information, see Agent JMX.

    • Use the trustedCertFolder=, agentSecurityFolder=, and keyPassword= parameters in the respective INI file to point to the relevant certificates. If the trustedCertFolder= parameter is not set, the certificates should be installed in the respective store; that is the Java trust store for Java Agents, the Windows OS store for Windows Agents, or the TLS/SSL store for UNIX Agents. For more information, see Securing Connections to the AE (TLS/SSL).

      For more information about the different certificate types and for detailed instructions on how to create and use them, see What Kind of Certificates Should I Use for Automic Automation v21.

  3. Use the following command to start the Agent from the command line (UNIX and Windows):

    java -jar -Xrs -Xmx1G ucxjjmx.jar

    You can also use the ServiceManager to start the Agent. For more information, see ServiceManager.

  4. On the host, consider the following when creating jobs:

    • Select the option Local Java VM in the Job object's JMX tab.
    • Activate the sub-items Use existing MBean Server and Create new instance...

See also:

Installing the Agents