You are here: 4.0 Scheduler Commands > Commands > mschedctl

mschedctl

Synopsis 

   mschedctl -A '<MESSAGE>'
mschedctl -c   message   messagestring [-o type:val]
mschedctl -c   trigger   triggerid -o type:val   mschedctl -d   trigger   triggerid   mschedctl -d   message:index   mschedctl -f {all|fairshare|usage}
mschedctl -k   mschedctl -l {config|message|trigger|trans} [--flags=verbose] [--xml]
mschedctl -L [LOGLEVEL]
mschedctl -m config string [-e] [--flags=persistent]
mschedctl -m trigger triggeridattr=val[,attr=val...]
mschedctl -q  mschedctl -q pactions --xml
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.
NoteWith many flags, the '--msg=<MSG>' option can be specified to annotate the action in the event log.

Format

-A - ANNOTATE
Format:<STRING>
Default:---
Description:Report the specified parameter modification to the event log and annotate it with the specified message. The RECORDEVENTLIST parameter must be set in order for this to work.
Example:
mschedctl -A 'increase logging' -m 'LOGLEVEL 6'
Adjust the LOGLEVEL parameter and record an associated message.
  
-c - CREATE
Format:One of:
  • message <STRING> [-o <TYPE>:<VAL>]
  • trigger<TRIGSPEC> -o <OBJECTTYPE>:<OBJECTID>
  • gevent -n <NAME> [-m <message>]

    where <ATTR> is one of account, duration, ID, messages, profile, reqresources, resources, rsvprofile, starttime, user, or variables
Default:---
Description:Create a message, trigger, or gevent and attach it to the specified object. To create a trigger on a default object, use the Moab configuration file (moab.cfg) rather than the mschedctl command.
Example:
mschedctl -c message tell the admin to be nice
Create a message on the system table. 
mschedctl -c trigger EType=start,AType=exec,Action="/tmp/email $OWNER $TIME" -o rsv:system.1
Create a trigger linked to system.1
NoteCreating triggers on default objects via mschedctl -c trigger does not propagate the triggers to individual objects. To propagate triggers to all objects, the triggers must be created within the moab.cfg file; for example: NODECFG[DEFAULT]TRIGGER.
mschedctl -c gevent -n diskfailure -m "node=n4"
Create a gevent indicating a disk failure on the node labeled n4.
  
-d - DESTROY
Format:One of:
  • trigger<TRIGID>
  • message:<INDEX>
Default:---
Description:Delete a trigger or message.
Example:
mschedctl -d trigger:3
Delete trigger 3. 
mschedctl -d message:5
Delete message with index 5.
  
-f - FLUSH
Format:{all|fairshare|usage}
Default:---
Description:Flush (clear out) specified statistics
Example:
mschedctl -f usage
Flush usage statistics.
  
-k - KILL
Format:---
Default:---
Description:Stop scheduling and exit the scheduler
Example:
mschedctl -k
Kill the scheduler.
  
-l - LIST
Format:{config | gres | message | trans | trigger} [--flags=verbose] [--xml]
NoteUsing the --xml argument with the trans option returns XML that states if the queuried TID is valid or not.
Default:config
Description:List the generic resources, scheduler configuration, system messages, triggers, or transactions.
Example:
mschedctl -l config
List system parameters. 
mschedctl -l gres
List all configured generic resources. 
mschedctl -l trans 1
List transaction id 1. 
mschedctl -l trigger
List triggers.
  
-L - LOG
Format:<INTEGER>
Default:7
Description:Create a temporary log file with the specified loglevel.
Example:
mschedctl -L 7
Create temporary log file with naming convention '<logfile>.YYYYMMDDHHMMSS'.
  
-m - MODIFY
Format:One of:
  • 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, the Moab configuration files (moab.cfg and moab.dat) are modified.

  • trigger:<TRIGID> <ATTR>=<VAL>

    where <ATTR> is one of action, atype, etype, iscomplete, oid, otype, offset, or threshold
Default:---
Description:Modify a system parameter or trigger.
Example:
mschedctl -m config LOGLEVEL 9
Change the system loglevel to 9. 
mschedctl -m trigger:2 AType=exec,Offset=200,OID=system.1
Change aspects of trigger 2.
  
 
  
-p - PAUSE
Format:---
Default:---
Description:Disable scheduling but allow the scheduler to update its cluster and workload state information.
Example:
mschedctl -p
-q QUERY PENDING ACTIONS
Format:--
Default:mschedctl -q pactions --xml
Description:A way to view pending actions. Only an XML request is valid. Pending actions can be VMs or system jobs.
Example:
mschedctl -q pactions --xml
-R - RECYCLE
Format:---
Default:---
Description:Recycle scheduler immediately (shut it down and restart it using the original execution environment and command line arguments).
Example:
mschedctl -R
Recycle scheduler immediately.
NoteTo restart Moab with its last known scheduler state, use:
mschedctl -R savestate
  
-r - RESUME
Format:<INTEGER>
Default:0
Description:Resume scheduling at the specified time (or immediately if none is specified).
Example:
mschedctl -r
Resume scheduling immediately.
  
-s - STOP
Format:<INTEGER>
Default:0
Description: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.
Example:
mschedctl -s 100I
Stop scheduling at iteration 100 and ignore all client requests until then.
  
-S - STEP
Format:<INTEGER>
Default:0
Description: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.
Example:
mschedctl -S
Step to the next iteration and stop scheduling.

Example 1

Shutting down the Scheduler: 
mschedctl -k
scheduler will be shutdown immediately

See Also

Copyright © 2012 Adaptive Computing Enterprises, Inc.®