Scanning a Self-Hosted Environment

This procedure describes how to scan your self-hosted Control-M environment with the BMC presales team. These scans produce qualification reports that enable you to determine the following:

  • The migration type that best suits your organization, as described in Helix Control-M Migration.

  • The steps that you must take before you can migrate to Helix Control-M.

Begin

  1. Scan Control-M/EM to determine if you can migrate to Helix Control-M, and estimate the work effort required, as described in Scanning Control-M/EM.

  2. Scan each of your self-hosted Control-M/Servers to determine which Control-M/Servers can migrate to Helix Control-M and which must remain self-hosted but connected to Helix Control-M Unified ViewClosed A mode of Helix Control-M that enables you to manage self-hosted and Helix Control-M/Servers., as described in Scanning a Self-Hosted Control-M/Server.

    This scan includes an option to rescan your Control-M/EM, if required.

  • You cannot migrate the following components to Helix Control-M, but you can connect them to Helix Control-M Unified View: 

    • Control-M for z/OS environments.

    • Control-M/Servers that are connected to Agents that run unsupported plug-ins, or that are installed on unsupported operating systems.

  • You cannot connect a self-hosted Control-M/Server that is installed on Windows to Helix Control-M Unified View.

Scanning Control-M/EM

This procedure describes how to scan Control-M/EM to determine what steps you must take before you can migrate to Helix Control-M. You can run this tool from your Windows- or Linux-based Control-M/EM host.

Before You Begin

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

  • Verify that you have access to the Control-M/EM host.

Begin

  1. Log in to the account where Control-M/EM is installed with a username that is associated with an Admin role.

  2. Download the Helix Control-M/EM Data Qualification Tool from Helix Control-M/EM Scanning and Migration Tools, and unzip it to a temporary folder.

  3. From the command line, navigate to the temporary folder where you unzipped the Helix Control-M/EM Data Qualification Tool, and run the following command to scan your environment:

    • Linux: HelixEMQualificationTool.sh

    • Windows: HelixEMQualificationTool.bat

    The tool scans your environment and produces an Excel-based EM_Qualifiation_Report.xlsx file, which includes one or more of the following results in the Qualification Summary sheet:

    • Passed

    • Manual action is required.

    • An incompatibility was found.

    • Not qualified.

  4. From the Control-M/EM home directory, open, review, and follow the directions in the EM_Qualifiation_Report.xlsx file.

    Depending on the results of this preliminary Control-M/EM qualification scan, you might have to run this tool more than once.

  5. Scan each of your self-hosted Control-M/Servers.

Scanning a Self-Hosted Control-M/Server

This procedure describes how to scan a self-hosted Control-M/Server or Control-M for z/OS to determine whether to migrate or connect it as a self-hosted component to Helix Control-M, and discover what you must do beforehand. If required, you can also rescan your Control-M/EM.

You must perform this procedure for every self-hosted Control-M/Server or Control-M for z/OS in your environment.

You can run this tool from any Windows or Linux host.

Before You Begin

  • Verify that Control-M Automation API 9.0.20.245 or higher is installed on the Control-M/EM server.

  • Verify that you have access to the Control-M/EM database.

BMC recommends that you use the latest version of Control-M Automation API. For more information, see Setting Up the API.

Begin

  1. Download the Helix Control-M/Server Data Migration tool for Windows or Linux from Helix Control-M/EM Scanning and Migration Tools, and unzip it to a temporary folder.

  2. (Optional) To migrate %%LIBMEMSYM variable lists, create a %%LIBMEMSYM control file, as described in Creating a LIBMEMSYM Control File.

  3. From the inputParameters folder that is inside the temporary folder, open the parameters.txt file and define the migration tool parameters, as described in Migration Tool Parameters.

  4. From the command line, navigate to the temporary folder and do one of the following:
    • Scan a Self-Hosted Control-M/Server: Do the following:

      1. Run the following command:

        migrateToHelix.bat q-CtmServerOnly

        Scan and export time depends on your environment size.

        The scan runs and produces an Excel-based Server_Qualification_Report-<Server_Name>.xlsx file in the report folder, which includes one or more of the following results in the Qualification Summary sheet:

        • Passed

        • An automatic adjustment was made.

        • Manual action is required.

        • An incompatibility was found.

      2. From the report folder, open, review, and follow the directions in the Server_Qualification_Report-<Server_Name>.xlsx file.

    • Scan Control-M/EM and a Self-Hosted Control-M/Server: Do the following:

      1. Run the following command:

        migrateToHelix.bat qualification

        Scan and export time depends on your environment size.

        The scan runs and produces an Excel-based Qualification_Report.xlsx file in the report folder, which includes one or more of the following results in the Qualification Summary sheet:

        • Passed

        • An automatic adjustment was made.

        • Manual action is required.

        • An incompatibility was found.

      2. From the report folder, open, review, and follow the directions in the Qualification_Report.xlsx file.

Creating a LIBMEMSYM Control File

This procedure describes how to create a LIBMEMSYM control file, which enables you to migrate your %%LIBMEMSYM variable lists to Pool variables. For more information, see Variable Lists.

Begin

  1. Find and record all unique LIBMEMSYM files that each %%LIBMEMSYM variable points to.

  2. Copy all of the LIBMEMSYM files that you found from Control-M/Server to a temporary folder on your host.

  3. Open a text editor and for each unique %%LIBMEMSYM variable list, type each of the following entries—separated by , (commas)—on a new line:

    • Pathname of the copied LIBMEMSYM file that is located on your host, which you copied from the Control-M/Server.

    • Pathname of the LIBMEMSYM file on the Control-M/Server.

    • Pool Name that each variable in the %%LIBMEMSYM variable list is migrated into.

      c:\temp\libMem1.txt,C:\Program Files\BMC Software\Control-M Server\ctm_server\libMem1,PoolName1

      c:\temp\libMem2.txt,C:\Program Files\BMC Software\Control-M Server\ctm_server\libMem2,PoolName2

      c:\temp\libMem3.txt,C:\Program Files\BMC Software\Control-M Server\ctm_server\libMem3,PoolName3

  4. Save the LIBMEMSYM_Control_File.csv file, record the pathname, and type the pathname after the = (equals sign) in the %%LIBMEMSYM Variable List Parameter, as described in Migration Tool Parameters.

Migration Tool Parameters

The following table describes the parameters that you must define when Scanning a Self-Hosted Control-M/Server, Migrating to Helix Control-M, and Migrating a Self-Hosted Control-M/Server to a Helix Control-M/Server.

Parameter

Definition

Control-M Automation API Endpoint

--control-m-automation-api-endpoint=<endpoint>:8443/automation-api

Control-M/Server Name

--control-m-server-name=<Server-Name>

Control-M/EM Administrator Username

--control-m-enterprise-manager-username=<EM_Username>

Control-M/EM Administrator Password

--control-m-enterprise-manager-password=<EM_Password>

To enter the password when prompted by the migration tool, delete =<EM_Password>.

Control-M/EM Database Username

--control-m-enterprise-manager-database-username=<Database_Username>

Control-M/EM Database Password

--control-m-enterprise-manager-database-password=<Database_Password>

To enter the password when prompted by the migration tool, delete =<Database_Password>.

Control-M/EM Database Type

--control-m-enterprise-manager-database-type=<Database_Type>

Type MSSQL, PostgreSQL, or Oracle.

Control-M/EM Database Host Name

--control-m-enterprise-manager-database-hostname=<Database_Host_Name>

Control-M/EM Database Port Number

--control-m-enterprise-manager-database-port=<Port_Number>

Control-M/EM Database Name

--control-m-enterprise-manager-database-name=<EM_Database_Name>

Type your database or service name.

%%LIBMEMSYM Variable List

--libmemsym-control-file=<LIBMEMSYM_Control_File.csv_Pathname>

(Optional) Creates Pool variables with names and values that correspond to each variable in the %%LIBMEMSYM variable list. For more information, see Variable Lists.

Helix does not recognize %%LIBMEMSYM variable lists. You must find all your %%LIBIMEMSYM variable lists, copy them to your local host, and create a control file to migrate your %%LIBIMEMSYM variable lists to Pool variables, as described in Creating a LIBMEMSYM Control File.

Control-M Helix Automation API Endpoint

--control-m-helix-automation-api-endpoint=<Endpoint>/automation-api

Control-M Helix Automation API Token

--control-m-helix-api-token=<Token_ID>

To enter the API token when prompted by the migration tool, delete =<Token_ID>.

For more information, see Creating an API Token.

Output Folder Path

--output-folder-path=output

(Optional) To change the default output folder, replace output with a new directory path.

Skip Missing Agents

--skip-if-missing-agents

(Optional) Does not migrate job and folder definitions when the required Helix Agents are not installed.

Helix Control-M/Server Name

--control-m-helix-server-name=<Control-M/Server_Name>

(Optional) Defines the name of the Helix Control-M/Server that the current Control-M/Server migrates to.