What's New

New developments in Control-M Automation API are divided into the following categories:

Enhancements

The following new features were introduced in the specified versions.

Feature

Version

You can now use the historyRunDate field in query strings of the run jobs:status::get command to filter for jobs that ran on a specific date.

9.0.21.215 (December 2023)

You can now use the following Agent (Host) Restrictions API commands to restrict the resources used and the number of concurrent jobs that you can execute on one or more Agents, which helps prevent resource overload:

9.0.21.200 (September 2023)

You can now use the deploy jobtype::get command to download a custom job type from theServer and store it locally in *.ctmai format, so that it is available for deployment (using What's New). You can use this command when you want to copy job types from one environment to another.

9.0.21.200 (September 2023)

You can now use the following API commands to check for jobs that were not ordered because a specific Order Method (a specific User Daily job) was interrupted, such as when an operating system crashes, and reorder those jobs.

These API commands replace the ctmudchk utility.

9.0.21.200 (September 2023)

You can now use run ondemand API command to immediately execute jobs, without deploying them to the Server database and without requiring the User Daily job in Control-M to trigger them This approach can be useful for event-driven job executions.

This API command replaces the use of the ctmcreate utility.

9.0.21.200 (September 2023)

File Transfer job definitions now support the inclusion of various new parameters, as described in File Transfer Job.

9.0.21.200 (September 2023)

You can now use the config server:notification:list::setactive API command to activate a notification destination list.

This API command replaces the use of the ctmshtb utility.

9.0.21.200 (September 2023)

You can now configure and manage Agentless Hosts with Control-M Automation API, as described in Agentless Host Configuration.

9.0.21.200 (September 2023)

You can now configure and manage SSH keys with Control-M Automation API, as described in SSH Key Configuration.

9.0.21.200 (September 2023)

What's Changed

The following changes were made in existing features in the specified versions:

Feature

Version

The config server:hostRestriction::add and config server:hostRestriction::update commands now receive the additional parameters—nodePrefix, maxJobsAllowed, and maxCPUPct—through the command, rather than through a JSON-formatted configuration file.

9.0.21.235 (May 2024)

Corrected Problems

The following table lists issues that have been corrected in the most recent releases:

Tracking #

Description

Version

CTM-9938

The Build service incorrectly executes the Deploy service. This occurs if the job was defined as a root object with a PathElement property.

9.0.21.235 (May 2024)

CTM-9916

The Run service fails to order a z/OS folder if the version of the Control-M/Server is 9.0.21.200.

9.0.21.235 (May 2024)

CTM-9858

The Alerts Listener is terminated when there is an overload of alerts on the sever side and the Alerts Listener client is unable to process them all.

As part of the resolution of this issue, the output of the Alert script is no longer included in the Alerts listener log. When listenerLogLevel is set to debug level, the exit status from the Alert script is included in the Alerts listener log.

9.0.21.235 (May 2024)

CTM-9730

The Alerts Listener process appears to be connected, even though the WebSocket gateway is experiencing a connection issue and no alerts are sent for up to two hours.

9.0.21.235 (May 2024)

CTM-9692

Job deployment fails when the job contains an event and the job was defined as a root object with a PathElement property. This issue occurs when a site standard was applied to the folder that contains the job.

The following error message appears:

Out condition... already exists

9.0.21.235 (May 2024)

CTM-9453

Job deployment fails for a job of type Job:Database:StoredProcedure, if the stored procedure does not have any defined parameters.

The following error message appears:

AGENT IS UNAVAILABLE

9.0.21.235 (May 2024)

CTM-9849

The config server:agent::ping command initiates too many internal polling requests to Helix Control-M, every 10 milliseconds instead every second.

9.0.21.230 (March 2024)

CTM-9839

Provision actions fail when Automation API CLI sends requests through an HTTPS or HTTP proxy server.

9.0.21.230 (March 2024)

CTM-9806

The deploy job::delete command fails to delete a job if the job name contains space characters, even though spaces are allowed in job names.

9.0.21.230 (March 2024)

CTM-9494

The CVE-2023-45857 vulnerability was reported in axios 0.25.0, which is used by the Control-M Automation CLI. This vulnerability does not impact Control-M Automation API.

A newer version of axios is now packaged with Control-M Automation CLI.

9.0.21.230 (March 2024)

CTM-9203

An API token does not grant proper permissions to the associated users after the name of the associated role is changed. API token details are not synchronized and the role name is not updated.

9.0.21.230 (March 2024)

CTM-9218

Provision actions fail when Automation API CLI runs on AIX 7.3.

9.0.21.230 (March 2024)

CTM-9675

The run ondemand API command ignores the specified Host property of a job in a sub-folder, and this might cause the job run to fail.

9.0.21.225 (February 2024)

CTM-9517

The deploy jobs::get command fails to return the specified parameters in a Stored Procedure Database job.

9.0.21.225 (February 2024)

CTM-9527

Deployment of a job that was obtained from a later version of Automation API (using the deploy jobs::get command) fails in an Automation API environment of an earlier version, due to unrecognized (new) job properties. The following error is issued:

<Name of new property> is an unknown keyword...

9.0.21.220 (January 2024)

CTM-9442

Password-type fields are corrupted in Application Integrator connection profiles when you make changes to non-password fields.

9.0.21.220 (January 2024)

CTM-9425

The run ondemand API command ignores the specified Host property, and this might cause the job run to fail.

9.0.21.220 (January 2024)

CTM-9357

The deploy jobs::get command does not return an array of jobs from a sub-folder specified through the folder field in the search query, even though useArrayFormat=true was included in the search query.

9.0.21.220 (January 2024)

CTM-9228

The deploy connectionprofile::test API command fails with the following error:

Failed to validate the connection with the selected Agent.

9.0.21.220 (January 2024)

CTM-9404

Job deployment fails for a job of type Job:Database:StoredProcedure, if the job runs on a PostgreSQL database and the stored procedure has no return value.

9.0.21.215 (December 2023)

CTM-9247

After an upgrade on AIX 7.2, Control-M Automation API fails to start.

9.0.21.215 (December 2023)

CTM-9235

The config server:agent::update API command fails to update the sslState parameter on the Agent. In addition, the range of values for the maximumRetries parameter is too narrow (up to 10, where some users might need values up to 100).

9.0.21.215 (December 2023)

CTM-9229

Agent provisioning fails if the Control-M Automation CLI version differs from the Automation API version on the Server.

9.0.21.215 (December 2023)

CTM-9162

The default value for the Delimiter parameter under a Capture Output action (Action:CaptureOutput) is an empty value. It should be WhiteSpace.

9.0.21.215 (December 2023)

CTM-8693

Non-default scheduling definitions are set to default values during deployment of a job that was defined as a root object with a PathElement property.

9.0.21.215 (December 2023)

CTM-5592

The run variables::set API command fails when a named pool variable contains an underscore character.

9.0.21.215 (December 2023)

CTM-8883

A return code of 500 (server internal error), instead of 404 (defined item not found), is issued when you attempt to GET details regarding objects in a folder that does not exist in Server.

9.0.21.210 (November 2023)

CTM-7709

The deploy sitestandards::get API command returns a corrupt JSON when the list of Site Standard rules contains conditions. The Conditions array is not created, and condition details appear directly under the Rules object. Deployment of this JSON fails with a null pointer exception error.

9.0.21.210 (November 2023)

CTM-8719

Deployment of an array of jobs fails with a java.lang.NullPointerException error when a validation error is detected in one of the job properties.

9.0.21.205 (October 2023)

CTM-8823

Deployment fails with a "Table in use" error. This occurs if Control-M/Server attempts to synchronize folders at the same time as the deployment.

9.0.21.200 (September 2023)

CTM-8524 CTM-5559

Control-M Automation API does not preserve memory settings during an upgrade, and instead resets them to default.

9.0.21.200 (September 2023)

CTM-8337

Job deployment fails when the job contains an Action:Run and the job was defined as a root object with a PathElement property.

9.0.21.200 (September 2023)

CTM-7634

Deployment fails for a job of type Job:DetachedScript with the RunAsDummy property set to true.

9.0.21.200 (September 2023)

CTM-6182

A build of File Transfer jobs (performed by the build service or the deploy service) issues the following warning message:

Cannot find field 'IsGroupAccount' in context 'AftAccount'.

The fix for this issue requires Control-M/Enterprise Manager version 9.0.21.200 or later.

9.0.21.200 (September 2023)