Control-M for Airflow Installation

The following procedures describe how to install Control-M for Airflow on Control-M/Agent on Linux and Windows, interactively or automatically, in a Control-M/Server self-hosted environment.

If you want to install multiple instances of Control-M for Airflow on several computers using the same configuration, use the automatic installation, as described in these procedures.

Before you install Control-M for Airflow, verify that you have installed the following:

Control-M/Server 9.0.20.200 or higher.
Control-M/Agent 9.0.21 or higher.

Installing Control-M for Airflow on Control-M/Agent on Linux

This procedure describes how to install Control-M for Airflow on Control-M/Agent on Linux.

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

Verify that all jobs running on the Control-M/Agent have ended.
Verify that you have met Java requirements, as described in Control-M External Java Installation.

Begin

Log in as the Control-M/Agent user.
Type the following command to stop the Control-M/Agent:

$CONTROLM/scripts/shut-ag -u <Agent_User> -p all

If the Control-M/Agent was installed with user root, then log in as user root every time you start up or shut down the Control-M/Agent throughout this procedure.
Extract the files from the temporary directory that you created when you obtained the installation files.
Use one of the following modes:
- Display: If you install using GUI (or XServer), set your DISPLAY environment variable, as described in Setting Environment Variables in UNIX.
- Console: It is not necessary to set DISPLAY.
Type the following command to activate the installation script:

<install_source_path>/setup.sh
Do one of the following:
- Interactive Install: Continue with the on-screen instructions until the installation is complete.
- Automatic Install: Do the following:
  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.
  4. Copy the automatic installation parameters file to a network location that is accessible to all computers where you want to perform an automatic installation.
  5. Type the following command to activate the installation script:
    
    <install_source_path>/setup.sh -silent <filename.xml>
The installation log is saved to the following location:

$HOME/BMCINSTALL/log/cmairflow/BMC_Airflow_Install_<date-time>.log
Log out of the Control-M/Agent.
Log in and start the Control-M/Agent with the following command:

$CONTROLM/scripts/start-ag -u <Agent_User> -p all

Installing Control-M for Airflow on Control-M/Agent on Windows

This procedure describes how to install Control-M for Airflow on Control-M/Agent on Windows.

Before You Begin

Verify that all jobs running on the Control-M/Agent have ended.
Verify that you have met Java requirements, as described in Control-M External Java Installation.

Begin

Log in as a user with Administrator privileges and stop the Control-M/Agent.
Do one of the following:
- From the installation path, double-click the setup.exe file.
- Open the command prompt as Administrator and type the following command:
  
  <Install_Source_Path>\setup.exe
Do one of the following:
- Interactive Install: Continue with the on-screen instructions until the installation is complete.
- Automatic Install: Do the following:
  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.
    
    The automatic installation XML parameters file created (<filename>.xml) is relevant only for computers with the same Control-M/Agent instance name. A separate <filename>.xml file must be created or modified manually for each Control-M/Agent instance name.
  4. Copy the automatic installation parameters file to a network location that is accessible to all Control-M/Agent computers where you want to perform an automatic installation.
  5. Run the installation script, as follows:
    <Install_Source_Path>\setup.exe -silent <silent.xml>
Restart the Control-M/Agent.

The installation log is available at the following location:
<Control-M Agent instance directory>\BMCINSTALL\log\cmairflow\BMC_Airflow_Install_<date-time>.log

If the installation fails, the log file is saved to the following location:
%temp%\BMC_Airflow_Install_<date-time>.log

Changing the JRE Package in Control-M for Airflow

This procedure describes how to change the JRE package in Control-M for Airflow. The use of JRE is supported only where the major release version is the same as the tested version. For more information about Java, see Control-M External Java Installation.

Begin

Do one of the following:
- UNIX: Do the following:
  1. Edit the external_java_path.dat file in the <HOME>/BMCINSTALL/ directory.
  2. Define an alternative Java home directory by modifying the value of the parameter CM_AIRFLOW_JAVA_HOME to the external Java path.
    
    CM_AIRFLOW_JAVA_HOME={new JRE Path}
    - A relative path is not supported.
    - The path can only include alphanumeric, period, underscore, hyphen and plus characters.
  3. Stop Control-M for Airflow using the following command.
    
    $CONTROLM/cm/AFL/exe/cm_container.sh stop
    
    Control-M for Airflow restarts automatically.
- Windows: Do the following:
  1. Edit the external_java_path.dat file in the <AGENT_HOME>\BMCINSTALL\ directory.
  2. Define an alternative Java home directory by modifying the value of the parameter CM_AIRFLOW_JAVA_HOME to the external Java path.
    
    CM_AIRFLOW_JAVA_HOME={new JRE Path}
    - The path must be enclosed with ? (quotation marks).
    - A network path is not supported.
    - A relative path is not supported.
    - The path can only include alphanumeric characters, spaces, ., _, -, and +.
  3. Stop Control-M for Airflow using the following command:
    
    <AGENT_HOME>\cm\AFL\exe\cm_container stop
    
    Control-M for Airflow restarts automatically.