com.splunk

Class Settings

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.Settings

All Implemented Interfaces:

Map<String,Object>

public class Settings
extends Entity

The Settings class represents configuration information for an instance of Splunk.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.splunk.Entity

content, toUpdate

Fields inherited from class com.splunk.Resource

actions, path, refreshArgs, service, title, updated

Method Summary

Modifier and Type	Method and Description
boolean	getEnableSplunkWebSSL() Indicates whether SSL is enabled on the Splunk management port.
String	getHost() Returns the default host name to use for data inputs.
int	getHttpPort() Returns the port on which Splunk Web is listening for this instance of Splunk.
int	getMgmtPort() Returns the IP address:port number for Splunkd.
int	getMinFreeSpace() Returns the amount of free disk space that is required for Splunk to continue searching and indexing.
String	getPass4SymmKey() Returns the string that is prepended to the Splunk symmetric key to generate the final key that used to sign all traffic between master and slave licensers.
String	getServerName() Returns the name that is used to identify this Splunk instance for features such as distributed search.
String	getSessionTimeout() Returns the amount of time before a user session times out.
String	getSplunkDB() Returns the fully-qualified path to the directory containing the default index for this instance of Splunk.
String	getSplunkHome() Returns the fully-qualified path to the Splunk installation directory.
boolean	getStartWebServer() Indicates whether the instance is configured to start Splunk Web.
String	getTrustedIP() Returns the IP address of the authenticating proxy.
void	setEnableSplunkWebSSL(boolean useHttps) Sets whether Splunk Web uses HTTP or HTTPS.
void	setHost(String host) Sets the default host name to use for data inputs that do not override this setting.
void	setHttpPort(int port) Sets the Splunk Web listening port.
void	setMgmtPort(int port) Sets the management port for splunkd.
void	setMinimumFreeSpace(int minFreeSpace) Sets the amount of free disk space that must exist for splunkd to continue operating.
void	setPasswordSymmKey(String pass4SymmKey) Sets the password string that is prepended to the Splunk symmetric key to generate the final key, which is used to sign all traffic between master/slave licensers.
void	setServerName(String serverName) Sets the name that is used to identify this Splunk instance for features such as distributed search.
void	setSessionTimeout(String sessionTimeout) Sets the session timeout.
void	setSplunkDBPath(String path) Sets the fully-qualified local path to the default index.
void	setStartWebServer(boolean startwebserver) Sets whether to start Splunk Web.
void	setTrustedIP(String trustedIP) Sets the IP address of the authenticating proxy.
void	update() Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.
void	update(Map<String,Object> args) Updates the entity with the values you previously set using the setter methods, and any additional specified arguments.

Methods inherited from class com.splunk.Entity

actionPath, clear, containsKey, containsValue, disable, enable, entrySet, get, getContent, getMetadata, isDisabled, isEmpty, isNameChangeAllowed, keySet, put, putAll, refresh, remove, remove, size, validate, values

Methods inherited from class com.splunk.Resource

getName, getPath, getService, getTitle, getUpdated, invalidate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Method Detail

getSplunkDB

public String getSplunkDB()

Returns the fully-qualified path to the directory containing the default index for this instance of Splunk.

Returns:

The path to the Splunk index directory.

getSplunkHome

public String getSplunkHome()

Returns the fully-qualified path to the Splunk installation directory.

Returns:

The path to the Splunk installation directory.

getEnableSplunkWebSSL

public boolean getEnableSplunkWebSSL()

Indicates whether SSL is enabled on the Splunk management port.

Returns:

true if SSL is enabled, false if not.

getHost

public String getHost()

Returns the default host name to use for data inputs.

Returns:

The host name.

getHttpPort

public int getHttpPort()

Returns the port on which Splunk Web is listening for this instance of Splunk. The port number defaults to 8000.

Returns:

The Splunk Web port number.

getMgmtPort

public int getMgmtPort()

Returns the IP address:port number for Splunkd.

Returns:

The IP address:port number.

getMinFreeSpace

public int getMinFreeSpace()

Returns the amount of free disk space that is required for Splunk to continue searching and indexing.

Returns:

The required amount of free disk space, in megabytes.

getPass4SymmKey

public String getPass4SymmKey()

Returns the string that is prepended to the Splunk symmetric key to generate the final key that used to sign all traffic between master and slave licensers.

Returns:

Licenser symmetric key.

getServerName

public String getServerName()

Returns the name that is used to identify this Splunk instance for features such as distributed search.

Returns:

The name used to identify the Splunk instance.

getSessionTimeout

public String getSessionTimeout()

Returns the amount of time before a user session times out.

Returns:

The session time-out.

getStartWebServer

public boolean getStartWebServer()

Indicates whether the instance is configured to start Splunk Web.

Returns:

true if the instance is configured to start Splunk Web, false if Splunk Web is disabled.

getTrustedIP

public String getTrustedIP()

Returns the IP address of the authenticating proxy.

Returns:

The IP address of the authenticating proxy.

setSplunkDBPath

public void setSplunkDBPath(String path)

Sets the fully-qualified local path to the default index. The default value is $SPLUNK_HOME/var/lib/splunk/defaultdb/db/.

Parameters:

path - The local path to the default index.

setEnableSplunkWebSSL

public void setEnableSplunkWebSSL(boolean useHttps)

Sets whether Splunk Web uses HTTP or HTTPS.

Parameters:

useHttps - true to use SSL and HTTPS, false to use HTTP.

setHost

public void setHost(String host)

Sets the default host name to use for data inputs that do not override this setting.

Parameters:

host - The default host name.

setHttpPort

public void setHttpPort(int port)

Sets the Splunk Web listening port. If Splunk uses SSL and HTTPS, this value should be set to the HTTPS port number.

Note: The port must be present for Splunk Web to start. If this value is omitted or set to 0, the server will not start an HTTP listener.

Parameters:

port - The Splunk Web listening port.

See Also:

getEnableSplunkWebSSL()

setMgmtPort

public void setMgmtPort(int port)

Sets the management port for splunkd. The default value is 8089.

Parameters:

port - The port for the management interface.

setMinimumFreeSpace

public void setMinimumFreeSpace(int minFreeSpace)

Sets the amount of free disk space that must exist for splunkd to continue operating.

Before attempting to run a search, Splunk requires this amount of free space on the file system where the dispatch directory is stored ($SPLUNK_HOME/var/run/splunk/dispatch).

Parameters:

minFreeSpace - The minimum free space, in megabytes.

setPasswordSymmKey

public void setPasswordSymmKey(String pass4SymmKey)

Sets the password string that is prepended to the Splunk symmetric key to generate the final key, which is used to sign all traffic between master/slave licensers.

Parameters:

pass4SymmKey - The prepended password string.

setServerName

public void setServerName(String serverName)

Sets the name that is used to identify this Splunk instance for features such as distributed search. The default value is <hostname>-<user running splunk>.

Parameters:

serverName - The server name.

setSessionTimeout

public void setSessionTimeout(String sessionTimeout)

Sets the session timeout. The valid format is number followed by a time unit ("s", "h", or "d").

Parameters:

sessionTimeout - The session timeout value.

setStartWebServer

public void setStartWebServer(boolean startwebserver)

Sets whether to start Splunk Web.

Parameters:

startwebserver - true to start Splunk Web, false if not.

setTrustedIP

public void setTrustedIP(String trustedIP)

Sets the IP address of the authenticating proxy. Set this value to a valid IP address to enable SSO. This attribute is disabled by default. The normal value is "127.0.0.1".

Parameters:

trustedIP - The authenticating proxy's IP address.

update

public void update(Map<String,Object> args)

Updates the entity with the values you previously set using the setter methods, and any additional specified arguments. The specified arguments take precedent over the values that were set using the setter methods.

Overrides:

update in class Entity

Parameters:

args - The arguments to update.

update

public void update()

Updates the entity with the accumulated arguments, established by the individual setter methods for each specific entity class.

Overrides:

update in class Entity