CI/CD Connection Profiles

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

ConnectionProfile:Ansible AWX
ConnectionProfile:Azure DevOps
Connection Profile:CircleCI
Connection Profile:Jenkins

ConnectionProfile:Ansible AWX

Ansible AWX jobs enable you to manage Ansible playbooks, inventories, and job scheduling.

For more information about this plug-in, 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. The plug-in appends the string /api to this value. Format: http(s):<hostname>:<port>
Ansible Token	Defines the API authentication key from your Ansible AWX account. This token must provide Write permissions in Ansible AWX.
Connection Timeout	Defines 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.

ConnectionProfile:Azure DevOps

Azure DevOps provides an integrated set of services and tools to manage software projects, from planning and development through testing and deployment. Azure DevOps delivers services through a client/server model.

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

The following examples show 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",
   "Identity Type": "PAT",
   "Description": "",
   "Centralized": true
}

Copy

"AZUREDEVCCP": 
{
   "Type": "ConnectionProfile:Azure DevOps",
   "Azure DevOps URL": "https://dev.azure.com",
   "Organization ID": "organization2023",
   "Azure Login URL": "https://login.microsoftonline.com", 
   "Tenant ID": "************************************", 
   "Scope": "https://app.vssps.visualstudio.com/.default", 
   "Application ID": "************************************", 
   "Azure DevOps URL": "https://dev.azure.com", 
   "Client Secret": "*****",
   "Identity Type": "PRINCIPAL",
   "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.
Identity Type	Determines one of the following authentication methods: PRINCIPAL (Service Principal): Access protected Azure services and resources based on roles assigned to the Service Principal by the Azure administrator. The Service Principal is also known as an App Registration. This method authenticates with the Azure login URL, Tenant ID, Scope, Application ID, and Client Secret. PAT (Personal Access Token): Access protected Azure services and resources using a token created and managed by the Azure platform, without login credentials. This method authenticates with the Azure Username and the Azure Devops Token.
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.
Azure Login URL	Defines the base URL of the Microsoft Entra/Azure AD authentication endpoint.
Tenant ID	Defines the Azure tenant ID for your organization.
Scope	Defines the scope, which limits the operations you can perform and the roles you can use in the Azure Devops plug-in, as follows: https://<resource-domain>/default https://app.vssps.visualstudio.com/default
Application ID	Defines the Registered App for the Azure service in your Microsoft Entra/Azure AD tenant. The corresponding Service Principal must be assigned the Owner or Contributor role for the Azure service.
Client Secret	Defines the password associated with the Service Principal/registered application.
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.

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

Connection Profile:Jenkins

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

For more information, 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	Defines the number of seconds to wait after Control-M initiates a connection request 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.