Queue Manager syntax

1
Queue Manager syntax

• The queue manager (as implemented by Bamboo)
  utilizes the SSSRMAP message format v3 and the
  SSSRMAP Job object v3.
• The following describes the command syntax for
  the queue manager.

2
Commands at a glance

• Submit Job
• Modify Job
• Query Job(s) or Queue
• Start Job
• Signal Job
• Cancel Job
• Suspend Job
• Resume Job
• Checkpoint Job
• Requeue Job
• Administer Server

3
Submit/Modify Job
Both Submit and Modify actions requires a
Job object in the Data section. In the case of
a modify only the JobId and items to be altered
need to be present. The response is simply
success or failure.

• ltRequest action"Submit"gt
• ltObjectgtJoblt/Objectgt
• ltDatagt
• ltJobgtltInitialWorkingDirectorygt/clusters/scl/brettlt
  /InitialWorkingDirectorygt
• ltProcessorsgt32lt/Processorsgt
• ltRequestedgtltWallDurationgt300lt/WallDurationgtlt/Reque
  stedgt
• ltOutputFilegtt.outlt/OutputFilegt
• ltActorgtbrettlt/Actorgt
• ltGroupIdgtscllt/GroupIdgt
• ltEnvironmentgtltVariable name"PATH"gt/usr/local/sss/
  bin/bin/usr/bin/usr/local/bin/usr/X11R6/binlt/V
  ariablegtlt/EnvironmentgtltExecutable
  parallel"false"gt./mpitest.shlt/Executablegt
• lt/Jobgt
• lt/Datagt
• lt/Requestgt

4
Query Job

• ltRequest action"Query"gt
• ltObjectgtJoblt/Objectgt
• ltGet name"JobId"gtlt/Getgt
• ltGet name"JobState"gtlt/Getgt
• ltGet name"UserId"gtlt/Getgt
• ltGet name"Processors"gtlt/Getgt
• ltGet name"Delivered"gtlt/Getgt
• ltGet name"Requested"gtlt/Getgt
• ltGet name"NodeList"gtlt/Getgt
• ltWhere name"JobClass"gtactivelt/Wheregt
• lt/Requestgt

5
Query response

• ltResponsegt
• ltStatusgtltValuegtSuccesslt/ValuegtltCodegt000lt/Codegt
• ltMessagegt1 jobs foundlt/Messagegtlt/Statusgt
• ltCountgt1lt/Countgt
• ltData type"xml"gt
• ltJobgtltJobIdgt3396lt/JobIdgt
• ltJobStategtidlelt/JobStategt
• ltUserIdgtbrettlt/UserIdgt
• ltProcessorsgt32lt/Processorsgt
• ltDeliveredgtltWallDurationgt0lt/WallDurationgtltNodeCoun
  tgtlt/NodeCountgtlt/Deliveredgt
• ltRequestedgtltWallDurationgt300lt/WallDurationgtltNodeCo
  untgtlt/NodeCountgtlt/Requestedgt
• ltNodeListgtlt/NodeListgt
• lt/Jobgt
• lt/Datagt
• lt/Responsegt

6
Start Job

• Start job requires the JobId and a NodeList.
  Response is success or failure.
• ltRequest action"Start"gt
• ltObjectgtJoblt/Objectgt
• ltData type"xml"gt
• ltJobgtltJobIdgt23423lt/JobIdgt
• ltNodeListgtltNodegtx1lt/NodegtltNodegtx2lt/Nodegtlt/NodeList
  gt
• lt/Jobgt
• lt/Datagt
• lt/Requestgt

7
Signal Job

• Simple unix style signals. Response contains
  success or failure.
• ltRequest action"Signal"gt
• ltObjectgtJoblt/Objectgt
• ltSet name"Signal"gtSIGTERMlt/Setgt
• ltWhere name"JobId"gt2293lt/Wheregt
• lt/Requestgt

8
Cancel/Suspend/Resume/Checkpoint

• All are simple commands requiring just a JobId
  and returning success or failure.
• ltRequest action"Cancel"gt
• ltObjectgtJoblt/Objectgt
• ltWhere name"JobId"gt3395lt/Wheregt
• lt/Requestgt

9
Authorization

• Bamboo uses the authentication information in the
  SSSRMAP wire protocol to establish the user id
  making the request. (ex. Only the owner or a
  manager can signal/cancel/etc a job)