Job template extension attributes

24.0 Job templates > Job template references > Job template extension attributes

24.6 Job template extension attributes

When creating a job template, you can use any attribute acceptable within the WIKI workload query data format. In addition, job templates can use any of the extension attributes in the following table. Note that the Template type (JMIN, JMAX, JDEF, JSET) row indicates compatibility with the associated attribute (See Applying templates based on job attributes for more information.).

Attributes set in a template are evaluated as if they were part of the original job submission. Their jobs are still subject to all the same ACLs and policies.

ACCOUNT
Format	<ACCOUNT>[,<ACCOUNT>]...
Template type	JMIN JDEF JSET
Description	Account credentials associated with job. This is used for job template matching.
Example	JOBCFG[public] FLAGS=preemptee JOBCFG[public.min] ACCOUNT=public_acct JOBMATCHCFG[public] JMIN=public.min JSET=public

CLASS
Format	<CLASS>[,<CLASS>]...
Template type	JMIN JDEF JSET
Description	Class credentials associated with job. This is used for job template matching.
Example	JOBCFG[night] FLAGS=preemptor JOBCFG[night.min] CLASS=night_class JOBMATCHCFG[night] JMIN=night.min JSET=night

CPULIMIT
Format	[[[DD:]HH:]MM:]SS
Template type	JMIN JMAX JDEF JSET
Description	Maximum amount of CPU time used by all processes in the job.
Example	JOBCFG[job.min] CPULIMIT=1:00:00:00 JOBCFG[job.max] CPULIMIT=2:00:00:00

DESCRIPTION
Format	<STRING>
Template type	JMAX JDEF
Description	Description of the job. When you run the checkjob command, the description appears as Reason.
Example	JOBCFG[webdb] DESCRIPTION="Template job"

DPROCS
Format	<INTEGER>
Template type	JMIN JMAX JSET
Description	Number of processors dedicated per task. The default is 1.
Example	JOBCFG[job.min] DPROCS=2 JOBCFG[job.max] DPROCS=4

EUSER
Format	<STRING>
Template type	JDEF JSET
Description	In a job template, EUSER is the effective user, meaning that when a job starts the user running the job will switch to the one on the template.
Example	JOBCFG[batch] EUSER=render

EXEC
Format	<STRING>
Template type	JSET
Description	Specifies what the job runs, regardless of what the user set.
Example	JOBCFG[setup.pre] EXEC=nfs/tools/setup.pre.sh

FLAGS
Format	<JOBFLAG>[,<JOBFLAG>]...
Template type	JMIN JDEF JSET
Description	One or more legal job flag values.
Example	JOBCFG[webdb] FLAGS=NORMSTART

GNAME
Format	<STRING>
Template type	JSET
Description	Group credential associated with job.
Example	JOBCFG[webserv] GNAME=service For matching the group, see the GROUP attribute.

GRES
Format	<genericResource>[:<COUNT>]
Template type	JMAX JDEF
Description	Consumable generic attributes associated with individual nodes or the special pseudo-node global, which provides shared cluster (floating) consumable resources. Use the NODECFG parameter to configure such resources.
Example	JOBCFG[gres.set] GRES=abaqus:2 In this example, the gres.set template applies two Abaqus licenses per task to a matched job.

GROUP
Format	<GROUP>[,<GROUP>]...
Template type	JMIN JDEF JSET
Description	Group credentials associated with job. This is used for job template matching.
Example	JOBCFG[webserv] GROUP=service For information about setting the group, see the GNAME attribute.

MEM
Format	<INTEGER>
Template type	JMIN JMAX JDEF JSET
Description	Maximum amount of physical memory per task used by the job. See Requesting Resources for more information.
Example	JOBCFG[smalljobs] MEM=25

NODEACCESSPOLICY
Format	One of the following: SHARED, SHAREDONLY, SINGLEJOB, SINGLETASK , SINGLEUSER, or UNIQUEUSER
Template type	JDEF JSET
Description	Specifies how node resources will be shared by a job. See the Node Access Policies for more information.
Example	JOBCFG[serverapp] NODEACCESSPOLICY=SINGLEJOB

NODERANGE
Format	<MIN>[,<MAX>]
Template type	JMAX JDEF
Description	Minimum and maximum nodes allowed to be allocated to job.
Example	JOBCFG[vizserver] NODERANGE=1,16

NODES
Format	<INTEGER>
Template type	JMIN JMAX JSET
Description	Number of nodes required by the job. The default is 1. See Node Definition for more information.
Example	JOBCFG[job.min] NODES=2 JOBCFG[job.max] NODES=4

NODESET
Format	<STRING>
Template type	JSET
Description	See Node Set Overview for more information.
Example	JOBCFG[medium.set] NODESET=ONEOF:FEATURE:fast,slow

PARTITION
Format	<PARTITION>[:<PARTITION>]...
Template type	JMIN JDEF JSET
Description	Specifies the partition (or partitions) in which a job must run.
Example	JOBCFG[meis] PARTITION=math:geology

PREF
Format	<STRING>
Template type	JDEF JSET
Description	Specifies which node features are preferred by the job and should be allocated if available. See PREF for more information.
Example	JOBCFG[meis] PREF=bigmem

PRIORITY
Format	<INTEGER>
Template type	JMAX JDEF
Description	Relative job priority. PRIORITY works only as a default setting and not as an override (JSET) setting.
Example	JOBCFG[meis] PRIORITY=25000

PROCRANGE
Format	<MIN>[,<MAX>]
Template type	JDEF JSET
Description	Minimum and maximum processors allowed to be allocated to job.
Example	JOBCFG[meis] PROCRANGE=2,64

QOS
Format	<QOS>[,<QOS>]...
Template type	JMIN JDEF JSET
Description	QoS credentials associated with job. This is used for job template matching.
Example	JOBCFG[admin] RFEATURES=bigmem JOBCFG[admin.min] QOS=admin_qos JOBMATCHCFG[admin] JMIN=admin.min JSET=admin

RARCH
Format	<STRING>
Template type	JSET
Description	Architecture required by job.
Example	JOBCFG[servapp] RARCH=i386

RFEATURES
Format	<FEATURE>[,<FEATURE>]...
Template type	JMIN JDEF JSET
Description	List of features required by job.
Example	JOBCFG[servapp] RFEATURES=fast,bigmem

RM
Format	<STRING>
Template type	JDEF JSET
Description	Destination resource manager to be associated with job.
Example	JOBCFG[webdb] RM=slurm

ROPSYS
Format	<STRING>
Template type	JDEF JSET
Description	Operating system required by job.
Example	JOBCFG[test.set] ROPSYS=windows

SELECT
Format	<BOOLEAN> : TRUE \| FALSE
Description	Job template can be directly requested by job at submission.
Example	JOBCFG[servapp] SELECT=TRUE

SOFTWARE
Format	<RESTYPE>[{+\|:}<COUNT>][@<TIMEFRAME>]
Template type	JDEF JSET
Description	Indicates generic resources required by the job. See SOFTWARE for more information.
Example	JOBCFG[servapp] SOFTWARE=matlab:2

SYSTEMJOBTYPE
Template type	JMIN
Description	System job type (ex. vmcreate).
Example	JOBCFG[vmcreate.min] SYSTEMJOBTYPE=vmcreate JOBCFG[vmcreate.set] TRIGGER=atype=reserve,action="00:05:00",etype=end JOBMATCHCFG[vmcreate] JMIN=vmcreate.min JSET=vmcreate.set

TARGETBACKLOG
Format	[<MIN>,]<MAX>
Template type	JDEF JSET
Description	Minimum and maximum backlog for application within job.
Example	JOBCFG[pdb] TARGETBACKLOG=0.5,2.0

TARGETLOAD
Format	[<MIN>,]<MAX>
Template type	JDEF JSET
Description	Minimum and maximum load for application within job.
Example	JOBCFG[pdb] TARGETLOAD=0.5,2.0

TARGETRESPONSETIME
Format	[<MIN>,]<MAX>
Template type	JDEF JSET
Description	Minimum and maximum response time in seconds for application within job.
Example	JOBCFG[pdb] TARGETRESPONSETIME=0.5,2.0

TARGETTHROUGHPUT
Format	[<MIN>,]<MAX>
Template type	JDEF JSET
Description	Minimum and maximum throughput for application within job.
Example	JOBCFG[pdb] TARGETTHROUGHPUT=0.5,2.0

TASKS
Format	<INTEGER>
Template type	JMIN JMAX JSET
Description	Number of tasks required by job. The default is 1. See Task Definition for more information.
Example	JOBCFG[job.min] TASKS=4 JOBCFG[job.max] TASKS=8

TASKPERNODE
Format	<INTEGER>
Template type	JMIN JMAX JDEF
Description	Exact number of tasks required per node. The default is 0. TASKPERNODE works only as a default setting and not as an override (JSET) setting.
Example	JOBCFG[job.min] TASKPERNODE=2 JOBCFG[job.max] TASKPERNODE=4

TEMPLATEDEPEND
Format	<TYPE>:<TEMPLATE_NAME>
Description	Create another job from the <TEMPLATE_NAME> job template, on which any jobs using this template will depend. This is used for dynamically creating workflows. See Job Dependencies for more information.
Example	JOBCFG[engineering] TEMPLATEDEPEND=AFTER:setup.pre JOBCFG[setup.pre] SELECT=TRUE EXEC=/tools/setup.pre.sh

UNAME
Format	<STRING>
Default	JSET
Description	User credential associated with job.
Example	JOBCFG[webserv] UNAME=service For matching the user, see the USER attribute.

USER
Format	<USER>[,<USER>]...
Template type	JMIN JMAX JDEF JSET
Description	User credentials associated with job.
Example	JOBCFG[webserv] USER=service For setting the user, see the UNAME attribute.

VARIABLE
Format	<NAME>[:<VAL>]
Template type	JMIN JSET
Description	Variables attached to the job template.
Example	JOBCFG[this] VARIABLE=var1:1 VARIABLE=var2:1 Variables are set upon successful completion of the job.

WCLIMIT
Format	[[HH:]MM:]SS
Template type	JMIN JMAX JDEF JSET
Description	Walltime required by job. The default is 8640000 (100 days).
Example	JOBCFG[job.min] WCLIMIT=2:00:00 JOBCFG[job.max] WCLIMIT=12:00:00