What's New

The run order command now supports running multiple deployed jobs through the use of commas in the jobs input parameter.

Starting with Control-M Automation API version 9.0.21.325, Java 17 or higher is required. For more information, see External Java Management.

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.

The hostgroupAgentParticipation object returned by the config server:hostgroups:agents::get API has been deprecated, and it is replaced by the participationRules object.

The participationRules object lists multiple defined participation rules of two types:

• dateTime: Limits the inclusion of an Agent host in a host group to scheduled dates and times.

• event: Limits the inclusion of an Agent host in a host group based on an event.

If you use the hostgroupAgentParticipation object in your code, you must replace it with the new participationRules object.

CTM-11998

Uninstallation of the Control-M REST API fails after an upgrade to version 9.0.21.325.

CTM-11814

The API process (emrestsrv) fails to start after you install Control-M REST API version 9.0.21.315 on AIX.

CTM-11758

The run job::get command fails when the JSON job definition contains the textual string "Folder".

CTM-10166

The colon character (:) is removed from patterns in a site standard during deployment.

CTM-9144

The deploy jobs::get command removes opening parenthesis characters in the JSON code of a z/OS job. As a result, deployment of the z/OS job fails.

CTM-11936

The CVE-2024-41818 vulnerability was reported in the fast-xml-parser library, which is used by the Control-M Automation CLI.

Newer version 4.4.1 of this library is now packaged with Control-M Automation API.

CTM-11928

The deploy jobs::get API command fails to return job details when one of the jobs is an OS command job with no Application Type value specified.

CTM-11823

The run job::get API command fails with a java.lang.NullPointerException error for an SLA Management job.

CTM-11790

Migration of local connection profiles to centralized connection profiles fails when Automation API version 9.0.21.320 is installed.

CTM-11756

The config server:hostgroups::get API command returns an outdated list of host groups if the CMSCtmNGRefreshInterval system parameter is set to 0. This occurs after an upgrade to Control-M version 9.0.21.

This issue is resolved only in Compatibility mode.

CTM-10282

Calendar deployment failure due to lack of authorization returns an error of status code 400 instead of status code 403.

CTM-11783

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

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.

CTM-11694

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

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.

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.

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

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.

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.

CTM-11547

The API process (emrestsrv) might choose to work with an old Java installation when multiple Java installations are listed in the external_java_path.dat file.

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.

CTM-8192

Files in the descriptors directory in the Control-M Automation API installation have group write permissions.

To resolve the issue, these files are no longer included in the installation.

CTM-10463

The authentication token does not work and API commands fail in a Control-M environment with an Oracle database that uses SSL communication.

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.

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.

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

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.

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.

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

CTM-10249

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

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.

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.

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.

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.

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 Control-M Web.

CTM-10062

The run workloadpolicies::add command adds the Workload Policy with a priority of 0. As a result, the list of Workload Policies in Control-M Web does not respond.

CTM-9991

Provision commands fail when you use an API token (rather than a user and password) for authentication.

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.

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.

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.

CTM-9830

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

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

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

CTM-9391

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

CTM-9624

The config server::failover command fails to perform a manual failover when the async option is not included in the command.

CTM-9849

The config server:agent::ping command initiates too many internal polling requests to the Configuration Management Server (CMS), every 10 milliseconds instead every second.

CTM-9839

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

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.

CTM-9709

The config em::failover command fails after an upgrade to version 9.0.21.215, and the following error is issued:

Cannot perform failover right now since the CTM/Server is currently running on the secondary host.

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.

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.

CTM-9218

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

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.

CTM-9615

The run workloadpolicy::delete deletes multiple Workload Policies with similar names, instead of just the one specified. This occurs when the specified name appears as a string within the names of other Workload Policies.

CTM-9609

Control-M Automation API uses the Java home path defined in external_java_path_9.0.21.100.dat instead of the one defined in external_java_path_9.0.21.200.dat after an upgrade of Control-M/EM to 9.0.21.200.

CTM-9517

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

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

To enable the resolution of this issue, you must add the min.aapi.ste.version property to the automation-api.properties file and set it to the target (earlier) version of Automation API.

For example, to deploy a job that was defined in Automation API 9.0.21.215 to an environment with Automation API 9.0.21.130, add the following line:

min.aapi.ste.version=9.0.21.130

CTM-9442

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

CTM-9425

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

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.

CTM-9228

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

Failed to validate the connection with the selected Agent.

CTM-9417

The provision agent::setup API command fails to set the tag parameter on the Agent if this parameter is defined in the configuration file.

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.

CTM-9247

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

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

CTM-9229

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

CTM-9162

The default value for the Delimiter parameter under a Capture Output action (Action:CaptureOutput) is an empty value (appropriate for z/OS jobs). It should be WhiteSpace (appropriate for other job types).

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.

CTM-5592

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

CTM-9200

Products installations fail due to a failure to stop the Automation API server.

CTM-9194

The error message for a failed export to JSON of a folder that contains an unidentified Site Standard does not contain clear details.

CTM-9119

The run job:output::get command fails to get the output of a z/OS job, and the following error is issued:

Request rejected by Data Center\n ECS3000 SERVER INTERNAL ERROR - TYPE 24.

CTM-9104

AAPI calls that use an API token fail with the following error:

User not found. Session token is invalid or expired.

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 Control-M/EM.

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.

CTM-8864

Deletion of a Site Standard or renaming of a Site Standard fails after an upgrade to version 9.0.21 if Control-M is in Compatibility mode.

CTM-8857

The provision agent::setup API command fails when a payload configuration file is used and annotation is enabled.

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.

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.

CTM 8622

Deployment of z/OS jobs fails with the following error:

Folder .... cannot contain both an array of jobs and a single, named job

This occurs even though the folder does not contain both an array of jobs and individual jobs.

CTM-8524 CTM-5559

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

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.

CTM-7634

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

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.

CTM-8610

The deploy jobs::get may fail to return job details when a folder contains multiple jobs with the same name and a defined job has both a filename and job name in its definitions.

CTM-8597

The deploy API command returns a validation error when job definitions contain an active period with a start date that equals the end date.

CTM-8563

The deploy jobs::get fails to return job details for z/OS jobs when a library filter is used in the API command.

CTM-8531

The JSON file returned by the deploy transform API command fails compilation by the build command. This occurs when you run the deploy transform command through the CLI and the job name contains only numeric characters.

CTM-8471

The run order API command fails when the orderIntoFolderparameter is set to a specific folder order ID.

CTM-8467

The provision image API command fails to provision an Agent or a plug-in on a Windows machine that already has a plug-in installed. The following error is issued:

Cannot invoke "java.lang.Boolean.booleanValue()" because ''x" is null.

CTM-8416
CTM-8105

The deploy jobs::get API command returns invalid JSON code, rather than an error message, when you attempt to retrieve the definitions of a job that is not supported by Control-M Automation API.

CTM-8323

Deployment of an Embedded Query Database Job fails when the variable contains special characters, but the error message does not properly describe the reason for the failure.

CTM-7414

The reporting download API command fails to download a report if port 18080 is blocked.

To resolve this issue, reports are now downloaded through the port specified in the API command request URL.

CTM-5563

Control-M Web fails to create a connection profile when annotation is enabled for certain categories but not for the Security category, due to issues in the communication with Control-M Automation API.

CTM-8514

Folder creation fails after an upgrade to Control-M Automation API version 9.0.21.120, and the following error is issued:

Internal validation problem: cannot find field 'retentionPolicyUnits' in context 'FolderPropertiesData' set by rule #2447.

CTM-8453

Vulnerability sonatype-2022-6438 was reported in jackson-core version 2.14.2 packaged with Control-M Automation API.

To resolve this issue, the jackson-core package in Control-M Automation API was updated to version 2.15.2.

CTM-8444

Details of an Action:Output object in a z/OS job returned by the deploy jobs::get command are incomplete.

CTM-8442

The deploy jobs::get command issues an Invalid JSON error when a folder and a job within the folder have the same name.

CTM-8441

CTM-8440

Security protocols used for communication between the Automation CLI and Automation API to Control-M components were outdated.

To resolve this issue, communication protocols were updated to TLSv1.2.

CTM-8439

Deployment of a job within a sub-folder fails when the sub-folder contains a ReferencePath property that references a folder rather than a job.

CTM-8107

The YAML file generated by the REST API server returns errors when validating the Swagger specifications (OpenAPI2.0) of the REST APIs.

CTM-7916

Host Group Management API commands get or process only one participation rule defined for the host group under the hostgroupAgentParticipation object.

For more information about the resolution of this issue and the introduced changes, see What's New.

CTM-8286

The deploy jobs::get command retrieves a wrong name for a job property of type Load text file in an Application Integrator job. Deployment of the retrieved job fails.

CTM-8229

The run job::rerun command support the restart of a z/OS job only if the job is in Ended OK or Ended Not OK status. Wait User status (which corresponds to Wait Confirmation status in Control-M for z/OS) is not supported.

To resolve this issue, support for the Wait User status was added to the run job::rerun command.

CTM-8179

The deploy jobs::get command fails to retrieve a job that contains an If statement, with the following error:

Retrieving as JSON is not fully supported ... has an invalid property ""code"" = ""COMPSTAT > 0"".

CTM-8177

The deploy jobs::get returns does not retrieve the "RunAsDummy": true property in an Embedded Script job.

CTM-8072

The deploy job::delete command fails with an erroneous error that indicates that the folder name is longer than the allowed 64 characters. This occurs when the job resides within a nested sub-folder in a folder path that exceeds the allowed length, even though the individual sub-folder name does not exceed the allowed length.

Site Standards are not applied to jobs or sub-folders that were defined as root objects under a PathElement property.

CTM-8175

The ctm provision image::remove command fails to remove an image of an agent of version 9.0.21.

CTM-8170

Connection Profiles with password-type fields that require very long strings fail to establish a connection with the target platform. This occurs in centralized connection profiles for job types developed in Application Integrator. For example, connection profiles that connect to the Google Cloud, which require a Service Account Key.

CTM-8055

The deploy jobs::get command fails to retrieve the details of a job type developed in Application Integrator if the job type was renamed.

CTM-7022

The deploy connectionprofile::test command exposes sensitive details of a modified connection profile to external tools.

CTM-8059

The CVE-2021-43138 vulnerability was reported in the async 0.9.2 library used by winston. These libraries are packaged with Control-M Automation CLI.

To resolve this issue, a newer version of the library is now packaged with Control-M Automation CLI.

CTM-8058

The provision command fails to provision an agent when the location of the installed java package is detected by Control-M Automation CLI and not through the BMC_INST_JAVA_HOME environment variable.

CTM-7976

An event defined within a sub-folder is not created during deployment of the sub-folder. This occurs if the sub-folder is defined as a root object (using the PathElement property).

CTM-7934

The deploy folder::delete command does not work properly. The original folder is deleted, but a new, empty folder with the same name is created. This occurs in product version 9.0.21.100 or later.

CTM-8166

The proxy port number setting of an AWS connection profile is not validated during deployment.

CTM-8167

The Region setting of an AWS connection profile is not validated during deployment.

CTM-7927

Deployment of a folder that contains 10 or more jobs in a job array fails.

CTM-7926

The deploy jobs::get command returns an empty parameters array ("Parameters": [],) from a Database Job for a Stored Procedure (Job:Database:StoredProcedure) when no parameters were defined. Deployment of the returned JSON fails.

CTM-7896

The run order command requires a value for the orderIntoFolder parameter in the submitted configuration file, and does not apply the default value ("New") for this parameter. This occurs in versions 9.0.21.xxx, but not in earlier versions, of Automation API.

Control-M Automation API no longer supports Java 11 as of version 9.0.21.325, the monthly release of October 2024.

API command config em:param::set is deprecated from version 9.0.21.300. It is replaced by config systemsettings::set.

Control-M Automation API is no longer supported on Solaris from version 9.0.21.230. Installation packages for Solaris will no longer be provided in any future release.