CI/CD Connection Profiles

The following topics describe connection profiles for Continuous Integration and Continuous Deployment (CI/CD) services.

Azure DevOps Connection Profile Parameters

Before you can define a job, you must create a connection profile in the Configuration domain. A connection profile contains authorization credentials—such as the username, password, and other plug-in-specific parameters—and enables you to connect to the application server with only the connection profile name. To create a connection profile, see Creating a Centralized Connection Profile.

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

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:

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

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

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.

Use External Vault

Determines whether to retrieve secret parameter values from an external vault, as described in CyberArk Secret Parameters in Connection Profiles.Determines whether to retrieve secret parameter values from an external vault as described in CyberArk Secret Parameters or HashiCorp Secret Parameters.

Connection Timeout

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

Default: 60

CircleCI Connection Profile Parameters

Before you can define a job, you must create a connection profile in the Configuration domain. A connection profile contains authorization credentials—such as the username, password, and other plug-in-specific parameters—and enables you to connect to the application server with only the connection profile name. To create a connection profile, see Creating a Centralized Connection Profile.

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

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.

Use External Vault

Determines whether to retrieve secret parameter values from an external vault, as described in CyberArk Secret Parameters in Connection Profiles.Determines whether to retrieve secret parameter values from an external vault as described in CyberArk Secret Parameters or HashiCorp Secret Parameters.

Connection Timeout

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

Default: 50

GitHub Actions Connection Profile Parameters

Before you can define a job, you must create a connection profile in the Configuration domain. A connection profile contains authorization credentials—such as the username, password, and other plug-in-specific parameters—and enables you to connect to the application server with only the connection profile name. To create a connection profile, see Creating a Centralized Connection Profile.

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

Parameter

Description

GitHub URL

Defines the URL for the REST API endpoint in GitHub.

Default: https://api.github.com

Authentication Method

Determines one of the following token types for authentication:

  • Classic Token

  • Fine Grained Token

Token

Defines the token to authenticate in GitHub.

Use External Vault

Determines whether to retrieve secret parameter values from an external vault, as described in CyberArk Secret Parameters in Connection Profiles.Determines whether to retrieve secret parameter values from an external vault as described in CyberArk Secret Parameters or HashiCorp Secret Parameters.

HTTPS Codes

Defines the HTTP codes that rerun a job step if it is detected in the response.

Multiple HTTP codes must be separated with a space.

You cannot rerun a step with HTTP codes when you perform manual execution, such as rerun from point of failure.

Default: 429

Rerun Interval

Determines the number of seconds to wait before Control-M reruns the job step.

Default: 10

Attempts Rerun

Determines the number of attempts to rerun a job step.

Default: 3

Connection Timeout

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

Default: 100

Jenkins Connection Profile Parameters

Before you can define a job, you must create a connection profile in the Configuration domain. A connection profile contains authorization credentials—such as the username, password, and other plug-in-specific parameters—and enables you to connect to the application server with only the connection profile name. To create a connection profile, see Creating a Centralized Connection Profile.

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

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.

Use External Vault

Determines whether to retrieve secret parameter values from an external vault, as described in CyberArk Secret Parameters in Connection Profiles.Determines whether to retrieve secret parameter values from an external vault as described in CyberArk Secret Parameters or HashiCorp Secret Parameters.

Connection Timeout

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

Default: 100