Connection Profiles

A connection profile contains plug-in authorization credentials, such as a username, password, host, and URL, and enables you to connect Control-M to the plug-in application server via the connection profile alone. You must create a connection profile before you can create a plug-in job, as described in Creating a Centralized Connection Profile.

You can manage the following connection profile types:

  • Local Connection Profile: Stored and managed on each Agent that is connected to a self-hosted or SaaS Control-M/Server. You can create, edit, and delete local connection profiles in Control-M Web. You can also copy local connection profiles from one Agent to another, as described in Migrating Local Connection Profiles.

  • Centralized Connection Profile: Stored in the Control-M/EM database and available to all Agents in your environment. These connection profiles facilitate authentication creation and management in the following ways:

    • If you install a new plug-in, you do not need to manually duplicate connection profiles on each Agent in your environment. Instead, create one centralized connection profile per plug-in, which all relevant Agents can access.

    • If you must update your plug-in username and password, you do not need to edit the local connection profile stored on each Agent. Instead, update your credentials in a centralized connection profile and the Control-M/Server updates the authentication credentials for all Agents.

    • If an Agent becomes unavailable, you do not need to recreate a connection profile on a new Agent. Instead, the Control-M/Server sends the connection profile details to the new Agent when the plug-in job executes.

Creating a Local Connection Profile

This procedure describes how to create a local connection profile, which is stored on each Agent.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Plug-ins.

    The Plug-ins pane appears.

  3. Select the relevant plug-in and right-click.

    A drop-down menu appears.

  4. Do the following:

    1. In the Connection Profile Name field, create a name for the connection profile.

    2. For each parameter field, type the required value, as described in the following plug-in connection profile parameters:

  5. Review the local connection profile details and click Test.

    If the test completes successfully, the local connection profile is validated.

    If the test fails, review and address the error message, and test again.

  6. Click Add.

Creating a Centralized Connection Profile

This procedure describes how to create a centralized connection profile, which is stored in the Control-M/EM database, and available to all Agents in your environment. Centralized connection profiles eliminate the need to duplicate connection profiles on each Agent.

Begin

  1. From the icon, select Configuration.

    The Configuration domain opens.

  2. From the drop-down list, select Centralized Connection Profiles.

    The Centralized Connection Profiles page appears.

  3. From the Add Connection Profile drop-down list, select the required plug-in.

    The Add Connection Profile pane appears.

    The drop-down list shows only plug-ins that you have installed.

  4. Do the following:

    1. In the Connection Profile Name field, create a name for the connection profile.

    2. In the Description field, describe the purpose of the connection profile.

    3. For each parameter field, type the required values. For more information, see Centralized Connection Profile Parameters.

  5. Review the connection profile details, click Test, select an Agent where the connection profile is tested, and then click Test.

    If the test completes successfully, the connection profile is validated and you can now define a plug-in job.

    If the test fails, review and address the error message, and test again.

  6. Click Add.

    The centralized connection profile is created successfully.

Centralized Connection Profile Parameters

The following table lists the available plug-in types and links to plug-in-specific topics that detail their centralized connection profile parameters.

Plug-in Type

Plug-in Parameters

Application Workflows

Business Intelligence and Analytics

Backup and Recovery

CI/CD

Cloud Computing

Container Orchestration

Data Processing and Analytics
Data Integration

Database Management

Databases Connection Profile Parameters

Enterprise Resource Planning (ERP)

File Transfer

MFT Connection Profile Parameters

Infrastructure as Code

Machine Learning

Mainframe Modernization

Messaging and Communication

Messaging and Queuing
Robotic Process Automation (RPA)

Web Services, Java, and Messaging

Migrating Local Connection Profiles

This procedure describes how to copy or migrate your local connection profiles (LCPs), as follows:

  • Copy: Copies LCPs from one Agent to another, which eliminates the need to manually redefine LCPs on the target Agent.

  • Migrate: Copies LCPs from one Agent and converts them to centralized connection profiles (CCPs) on Control-M Self-Hosted or Control-M SaaS.

You can copy or migrate Control-M for MFT, Application Integrator, Control-M Integrations, and Control-M for Databases LCPs.

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. Log in to the account where Control-M/Agent is installed.

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

  3. Navigate to the temporary folder where you unzipped the LCP Copy and Migration Tool, and run the following command to export your LCPs to a ZIP file:

    • UNIX: lcpMigrationTool -export [-pluginType <FileTransfer, AI, Database, or ALL>] [-agentDir <Agent_Directory_Pathname>]

    • Windows: lcpMigrationTool.cmd -export [-pluginType <FileTransfer, AI, Database, or ALL>] [-agentDir <Agent_Directory_Pathname>]

    For more information, see Connection Profile Migration Parameters.

    The directory path and filename of the exported LCPs appears.

  4. Copy the ZIP file to the Agent where you want to copy or migrate the LCPs (the target Agent).

  5. From the target Agent, do one of the following: 

    • Copy LCPs to Target Agent: Run the following command:

      • UNIX: lcpMigrationTool -import -path <ZIP_Pathname_and_Filename> -importAs LCP [-cpnp <OVERWRITE, SKIP, or ASK>] [-d <TRUE or FALSE>] [-agentDir <Agent_Directory_Pathname>]

      • Windows: lcpMigrationTool.cmd -import -path <ZIP_Pathname_and_Filename> -importAs LCP [-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 original Agent are copied to the target Agent.

    • Migrate LCPs to CCPs: Run the following command:

      • UNIX: lcpMigrationTool -import -path <ZIP_Pathname_and_Filename> -importAs CCP -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>]

      • Windows: lcpMigrationTool.cmd -import -path <ZIP_Pathname_and_Filename> -importAs CCP -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 original Agent are migrated to centralized connection profiles.

Connection Profile Migration Parameters

The following table describes the parameters that you must define when you copy or migrate your LCPs, as described in Migrating Local Connection Profiles.

Parameter

Description

-pluginType

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

  • FileTransfer: Exports the Control-M MFT LCPs.

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

  • Database: Exports the Control-M for Databases LCPs.

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

Default: ALL

-agentDir

(Optional and 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 instance directory.

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

-path

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

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

-importAs

Determines whether to import the local connection profiles as one of the following connection profile types:

  • LCP: Local connection profile.

  • CCP: Centralized connection profile.

-url

Defines the Control-M Automation API URL, which is the endpoint that enables you to interact with Control-M via REST calls and is written in the following format:

  • Control-M Self-Hosted: https://<Control-M_Hostname>:8443/automation-api

  • Control-M SaaS: https://<Control-M_SaaS_Hostname>/automation-api

  • Control-M Self-Hosted: https://abc-def-g1h2jk:8443/automation-api

  • Control-M SaaS: 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 plug-in connection profiles after they are migrated to centralized connection profiles.

  • TRUE: Deletes the ZIP file.

  • FALSE: Saves the ZIP file.

Default: FALSE