com.splunk

Class WindowsWmiInput

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.Input

com.splunk.WindowsWmiInput

All Implemented Interfaces:

Map<String,Object>

public class WindowsWmiInput
extends Input

The WindowsWmiInput class represents a Windows Management Instrumentation (WMI) 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	getClasses() Returns the WMI class name of this WMI input.
String[]	getFields() Returns the properties (fields) collected for this class for this WMI input.
String	getIndex() Returns the index name of this WMI input.
String[]	getInstances() Returns a list of the WMI class instances for this WMI input.
int	getInterval() Returns the interval at which WMI input providers are queried for this WMI input.
InputKind	getKind() Returns the input kind of this input.
String	getLocalName() Returns the collection name for this WMI input.
String	getLookupHost() Returns the main server for this WMI input.
String	getServers() Returns a list of secondary servers used for monitoring.
String	getWql() Returns the query string for this WMI input.
void	setClasses(String classes) Sets the WMI class name.
void	setDisabled(boolean disabled) Sets whether this input is enabled or disabled.
void	setFields(String field) Sets a property (field) that you want to gather from the given class.
void	setFields(String[] fields) Sets the properties (fields) that you want to gather from the given class.
void	setIndex(String index) Sets the index in which to store all generated events.
void	setInstances(String instance) Sets a counter instance to monitor.
void	setInstances(String[] instances) Sets the counter instances to monitor.
void	setInterval(int interval) Sets the frequency at which the WMI providers are queried.
void	setLookupHost(String lookup_host) Sets the main server from which to monitor log events.
void	setServers(String servers) Sets secondary servers that you want to gather data from.
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

getClasses

public String getClasses()

Returns the WMI class name of this WMI input.

Returns:

The WMI class name.

getFields

public String[] getFields()

Returns the properties (fields) collected for this class for this WMI input.

Returns:

The list of properties collected for this class, or null if not specified.

getIndex

public String getIndex()

Returns the index name of this WMI input.

Returns:

The index name, or null if not specified.

getInstances

public String[] getInstances()

Returns a list of the WMI class instances for this WMI input.

Returns:

A list of the WMI class instances, or null if not specified.

getInterval

public int getInterval()

Returns the interval at which WMI input providers are queried for this WMI input.

Returns:

The WMI query interval, in seconds.

getKind

public InputKind getKind()

Returns the input kind of this input.

Overrides:

getKind in class Input

Returns:

The input kind.

getLookupHost

public String getLookupHost()

Returns the main server for this WMI input. To list secondary servers, use the getServers method.

Returns:

The main server.

See Also:

getServers()

getLocalName

public String getLocalName()

Returns the collection name for this WMI input. This name appears in configuration file, the source, and the sourcetype of the indexed data.

Returns:

The collection name.

getServers

public String getServers()

Returns a list of secondary servers used for monitoring. To list the main server, use the getLookupHost method.

Returns:

A comma-separated list of additional servers, or null if not specified.

See Also:

getLookupHost()

getWql

public String getWql()

Returns the query string for this WMI input.

Returns:

The query string.

setClasses

public void setClasses(String classes)

Sets the WMI class name.

Parameters:

classes - A valid WMI class name.

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.

setFields

public void setFields(String[] fields)

Sets the properties (fields) that you want to gather from the given class.

Parameters:

fields - An array of properties (fields) to gather.

setFields

public void setFields(String field)

Sets a property (field) that you want to gather from the given class. Use this method to set a single field rather than an array.

Parameters:

field - A property (field) to gather.

setIndex

public void setIndex(String index)

Sets the index in which to store all generated events.

Parameters:

index - The index name.

setInstances

public void setInstances(String[] instances)

Sets the counter instances to monitor.

Parameters:

instances - The counter instances to monitor.

setInstances

public void setInstances(String instance)

Sets a counter instance to monitor. Use this method to set a single instance rather than an array.

Parameters:

instance - A counter instance to monitor.

setInterval

public void setInterval(int interval)

Sets the frequency at which the WMI providers are queried.

Parameters:

interval - The polling frequency, in seconds.

setLookupHost

public void setLookupHost(String lookup_host)

Sets the main server from which to monitor log events. To specify additional servers to monitor using WMI, use the setServers method.

Parameters:

lookup_host - The main server.

See Also:

setServers(java.lang.String)

setServers

public void setServers(String servers)

Sets secondary servers that you want to gather data from. Use this method if you need to gather more than a single server. To specify the main server, use the setLookupHost method.

Parameters:

servers - A comma-separated list of additional servers.

See Also:

setLookupHost(java.lang.String)

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