Installing Control-M/Agent on UNIX

This procedure describes how to install Control-M/Agent on UNIX in a Control-M/Server self-hosted environment. This installation includes Application Integrator and Automation API CLI. If you want to install multiple instances of Control-M/Agent on several computers using the same configuration, use the automatic installation, as described in this procedure.

If a previous version of Control-M/Agent is detected, an upgrade is automatically performed and the parameters values from the previous version are used.

The default installation is interactive and uses a GUI display. XServer must be running and configured using the DISPLAY environment variable. If you do not have XServer available, BMC recommends that you continue with the console installation or perform an automatic installation.

Before You Begin

Ensure that you have met the following requirements:

Verify that your operating system is compatible with the current version of Control-M/Agent, as described in Agent System Requirements for UNIX.
Verify that you have successfully completed the Agent Pre-installation Procedures for UNIX.
Verify that you have met the Java requirements, as described in Control-M External Java Installation.
Verify that the Internal Process Communication (IPC) subsystem is enabled.
Verify that your locale is set to English before beginning the installation.
(Red Hat Linux) BMC recommends that you define the maxproc parameter to at least 4,096 before you install.
(AIX only) You must set the tcp_nodelayack to 1 as a root user, as follows:

/usr/sbin/no -o tcp_nodelayack=1
(Solaris only) You must configure /etc/project as root user, by adding the following line to the file:

project-name:project-id-number::username::rcap.max-rss=734003200

Begin

Log in as a Control-M/Agent user.
Download the installation files, as described in Obtaining Control-M Installation Files, and move them to the home directory.
Set your DISPLAY environment variable, as described in Setting Environment Variables in UNIX.
From the home directory, type the following command:

<source_path>/setup.sh
Do one of the following:
- Interactive Installation: Continue with the on-screen instructions until the installation is complete.
- Automatic Installation: Create a parameter file and then run the automatic install in a non-interactive mode, as follows:
  1. Continue with the on-screen instructions until the Summary window.
  2. Click Generate and select the location to create the XML parameter file.
  3. Click Yes to quit the installation.
    
    A confirmation message appears.
  4. Click Yes.
  5. Copy the automatic installation parameters file to a network location that is accessible to all computers where you want to perform an automatic installation.
  6. To run the installation script, type the following command:
    
    <Source_Path>/setup.sh -silent <xml_path>/<Filename.xml>
  If you want to encrypt a password in the installation, run the following command:
  
  <Source_Path>/setup.sh -encrypt <Password>
  
  The installation log is available in the following location:
  
  <$HOME>/BMCINSTALL/log/BMC_Control-M_AGENT_Install<date-time>.log
  
  The backup file is available in the following location:
  
  $HOME/BMCINSTALL/uninstall/DRKAI.9.0.22/backup_area
After Agent installation, jobs can run under the Agent user account only. To allow jobs to run under other Run As users, you must change the Agent mode, as described in set_agent_mode.

By default, Control-M/Agent is configured to work with TCP. To secure your environment, BMC recommends to change your configuration to SSL, as described in Zone 2 and 3 SSL Configuration.

Installing Control-M/Agent for Linux with RPM

This procedure describes how to install Control-M/Agent for Linux with Red Hat Package Manager (RPM). You can install only one instance of Control-M/Agent on a host because RPM installs Control-M/Agent on the root user.

You can only install Control-M/Agent with RPM for x86-64 architecture.
You cannot downgrade Control-M/Agent to a version lower than 9.0.22.
You cannot upgrade an existing Control-M/Agent installation to Control-M/Agent for RPM.

Before You Begin

Verify that you have one of the following operating systems for x 86_64 architecture:
- Amazon Linux
- Oracle Linux
- Red Hat
- SuSE
- AlmaLinux
Verify that you have Java 17 or 21 for x 86_64 architecture installed from a supported vendor, as described in Control-M Compatibility with External Java Vendors.
Define a non-root user as an Agent owner. See Configuring a User Account on UNIX.

Begin

Log in as the root user.
Download the installation files, as described in Obtaining Control-M Installation Files, and move it to a relevant directory.
(Optional) To change the default Control-M/Server host and port settings during the installation, in the /tmp directory, create a controlm-agent.ini input in with the parameters defined in the following format:

<parameter name>=<parameter value>
The following is an example of a controlm-agent.ini file:
Copy
```
CTMSHOST=localhost 
CTMPERMHOSTS="localhost|host2" 
ATCMNDATA=7005 
AGCMNDATA=7006
```
If you do not change a parameter value, it retains the default value, as described in this example.

For descriptions of the parameters, see Configuring Agent System Parameters.
Run the following command:

rpm -U <path to the rpm package file>

The following message appears:

Execute the set_agent_mode script as root, enable non-root mode, and start the agent with the start-ag utility.
To enable jobs to run as other Run as Users, change the Agent mode, as described in set_agent_mode.
Start the Agent, as described in Starting Up the Agent.

Installing Control-M/Agent for Debian or Ubuntu Linux with dpkg

This procedure describes how to install a Control-M/Agent for Debian or Ubuntu Linux with dpkg package manager. You can install only one instance of Control-M/Agent on a host because Debian installs Control-M/Agent on the root user.

You can only install Control-M/Agent for Debian for x86-64 architecture.
You cannot downgrade Control-M/Agent to a version lower than 9.0.22.
You cannot upgrade an existing Control-M/Agent installation to Control-M/Agent for Debian.

Before You Begin

Verify that you have either Debian or Ubuntu operating systems for x 86_64 architecture installed.
Verify that you have Java 17 or 21 for x 86_64 architecture installed from either Ubuntu (Private Build) or Debian.
Define a non-root user as an Agent owner. See Configuring a User Account on UNIX.

Begin

Log in as the root user.
Download the installation file, as described in Obtaining Control-M Installation Files, and move it to a relevant directory.
(Optional) To change the default Control-M/Server host and port settings during the installation, in the /tmp directory, create a controlm-agent.ini input in with the parameters defined in the following format:

<parameter name>=<parameter value>
The following is an example of a controlm-agent.ini file:
Copy
```
CTMSHOST=localhost 
CTMPERMHOSTS="localhost|host2"
ATCMNDATA=7005 
AGCMNDATA=7006
```
If you do not change a parameter value, it retains the default value, as described in this example.

For descriptions of the parameters, see Configuring Agent System Parameters.
Run the following command:

dpkg -i <path to the deb package file>

The following message appears:

Execute the set_agent_mode script as root, enable non-root mode, and start the agent with the start-ag utility.
To enable jobs to run as other Run as Users, change the Agent mode, as described in set_agent_mode.
Start the Agent, as described in Starting Up the Agent.