Splunk Enterprise Security
Highlighted

Enterprise Security: can we extend the cim definition with our own custom fields?

Motivator

The TA mapped our bluecoat index as a Web cim compliant. Looking at our bluecoat index and reports we built on top and some of these fields, that we use are not defined at Web CIM

Therefore, is it possible to extend the cim definition with our own custom fields?

0 Karma
Highlighted

Re: Enterprise Security: can we extend the cim definition with our own custom fields?

Communicator

Sure, it is. You just need to create a new data model that is cloned from the CIM model. (you could just edit the existing - but best be safe during explorations).

1) Start by cloning the original model.

  • System Menu: Settings/Data Model/Clone(under the Edit).
  • We usually append a standard indicator on the name of the original model. Something like "Web_Extended". We also typically Clone the permissions, but you may want to work privately while it's tested.

2) Add the field to a Dataset,

  • From Enterprise Security app menu, go to Search / Datasets. Find your new "Web_Extended" data set and then Manage / Edit Data Model.
  • Click Add Field and Auto Extracted. You will probably see your field there. Give it a Display Name and a Type. Or, add an EVAL to create a new field... up to you

3) Search it.

  • From Enterprise Security app menu, click Search / Datasets again...
  • Scroll down to Web_Extended..
  • Select "Explore / Investigate in Search"

At this point, you'll get a search of " | from datamodel:"Web_Extended.Web" and your new field should be in there. You'll want to change your correlation searches that make use of the Web.Web data model to use your new extended data model instead.

HTH, Good luck.

View solution in original post

Highlighted

Re: Enterprise Security: can we extend the cim definition with our own custom fields?

Splunk Employee
Splunk Employee

Hi,
Thanks for the great Q&A! This topic is now added the CIM guide. However, cloning would create an entirely new model that wouldn't be referenced in any downstream searches. It would require extra diligence mentioned by memarshall63. So that part is not currently included in the instructions:
https://docs.splunk.com/Documentation/CIM/4.13.0/User/UsetheCIMtonormalizedataatsearchtime#7._.28Opt...