Splunk® Enterprise

Updating Splunk Enterprise Instances

Download manual as PDF

This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Download topic as PDF

Exclude content from app updates

You can exclude specified files or directories from app updates. If you enable this feature, the deployment client copies the content the first time it downloads the app but ignores it on future updates of that app. This can be particularly useful for preventing the contents of the /local directory from getting wiped out on update.

This feature requires that both the deployment server and its deployment clients run version 6.2 or higher.

To use this feature, set the excludeFromUpdate attribute in serverclass.conf on the deployment server.

For example, say that you want to prevent app updates from overwriting my-app's /local directory. Assume the app has the typical directory structure:

my-app/
   default/
   local/
       some-conf.conf
       ...

To exclude the content of the /local directory from updates, place the attribute excludeFromUpdate in the my-app stanza of serverclass.conf:

[serverClass:my-class:app:my-app]
excludeFromUpdate = $app_root$/local

When the deployment client downloads the app for the first time, it copies the /local directory and its contents. On subsequent downloads, it completely ignores the directory. Any content already in /local directory on the client remains there. Similarly, any new content in the download's /local directory is ignored.

Note the following:

  • You must use $app_root$ to specify the app root directory.
  • You can exclude single files or entire directories.
  • You can specify excludeFromUpdate at any of the three stanza levels: global, server class, or app. If you specify it at the global level, for example, it excludes the specified content from all apps.
PREVIOUS
Deploy apps to clients
  NEXT
View app deployment status

This documentation applies to the following versions of Splunk® Enterprise: 6.2.0, 6.2.1, 6.2.2, 6.2.3, 6.2.4, 6.2.5, 6.2.6, 6.2.7, 6.2.8, 6.2.9, 6.2.10, 6.2.11, 6.2.12, 6.2.13, 6.2.14, 6.2.15


Comments

What about in a Windows environment. Say I want to exclude a folder from being deployed on a Windows based Universal Forwarder? Would the path change from / to \?

Bkcarter
July 3, 2018

Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters