Control-M SaaS Migration

The Control-M SaaS migration copies the data from a self-hostedClosed An Control-M environment (Control-M Self-Hosted), or specific Control-M component that you install and manage on your own infrastructure. Control-M/EM to a SaaS Control-M/EM and enables you to migrate some or all of your self-hosted Control-M components to Control-M SaaS. This eliminates the need to maintain a self-hosted Control-M/EM, one or more self-hosted Control-M/Servers, and the databases for all migrated components. If you have Control-M for z/OS environments or Control-M/Servers that cannot be migrated, you can instead connect these components to Control-M SaaS Unified ViewClosed A mode of Control-M SaaS that enables you to connect self-hosted Control-M/Servers and Control-M for z/OS environments to a SaaS Control-M/EM and run jobs that are connected to these self-hosted components from Control-M SaaS..

Before you migrate your data, BMC Services or a BMC certified partner will help you scan your Control-M Self-Hosted components and create a migration plan that best suits your organization.

  • If you are unable to upgrade your self-hosted Control-M/EM to version 9.0.21.200, as described in Control-M/EM Upgrade, contact a BMC pre-sales representative.

  • You cannot migrate the following self-hosted components to Control-M SaaS, but you can connect them to Control-M SaaS Unified View.

  • You cannot revert a Control-M SaaS migration.

The following diagram shows the logical architecture of a typical migration:

Migrating to Control-M SaaS

This procedure describes how to migrate the data from a self-hosted Control-M/EM to a SaaS Control-M/EM, and migrate or connect your self-hosted Control-M/Servers to Control-M SaaS, based on your organizational needs and the results of a preliminary qualification scan.

Before You Begin

Begin

  1. Register for Control-M SaaS, as described in Registering for Control-M SaaS.

    This enables BMC to provide you with a SaaS Control-M/EM and SaaS Control-M/Servers that match the names of your current self-hosted Control-M/Servers.

  2. From your new Control-M SaaS tenant, redefine your IdP settings, as described in Configuring System Settings.

  3. (Optional) Do one or more of the following to redefine each of your self-hosted Agents for Control-M SaaS:

  4. Migrate your self-hosted Control-M/EM data to Control-M SaaS, as described in Migrating a Self-Hosted Control-M/EM to Control-M SaaS.

  5. For each Control-M/Server or Control-M for z/OS in your current self-hosted environment, do one of the following:

  6. Resume all connected self-hosted components, as described in Resuming All Connected Self-Hosted Components.

  7. Get started with Control-M SaaS, as described in Getting Started.

Scanning Control-M Self-Hosted

This procedure describes how to scan your Control-M Self-Hosted components with BMC Services or a BMC certified partner. The scan produces qualification reports that enable you to determine the following:

  • The migration plan that best suits your organization.

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

You can run this tool from your Windows- or Linux-based self-hosted Control-M/EM host.

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

  • Control-M for z/OS environments.

  • Control-M/Servers that are connected to the following types of Agents:

    • Agents that are installed on operating systems which are not supported in Control-M SaaS.

    • Agents that run plug-ins which are not supported in Control-M SaaS.

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.

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

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

Begin

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

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

  3. From a command line, navigate to the temporary directory where you unzipped the Control-M SaaS Qualification Tool, and run the following command:

    • Linux: SaasQualificationTool.sh -u <Control-M/Automation_API_Username> -p <Control-M/Automation_API_Password>

    • Windows: SaasQualificationTool.bat -u <Control-M/Automation_API_Username> -p <Control-M/Automation_API_Password>

    The qualification tool scans your Control-M/EM and all connected Control-M/Servers, creates one Control-M/EM qualification report, and creates two Control-M/Server reports for every connected Control-M/Server. All of these reports are saved to the <Temporary_Installation_Directory>/report directory, as follows:

    • EM_SaaS_Qualification.xlsx: Contains the Control-M/EM qualification scan results, which describes the actions that you must take before you can migrate to Control-M SaaS.

    • Server_Qualification_<Control-M/Server_Name>.xlsx: Contains the Self-Hosted-to-SaaS Control-M/Server qualification scan results, which describes the actions that you must take before you can migrate this Control-M/Server to a SaaS Control-M/Server.

    • Server_Qualification_Self_Hosted_<Control-M/Server_Name.xlsx>: Contains the self-hosted Control-M/Server qualification scan results, which describes the actions that you must take before you can connect this self-hosted Control-M/Server to Control-M SaaS Unified View.

  4. Send the compressed ControlMSaasQualificationResults_<Timestamp> file, which contains the results of the qualification scan, to BMC Services or a BMC certified partner.

  5. Navigate to the report directory, review the qualification reports, and do the following:

    1. Based on the qualification report results, determine which self-hosted Control-M/Servers will fully migrate and which will connect to Control-M SaaS Unified View.

    2. Follow the directions in the relevant qualification reports.

    3. Migrate to Control-M SaaS, as described in Migrating to Control-M SaaS.

Registering for Control-M SaaS

This procedure describes how to register for Control-M SaaS, which enables BMC to provide you a with a SaaS Control-M/EM and SaaS Control-M/Servers that match the names of your current self-hosted Control-M/Servers. You only need to perform this procedure once.

Before You Begin

Begin

  1. From the temporary folder where you unzipped the Control-M SaaS Qualification Tool, open the following file:

    • Linux: <Temporary_Folder>/output/migration_metadata.xlsx

    • Windows: <Temporary_Folder>\output\migration_metadata.xlsx

  2. Open the migration_metadata.xlsx file and, from the Control-M/Server column, delete all Control-M/Servers that must remain self-hosted and will not migrate to SaaS Control-M/Servers.

    Do not change the self-hosted Control-M/Server names that remain in the Control-M/Server column. If you do, they will fail to migrate. After migration, these new SaaS Control-M/Servers retain their original self-hosted names.

  3. Save the migration_metadata.xlsx file and upload it in the online Control-M SaaS Production: Migration Metadata file (Migration Only!) section of the SaaS Subscription Registration form.

  4. Complete and submit the SaaS Subscription Registration form.

    A confirmation email with a link to your new Control-M SaaS tenant will arrive when it is ready. If you do not receive this email, you must contact your customer service representative.

Migrating a Self-Hosted Control-M/EM to Control-M SaaS

This procedure describes how to migrate a self-hosted Control-M/EM to Control-M SaaS. This migration exports your self-hosted Control-M/EM data to an export file, uploads it to an Amazon S3 bucket, transfers and extracts it, and then imports the Control-M/EM data into your new Control-M SaaS tenant.

If your Control-M/EM is not connected to the internet, you can transfer the export file to any internet-accessible Windows or Linux host and then continue the migration.

Before You Begin

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

Begin

  1. Log in to Control-M SaaS with a username that is associated with an Admin role, and then generate and record the value of an API token, as described in Creating an API Token.

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

  3. From the command line, navigate to the export/EM directory in the unzipped migration tool folder, and then run the following command to export your self-hosted Control-M/EM data to a compressed archive export (*.tar.gz) file:

    • Linux: run_saas_migration_export.sh

    • Windows: run_saas_migration_export.bat

    The export tool runs, produces a compressed archive export file (EMExportForSaaS.tar.gz) that contains your self-hosted Control-M/EM data, and saves it to the temporary folder.

  4. From an internet-accessible host (either your self-hosted Control-M/EM, or a separate Windows or Linux host) do the following:

    1. Verify that Python 3.8 or higher and a pip or pip3 Python package-management system is installed.

    2. From the import/EM directory in the unzipped migration tool folder, run one of the following commands:

      • Pip: pip install -r requirements.txt

      • Pip3: pip3 install -r requirements.txt

    3. If you use a proxy server, define the following environment system variable:

      • Name: https_proxy

      • Value: http://<Proxy_Server_Address>:<Proxy_Server_Port>

    4. Verify that you have outgoing internet access to the following locations:

      • *.controlm.com:443

      • *.amazonaws.com:443

    5. Navigate to the import/EM directory in the temporary folder.

      From the import/EM directory in the unzipped migration tool folder, do one of the following to import your self-hosted Control-M/EM data to Control-M SaaS:

      • Control-M/EM Host: From your internet-accessible Control-M/EM host, run the following command:

        • Linux: em ./run_saas_migration_import.sh

        • Windows: em ./run_saas_migration_import.bat

      • Separate Host: From your separate internet-accessible host, run the following command:

        • Linux: ./run_saas_migration_import.sh

        • Windows: ./run_saas_migration_import.bat

  5. At the prompts, type the requested information, as described in Import Parameters.

    The import tool runs and a number of status messages appear that describe the import process.

Import Parameters

The following table describes the parameters that you must provide at the import tool prompts in Migrating a Self-Hosted Control-M/EM to Control-M SaaS.

Parameter

Description

SaaS Control-M Automation API Endpoint

Defines the SaaS Control-M Automation API endpoint, in the following format:

<Tenant_Name>-aapi.<Zone>.controlm.com

Control-M Automation API Token

Defines the API token that you created in Migrating a Self-Hosted Control-M/EM to Control-M SaaS.

Compressed Archive Export File Pathname

Defines the pathnameClosed The fully specified name of a computer file, including the position of the file in the file system directory structure. of the compressed archive export file that you created in Migrating a Self-Hosted Control-M/EM to Control-M SaaS.

UNIX: <Temporary_Folder>ControlMSaaSEmDataMigrationTool\export\EMExportForSaaS.tar.gz

Windows: <Temporary_Folder>ControlMSaaSEmDataMigrationTool/export/EMExportForSaaS.tar.gz

Python Interpreter Name or Pathname

Defines the name or pathname of the Python interpreter that converts source code into machine language, as follows:

  • Control-M/EM Host: bmcpython

  • Separate Host

    • Name: <Python_Interpreter_Name>

      Press ENTER to utilize the default Python interpreter (python3).

    • Pathname: <Python_Interpreter_Pathname>

      • UNIX: /user/bin/python

      • Windows: C:\Users\dbauser\AppData\Local\Programs\Python312\python.exe

Migrating a Self-Hosted Control-M/Server to a SaaS Control-M/Server

This procedure describes how to migrate a self-hosted Control-M/Server to a SaaS Control-M/Server. You must perform this procedure for every self-hosted Control-M/Server that must be migrated. You can run this tool from any Windows or Linux host.

Before You Begin

  • Verify that the most recent version of Control-M Automation API is installed on Control-M/EM server. For more information, see Setting Up the API.

  • Verify that you have access to the Control-M/EM database.
  • If you made changes to the self-hosted Control-M/Server after the qualification scan, then you must run the scan again, as described in Scanning Control-M Self-Hosted.

Begin

  1. Download the Control-M SaaS Server Data Migration tool from Control-M SaaS Scanning and Migration Tools, and unzip it to a temporary folder.

  2. From the inputParameters folder inside the temporary folder, open the parameters.txt file and define the relevant parameters, as described in Control-M/Server Migration Tool Parameters.

  3. (Optional) Migrate your variable lists to pool variables, as described in Creating a LIBMEMSYM Control File.

  4. From the command line, navigate to the temporary folder and run the following commands:

    • UNIX

      • migrateToSaaS.sh extract

      • migrateToSaaS.sh deployCtmServer

    • Windows

      • migrateToSaaS.bat extract

      • migrateToSaaS.bat deployCtmServer

    The tool migrates your self-hosted Control-M/Server to a SaaS Control-M/Server and produces a Deploy_Server_Report-<Server_Name>.xslx Excel file in the report folder.

  5. (Optional) Migrate Control-M MFT, Application Integrator, and Control-M Integration local connection profiles (LCPs) to SaaS-supported centralized connection profiles (CCPs), as described in Migrating Local to Centralized Connection Profiles.

  6. From the report folder, open, review, and follow the directions in the Deploy_Server_Report-<Server_Name>.xslx file. You might be asked to do one or more of the following in Control-M SaaS:

    • Ask the BMC Pre-sales team to help you migrate your Control-M for MFT Enterprise sites to Control-M SaaS.

    • Redefine the unsupported notification destinations that are listed in the Deploy_Server_Report-<Server_Name>.xslx file, as described in Notification Destinations.

    • Redefine folders that exceed 20,000 job runs at New Day, as described in the Run Method folder attribute in Folder General Attributes.

    • Redefine all Control-M Automation API tokens wherever they are used, such as OS job scripts, and change all connection profile credentials to API tokens, as described in Creating an API Token.

    • Redefine passwords in all Run as Users.

    • Run test jobs on all connected SaaS Agents to validate plug-in job Run as Users and connection profiles to confirm that the new Control-M SaaS environment is ready for production.

    • Verify that the Run Method name on all folders is correct.

      The _ (underscore) prefix was appended to the Run Method name on all folders to prevent Control-M SaaS from automatically

      ordering these folders.

Control-M/Server Migration Tool Parameters

The following table describes the parameters that you must define in the parameters.txt file in the inputParameters folder when Migrating a Self-Hosted Control-M/Server to a SaaS Control-M/Server.

Parameter

Definition

Control-M Automation API Endpoint

--control-m-automation-api-endpoint "https://<Automation-API-endpoint>:8443/automation-api"

Control-M/Server Name

--control-m-server-name "<Control-M/Server-Name>"

Defines the name of the Control-M/Server, as it appears in the CCM and in the Configuration domain in Control-M/EM 9.0.21.300 and higher.

Control-M Automation API Username

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

Control-M Automation API 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 (PostgreSQL, MSSQL) or service (Oracle) name.

Control File with LIBMEMSYM Details

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

(Optional) Defines the filename that you create in Control-M SaaS Migration, which enables you to create pool variables with names and values that correspond to each variable in the %%LIBMEMSYM list variable.

Control-M SaaS does not recognize %%LIBMEMSYM variable lists. To migrate your 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.

Time Zone Mapping File Pathname

--time-zone-mapping-file "<Time_Zone_Mapping_File_Pathname>"

(Optional) Defines the pathname of the time zone mapping file that you must modify after you scan your Control-M Self-Hosted environment, as described in the Server_Qualification_<Control-M/Server_Name>.xlsx report.

--time-zone-mapping-file "inputParameters/TimeZoneMapping.txt"

Output Folder Path

--output-folder-path "output"

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

Control-M SaaS Automation API Endpoint

--control-m-saas-automation-api-endpoint "<Endpoint>/automation-api"

Control-M SaaS Automation API Token

--control-m-saas-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.

Skip Missing Agents

--skip-if-missing-agents

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

Control-M SaaS Proxy Hostname

--control-m-saas-https-proxy-hostname "proxy.bmc.com"

(Optional) Enables you to pass all HTTPS requests to Control-M/SaaS via the HTTP proxy hostname that you define.

Control-M SaaS Proxy Port

--control-m-saas-https-proxy-port "8080"

(Optional) Enables you to pass all HTTPS requests to Control-M/SaaS via the HTTP proxy port that you define.

Creating a LIBMEMSYM Control File

This procedure describes how to create a LIBMEMSYM control file, which the Control-M SaaS Server Data Migration tool uses to replace your self-hosted %%LIBMEMSYM variable lists with SaaS pool variables. For more information, see List Variables.

Begin

  1. Find all unique LIBMEMSYM files that each %%LIBMEMSYM variable points to, and copy these files from the self-hosted Control-M/Server to a location that is accessible to the Control-M SaaS Server Data Migration tool.

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

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

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

    • Pool name that each variable in the %%LIBMEMSYM list variable 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

  3. Save the LIBMEMSYM_Control_File.csv file.

  4. From the inputParameters folder, open the parameters.txt file, locate --libmemsym-control-file, and then type a space and the LIBMEMSYM control file pathname, enclosed in " (quotation marks), as described in Control-M/Server Migration Tool Parameters.

    UNIX: --libmemsym-control-file "/home/ABC_User/Temp/"
    Windows: --libmemsym-control-file "C:\Temp\LIBMEMSYM_Control_File.csv"

Migrating Local to Centralized Connection Profiles

This procedure describes how to migrate the following local connection profiles (LCPs) to centralized connection profiles (CCPs) in Control-M SaaS:

  • Control-M for MFT

  • Application Integrator

  • Control-M Integrations

You must perform this procedure on every Agent required for migration that contains these LCP types.

This procedure only enables you to migrate LCPs to CCPs.

Before You Begin

  • Self-Hosted Agents: Verify that Control-M/Agent 9.0.21 or higher is installed.

  • SaaS Agents: Verify that Control-M/Agent 9.0.21.200 or higher is installed.

Begin

  1. Download the Helix Control-M LCP-to-CCP Migration Tool, based on your operating system, from Control-M SaaS Scanning and Migration Tools, and unzip it to a temporary folder.

  2. From the Agent, navigate to the temporary folder where you unzipped the LCP-to-CCP migration tool, and run the following command to export your local connection profiles:

    lcpToCcp -export [-pluginType <MFT, AI, or ALL>] [-agentDir <Windows_Agent_Directory_Pathname>]

    For more information, see Connection Profile Migration Parameters.

    The directory path and filename of the zipped exported LCP files appears.

  3. Copy the ZIP file to the SaaS Agent.

  4. From the SaaS Agent, run the following command to migrate the zipped LCPs to CCPs:

    lcpToCcp -import -path <ZIP_Pathname_and_Filename> -url <Automation_API_URL> -token <API_Token> -ctm <Control-M/Server> -agent <Agent> [-cpnp <OVERWRITE, SKIP, or ASK>] [-d <TRUE or FALSE>] [-agentdir <Agent_Directory_Pathname>]

    For more information, see Connection Profile Migration Parameters.

    The LCPs on the self-hosted Agent are migrated to CCPs in Control-M SaaS.

Connection Profile Migration Parameters

The following table describes the parameters that you must define when you migrate your LCPs to CCPs in Control-M SaaS.

Parameter

Description

-pluginType

(Optional) Determines which plug-in local connection profiles (LCPs) are exported, as follows:

  • MFT: Exports the Control-M MFT LCPs.

  • AI: Exports the Application Integrator and Control-M Integration LCPs.

  • ALL: Exports the Control-M MFT, Application Integrator, and Control-M Integration LCPs.

Default: ALL

-agentDir

(Windows only) Defines the Agent directory pathname where the connection profiles are stored.

You must use this parameter if you have multiple Agents on the same host.

Default: Defaults to the local Agent directory.

"C:\Program Files\BMC Software\SaaS Agent\ABC-TLV-WEG30I_1"

-path

Defines the ZIP file pathname on the SaaS Agent that contains the exported local connection profiles.

/home/myuser/pluginExportedData_dba-tlv-w5r6p9_20230716_121315.zip

-url

Defines the Control-M Automation API URL.

https://myemserver-aapi.us1.ci.ctmsaas.com/automation-api/

-token

Defines the Control-M Automation API token, as described in Creating an API Token.

-ctm

Defines the Control-M/Server name, such as AA01.

-agent

Defines the Agent name or alias, such as Agent1.

-cpnp

(Optional) Determines one of the following actions to take when a centralized connection profile with the same name is found:

  • SKIP: Leaves the current centralized connection profile as is.

  • OVERWRITE: Overwrites the current centralized connection profile with the migrated local connection profile definitions.

-d

(Optional) Determines whether to save or delete the ZIP file that contains the Control-M MFT local connection profiles and Application-Integrator-created plug-in connection profiles after they are migrated to centralized connection profiles in Control-M SaaS.

  • TRUE: Deletes the ZIP file.

  • FALSE: Saves the ZIP file.

Default: FALSE

Connecting a Self-Hosted Control-M/Server to Control-M SaaS Unified View

This procedure describes how to disconnect a self-hosted Control-M/Server from your self-hosted Control-M/EM and connect it to Control-M SaaS Unified View via the ctm_menu utility.

  • You cannot connect Control-M/Servers with Agents that are installed on unsupported platforms or that run unsupported plug-ins. For more information, see Self-Hosted Agent Compatibility and SaaS Agent Compatibility.

  • If your Control-M/Servers execute more than 100,000 jobs daily, you must distribute these jobs on two or more Control-M/Servers.

Before You Begin

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

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

  • Generate a server token in Control-M SaaS, as described in Generating a Server Token.

Begin

  1. Pause the self-hosted Control-M/Server, as described in Pausing a Self-Hosted Control-M/Server or config server::pause.

  2. Do the following:

    1. Disable the Control-M/Server from the CCM or from Control-M/EM 9.0.21.300 or higher, as described in Disabling a Self-Hosted Control-M/Server.

    2. Verify that the Actual State of the Control-M/Server is Disabled.

  3. Unmanage the Control-M/Server from the CCM, via the config server::unmanaged Control-M Automation API command, or from Control-M/EM 9.0.21.300 or higher, as described in Unmanaging a Control-M/Server.

  4. Set the desired state of the Control-M/EM Gateway to Down from the CCM, via the ccmcli utility, or from the Configuration domain in Control-M/EM 9.0.21.300 and higher.

  5. From the Control-M/Server host, do the following:

    1. Run the following command:

      ctm_menu

      The Control-M Main Menu appears.

    2. Press 1.

    3. Type 9 or 12, depending on your database type, to select Register Control-M/Server in Helix Control-M/EM, and then follow the prompts.

      The registration utility runs and connects the Control-M/Server to Control-M SaaS.

  6. From the Control-M/Servers pane in Control-M SaaS, verify that the self-hosted Control-M/Server status changes from Ready to Connect to OK.

    The self-hosted Control-M/Server is now disconnected from the Control-M/EM and is connected to Control-M SaaS.

Connecting a Self-Hosted Control-M for z/OS to Control-M SaaS Unified View

This procedure describes how to disconnect a self-hosted Control-M for z/OS from your Control-M/EM and connect it to Control-M SaaS Unified View via the ICE utility.

If your Control-M for z/OS environments execute more than 100,000 jobs daily, you must distribute these jobs on two or more Control-M for z/OS environments.

Before You Begin

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

  • Verify that Control-M for z/OS 9.0.21.300 or higher is installed.

  • Verify that the Control-M API Gateway is installed, as described in Step 12 – Install Control-M API Gateway in the INCONTROL documentation.

  • Generate a server token in Control-M SaaS, as described in Generating a Server Token.

Begin

  1. Pause the Control-M for z/OS, as described in Pausing a Self-Hosted Control-M/Server or config server::pause.

  2. Disable the Control-M for z/OS, as described in Disabling a Self-Hosted Control-M/Server, and verify that the Actual State is Disabled.

  3. Unmanage the Control-M for z/OS from the CCM, via the config server::unmanaged Control-M Automation API command, or from Control-M/EM 9.0.21.300 or higher, as described in Unmanaging a Control-M/Server.

  4. Set the desired state of the Control-M/EM Gateway to Down from the CCM, via the ccmcli utility, or from Control-M/EM 9.0.21.300 or higher, as described in Shutting Down a Control-M/EM Component.

  5. From your Control-M for z/OS, load ICE, as described in Installing INCONTROL Products with ICE.

  6. Select Installation.

    The IOA Installation menu appears.

  7. Select Customized Installation.

    The IOA Customized Installation menu appears.

  8. From the IOA Customized Installation menu, at the Option ===> prompt, type 2, at the Product ID ===> prompt, type CTM, and then press ENTER.

    The Major Steps Selection menu appears.

  9. Select 13 - Register Control-M for z/OS to Helix CTM.

    The Minor Steps Selection menu appears for major step 13 - Register Control-M for z/OS to Helix CTM.

  10. Follow steps 1–8 in the Minor Steps Selection menu, as described in Step 13 - Register Control-M for z/OS to Helix CTM.

    The self-hosted Control-M for z/OS is now connected to Control-M SaaS.

Generating a Server Token

This procedure describes how to generate a Server token, which enables you to connect a self-hosted Control-M/Server or Control-M for z/OS to Control-M SaaS Unified View.

Begin

  1. Log in to Control-M SaaS with a user ID that is associated with an Admin role.

  2. From the icon, select Configuration.

    The Configuration domain opens.

  3. From the drop-down list, select Control-M/Servers.

    The Control-M/Servers page appears.

  4. Toggle on Self-Hosted and verify that your self-hosted Control-M/Servers or Control-M for z/OS environments appear in the Self-Hosted area of the Control-M/Servers pane.

    In the Status column, a Ready to Connect button appears next to the recently added Control-M/Server or Control-M for z/OS.

  5. Select the required self-hosted Control-M/Server or self-hosted Control-M for z/OS, and then do the following:

    1. Click Ready to Connect.

      A Control-M/Server Token dialog box appears.

    2. Click Get Control-M/Server Token.

      A dialog box appears with the token value and enables you to copy it to your clipboard.

    3. Record the token, which you must provide when you are prompted by the registration utility, as described in Connecting a Self-Hosted Control-M/Server to Control-M SaaS Unified View and Connecting a Self-Hosted Control-M for z/OS to Control-M SaaS Unified View.

Resuming All Connected Self-Hosted Components

This procedure describes how to resume all self-hosted Control-M/Servers and Control-M for z/OS environments that are now connected to Control-M SaaS Unified View. This enables you to run jobs on Agents that are connected to these self-hosed components from Control-M SaaS.

Before You Begin

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Control-M/Servers.

    The Control-M/Servers page appears.

  3. Do one of the following:

    • From the Control-M/Servers Pane: Toggle on Self-Hosted and select the required self-hosted Control-M/Server or Control-M for z/OS, and then click Resume.

    • From a Command Prompt: Run config server::resume.

  4. Verify that the Control-M/Server or Control-M for z/OS Actual State changes from Paused & Up to Up.

  5. Repeat this procedure to resume the remaining connected, self-hosted Control-M/Servers or Control-M for z/OS environments.

    You can now access and manage your resumed, self-hosted Control-M/Servers or Control-M for z/OS environments from Control-M SaaS Unified View.