CI/CD Connection Profiles

The following topics describe connection profiles for continuous integration and continuous deployment (CI/CD) services.

ConnectionProfile:Ansible AWX

For more information about this plug-in see see Control-M for Ansible AWX.

The following example shows how to define a connection profile for an Ansible AWX job:

Copy
{
"ANSIBLE"
{
   "Type": "ConnectionProfile:Ansible AWX",
   "Connection Timeout": "50",
   "Ansible URL": "http://11.22.33.444:5678",
   "Ansible Token": "*****",
   "Description": "",
   "Centralized": true
}
}

The following table describes Azure DevOps connection profile parameters.

Parameter

Description

Ansible URL

Defines the Ansible AWX source hostname.

Ansible Token

Defines the API authentication key from your Ansible AWX account.

This token must provide Write permissions in Ansible AWX.

Connection Timeout

Determines the number of seconds to wait after Control-M initiates a connection request before a timeout.

Default:50

Centralized

Determines whether to create a centralized connection profile, which is stored in the Control-M/EM database and is available to all Agents.

You must set this parameter to true.

Values:

  • true: Creates a centralized connection profile.

  • false: Creates a local connection profile, which is associated with and stored on a specific Agent.

Default: false

ConnectionProfile:Azure DevOps

For more information about this plug-in see Control-M for Azure DevOps.

The following example shows how to define a connection profile for an Azure DevOps job:

Copy
"AZUREDEVCCP"
{
   "Type": "ConnectionProfile:Azure DevOps",
   "Azure Devops Token": "*****",
   "Azure DevOps URL": "https://dev.azure.com",
   "Organization ID": "organization2023",
   "Azure Username": "AZusername",
   "Description": "",
   "Centralized": true
}

The following table describes Azure DevOps connection profile parameters.

Parameter

Description

Azure DevOps URL

Defines the Azure DevOps source hostname.

Default: https://dev.azure.com

Organization ID

Defines the name of the Azure DevOps organization.

Azure Username

Defines the Azure DevOps username.

Azure DevOps Token

Determines the Personal Access Token (PAT), with a defined expiration date and scope of access, that connects to an Azure DevOps job. You can retrieve the token from Azure DevOps Configurations. You can use Secrets in Code to hide this value in the code.

By default, each authentication type uses an Azure token that is valid for 24 hours. You can extend token lifetimes through Azure.

Centralized

Determines whether to create a centralized connection profile, which is stored in the Control-M/EM database and is available to all Agents.

You must set this parameter to true.

Values:

  • true: Creates a centralized connection profile.

  • false: Creates a local connection profile, which is associated with and stored on a specific Agent.

Default: false

Connection Profile:CircleCI

CircleCI enables you to automate software development build, test, and deployment processes..

For more information about this plug-in, see Control-M for CircleCI.

The following example shows how to define a connection profile for a CircleCI job:

Copy
"CIRCLE"
{
   "Type": "ConnectionProfile:CircleCI",
   "CircleCI URL": "https://circleci.com/api/v2",
   "API Key": "*****",
   "Connection Timeout": "50",
   "Description": "",
   "Centralized": true
}

The following table describes CircleCI connection profile parameters.

Parameter

Description

CircleCI URL

Defines the URL of the CircleCI service.

Default: https://circleci.com/api/v2

API Key

Defines an API token for this account that is generated by the CircleCI service. You can use Secrets in Code to hide this value in the code.

Connection Timeout

Determines the number of seconds to wait after Control-M initiates a connection request before a timeout occurs.

Default: 50

Centralized

Determines whether to create a centralized connection profile, which is stored in the Control-M/EM database and is available to all Agents.

You must set this parameter to true.

Values:

  • true: Creates a centralized connection profile.

  • false: Creates a local connection profile, which is associated with and stored on a specific Agent.

Default: false

Connection Profile:Jenkins

Jenkins enables you to automate building, testing, and deploying code for repetitive tasks in software deployment process.

For more information about this plug-in, see Control-M for Jenkins.

The following example shows how to define a connection profile for a Jenkins job:

Copy
"JENKINS_RELEASE_TEAM":
{
   "Type": "ConnectionProfile:Jenkins",
   "Jenkins URL": "https://vl-tlv-ctm-bl30.adprod.bmc.com",
   "Username": "johndoe",
   "User API Token": "*****",
   "Connection Timeout": "100",
   "Description": "",
   "Centralized": true
}

The following table describes Jenkins connection profile parameters.

Parameter

Description

Jenkins URL

Defines the Jenkins source hostname.

https://<Server Name>:8443

Username

Defines the Jenkins username.

User API Token

Defines the API token that is generated by Automation API. You can use Secrets in Code to hide this value in the code.

Connection Timeout

Determines the number of seconds to wait after Control-M initiates a connection request to Jenkins before a timeout occurs.

Default: 100

Centralized

Determines whether to create a centralized connection profile, which is stored in the Control-M/EM database and is available to all Agents.

You must set this parameter to true.

Values:

  • true: Creates a centralized connection profile.

  • false: Creates a local connection profile, which is associated with and stored on a specific Agent.

Default: false