Splunk® Enterprise

Admin Manual

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

Change default values

Before you begin configuring Splunk Enterprise for your environment, check through the following default settings to see if there's anything you'd like to change.

Set or change environment variables

You can change how Splunk Enterprise starts by setting environment variables on your operating system.

On *nix, use the setenv or export commands to set a particular variable. For example:

# export SPLUNK_HOME = /opt/splunk02/splunk

If you want to set the environment permanently, edit the appropriate shell initialization file and add entries for the variables you want Splunk Enterprise to use when it starts up.

On Windows, use the set environment variable in either a command prompt or PowerShell window:

C:\> set SPLUNK_HOME = "C:\Program Files\Splunk"

If you want to set the environment permanently, use the "Environment Variables" window to add the entry to the "User variables" list.

Windows EnvironmentVariablesList.png

There are several environment variables that are available:

Environment variable Purpose
SPLUNK_HOME The fully-qualified path to the Splunk Enterprise installation directory.
SPLUNK_DB The fully-qualified path to the directory that contains the Splunk Enterprise index directories.
SPLUNK_BINDIP The IP address on the system that Splunk Enterprise should bind to on startup to accept connections. Useful for when a host has more than one live IP address.
SPLUNK_IGNORE_SELINUX Tells Splunk Enterprise to attempt to start when running in Linux host with SELinux enabled. By default, Splunk Enterprise quits immediately when it detects that SELinux is active. This variable defeats that check and can be used in scenarios where you have configured SELinux to allow Splunk Enterprise to work.
SPLUNK_OS_USER Tells Splunk Enterprise to assume the credentials of the user you specify, regardless of what user you started it as. For example, if you specify the user 'splunk' on your system and start Splunk Enterprise as root, it adopts the privileges of the 'splunk' user and any files written by those processes will be owned by the 'splunk' user.
SPLUNK_SERVER_NAME The name of the splunkd service (on Windows) or process (on *nix). Do not set this variable unless you know what you are doing.
SPLUNK_WEB_NAME The name of the splunkweb service (on Windows) or process (on *nix). Do not set this variable unless you know what you are doing.

You can also edit these environment variables for each instance by editing splunk-launch.conf (and, in some cases, web.conf. This is handy when you run more than one Splunk instance on a host. See "splunk-launch.conf".

Changing the admin default password

Splunk with an Enterprise license has a default administration account and password, admin/changeme. Splunk recommends strongly that you change the default. You can do this via Splunk's CLI or Splunk Web.

Use Splunk Web

To change the admin default password:

1. Log into Splunk Web as the admin user.

2. Click Settings in the top-right of the interface.

3. Click Access controls in the Users and Authentication section of the screen.

4. Click Users.

5. Click the admin user.

6. Update the password, and click Save.

Use Splunk CLI

The Splunk CLI command is:

splunk edit user

Important: You must authenticate with the existing password before you can change it. Log into Splunk via the CLI or use the -auth parameter. For example, this command changes the admin password from changeme to foo:

splunk edit user admin -password foo -role admin -auth admin:changeme

Note: On *nix operating systems, the shell interprets some special characters as command directives. You must either escape these characters by preceding them with \ individually, or enclose the password in single quotes ('). For example:

splunk edit user admin -password 'fflanda$' -role admin -auth admin:changeme

or

splunk edit user admin -password fflanda\$ -role admin -auth admin:changeme

On Windows, use the caret (^) to escape reserved shell characters, or enclose the password in double-quotes ("). For example:

splunk edit user admin -password "fflanda>" -role admin -auth admin:changeme

or

splunk edit user admin -password fflanda^> -role admin -auth admin:changeme

Note: You can also reset all of your passwords across servers at once. See "Deploy secure passwords across multiple servers for the procedure.

Change network ports

Splunk configures two ports at installation time:

  • The HTTP/HTTPS port. This port provides the socket for Splunk Web. It defaults to 8000.
  • The management port. This port is used to communicate with the splunkd daemon. Splunk Web talks to splunkd on this port, as does the command line interface and any distributed connections from other servers. This port defaults to 8089.

Important: During installation, you might have set these ports to values other than the defaults.

Note: Splunk instances receiving data from forwarders must be configured with an additional port, the receiver port. They use this port to listen for incoming data from forwarders. This configuration does not occur during installation. The default receiver port is 9997. For more information, see "Enable a receiver" in the Forwarding Data Manual.

Use Splunk Web

To change the ports from their installation settings:

1. Log into Splunk Web as the admin user.

2. Click Settings in the top-right of the interface.

3. Click the Server settings link in the System section of the screen.

4. Click General settings.

5. Change the value for either Management port or Web port, and click Save.

Use Splunk CLI

To change the port settings via the Splunk CLI, use the CLI command set. For example, this command sets the Splunk Web port to 9000:

splunk set  web-port 9000

This command sets the splunkd port to 9089:

splunk set  splunkd-port 9089

Change the default Splunk server name

The Splunk server name setting controls both the name displayed within Splunk Web and the name sent to other Splunk Servers in a distributed setting.

The default name is taken from either the DNS or IP address of the Splunk Server host.

Use Splunk Web

To change the Splunk server name:

1. Log into Splunk Web as the admin user.

2. Click Settings in the top-right of the interface.

3. Click the Server settings link in the System section of the screen.

4. Click General settings.

5. Change the value for Splunk server name, and click Save.

Use Splunk CLI

To change the server name via the CLI, use the set servername command. For example, this command sets the server name to foo:

splunk set servername foo

Changing the datastore location

The datastore is the top-level directory where the Splunk Server stores all indexed data.

Note: If you change this directory, the server does not migrate old datastore files. Instead, it starts over again at the new location.

To migrate your data to another directory follow the instructions in "Move an index".

Use Splunk Web

To change the datastore location:

1. Log into Splunk Web as the admin user.

2. Click Settings in the top-right of the interface.

3. Click the Server settings link in the System section of the screen.

4. Click General settings.

5. Change the path in Path to indexes, and click Save.

6. Use the CLI to restart Splunk. Navigate to $SPLUNK_HOME/bin/ (*nix) or %SPLUNK_HOME%\bin (Windows) and run this command:

splunk restart

Important: Do not use the restart function inside Settings. This will not have the intended effect of causing the index directory to change. You must restart from the CLI.

Use Splunk CLI

To change the datastore directory via the CLI, use the set datastore-dir command. For example, this command sets the datastore directory to /var/splunk/:

splunk set datastore-dir /var/splunk/

Set minimum free disk space

The minimum free disk space setting controls how low disk space in the datastore location can fall before Splunk stops indexing.

Splunk resumes indexing when more space becomes available.

Use Splunk Web

To set minimum free disk space:

1. Log into Splunk Web as the admin user.

2. Click Settings in the top-right of the interface.

3. Click the Server settings link in the System section of the screen.

4. Click General settings.

5. Change the value for Pause indexing if free disk space falls below, and click Save.

Use Splunk CLI

To change the minimum free space value via the CLI, use the set minfreemb command. For example, this command sets the minimum free space to 2000 MB:

splunk set minfreemb 2000

Other default settings

The Splunk Web Settings General Settings screen has a few other default settings that you might want to change. Explore it, to see the range of options.

PREVIOUS
Install your license
  NEXT
Bind Splunk to an IP

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.3.0, 6.3.1, 6.3.2, 6.3.3, 6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.3.8, 6.3.9, 6.3.10, 6.3.11, 6.3.12, 6.3.13


Comments

Your information on Datastore path is incorrect.
Based on Splunk Support the Datastore path cant be set from the web interface any longer:

The documentation team replied with this:

Works: 6.0.12, 6.2.14
Doesn't work: 6.6.0, 6.4.0, 6.3.9

So, it appears this field got locked starting in 6.3.9

Kenoski
February 20, 2017

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