Splunk® Enterprise

Search Reference

Download manual as PDF

NOTE - Splunk version 4.x reached its End of Life on October 1, 2013. Please see the migration information.
Download topic as PDF

crawl

Description

Crawls the file system to discover new sources to index, using built-in settings.

Syntax

| crawl [ files | network ] [<crawl-option>...]

Optional arguments

crawl-option
Syntax: <string>=<string>
Description: Overrides the settings in the crawl.conf file.

Usage

The default crawl settings are found in the crawl.conf file. If you have Splunk Enterprise, you can view a log of crawl operations in the $SPLUNK_HOME/var/log/splunk/crawl.log file. This command is generally used in conjunction with the input command.

The crawl command is a generating command and should be the first command in the search. Generating commands use a leading pipe character.

When you add the crawl command to a search, the search returns only data that is generated from the crawl command. The search does not return any data generated before the crawl command.

Examples

Example 1:

crawl root and home directories and add all possible inputs found. Adds configuration information to "inputs.conf".

| crawl root="/;/Users/" | input add

Example 2:

Crawl bob's home directory.

| crawl root=/home/bob

Example 3:

Add all sources found in bob's home directory to the 'preview' index.

| crawl root=/home/bob | input add index=preview

Example 4:

Use the default settings defined in the crawl.conf file.

| crawl

See also

input

Answers

Have questions? Visit Splunk Answers and see what questions and answers the Splunk community has using the crawl command.

PREVIOUS
correlate
  NEXT
dbinspect

This documentation applies to the following versions of Splunk® Enterprise: 4.3, 4.3.1, 4.3.2, 4.3.3, 4.3.4, 4.3.5, 4.3.6, 4.3.7, 5.0, 5.0.1, 5.0.2, 5.0.3, 5.0.4, 5.0.5, 5.0.6, 5.0.7, 5.0.8, 5.0.9, 5.0.10, 5.0.11, 5.0.12, 5.0.13, 5.0.14, 5.0.15, 5.0.16, 6.0, 6.0.1, 6.0.2, 6.0.3, 6.0.4, 6.0.5, 6.0.6, 6.0.7, 6.0.8, 6.0.9, 6.0.10, 6.0.11, 6.0.12, 6.1, 6.1.1, 6.1.2, 6.1.3, 6.1.4, 6.1.5, 6.1.6, 6.1.7, 6.1.8, 6.1.9, 6.1.10, 6.1.11, 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.3.0, 6.3.1, 6.3.2, 6.3.3, 6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.4.0, 6.4.1, 6.4.2, 6.4.3


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