Velocity Scheduler Command Reference

All Velocity Scheduler (vsched) command options are listed below. Click on an option to see an example. The commands are run in a command window on a CTC login node.

General usage: vsched <option> <additional information>

<option> <additional information>

Description (-h output)
-h or -help lists options available
-a or -affiliations lists all affiliations; an affiliation is the name for a pool of compute nodes
-q or -queue <affiliation> lists all jobs in the queue unless qualified by affiliation
-s or -submit <xml job file> submits a job to the scheduler
-j or jid returns job id, run from compute note
-c or -cancel <JobID> cancels the job specified by JobID, you must be job owner or admin
-r or -restart <JobID> restarts the job specified by JobID, you must be job owner
-pa or -passwd registers your password with the scheduler, enabling jobs to be started with your credentials
-m or -machines <JobID> creates a file called 'machines' which lists all compute nodes allocated to your job
-i or -info <hostname> lists system information for a given compute node
-u or -usage <affiliation> lists compute node status, can be qualified by affiliation
-po or -policy <affiliation> lists policy for affiliation specified, otherwise all will be listed
-cs or -changestatus <jobid> changes the job status from Holding to Waiting, specified by JobID, you should re-register your password before issuing this command
Command: vsched -a or -affiliations
Description: lists all affiliations; an affiliation is the name for a pool of compute nodes
Notes: For example, v3 and development are affiliations
Example:

H:\Users\username>vsched -a
Cluster                    Total   Free   Busy  Clearing Maintenance   Down
-------------------------------------------------------------
vplustest                     33     33      0        0            0      0
vplustest2                     6      6      0        0            0      0
vplustest2 		
Command: vsched -c or -cancel <JobID>
Description: cancels the job specified by JobID, you must be job owner or admin
Notes:
Example:

H:\Users\username>vsched -c 1706
1706 canceled
Command: vsched -cs or -changestatus <JobID>
Description: changes the job status from Holding to Waiting, specified by JobID, you should re-register your password before issuing this command
Notes: More details are in Tips and Tricks.
Example:

H:\Users\username>vsched -pa
Please enter your password : ***********
Please confirm your password : ***********
Your password for Velocity Scheduler has been set
H:\Users\username>vsched -cs 1706
JobID status modified to waiting
Command: vsched -h or -help
Description: lists options available
Notes:
Example:

H:\Users\username>vsched -h
usage: vsched <option> <additional information>
options:
   -h or -help
       lists options available
   -a or -affiliations
       lists all affiliations; 
       an affiliation is the name for a pool of compute nodes
   -q or -queue          <affiliation>
       lists all jobs in the queue unless qualified by affiliation
   -s or -submit         <xml job file>
       submits a job to the scheduler
   -c or -cancel         <JobID>
       cancels the job specified by JobID, you must be job owner or admin
   -r or -restart        <JobID>
       restarts the job specified by JobID, you must be job owner
   -pa or -passwd
       registers your password with the scheduler, enabling jobs to be started with your credentials
   -m or -machines       <JobID>
       creates a file called 'machines' which lists all
       compute nodes allocated to your job
   -i or -info           <hostname>
       lists system information for a given compute node
   -u or -usage          <affiliation>
       lists compute node status, can be qualified by affiliation
   -po or -policy        <affiliation>
       lists policy for affiliation specified, otherwise all will be listed
   -cs or -changestatus <jobid>
       changes the job status from Holding to Waiting, specified by JobID,
       you should re-register your password before issuing this command
Command: vsched -i or -info <hostname>
Description: lists system information for a given compute node
Notes:
Example:

H:\Users\username>vsched -i ctc065

ctc065 : System Summary Information
--------------------------------------------------------
OS Name                  Microsoft(R) Windows(R) Server 2003,
Standard Edition OS Version 5.2.3790 Build 3790 OS Manufacturer Microsoft Corporation Service Pack 10 System Manufacturer Dell Computer Corporation System Model PowerEdge 2450 System Type X86-based PC Processor x86 Family 6 Model 8 Stepping 3
GenuineIntel ~731 Mhz BIOS Version DELL - 2 Windows Directory C:\WINDOWS Locale English (United States) Time Zone Eastern Standard Time Total Physical Memory 2096648KB Total Virtual Memory 1947208KB Page File Space 0KB Contact Lucy Walle Location 757 Cluster Affiliation vplustest (Dedicated Resource) Current Status up Last Update ctclwalle on 1/3/2006 1:37:21 PM
Command: vsched -m or -machines <JobID>
Description: creates a file called 'machines' which lists all compute nodes allocated to your job
Note 1: The file lists all machines allocated to <JobID>. If run on compute node, JobID not required.
Note 2: "vsched -m" turns off echoing. That is, if "@echo on" is at the top of a .bat file, and "vsched -m" is issued later in that .bat file, then echoing is disabled for all commands subsequent to the "vsched -m". Turn it on by issuing "@echo on" a second time.
Example:

H:\Users\username>vsched -m 1710
Machines file created for job ID: 1710

H:\Users\username>type machines
ctc065
ctc066
Command: vsched -pa or -passwd
Description: registers your password with the scheduler, enabling jobs to be started with your credentials
Notes:
Example:

H:\Users\username>vsched -pa
Please enter your password : ***********
Please confirm your password : ***********
Your password for Velocity Scheduler has been set
Command: vsched -po or -policy <affiliation>
Description: lists policy for affiliation specified, otherwise all will be listed
Notes:
Example:

H:\Users\username>vsched -po vplustest
Cluster Affiliation: vplustest
Max_Time_Limit: 1440
Min_Time_Limit: 1
Max_Nodes: 32
Min_Nodes: 1
Max_Queue_Limit: 0
Max_Jobs_Waiting: 0
Command: vsched -q or -queue <affiliation>
Description: lists all jobs in the queue unless qualified by affiliation
Notes: Key for "Stat" column:
  • W: Waiting
  • S: Starting
  • M: Mending
  • R: Running
  • C: Clearing
  • H: Holding (See details in Tips and Tricks)

Example:

H:\Users\username>vsched -q
JobId   User     Nodes  Time  Type Stat  End Time    Master       Affiliation
----------------------------------------------------------------------
1702    susan        2  0:05    B   R    11:18 04/18 ctc065       vplustest
Command: vsched -r or -restart <JobID>
Description: restarts the job specified by JobID, you must be job owner
Notes: When you issue restart, running scripts and programs are terminated, the scheduler obtains new job files from the file server, and the programs are restarted using your job's remaining time in the queue.
Example:

H:\Users\username>vsched -r 1709

1709 restarted
Command: vsched -s or -submit <xml job file>
Description: submits a job to the scheduler
Notes:
Example:

H:\Users\username>vsched -s MyJob.xml
1702
Command: vsched -j or jid
Description: returns job id, run from compute node
Notes:
Example:


H:\Users\username>vsched -j
1702
Command: vsched -u or -usage <affiliation>
Description: lists compute node status, can be qualified by affiliation
Notes: "Clrg" means Clearing, "Maint" means Maintenance.

"Status" column values:

  • Down
  • Free
  • Clrg
  • Maint
  • Busy
  • Busy-M (will go into maintenance when current job ends)

Example:

H:\Users\username>vsched -u
Host Name          Status User      JobID    Completion Time
------------------------------------------------------------
ctc065             Free
ctc066             Free
ctc067             Free
ctc068             Free
ctc069             Free
ctc070             Free
ctc071             Free
. . . .