com.splunk
Class DeploymentServer

java.lang.Object
  extended by com.splunk.Resource
      extended by com.splunk.Entity
          extended by com.splunk.DeploymentServer
All Implemented Interfaces:
java.util.Map<java.lang.String,java.lang.Object>

public class DeploymentServer
extends Entity

The DeploymentServer class represents a Splunk deployment server, and provides access to the configurations of all deployment servers.


Nested Class Summary
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Method Summary
 java.lang.String getWhitelistByIndex(int index)
          Returns inclusive criteria for determining deployment client access to this deployment server.
 void setDisabled(boolean disabled)
          Sets whether the deployment server is enabled or disabled.
 
Methods inherited from class com.splunk.Entity
clear, containsKey, containsValue, disable, enable, entrySet, get, getMetadata, isDisabled, isEmpty, keySet, put, putAll, refresh, remove, remove, size, update, update, validate, values
 
Methods inherited from class com.splunk.Resource
getName, getPath, getService, getTitle, invalidate
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.util.Map
equals, hashCode
 

Method Detail

getWhitelistByIndex

public java.lang.String getWhitelistByIndex(int index)
Returns inclusive criteria for determining deployment client access to this deployment server.

Parameters:
index - The index of the whitelist entry to return.
Returns:
A list of included client addresses, or null if not specified.

setDisabled

public void setDisabled(boolean disabled)
Sets whether the deployment server 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 the deployment client, false to enable it.
See Also:
Entity.disable(), Entity.enable()