Control-M Upgrade

The Control-M upgrade process upgrades your current version of Control-M/EM, Control-M/Server, and Control-M/Agent to the latest annual or fix pack version on the same computer. This eliminates the need to migrate data and reduces downtime. Control-M processes remain up during the upgrade preparation process, which prepares all the required files. After the preparation completes, you are prompted to confirm the shutdown of Control-M processes. After the processes are shut down, the upgrade begins and completes with minimum downtime.

  • You can only upgrade from Control-M/EM and Control-M/Server version 9.0.19 or higher. For lower versions, you must first migrate your data, as described in Control-M Migration.

  • Control-M requires an external Java library. To ensure that Java libraries remain updated to the latest versions, Java library deliveries are decoupled from Control-M and not part of the upgrade. For more information, see Control-M External Java Installation.

The upgrade process supports compatibility across all Control-M components, as follows:

  • An upgraded Control-M/EM is compatible with lower versions of Control-M/Server, from version 9.0.19 and higher.

  • An upgraded Control-M/Server is compatible with lower versions of Control-M/EM, from version 9.0.19 and higher.

  • An upgraded Control-M/EM is compatible with lower versions of Control-M client , from version 9.0.19 and higher. However, the new features of the higher version are disabled.

    For more information, see Compatibility Mode and Control-M Client and Control-M/EM Server Compatibility Scenarios.

  • An upgraded Control-M/Server is compatible with lower versions of Control-M/Agent, from version 9.0.00.300 and higher.

  • An upgraded Agent is compatible with lower versions of Control-M/Server, from version 9.0.19 and higher

The following description illustrates a typical upgrade scenario:

Before you upgrade, review the Upgrade Requirements and Considerations.

The following procedures describe how to upgrade Control-M/EM, Control-M/Server, and Control-M/Agent:

If you are using the BMC-provided PostgreSQL database, after you upgrade Control-M/EM or Control-M/Server, the PostgreSQL database server version remains the same and must be upgraded, as described in Control-M Upgrade.

If you are using an Oracle or MSSQL external database, see Upgrading an External Oracle or MSSQL Database Server.

Upgrade Requirements and Considerations

The following table lists requirements and considerations to review prior to the upgrade.

Component/Topic

Requirement

New Features

You must upgrade both Control-M/EM and Control-M/Server to use the new features of Control-M 9.0.21.300.

Authorizations

Control-M authorizations are only assigned to roles. To upgrade from any version lower than 9.0.21, you must assign all users to a role. Previous user authorizations are migrated in an upgrade but cannot be modified. For this reason, BMC recommends that you move all user authorizations to a role and assign the role to specific users to ensure that all user attributes can be managed. For more information, see User and Role Authorizations.

PostgreSQL Database Server

You must upgrade PostgreSQL database server to version 11.5 to use Control-M version 9.0.21.300. If you do not upgrade, Control-M might not work as expected.

On AIX systems, you cannot upgrade to PostgreSQL 11.5.

Compatibility Mode

  • If Compatibility Mode is on, you can connect Control-M client 9.0.20 and higher to other 9.0.21.300 environments.

  • If Compatibility Mode is on, you cannot upgrade to 9.0.21.300 if the Compatibility version is 9.0.19 or lower.

  • After you turn Compatibility Mode off, you can only connect Control-M client 9.0.21.300 to other 9.0.21.300 environments.

  • If Compatibility Mode is on, you cannot deploy the Agent or Application Pack9.0.21.300 packages.

  • After you upgrade to Control-M 9.0.21.300 and turn Compatibility Mode off, you can no longer downgrade Control-M to a version lower than 9.0.21, since the password encryption method changes.

    After you upgrade to Control-M 9.0.21.300 and before you turn Compatibility Mode off, you can back up passwords with the following command:

    em util -U <username> -P <password> -export -type user -file user-exp-before-921.txt

Promotion

  • Promotion from one environment to another is only possible if the source and target Control-M/EM machines are the same version of Control-M/EM.

  • If you upgrade Control-M/EM on the source machine and Compatibility Mode is off, you must edit any previously defined target promotion environments to update password encryption.

  • If you upgrade Control-M/EM on the target machine and Compatibility Mode is off, you must log in at least once on the target machine prior to promotion to update password encryption.

  • If you upgrade Control-M/EM on both the source and target machines and Compatibility Mode is on, promotion always completes successfully.

  • Check whether any of your promotion rules involve changes to fields in plug-ins that are deprecated and discontinued. These promotions rules must be deleted.

HTTPS Protocol

  • The Control-M client connects to the Control-M/EM server via the Control-M Web Server. After the upgrade, BMC recommends to use the HTTPS protocol with a secured port as opposed to the insecure HTTP protocol.

  • For Control-M Web, you are automatically redirected to an HTTPS protocol with the secured port.

Control-M/Agent

You can upgrade Control-M/Agent 9.0.00.300 and higher to version 9.0.21.300.

Control-M Full Installation

To avoid any Kafka configuration issues, you must do the following:

  • Shut down both Control-M/EM and Control-M/Server before upgrade.

  • Upgrade Control-M/EM before you upgrade Control-M/Server.

Application Integrator

Export all job types that were created through Application Integrator prior to the upgrade.

For upgrades from version 9.0.19.xxx to 9.0.21, or 9.0.21.100, you must re-import all the job types after the upgrade. To avoid this additional import step, you can plan an upgrade in stages, as follows:

  1. Upgrade from 9.0.19.xxx to 9.0.20.200.

  2. Upgrade to 9.0.21.100.

Control-M/EM Distributed

  • In a Control-M/EM Distributed environment, you must install the same version on both the Control-M/EM Server and Control-M/EM Distributed hosts, as described in Upgrading Control-M/EM on UNIX and Upgrading Control-M/EM on Windows.

  • The Control-M Workload Archiving and Control-M Workflow Insights servers are upgraded during the Control-M/EM Distributed upgrade.

Client Distribution

  • This feature is disabled during upgrade.

  • To enable users to upgrade their clients without installing Java, you can save Java 1.8 (64-bit) or higher to a network location that is accessible by all Control-M client machines and define the pathname in the following file:

    <EM_HOME>/Client_Updates/conf/client_deploy_java.properties

    java_home_path=/network/java_home_directory

SSL

  • Control-M/EM: If the CmsCommMode system parameter value is SSL or AUTO, with at least one Control-M/Server connected via SSL, then you must ensure the following:

    • The security policy must not use a *.kdb file keystore.

    • The security policy must be configured to the TLS 1.2 protocol before the upgrade.

    • If you installed Control-M/EM 9.0.20.205, you must disable SSL before you upgrade to 9.0.21.300.

    • ManageSSL and Manage_SSL_BYO: If the value of the message digest algorithm is sha1, it is upgraded to sha256. If the value of the certificates key length is 1,024, it is upgraded to 2,048.

  • Control-M/Server

    • If your Control-M/Server is configured to work in SSL mode and it uses a KDB keystore, the upgrade is aborted.

    • If your Control-M/Server is configured to work in TCP mode, the Control-M/Server upgrade installs the default PKCS #12 archive file.

    • If Control-M/Server is configured to communicate via an SSL protocol that is less than TLS1_2 (either SSLv3 or TLS1), you must update the SSL protocol to TLS1_2.

    • If you use Control-M/Server 9.0.20.204, you must disable SSL before you upgrade to 9.0.21.300.

  • Control-M/Agent

    • If your Agent is configured to work in SSL mode and the Agent is using 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 work in TCP mode, Agent upgrade procedure installs the default PKCS #12.

    • If the Agent is configured to use SSL protocol less than TLS1_2 (either SSLv3 or TLS1), update the SSL protocol to TLS1_2.

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

High Availability

  • To upgrade in a High Availability environment, see High Availability Requirements.

  • If you set the Secondary to Primary after a failover, you cannot downgrade to an earlier version. You must fall back to the Primary before you can downgrade.

Demo Ha Cluster Scripts

If modified demo scripts from previous versions are stored in the $HOME/ctm_em/bin directory, the upgrade overwrites them and you must recreate them.

BMC recommends that you back the scripts up separately or modify the new demo scripts that are placed in the directory as part of the upgrade.

For more information, see Modifying the Demo Ha Cluster Script.

Site Standards

Site Standards defined in the original version of Control-M are backed up to the def_items_table_backup.dat file during the upgrade.

To downgrade, see Restoring Site Standards after Downgrade.

Rule Based Calendars

After you upgrade, if you have Rule-Based Calendars with specific dates, you must Force Upload them to the Control-M/Server.

Backup Folders

After you upgrade, the backup folder of the previous version is compressed into a zip or tar file and encrypted.

However, the exe folder of the previous version is kept on the host for three days before it is automatically deleted for the following components:

  • Control-M/EM 

  • Control-M/Server

  • Control-M/Agent

  • Application Integrator

  • Automation API

Upgrade Scenarios

The following table lists the supported upgrade options to upgrade to 9.0.21.300 based on your database and version.

Database

Version

Upgrade Action

PostgreSQL (Dedicated)

  • 9.6

  • 9.5

  1. Upgrade to Control-M 9.0.20.

  2. Upgrade to PostgreSQL 11.5.

  3. Upgrade to Control-M 9.0.21.300.

10.4

  1. Upgrade to Control-M 9.0.21.300.

  2. Upgrade to PostgreSQL 11.5.

    On AIX, you cannot upgrade to PostgreSQL 11.5. However, you can convert the BMC-provided PostgreSQL database to an external PostgreSQL database and upgrade to one of the supported versions, as listed in the Product Availability and Compatibility.

11.5

Upgrade to Control-M 9.0.21.300.

Oracle

  • 11

  • 12c

  • 18c

  1. Upgrade to Oracle 19c.

  2. Upgrade to Control-M 9.0.21.300.

19c

Upgrade to Control-M 9.0.21.300

MSSQL

  • 2008

  • 2012

  1. (Windows 2012R2 or 2016 only) Upgrade to MSSQL 2014 or higher.

  2. Upgrade to Control-M 9.0.21.300.

2014 SP3

(Windows 2012R2 or 2016 only) Upgrade to Control-M 9.0.21.300.

  • 2016

  • 2017

  • 2019

Upgrade to Control-M 9.0.21.300.

PostgreSQL (Existing)

9 or lower

  1. Upgrade to Control-M 9.0.20.

  2. Upgrade to PostgreSQL 11.x or 12.x.

  3. Upgrade to Control-M 9.0.21.300

10.x

  1. Upgrade to Control-M 9.0.21.300

  2. Upgrade to PostgreSQL 11.x, 12.x, 13.x, or 14.x.

  • 11.x

  • 12.x

  • 13.x

  • 14.x

Upgrade to Control-M 9.0.21.300.

Compatibility Mode

Compatibility Mode allows users with previous versions of Control-M client to connect to the latest version of Control-M/EM Server along with the upgraded Control-M clients. However, when Compatibility Mode is on, new features are disabled in upgraded Control-M clients. This ensures system integrity during the transition to a higher version. After Compatibility Mode is turned off, the new features are enabled in the upgraded Control-M clients and the older clients are disconnected. Users that have not upgraded their Control-M clients cannot log in.

After you upgrade to Control-M/EM 9.0.21.300 and turn off Compatibility Mode, you can no longer downgrade Control-M/EM to a version lower than 9.0.21, ssince the password encryption method changes.

The following table lists the features that are disabled in Control-M clients after you have upgraded and compatibility mode is on.

Source Version

Disabled Features
9.0.20.xxx

  • Users

  • Roles

  • API Tokens

  • System Settings

  • IdP Authentication (SAML)

  • Reference Folder

  • SHA512 Encryption Algorithm
9.0.19.xxx

  • (Control-M Web) User Views

  • (Control-M Web) Site Standards

  • XML Validation

  • 85-Character Hostname Limit

  • Centralized Connection Profiles

  • (Control-M Web) Control-M MFT Enterprise

  • RBA Authorizations

  • 9.0.20.xxx Features

Turning off Compatibility Mode

This procedure describes how to turn off Compatibility Mode, which enables new features in upgraded clients.

  • After Compatibility Mode is turned off, users that have not upgraded their Control-M clients cannot log in.

  • After Compatibility Mode is turned off, you cannot turn it back on.

Begin

  1. From the CCM in the Manage tab, click Compatibility Mode.

  2. Click I have read and understand.

  3. Click Turn Off Compatibility Mode.

    Control-M/EM server components are automatically restarted.

Control-M Client and Control-M/EM Server Compatibility Scenarios

The following table lists the different Control-M client and Control-M/EM Server compatibility scenarios after you upgrade Control-M/EM Server from the source (compatibility version) to the new target version.

Control-M/EM Server Source Version

Control-M/EM Server Target Version

Client Version

Result
9.0.20.xxx 9.0.21

9.0.20.xxx

Compatibility Mode: On

 Success
9.0.20.xxx

9.0.21

9.0.20.xxx

Compatibility Mode: Off

Fail

Reason: If compatibility mode is off, the client must be in the same major release as the server target version.
9.0.20.xxx 9.0.21

9.0.21

Compatibility Mode: On

 Success

Upgrading Control-M/EM on UNIX

This procedure describes how to upgrade from Control-M/EM 9.0.19 and higher (default and Distributed) to the latest version of Control-M/EM on UNIX. To upgrade multiple instances of Control-M/EM on several computers with the same configuration, use the automatic installation, as described in this procedure.

  • The default upgrade 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 upgrade or perform an automatic upgrade.

  • If you have a Control-M/EM Distributed installation, you must upgrade the default Control-M/EM first and then upgrade the Distributed Control-M/EM. The Workload Archiving server is upgraded automatically during the Control-M/EM Distributed upgrade.

  • If you are upgrading in a Full installation environment, you must do the following:

    • Shut down both Control-M/EM and Control-M/Server before you upgrade.

    • Upgrade Control-M/EM before you upgrade Control-M/Server.

Before You Begin

Ensure that you have met the following requirements:

Begin

  1. Copy the installation files from the temporary directory that you created in Obtaining Control-M Installation Files, to the host where the existing Control-M/EM is installed.

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

  3. From your home directory, type the following command:

    <source_path>/setup.sh

  4. Do one of the following:

    • Interactive upgrade: Select the Control-M/Enterprise Manager option and continue with the on-screen instructions until the upgrade is complete.

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

      1. Select the Control-M/Enterprise Manager option and continue with the on-screen instructions until the Summary window.

        There is no confirmation to shut down Control-M/EM 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 computers where you want to perform an automatic upgrade.

      6. To run the upgrade script, type the following command:

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

        The upgrade logs can be found at the following location:

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

        To ensure compatibility between older versions of Control-M client, Control-M/EM is now running in Compatibility Mode.

        By default, Control-M/EM and Control-M clients are configured to work with HTTP. To secure your environment, BMC recommends to change your configuration to HTTPS, as described in Zone 1 SSL Configuration.

Upgrading Control-M/EM on Windows

This procedure describes how to upgrade from Control-M/EM 9.0.19 (Default and Distributed) and higher to the latest version of Control-M/EM on Windows. If you want to install multiple instances of Control-M/EM on several computers using the same configuration, use the automatic installation, as described in this procedure.

  • If you have a Control-M/EM Distributed installation, you must upgrade the default Control-M/EM first and then upgrade the Distributed Control-M/EM. The Workload Archiving server is upgraded automatically during the Control-M/EM Distributed upgrade.

  • If you are upgrading in a Full installation environment, you must do the following:

    • Shut down both Control-M/EM and Control-M/Server before you upgrade.

    • Upgrade Control-M/EM before you upgrade Control-M/Server.

Before You Begin

Begin

  1. Log in to the computer using a user ID that has Administrator permissions.

  2. Copy the installation files from the temporary directory that you created in Obtaining Control-M Installation Files, to the host where the existing Control-M/EM is installed.

  3. From a command prompt window, enter <source_path>\setup.exe.

  4. Do one of the following:

    • Interactive Upgrade: Select the Control-M/Enterprise Manager option and continue with the on-screen instructions until the upgrade is complete.

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

      1. Select the Control-M/Enterprise Manager option and continue with the on-screen instructions until the Summary window.

        There is no confirmation to shut down Control-M/EM processes. It is done automatically

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

      3. Click Yes to quit the upgrade.

      4. A confirmation message appears.Click Yes.

      5. Copy the automatic upgrade 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 upgrade script, as follows:

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

        The upgrade log can be found at the following location:

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

        To ensure compatibility between older versions of Control-M client, Control-M/EM is now running in Compatibility Mode.

        By default, Control-M/EM and Control-M clients are configured to work with HTTP. To secure your environment, BMC recommends to change your configuration to HTTPS, as described in Zone 1 SSL Configuration.

Upgrading Control-M Client on Windows from the Full Installation Package

This procedure describes how to upgrade the Control-M client to the latest version on Windows from the Full installation package. If you want to install multiple instances of Control-M client on several computers using the same configuration, use the automatic installation, as described in this procedure.

Before You Begin

Begin

  1. Log in to the computer using a user ID that has Administrator permissions.

  2. Copy the installation files from the temporary directory that you created in Obtaining Control-M Installation Files, to the host where the existing Control-M/EM is installed.

  3. Do one of the following:

    • Interactive upgrade: Select the Control-M/Enterprise Manager option and continue with the on-screen instructions until the upgrade is complete.

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

      1. Select the Control-M/Enterprise Manager option and 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 upgrade.

      4. A confirmation message appears. Click Yes.

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

      6. Run the upgrade script, as follows:

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

        The upgrade log can be found at the following location:

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

Upgrading Control-M Client on Windows from the Client Installation Package

This procedure describes how to upgrade the Control-M client to the latest version on Windows from the client installation package. If you want to install multiple instances of Control-M client on several computers using the same configuration, use the automatic installation, as described in this procedure.

Before You Begin

  • Ensure that your operating system is compatible with the new version of the Control-M client, as described in Control-M/EM Windows System Requirements.

  • Verify one of the following:

    • Java 1.8 (64-bit) or higher is available in your Path Environment Variable.

    • The Java path is on a network, which is accessible from all Control-M clients.

      To enable users to upgrade their clients without installing Java, you can place Java 1.8 (64-bit) or higher on a network location that is accessible by all Control-M client machines and define the path in the following file:

      <EM_HOME>/Client_Updates/conf/client_deploy_java.properties

      java_home_path=/network/java_home_directory

Begin

  1. Copy the installation files from the temporary directory that you created in Obtaining Control-M Installation Files, to the host where the existing Control-M/EM is installed.

  2. From the same command line, run the following command:

    <source_path>\setup.exe

    If Java is not available, run the following command:

    setup.bat -BMC_INST_JAVA_HOME <Java 11 installation directory>

    The Java installation directory must contain the bin directory and the Release file.

  3. Do one of the following:

    • Interactive upgrade: Follow the on-screen instructions until the upgrade is complete.

    • Automatic upgrade: Create a parameter 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 parameter file. Click Yes to quit the upgrade.

      3. Click Yes to quit the upgrade.

      4. A confirmation message appears. Click Yes.

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

      6. Run the upgrade script, as follows:

        <source_path>\Setup_files\components\clientem\setup.bat -silent <xml_path>\<filename.xml>

        The upgrade log can be found at the following location:

        <installFolder>\BMCINSTALL\log\BMC_Control-M_client_<date-time>.log

Upgrading Control-M Client from the Control-M Welcome Page

This procedure describes how to upgrade the Control-M client on Windows from the Control-M Welcome Page. The Control-M/EM server and port are automatically configured during the installation.

Before You Begin

  • Ensure that your operating system are compatible with the current version of the Control-M client, as described in Control-M Client and Control-M/EM Server Compatibility Scenarios.

  • Verify one of the following:

    • Java 1.8 (64-bit) or higher is available in your Path Environment Variable.

    • The Java path is on a network, which is accessible from all Control-M clients.

      To enable users to upgrade their clients without installing Java, you can place Java 1.8 (64-bit) or higher on a network location that is accessible by all Control-M client machines and define the path in the following file:

      <EM_HOME>/Client_Updates/conf/client_deploy_java.properties

      java_home_path=/network/java_home_directory

Begin

  1. Open a new browser window before you download and install.

  2. Go to <Control-M/EM_Host>:<port>/Welcome/ and from the Control-M Client section, click Download.

  3. Run the upgrade and continue with the on-screen instructions until the upgrade is complete.

    The upgrade log can be found at the following location:

    <installFolder>\BMCINSTALL\log\BMC_Control-M_client_<date-time>.log

Upgrading Control-M/Server on UNIX

This procedure describes how to upgrade from Control-M/Server 9.0.19 and higher to the latest version of Control-M/Server on UNIX. If you want to upgrade multiple instances of Control-M/Server on several computers using the same configuration, use the automatic upgrade, as described in this procedure.

  • The default upgrade 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 upgrade or perform an automatic upgrade.

  • If you are upgrading in a Full installation environment, you must do the following:

    • Shut down both Control-M/EM and Control-M/Server before you upgrade.

    • Upgrade Control-M/EM before you upgrade Control-M/Server.

Before You Begin

Ensure that you have met the following requirements:

  • Verify that your operating system and database software is compatible with the new version of Control-M/Server, as described in Control-M/Server UNIX System Requirements.

  • Verify that you have met Java requirements, as described in Control-M External Java Installation.

  • Set the BMC_INST_CTM_APIGTW_PORT environment variable to the number of an unused port of your choice. The default is 8393.

  • If you are upgrading in a cluster environment, see Control-M/Server UNIX Cluster Configuration.

  • If your current Control-M components were installed using the Full Installation method and you are upgrading from a version earlier than 9.0.20, upgrade Control-M/EM before upgrading Control-M/Server.

  • Verify that the Control-M/Server database server is up.

Begin

  1. Copy the installation files from the temporary directory that you created in Obtaining Control-M Installation Files, to the host where the existing Control-M/Server is installed.

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

  3. From your home directory, type the following command:

    <source_path>/setup.sh

  4. Do one of the following:

    • Interactive upgrade: Select the Control-M/Server option and continue with the on-screen instructions until the upgrade is complete.

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

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

        NOTE: There is no confirmation to shut down Control-M/Server 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 computers where you want to perform an automatic upgrade.

      6. To run the upgrade script, type the following command:

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

        The upgrade log can be found at the following location:

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

  5. If a firewall is active, perform the steps described in System Configuration.

Upgrading Control-M/Server on Windows

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

Before You Begin

  • Ensure that your operating system and database software is compatible with the new version of Control-M/Server, as described in Control-M/Server Windows System Requirements.

  • Verify that you have met Java requirements, as described in Control-M External Java Installation.

  • Set the BMC_INST_CTM_APIGTW_PORT environment variable to the number of an unused port of your choice. The default is 8393.

  • If you are upgrading in a cluster environment, see Control-M/Server Windows Cluster Configuration.

  • If your current Control-M components were installed using the Full Installation method and you are upgrading from a version earlier than 9.0.20, upgrade Control-M/EM before upgrading Control-M/Server.

  • Verify that the Control-M/Server database server is up.

  • If you are upgrading in a Full installation environment, you must do the following:

    • Shut down both Control-M/EM and Control-M/Server before you upgrade.

    • Upgrade Control-M/EM before you upgrade Control-M/Server.

Begin

  1. Log in to the computer using a user ID that has Administrator permissions.

  2. Copy the installation files from the temporary directory that you created in Obtaining Control-M Installation Files, to the host where the existing Control-M/Server is installed.

  3. From a command prompt window, enter <source_path>\setup.exe.

  4. Do one of the following:

    • Interactive upgrade: Select the Control-M/Server option and continue with the on-screen instructions until the upgrade is complete.

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

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

        There is no confirmation to shut down Control-M/Server 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 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 upgrade script, as follows:

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

        The upgrade log can be found at the following location:

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

  5. If a firewall is active, perform the steps described in System Configuration.

Upgrading Control-M/Agent on UNIX

This procedure describes how to upgrade from Control-M/Agent 9.0.00.300 and higher to the latest version of Control-M/Agent on UNIX, which includes Application Integrator and Automation API CLI. If you want to upgrade multiple Agents on several computers using 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 Control-M/Agent deployment.

  • If you upgrade the Agent, Application Integrator that was part of Application Pack is upgraded as well. 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 upgrading the Agent.

The default upgrade 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 upgrade or perform an automatic upgrade.

Before You Begin

Ensure that you have met the following requirements:

  • Ensure that your operating system is compatible with the new version of Control-M/Agent, as described in Agent System Requirements for UNIX/Linux.

  • Verify that you have met Java requirements, as described in Control-M External Java Installation.

  • Verify that your locale is set to English before beginning the upgrade.

  • (AIX only) You must set the tcp_nodelayack to 1 as a root user, as follows:

    /usr/sbin/no -o tcp_nodelayack=1

Begin

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

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

  2. Copy the installation files from the temporary directory that you created in Obtaining Control-M Installation Files, 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 command:

    <source_path>/setup.sh

  5. Do one of the following:

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

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

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

        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 computers where you want to perform an automatic upgrade.

      6. To run the upgrade script, type 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 the Agent on Windows

This procedure describes how to upgrade from Control-M/Agent 9.0.00.300 and higher to the latest version of Agent on Windows. If you want to upgrade multiple instances of Control-M/Agent on several computers using 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 Control-M/Agent deployment.

  • If there are multiple Agents installed on the same machine, 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 upgraded as well. 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 upgrading the Agent.

Before You Begin

Begin

  1. Log in to the computer using a user ID that has Administrator permissions.

  2. Copy the installation files from the temporary directory that you created in Obtaining Control-M Installation Files, to the host where the existing Agent is installed.

  3. From a command prompt window, enter <source_path>\setup.exe.

  4. Do one of the following:

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

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

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

        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 computers with the same agent instance name. Otherwise, a separate <filename>.xml file must be created for each computer, or modified manually for each computer.

      5. Copy the automatic upgrade 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 upgrade script, as follows:

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

        The upgrade log can be found at the following location:

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

Upgrading the PostgreSQL Database Server

This procedure describes how to upgrade the PostgreSQL database server to the latest supported version.

  • If you upgrade Control-M/EM or Control-M/Server 9.0.19, 9.0.20, or 9.0.21 to version 9.0.21.200 or higher, the PostgreSQL database server version (10.4 or 11.5) remains the same. However, if you perform a new installation of Control-M 9.0.21.200 or higher, the PostgreSQL version is 15.3.

  • After you upgrade the dedicated PostgreSQL database server to PostgreSQL 15, you can no longer downgrade Control-M/EM or Control-M/Server to a version lower than version 9.0.21.200.

  • In a Control-M Full Installation, you only need to perform this procedure once, since the Control-M/EM and Control-M/Server share the same PostgreSQL database server.

  • In a High Availability environment, you must perform this procedure once on the primary node.

  • If you want to upgrade the Control-M Workload Archiving PostrgreSQL database, see Control-M Workload Archiving Installation.

Before You Begin

  • Verify that there is enough disk space to contain an additional PostgreSQL database server. You must make at least 25% more free disk space than is used by the <Control-M_Home>\pgsql directory. The upgrade fails when there is not enough space.

    If the current size of the pgsql directory is 1 GB, you must reserve at least 1.25 GB of free disk space for the upgrade.

  • Verify that Control-M/EM or Control-M/Server 9.0.21.200 or higher is installed.

  • Note that this upgrade requires some Control-M down time, which depends on the database size. In most scenarios, the upgrade completes in 10 minutes. A large-scale environment might take up to an hour to upgrade.

Begin

  1. Click Control-M/Server for UNIX and Microsoft Windows to navigate to the EPD, then search for and download one of the following installation packages:

    • Control-M Version 9.0.21.200 - PostgreSQL in place Upgrade for Microsoft Windows

    • Control-M Version 9.0.21.200 - PostgreSQL in place Upgrade for Linux

    • Control-M Version 9.0.21.200 - PostgreSQL in place Upgrade for IBM AIX

  2. Copy the package to one of the following locations:

    • Full Installation and Control-M/Server on UNIX: $HOME

    • Control-M/EM on UNIX: $HOME/ctm_em/

    • Full Installation on Windows: <Control-M/Server Home>

    • Control-M/Server on Windows: <Control-M/Server Home>

    • Control-M/EM on Windows: <Control-M/EM Home>

  3. Do one of the following:

    • UNIX: Run the following commands to open and uncompress the upgrade package:

      1. gunzip pg_server_upgrade.tar.gz

      2. tar -xvf pg_server_upgrade.tar

    • Windows: Extract the pg_server_upgrade.tar.gz.

  4. Shut down the Control-M/EM or Control-M/Server components and verify that the processes are down. On a full installation, shut down both components. On a High Availability installation, shut down the primary and secondary components.

  5. Verify that the PostgreSQL database server is up and online.

  6. Navigate to the pg_server_upgrade directory and run one of the following commands:

    • UNIX: ./PG_Upgrade.sh

    • Windows: PG_Upgrade.bat

  7. Follow the on-screen instructions until the upgrade is complete.

    If you want to roll back to the old PostgreSQL database server version, rename the pgsql.old.<timestamp> directory to pgsql. The database server reverts to the existing version before the upgrade. Any changes made to the new PostgreSQL database server are not applied to the downgraded PostgreSQL database server version.

Upgrading an External Oracle or MSSQL Database Server

This procedure describes how to upgrade an external Oracle or MSSQL database server after you have upgraded Control-M/EM or Control-M/Server.

Begin

  1. Verify that the database server version is supported, as described in Product Availability & Compatibility.

  2. Verify the database server requirements, as described in Database Server Requirements.

  3. Contact your DBA to upgrade your database server.

    • If the connection properties have changed in the new database server, update Control-M/EM or Control-M/Server configuration to point to the new location, as described in Reconfiguring the Database Server Connection Data.

    • (Oracle only) You can upgrade Control-M to version 9.0.21.300 using Oracle 12c as an external database server, but you must upgrade your external database server to a supported version before you start up Control-M components.

Upgrading Control-M in a Disaster Recovery Configuration

This procedure describes how to upgrade Control-M/EM and Control-M/Server in a Disaster Recovery configuration on UNIX and Windows. In a disaster recovery environment, the database in the recovery site is set to read-only, which enables replication from the primary site. This procedure allows you to upgrade without changing the read-only status of the database and without interrupting the database replication.

The database in the disaster recovery environment must have read access.

Begin

  1. Set the inst_skip_db_changes environment variable to Y where the upgrade is executed.

  2. Do one of the following:

    To upgrade Control-M/EM, see Upgrading Control-M/EM on UNIX or Upgrading Control-M/EM on Windows.

    To upgrade Control-M/Server, see Upgrading Control-M/Server on UNIX or Upgrading Control-M/Server on Windows.

  3. Set the inst_skip_db_changes environment variable to N.