Creating a Centralized Connection Profile

This procedure describes how to create a centralized connection profile in the Configuration domain of Control-M. Centralized connection profiles are stored in the Control-M/EM database and are available to all of your Agents in your environment. It saves you time and resources and there is no need to define connection profiles for each Agent.

Begin

  1. From the Configuration domain, click and then select Centralized Connection Profiles.

    The Centralized Connection Profile tab appears.

  2. 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.

  3. 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 field, type the required values.

      For lists of required parameters, see Connection Profile Parameters.

  4. Review the connection profile details, click Test, select an Agent to test the connection profile, and then click Test.

    If the test completes successfully, the connection profile is validated and you can now define an application plug-in job. If the test fails, review the error message and test it again.

  5. Click Add.

    The centralized connection profile was created successfully.

Connection Profile Parameters

The following table lists the various plug-in types and provides links to further information about the parameters of each type of connection profile:

Plug-in Type

Available Plug-in Parameters

Application Workflows

Business Intelligence and Analytics

Backup as a Service

Azure Backup Connection Profile Parameters

Cloud Computing
Data Processing
Data Integration

Data Management

NetBackup Connection Profile Parameters

Database Management

Databases Connection Profile Parameters

Enterprise Resource Planning (ERP)

File Transfer

MFT Connection Profile Parameters

Machine Learning

Mainframe Modernization

Micro Focus Connection Profile Parameters

Messaging and Communication

Communication Suite Connection Profile Parameters

Robotic Process Automation (RPA)

Workflow Management

Airflow Connection Profile Parameters

Converting to a Centralized Connection Profile

This procedure describes how to convert multiple local connection profiles (LCP) in a single process to centralized connection profiles (CCP). This enables you to store all your connection profiles in a central database.

Before you Begin

  • Verify that you have installed Python 3.8.0 on the computer where you are running the script.

  • Verify that you have the Requests Python package installed on your computer by running pip install requests.

It is recommended to save a backup of your local connection profiles.

The local connection profiles file is located on the Agent computer under the cm/<plugin>/data directory. The file name is accounts.xml for MFT or accounts.dat for all other plug-ins.

Begin

  1. From the Control-M/EM host, navigate to one of the following locations:

    • UNIX: <EM_HOME>/etc/emweb/automation-api/downloads

    • Windows: <EM_HOME>\emweb\automation-api\downloads

    You can run the script from a remote computer, which must have network access to a Control-M/EM web server.

  2. Run the following script and follow the on-screen instructions:

    convert_lcps_to_ccps.py

    You might be prompted to provide one of the following authentication methods:

    • Control M/EM username and password

    • Control M/EM token

  3. For each parameter type the required value, as described in lcps_to_ccps.py Parameters .

  4. Press Y to continue.

    You can view the connection profiles report results in the following path:

    <CTM_Server_name>-<CTM_Agent_name>-<ApplType>-<Time>-ConvertedCPsReport.json

lcps_to_ccps.py Parameters

The following table describes the lcps_to_ccps.py parameters:

Parameter

Description

-h

Defines the help message and text.

-c CTM

Defines the name of the Control-M/Server.

-a AGENT

Defines the name of the alias or host of the Control-M/Agent.

-t PLUGIN_TYPE

Defines one or more of the following plug-in types:

  • AWS

  • Azure

  • Database

  • FileTransfer

  • Hadoop

  • Informatica

  • SAP

  • ApplicationIntegrator: <AppType>.

-f file

Defines the rules file in JSON format. (Optional)

By default, all connection profiles are converted. A connection profile conversion skips if a centralized connection profile with the same name already exists.

You can use the conversion rules file to specify the connection profile names/patterns or to enforce overwriting. The pattern accepts regular expressions.

You can use the following attribute to overwrite an existing centralized connection profile:

ifExists: Overwrite

{ "conversionRules": [

{ "pattern": ".*Prod", "ifExists": "Overwrite" },

{ "pattern": "A_.*" },

{ "pattern": "Pre.*Post", "ifExists": "Overwrite" }

]}

-d dryRun

Determines whether to simulate the flow without converting to a centralized connection profile.

-s silent

Determines whether to run the utility in silent mode. You are not prompted with a warning to back up the file.

 

If the -silent mode was set and you have not provided a credentials file, the following error message appears:

Missing credentials file.

-credfile

Defines the credentials file that contains the username and password or the Control-M/EM token in the following format:

  • User=<EM user>

  • Password=<EM password>

  • Token=<EM token>

    • Username=emuser

    • Password=empass

    • Token=jklasd876ASDKJAHSDJTASD=

  • The file is deleted after it is read by the utility.

  • If the -credfile is not provided, you must provide credentials.

-url

Defines the Control-M Automation API URL.

https://emSrverHost:8443/automation-api

If the certificate is not signed by a CA, a warning message appears. The script continues to run.