Configuration Reference Guide

XrdProofdProtocol directives

To load the XrdProofd plugin the following directive must be included in the xrootd config file:

xrd.protocol xproofd [:port] [path] libXrdProofd.so

xrd.protocol xproofd [:port] [path] libXrdProofd.so

Here port is the port chosen for PROOF (default 1093) and path is the path containing the libXrdProofd.so plug-in .

The directives governing the behaviour of xproofd all begin with "xpd." . These directives are processed via the dedicated tools available for this purpose in the SCALA package. Therefore the standard SCALLA if-else-fi constructs and other features (e.g variable replacement) are automatically supported. Support for the old-style 'if ' constructs, e.g.


  xpd.role worker if lxb*.cern.ch
  xpd.role master if lxp*.cern.ch

is deprecated but still kept for backward compatibility.

Unless differently specified, patterns may contain any number of wild cards; the best match is retained (max number of matching chars; if two are equal, the last specified wins).

The following directives are recognized:

adminreqto

xpd.adminreqto sec

xpd.adminreqto sec

Function: Defines the timeout on requests broadcast to workers; as there are 4 attempts, so the actual timeout is 4 times this number
Default: 30 secs
Example: xpd.adminreqto 15

allow

xpd.allow node

xpd.allow node

Function: Define the master node(s) allowed to connect. This directive is ignored by masters. Multiple 'allow' directives can be specified.
Default: all type of connection allowed.
Example: xpd.allow lxb6041.cern.ch

allowedusers

xpd.allowedusers [-]usr1,[-]usr2,...

xpd.allowedusers [-]usr1,[-]usr2,...

Function: Defines a list of users allowed to connect to the cluster. Users can be denied to connect by prefixing the name by '-'. Users explicitely authorized via this directive are allowed to connect regardless of the xpd.allowedgroups settings for their UNIX or PROOF group.
Default: All users (with an entry in the password file, if not in multiuser mode) are allowed to connect.
Example: xpd.allowedusers usr1,usr2,usr3; See also the Controlling Access section.

allowedgroups

xpd.allowedgroups grp1,grp2,...

xpd.allowedgroups grp1,grp2,...

Function: Defines the list of UNIX or PROOF groups allowed to connect to the cluster. Groups can be denied to connect by prefixing the name by '-'. Either group must be explicitly allowed with the other not explicitly denied. Starting from version 5.34/19 UNIX groups can be either primary or secondary.
Default: If this directive is missing all users (with an entry in the password file, if not in multiuser mode) are allowed to connect.
Example: xpd.allowedgroups grp1,grp2,grp3; See also the Controlling Access section.

bonjour

xpd.bonjour mode [servicetype=type] [name=name] [domain=dns] [cores=number]

xpd.bonjour mode [servicetype=type] [name=name] [domain=dns] [cores=number]

Function

Enables and defines the options for the Bonjour/Zeroconf node discovery and publish service

Parameters

mode

Mandatory parameter. Its value can be one of the following:

register | publish: the PROOF node will register on the local multicast responder, publishing itself on the network. This is intended for worker nodes.
discover | browse: the node will discover other PROOF nodes from the multicast resolver and will keep an updated list of them. This works like a subscription and the list will be updated dynamically. Is also possible to establish also a list of static workers using the worker directive at the same time. This is intended for master nodes.
both | all: enable both the publishing and the registering features at the same time.

servicetype

Defines the name of the service type to search for or to publish. It must conform to the Zeroconf guidelines defined in RFC 2782 (there is also a list of common service names). This name is intended to identify the class of the service and all the machines in the cluster must use the same. Also, a categorization of machines can be done using this parameter.

name

The name of the instance. This name identifies in a unique way the name of the instance, it is like a DNS hostname (but it is not, and it will translated to a hostname and IP address by the system).

domain

Custom domain used to publish the services. By default, the local domain is used, but one can use a DNS domain like cern.ch (note that proper DNS server configuration is needed).

cores

In the case of a worker machine, sets the number of workers that will be started in that machine when a PROOF session is opened. This is useful for multicore machines.

Default

servicetype = _proof._tcp. , name = hostname of the machine, domain = local. , cores = 1

Notes

To be correctly honored, any port specification via xpd.port must appear in the configuration file before the xpd.bonjour directive.

Example

xpd.bonjour register servicetype=_xproofd._tcp name=worker1 cores=8

clientmgr

xpd.clientmgr checkfq:[seconds] activityto:[seconds]

xpd.clientmgr checkfq:[seconds] activityto:[seconds]

Function

Defines the parameters controlling the client manager

Parameters

checkfq: defines the frequency in secs of the regular checks performed on client activities
activityto: defines the timeout in secs to consider inactive a client connection

Default

checkfq = 60 secs, activityto = 1200 secs

Example

xpd.clientmgr checkfq:120

cpcmd

xpd.cpcmd protocol cmd put:{1\|0} fmt:[format string]

xpd.cpcmd protocol cmd put:{1|0} fmt:[format string]

Function

Enable or disable a file transfer command to move files in or our of the sandbox.

Parameters

protocol
The protocol string on the base of which this command is chosen; if this string is prefixed with '-' this protocol is disabled
cmd
The actual command to be run for the movement
put

0: this command can only be used to retrieve files (e.g. wget)
1: this command can be used in both directions

fmt
The format to be used to build the command; it must contain two '%s' converters or, respectively, the source and destination paths, and the relevant options
Default

the standard cp is used for internal moves; xrdcp to handle 'root' or 'xrd' protocols; 'wget' ('curl' on MacOsX) to handle 'http' or 'https' protocols (retrieve only)

Examples

xpd.cpcmd -http

xpd.cpcmd alien aliencp put:1 fmt:%s %s

datadir

xpd.datadir datadir [options]

xpd.datadir datadir [options]

Function

Define the root for the user data directories and their write permissions.

Parameters

datadir
Directory under which the user data directories are created, in the form datadir/group/user/ordinal/session-tag .
opt
Options controlling where to create the directories and the write permissions. Options are entered as single letters with the following meaning: g extend write permissions to the group members; o or a extend write permissions to all users; W assert directories only on worker nodes;
M assert directories only on non-worker nodes; If the option string is absent no action or check is done on the directories (they will be created by proofserv).

Default

No action.

Example

xpd.datadir /data/proof aW

datasetsrc

xpd.datasetsrc type url:URL opt:[options string] rw:{1\|0}

xpd.datasetsrc type url:URL opt:[options string] rw:{1|0}

Function

Define the source for dataset meta information. Currently only file-based repositories are suppo

Parameters

type
String defining the type of the repository; currently only file-based repositories are supported; the tag for these is "file".
url
The entry point for the repository; for file-based repositories this is the full path to the directory with the dataset information; for read-only repositories the directory can also be remote; files are handled via the protocol-driven TFile and TSystem ROOT interfaces.
opt
Options to be passed to the dataset manager instance. See the dataset manager description.
rw

0: the repository is read-only [default]
1: the repository can be modified

Examples

xpd.datasetsrc file url:root://alicecaf.cern.ch:11094//dataset-xpd opt:-Ar:-Av: rw:0

xpd.datasetsrc file url:/data2/dataset opt:Av:As:

exportpath

xpd.exportpath path1[,path2] [path3[,path4[,...]]]

xpd.exportpath path1[,path2] [path3[,path4[,...]]]

Function: Defines a list of comma- or black- separated paths which can be browsed by all users using the admin functionality (ls, more, ...); many of these directives can be specified.
Default: none
Example: xpd.exportpath /tmp,/data2 /pool/proofbox

filterlibpaths

xpd.filterlibpaths 1\|0 [path1[,path2] [path3[,path4[,...]]]]

xpd.filterlibpaths 1|0 [path1[,path2] [path3[,path4[,...]]]]

Function: Allows to remove paths from the library path (LD_LIBRARY_PATH or equivalent) passed to proofserv. The first switch refers to the ROOT library path, i.e. $ROOTSYS/lib; the rest is the list of additional paths to be removed.
Default: As of ROOT 5.30/03, ROOT 5.28/00h, 5.32/00, the library path passed to proofserv is exactly the same as the one seen by xproofd. In previous versions the ROOT library path was removed.
Example: xpd.filterlibpaths 1

groupfile

xpd.groupfile path

xpd.groupfile path

Function: Defines the path to the file containing the definition of the groups. For an example of the file see $ROOTSYS/etc/proof/xpd.groups.sample.
Default: none
Example: xpd.groupfile $ROOTSYS/etc/proof/xpd.groups

image

xpd.image image

xpd.image image

Function: Define the image name for this server
Default: node fully-qualified domain name
Example: xpd.image nfs

intwait

xpd.intwait sec

xpd.intwait sec

Function: Defines the timeout for waits internal to xproofd (in seconds). Increasing this to O(min) is needed for debugging operations.
Default: 5 seconds
Example: xpd.intwait 500

localwrks

xpd.localwrks nwrks

xpd.localwrks nwrks

Function: Defines the number of workers for local sessions.
Default: the number of CPUs in the local machine
Example: xpd.localwrks 2

maxoldlogs

xpd.maxoldlogs max

xpd.maxoldlogs max

Function: Define maximum number of old PROOF sessions for which the working directory is kept with all the relevant files in (logs, env, ...); non-positive values mean no limit
Default: 10
Example: xpd.maxoldlogs 50

maxsessions

xpd.maxsessions max

xpd.maxsessions max

Function: Defines the maximum number of concurrent PROOF sessions that a client can have on the cluster; -1 indicates no limit.
Default: -1
Example: xpd.maxsessions 1

multiuser

xpd.multiuser opt [subWORKdir]

xpd.multiuser opt [subWORKdir]

Function

Enable/disable multi-user mode.

Parameters

opt: 0 OFF: only the effective user of the daemon can start a PROOF session;
1 ON: all connecting users are served (if allowed according to xpd.allowedusers - see below);

subWORKdir

Template for the user working areas; supported keywords:

the working directory (see xpd.workdir)

the effective owner of the daemon

the target username

the initial of the target username

Default

The default for this switch is OFF; when switched on, the default template for the sub-directories is //user//

Example

xpd.multiuser 1

Notes

The user areas (sandboxes) and the proofserv processes will be owned by the reference effective user (the owner of the daemon or the effective user to which the username has been mapped - see xpd.umap); in particular, the privacy of the user areas is not ensured.

namespace

xpd.namespace name

xpd.namespace name

Function: namespace for the local storage if different from defaults.
Default: by the default it is assumed that the pool space on the cluster is accessed under the common namespace /proofpool.
Example: xpd.namespace /store

poolurl

xpd.poolurl pool

xpd.poolurl pool

Function: URL for the local storage if different from defaults.
Default: by the default it is assumed that the pool space on the cluster is accessed via a redirector running at the top master.
Example: xpd.poolurl lxb0105.cern.ch

port

xpd.port port

xpd.port port

Function: Define the port where the daemon is listening.
Default: The default port for PROOF is 1093.
Example: xpd.port 11093

priority

xpd.priority delta-priority [if auser]

xpd.priority delta-priority [if auser]

Function: Modify the priority of sessions belonging to auser by delta-priority ; if auser is missing, apply the change to all sessions. This directive requires special privileges, so it may be ineffective if the latters are missing
Default: No change in priority
Example: xpd.priority 4

proofplugin

xpd.proofplugin prefix

xpd.proofplugin prefix

Function: Specify the prefix for the TProof implementation plug-in to be used on the master. The plug-in is loaded by the ROOT plugin manager. This directive is needed, for example, when working with Condor.
Default: none
Example: xpd.proofplugin condor:

proofservmgr

xpd.proofservmgr [checkfq:sec] [termto:sec] [verifyto:sec] [recoverto:sec] [checklost:0\|1] [usefork:0\|1]

xpd.proofservmgr [checkfq:sec] [termto:sec] [verifyto:sec] [recoverto:sec] [checklost:0|1] [usefork:0|1]

Function

Defines the parameters controlling the PROOF sessions manager

Parameters

checkfq: defines the frequency in secs of the regular checks performed on sessions
termto: defines the time in secs given to sessions to terminate gently
verifyto: defines the time in secs to proof that they are still alive by touching their admin path
recoverto: defines the time in secs given to a session to recover its connection after being asked to do so
checklost: toggles on/off the check for orpheline proofserv processes; the serach is based on the process name; default is on, but when running with applications like valgrind which may modify the process string, it may be useful to have it off.
usefork: toggles the usage of 'fork' to start a proofserv process; if set to 0, proofserv is launched using 'system', as in PROOF-Lite.

Default

checkfq = 60 secs, termto = checkfq - 10 secs, verifyto = 3 * checkfq , recoverto = 10 secs, checklost:1, usefork:1

Example

xpd.proofservmgr checkfq:120 verifyto:120 usefork:0

putenv

xpd.putenv [u:usr1,usr2,...] [g:gr1,gr2,...] [s:[svnmi][-][svnmx]] [v:[versmi][-][versmx]] variable

xpd.putenv [u:usr1,usr2,...] [g:gr1,gr2,...] [s:[svnmi][-][svnmx]] [v:[versmi][-][versmx]] variable

Function: Set additional environment variable for 'proofserv'. This is useful, for instance, to set client-side security options.
Parameters
usr1,usr2,...
User(s) to which this setting applies; can contain the wild card '*'
grp1,grp2,...
Group(s) to which this setting applies; can contain the wild card '*'
svnmi (svnmx)
minimum (maximum) SVN revision number for which this setting applies
versmi (versmx)
minimum (maximum) ROOT version numbers for which this setting applies: variable; Variable to be set; it can contain the following place holders which will be replaced before launching 'proofserv':

	replaced with WORKdir (see above)
	replaced with the machine host name
	replaced with the user $HOME dir (as returned by getpwuid)
	replaced with the user's username
	replaced with the users's PROOF group
	replaced with the users's UNIX user id
	replaced with the users's UNIX group id

Notes

Support for selective setting has been introduced in ROOT version 5.28/00 .

Default

none

Example

xpd.putenv MYENV=//.creds

xpd.putenv g:z2 PROOF_VIRTMEMMAX=1000

putrc

xpd.putrc [u:usr1,usr2,...] [g:gr1,gr2,...] [s:[svnmi][-][svnmx]] [v:[versmi][-][versmx]] variable

xpd.putrc [u:usr1,usr2,...] [g:gr1,gr2,...] [s:[svnmi][-][svnmx]] [v:[versmi][-][versmx]] variable

Function: Set an additional rootrc-like variable for 'proofserv'. This allows to have full control on the parameters needed by 'proofserv' from one configuration file.
Parameters
usr1,usr2,...
User(s) to which this setting applies; can contain the wild card '*'
grp1,grp2,...
Group(s) to which this setting applies; can contain the wild card '*'
svnmi (svnmx)
minimum (maximum) SVN revision number for which this setting applies
versmi (versmx)
minimum (maximum) ROOT version numbers for which this setting applies: variable; variable to be set in the form: .:; (there can be a space between the colon after the name and the value).
Notes
Support for selective setting has been introduced in ROOT version 5.28/00 .
Default: none
Example: xpd.putrc Packetizer.MaxWorkersPerNode: 8; xpd.putrc v:52706- Proof.SchemaEvolution: 0

reconnto

xpd.reconnto sec

xpd.reconnto sec

Function: Defines the time in secs given to clients to reconnect after a xrootd restart. This directive is used both by the client and session managers.
Default: 300 secs
Example: xpd.reconnto 120

resource

xpd.resource source [cfg-file] [ucfg:ucfg-opt] [wmx:max-wrks] [selopt:mode]

xpd.resource source [cfg-file] [ucfg:ucfg-opt] [wmx:max-wrks] [selopt:mode]

Function

Define the way the composition of the PROOF sessions for a given user is determined

Parameters

source: source of information; only static (from a static configuration file) enabled for the time being
cfg-file: location of the static configuration file; on-the-fly changes to this file are automatically detected (no need to restart the daemon). Default if $ROOTSYS/etc/proof.conf .
ucfg-opt: enables ("yes") or disables ("no") user private configuration files. If enabled, are looked for at $HOME/.proof.conf or $HOME/.usr_cfg , where usr_cfg is the second argument to TProof::Open("master","usr_cfg" ; by default user private files are disabled.
mode: specify the way workers are chosen (for positive max-workers ); options are:
"roundrobin" : round-robin selection in bunches of n (= max-workers) workers. Example: N = 10 (available workers), n = 4: 1st (session): 1-4, 2nd: 5-8, 3rd: 9,10,1,2, 4th: 3-6, ...
"random" : random choice (a worker is not assigned twice)

Default: xpd.resource static $ROOTSYS/etc/proof.conf
Example: xpd.resource static /opt/proof/proof.test.conf wmx:2 selopt:random

role

xpd.role role

xpd.role role

Function: Define the role of a given server (master, submaster, worker, any). Allows to control the cluster structure.
Default: the server can assume any role.
Example: # lxb*cern.ch machines are all workers ...; if lxb*.cern.ch xpd.role worker fi; # ... except lxb6041.cern.ch which can also be anything.
if lxb6041.cern.ch xpd.role any fi

rootd

xpd.rootd deny [rootsys:rootsystag] [path:abs-path/] [mode:ro|rw] [auth:none|full] [other_rootd_args]

WARNING

This directive is now deprecated if you are using XRootD v >= 4 : use 'xpd.xrootd' instead

Function

Controls file-serving via the 'rootd' on the same port. This is useful to access the files produced by the workers or residing on the workers when there is no distributed file system and an independent file-serving system can not be added. This works by identifying file-access requests and forking a 'rootd' daemon to serve them. The port is therefore the same used for PROOF. The protocol to be used to trigger this service is 'rootd://'. When this service is enabled, the env variable LOCALDATASERVER is by default automatically set to 'rootd://:' so that files handled by TProofOutputFile have the correct URL. The service is enabled by default.

Parameters

deny: disables the service; alternative names: off, disable.
rootsys: defines the tag of the valid ROOT distribution from which 'rootd' should be taken. tags are those defined via 'xpd.rootsys'. Default is the distribution of the running 'xproofd'.
path: defines the absolute path to the 'rootd' daemon to be used. Default is the same of the running 'xproofd'.
mode: defines access mode for 'rootd'; possible values are 'ro' for 'read-only' (default) and 'rw' for 'read-write'; the latter should be used only if authentication is used.
auth: controls the authentication for 'rootd'; possible values are 'none' (default) and 'full' to use the settings defined by the default access control file (etc/system.rootdaemonrc).
other_rootd_args: any other argument to be passed to 'rootd'.

Example

xpd.rootd allow
xpd.rootd allow mode:rw auth:full

rootdallow

xpd.rootdallow host1,host2 host3 ...

xpd.rootdallow host1,host2 host3 ...

WARNING: This directive is now deprecated if you are using XRootD v >= 4 : use 'xpd.xrootd' instead
Function: Defines the lists of hosts allowed to access files via the 'rootd://' protocol (see the directive xpd.rootd). Host names are separated by a comma or by a space. Names can contains the wild card '*'. Multiple lines can be specified.
Example: xpd.rootdallow lxbuild*.cern.ch
xpd.rootdallow lxplus102.cern.ch,lxplus103 lxbatch118

rootsys

xpd.rootsys ROOTdir [tag]

xpd.rootsys ROOTdir [tag]

Function: Defines a ROOT distribution that can be used for PROOF sessions. The binary for the proofserv application is searched for under ROOTdir/bin and ROOTSYS is set to ROOTdir for proofserv. The administrator should define one of these directives per version/distribution supported. The first directive defines the ROOT version to be used by default. Specifying a tag is optional: if missing, the ROOT version tag - e.g. 5.15/03 - is taken (however, the tag must be unique, the first occurence is retained). If none of these directives are specified, $ROOTSYS is used as default ROOT version; if $ROOTSYS is not defined, xrootd will fail initialization.
Example: xpd.rootsys /opt/root_v5-13-06 pro
xpd.rootsys /opt/root_v5-13-06_dbg pro_dbg

schedopt

xpd.schedopt opt [min:val] [max:val]

xpd.schedopt opt [min:val] [max:val]

Function

control the renicing of sessions according to the priorities defined in the group file

Parameters

opt

controlling option; can have two values:

central: group priorities are read by the master and propagated to the workers
local: each worker reads priorities from a local file

min

defines the minimum nice value for sessions

max

defines the maximum nice value for sessions

Default

renicing is off by default; when on, the default values for min is 1 and for max 20

Example

xpd.schedopt central min:-10

schedparam

xpd.schedparam [scheduler] [key1:par1] [key2:par2] ...

xpd.schedparam [scheduler] [key1:par1] [key2:par2] ...

Function

Define the scheduler to be used and its configuration parameters; a scheduler is an implementation of the XrdProofSched interface; each scheduler has its own {key:parameter} pairs; those governing the behaviour of the default scheduler are described below. $ {key:parameter} pairs valid for the default scheduler:

[wmx:mxw]: defines the maximum number of workers to be assigned to user session; the default is -1, i.e. all possible workers as defined in the configuration file.
[mxsess:mxs]: defines the maximum number of sessions which can be started on each node; the default is -1, i.e. no limitation. It can be also used with the load-based scheduling. For load-based scheduling, setting this to a positive value just sets the minforquery parameter to 0, so that there is no guarantee to get a set of workers.
[mxrun:mxr]: defines the maximum number of sessions which can be run concurrently. This is active only for non-load-based assignment and requires 'queue=fifo' to be set. For load-based scheduling the number of concurrently running sessions is determined dynamically by the algorithm used for the worker assignment.
[queue:fifo]: enables the FIFO queue when controlling the number of sessions which can be run concurrently.
[selopt:mode]: specify the way workers are chosen (for positive max-workers ); options are:
"roundrobin" : round-robin selection in bunches of n (= max-workers) workers. Example: N = 10 (available workers), n = 4: 1st (session): 1-4, 2nd: 5-8, 3rd: 9,10,1,2, 4th: 3-6, ...
"random" : random choice (a worker is not assigned twice)
"load" : choice taking into account the load, defined as the number of sessions per node; the behaviour is steered by the parameters described below.
[fraction:f]: defines the fraction of free processors assigned to a session; default is 0.5; applies only to mode 'load' .
[optnwrks:optw]: defines the optimal number of workers per node; this is used to estimate the number of free processors; default is 2; applies only to mode 'load' .
[minforquery:minq]: defines the minimal number of workers for a session; default is 2; applies only to mode 'load' . Note that this is ignored if mxs is set positive (see above).

Example

xpd.schedparam selopt:load optnwrks:2

seclib

xpd.seclib protocol lib

xpd.seclib protocol lib

Function: Define xproofd specific security directives, allowing for independent rules from the ones applying to data serving. If this directive is missing xproofd falls back to the security setup defined for data serving.
Notes: conditional structures are not supported for these directives (xpd.protbind can used for similar purposes).
Default: security checks are disabled by default
Example: xpd.seclib libXrdSec.so

sec.protocol

xpd.sec.protocol protocol params

xpd.sec.protocol protocol params

Function: Configure a security protocol for xproofd; same rules as for xrootd.
Default: none
Example: xpd.sec.protocol gsi -crl:0 -gmapopt:1 -dlgpxy:1

shutdown

xpd.shutdown opt delay

xpd.shutdown opt delay

Function

Defines what to do when no client sessions are attached to a client area.

Parameters

opt: is the type of action to be taken when a client completly disconnets; possible values are:
0 remain connected
1 terminate when idle
2 terminate no matter the processing state
delay: is the delay after which the action for option 1 or 2 is performed; in seconds; to indicate minutes or hours use the suffix 'm' or 'h', respectively; e.g. 5m for 5 minutes.

Default

xpd.shutdown 1 0

Example

xpd.shutdown 2 1m

sockpathdir

xpd.sockpathdir dir

xpd.sockpathdir dir

Function: Defines the directory to be used to create the UNIX sockets used by the proofserv applications to communicate with the controlling daemon

Default: The default is /.xproofd./socks , e.g. /pool/admin/xproofd.1093/socks .
Example: xpd.sockpathdir /tmp/xpd-sock

superusers

xpd.superusers usr1,usr2,...

xpd.superusers usr1,usr2,...

Function: Define list of users with special privileges.
Default: the effective user under which the daemon runs (-R option to xrootd on the command line) is always privileged.
Example: xpd.superusers thisusr1,thatusr

tmp

xpd.tmp TMPdir

xpd.tmp TMPdir

Function: Defines the directory to be used to create temporary files
Example: xpd.tmp /pool/tmp

trace

xpd.trace [-]keyword1 [-]keyword2 ...

xpd.trace [-]keyword1 [-]keyword2 ...

Function

Specifies tracing options. This works by levels and domains. Each option may be optionally prefixed by a minus sign to turn off the setting.

Keywords

err :	trace errors	[on]
req :	trace protocol requests	[on]*
dbg :	trace details about actions	[off]
hdbg :	trace more details about actions	[off]
login :	trace details about login requests	[on]*
fork :	trace proofserv forks	[on]*
mem :	trace mem buffer manager	[off]

Domains

rsp :	server replies	[on]
aux :	aux functions	[on]
cmgr :	client manager	[on]
smgr :	session manager	[on]
nmgr :	network manager	[on]
pmgr :	priority manager	[on]
gmgr :	group manager	[on]
sched :	details about scheduling	[on]

Global switches:

all (or dump) :	full tracing of everything

all (or dump) :

full tracing of everything

Notes

Order matters: 'all' in last position enables everything; in first position is corrected by subsequent settings

Default

Defaults are shown in brackets; '*' shows the default when the '-d' option is passed on the command line. Each option may be optionally prefixed by a minus sign to turn off the setting.

Example

xpd.trace fork -err rsp

umap

xpd.umap name effuser

xpd.umap name effuser

Function: Map name to effective user effuser; effuser must be known by the system, i.e. it must be in the password file; name can be either a target user name, or the name of a VO (which can be the result of the authentication handshake or defined via xpd.vo).
Default: By default, the VO default (always created including all users) is mapped to the effective owner of the daemon.
Example: xpd.umap alienvo alipro

vo

xpd.vo voname usr_1 [,usr_2 [,...]] [,g:grp_1,...]

xpd.vo voname usr_1 [,usr_2 [,...]] [,g:grp_1,...]

voname: name of the VO
usr_1 [,usr_2 [,...]]: comma-separated list of users to be associated to VO voname.
g:grp_1,...: comma-separated list of PROOF groups (see xpd.groupfile) to be associated to VO voname.

Function: Define VO, i.e. group of names or of groups. This mapping can be used in conjunction with xpd.umap to map groups or VO to effective users.
Parameters :
Example: xpd.vo votest proof21,g:proofteam

workdir

xpd.workdir WORKdir

xpd.workdir WORKdir

Function: Defines the root path for user sandboxes (working directories); user sandbox for username will be asserted/created as WORKdir/username
Default: if this directive is missing the user sandbox will be $HOME/proof (i.e. without any additional username specification)
Example: xpd.workdir /tmp/proof

worker

xpd.worker type [user@]host[:port] [workdir=path] [port=val] [repeat=val] \ [image=string] [msd=string]

xpd.worker type [user@]host[:port] [workdir=path] [port=val] [repeat=val] \
[image=string] [msd=string]

type: type of worker: master, submaster or worker
host: the host name of the worker; a username different from the local one can be specified in the usual URL format. The host name can contain ranges in square brackets, eg lxb60[45-60] to indicate all hosts lxb6045, lxb6046, ..., lxb6060 . A non-standard port can be appended in URL format or via the dedicated keyword (see below).
workdir: remote path for working directories (sandboxes)
port: port to contact fpr the connection
repeat: number of times this line or multi-line has to be repeated; this allows to avoid duplicating the same line many times when defining multiple workers on the same machine
image: a string used to identifying host sharing a file system
msd: string used to identify machines sharing the mass storage

Function: Defines a PROOF node(s). This directive is supposed to replace the proof.conf file giving more flexibility in the definition of the host name.
Parameters :
Example: xpd.worker worker lxb60[47-80] workdir=/tmp/proof1

xrootd

xpd.xrootd path-to-plugin-with-XrdXrootdProtocol

Function: Enables file serving via XRootD. If a request for a file is identified on the open connection, the request is served by XRootD. This works internally by creating a XrdXrootdProcotol object and attaching it to the open link.
Notes: This directive should be used instead of 'xpd.rootd' . The behaviour of the XrdXrootdProtocol plug-in can be controlled with standard XRootD directives in this same configuration file.
Default: Disabled.
Examples: xpd.xrootd libXrdXrootd-4.so; xpd.xrootd /opt/xrootd/lib/libXrdXrootd-4.so

You are here

XrdProofdProtocol directives

adminreqto

allow

allowedusers

allowedgroups

clientmgr

cpcmd

datadir

datasetsrc

exportpath

filterlibpaths

groupfile

image

intwait

localwrks

maxoldlogs

maxsessions

multiuser

namespace

poolurl

port

priority

proofplugin

proofservmgr

putenv

putrc

reconnto

resource

role

rootd

rootdallow

rootsys

schedopt

schedparam

seclib

sec.protocol

shutdown

sockpathdir

superusers

tmp

trace

umap

vo

workdir

worker

xrootd