deployment.conf
This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
deployment.conf
deployment.conf contains settings for configuring both deployment servers and clients.
deployment.conf.spec
# Copyright (C) 2005-2007 Splunk Inc. All Rights Reserved. Version 3.0
# This file contains possible attributes and values for configuring deployment in deployment.conf.
[distributedDeployment]
serverClassPath = <path>
* The directory which contains the base of your server class bundles.
* Defaults to $SPLUNK_HOME/etc/modules/distributedDeployment/classes.
[distributedDeployment-classMaps]
www.* = web,apache
10.1.*.1 = osx
* Map IP ranges or DNS addresses to server classes.
* You can put a wildcard (*) anywhere in the string.
# The following settings are only for multicast configuration (as opposed to polling):
[distributedDeployment-multicast]
* Only use this group of tags if you are using multicast to notify deployment clients
sendMulticast = <true/false>
* To use multicast, set this to true.
* Defaults to false.
multicastUri = <IP:Port>
* What multicast group to send to.
* Only used if 'sendMulticast = true'.
* If this is not specified, multicast will be turned off
* No default.
interfaceIP = <IP Address>
* The IP address of the interface to send mcast packets on.
* Defaults to whatever the kernel picks (usually sufficient).
frequency = <integer>
* How often (in seconds) to send multicast packets.
* Defaults to 30 seconds.
useDNS = <true/false>
* Lookup host name.
* Defaults to false.
#******************************************************************************
# The following configurations are only for Splunk instances that will act as
# deployment clients (deployed by a deployment server).
# PLEASE NOTE: you will not need to set these in deployment.conf if you enable the client
# from the command line using ./splunk set deploy. These settings are written out automatically.
[deployment-client]
deploymentServerUri = <IP:Port, IP2:Port2, etc>
* List of deployment server to poll.
* This can be used concurrently with multicast, but is typically used instead.
pollingFrequency = <integer>
* How often (in seconds) to poll each deployment server listed in 'deploymentServerUri'.
* Only used if deploymentServerUri is specified.
maxBackoff = <integer>
* Back off randomly between 0 and this number (in seconds) polling the deployment server.
* The more deployment clients controlled by a single deployment server, the higher this number should be.
* maxBackoff effectively "smooths" the number of concurrent requests on the server.
serverClasses = <comma separated list>
* List of server classes that this deployment client is a member of.
* Usually set on the server side, under [distributedDeployment-classMaps]
# Multicast configuration -- these settings are only necessary if you are using multicast.
multicastUri = <IP:Port, IP2:Port2, etc>
* A comma-separated list of multicast address for deployment server instructions.
* Each deployment server needs to be in control over a unique set of server classes.
* Typically there is only zero or one entry in this list.
mcastInterfaceIp = <IP Address>
* Use the physical interface bound to this IP address for listening to muliticasts.
* Only set this if using multicast.
deployment.conf.example
# Copyright (C) 2005-2007 Splunk Inc. All Rights Reserved. Version 3.0 # # EXAMPLE deployment.conf # # You can use this example configuration file to customize your deployment. # # Path to the server class configuration files. # By default, this example directory does not exist -- you must create your own. [distributedDeployment] serverClassPath=/opt/splunk/etc/modules/distributedDeployment/classes # Enable multicast [distributedDeployment-multicast] sendMulticast=true multicastUri=225.0.0.39:9999 # Map server classes to host names and IP addresses [distributedDeployment-classMaps] www.* = web,apache 10.1.1.2* = osx # # The following stanza enables a distributed deployment client # which listens on the same mcast IP as the above server sends on # [deployment-client] multicastUri=225.0.0.39.9999
This documentation applies to the following versions of Splunk: 3.1.4 View the Article History for its revisions.