Configure FairShare via File

The options are:

-w (weight): Specify the relative weight of the group (default given by variable $FSGROUP(weights), which is normally 100).
-t (timeWindow): Specify the time window used in the computation of the actual shares (default given by variable $FSGROUP(windows) which is normally 7200, which is 2 hours).
Note: A time window of duration zero can be used to disable FairShare for a subset of the FairShare tree.
-u (List-Of-Users): Specify a list of users that have exclusive access to that FairShare group. This access is controlled by an Access Control List.
-user: Specify that the group is a USER level group

A FairShare configuration file that represents current FairShare state can be created in the web user interface. Click FairShare > Hierarchical Configuration. The vovfsgroup genconfig command provides a way to generate a FairShare cofiguration file from the CLI.

Tcl Example

% vovfsgroup genconfig  config.mysetup.tcl
% vovfsgroup genconfig -leaf config.mysetup_with_leaf_nodes.tcl

A FairShare configuration file (as generated by the example above) can be imported into the system with the command vovfsgroup loadconfig, as follows:

% vovfsgroup loadconfig config.normal.tcl

Where config.normal.tcl contains the FairShare configuration declared in Tcl as follows:

# Copyright (c) 1995-2023, Altair Engineering
# All Rights Reserved.

# $Id: //vov/branches/2023.1.2/src/etcDir/config/fairshare/config.normal.tcl#2 $

#
# This is an example of config for fairshare.
#
FSGROUP "class" {

    FSGROUP "sim" -w 0 -t 0 {
	# In this branch, fairshare is disabled
	# because the timewindow is zero (-t 0)
	FSGROUP jolly
	FSGROUP cronos  -w 100 -t 3h
    }
    FSGROUP "urgent" -window 10m {
	FSGROUP h2p -w 300
	FSGROUP jolly 
	FSGROUP cronos
    }
    FSGROUP projects -w 133 {
	FSGROUP jolly  {
	    FSGROUP normal -w 200 {}
	    FSGROUP random -w  80 {}
	}
	FSGROUP cronos {
	    FSGROUP normal
	    FSGROUP random 
	}
    }
}

Serial Example

The vovfsgroup genconfig -serial command provides a way to generate a FairShare configuration file in the "serial" format.

% vovfsgroup genconfig -serial config.mysetup.txt
% vovfsgroup genconfig -leaf -serial config.mysetup_with_leaf_nodes.txt

A FairShare configuration file in serial format (as generated by the example above) can be imported into the system with the command vovfsgroup loadconfig, as follows:

% vovfsgroup loadconfig config.normal.txt

Where the content of file config.normal.txt is as follows:

# FairShare configuration file created by vovfsgroup on Mon May 02 16:55:09 EDT 2022
# Output is in tab-separated key=value format
# ACL values are in AGENT/NAME/ACTIONS format, with multiple ACLs separated by a comma

group=/	weight=16777215	window=-1s	flatten=0
group=/time	weight=100	window=1h00m	flatten=0
group=/time/users	weight=100	window=1h00m	flatten=0	acl=OWNER//ATTACH DETACH EDIT VIEW STOP FORGET DELEGATE EXISTS CREATE,ADMIN//ATTACH DETACH EDIT VIEW FORGET CREATE,EVERYBODY//ATTACH DETACH VIEW
group=/system	weight=100	window=0s	flatten=0
group=/system/taskers	weight=100	window=0s	flatten=0
group=/system/taskers/closures	weight=100	window=0s	flatten=0
group=/system/taskers/messages	weight=100	window=0s	flatten=0
group=/system/vovdbd	weight=100	window=0s	flatten=0