Installing an Agent

This procedure describes how to install an Agent on a Windows or Linux host. The installation includes a default JRE package. You can use your own JRE package during or after the installation.

Before You Begin

Verify that you have met all requirements, as described in Agent System Requirements for Windows or Agent System Requirements for Linux.
(Linux only) Verify that you have completed all pre-install procedures, as described in Agent Pre-Installation Procedures for Linux

Begin

From the Configuration domain, click and then select System Settings.
The System Settings pane appears.
Click Install Agent.
Select the operating system where you want to install the Agent.
Do one of the following:
- Windows: Log into the target host with Administrative privileges, download the installation file and save it on the target host.
- Linux: Copy the cURL or wget command to the clipboard by clicking one of them and run it on the Agent host to download the installation file.
Set the Java environment variable with one of the following:
- Linux: Do the following:
  1. From a command line, type one of the following:
    
    shell/bash: export BMC_INST_JAVA_HOME=/home/java
    
    csh/tcsh: setenv BMC_INST_JAVA_HOME /home/java
  2. Install the Control-M/Agent component from the same session where you set the variable.

Windows: Do the following:
1. From a command line, type the following:
  
  set BMC_INST_JAVA_HOME=”C:\Program Files\Java”
2. Install the Control-M/Agent component from the same session where you set the variable.

From the Copy token of the selected Agent's authorization tag drop-down list, select the tag that this Agent must be assigned to.

A tag is a logical name that is used to label specific Agents into a group with a specific authorization level. You can only define one tag per Agent. You can apply a specific tag to an Agent or you can define your own tag with the asterisk character if you have the correct authorizations. For example, if users have been assigned the Agent tag with the value Fin*, they can define their own tag names when they install Agents, such as FinDev or FinOps.
Do one of the following:
- If the tokenAn authorization entity, required during Agent installation, that enables you to connect the Agent to your SaaS backend already appears, click to copy it to the clipboard.
- If the token isn't generated yet, do the following:
  1. Click create new token.
  2. Select an Agent tag pattern to generate a token.
  3. Enter a tag that matches the selected pattern.
  4. Click Generate Token
  5. Click to copy it to the clipboard.
You need this token key to perform the installation and connect the Agent to the Control-M environment. The token is based on the Agent tag and can be reused for additional installations with the same tag.
Run one of the following installation files:
- Windows: <file_path >/KAI.9.0.20.080_windows_x86_64.exe
- Linux: <file_path >/KAI.9.0.20.080_Linux-x86_64.BIN
  
  Verify that the file has execute permissions.
Do one of the following:
- Interactive install: Follow the on-screen instructions until the installation is complete.
- Automatic install: Create an xml installation file and then run the automatic install in a non-interactive mode, as follows:
  1. Follow the on-screen instructions until the Summary window.
  2. Click Generate and select the location to create the XML installation 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. Log in using a user ID that has Administrator permissions on the current computer.
  7. Run the installation file, as follows:
    
    <installation_file> -silent <xml_path>\<filename.xml>-BMC_INST_JAVA_HOME <java_path> -token <value>
    
    The installation log can be found at the following location:
    
    <installFolder>\BMCINSTALL\log\
- Automation API Automatic install: Follow the on-screen instructions until the installation is complete, as described in Automation API Automatic install.
After the installation is complete, the Agent appears in the Agents tab
Verify that installation was successful by opening the installed-versions.txt file in the Agent home directory and check that the correct product code appears.

For a list of product codes, see Installing an Agent.

For a list of frequently asked questions about Agent installation, see Agent Installation FAQ.

Upgrading an Agent

This procedure describes how to upgrade an Agent on a Windows or Linux host. The installation includes a default JRE package. You can use your own JRE package after the upgrade completes.

Before You Begin

Verify that you have met all requirements, as described in Agent System Requirements for Windows or Agent System Requirements for Linux.
(Linux only) Verify that you have completed all pre-install procedures, as described in Agent Pre-Installation Procedures for Linux.

Begin

From the Configuration domain, click and then select System Settings.
Click Install Agent.
Select the operating system of the Agent.
Do one of the following:
- Windows: Log into the target host with Administrative privileges, download the installation file and save it on the target host.
- Linux: Copy the cURL or wget command to the clipboard by clicking one of them and run it on the Agent host to download the installation file.
Run one of the following installation files:
- Windows: <file_path >/KAI.9.0.21.080_windows_x86_64.exe
- Linux: <file_path >/KAI.9.0.21.080_Linux-x86_64.BIN
  
  Verify that the file has execute permissions.
Do one of the following:
- Interactive upgrade: Follow the on-screen instructions until the upgrade is complete.
- Automatic upgrade: Create an xml installation file and then run the automatic upgrade in a non-interactive mode, as follows:
  1. Follow the on-screen instructions until the upgrade completes.
  2. Click Generate and select the location to create the XML installation 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 upgrade.
  6. Log in using a user ID that has Administrator permissions on the current computer.
  7. Run the installation file, as follows:
    
    <installation_file> -silent <xml_path>\<filename.xml>
    
    The upgrade log is save to the following location:
    
    <installFolder>\BMCINSTALL\log\
- Automation API Automatic install: Follow the on-screen instructions until the installation is complete, as described in provision saas::install.
- Automatic Upgrade: Upgrades Control-M/Agent and all plug-ins installed on the Agent. Follow the on-screen instructions until the installation is complete, as described in provision agent::update. To run this API command, the current version of Control-M/Agent must be 9.0.20.280 or higher.
  
  If Control-M MFT or Control-M for SAP is installed on the Agent, you must stop the Agent before you upgrade and start it afterwards. To avoid Agent downtime, you can create a host group and include multiple Agents with the same plug-in within the host group. After you shut down one Agent, jobs are routed to another Agent in the host group.
Verify that upgrade was successful by opening the installed-versions.txt file in the Agent home directory and check that the correct product code appears.

For a list of frequently asked questions about Agent installation, see Agent Installation FAQ.