mschedctl

(Moab Scheduler Control)

Synopsis

mschedctl -A '<MESSAGE>'
mschedctl -c message messagestring [-o type:val]
mschedctl -c trigger triggerid -o type:val
mschedctl -d trigger triggerid
mschedctl -d vpc:vpcid
mschedctl -d message:index

mschedctl -f {all|estimates|fairshare|usage}

mschedctl -k
mschedctl -l {config|message|trigger|trans|vpc|vpcprofile} [--flags=verbose]
mschedctl -L [LOGLEVEL]
mschedctl -m config string [-e] [--flags=persistent]
mschedctl -m trigger triggerid attr=val[,attr=val...]
mschedctl -m vpc vpcid attr=val[,attr=val...]

mschedctl -n
mschedctl -p
mschedctl -r [resumetime]
mschedctl -R
mschedctl -s [STOPITERATION]
mschedctl -S [STEPITERATION]

Overview

The mschedctl command controls various aspects of scheduling behavior. It is used to manage scheduling activity, shutdown the scheduler, and create resource trace files. It can also evaluate, modify, and create parameters, triggers, and messages.

NOTE: With many flags, the '--msg=<MSG>' option can be specified to annotate the action in the event log.

Format

Name	Format	Default	Description	Example
ANNOTATE	<STRING>	---	Report the specified parameter modification to the event log and annotate it with the specified message	mschedctl -A > mschedctl --flags=pers -A 'increase logging' -m 'LOGLEVEL 6' adjust the LOGLEVEL parameter and record an associated message
CREATE	message <STRING> [-o <TYPE>:<VAL>]	---	Create a Message and link it to the specified object	`mschedctl -c message tell the admin to be nice` (create a message on the system table)
	trigger <TRIGSPEC> -o <OBJECTTYPE>:<OBJECTID>	---	Create a trigger and attach it to the specified object	`mschedctl -c trigger EType=start,AType=exec,Action="/tmp/email $OWNWER $TIME" -o rsv:system.1` (create a trigger linked to system.1)
	vpc [-a <ATTR>=<VAL>]... where <ATTR> is one of account, duration, messages, profile, reqresources, resources, rsvprofile, starttime, user, or variables	---	Create a Virtual Private Cluster	`mschedctl -c vpc -a resources=6,7,8 -a profile=packageA` (create a vpc using TID's 6, 7, and 8 and based on profile packageA) Note: VPC commands (such as `mschedctl -c vpc`) are only enabled on hosting center builds. Additional VPC attributes: -a
DESTROY	trigger <TRIGID>	---	Delete a trigger	`mschedctl -d trigger 3` (delete trigger 3)
	message:<INDEX>	---	Delete a message	`mschedctl -d message:5` (delete message with index 5)
	vpc:<VPCID>	---	Delete a VPC	`mschedctl -d vpc:vpc.5` (delete vpc.5)
FLUSH	{all\|estimates\|fairshare\|usage}	---	Flush (clear out) specified statistics	`mschedctl -f usage` (flush usage statistics)
KILL	---	---	Stop scheduling and exit the scheduler	`mschedctl -k` (kill the scheduler)
LIST	{config \| message \| trigger \| trans \| vpc \| vpcprofile} [--flags=verbose]	config	List the scheduler configuration, system messages, triggers, transactions, virtual private clusters or VPC profiles.	`mschedctl -l config` (list system parameters) `mschedctl -l trigger` (list triggers) `mschedctl -l trans 1` (list transaction id 1)
LOG	<INTEGER>	7	create a temporary log file with the specified loglevel.	mschedctl -L > mschedctl -L 7 create temporary log file with naming convention '<logfile>.YYYYMMDDHHMMSS'
MODIFY	config [<STRING>] [-e] [--flags=pers] <STRING> is any string which would be acceptable in `moab.cfg`> If no string is specified, <STRING> is read from STDIN. If '-e' is specified, the configuration string will be evaluated for correctness but no configuration changes will take place. Any issues with the provided string will be reported to STDERR. If --flags=persistent is specified, changes will be made persistent by changing in memory configuration and modifying `moab.cfg`.	---	Modify a system parameter	mschedctl -m > mschedctl -m config LOGLEVEL 9 change the system loglevel to 9
	trigger:<TRIGID> <ATTR>=<VAL> where <ATTR> is one of action, atype, ttime, etype, oid, otype, offset, or threshold	---	Modify a trigger	`mschedctl -m trigger:2 AType=exec,Offset=200,OID=system.1` (change aspects of trigger 2)
	vpc:<VPCID> <ATTR>=<VAL> where <ATTR> is one of variables	---	Modify a Virtual Private Cluster	`mschedctl -m vpc:packageA.1 variables=blue=dog` (change aspects of vpc packageA.1)
NODE TRACE	---	---	Output a Resource Trace File to STDOUT	mschedctl -n mschedctl -n > /tmp/node.trace
PAUSE	---	---	Disable scheduling but allow the scheduler to update its cluster and workload state information	`mschedctl -p`
RECYCLE	---	---	Recycle scheduler immediately (shut it down and restart it using the original execution environment and command line arguments.	`mschedctl -R` (recycle scheduler immediately)
RESUME	<INTEGER>	0	Resume scheduling at the specified time. (Or immediately if none is specified.)	`mschedctl -r` (resume scheduling immediately)
STOP	<INTEGER>	0	Suspend/stop scheduling at specified iteration (or at the end of the current iteration if none is specified) If the letter 'I' follows <ITERATION>, moab will not process client requests until this iteration is reached	`mschedctl -s 100I` (stop scheduling at iteration 100 and ignore all client requests until then)
STEP	<INTEGER>	0	Step the specified number of iterations (or to the next iteration if none is specified) and suspend scheduling If the letter 'I' follows <ITERATION>, moab will not process client requests until this iteration is reached	`mschedctl -S` (step to the next iteration and stop scheduling)

Example 1

Shutting down the Scheduler

shutting down the scheduler

> mschedctl -k

scheduler will be shutdown immediately

Example 2

Creating a virtual private cluster

creating a VPC

> mschedctl -c vpc -a resources=14332 -a variables=os=rhel3

vpc.98