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

The new API command deploy connectionprofile:centralized::test enables you to test an existing centralized connection profile on a specific Control-M/Agent.

9.0.21.320 (October 2024)

The new API command run job::bypass enables you to bypass or ignore job options such as a resource, event, or time limit when you submit a job.

9.0.21.320 (October 2024)

Two new API commands, run forecast:timeline::get and run forecast:timeline::poll, enable you to generate a timeline forecast for when jobs, folders, or calendars are scheduled to run over a time period of months or years.

9.0.21.320 (October 2024)

Management of system settings in Helix Control-M using API commands config systemsettings::get and config systemsettings::set now supports a wide variety of additional system settings and system parameters. Most of these newly supported system settings and parameters appear in the JSON-format System Settings file under a new additionalParameters object, and are configurable in Helix Control-M using only the API commands. Management of these system settings, which pertain to the Control-M/Enterprise Manager component, is especially useful if you have self-hosted Control-M/Servers connected to Helix Control-M.

For more information, see System Settings Configuration.

9.0.21.300 (July 2024)

The following additional Control-M/Server system parameters are now supported by the config systemsettings:server::get and config systemsettings:server::set API commands:

  • MAIL_ADD_SUBJECT_PREFIX: Determines whether to add the Shout by orderno prefix to the subjects of email messages.

  • OUTPUTRETN: Defines the number of days that job OUTPUT files are retained for jobs executed by Agent computers.

For more information, see Control-M/Server System Parameters.

9.0.21.300 (July 2024)

The following new API commands are available for server configuration management:

9.0.21.300 (July 2024)

You can now retrieve secrets from an external CyberArk vault for use in password-type parameters in the following types of centralized connection profiles:

  • File Transfer Connection Profiles

  • Application Integrator Connection Profiles

  • Connection Profiles forControl-M Integrations

To locate and retrieve a secret from the external vault, you define several parameters under a Secret object, as described in External Vault Secrets.

9.0.21.300 (July 2024)

A new array structure for Resources in a job enables you to give the same name to a resource pool and a lock resource in the same job.

To enable this option, you must set the allowDuplicateResourceNames system setting to true. By default, this system setting is set to false.

For the deployment of jobs with resources, you can choose either the old JSON format (each resource defined under an object that bears the name of the resource) or the new format (an array of resources under a Resources object).

Retrieval of job resource details defaults to the old format, unless a resource pool and lock resource with the same name are detected in a job. You can enforce the display of job resources in the new array format by including the useArrayFormat query field in the deploy jobs::get command.

9.0.21.300 (July 2024)

Rule Based Calendar settings now include a group of new options for exception policies, which enable you to shift the calendar-day scheduling date before the working day adjustment is made.

9.0.21.300 (July 2024)

Job:Database:MSSQL:AgentJob includes new settings for the following options:

  • Rerun the job from the point of failure (from the step that failed during the previous run).

  • Run from a specific step.

9.0.21.300 (July 2024)

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-11783

All measurements in the response to a folder deployment have a value of 0, even though the job ended OK.

9.0.21.320 (October 2024)

CTM-11708

The CVE-2023-3635 vulnerability was reported in com.squareup.okio:okio 1.17.2, which is used by the Provision service in Control-M Automation API.

A newer version 1.17.6 of com.squareup.okio:okio is now packaged with the Provision service.

9.0.21.320 (October 2024)

CTM-11694

The run variables::get API command fails when the pool name specified in the query contains an underscore character.

9.0.21.320 (October 2024)

CTM-11635

Provisioning of certain Control-M Integration plug-ins fails, even though these plug-ins are available through the Install Plug-in pane.

In addition, these Integration plug-ins do not appear in the list returned by the provision images command.

9.0.21.320 (October 2024)

CTM-8193

Job deployment fails for a script-type job that contains the FileName property without a value, even though it also contains the RunAsDummy property set to true.

9.0.21.320 (October 2024)

CTM-8171

Job deployments fails for an embedded script job when the script file contains a \t string, as this string is incorrectly converted to a tab character.

9.0.21.320 (October 2024)

CTM-4615

The ctm run events::get API command returns the following incorrect message when the request fails due to a query string that matches a very large number of events:

error getting quantative resources

9.0.21.320 (October 2024)

CTM-4607

Job or folder deployment fails when scheduling criteria under the When property include the WeekDays or MonthDays property with a value that contains the D or L prefix with a leading 0 (for example, D06 instead of D6 or L03 instead of L3), according to the syntax used in previous versions of Control-M.

9.0.21.320 (October 2024)

CTM-11574

The CVE-2024-37890 vulnerability was reported in the JavaScript WebSocket ws library, which is used by the Control-M Automation CLI. This vulnerability does not impact Control-M Automation API.

Newer version 8.17.1 of the ws library is now packaged with Control-M Automation API.

9.0.21.320 (October 2024)

CTM-10068

The CVE-2023-35116 vulnerability was reported in jackson-databind 2.15.2, which is used by Control-M Automation API.

A newer version 2.17.2 of jackson-databind is now packaged with Control-M Automation API.

9.0.21.320 (October 2024)

CTM-10324

An incorrect status code is returned, code 200 (success) instead of 400 (errors in the request data), when deployment fails due to an empty SiteStandard object in the JSON code.

9.0.21.320 (October 2024)

CTM-10288

The run job:output::get fails to get the job run output if a previous request is still running, but the error message does not provide the reason for the failure.

To resolve this issue, the error message was enhanced to include the reason for the failure.

9.0.21.320 (October 2024)

CTM-8952

The deploy calendars::get API command fails to return the definitions of calendars when the calendar name or server name specified in the search query contains special characters (except *, which is supported).

9.0.21.320 (October 2024)

CTM-10287

The deploy folders::get API command fails to get details of folders if the search query does not include both the server and folder fields, but the error message does not contain the correct information about the reason for the issue.

9.0.21.320 (October 2024)

CTM-10286

Parameters of the following types in an Application Integrator based job that are exported from Control-M or retrieved using the deploy jobs::get API command appear in the JSON code as variables:

  • SOAP Request

  • REST body

  • Key/Value table

In addition, deployment fails for such an exported job with a SOAP Request field or a REST body field.

9.0.21.320 (October 2024)

CTM-10259

The specificDates parameter under the When scheduling property is limited to 12 dates, even though Control-M Web allows a much larger number of dates (up to 400). Deployment of an exported job fails with the following error message:

The field cannot contain more than 12 items

9.0.21.320 (October 2024)

CTM-10249

The run status API command fails to return the status of a z/OS job run.

9.0.21.320 (October 2024)

CTM-10127

Deployment of a job fails when the When scheduling property includes a MonthDaysCalendar property that references a periodic calendar and the MonthDays parameter specifies day 60 or later in the periodic calendar. This occurs even though the periodic calendar supports up to a full year (366 days).

The following error message is issued:

Bad day string DxxPB

where xx is 60 or higher.

9.0.21.320 (October 2024)

CTM-9971

The SLA Management job issues a warning message to the log when the CompleteBy parameters are not assigned values in the job definitions.

To resolve this issue, these parameters now have default values, so that the warning message is not issued.

9.0.21.320 (October 2024)

CTM-8326

The deploy jobs::get API command retrieves an If action of type Action:Run with incorrect variable values if ControlmServer is set to Local.

9.0.21.320 (October 2024)

CTM-7245

Deployment of objects (such as jobs and folders) associated with Control-M Application Integrator (including the various Control-M Integrations) might fail after a Control-M/EM failover.

9.0.21.320 (October 2024)

CTM-10075

Deployment fails when the JSON contains a variable with a value that contains a hyphen character. This occurs even though the

CTM_VARIABLE_ALLOW_HYPHEN server system parameter is set to Y in Helix Control-M.

9.0.21.300 (July 2024)

CTM-9934

The provision image and provision agent::update CLI commands fail when no Control-M CLI environment is defined.

9.0.21.300 (July 2024)

CTM-8341

APIs of the Reporting service fail to download large reports (more than 10MB) due to a connection timeout.

To resolve this issue, the reporting download API command has been deprecated and it is replaced by the new reporting reportUrl::get API command.

9.0.21.300 (July 2024)

CTM-9916

The run status command fails to retrieve the status of a z/OS job after deployment of a folder and execution of the run order command on the folder.

9.0.21.300 (July 2024)

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-9830

The config server:runasusers::get API command consumes a large amount of CPU when there are many Run as Users defined.

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-9391

The config server:runasusers::get API command exhibits bad performance when you run it as a non-Admin user.

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)