com.splunk

Class OutputServer

java.lang.Object

com.splunk.Resource

com.splunk.Entity

com.splunk.OutputServer

All Implemented Interfaces:

Map<String,Object>

public class OutputServer
extends Entity

The OutputServer class represents an output server, providing access to data-forwarding configurations.

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
OutputServerAllConnections	allConnections() Returns an object that contains all current connections to the output server.
String	getClientCert() Returns client certificate path.
String	getDestHost() Returns the DNS name of the destination server for this connection.
String	getDestIp() Returns the IP address of the destination server for this connection.
int	getDestPort() Return the port on which the destination server is listening.
String	getMethod() Returns the data distribution method used when two or more servers exist in the same forwarder group.
int	getSourcePort() Returns the port on the destination server where data is forwarded.
String	getStatus() Returns the server connection status (usually "connect_done", "connect_fail", or "connect_try").
void	setClientCert(String clientCert) Sets the client certificate path which is being supported in recent versions.
void	setMethod(String method) Sets the type of data distribution method when two or more servers exist in the same forwarder group.
void	setSslAltNameToCheck(String sslAltNameToCheck) Sets the alternate name to match in the remote server's SSL certificate.
void	setSslCertPath(String sslCertPath) Sets the path to the client certificate.
void	setSslCipher(String sslCipher) Sets the SSL cipher in the form: ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM
void	setSslCommonNameToCheck(String sslCommonNameToCheck) Sets the name against which to check the common name of the server's certificate.
void	setSslPassword(String sslPassword) Sets the password associated with the PEM file store.
void	setSslRootCAPath(String sslRootCAPath) Sets the path to the root certificate authority file.
void	setSslVerifyServerCert(boolean sslVerifyServerCert) Sets whether the server being connected to is authenticated.

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, update, update, 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

getDestHost

public String getDestHost()

Returns the DNS name of the destination server for this connection.

Returns:

The destination host name.

getDestIp

public String getDestIp()

Returns the IP address of the destination server for this connection.

Returns:

The IP address of the destination server.

getDestPort

public int getDestPort()

Return the port on which the destination server is listening.

Returns:

The destination port.

getMethod

public String getMethod()

Returns the data distribution method used when two or more servers exist in the same forwarder group. Valid values are: "clone", "balance", and "autobalance".

Returns:

The data distribution method.

getSourcePort

public int getSourcePort()

Returns the port on the destination server where data is forwarded.

Returns:

The source port.

getStatus

public String getStatus()

Returns the server connection status (usually "connect_done", "connect_fail", or "connect_try").

Returns:

The connection status.

getClientCert

public String getClientCert()

Returns client certificate path.

Returns:

Path of client certificate.

setMethod

public void setMethod(String method)

Sets the type of data distribution method when two or more servers exist in the same forwarder group. Valid values are: "clone", "balance", and "autobalance".

Parameters:

method - The data distribution method.

setSslAltNameToCheck

public void setSslAltNameToCheck(String sslAltNameToCheck)

Sets the alternate name to match in the remote server's SSL certificate.

Parameters:

sslAltNameToCheck - The alternate name.

setSslCertPath

public void setSslCertPath(String sslCertPath)

Sets the path to the client certificate. If a path is specified, the connection uses SSL.

Parameters:

sslCertPath - The path to the client certificate.

setSslCipher

public void setSslCipher(String sslCipher)

Sets the SSL cipher in the form: ALL:!aNULL:!eNULL:!LOW:!EXP:RC4+RSA:+HIGH:+MEDIUM

Parameters:

sslCipher - The SSL cipher.

setSslCommonNameToCheck

public void setSslCommonNameToCheck(String sslCommonNameToCheck)

Sets the name against which to check the common name of the server's certificate. If there is no match, you can assume that Splunk is not authenticated against this server. You must set a value for this parameter if SslVerifyServerCert is true.

Parameters:

sslCommonNameToCheck - The SSL common name.

See Also:

setSslVerifyServerCert(boolean)

setSslPassword

public void setSslPassword(String sslPassword)

Sets the password associated with the PEM file store.

Parameters:

sslPassword - The password.

setSslRootCAPath

public void setSslRootCAPath(String sslRootCAPath)

Sets the path to the root certificate authority file.

Parameters:

sslRootCAPath - The path to the root certificate authority file.

setSslVerifyServerCert

public void setSslVerifyServerCert(boolean sslVerifyServerCert)

Sets whether the server being connected to is authenticated. Both the common name and the alternate name of the server are checked for a match.

Parameters:

sslVerifyServerCert - true to determine whether the server is authenticated, false if not.

setClientCert

public void setClientCert(String clientCert)

Sets the client certificate path which is being supported in recent versions.

Parameters:

clientCert - The path for client certificate.

allConnections

public OutputServerAllConnections allConnections()

Returns an object that contains all current connections to the output server.

Returns:

The OutputServerAllConnections object.