com.splunk

Class WindowsActiveDirectoryInput

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.Input

com.splunk.WindowsActiveDirectoryInput

All Implemented Interfaces:

Map<String,Object>

public class WindowsActiveDirectoryInput
extends Input

The WindowsActiveDirectoryInput class represents a Windows Active Directory data input.

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
String	getIndex() Returns the index name of this Windows Active Directory input.
InputKind	getKind() Returns the input kind of this input.
boolean	getMonitorSubtree() Indicates whether the directory path subtree is being monitored for this Windows Active Directory input.
String	getStartingNode() Returns the starting location in the directory path for this Windows Active Directory input.
String	getTargetDc() Returns the fully-qualified domain name of a valid, network-accessible domain controller.
void	setDisabled(boolean disabled) Sets whether this input is enabled or disabled.
void	setIndex(String index) Sets the index in which to store all generated events.
void	setMonitorSubtree(boolean monitorSubtree) Sets whether to monitor the subtrees of the given directory tree path.
void	setStartingNode(String startingNode) Sets the starting Active Directory directory to start monitoring.
void	setTargetDc(String targetDc) Sets the fully-qualified domain name of a valid, network-accessible domain controller.
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

getIndex

public String getIndex()

Returns the index name of this Windows Active Directory input.

Returns:

The index name, or null if not specified.

getKind

public InputKind getKind()

Returns the input kind of this input.

Overrides:

getKind in class Input

Returns:

The input kind.

getMonitorSubtree

public boolean getMonitorSubtree()

Indicates whether the directory path subtree is being monitored for this Windows Active Directory input.

Returns:

true if the directory path subtree is being monitored, false if not.

getStartingNode

public String getStartingNode()

Returns the starting location in the directory path for this Windows Active Directory input. If not specified, the root of the directory tree is used.

Returns:

The starting location in the directory path, or null if not specified.

getTargetDc

public String getTargetDc()

Returns the fully-qualified domain name of a valid, network-accessible domain controller. If not specified, the local machine is used.

Returns:

The fully-qualified domain name, or null if not specified.

setDisabled

public void setDisabled(boolean disabled)

Sets whether this input is enabled or disabled.

Note: Using this method requires you to restart Splunk before this setting takes effect. To avoid restarting Splunk, use the Entity.disable and Entity.enable methods instead, which take effect immediately.

Parameters:

disabled - true to disable this input, false to enable it.

setIndex

public void setIndex(String index)

Sets the index in which to store all generated events.

Parameters:

index - The index name.

setMonitorSubtree

public void setMonitorSubtree(boolean monitorSubtree)

Sets whether to monitor the subtrees of the given directory tree path.

Parameters:

monitorSubtree - true to monitor subtrees, false if not.

setStartingNode

public void setStartingNode(String startingNode)

Sets the starting Active Directory directory to start monitoring. If this value is not specified, Splunk attempts to start monitoring at the root of the directory tree.

Parameters:

startingNode - The starting Active Directory directory.

setTargetDc

public void setTargetDc(String targetDc)

Sets the fully-qualified domain name of a valid, network-accessible domain controller. If this value is not specified, Splunk obtains the local computer's domain controller.

Parameters:

targetDc - The fully-qualified domain name.

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