vtk_server_config

This section explains the usage of vtk_server_config. Only an ADMIN is allowed to use this API.
% vovsh -x 'vtk_server_config KEYWORD VALUE'
All configuration parameters can be controlled via this interface. In addition, the following keywords are understood.
KEYWORD (case-insensitive) VALUE Description
allowcoredump boolean If the vovserver encounters a serious error, it may dump its core if the flag is set.
autoshutdown time_spec Control the auto-shut-down time for the vovserver. The vovserver shuts down when the specified time elapses after the last executed job. If the value is 0, auto-shut-down is disabled.
chdir directory_path Change working directory of the vovserver. This can be useful if the OS loses the notion of where the vovserver is running (seen on some old systems).
checkbarrier ignored Run a sanity check for barriers, including the barrier-invalid flags. Only useful for FlowTracer.
checklogchecklogs size Check the size of the vovserver log and rotate it if it is larger than the specified size.
clearsymlinks ignored Force clearing of the caches for symlinks. See also printsymlinks.
clientfdoffset integer DEBUG: do not use (default is 40).
closeclientbyhost hostname Close all clients on the specified host. You can see the connected clients with vovshow -clients. This can be used, for example, when the OS is refusing to shut-down a socket even when a machine is down. See also closeclientsbyindex.
closeclientbyindex integer Close the specified client. The value is the index of the client. You can see the connected clients with vovshow -clients. This can be used, for example, when the OS is refusing to shut-down a socket even when a machine is down. See also closeclientsbyhost
dumphalfattachments ignore DEBUG: Create a file called ha.dump to show where the half-attachment memory is being spent.
enablepam boolean  
enableldap boolean  
enterpriselicensecoresslots integer | "off" | "auto" | "full" Control the use of the enterprise license. See also "refreshlicense" below for more interaction with licensing.
flushlogs ignore Force flushing of all journals and logs. (normally all logs are flushed once a second).
graceperiod time_spec DEBUG ONLY: set the grace period for when the license expires. The default value is 5d, the range is between 1m and 5d.
httpsecure boolean If the flag is 1 (which is the default), one must authenticate to use the browser interface. Otherwise everyone can login and browse using READ_ONLY credentials. See also environment variable VOV_HTTP_UNSECURE.
idmgmt vovid Test the insertion of an object with specified VovId. If the VovId is large, this will likely trigger the recycling of VovIds. Used mostly for testing.
idrange lowId-highId Specify the range of VovId recycling.
liverecorder "on" or "off" or PID of vovserver Controls the live recording capability provided by Undo Software. Turning live recorder on is quick, turning it off requires a relatively long time (about 30s if you have 200k jobs in the system)
maxclients integer DEBUG: used to test the behavior of system when a small number of clients are allowed. Reduces the total number of usable clients. Internal levels are enforced.
maxlevel integer Used in FlowTracer. Set the maximum level for the flow. The default value is 4095. The range is 3 to 4095.
maxjobarray integer Used in Accelerator. Set the maximum size of a job array. The default is 10,000. The range is 10..100,000.
maxnormalclients integer  
maxnotifyclients integer

Maximum number of notify clients per user. This is a protection against denial-of-service attacks by a single user. The 'notify' clients are those that tap into the event stream. They are used for example in waiting for jobs to finish and to update the GUI.

maxresmap integer  
maxbuffersize integer  
minhw string Set the value of the minimum hardware resources that every job needs to request. The default value is "RAM/20 CORES/1 SLOTS/1 PERCENT/1".
netinfo boolean Control whether the system is supposed to collect network information from all its taskers.
preemptionfairshare "on" | "off" | time_spec Enable or disable the computation to support FairShare of preemption.
printcodes ignored Force printing usage of RPC codes (debugging only). Output goes to the vovserver log.
printsymlinks ignored Force printing of content of symlink cache (debugging only). Output is in vovserver log. See also clearsymlinks.
product lm lms nc mq la ft rm Set the product of vovserver.
readonlyport integer Control the read-only port for vovserver. If the integer is 0, the read-only port is closed. If in the range 1000...32000, the specified port is opened, if possible. If the port cannot be opened, then the port is closed again.
refreshlicense bool Update the licensing information. If the value is true, then all RLM licenses are checked-in before being checked-out again.
reset_debug_flag flag-name DEBUG: turn OFF the named debug flag. The list of flags is not published. See also set_debug_flag.
reopenlogs ignore Close and reopen all journals and logs. See also checklogs, flushlogs, and rotateserverlog.
rotateserverlog boolean Rotation of the server logs, but only if the boolean is true.
scheduler command Request a scheduler cycle. If the command is the word "suspend", then the scheduler is suspended, meaning no jobs are dispatched. If the command is "request", then the scheduler is called once, while remaining suspended or active. If the command is "unsuspend", then the scheduler is reactivated. If the command is anything else, the scheduler is reactivated and called once.
set_debug_flag flag-name DEBUG: turn ON the named debug flag. The list of flags is not published. See also reset_debug_flag.
taskerheartbeat num_seconds Set the expected heart beat of the taskers. If a tasker is not reporting an update after 3*taskerheartbeat, it is considered SICK. The range for this is between 10 and 86400(1day).
trace_debug_flag bit-mask DEBUG: Set some debug flags in VovTrace. Default value is 0. See also VOV_DEBUG_FLAGS.
type string Set the project type.
usrtmp directory Specify the directory to be used for temporary files. Default is /usr/tmp or /tmp.