Installing Control-M/Agent on Windows

This procedure describes how to install Control-M/Agent on Windows, which includes Application Integrator and Control-M Automation API CLI. If a previous version of Control-M/Agent is detected, the Agent is automatically upgraded and the previous version parameter values are saved. You can automatically or interactively install Control-M with its default settings or custom define its database server and name, along with the component usernames, hostnames, and port settings, as follows:

  • Interactive Installation: Prompts you for installation settings via a GUI or command line.

  • Automatic Installation: Applies the installation settings that you include in a parameter file option argument, and enables you to simultaneously install Control-M instances on multiple hosts.

You can install up to three Agents on a single host.

Before You Begin

  • Verify that you meet the system requirements, as described in Agent System Requirements for Windows.

  • Verify that an external Java package is installed outside of the <Control-M/Agent_Home> directory, as described in External Java Installation.

  • Verify that Windows Powershell is set to Full Language Mode.

  • Verify that the Internal Process Communication (IPC) subsystem is enabled.

  • Verify that your operating system locale is set to English.

  • Download the installation package, as described in Obtaining Control-M Installation Files.

  • (Control-M Automation API CLI only) Verify the following:

    • Python 3.8.4 or higher and pip 20.1.1 or higher is installed.

    • Your system path includes the required Python executable pathname. Or, to use a different Python installation, point the CLI_INSTALL_PYTHON_EXE environment variable to the relevant Python installation.

    If you want to use Automation API CLI at a later time, you must install Python and pip, run the ctm command, and then follow the prompts.

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

Begin

  1. Log in to the host with user ID that has Administrator permissions.

  2. Copy the installation files to the home directory.

  3. From a command prompt, run the following command:

    <Source_Path>\setup.exe

  4. 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.

        The automatic installation XML parameters file that is created (<Filename>.xml) is relevant only for hosts with the same Agent instance name. Otherwise, a separate <Filename>.xml file must be created for each host, or modified manually for each host.

      5. Copy the automatic installation parameters file to a network location that is accessible to all hosts where you want to perform an automatic installation.

      6. Log in using a user ID that has Administrator permissions on the current host.

      7. Run the following installation script:

        <Source_Path>\setup.exe -silent <xml_path>\<Filename.xml>

        If you want to encrypt a password in the installation, run the following command:

        <Source_Path>\setup.exe -encrypt <Password>

        The installation log can be found at the following location:

        <Installation_Folder>\BMCINSTALL\log\BMC_Control-M_AGENT_Install<date-time>.log

        The backup file is available in the following location:

        <Installation_Directory>\BMCINSTALL\uninstall\DRKAI.9.0.22\backup_area