Deploy service

The deploy service allows you to transfer job and configuration definitions to Control-M. Once a job is deployed, it will be scheduled by Control-M according to its scheduling criteria and dependencies. The deploy overwrites any existing definition of the same name.

deploy

Deploy the provided definitions file to Control-M. Build will take place as part of the deploy to ensure code validity. deploy can receive definitions files for folders or jobs in .json format or Control-M import/export .xml format, or a package of multiple job definition files in .zip or .tar.gz format.

CLI Syntax

ctm deploy <definitionsFile> [deployDescriptorFile]

If annotation is enabled for the Scheduling definitions, Configuration management, or Control-M security category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

Example using curl:

curl -H "Authorization: Bearer $token" -X POST  -F "definitionsFile=@examples/AutomationAPISampleFlow.json" 
-F "deployDescriptorFile=@examples/deployDescriptor.json"  "$endpoint/deploy" 

deploy transform

The transform command enables you to apply the rules of the deployDescriptorsFile to the original definitionsFile.  The rules define the method to use that change the values of the JSON code properties in the original defintionsFile. 

CLI Syntax

ctm deploy transform <definitionsFile> <deployDescriptorFile>

Where:

REST API Syntax

See REST API reference.

curl -H "Authorization: Bearer $token" -X POST  -F "definitionsFile=@examples/AutomationAPISampleFlow.json" 
-F "deployDescriptorFile=@examples/deployDescriptor.json"  "$endpoint/deploy/transform"

deploy jobs::get

Returns the definition of jobs and folders in the requested format that match the search criteria.

CLI Syntax

ctm deploy jobs::get [format] -s <search query>

-s  is used to run a search using the query string format. The following table includes the fields that can be used in the search query:

For example, the following command shows how to get a job in a JSON format for all the folders that start with Automation:

ctm deploy jobs::get -s "ctm=*&folder=Automation*"

REST API Syntax

See REST API reference.

>curl -k  -H "Authorization: Bearer $token"  "$endpoint/deploy/jobs?ctm=*&folder=Auto*"
 
>curl -k  -H "Authorization: Bearer $token"  "$endpoint/deploy/jobs?ctm=*&folder=Auto*&format=XML"

deploy connectionprofiles::get

Returns the connection profiles that match the search criteria.

CLI Syntax

ctm deploy connectionprofiles::get -s <search query>

Use the required -s option to specify a query string to search for. The following table includes the fields that can be used in the search query:

REST API Syntax

See REST API reference.

endpoint=https://<controlm>:8443/automation-api
token=
ctm=
agent=
type=
curl -X GET -H "Authorization: Bearer $token"  "$endpoint/deploy/connectionprofiles?ctm=$ctm&agent=$agent&type=$type"

deploy connectionprofile::delete

Deletes the connection profile.

CLI Syntax

ctm deploy connectionprofile::delete <ctm> <agent> <type> <name>

If annotation is enabled for the Control-M security category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

endpoint=https://<controlm>:8443/automation-api
token=
ctm=
agent=
type=
name=
curl -X DELETE -H "Authorization: Bearer $token"  "$endpoint/deploy/connectionprofile/$ctm/$agent/$type/$name"

deploy folder::delete

The delete folder command enables you to delete a folder.

CLI Syntax

ctm deploy folder::delete <ctm> <folderName>

If annotation is enabled for the Scheduling definitions category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

endpoint=https://<controlm>:8443/automation-api
token=
ctm=
folder=
curl -X DELETE -H "Authorization: Bearer $token"  "$endpoint/deploy/folder/$ctm/$folder"

deploy ai:jobtype

This command enables you to deploy an Application Integrator job type to the Control-M/Agent to allow it to run.

The response notifies you whether the deployment succeeded or failed.

Note: Deployment of an Application Integrator job type is supported in Control-M environments with Control-M/Enterprise Manager version 9.0.19.100 or later.

CLI Syntax

ctm deploy ai:jobtype <ctm> <agent> <jobTypeId>

REST API Syntax

See REST API reference.

token=
endpoint=https://<controlm>:8443/automation-api
ctm=
agent=
jobType=
curl -X POST -H "Authorization: Bearer $token" 
"$endpoint/deploy/ai/jobtype/?ctm=$ctm&agent=$agent&jobTypeId=$jobType"

deploy ai:jobtypes::get

This command enables you to get details of deployed Application Integrator job types that match a specified search query.

CLI Syntax

ctm deploy ai:jobtypes::get [-s <search query>]

The optional -s option enables you to limit the list to job types that match specified criteria. The format for the query string is "field1=criteria1&field2=criteria2", according to the following guidelines:

REST API Syntax

See REST API reference.

token=
endpoint=https://<controlm>:8443/automation-api
curl -X GET -H "Authorization: Bearer $token" 
"$endpoint/deploy/ai/jobtypes/?jobTypeId=<ID string>&jobTypeName=<name string>"

Response

The following example response lists 3 Application Integrator job types, 2 of which are ready to deploy and one more in draft status:

{
'jobtypes': [
  {'status': 'ready to deploy', 'jobTypeId': 'CTMREMOTE', 'description': 'Track job running on remote Control-M Stack', 'jobTypeName': 'Monitor Remote Job'}, 
  {'status': 'ready to deploy', 'jobTypeId': 'AZUREBLOB', 'description': 'Azure blob storage', 'jobTypeName': 'Azure blob storage'}, 
  {'status': 'draft', 'jobTypeId': 'DRAFT4GET', 'description': 'Draft Job Type', 'jobTypeName': 'Draft Job'}
]
}

The following parameters are provided for each job type:

deploy sitestandard:fieldRestriction::get

9.0.19.200This command obtains the list of allowed values defined for a restricted-text field in a Site standard.

Note: API commands related to Site standards are supported in Control-M environments with Control-M/Enterprise Manager version 9.0.19.000 or later.

CLI Syntax

ctm deploy sitestandard:fieldRestriction::get <standardName> <fieldName>

Where:

REST API Syntax

See REST API reference.

standardName=standard1
fieldName=application
curl -X GET -H "Authorization: Bearer $token" 
"$endpoint/deploy/sitestandard/$standardName/fieldRestriction/$fieldName"

deploy sitestandard:fieldRestriction::replaceValues

9.0.19.200This command replaces the allowed values defined for a restricted-text field in a Site standard with a new set of allowed values.

Note: API commands related to Site standards are supported in Control-M environments with Control-M/Enterprise Manager version 9.0.19.000 or later.

CLI Syntax

ctm deploy sitestandard:fieldRestriction::replaceValues <standardName> <fieldName> -f <valuesFile>

Where:

{
  "values": [
    {
      "value": "App1"
    },
    {
      "value": "App2",
      "description": "description of application2"
    }
  ]
}

If annotation is enabled for the Scheduling definitions category in Control-M, you must also provide an annotation to justify your action. For more information, see Annotation input.

REST API Syntax

See REST API reference.

standardName=standard1
fieldName=application
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer $token" 
-d "@examples/SiteStandardApplicationFieldValues.json"
"$endpoint/deploy/sitestandard/$standardName/fieldRestriction/$fieldName"