Release notes for the Splunk Common Information Model Add-on

Version 5.2.0 of the Splunk Common Information Model Add-on was released on September 6, 2023 and contains only backend improvements for cross-platform synchronization.

New features or enhancements

Version 5.2.0 of the Splunk Common Information Model Add-on includes no new features.

Upgrade requirements

Splunk platform version	Upgrade activity
8.0.x or later	If you apply custom tags to data mapped to CIM data models and you use these tags in searches and search filters, add these tags to the allowlists for those models. See Set up the Splunk Common Information Model Add-on for details about the tags allow list field.

Compatibility

Version 5.0.x of the Splunk Common Information Model Add-on requires Splunk platform version 8.0.x or later. Some workarounds, such as the datamodels spec workaround for tags_allowlist and poll_buckets, are no longer available in version 7.0.x and later. This might lead to btool check warnings at startup.

Fixed issues

This version of the Splunk Common Information Model Add-on fixes the following issues. If this section is empty, this release has no reported fixed issues.

Limitations

If you are in a search head cluster environment on Splunk Cloud Platform, you might see error messages related to adaptive response actions. To troubleshoot these issues, see Troubleshoot adaptive response actions in search head cluster deployments on Splunk Cloud Platform.

Known issues

This version of the Splunk Common Information Model Add-on has the following reported known issues. If this section is empty, this release has no reported known issues.

Date filed	Issue number	Description
2024-09-03	CIM-1275	CIM Setup - Improve UI message for DMA index filtering
2024-08-29	CIM-1272	DLP Data Model - Incidents category field evaluates incorrectly
2024-08-27	CIM-1269	Biased language fixed within CIM Setup UI Labels
2024-08-26	CIM-1265	Vulnerability fix validation/testing: Session Key stored cam_queue lookup in clear text
2024-08-08	CIM-1264, CIM-1258	Vulnerability fix: Session Key stored cam_queue lookup in clear text
2024-03-28	CIM-1225	The Auth DM needs a Session ID to enable ES usecases
2024-03-22	CIM-1224	CIM field "protocol_version" should have description saying that it should be in lower case Workaround: The description of field Template:Protocol version in [+Network_Traffic.json+|https://cd.splunkdev.com/EnterpriseSecurity/sa-commoninformationmodel/-/blob/develop/packages/sa-commoninformationmodel/src/main/resources/splunk/default/data/models/Network_Traffic.json] is changed to: {quote}Version of the OSI layer 3 protocol, in lower case.{quote}
2024-02-15	CIM-1212, CIM-1193	"Update" datamodel: add prescribed value "failure" to the cim field "status"
2023-11-13	CIM-1186	Tags are not saved as expected in the "Tags allow list" parameter in Splunk Common Information Model (v5.2.0).
2023-04-03	CIM-1278	Entity Zones are rarely available in ESS and ESCU's default correlation search. Workaround: Clone the correlation search that has a tstats or stats command, provided by the ESCU or ESS you wish to enable and edit the search so that the zone information (e.g., cim_entity_zone field) remains in the search results.
2022-11-28	CIM-1128, SOLNESS-33830	The parent_process_name field is not extracted correctly when events with data model are searched.
2021-11-09	CIM-1069	Network sessions actions field prescribed values don't cleanly match the traffic

Deprecated or removed features

The following are deprecated or removed features:

As of version 5.2.0:

• N/A

As of version 5.1.1:

• N/A

As of version 5.1.0:

• N/A

As of version 5.0.1:

• N/A

As of version 5.0.0:

• N/A

As of version 4.20.2:

• N/A

As of version 4.20.0:

• N/A

As of version 4.19.0:

• N/A

As of version 4.18.0:

• The body field is deprecated in favor of the description field in the Alerts data model and will be removed in a future version.
• The subject field is deprecated in favor of the signature field in the Alerts data model and will be removed in a future version.

As of version 4.15.0:

• The Predictive Analytics dashboard is removed in favor of Machine Learning Toolkit functionality.

As of version 4.14.0:

• The Predictive Analytics dashboard is deprecated in favor of Machine Learning Toolkit functionality and will be removed in a future version.

As of version 4.13.0:

• N/A

Third-party software attributions

The Splunk Common Information Model Add-on does not incorporate any third-party software or libraries.