Control-M/Agent Upgrade

You can upgrade to Control-M/Agent 9.0.02 on UNIX and Windows from version 9.0.2 and higher. Control-M/Agent must be upgraded after Control-M/Server.

The following procedures describe the Control-M/Agent upgrade process:

You can also downgrade Control-M/Agent to the previous  version, as described in Control-M/Agent Downgrade.

Control-M/Agent SSL Requirements

If the Agent is configured for TCP mode, the Agent upgrade procedure installs the default PKCS #12.

The following actions are required for sites with SSL:

  • You cannot upgrade an Agent if you work in SSL with a KDB keystore. You must deploy a PKCS #12 keystore before you upgrade to 9.0.02. If the Agent is configured for SSL mode and uses a KDB keystore, the upgrade attempts to convert the KDB to PKCS #12 archive file. If this fails, the upgrade aborts and prompts you to manually replace the KDB with a PKCS #12 archive file (keystore).

  • If the Agent is configured to communicate via an SSL protocol lower than TLS1_2 (either SSLv3 or TLS1), you must update SSL to TLS1_2.

For more information about security policy attributes, see Security Policies.

Upgrading Control-M/Agent on UNIX

This procedure describes how to upgrade Control-M/Agent 9.0.2 or higher to the latest version of Control-M/Agent on UNIX, which includes Application Integrator and Automation API CLI. You can upgrade multiple Agents on several hosts with the same configuration via automatic upgrade, as described in this procedure.

  • This procedure upgrades the Agent locally. To deploy and upgrade multiple Agents from the CCM, see Agent Deployment.

  • If you upgrade the Agent, Application Integrator that was part of Application Pack is also upgraded. If you roll back the Agent, then Application Integrator cannot work. To re-enable Application Integrator, you must uninstall and then reinstall Application Pack.

  • If Application Pack is installed, verify that all Application Integrator jobs have completed before you upgrade the Agent.

  • If Application Pack version 9.0.21.000 or lower is installed and you want to upgrade to Control-M/Agent 9.0.22, you must upgrade Application Pack to 9.0.21.100 or uninstall Application Pack, and then upgrade the Agent to 9.0.22.

  • If you upgrade from a version lower than 9.0.2, you need to upgrade to 9.0.2 and then upgrade to 9.0.02.

  • If you utilize Automation API CLI, Python version 3.8.4 or higher and pip version 20.1.1 or higher are required for a successful upgrade.

    If the required Python is not detected and you use Automation API CLI, the upgrade fails. If the required Python is not detected and you do not use Automation API CLI, a warning message appears.

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

Before You Begin

Begin

  1. Log in as an Agent user and then switch to user root.

    If you upgrade the Agent in non-root mode, log out user root and log in as the Agent user.

  2. Copy the upgrade files from the temporary to the host where the existing Agent is installed.

  3. Set your DISPLAY environment variable, as described in Setting Environment Variables in UNIX.

  4. From the Agent home directory, type the following:

    <source_path>/setup.sh

  5. Do one of the following:

    • Interactively Upgrade: Select Control-M/Agent and continue with the on-screen instructions until the upgrade is complete.

    • Automatically Upgrade: Create a parameter file and then run the automatic install in a non-interactive mode, as follows:

      1. Select Control-M/Agent and continue with the on-screen instructions until the Summary window appears.

        There is no confirmation to shut down Agent processes. It is done automatically.

      2. Click Generate and select the location to create the XML parameter file.

      3. Click Yes to quit the upgrade.

        A confirmation message appears.

      4. Click Yes.

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

      6. Run the following command:

        <source_path>/Setup_files/components/agent/setup.sh -silent <xml_path>/<filename.xml>

        The upgrade log can be found at the following location:

        <$HOME>/BMCINSTALL/log/BMC_Control-M_Agent_<date-time>.log

Upgrading Control-M/Agent on Windows

This procedure describes how to upgrade from Control-M/Agent 9.0.2 and higher to the latest version of Agent on Windows. If you want to upgrade multiple instances of Control-M/Agent on several hosts with the same configuration, use the automatic upgrade, as described in this procedure.

  • This procedure upgrades the Agent locally. To deploy and upgrade multiple Agents from the CCM, see Agent Deployment.

  • If there are multiple Agents installed on the same host, you must upgrade each Agent to the same version before you can start up any Agent.

  • If you upgrade the Agent, Application Integrator that was part of Application Pack is also upgraded. If you roll back the Agent, then Application Integrator cannot work. To re-enable Application Integrator, you must uninstall and then reinstall Application Pack.

  • If Application Pack is installed, verify that all Application Integrator jobs have completed before you upgrade the Agent.

  • If Application Pack version 9.0.21.000 or lower is installed and you want to upgrade to Control-M/Agent 9.0.22, you must upgrade Application Pack to 9.0.21.100 or uninstall Application Pack, and then upgrade the Agent to 9.0.22.

  • If you upgrade from a version lower than 9.0.2, you need to upgrade to 9.0.2 and then upgrade to 9.0.02.

  • If you use Automation API CLI, Python version 3.8.4 or higher and pip version 20.1.1 or higher are required.

    If the required Python is not detected and you use Automation API CLI, the upgrade fails. If the required Python is not detected and you do not use Automation API CLI, a warning message appears.

Before You Begin

Begin

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

  2. Copy the upgrade files from the temporary directory to the host where the existing Agent is installed.

  3. From a command prompt window, type the following:

    <source_path>\setup.exe.

  4. Do one of the following:

    • Interactively Upgrade: Select Control-M/Agent and continue with the on-screen instructions until the upgrade is complete.

    • Automatically Upgrade: Create a parameter file and then run the automatic install in a non-interactive mode, as follows:

      1. Select Control-M/Agent and continue with the on-screen instructions until the Summary window appears.

        There is no confirmation to shut down Agent processes. It is done automatically.
      2. Click Generate and select the location to create the XML parameter file.

      3. Click Yes to quit the upgrade.

        A confirmation message appears.

      4. Click Yes.

        The automatic upgrade 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 upgrade parameters file to a network location that is accessible to all hosts where you want to perform an automatic upgrade.

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

      7. Run the following upgrade script:

        <source_path>\Setup_files\components\oneagent\setup.exe -silent <xml_path>\<filename.xml>

        The upgrade log is at the following location:

        %temp%\BMC_Control-M_Agent_<date-time>.log

Control-M/Agent Downgrade

If you want to downgrade to a version of Control-M/Agent that is lower than 9.0.02, you must uninstall Control-M/Agent, as described in Control-M/Agent Uninstall. After the uninstall, the version will automatically revert to the previous version.